Class: MachineShop::APIResource

Inherits:
MachineShopObject show all
Defined in:
lib/machineshop/api_resource.rb

Instance Attribute Summary

Attributes inherited from MachineShopObject

#auth_token

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MachineShopObject

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

Constructor Details

This class inherits a constructor from MachineShop::MachineShopObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class MachineShop::MachineShopObject

Class Method Details

.class_name ⇒ Object 



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

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

.retrieve(id, auth_token = nil) ⇒ Object 



29
30
31
32
33
 
# File 'lib/machineshop/api_resource.rb', line 29

def self.retrieve(id, auth_token=nil)
  instance = self.new(id, auth_token)
  instance.refresh
  instance
end

.url ⇒ Object 



7
8
9
10
11
12
13
 
# File 'lib/machineshop/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 (Device, Rule, etc.)')
  end
  ret = "/platform/#{CGI.escape(class_name.underscore)}"
  ret
end

Instance Method Details

#refresh ⇒ Object 



23
24
25
26
27
 
# File 'lib/machineshop/api_resource.rb', line 23

def refresh      
  response = MachineShop.gem_get(url, @auth_token)
  refresh_from(response, auth_token)
  self
end

#url ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/machineshop/api_resource.rb', line 15

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