ocean-rails 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5196e49a82cdc5c825f9b4524b2fe9adfe3a9e15
-  data.tar.gz: 5e57fb8270cc2fad3f6f9f39fbf907539e4a2a0e
+  metadata.gz: c40e04d9a10d45f336d5c870c88bb78520d5fc90
+  data.tar.gz: 42d04e38d27d92bd906daeca2d817a5dc80c8ddb
 SHA512:
-  metadata.gz: 8ddf46f41e2bdbad6268f85587ae486518bac79c4f7a7bde144838c8feb2d73d6658b6e06de51176331d083dd56adb65c903d5362675f2c77bff8958411a940e
-  data.tar.gz: 06cfdf2f0db1b8cc5261d63ac0e56c4dddb456e6c7f02b8d4f822c8df1792b6a2c27ee3d7cf493d1e55f856dc10921ad2c3a3e44297800b8bf65945310468344
+  metadata.gz: 0ce76c663f2a663a91d6262f73f98e9e99a1f834053731ac66712a429c159f9a3ab6d88d32c0f338913d17bf288fd13a32abbbfdd539698a4bcbd75e64389c90
+  data.tar.gz: 97fd6522add6458b8e98e1801ee66f286a984f37484da1351c1b8bf7825361decdf86f2f552992839c544176fe3ef4bfe791046a700f09434e348fdab079cf25

data/lib/ocean-rails.rb

@@ -36,13 +36,16 @@ end
 #
 # 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.
+# and +creator_uri+ given by the parameters. It also allows the value of 'right' to
+# be specified: this will restrict all SQL queries accordingly.
 #
-def permit_with(status, user_id: 123, creator_uri: "https://api.example.com/v1/api_users/#{user_id}")
+def permit_with(status, user_id: 123, creator_uri: "https://api.example.com/v1/api_users/#{user_id}",
+                        right: nil)
   Api.stub(:permitted?).
     and_return(double(:status => status, 
                       :body => {'authentication' => 
                                  {'user_id' => user_id,
+                                  'right' => right,
                                   '_links' => { 'creator' => {'href' => creator_uri,
                                                               'type' => 'application/json'}}}}))
 end
@@ -56,3 +59,19 @@ def deny_with(status, *error_messages)
     and_return(double(:status => status, 
                       :body => {'_api_error' => error_messages}))
 end
+
+
+#
+# Takes a relation and adds right restrictions, if present.
+#
+def add_right_restrictions(rel, restrictions)
+  return rel unless restrictions
+  # The below works only for a single restriction (multiple should be ORed)
+  restrictions.each do |rr|
+    rel = rel.where("app" => rr["app"]) if rr["app"] != "*"
+    rel = rel.where("context" => rr["context"]) if rr["context"] != "*"
+  end
+  rel
+end
+
+

data/lib/ocean/api_resource.rb

@@ -41,13 +41,14 @@ module ApiResource
     # also be declared using +ocean_resource_model+.
     #
     def collection(bag={})
-      collection_internal bag, bag[:group], bag[:search], bag[:page], bag[:page_size]
+      collection_internal bag, bag[:group], bag[:search], bag[:page], bag[:page_size],
+                          bag['_right_restrictions']
     end
 
 
     private 
 
-    def collection_internal(conds={}, group, search, page, page_size)
+    def collection_internal(conds={}, group, search, page, page_size, restrictions)
       if index_only != []
         new_conds = {}
         index_only.each do |key| 
@@ -77,8 +78,8 @@ module ApiResource
         page_size = page_size.to_i || collection_page_size
         query = query.limit(page_size).offset(page_size * page)
       end
-      # Finally, return the accumulated Relation
-      query
+      # Finally, add any app/context restrictions, then return the accumulated Relation
+      add_right_restrictions(query, restrictions) 
     end
 
 

data/lib/ocean/ocean_application_controller.rb

@@ -64,9 +64,12 @@ module OceanApplicationController
     qs = Api.authorization_string(@@extra_actions, controller_name, action_name)
     response = Api.permitted?(@x_api_token, query: qs)                                   
     if response.status == 200
-      @auth_api_user_id = response.body['authentication']['user_id']  # Deprecate and remove
-      @auth_api_user_uri = response.body['authentication']['_links']['creator']['href']  # Keep
-      Thread.current[:username] = response.body['authentication']['username']
+      @authentication = response.body['authentication']
+      @auth_api_user_id = @authentication['user_id']  # Deprecate and remove
+      @auth_api_user_uri = @authentication['_links']['creator']['href']  # Keep
+      Thread.current[:username] = @authentication['username']
+      @right_restrictions = @authentication['right']
+      params['_right_restrictions'] = @right_restrictions if @right_restrictions
       return true
     end
     error_messages = response.body['_api_error']
@@ -236,6 +239,7 @@ module OceanApplicationController
   # member.
   #
   def collection_etag(coll)
+    coll = add_right_restrictions(coll, @right_restrictions)
     klass = coll.name.constantize # Force a load of the class (for secondary collections)
     timestamp = klass.update_timestamp || klass.create_timestamp
     if (timestamp)
@@ -244,9 +248,7 @@ module OceanApplicationController
     else
       last_updated = 0
     end
-    # We could also, in the absence of an updated_at attribute, use created_at.
-    { etag: "#{coll.name}:#{coll.count}:#{last_updated}"
-    }
+    { etag: "#{coll.name}:#{coll.count}:#{last_updated}" }
   end
 
 

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "2.7.1"
+  VERSION = "2.8.0"
 end

data/lib/templates/rails/scaffold_controller/controller.rb

@@ -63,6 +63,9 @@ class <%= controller_class_name %>Controller < ApplicationController
      
   def find_<%= singular_table_name %>
     @<%= singular_table_name %> = <%= class_name %>.find_by_id params[:id]
+    # If your table has app and context columns and you have created Rights utilising them,
+    # comment out the line above this comment and uncomment the following one:
+    #@<%= singular_table_name %> = add_right_restrictions(<%= class_name %>.where(id: params[:id]), @right_restrictions).first
     return true if @<%= singular_table_name %>
     render_api_error 404, "<%= class_name %> not found"
     false

metadata

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