ocean-rails 3.7.5 → 3.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4618f9060b2df689ac48bed4bb607fd7e1c939b
-  data.tar.gz: 58a774e1cdca3c245e5d804170ab90e5ceee1319
+  metadata.gz: e0d5bb7e0b732f82788e637801f4bf837caebb9f
+  data.tar.gz: c15a1ac82c55631de85ed86e300f418624390828
 SHA512:
-  metadata.gz: 0d14cbed87fa91c0d77ce24009b25d10fb07d463609f9afc40486a6d76ff7ad2726769dcbe80ebda538cd94c09ed771c690279b0488a0220774357dcc5d1d6df
-  data.tar.gz: 074db59dc54f1773f89b0068eceb0b1789aa3fba4a144b7c16ef73b809f27c9a6ce9a7f27cb05fc3231d5609a9b37d0b0d3d0ee5d31e081cfee630504b4cb0b7
+  metadata.gz: d7439c51c1d41f0fcd25b9c421714d80e00eec7d47762aabf4eeec5665c319b80d24c6c37fedcc8d154e02be8032e923e91125af57f7f3178f2ce73b6af42479
+  data.tar.gz: 4489f66cd54b17affb9a80cfb10646cc3046529cd83aa34f637d96f072c85025eafc891b7a6533e16ddd9e0368022b796a5bafef527877592362bac95bed5465

data/lib/ocean/api_remote_resource.rb

@@ -14,6 +14,7 @@ class Api
   #   thing.status => 200
   #   thing.status_message => "OK"
   #   thing.response => #<an Api::Response instance>
+  #   thing.etag => "e4552f0ae517f0352f0ae56222fa0733ea52f0ae5e0"
   #
   # The last raw body can be read:
   #
@@ -82,12 +83,14 @@ class Api
   #
   # Exceptions:
   #
-  #   GetFailed          raised when the GET to obtain the remote resource has failed.
-  #   PutFailed          raised when a PUT on the remote resource has failed.
-  #   PostFailed         raised when a POST to the remote resource has failed.
-  #   DeleteFailed       raised when a DELETE of the remote resource has failed.
-  #   UnparseableJson    raised when the response body doesn't parse as JSON.
-  #   JsonIsNoResource   raised when the structure of the parsed JSON body is not a resource.
+  #   GetFailed             raised when the GET to obtain the resource has failed.
+  #   ConditionalGetFailed  raised when a Conditional Get to refresh the resource has failed.
+  #   PutFailed             raised when a PUT on the resource has failed.
+  #   PostFailed            raised when a POST to the resource has failed.
+  #   DeleteFailed          raised when a DELETE of the resource has failed.
+  #   UnparseableJson       raised when the response body doesn't parse as JSON.
+  #   JsonIsNoResource      raised when the structure of the parsed JSON body is not a resource.
+  #   HyperlinkMissing      raised when a hyperlink isn't available.
   #
   # To parse as a resource, the JSON must be a wrapped Ocean resource of this format:
   #
@@ -109,10 +112,11 @@ class Api
   #   thing.refresh
   #   thing.refresh!
   #
-  # #refresh returns the resource itself, so you can do
+  # Both return the resource itself, so you can do
   #
   #   thing.refresh['updated_at']
   #
+  #
   # NB: this class can also be used to fetch any JSON data. E.g.:
   #
   #   Api::RemoteResource.get("http://example.com/anything").raw
@@ -122,14 +126,13 @@ class Api
   # +nil+, you can always chack +#status+, +#status_message+, and/or +#headers+ to determine what
   # went wrong. After fetching non-resource data, +#present?+ will always be false.
   #
-  # TODO: 1. If .get or .get! retrieve an Ocean collection, let them return an array of RemoteResources.
-  #       2. Implement refresh.
+  # TODO: If .get or .get! retrieve an Ocean collection, let them return an array of RemoteResources.
   #
   class RemoteResource
 
   	attr_reader :uri, :content_type, :retries, :backoff_time, :backoff_rate, :backoff_max
     attr_reader :raw, :resource, :resource_type, :status, :headers, :credentials, :x_api_token
-    attr_reader :status_message, :response
+    attr_reader :status_message, :response, :etag
 
   	def initialize(uri, type="application/json",
                    credentials: nil, x_api_token: nil,
@@ -186,6 +189,8 @@ class Api
     class UnparseableJson < StandardError; end
     class JsonIsNoResource < StandardError; end
     class HyperlinkMissing < StandardError; end
+    class ConditionalGetFailed < StandardError; end
+
 
     def self.get!(*args)
       _retrieve new(*args)
@@ -290,10 +295,30 @@ class Api
     end
 
 
+    def refresh!
+      if present? && etag.present?
+        _conditional_get
+      else
+        get!
+      end
+      self
+    end
+
+    def refresh
+      if present? && etag.present?
+        _conditional_get rescue nil
+      else
+        get
+      end
+      self
+    end
+
+
     private
 
     attr_accessor :present
     attr_writer :raw, :resource, :resource_type, :status, :headers, :status_message, :response
+    attr_writer :etag
 
 
     def self._credentials(rr)
@@ -310,7 +335,9 @@ class Api
 
     def self._retrieve(rr)
       credentials, token = _credentials(rr)
-      response = Api.request Api.internalize_uri(rr.uri), :get, headers: {}, credentials: credentials, x_api_token: token,
+      response = Api.request Api.internalize_uri(rr.uri), :get, 
+                             headers: {}, 
+                             credentials: credentials, x_api_token: token,
                              retries: rr.retries, backoff_time: rr.backoff_time, backoff_rate: rr.backoff_rate, 
                              backoff_max: rr.backoff_max
       rr.send :response=, response
@@ -327,6 +354,27 @@ class Api
       rr
     end
 
+    def _conditional_get
+      credentials, token = RemoteResource._credentials(self)
+      response = Api.request Api.internalize_uri(uri), :get, 
+                             headers: {"If-None-Match" => etag}, 
+                             credentials: credentials, x_api_token: token,
+                             retries: retries, backoff_time: backoff_time, backoff_rate: backoff_rate, 
+                             backoff_max: backoff_max
+      send :response=, response
+      return if response.status == 304
+      send :status=, response.status
+      send :status_message=, response.message
+      send :headers=, response.headers
+      raise ConditionalGetFailed, "#{response.status} #{response.message}" unless response.success?
+      begin
+        raw = response.body
+      rescue JSON::ParserError
+        raise UnparseableJson
+      end
+      _setup raw, response
+    end
+
 
     def _setup(body, response)
       self.raw = body
@@ -337,6 +385,7 @@ class Api
       self.status = response.status
       self.status_message = response.message
       self.headers = response.headers
+      self.etag = headers['ETag']
       self.present = true
     end
 
@@ -374,6 +423,7 @@ class Api
       return if resource_type && type != resource_type
       self.resource = resource
       self.resource_type = type
+      self.etag = headers['ETag']
       self.present = true
     end
 
@@ -397,6 +447,7 @@ class Api
       type, resource = verify_resource(response.body)
       created = RemoteResource.new(post_uri)
       created.send :_setup, raw, response
+      created.send :etag=, nil
       created
     end
 

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "3.7.5"
+  VERSION = "3.7.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 3.7.5
+  version: 3.7.6
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus