Class: Scribesend::APIResource

Inherits:
ScribesendObject show all
Defined in:
lib/scribesend/api_resource.rb

Direct Known Subclasses

Account, Entry, EntryLine

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ScribesendObject

#[], #[]=, #as_json, construct_from, #each, #initialize, #inspect, #keys, #refresh_from, #serialize_nested_object, serialize_params, #to_hash, #to_json, #to_s, #values

Constructor Details

This class inherits a constructor from Scribesend::ScribesendObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Scribesend::ScribesendObject

Class Method Details

.all(filters = {}, opts = {}) ⇒ Object 



49
50
51
52
 
# File 'lib/scribesend/api_resource.rb', line 49

def self.all(filters={}, opts={})
  response, opts = self.request(:get, url, filters, opts)
  Util.convert_to_scribesend_object(response, opts)
end

.class_name ⇒ Object 



3
4
5
 
# File 'lib/scribesend/api_resource.rb', line 3

def self.class_name
  self.name.split('::')[-1]
end

.create(params = {}, opts = {}) ⇒ Object 



54
55
56
57
 
# File 'lib/scribesend/api_resource.rb', line 54

def self.create(params={}, opts={})
  response, opts = self.request(:post, url, params, opts)
  Util.convert_to_scribesend_object(response, opts)
end

.request(method, url, params = {}, opts = {}) ⇒ Object

API Methods



29
30
31
32
33
34
35
36
 
# File 'lib/scribesend/api_resource.rb', line 29

def self.request(method, url, params={}, opts={})
  headers = opts.clone
  api_key = headers.delete(:api_key)
  api_base = headers.delete(:api_base)

  response, opts = Scribesend.request(method, url, api_key, params, headers, api_base)
  [response, opts]
end

.retrieve(id, opts = {}) ⇒ Object 



43
44
45
46
47
 
# File 'lib/scribesend/api_resource.rb', line 43

def self.retrieve(id, opts={})
  instance = self.new(id, opts)
  instance.refresh
  instance
end

.url ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/scribesend/api_resource.rb', line 7

def self.url
  if self == APIResource
    raise NotImplementedError.new("APIResource is an abstract class. You should perform actions on its subclasses (Account, Entry, etc.)")
  end
  if (self.class_name[-1..-1] == 's' || self.class_name[-1..-1] == 'h')
    return "/#{CGI.escape(self.class_name.downcase)}es"
  elsif (self.class_name[-1..-1] == 'y')
    return "/#{CGI.escape(self.class_name.downcase[0..-2])}ies"
  else
    return "/#{CGI.escape(class_name.downcase)}s"
  end
end

Instance Method Details

#refresh ⇒ Object 



38
39
40
41
 
# File 'lib/scribesend/api_resource.rb', line 38

def refresh
  response, opts = self.class.request(:get, url, @retrieve_params)
  refresh_from(response, opts)
end

#save(params = {}) ⇒ Object

def delete(params={}, opts={})

response, opts = self.class.request(:delete, url, params, opts)
refresh_from(response, opts)
self

end



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/scribesend/api_resource.rb', line 65

def save(params={})
  values = self.class.serialize_params(self).merge(params)

  if values.length > 0
    values.delete(:id)

    response, opts = self.class.request(:post, url, values)
    refresh_from(response, opts)
  end
  self
end

#url ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/scribesend/api_resource.rb', line 20

def url
  unless id = self['id']
    raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")
  end
  "#{self.class.url}/#{CGI.escape(id)}"
end