hoodoo 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33592f5c0f6228a5253592dff50c587e70319ae8
-  data.tar.gz: 3f7c50f2d5935c5758c2efd61a650b96335be4bf
+  metadata.gz: 686b88cd1d3e169957a22f9bbd1b2e0680143344
+  data.tar.gz: bbb4fe6fdfd02d447ca76c9972ede50aec481ba7
 SHA512:
-  metadata.gz: b5ccdb3765ae191bed76db43c25bbcf674dea032bd8d6ed2b6ff01fdc53ed811748e68ef34dcc1f2f1e89ce2d9f494e2323d31c0292bcf905fd3201661b4ff21
-  data.tar.gz: 3196db1484495a18006ce741da581e77bbce7b3aecf4deb829bb8b96f8005226c486c523d6c1374849323c8241d68cb70cc3dcdbe696f4e6678a723ad5360281
+  metadata.gz: 02bde4ca9622f8b7ce1524341c4e997d54717cc8282addfb86d44ad87333942a6caa6d97bf8d28cd860e40cf50f34cb8c97a90d7015249625dd711e950375658
+  data.tar.gz: c16e8ea17f27fb117816c6e1416ba65248e6d9e3b0b113e05f88f04499afb949d3a00c37412e5073385f1b6b5e3fd5b883173a110d5c9cf874ef717a2f442ea1

data/lib/hoodoo/data/resources/caller.rb

@@ -20,6 +20,7 @@ module Hoodoo
 
           text :authentication_secret
           text :name
+          uuid :fingerprint, :required => false
 
           hash :identity, :required => true do
           end

data/lib/hoodoo/presenters/base.rb

@@ -86,7 +86,16 @@ module Hoodoo
       #                is internationalised but this is omitted, then a value
       #                of "en-nz" is used as a default.
       #
-      def self.render( data, uuid = nil, created_at = nil, language = 'en-nz' )
+      # +created_by+:: Optional fingerprint of the Caller whose credentials
+      #                were used to create the Session under which the
+      #                resource instance was created. Absent if omitted.
+      #
+      def self.render( data,
+                       uuid       = nil,
+                       created_at = nil,
+                       language   = 'en-nz',
+                       created_by = nil )
+
         target = {}
         data   = data || {}
 
@@ -117,7 +126,8 @@ module Hoodoo
             'created_at' => Hoodoo::Utilities.standard_datetime( created_at.to_datetime )
           } )
 
-          target[ 'language' ] = language if self.is_internationalised?()
+          target[ 'created_by' ] = created_by unless created_by.nil?
+          target[ 'language'   ] = language if self.is_internationalised?()
 
         end
 
@@ -157,6 +167,10 @@ module Hoodoo
       # +created_at+::   Same as the +created_at+ parameter to ::render, except
       #                  mandatory.
       #
+      # +created_by+::   Optional fingerprint of the Caller whose credentials
+      #                  were used to create the Session under which the
+      #                  resource instance was created.
+      #
       # +language+::     Optional value for resource's +language+ field; taken
       #                  from the +context+ parameter if omitted.
       #
@@ -180,12 +194,13 @@ module Hoodoo
       def self.render_in( context, data, options = {} )
         uuid         = options[ :uuid         ]
         created_at   = options[ :created_at   ]
+        created_by   = options[ :created_by   ]
         language     = options[ :language     ] || context.request.locale
         secured_with = options[ :secured_with ]
         embeds       = options[ :embeds       ]
         references   = options[ :references   ]
 
-        target = self.render( data, uuid, created_at, language )
+        target = self.render( data, uuid, created_at, language, created_by )
 
         if secured_with.is_a?( ::ActiveRecord::Base )
           result_hash     = {}
@@ -233,6 +248,9 @@ module Hoodoo
             'kind'       => data[ :kind       ]
           }
 
+          created_by = data[ :created_by ]
+          common_fields[ 'created_by' ] = created_by unless created_by.nil?
+
           if self.is_internationalised?
             common_fields[ 'internationalised' ] = data[ 'internationalised' ]
             Hoodoo::Presenters::CommonResourceFields.get_schema.properties[ 'language' ].required = true

data/lib/hoodoo/services/middleware/middleware.rb

@@ -164,6 +164,7 @@ module Hoodoo; module Services
       'caller_version'       => 1,
       'caller_id'            =>                  'c5ea12fb7f414a46850e73ee1bf6d95e',
       'caller_identity_name' =>                  'c5ea12fb7f414a46850e73ee1bf6d95e',
+      'caller_fingerprint'   =>                  '7bc0b402a77543a49d0b1b671253fb25',
       'identity'             => { 'caller_id' => 'c5ea12fb7f414a46850e73ee1bf6d95e' },
       'permissions'          => Hoodoo::Services::Permissions.new( {
         'default' => { 'else' => Hoodoo::Services::Permissions::ALLOW }
@@ -1210,6 +1211,7 @@ module Hoodoo; module Services
             'caller_id'            => session.caller_id,
             'caller_version'       => session.caller_version,
             'caller_identity_name' => session.caller_identity_name,
+            'caller_fingerprint'   => session.caller_fingerprint,
             'identity'             => Hoodoo::Utilities.stringify( ( session.identity || {} ).to_h() )
           }
         end

data/lib/hoodoo/services/services/session.rb

@@ -39,6 +39,13 @@ module Hoodoo
       #
       attr_accessor :caller_identity_name
 
+      # An optional property of a session is the Caller's fingerprint, a
+      # UUID assigned to some Callers which can be persisted by resource
+      # instances when created and rendered in the +created_by+ field
+      # via e.g. Hoodoo::Presenters::Base.#render_in.
+      #
+      attr_accessor :caller_fingerprint
+
       # Callers can change; if so, related sessions must be invalidated.
       # This must be achieved by keeping a version count on the Caller. A
       # session is associated with a particular Caller version and if the
@@ -126,25 +133,29 @@ module Hoodoo
       #
       # Options are:
       #
-      # +session_id+::     UUID of this session. If unset, a new UUID is
-      #                    generated for you. You can read the UUID with
-      #                    the #session_id accessor method.
+      # +session_id+::        UUID of this session. If unset, a new UUID is
+      #                       generated for you. You can read the UUID with
+      #                       the #session_id accessor method.
+      #
+      # +caller_id+::         UUID of the Caller instance associated with this
+      #                       session. This can be set either now or later, but
+      #                       the session cannot be saved without it.
       #
-      # +caller_id+::      UUID of the Caller instance associated with this
-      #                    session. This can be set either now or later, but
-      #                    the session cannot be saved without it.
+      # +caller_version+::    Version of the Caller instance; defaults to zero.
       #
-      # +caller_version+:: Version of the Caller instance; defaults to zero.
+      # +caller_fingerprint:: Optional Caller fingerprint UUID. Default to
+      #                       +nil+.
       #
       # +memcached_host+:: Host for Memcached connections.
       #
       def initialize( options = {} )
         @created_at = Time.now.utc
 
-        self.session_id     = options[ :session_id     ] || Hoodoo::UUID.generate()
-        self.memcached_host = options[ :memcached_host ]
-        self.caller_id      = options[ :caller_id      ]
-        self.caller_version = options[ :caller_version ] || 0
+        self.session_id         = options[ :session_id         ] || Hoodoo::UUID.generate()
+        self.memcached_host     = options[ :memcached_host     ]
+        self.caller_id          = options[ :caller_id          ]
+        self.caller_version     = options[ :caller_version     ] || 0
+        self.caller_fingerprint = options[ :caller_fingerprint ]
       end
 
       # Save this session to the transient store, in a manner that will allow
@@ -471,6 +482,7 @@ module Hoodoo
           caller_id
           caller_version
           caller_identity_name
+          caller_fingerprint
 
         ).each do | property |
           value = self.send( property )
@@ -516,6 +528,7 @@ module Hoodoo
           caller_id
           caller_version
           caller_identity_name
+          caller_fingerprint
 
         ).each do | property |
           value = hash[ property ]

data/lib/hoodoo/version.rb

@@ -12,7 +12,7 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '1.18.0'
+  VERSION = '1.19.0'
 
   # The Hoodoo gem date. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.

data/spec/data/resources/caller_spec.rb

@@ -6,10 +6,11 @@ describe Hoodoo::Data::Resources::Caller do
 
     expect(schema.is_internationalised?()).to eq(true)
 
-    expect(schema.properties.count).to eq(5)
+    expect(schema.properties.count).to eq(6)
 
     expect(schema.properties['authentication_secret']).to be_a(Hoodoo::Presenters::Text)
     expect(schema.properties['name']).to be_a(Hoodoo::Presenters::Text)
+    expect(schema.properties['fingerprint']).to be_a(Hoodoo::Presenters::UUID)
     expect(schema.properties['identity']).to be_a(Hoodoo::Presenters::Hash)
     expect(schema.properties['permissions']).to be_a(Hoodoo::Presenters::Object)
     expect(schema.properties['permissions'].properties['resources']).to be_a(Hoodoo::Presenters::Hash)

data/spec/presenters/base_spec.rb

@@ -328,30 +328,60 @@ describe '#schema' do
       expect(Hoodoo::Data::Resources::World.validate(data, false).errors).to eq([])
     end
 
-    it 'should return no errors with valid data for resource' do
-      data = {
-        :errors_id => Hoodoo::UUID.generate,
-        :test_tags => 'foo,bar,baz',
-        :test_object => {
-          :nested_object => {
-            :name => 'Some name',
-            :obj_suffix => '!'
-          },
-          :test_array => [
-            { :name => 'Some name 0', :ary_suffix => '00' },
-            { :name => 'Some name 1' }
-          ]
-        }
-      }
+    context 'should return' do
+      before :each do
+        @input = Hoodoo::Utilities.stringify( {
+          :errors_id => Hoodoo::UUID.generate,
+          :test_tags => 'foo,bar,baz',
+          :test_object => {
+            :nested_object => {
+              :name => 'Some name',
+              :obj_suffix => '!'
+            },
+            :test_array => [
+              { :name => 'Some name 0', :ary_suffix => '00' },
+              { :name => 'Some name 1' }
+            ]
+          }
+        } )
+      end
 
-      data = Hoodoo::Utilities.stringify(data)
-      rendered = Hoodoo::Data::Resources::World.render(
-        data,
-        Hoodoo::UUID.generate,
-        Time.now
-      )
+      it 'no errors with valid data for resource' do
+        rendered = Hoodoo::Data::Resources::World.render(
+          @input,
+          Hoodoo::UUID.generate,
+          Time.now
+        )
 
-      expect(Hoodoo::Data::Resources::World.validate(rendered, true).errors).to eq([])
+        expect(Hoodoo::Data::Resources::World.validate(rendered, true).errors).to eq([])
+      end
+
+      it 'no errors with valid data for resource with fingerprint' do
+        rendered = Hoodoo::Data::Resources::World.render(
+          @input,
+          Hoodoo::UUID.generate,
+          Time.now,
+          'en-gb',
+          Hoodoo::UUID.generate
+        )
+
+        expect(Hoodoo::Data::Resources::World.validate(rendered, true).errors).to eq([])
+      end
+
+      it 'a complaint about missing language if internationalised' do
+        rendered = Hoodoo::Data::Resources::World.render(
+          @input,
+          Hoodoo::UUID.generate,
+          Time.now,
+          nil
+        )
+
+        expect(Hoodoo::Data::Resources::World.validate(rendered, true).errors).to eq([{
+          'code'      => 'generic.required_field_missing',
+          'message'   => 'Field `language` is required',
+          'reference' => 'language'
+        }])
+      end
     end
 
     it 'should return correct errors invalid data' do
@@ -654,48 +684,70 @@ describe '#schema' do
       })
     end
 
-    it 'should render correctly as a resource with a UUID' do
-      data = Hoodoo::Utilities.stringify({
-        :errors_id => Hoodoo::UUID.generate,
-        :test_tags => 'foo,bar,baz',
-        :test_object => {
-          :nested_object => {
-            :name => 'Some name',
-            :obj_suffix => '!'
-          },
-          :test_array => [
-            { :name => 'Some name 0', :ary_suffix => '00' },
-            { :name => 'Some name 1' }
-          ]
+    context 'should render correctly as a resource' do
+      before :each do
+        @uuid  = Hoodoo::UUID.generate
+        @time  = Time.now
+        @input = Hoodoo::Utilities.stringify({
+          :errors_id => Hoodoo::UUID.generate,
+          :test_tags => 'foo,bar,baz',
+          :test_object => {
+            :nested_object => {
+              :name => 'Some name',
+              :obj_suffix => '!'
+            },
+            :test_array => [
+              { :name => 'Some name 0', :ary_suffix => '00' },
+              { :name => 'Some name 1' }
+            ]
+          }
+        })
+
+        @output = {
+          'id' => @uuid,
+          'kind' => 'World',
+          'created_at' => Hoodoo::Utilities.standard_datetime( @time ),
+          'language' => 'en-gb',
+          'errors_id' => @input['errors_id'],
+          'test_tags' => 'foo,bar,baz',
+          'test_object' => {
+            'nested_object' => {
+              'name' => 'Some name',
+              'obj_suffix' => '!'
+            },
+            'test_array' => [
+              { 'name' => 'Some name 0', 'ary_suffix' => '00' },
+              { 'name' => 'Some name 1' }
+            ]
+          }
         }
-      })
+      end
 
-      uuid = Hoodoo::UUID.generate
-      time = Time.now
-
-      expect(Hoodoo::Data::Resources::World.render(
-        data,
-        uuid,
-        time,
-        'en-gb'
-      )).to eq({
-        'id' => uuid,
-        'kind' => 'World',
-        'created_at' => Hoodoo::Utilities.standard_datetime( time ),
-        'language' => 'en-gb',
-        'errors_id' => data['errors_id'],
-        'test_tags' => 'foo,bar,baz',
-        'test_object' => {
-          'nested_object' => {
-            'name' => 'Some name',
-            'obj_suffix' => '!'
-          },
-          'test_array' => [
-            { 'name' => 'Some name 0', 'ary_suffix' => '00' },
-            { 'name' => 'Some name 1' }
-          ]
-        }
-      })
+      it 'with a UUID' do
+        expect(
+          Hoodoo::Data::Resources::World.render(
+            @input,
+            @uuid,
+            @time,
+            'en-gb'
+          )
+        ).to( eq( @output ) )
+      end
+
+      it 'with a UUID and fingerprint' do
+        fingerprint = Hoodoo::UUID.generate()
+        @output[ 'created_by' ] = fingerprint
+
+        expect(
+          Hoodoo::Data::Resources::World.render(
+            @input,
+            @uuid,
+            @time,
+            'en-gb',
+            fingerprint
+          )
+        ).to( eq( @output ) )
+      end
     end
 
     it 'should complain about resources with no creation date' do
@@ -803,6 +855,22 @@ describe '#schema' do
       })
     end
 
+    it 'renders with fingerprint' do
+      data = {}
+      t = Time.now.utc
+      u = Hoodoo::UUID.generate
+      f = Hoodoo::UUID.generate
+      options = { :uuid => u, :created_at => t, :created_by => f }
+      expect(TestPresenter5.render_in(@con, data, options)).to eq({
+        'id'         => u,
+        'kind'       => 'TestPresenter5',
+        'created_at' => Hoodoo::Utilities.standard_datetime( t ),
+        'created_by' => f,
+        'language'   => 'de',
+        'three'      => 'default_three'
+      })
+    end
+
     it 'overrides language' do
       data = {}
       t = Time.now.utc

data/spec/services/middleware/amqp_log_writer_spec.rb

@@ -3,14 +3,16 @@ require 'timecop'
 
 describe Hoodoo::Services::Middleware::AMQPLogWriter do
   before :each do
-    @session_id     = Hoodoo::UUID.generate
-    @caller_id      = Hoodoo::UUID.generate
-    @caller_version = 2
-    @session        = Hoodoo::Services::Session.new( {
-      :session_id     => @session_id,
-      :memcached_host => '0.0.0.0:0',
-      :caller_id      => @caller_id,
-      :caller_version => @caller_version
+    @session_id         = Hoodoo::UUID.generate
+    @caller_id          = Hoodoo::UUID.generate
+    @caller_version     = 2
+    @caller_fingerprint = Hoodoo::UUID.generate
+    @session            = Hoodoo::Services::Session.new( {
+      :session_id         => @session_id,
+      :memcached_host     => '0.0.0.0:0',
+      :caller_id          => @caller_id,
+      :caller_version     => @caller_version,
+      :caller_fingerprint => @caller_fingerprint
     } )
 
     @permissions_hash = {

data/spec/services/middleware/middleware_logging_spec.rb

@@ -392,6 +392,7 @@ describe Hoodoo::Services::Middleware do
             expect( data[ :session ][ 'caller_id'            ] ).to be_present
             expect( data[ :session ][ 'caller_version'       ] ).to be_present
             expect( data[ :session ][ 'caller_identity_name' ] ).to be_present
+            expect( data[ :session ][ 'caller_fingerprint'   ] ).to be_present
             expect( data[ :session ][ 'identity'             ] ).to be_present
 
             expect( data[ :session ][ 'permissions' ] ).to_not be_present
@@ -423,6 +424,7 @@ describe Hoodoo::Services::Middleware do
             expect( data[ :session ][ 'caller_id'            ] ).to be_present
             expect( data[ :session ][ 'caller_version'       ] ).to be_present
             expect( data[ :session ][ 'caller_identity_name' ] ).to be_present
+            expect( data[ :session ][ 'caller_fingerprint'   ] ).to be_present
             expect( data[ :session ][ 'identity'             ] ).to be_present
             expect( data[ :session ][ 'permissions'          ] ).to be_present
             expect( data[ :session ][ 'scoping'              ] ).to be_present

data/spec/services/middleware/middleware_permissions_spec.rb

@@ -306,14 +306,16 @@ describe Hoodoo::Services::Middleware do
   before :each do
     spec_helper_use_mock_memcached()
 
-    @session_id     = Hoodoo::UUID.generate
-    @caller_id      = Hoodoo::UUID.generate
-    @caller_version = 1
-    @session        = Hoodoo::Services::Session.new( {
-      :session_id     => @session_id,
-      :memcached_host => '0.0.0.0:0',
-      :caller_id      => @caller_id,
-      :caller_version => @caller_version
+    @session_id         = Hoodoo::UUID.generate
+    @caller_id          = Hoodoo::UUID.generate
+    @caller_version     = 1
+    @caller_fingerprint = Hoodoo::UUID.generate
+    @session            = Hoodoo::Services::Session.new( {
+      :session_id         => @session_id,
+      :memcached_host     => '0.0.0.0:0',
+      :caller_id          => @caller_id,
+      :caller_version     => @caller_version,
+      :caller_fingerprint => @caller_fingerprint
     } )
 
     # Grant top-level access to all of the Clock endpoints

data/spec/services/services/session_spec.rb

@@ -16,6 +16,7 @@ describe Hoodoo::Services::Session do
       expect( s.memcached_host ).to be_nil
       expect( s.caller_id ).to be_nil
       expect( s.caller_version ).to eq( 0 )
+      expect( s.caller_fingerprint ).to be_nil
     end
 
     it 'initialises with given options' do
@@ -23,13 +24,15 @@ describe Hoodoo::Services::Session do
         :session_id => '1234',
         :memcached_host => 'abcd',
         :caller_id => '0987',
-        :caller_version => 2
+        :caller_version => 2,
+        :caller_fingerprint => 'asdf'
       )
       expect( s.created_at ).to be_a( Time )
       expect( s.session_id ).to eq( '1234' )
       expect( s.memcached_host ).to eq( 'abcd' )
       expect( s.caller_id ).to eq( '0987' )
       expect( s.caller_version ).to eq( 2 )
+      expect( s.caller_fingerprint ).to eq( 'asdf' )
     end
 
     it 'reports not expired when it has no expiry' do
@@ -48,7 +51,8 @@ describe Hoodoo::Services::Session do
         :session_id => '1234',
         :memcached_host => 'abcd',
         :caller_id => '0987',
-        :caller_version => 2
+        :caller_version => 2,
+        :caller_fingerprint => 'asdf'
       )
       p = Hoodoo::Services::Permissions.new
 
@@ -59,15 +63,16 @@ describe Hoodoo::Services::Session do
       h = s.to_h
 
       expect( h ).to eq( {
-        'session_id'     => '1234',
-        'caller_id'      => '0987',
-        'caller_version' => 2,
+        'session_id'         => '1234',
+        'caller_id'          => '0987',
+        'caller_version'     => 2,
+        'caller_fingerprint' => 'asdf',
 
-        'created_at'     => Hoodoo::Utilities.standard_datetime( s.created_at ),
+        'created_at'         => Hoodoo::Utilities.standard_datetime( s.created_at ),
 
-        'identity'       => { 'foo' => 'foo', 'bar' => 'bar' },
-        'scoping'        => { 'baz' => [ 'foo', 'bar', 'baz' ] },
-        'permissions'    => p.to_h()
+        'identity'           => { 'foo' => 'foo', 'bar' => 'bar' },
+        'scoping'            => { 'baz' => [ 'foo', 'bar', 'baz' ] },
+        'permissions'        => p.to_h()
       } )
     end
 
@@ -77,16 +82,17 @@ describe Hoodoo::Services::Session do
       c = Time.now.utc
       e = Time.now.utc + 10
       h = {
-        'session_id'     => '1234',
-        'caller_id'      => '0987',
-        'caller_version' => 2,
+        'session_id'         => '1234',
+        'caller_id'          => '0987',
+        'caller_version'     => 2,
+        'caller_fingerprint' => 'asdf',
 
-        'created_at'     => Hoodoo::Utilities.standard_datetime( c ),
-        'expires_at'     => Hoodoo::Utilities.standard_datetime( e ),
+        'created_at'         => Hoodoo::Utilities.standard_datetime( c ),
+        'expires_at'         => Hoodoo::Utilities.standard_datetime( e ),
 
-        'identity'       => { 'foo' => 'foo', 'bar' => 'bar' },
-        'scoping'        => { 'baz' => [ 'foo', 'bar', 'baz' ] },
-        'permissions'    => p.to_h()
+        'identity'           => { 'foo' => 'foo', 'bar' => 'bar' },
+        'scoping'            => { 'baz' => [ 'foo', 'bar', 'baz' ] },
+        'permissions'        => p.to_h()
       }
 
       s.from_h!( h )
@@ -94,6 +100,7 @@ describe Hoodoo::Services::Session do
       expect( s.session_id ).to eq( '1234' )
       expect( s.caller_id ).to eq( '0987' )
       expect( s.caller_version ).to eq( 2 )
+      expect( s.caller_fingerprint ).to eq( 'asdf' )
       expect( s.created_at ).to eq( Time.parse( Hoodoo::Utilities.standard_datetime( c ) ) )
       expect( s.expires_at ).to eq( Time.parse( Hoodoo::Utilities.standard_datetime( e ) ) )
       expect( s.identity.foo ).to eq( 'foo' )
@@ -107,7 +114,8 @@ describe Hoodoo::Services::Session do
         :session_id => '1234',
         :memcached_host => 'abcd',
         :caller_id => '0987',
-        :caller_version => 2
+        :caller_version => 2,
+        :caller_fingerprint => 'asdf'
       )
 
       expect( s1.save_to_store ).to eq( :ok )
@@ -137,6 +145,7 @@ describe Hoodoo::Services::Session do
       expect( s2.memcached_host ).to be_nil
       expect( s2.caller_id ).to eq( s1.caller_id )
       expect( s2.caller_version ).to eq( s1.caller_version )
+      expect( s2.caller_fingerprint ).to eq( s1.caller_fingerprint )
     end
 
     it 'can be deleted' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Loyalty New Zealand