ocean-rails 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a931fab98c0b77adbd93d419a208be124d3777a
-  data.tar.gz: a25db8fe648e413a944a42e7ebd2397f0c4452d9
+  metadata.gz: 199cd45800bf7316cb1bb1b79f622ee1c6a74556
+  data.tar.gz: 8865f5b42851598a6b02ae921e62e42487d6ce9b
 SHA512:
-  metadata.gz: 1d8a941fb42ab893e71e5f7211c1b807c2551a882fe448fd6fa7caf1608b48004f6f14bd549102034bd565044cc6fd847c909f617de7f6477b102842a331abcc
-  data.tar.gz: afe18d5dedc343d1b7e6a0221cfc512d15ed9e04a4bbeeb86fbb80811cfbe393935a01d23333724246654274ccda2d0bc0836ae21492094d5e27d17f743b601a
+  metadata.gz: 7db74a25a4eeddb2b8ce989ab9725c211a272c4353aeabc4b3099ee55e7f7525a8af5f6b9abcd3f23164b549a1309163ddc829a572c10874c094ed1d0440a27d
+  data.tar.gz: 415353c47a9a3a8a09e4307262a1952f0dc7fcbf8a909145a1bd566bde5478c9500eea6ad6e43d689a0ed795ea2055376c682211e5b2923065c63a4e06ec7f55

data/app/helpers/application_helper.rb

@@ -33,13 +33,17 @@ module ApplicationHelper
 
 
   #
-  # View helper predicates to determine whether the ApiUser belongs
-  # to one or more of a list of Groups.
+  # View helper predicates to determine if the ApiUser behind the current
+  # authorisation belongs to one or more of a list of Groups.
   #
   def member_of_group?(*names)
     @group_names && @group_names.intersect?(names.to_set) 
   end
 
+  #
+  # Returns true if the ApiUser behind the current authorisation belongs 
+  # to the Ocean Group "Superusers".
+  #
   def superuser?
     member_of_group?("Superusers")
   end

data/lib/ocean/api.rb

@@ -14,15 +14,6 @@ class Api
   end
   
 
-  #
-  # Given that this service has authenticated successfully with the Auth service,
-  # returns the token returned as part of the authentication response.
-  #
-  def self.token
-    @token
-  end
-      
-  
   #
   # Adds environment info to the basename, so that testing and execution in various combinations
   # of the Rails env and the Chef environment can be done without collision. 
@@ -77,6 +68,13 @@ class Api
       @response.response_code
     end
 
+    #
+    # The status message of the HTTP response.
+    #
+    def message
+      @response.status_message
+    end
+
     #
     # Returns a hash of HTTP response headers.
     #
@@ -95,12 +93,26 @@ class Api
       @body ||= @response.response_body.blank? ? nil : JSON.parse(@response.response_body)
     end
 
+    #
+    # Returns true if the HTTP request was a success and status == 2xx.
+    #
+    def success?
+      @response.success?
+    end
+
     #
     # Returns true if the HTTP request timed out.
     #
     def timed_out?
       @response.timed_out?
     end
+
+    #
+    # Returns true if the HTTP response was a success and not a 304.
+    #
+    def modified?
+      @response.modified?
+    end
   end
 
 
@@ -117,26 +129,48 @@ class Api
   # +args+, if given, should be a hash of query arguments to add to the URL.
   # +headers+, if given, is a hash of extra HTTP headers for the request.
   # +body+, if given, is the body of the request (:post, :put) as a string.
+  # +x_api_token+, if given, is a string which will be used as an X-API-Token header.
   #
-  # Api.request won't raise an exception if the request times out or the operation fails.
-  # Instead, all such information is encapsulated in the Api::Response instance returned.
-  #
-  def self.request(url, http_method, args: nil, headers: {}, body: nil)
+  def self.request(url, http_method, args: nil, headers: {}, body: nil,
+                   x_api_token: nil)
     # Set up the request
     headers['Accept'] = "application/json"
     headers['Content-Type'] = "application/json"
     headers['User-Agent'] = "Ocean"
-    request = Typhoeus::Request.new(url, method: http_method, headers: headers,
-                                    params: args, body: body)
-    # Run it
-    response = request.run
-    # Retries would be done here
-
-    # Return the response
-    Response.new(response)
+    headers['X-API-Token'] = x_api_token if x_api_token
+
+    while (true) do
+      request = Typhoeus::Request.new(url, method: http_method, headers: headers,
+                                      params: args, body: body)
+      # Run it
+      response = Response.new(request.run)
+      # If successful, return
+      return response if response.success?
+
+      # Not successful, deal with it
+      if response.timed_out?
+        raise Api::TimeoutError, "Api.request timed out"
+      elsif response.status == 0
+        # Could not get an http response, something's wrong.
+        raise Api::NoResponseError, "Api.request could not obtain a response"
+      elsif [400, 419].include?(response.status) && x_api_token.present?
+        # Re-authenticate and retry
+        Api.reset_service_token
+        headers['X-API-Token'] = Api.service_token
+        x_api_token = false   # This prevents us from ending up here twice
+      else
+        # Failed
+        break
+      end
+    end
+    # Return the wrapped response to the failed request
+    response
   end 
 
 
+  class TimeoutError < StandardError; end
+  class NoResponseError < StandardError; end
+
   #
   # Makes an internal HTTP request to +host_url+ using the HTTP method +method+. The +resource_name+
   # is used to obtain the latest version string of the resource. The arg +path+ is the
@@ -237,18 +271,47 @@ class Api
     URI.escape(path, Regexp.new("[^/$\\-+_.!~*'()a-zA-Z0-9]"))
   end
 
+
+
+  #
+  # Given that this service has authenticated successfully with the Auth service,
+  # returns the token returned as part of the authentication response.
+  # NB: This method is deprecated.
+  #
+  def self.token
+    ActiveSupport::Deprecation.warn "Api.token is deprecated, use Api.service_token instead and skip the explicit call to Api.authenticate.", caller
+    service_token
+  end
+
+  #
+  # This method returns the current token. If no current token has been obtained,
+  # authenticates.
+  #
+  def self.service_token
+    @service_token ||= authenticate
+  end
+
+  #
+  # Resets the service token, causing the next call to Api.service_token to
+  # re-authenticate.
+  #
+  def self.reset_service_token
+    @service_token = nil
+  end
+
   
   #
   # 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 @token. If not successful, +nil+ is returned.
+  # a given +username+ and +password+. If successful, the authentication token is returned.
+  # 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)
     response = Api.post(:auth, "/authentications", nil, 
                                {'X-API-Authenticate' => encode_credentials(username, password)})
     case response.status
     when 201
-      @token = response.body['authentication']['token']
+      @service_token = response.body['authentication']['token']
     when 400
       # Malformed credentials. Don't repeat the request.
       nil
@@ -299,7 +362,7 @@ class Api
   #
   # e.g.
   #
-  #   Api.permitted?(@token, query: "cms:texts:self:GET:*:*")
+  #   Api.permitted?(@service_token, query: "cms:texts:self:GET:*:*")
   #
   # Api.authorization_string can be used to produce the query string.
   # 

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "2.9.0"
+  VERSION = "2.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus