ocean-rails 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eb951de7297659f9c79367775f94d75ff8a2903
-  data.tar.gz: 33b32f1b9146fa0570294e064d6153a017121c40
+  metadata.gz: 657f5cff217cb3e6e5fc39cec900587db01631bb
+  data.tar.gz: 5189d82abe5317d0fbb120c7c70722b022c7ac91
 SHA512:
-  metadata.gz: 297addb38efb3762a5fc2da0e9d482da97440ef0fffb6eb25fd0d39c1f52423ce7881104eb8de9529473fd752939b431a10c99cdab7f3d52c47e1bb36d1ed4ce
-  data.tar.gz: 3cdf60d75b61819a9dc1ddc5af0c79e67bc476c0744d96dfa5b688e1bf772e39c7197c467e9190b78e2329befed95c248eb585a4179327f55a8a9137a9251d79
+  metadata.gz: 805073b02c7253848eeb3bce175bcc396217fd497e96e9efa0b76ee0fa9a2ef0b47a4bddc959f1ef558fc9eae74e257d781c8a4cce067d99a08a54c5e92e4b5e
+  data.tar.gz: 18ea51cd7aeff51beb43f64a2f1e2906d6d3e093604f2afdab739427ff5b035f3a9d0550ab4cef4801af2d8dff70f57c69857dac009bb3d1a0e3cc0d657ec16f

data/lib/ocean-rails.rb

@@ -26,7 +26,9 @@ end
 
 
 #
-# For stubbing authorisation calls in RSpec
+# For stubbing successful authorisation calls. Makes <tt>Api.permitted?</tt> return
+# the status, and a body containing a partial authentication containing the +user_id+ 
+# and +creator_uri+ given by the parameters.
 #
 def permit_with(status, user_id: 123, creator_uri: "https://api.example.com/v1/api_users/#{user_id}")
   Api.stub(:permitted?).
@@ -37,6 +39,10 @@ def permit_with(status, user_id: 123, creator_uri: "https://api.example.com/v1/a
                                                               'type' => 'application/json'}}}}))
 end
 
+#
+# For stubbing failed authorisation calls. Makes <tt>Api.permitted?</tt> return the
+# given status and a body containing a standard API error with the given error messages.
+#
 def deny_with(status, *error_messages)
   Api.stub(:permitted?).
     and_return(double(:status => status, 

data/lib/ocean/ocean_application_controller.rb

@@ -71,6 +71,23 @@ module OceanApplicationController
     false
   end
 
+
+  #
+  # Requires the request to be conditional: it must have an +If-None-Match+ and/or an
+  # +If-Modified-Since+ HTTP header. If the request isn't conditional, a 428 error is
+  # returned. The body will be a standard API error message, with two strings:
+  # <tt>"Precondition Required"</tt> and <tt>"If-None-Match and/or If-Modified-Since missing"</tt>.
+  #
+  def require_conditional
+    if request.headers['If-None-Match'].blank? && request.headers['If-Modified-Since'].blank?
+      render_api_error 428, "Precondition Required", 
+                            "If-None-Match and/or If-Modified-Since missing"
+      false
+    else
+      true
+    end
+  end
+
   
   #
   # Updates +created_by+ and +updated_by+ to the ApiUser for which the current request

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "1.16.1"
+  VERSION = "1.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday