ocean-rails 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e35b6a26426816dec30071f7fd2c87272e4530d7
-  data.tar.gz: ac1e42b243d0985e4aba91f2b2939ec0e3b3d0c4
+  metadata.gz: 9a20a0b667cf8116ca4b9f5636927ee1e363484b
+  data.tar.gz: 63f9521d2df37e1dfa8aaee5eecbb3f40e3959c6
 SHA512:
-  metadata.gz: 00265cc72834b55c5c5c9e4e4d2f672dddd14ebbbd20baf65c9d28d2898138054d7fd9f08a36c5eacfdc025a04cda1f83373ffe0cda7306fd195cd6db8dde6f1
-  data.tar.gz: 191b0d669a58c0efcac288da5a6605f6d97fcbc62d89a650333f4083fec9da7938fe2b037412a1b20a28f4d2c03ec55582064ceb3855ac820ae71e118f064b9f
+  metadata.gz: 05d47be29854d4388b6299b578911fb901541d408341ccb1f22ef5b3976d012a3c23ba057c797a97ed1251f0b3eed5641aeec7519946cf05b8b358a35494ae7c
+  data.tar.gz: bebf3921bfb685b956a4d2cc865bfbdfa6fcf4299a2854ba418ea9ed94b3ef7172433c01c5dadac554cef3d4b8531c1a8447daf172226cd157d0a4e06fc16411

data/config/initializers/_zeromq_logger.rb

@@ -49,12 +49,14 @@ if Rails.env == 'production' && ENV['NO_ZEROMQ_LOGGING'].blank?
       data[:filter] = Thread.current[:filter] if Thread.current[:filter]
       data[:token] = Thread.current[:x_api_token] if Thread.current[:x_api_token].present?
       data[:username] = Thread.current[:username] if Thread.current[:username].present?
+      data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
 
       Thread.current[:logdata] = data
       Thread.current[:filter] = nil
       Thread.current[:x_api_token] = nil
       Thread.current[:username] = nil
       Thread.current[:cache_control] = nil
+      Thread.current[:metadata] = nil
     end
   end
 

data/lib/ocean/api.rb

@@ -155,8 +155,8 @@ class Api
   #
   # The backoff time is increased after each wait period by the product of itself and 
   # backoff_rate. The backoff time is capped by backoff_max. The default time and rate
-  # settings will generate the progression 1, 1.9, 3.61, 6.859, 13.0321, 24.76099, etc.
-  # To disable waiting between retries, set +backoff_time+ to zero.
+  # settings will generate the progression 1, 1.9, 3.61, 6.859, 13.0321, 24.76099, 30, 30, 
+  # 30, etc. To disable waiting between retries entirely, set +backoff_time+ to zero.
   #
   def self.request(url, http_method, args: nil, headers: {}, body: nil,
                    credentials: nil,

data/lib/ocean/api_remote_resource.rb

@@ -4,7 +4,6 @@ class Api
   # This class represents an Ocean resource accessed by a URI. 
   # 
   # The resource is read lazily. Retries and back off properties are available.
-  # Conditional GETs are used whenever possible.
   #
   #   thing = Api::RemoteResource.new("http://api.example.com/things/1")
   #   thing.present? => false
@@ -53,8 +52,8 @@ class Api
   #
   # If get or get! retrieve an Ocean collection, they will return an array of RemoteResources.
   #
-  # <tt>thing.get!</tt> returns the Api::RemoteResource if successful. If not, raises an exception.
-  # <tt>thing.get</tt> does the same, but always returns the Api::RemoteResource. The remote resource
+  # +thing.get!+ returns the RemoteResource if successful. If not, raises an exception.
+  # +thing.get+ does the same, but always returns the RemoteResource. The remote resource
   # can be examined to see its status.
   #
   # Exceptions:
@@ -76,7 +75,21 @@ 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.  
+  # hash, which must have at least a +_links+ hyperlink attribute with a href and a content type. 
+  #
+  # To refresh a resource using a conditional GET:
+  #
+  #  +thing.refresh+
+  #  +thing.refresh!+
+  #
+  # NB: this class can also be used to fetch any JSON data. E.g.:
+  #
+  #   Api::RemoteResource.get("http://example.com/anything").raw
+  #
+  # +#raw+ will return any raw data received, even if it wasn't recognised as an Ocean resource
+  # and +JsonIsNoResource+ was raised. The +.get+ will suppress any exceptions. If +#raw+ returns 
+  # +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.
   #
   class RemoteResource
 

data/lib/ocean/ocean_application_controller.rb

@@ -31,6 +31,8 @@ module OceanApplicationController
     return true if ENV['NO_OCEAN_AUTH']
     @x_api_token = request.headers['X-API-Token']
     Thread.current[:x_api_token] = @x_api_token
+    @x_metadata = request.headers['X-Metadata']
+    Thread.current[:metadata] = @x_metadata
     return true if @x_api_token.present?
     logger.info "X-API-Token missing"
     render_api_error 400, "X-API-Token missing"

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "3.4.0"
+  VERSION = "3.5.0"
 end

data/lib/ocean/zeromq_logger.rb

@@ -84,6 +84,7 @@ class ZeromqLogger
     data[:username] = Thread.current[:username] if Thread.current[:username].present?
     data[:msg] = msg if msg.is_a?(String)
     data[:timestamp] = (Time.now.utc.to_f * 1000).to_i unless data[:timestamp]
+    data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
     data = data.merge msg if msg.is_a?(Hash)
     @logger.log data
     true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus