Class: Kippt::Users

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

Constant Summary collapse

VALID_SEARCH_PARAMETERS = 
[:q]

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) ⇒ Users 



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

def initialize(client)
  @client = client
end

Class Method Details

.valid_filter_parameters ⇒ Object 



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

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

Instance Method Details

#base_uri ⇒ Object 



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

def base_uri
  "users"
end

#collection_class ⇒ Object 



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

def collection_class
  Kippt::UserCollection
end

#object_class ⇒ Object 



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

def object_class
  Kippt::User
end

#search(parameters) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/kippt/users.rb', line 30

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

    Kippt::UserCollection.new(
      client.get("#{base_uri}/search", parameters).body,
      client)
  end
end