ocean-rails 2.6.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70bf4729704338768d5f743d77131a57a3b5f727
-  data.tar.gz: 230ebe6ac4905c2ee3439fd2adc04a7561779847
+  metadata.gz: b145db3805039a6cc1d38e79ca8082fff55b1cf9
+  data.tar.gz: f419dd31a14e6ee523304489213dc61cda381647
 SHA512:
-  metadata.gz: 679ce12c6732acf220721832b9ce61b6688f87533b9607f83c268a7d2648d5488714d963283856edff99564547db87a64f7a9c4c90786ea2aa378e95a4ff5a9f
-  data.tar.gz: edae51c49986ccf4e2533acad819fdbab3673e9baafb15c4b626c64f1e4a7958d23d10a7b70eff41239782c239d05190edd4b1f4f883e9e72bc77f44cf0c9cdf
+  metadata.gz: 74240a3d708dc16ec24d1da03607f11cbdb1f721f1f49be388bb0ea5c23846e0145b6331bd7f54b8fae088f0b0337460afedec2022748d97466ad65f07e201a8
+  data.tar.gz: 351a73dc913d1570f6beefaafba47060e672369bec796ede8be44c222c5357ae5cd4e2c5f5bbae663193db6bccb8734fad6c6ceab9f4bc01da850c10b611bdf7

data/lib/ocean/api.rb

@@ -1,30 +1,3 @@
-#
-# We need to monkey-patch Faraday to pull off PURGE and BAN
-#
-require 'faraday'
-require 'faraday_middleware'
-
-module Faraday #:nodoc: all
-  class Connection
-
-    METHODS << :purge
-    METHODS << :ban
-
-    # purge/ban(url, params, headers)
-    %w[purge ban].each do |method|
-      class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{method}(url = nil, params = nil, headers = nil)
-          run_request(:#{method}, url, nil, headers) { |request|
-            request.params.update(params) if params
-            yield request if block_given?
-          }
-        end
-      RUBY
-    end
-
-  end
-end
-
 require 'typhoeus'
 
 #
@@ -40,6 +13,7 @@ class Api
     API_VERSIONS[resource_name.to_s] || API_VERSIONS['_default']
   end
   
+
   #
   # Given that this service has authenticated successfully with the Auth service,
   # returns the token returned as part of the authentication response.
@@ -84,6 +58,10 @@ class Api
   end
 
 
+  #
+  # Api::Response instances wrap Typhoeus responses as an abstraction layer, but also
+  # in order to provide lazy evaluation of headers and JSON decoding of the body.
+  #
   class Response
     
     def initialize(response)
@@ -92,10 +70,16 @@ class Api
       @body = nil
     end
 
+    #
+    # The status code of the HTTP response.
+    #
     def status
       @response.response_code
     end
 
+    #
+    # Returns a hash of HTTP response headers.
+    #
     def headers
       @headers ||= (@response.response_headers || "").split("\r\n").inject({}) do |acc, h|
                      k, v = h.split(": ")
@@ -104,52 +88,75 @@ class Api
                    end
     end
 
+    #
+    # Returns the HTTP response body parsed from JSON. This is done lazily and only once.
+    #
     def body
       @body ||= @response.response_body.blank? ? nil : JSON.parse(@response.response_body)
     end
 
+    #
+    # Returns true if the HTTP request timed out.
+    #
+    def timed_out?
+      @response.timed_out?
+    end
   end
 
 
   #
-  # Makes a HTTP request to +host_url+ using the HTTP method +method+. The +resource_name+
+  # Api.request is designed to be the lowest common denominator for making any kind of
+  # HTTP request, except parallel requests which will have a similar method (to which BAN
+  # and PURGE requests to Varnish is a special case).
+  #
+  # In its present form it assumes the request is a JSON one. Eventually, keyword args will
+  # provide abstract control of content type.
+  #
+  # +url+ is the URL to which the request will be made.
+  # +http_method+ is the HTTP method to use (:post, :get, :head, :put, :delete, etc).
+  # +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.
+  #
+  # 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)
+    # 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)
+  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
   # local path, +args+ is a hash of query args, and +headers+ a hash of extra HTTP headers.
   #
   # Returns the response in its entirety so that the caller can examine its status and body.
   #
-
-  def self.call(host_url, http_method, resource_name, path, args={}, headers={})
-    # Set up the connection parameters
-    conn = Faraday.new(host_url) do |c|
-      c.response :json, :content_type => /\bjson$/    # Convert the response body to JSON
-      c.adapter Faraday.default_adapter               # Use net-http
-    end
-    api_version = version_for resource_name
-    path = "/#{api_version}#{path}"
-    # Make the call. TODO: retries?
-    response = conn.send(http_method, path, args, headers) do |request|
-      request.headers['Accept'] = 'application/json'
-      request.headers['Content-Type'] = 'application/json'
+  # It is quite probable that this method will become deprecated. The main reason for its existence
+  # is the version computation, nothing more, and separating host and path isn't ideal.
+  #
+  def self.call(host_url, http_method, resource_name, path, args=nil, headers={})
+    if [:post, :put].include? http_method
+      request "#{host_url}/#{version_for resource_name}#{path}", http_method,
+                    headers: headers, body: args 
+    else
+      request "#{host_url}/#{version_for resource_name}#{path}", http_method,
+                    headers: headers, args: args 
     end
-    response
   end
 
-  # def self.call(host_url, http_method, resource_name, path, args_or_body={}, headers={})
-  #   # Set up the request
-  #   url = "#{host_url}/#{version_for resource_name}#{path}"
-  #   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_or_body.is_a?(String) ? nil : args_or_body, 
-  #                                   body:   args_or_body.is_a?(String) ? args_or_body : nil
-  #                                  )
-  #   # Run it
-  #   response = request.run
-  #   # Return the response
-  #   Response.new(response)
-  # end 
 
   #
   # Convenience method to make an internal +GET+ request to the Ocean Api. The +resource_name+
@@ -191,6 +198,7 @@ class Api
   #
   def self.delete(*args) call(INTERNAL_OCEAN_API_URL, :delete, *args); end
 
+
   #
   # Makes an internal +PURGE+ call to all Varnish instances. The call is made in parallel.
   # Varnish will only accept +PURGE+ requests coming from the local network.
@@ -205,6 +213,7 @@ class Api
     hydra.run
   end
 
+
   #
   # Makes an internal +BAN+ call to all Varnish instances. The call is made in parallel.
   # Varnish will only accept +BAN+ requests coming from the local network.
@@ -265,6 +274,7 @@ class Api
     ::Base64.strict_encode64 "#{username}:#{password}"
   end
   
+
   #
   # Takes encoded credentials (e.g. by Api.encode_credentials) and returns a two-element array
   # where the first element is the username and the second is the password. If the encoded
@@ -280,6 +290,7 @@ class Api
     [username || "", password || ""]
   end
   
+
   #
   # Performs authorisation against the Auth service. The +token+ must be a token received as a 
   # result of a prior authentication operation. The args should be in the form
@@ -334,6 +345,7 @@ class Api
     'disconnect' => ['connect', 'DELETE']
   }
 
+
   #
   # Returns the hyperlink and HTTP method to use for an +action+ in a certain +controller+.
   # First, the +DEFAULT_ACTIONS+ are searched, then any extra actions defined for the

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "2.6.2"
+  VERSION = "2.7.0"
 end

data/lib/ocean/zeromq_logger.rb

@@ -92,22 +92,27 @@ class ZeromqLogger
 
 
   def debug(*args)
+    return if args.blank?
     add 0, *args
   end
 
   def info(*args)
+    return if args.blank?
     add 1, *args
   end
 
   def warn(*args)
+    return if args.blank?
     add 2, *args
   end
 
   def error(*args)
+    return if args.blank?
     add 3, *args
   end
 
   def fatal(*args)
+    return if args.blank?
     add 4, *args
   end
 

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement