ocean-rails 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 098dd40c3f091686952bd78105c343ee87535f61
-  data.tar.gz: 9d2cd112b855fd23afd076990794aad0793c4a9b
+  metadata.gz: 0e862602465b2d95c4feb017e60d9aa0c7ba4d01
+  data.tar.gz: 0f70ab560a3e158f98c665dca412f6b95a8dd065
 SHA512:
-  metadata.gz: 2de952ef104e432eead8554f0f5a7d6a2113c080f1b84b2a0a303937d51bf9dc8ce92574fc5fa53e3cd1bd47eba1e6decb20f2d7e8d9ae10a131741a9b62b128
-  data.tar.gz: 7a13f27912aecad17c15a54e93f300071053f9fcda62fb77b6af64425a48a81182fb5322570d053b26e65a7f4e6d020e364ce314079985a959f0e5d6239d8fc4
+  metadata.gz: c67589b6dcee0ae611df937f0086c3ee61d4b7b52d814a785d819f3227005daefbf2f64951a4f2897e4680a76a6519356975316c4f620235a348e648cae4e67d
+  data.tar.gz: c690688b2acd71632fc1be92d4bcda692464fab52039e6496722f97ba7d45830ed4aeafa3cf93df270738f4fd512ac834a4c678e641fbcc3f696005b49d9faa7

data/lib/ocean/api.rb

@@ -146,6 +146,7 @@ class Api
   # +ssl_verifyhost+ (2 by default), controls SSL host verification.
   #
   def self.request(url, http_method, args: nil, headers: {}, body: nil,
+                   credentials: nil,
                    x_api_token: headers['X-API-Token'], 
                    reauthentication: true,
                    ssl_verifypeer: true, ssl_verifyhost: 2)
@@ -153,7 +154,8 @@ class Api
     headers['Accept'] = "application/json"
     headers['Content-Type'] = "application/json" if [:post, :put].include?(http_method)
     headers['User-Agent'] = "Ocean"
-    headers['X-API-Token'] = x_api_token if x_api_token
+    x_api_token =  Api.authenticate(*Api.decode_credentials(credentials)) if x_api_token.blank? && credentials.present?
+    headers['X-API-Token'] = x_api_token if x_api_token.present?
 
     while (true) do
       request = Typhoeus::Request.new(url, 
@@ -176,8 +178,13 @@ class Api
         raise Api::NoResponseError, "Api.request could not obtain a response"
       elsif [400, 419].include?(response.status) && reauthentication && x_api_token.present? 
         # Re-authenticate and retry
-        Api.reset_service_token
-        headers['X-API-Token'] = Api.service_token
+        if credentials
+          x_api_token = Api.authenticate(*Api.decode_credentials(credentials))
+          headers['X-API-Token'] = x_api_token
+        else
+          Api.reset_service_token
+          headers['X-API-Token'] = Api.service_token
+        end
         reauthentication = false   # This prevents us from ending up here twice
       else
         # Failed
@@ -342,7 +349,7 @@ class Api
   #
   # Authenticates against the Auth service (which must be deployed and running) with
   # a given +username+ and +password+. If successful, the authentication token is returned.
-  # The token is also assigned to the instance variable @service_token. 
+  # If the credentials match the service's own, the token is also assigned to the instance variable @service_token. 
   # If not successful, +nil+ is returned.
   #
   def self.authenticate(username=API_USER, password=API_PASSWORD)
@@ -350,7 +357,9 @@ class Api
                                {'X-API-Authenticate' => encode_credentials(username, password)})
     case response.status
     when 201
-      @service_token = response.body['authentication']['token']
+      token = response.body['authentication']['token']
+      @service_token = token if username == API_USER && password == API_PASSWORD
+      token
     when 400
       # Malformed credentials. Don't repeat the request.
       nil

data/lib/ocean/api_remote_resource.rb

@@ -56,12 +56,36 @@ class Api
   # <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.
   #
+  # Exceptions:
+  #
+  #  GetFailed          raised when the GET to obtain the remote resource has failed.
+  #  WrongContentType   raised when the Content-Type doesn't match :content_type.
+  #  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.
+  #
+  # To parse as a resource, the JSON must be a wrapped Ocean resource of this format:
+  #
+  #  {"thing": {
+  #     "_links": {
+  #       "self": {"href": "https://....", type: "application/json"},
+  #       ...
+  #     },
+  #     "foo": 2,
+  #     "bar": [1,2,3],
+  #     ...
+  #  }
+  #
+  # 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.  
+  #
   class RemoteResource
 
   	attr_reader :uri, :content_type, :retries, :backoff_time, :backoff_rate, :backoff_max
-    attr_reader :raw, :resource, :resource_type, :status, :headers
+    attr_reader :raw, :resource, :resource_type, :status, :headers, :credentials, :x_api_token
+    attr_reader :status_message
 
   	def initialize(uri, type="application/json",
+                   credentials: nil, x_api_token: nil,
   		             retries: 3, backoff_time: 1, backoff_rate: 2, backoff_max: 30)
       super()
   	  @uri = uri
@@ -75,7 +99,10 @@ class Api
       @resource = nil
       @resource_type = nil
       @status = nil
+      @status_message = nil
       @headers = nil
+      @credentials = credentials
+      @x_api_token = x_api_token
   	end
 
     def present?
@@ -129,6 +156,7 @@ class Api
     end
 
 
+    class GetFailed < StandardError; end
     class WrongContentType < StandardError; end
     class UnparseableJson < StandardError; end
     class JsonIsNoResource < StandardError; end
@@ -137,19 +165,28 @@ class Api
     private
 
     attr_accessor :present
-    attr_writer :raw, :resource, :resource_type, :status, :headers
+    attr_writer :raw, :resource, :resource_type, :status, :headers, :status_message
 
 
     def self._retrieve(rr)
-      response = Api.request rr.uri, :get, headers: {}, x_api_token: Api.service_token
-      return unless response.success?
+      if rr.credentials.present? && rr.credentials != Api.encode_credentials(API_USER, API_PASSWORD)
+        credentials = rr.credentials
+        token = rr.x_api_token
+      else
+        credentials = nil
+        token = rr.x_api_token || Api.service_token
+      end
+      response = Api.request rr.uri, :get, headers: {}, credentials: credentials, x_api_token: token
+      rr.send :status=, response.status
+      rr.send :status_message=, response.message
+      raise GetFailed 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.send :_setup, raw, response
       rr
     end
 

data/lib/ocean/version.rb

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

metadata

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