Class: OurKudos::Client

Inherits:
Object
  • Object
show all
Includes:
ResourceEditor
Defined in:
lib/ourkudos/our_kudos.rb

Constant Summary collapse

OurKudosClientOptions =

configuration hash

{ 'api_key' => nil, 
'base_uri' => "http://localhost:3000/api/" }
@@base_uri = 
OurKudosClientOptions['base_uri']
@@api_key = 





Class Method Summary
collapse





Instance Method Summary
collapse




Methods included from ResourceEditor


#create, #edit, resource_name, resource_name=, #show




Class Method Details





.api_key=(api_key = nil) ⇒ Object







sets new api key















56
57
58
59
60




# File 'lib/ourkudos/our_kudos.rb', line 56

def api_key= api_key = nil
  return @@api_key unless api_key
      
  @@api_key  = OurKudosClientOptions['api_key'] = api_key
end












.base_uri=(base_uri = nil) ⇒ Object







sets base url















63
64
65
66
67




# File 'lib/ourkudos/our_kudos.rb', line 63

def base_uri= base_uri = nil
  return @@base_uri unless base_uri
  
  @@base_uri = OurKudosClientOptions['base_uri'] = base_uri
end













Instance Method Details





#delete(options = {}) ⇒ Object







deletes item















102
103
104
105




# File 'lib/ourkudos/our_kudos.rb', line 102

def delete(options = {})
  Nestful.delete OurKudos.base_uri + options[:path], :params => {:api_key => OurKudos.api_key}.merge(options[:params]),   
                                                                     :format => :json
end












#get(options = {}) ⇒ Object







retrieves item















90
91
92
93




# File 'lib/ourkudos/our_kudos.rb', line 90

def get(options = {})
  Nestful.get OurKudos.base_uri + options[:path], :params => {:api_key => OurKudos.api_key}.merge(options[:params]), 
                                                               :format => :json
end












#post(options = {}) ⇒ Object







general restuful post method - creates an item















84
85
86
87




# File 'lib/ourkudos/our_kudos.rb', line 84

def post(options = {})
    Nestful.post OurKudos.base_uri + options[:path], :params => {:api_key => OurKudos.api_key}.merge(options[:params]), 
                                                               :format => :json 
end












#put(options = {}) ⇒ Object







updates item















96
97
98
99




# File 'lib/ourkudos/our_kudos.rb', line 96

def put(options = {})
  Nestful.put OurKudos.base_uri + options[:path], :params => {:api_key => OurKudos.api_key}.merge(options[:params]), 
                                                               :format => :json
end












#resource_name ⇒ Object







displays current resource















79
80
81




# File 'lib/ourkudos/our_kudos.rb', line 79

def resource_name 
  OurKudos::ResourceEditor.resource_name 
end












#resource_name=(resource) ⇒ Object







sets resource to read/edit/delete















74
75
76




# File 'lib/ourkudos/our_kudos.rb', line 74

def resource_name= resource
  OurKudos::ResourceEditor.resource_name = resource
end