ocean-rails 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695bf42c433ee293191b3c856bdea9659fa6026b
-  data.tar.gz: 2472561dd035df00ca8ee24d923d6576ba3bc79f
+  metadata.gz: 9e13cc2480ac989b37242e14182c41931b25b5ff
+  data.tar.gz: e84d495747487e35a951cc80eb1c53508d742351
 SHA512:
-  metadata.gz: c32548ba8c61a9b8348f8f710e97864ac26a58f2dd18dce8f2ceb2d872472630d2d30f3780e756e14d4336ab3fffcdcf818c56784d7e420e4293f69082a52c6a
-  data.tar.gz: 722dc5edec98fcf8a921fcc5f3b9372804eaedb4e33f6206b0090c48d4bf8a2e82f1add6e81bacc98dd9f768bb1c7861a1584aec8d3f42f9117f5de359acc74c
+  metadata.gz: c75d7190f2c20ada7c2349e625523fb2bf5161bd7e805d680d5bd4b2872605850fa3e65cd067022aad9f2ad3b18be0e0203c4b9215839df3d1c716562594a2ae
+  data.tar.gz: 17e85cd0ce7257bbedac4b231e4222f62e563bc21089ee43a29c448f68314ea94f41e82a175d04417f3065953b4295f8c36958bd4d469df8ea9b8050b3596925

data/lib/ocean/api.rb

@@ -349,7 +349,7 @@ class Api
   # If not successful, +nil+ is returned.
   #
   def self.authenticate(username=API_USER, password=API_PASSWORD)
-    response = Api.request "#{INTERNAL_OCEAN_API_URL}/v1/authentications", :post,
+    response = Api.request "/v1/authentications", :post,
                            headers: {'X-API-Authenticate' => credentials(username, password)}
     case response.status
     when 201
@@ -423,8 +423,7 @@ class Api
   #
   def self.permitted?(token, args={})
     raise unless token
-    Api.request "#{INTERNAL_OCEAN_API_URL}/v1/authentications/#{token}", :get, 
-                args: args
+    Api.request "/v1/authentications/#{token}", :get, args: args
   end  
 
 
@@ -480,7 +479,7 @@ class Api
                      subject: nil, 
                      plaintext: nil, html: nil,
                      plaintext_url: nil, html_url: nil, substitutions: nil)
-    Api.request "#{INTERNAL_OCEAN_API_URL}/v1/mails", :post, 
+    Api.request "/v1/mails", :post, 
       x_api_token: Api.service_token, credentials: Api.credentials,
       body: {
         from: from, to: to, subject: subject, 
@@ -555,7 +554,7 @@ class Api
   # 
   def self.run_async_job(href=nil, method=nil, job: nil, **keywords, &block)
     job ||= async_job_body(href, method, **keywords)
-    Api.request "#{INTERNAL_OCEAN_API_URL}/v1/async_jobs", :post,
+    Api.request "/v1/async_jobs", :post,
       body: job.to_json, x_api_token: Api.service_token
   rescue TimeoutError, NoResponseError => e
     raise e unless block

data/lib/ocean/api_remote_resource.rb

@@ -107,6 +107,11 @@ class Api
   # The above is a Thing resource, wrapped with its type. Attributes should appear in the inner
   # hash, which must have at least a +_links+ hyperlink attribute with a href and a content type. 
   #
+  # If any of the four getters (.get!, .get, #get!, and #get) receive an Ocean collection, 
+  # the instance method +#collection+ will return an array of RemoteResources. NB: the getters
+  # will still, in all cases, return the RemoteResource itself. The collection is always made
+  # available as the value of +#collection+ on the RemoteResource which was used to obtain it.
+  #
   # To refresh a resource using a conditional GET:
   #
   #   thing.refresh
@@ -126,13 +131,11 @@ 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: If .get or .get! retrieve an Ocean collection, let them return an array of RemoteResources.
-  #
   class RemoteResource
 
   	attr_reader :uri, :args, :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, :etag
+    attr_reader :status_message, :response, :etag, :collection
 
     #
     # The credentials and the x_api_token, if both are left unspecified, will default to
@@ -435,7 +438,7 @@ class Api
 
     attr_accessor :present
     attr_writer :raw, :resource, :resource_type, :status, :headers, :status_message, :response
-    attr_writer :etag
+    attr_writer :etag, :collection
 
 
     def _credentials(rr)
@@ -491,11 +494,16 @@ class Api
     end
 
 
-    def _setup(body, response)
-      self.raw = body
-      type, resource = verify_resource body
-      self.resource = resource
-      self.resource_type = type
+    def _setup(wrapped, response)
+      self.raw = wrapped
+      if raw && raw.is_a?(Hash) && raw['_collection']
+        self.collection = raw['_collection']['resources'].map { |wrapped| _make wrapped, response }
+        self.resource_type = '_collection'
+      else
+        type, resource = verify_resource wrapped
+        self.resource = resource
+        self.resource_type = type
+      end
       self.response = response
       self.status = response.status
       self.status_message = response.message
@@ -505,10 +513,20 @@ class Api
     end
 
 
-    def verify_resource(json)
-      raise JsonIsNoResource unless json.is_a? Hash
-      raise JsonIsNoResource unless json.size == 1
-      resource_type, attributes = json.to_a.first
+    def _make(wrapped, response)
+      resource_type, attributes = wrapped.to_a.first
+      r = Api::RemoteResource.new attributes['_links']['self']['href'],
+          retries: retries, backoff_time: backoff_time, 
+          backoff_rate: backoff_rate, backoff_max: backoff_max
+      r.send :_setup, wrapped, response
+      r
+    end
+
+
+    def verify_resource(wrapped)
+      raise JsonIsNoResource unless wrapped.is_a? Hash
+      raise JsonIsNoResource unless wrapped.size == 1
+      resource_type, attributes = wrapped.to_a.first
       raise JsonIsNoResource unless attributes.is_a? Hash
       raise JsonIsNoResource unless attributes['_links'].is_a? Hash
       raise JsonIsNoResource unless attributes['_links']['self'].is_a? Hash

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Peter Bengtson