ocean-rails 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b43f4ba84984a518c763a6f6617afb5bbe60c5c
-  data.tar.gz: 7d4407aebaa0e24ba645980c6481deebd93e2b86
+  metadata.gz: 098dd40c3f091686952bd78105c343ee87535f61
+  data.tar.gz: 9d2cd112b855fd23afd076990794aad0793c4a9b
 SHA512:
-  metadata.gz: 4d6296a69023769b3a80d548d50a6ae3eed1ad63a29922f43f22868a349a440ebd90daef77699525929d1de85435ff4743e36954c2446420275b875d8b0d2fc1
-  data.tar.gz: b47bfae2f6afb2345f8a530dc8794cbd4e70ed18787fee9dd8a67a1d05f4ed30e193c74e277244f4a6f19ad2c52f7464583a4bfaeb79d5255caeeda60a6a53ab
+  metadata.gz: 2de952ef104e432eead8554f0f5a7d6a2113c080f1b84b2a0a303937d51bf9dc8ce92574fc5fa53e3cd1bd47eba1e6decb20f2d7e8d9ae10a131741a9b62b128
+  data.tar.gz: 7a13f27912aecad17c15a54e93f300071053f9fcda62fb77b6af64425a48a81182fb5322570d053b26e65a7f4e6d020e364ce314079985a959f0e5d6239d8fc4

data/lib/ocean-rails.rb

@@ -10,7 +10,7 @@ require "ocean/zero_log"
 require "ocean/zeromq_logger"
 require "ocean/selective_rack_logger"
 require "ocean/flooding"
-
+require "ocean/api_remote_resource"
 
 
 INVALIDATE_MEMBER_DEFAULT =     ["($|/|\\?)"]

data/lib/ocean/api_remote_resource.rb

@@ -0,0 +1,176 @@
+class Api
+
+  #
+  # This class represents an Ocean resource accessed by a URI. 
+  # 
+  # The resource is read lazily. Retries and back off properties are available.
+  # Conditional GETs are used whenever possible.
+  #
+  #   thing = Api::RemoteResource.new("http://api.example.com/things/1")
+  #   thing.present? => false
+  #   thing['some_attr'] => {"this" => "is", "just" => "an example"}
+  #   thing.present? => true
+  #   
+  #   thing.resource_type => 'thing'
+  #   thing.status => 200
+  #   thing.success? => true
+  #
+  # The last raw body can be read:
+  #
+  #   thing.raw => nil or {"foo" => {...}}
+  #
+  # Headers can be read or set:
+  #
+  #   thing.headers => {...}
+  #   thing.headers['X-Some-Header'] = "Zalagadoola"
+  #
+  # Attributes can be read or set:
+  #
+  #   thing['foo'] = "bar"
+  #   thing['foo'] = "newbar"
+  #
+  # Hyperlinks can be read:
+  #
+  #   thing.hyperlink['self'] => {"href"=>"http://api.example.com/things/1", 
+  #                               "type"=>"application/json"}
+  #
+  # These are defined for convenience:
+  #
+  #   thing.href => "http://api.example.com/things/1"
+  #   thing.type => "application/json"
+  #
+  # The following two are equivalent:
+  #
+  #   Api::RemoteResource.new("foo").get
+  #   Api::RemoteResource.get("foo")
+  #
+  # as are:
+  #
+  #   Api::RemoteResource.new("foo").get!
+  #   Api::RemoteResource.get!("foo")
+  #
+  # #post, #post!, #put, #put!, #delete, and #delete! are also available.
+  #
+  # If get or get! retrieve an Ocean collection, they will return an array of RemoteResources.
+  #
+  # <tt>thing.get!</tt> returns an Api::RemoteResource if successful. If not, raises an exception.
+  # <tt>thing.get</tt> does the same, but returns nil if unsuccessful.
+  #
+  class RemoteResource
+
+  	attr_reader :uri, :content_type, :retries, :backoff_time, :backoff_rate, :backoff_max
+    attr_reader :raw, :resource, :resource_type, :status, :headers
+
+  	def initialize(uri, type="application/json",
+  		             retries: 3, backoff_time: 1, backoff_rate: 2, backoff_max: 30)
+      super()
+  	  @uri = uri
+  	  @content_type = type
+      @retries = retries
+      @backoff_time = backoff_time
+      @backoff_rate = backoff_rate
+      @backoff_max = backoff_max
+      @present = false
+      @raw = nil
+      @resource = nil
+      @resource_type = nil
+      @status = nil
+      @headers = nil
+  	end
+
+    def present?
+      @present
+    end
+
+
+    def self.get!(*args)
+      _retrieve new(*args)
+    end
+
+    def get!
+      RemoteResource._retrieve self
+    end
+
+    def self.get(*args)
+      begin
+        get!(*args)
+      rescue
+        nil
+      end
+    end
+
+    def get
+      begin
+        get!
+      rescue
+        nil
+      end
+    end
+
+    def [](key)
+      get! unless present?
+      resource[key]
+    end
+
+    def []=(key, value)
+      resource[key] = value
+    end
+
+    def hyperlink
+      self['_links']
+    end
+
+    def href
+      hyperlink['self']['href']
+    end
+
+    def type
+      hyperlink['self']['type']
+    end
+
+
+    class WrongContentType < StandardError; end
+    class UnparseableJson < StandardError; end
+    class JsonIsNoResource < StandardError; end
+
+
+    private
+
+    attr_accessor :present
+    attr_writer :raw, :resource, :resource_type, :status, :headers
+
+
+    def self._retrieve(rr)
+      response = Api.request rr.uri, :get, headers: {}, x_api_token: Api.service_token
+      return unless response.success?
+      raise WrongContentType unless response.headers['Content-Type'] == rr.content_type
+      begin
+        raw = response.body
+      rescue JSON::ParserError
+        raise UnparseableJson
+      end
+      rr.send(:_setup, raw, response)
+      rr
+    end
+
+
+    def _setup(body, response)
+      self.raw = body
+      raise JsonIsNoResource unless raw.is_a? Hash
+      raise JsonIsNoResource unless raw.size == 1
+      resource_type, value = raw.to_a.first
+      raise JsonIsNoResource unless value.is_a? Hash
+      raise JsonIsNoResource unless value['_links'].is_a? Hash
+      raise JsonIsNoResource unless value['_links']['self'].is_a? Hash
+      raise JsonIsNoResource unless value['_links']['self']['href'].is_a? String
+      raise JsonIsNoResource unless value['_links']['self']['type'].is_a? String
+      self.resource = value
+      self.resource_type = resource_type
+      self.status = response.status
+      self.headers = response.headers
+      self.present = true
+    end
+
+
+  end
+end

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -250,6 +250,7 @@ files:
 - lib/generators/ocean_setup/templates/spec_helper.rb
 - lib/ocean-rails.rb
 - lib/ocean/api.rb
+- lib/ocean/api_remote_resource.rb
 - lib/ocean/api_resource.rb
 - lib/ocean/engine.rb
 - lib/ocean/flooding.rb