Class: Sendle::Api::Resource

Inherits:
Object
  • Object
show all
Includes:
Actions::Base
Defined in:
lib/sendle/api/resource.rb

Direct Known Subclasses

Order, Ping, Quote

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Actions::Base

#request

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args, &blk) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/sendle/api/resource.rb', line 42

def method_missing(m, *args, &blk)
  if Sendle::Api::Utils.respond_to?(m)
    Sendle::Api::Utils.send(m, *args)
  else
    super(m, *args, blk)
  end
end

Class Method Details

.url ⇒ Object 



8
9
10
 
# File 'lib/sendle/api/resource.rb', line 8

def self.url
  self.new.url
end

Instance Method Details

#include_credentials? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/sendle/api/resource.rb', line 12

def include_credentials?
  true
end

#process_create_response(response) ⇒ Object 



28
29
30
 
# File 'lib/sendle/api/resource.rb', line 28

def process_create_response(response)
  return_json(response)
end

#process_destroy_response(response) ⇒ Object

Destroy action hook methods



38
39
40
 
# File 'lib/sendle/api/resource.rb', line 38

def process_destroy_response(response)
  return_json(response)
end

#process_index_response(response) ⇒ Object 



20
21
22
 
# File 'lib/sendle/api/resource.rb', line 20

def process_index_response(response)
  return_json(response)
end

#process_show_response(response) ⇒ Object

Show action hook methods



33
34
35
 
# File 'lib/sendle/api/resource.rb', line 33

def process_show_response(response)
  return_json(response)
end

#url ⇒ Object 



4
5
6
 
# File 'lib/sendle/api/resource.rb', line 4

def url
  raise "An API Resource must implement the url method."
end

#validate_create_request!(params) ⇒ Object

Create action hook methods



25
26
 
# File 'lib/sendle/api/resource.rb', line 25

def validate_create_request!(params)
end

#validate_index_request!(params) ⇒ Object

Index action hook methods



17
18
 
# File 'lib/sendle/api/resource.rb', line 17

def validate_index_request!(params)
end