Class: Kippt::Clips

Inherits:
Object
  • Object
show all
Includes:
CollectionResource
Defined in:
lib/kippt/clips.rb

Constant Summary collapse

VALID_SEARCH_PARAMETERS = 
[:q, :list, :is_starred]

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CollectionResource

#[], #all, #build, #collection_from_url, #create, #destroy_resource, #save_resource

Constructor Details

#initialize(client) ⇒ Clips

Returns a new instance of Clips.



10
11
12
 
# File 'lib/kippt/clips.rb', line 10

def initialize(client)
  @client = client
end

Class Method Details

.valid_filter_parameters ⇒ Object 



14
15
16
 
# File 'lib/kippt/clips.rb', line 14

def self.valid_filter_parameters
  [:limit, :offset, :is_read_later, :is_starred]
end

Instance Method Details

#base_uri ⇒ Object 



26
27
28
 
# File 'lib/kippt/clips.rb', line 26

def base_uri
  "clips"
end

#collection_class ⇒ Object 



22
23
24
 
# File 'lib/kippt/clips.rb', line 22

def collection_class
  Kippt::ClipCollection
end

#feed ⇒ Object 



30
31
32
 
# File 'lib/kippt/clips.rb', line 30

def feed
  Kippt::ClipCollection.new(client.get("clips/feed").body, client)
end

#object_class ⇒ Object 



18
19
20
 
# File 'lib/kippt/clips.rb', line 18

def object_class
  Kippt::Clip
end

#search(parameters) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/kippt/clips.rb', line 34

def search(parameters)
  if parameters.is_a?(String)
    Kippt::ClipCollection.new(
      client.get("search/clips", {:q => parameters}).body,
      client)
  else
    validate_search_parameters(parameters)

    Kippt::ClipCollection.new(
      client.get("search/clips", parameters).body,
      client)
  end
end