hoodoo 2.12.0 → 2.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6cfaed24695383d45ef45ee57241f89f37ef6005247c613014238c59b57f158
-  data.tar.gz: 0547a5c355d815eaf6709f5023fa9878065f613d43c492fe781d87dbcb40b075
+  metadata.gz: ef8db3ad23e93ddb58cfa9c5d41342cbab01f00ce55e57b37cd93748732da340
+  data.tar.gz: bead6ded0b48b1b7ed361b9ec07ae59cdb0a797342ad8f96bac3b000bfc2cbf3
 SHA512:
-  metadata.gz: af7cd5e04e9ed36530627d80120a43a3f7e5569fda99969cf23c437edb98e509011cd00a83e720d67027bbfedd09a2b3cdc20cbcfcbd7b6d56dfb1a30152122a
-  data.tar.gz: a4cc5ef27dfb5ae7d8f3c8ad555fd96101ca0ac6b864055d4b37534a276ffb47856da28c9b7eacbe6fb93b766b9285c164ae338d76ed268998c209dc5b2446a6
+  metadata.gz: 0ecf3d0a5c33119941526e9b04684f72ed12c96d351755fcaa773e8b4b14918bc5a55a57cd4411d592448f54b25d09546f249ba37b7fca50c26e2d341a2f02cd
+  data.tar.gz: 523010953e4d7d3a07036224158163bc43743a45afe1ce5c106102ff50e1ae251090d4c04b2b8f3faa741d14032e68479e484273aaf7021d6c428a67a707c666

data/lib/hoodoo/client/endpoint/endpoints/http.rb

@@ -56,7 +56,22 @@ module Hoodoo
 
           # See Hoodoo::Client::Endpoint#show.
           #
+          # In RESTful HTTP, `GET /resources/#{ident = nil}` gets evaluated
+          # as `GET /resources/`, which is of course interpreted as a #list
+          # request. Since this is undesirable behaviour, the +ident+ must be
+          # populated, and this will return `404 Not Found` if it is not.
+          #
           def show( ident, query_hash = nil )
+            if ident.nil?
+              data = response_class_for( :show ).new
+              data.platform_errors.add_error(
+                'platform.not_found',
+                'reference' => {entity_name: 'nil identifier given on :show action'}
+              )
+
+              return data
+            end
+
             d            = @description.dup
             d.action     = :show
             d.ident      = ident

data/lib/hoodoo/presenters/base.rb

@@ -90,12 +90,16 @@ module Hoodoo
       #                were used to create the Session under which the
       #                resource instance was created. Absent if omitted.
       #
+      # +updated_at+:: Optional Date/Time of instance update. This is a Ruby
+      #                DateTime instance or similar, _NOT_ a string!
+      #
       def self.render( data,
                        uuid       = nil,
                        created_at = nil,
                        language   = 'en-nz',
-                       created_by = nil )
-
+                       created_by = nil,
+                       updated_at = nil
+                      )
         target = {}
         data   = data || {}
 
@@ -126,6 +130,7 @@ module Hoodoo
             'created_at' => Hoodoo::Utilities.standard_datetime( created_at.to_datetime )
           } )
 
+          target[ 'updated_at' ] = Hoodoo::Utilities.standard_datetime( updated_at.to_datetime ) unless updated_at.nil?
           target[ 'created_by' ] = created_by unless created_by.nil?
           target[ 'language'   ] = language if self.is_internationalised?()
 
@@ -167,6 +172,9 @@ module Hoodoo
       # +created_at+::   Same as the +created_at+ parameter to ::render, except
       #                  mandatory.
       #
+      # +updated_at+::   Optional value expressing the time the resource was last
+      #                  updated.
+      #
       # +created_by+::   Optional fingerprint of the Caller whose credentials
       #                  were used to create the Session under which the
       #                  resource instance was created.
@@ -194,13 +202,14 @@ module Hoodoo
       def self.render_in( context, data, options = {} )
         uuid         = options[ :uuid         ]
         created_at   = options[ :created_at   ]
+        updated_at   = options[ :updated_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, created_by )
+        target = self.render( data, uuid, created_at, language, created_by, updated_at )
 
         if defined?( ::ActiveRecord ) && secured_with.is_a?( ::ActiveRecord::Base )
           result_hash     = {}
@@ -251,6 +260,9 @@ module Hoodoo
           created_by = data[ :created_by ]
           common_fields[ 'created_by' ] = created_by unless created_by.nil?
 
+          updated_at = data[ :updated_at ]
+          common_fields[ 'updated_at' ] = updated_at unless updated_at.nil?
+
           if self.is_internationalised?
             common_fields[ 'internationalised' ] = data[ 'internationalised' ]
             Hoodoo::Presenters::CommonResourceFields.get_schema.properties[ 'language' ].required = true

data/lib/hoodoo/presenters/base_dsl.rb

@@ -747,6 +747,10 @@ module Hoodoo
       #   Hoodoo::Presenters::Text
       # [:uuid]
       #   Hoodoo::Presenters::UUID
+      # [:hash]
+      #   Hoodoo::Presenters::Hash
+      # [:object]
+      #   Hoodoo::Presenters::Object
       #
       def type_option_to_class( type )
         case type
@@ -776,6 +780,10 @@ module Hoodoo
             Hoodoo::Presenters::Text
           when :uuid
             Hoodoo::Presenters::UUID
+          when :object
+            Hoodoo::Presenters::Object
+          when :hash
+            Hoodoo::Presenters::Hash
           else
             raise "Unsupported 'type' option value of '#{ type }' in Hoodoo::Presenters::BaseDSL"
         end

data/lib/hoodoo/presenters/common_resource_fields.rb

@@ -18,6 +18,7 @@ module Hoodoo
       schema do
         uuid     :id,         :required => true
         datetime :created_at, :required => true
+        datetime :updated_at, :required => false
         text     :kind,       :required => true
         text     :language
 

data/lib/hoodoo/presenters/types/hash.rb

@@ -58,9 +58,12 @@ module Hoodoo
         end
 
         @specific   = true
-        value_klass = block_given?               ?
-                      Hoodoo::Presenters::Object :
-                      type_option_to_class( options.delete( :type ) )
+
+        # If an explicit type is given, use that. Otherwise, default to Field
+        # if no block is given, or Object is a block is given.
+        #
+        value_klass = !(options[:type].nil? || options[:type] == '') ? type_option_to_class( options.delete( :type ) ) :
+                        (block_given? ? Hoodoo::Presenters::Object : Hoodoo::Presenters::Field)
 
         # If we're defining specific keys and some of those keys have fields
         # with defaults, we need to merge those up to provide a whole-Hash

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

@@ -132,12 +132,14 @@ module Hoodoo; module Services
     MAXIMUM_PAYLOAD_SIZE = 1048576 # 1MB Should Be Enough For Anyone
 
     # Maximum *logged* payload (inbound data) size.
+    # Keep consistent with max payload size so data is not lost from the logs.
     #
-    MAXIMUM_LOGGED_PAYLOAD_SIZE = 1024
+    MAXIMUM_LOGGED_PAYLOAD_SIZE = MAXIMUM_PAYLOAD_SIZE
 
     # Maximum *logged* response (outbound data) size.
+    # Keep consistent with max payload size so data is not lost from the logs.
     #
-    MAXIMUM_LOGGED_RESPONSE_SIZE = 1024
+    MAXIMUM_LOGGED_RESPONSE_SIZE = MAXIMUM_PAYLOAD_SIZE
 
     # The default test session; a Hoodoo::Services::Session instance with the
     # following characteristics:

data/lib/hoodoo/version.rb

@@ -12,11 +12,11 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '2.12.0'
+  VERSION = '2.12.6'
 
   # The Hoodoo gem date. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  DATE = '2018-12-17'
+  DATE = '2020-11-10'
 
 end

data/spec/client/client_spec.rb

@@ -388,6 +388,14 @@ describe Hoodoo::Client do
         expect( result.platform_errors.has_errors? ).to eq( false )
         expect( result[ 'kind' ] ).to eq( 'Errors' )
       end
+
+      it 'returns a 404 for show(nil)', :wont_create_net_http do
+        result = @endpoint.show( nil )
+
+        expect( result.platform_errors.has_errors? ).to eq( true )
+        expect( result.platform_errors.errors[ 0 ][ 'code' ] ).to eq( 'platform.not_found' )
+        expect( result.platform_errors.errors[ 0 ][ 'reference' ] ).to eq( 'nil identifier given on :show action' )
+      end
     end
 
     before :each do
@@ -451,6 +459,11 @@ describe Hoodoo::Client do
     end
 
     context 'and with an HTTP proxy via custom discoverer' do
+      around :each do | example |
+        @example_wont_create_net_http = example.metadata[ :wont_create_net_http ]
+        example.run
+      end
+
       before :each do
         base_uri   = "http://localhost:#{ @port }"
         proxy_uri  = 'http://foo:bar@proxyhost:1234'
@@ -459,17 +472,19 @@ describe Hoodoo::Client do
           proxy_uri: proxy_uri
         )
 
-        original_new = Net::HTTP.method( :new )
-
-        expect( Net::HTTP ).to receive( :new ).at_least( :once ) do | host, port, proxy_host, proxy_port, proxy_user, proxy_pass |
-          expect( host       ).to eq( 'localhost' )
-          expect( port       ).to eq( @port       )
-          expect( proxy_host ).to eq( 'proxyhost' )
-          expect( proxy_port ).to eq( 1234        )
-          expect( proxy_user ).to eq( 'foo'       )
-          expect( proxy_pass ).to eq( 'bar'       )
-
-          original_new.call( host, port )
+        if @example_wont_create_net_http
+          expect( Net::HTTP ).not_to receive( :new )
+        else
+          expect( Net::HTTP ).to receive( :new ).at_least( :once ).and_wrap_original do | original_new, host, port, proxy_host, proxy_port, proxy_user, proxy_pass |
+            expect( host       ).to eq( 'localhost' )
+            expect( port       ).to eq( @port       )
+            expect( proxy_host ).to eq( 'proxyhost' )
+            expect( proxy_port ).to eq( 1234        )
+            expect( proxy_user ).to eq( 'foo'       )
+            expect( proxy_pass ).to eq( 'bar'       )
+
+            original_new.call( host, port )
+          end
         end
 
         set_vars_for(

data/spec/presenters/base_spec.rb

@@ -362,7 +362,8 @@ describe '#schema' do
           Hoodoo::UUID.generate,
           Time.now,
           'en-gb',
-          Hoodoo::UUID.generate
+          Hoodoo::UUID.generate,
+          Time.now
         )
 
         expect(Hoodoo::Data::Resources::World.validate(rendered, true).errors).to eq([])
@@ -707,6 +708,7 @@ describe '#schema' do
           'id' => @uuid,
           'kind' => 'World',
           'created_at' => Hoodoo::Utilities.standard_datetime( @time ),
+          'updated_at' => Hoodoo::Utilities.standard_datetime( @time ),
           'language' => 'en-gb',
           'errors_id' => @input['errors_id'],
           'test_tags' => 'foo,bar,baz',
@@ -729,7 +731,9 @@ describe '#schema' do
             @input,
             @uuid,
             @time,
-            'en-gb'
+            'en-gb',
+            nil,
+            @time
           )
         ).to( eq( @output ) )
       end
@@ -744,7 +748,8 @@ describe '#schema' do
             @uuid,
             @time,
             'en-gb',
-            fingerprint
+            fingerprint,
+            @time
           )
         ).to( eq( @output ) )
       end

data/spec/presenters/common_resource_fields_spec.rb

@@ -6,13 +6,15 @@ describe Hoodoo::Presenters::CommonResourceFields do
 
     expect(schema.is_internationalised?()).to eq(false)
 
-    expect(schema.properties.count).to eq(7)
+    expect(schema.properties.count).to eq(8)
 
     expect(schema.properties['id']).to be_a(Hoodoo::Presenters::UUID)
     expect(schema.properties['id'].required).to eq(true)
     expect(schema.properties['id'].resource).to be_nil
     expect(schema.properties['created_at']).to be_a(Hoodoo::Presenters::DateTime)
     expect(schema.properties['created_at'].required).to eq(true)
+    expect(schema.properties['updated_at']).to be_a(Hoodoo::Presenters::DateTime)
+    expect(schema.properties['updated_at'].required).to eq(false)
     expect(schema.properties['kind']).to be_a(Hoodoo::Presenters::Text)
     expect(schema.properties['kind'].required).to eq(true)
     expect(schema.properties['language']).to be_a(Hoodoo::Presenters::Text)

data/spec/presenters/types/hash_spec.rb

@@ -663,6 +663,94 @@ describe Hoodoo::Presenters::Hash do
 
   ############################################################################
 
+  class TestHashKeyWithHashType < Hoodoo::Presenters::Base
+    schema do
+      hash :key_with_hash_type do
+        key :specific_hash, :type => :hash do
+          key :optional_field, required: false
+          key :required_field, required: true
+        end
+        key :generic_hash, :type => :hash do
+          keys :length => 6
+        end
+      end
+    end
+  end
+
+
+  ############################################################################
+
+  context 'specific key with a hash as the type' do
+    context '#render' do
+      it 'renders required fields correctly' do
+        input_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo'}
+        } }
+        expected_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo'}
+        } }
+
+        expect( TestHashKeyWithHashType.render( input_data ) ).to eq( expected_data )
+      end
+
+      it 'renders optional fields correctly' do
+        input_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo', 'optional_field' => 'bar'},
+          'generic_hash' => {'foo' => 'bar', 'somekey' => 'somevalue'}
+        } }
+        expected_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo', 'optional_field' => 'bar'},
+          'generic_hash' => {'foo' => 'bar', 'somekey' => 'somevalue'}
+        } }
+
+        expect( TestHashKeyWithHashType.render( input_data ) ).to eq( expected_data )
+      end
+    end
+
+    context '#validate' do
+      it 'succeeds if the key is optional and absent' do
+        expect( TestHashKeyWithHashType.validate( {} ).errors.size ).to( eql( 0 ) )
+      end
+
+      it 'succeeds if the key is present and its specific required keys are present' do
+        input_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo'}
+        } }
+        expect( TestHashKeyWithHashType.validate( input_data ).errors.size ).to( eql( 0 ) )
+      end
+
+      it 'succeeds if the key is present and its specific required and optional keys are present' do
+        input_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'required_field' => 'foo', 'optional_field' => 'bar'}
+        } }
+        expect( TestHashKeyWithHashType.validate( input_data ).errors.size ).to( eql( 0 ) )
+      end
+
+      it 'fails if the key is present and its specific required keys are missing' do
+        input_data = { 'key_with_hash_type' => {
+          'specific_hash' => {'optional_field' => 'bar'}
+        } }
+        expect( TestHashKeyWithHashType.validate( input_data ).errors.size ).to( eql( 1 ) )
+      end
+
+      it 'succeeds if the key is present and its generic keys are valid' do
+        input_data = { 'key_with_hash_type' => {
+          'generic_hash' => {'foo' => 'bar'}
+        } }
+        expect( TestHashKeyWithHashType.validate( input_data ).errors.size ).to( eql( 0 ) )
+      end
+
+      it 'fails if the key is present and its generic keys are invalid' do
+        input_data = { 'key_with_hash_type' => {
+          'generic_hash' => {'keynametoolong' => 'bar'}
+        } }
+        expect( TestHashKeyWithHashType.validate( input_data ).errors.size ).to( eql( 1 ) )
+      end
+    end
+  end
+
+  ############################################################################
+
   class TestHashGenericKeyPresenterNoValues < Hoodoo::Presenters::Base
     schema do
       hash :generic do

data/spec/services/services/response_spec.rb

@@ -160,7 +160,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate({})
       expect(status).to eq(200)
       expect(headers).to eq({'Content-Length' => expected.length.to_s})
-      expect(body.body).to eq([expected])
+      expect(body).to eq([expected])
     end
 
     it 'should return header data correctly' do
@@ -172,7 +172,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate({})
       expect(status).to eq(200)
       expect(headers).to eq({'X-Foo' => 'baz', 'X-Bar' => 'boo', 'Content-Length' => expected.length.to_s})
-      expect(body.body).to eq([expected])
+      expect(body).to eq([expected])
     end
 
     it 'should return error condition Rack data correctly' do
@@ -187,7 +187,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate(errors_hash)
       expect(status).to eq(422) # From the first error we stored, not the second
       expect(headers).to eq({'Content-Length' => expected.length.to_s})
-      expect(body.body).to eq([expected])
+      expect(body).to eq([expected])
     end
 
     it 'should return non-error condition Rack data correctly with a Hash body' do
@@ -199,7 +199,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate(response_hash)
       expect(status).to eq(200) # From the first error we stored, not the second
       expect(headers).to eq({'Content-Length' => expected.length.to_s})
-      expect(body.body).to eq([expected])
+      expect(body).to eq([expected])
     end
 
     it 'returns non-error condition Rack data correctly with an Array body' do
@@ -211,7 +211,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate({'_data' => response_array})
       expect(status).to eq(200) # From the first error we stored, not the second
       expect(headers).to eq({'Content-Length' => expected.length.to_s})
-      expect(body.body).to eq([expected])
+      expect(body).to eq([expected])
     end
 
     it 'returns non-error condition Rack data correctly with a dataset size' do
@@ -223,7 +223,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate( { '_data' => response_array, '_dataset_size' => response_array.count } )
       expect( status    ).to eq( 200 )
       expect( headers   ).to eq( { 'Content-Length' => expected.length.to_s } )
-      expect( body.body ).to eq( [ expected ] )
+      expect( body ).to eq( [ expected ] )
     end
 
     it 'returns non-error condition Rack data correctly with an estimated dataset size' do
@@ -235,7 +235,7 @@ describe Hoodoo::Services::Response do
       expected = JSON.generate( { '_data' => response_array, '_estimated_dataset_size' => response_array.count } )
       expect( status    ).to eq( 200 )
       expect( headers   ).to eq( { 'Content-Length' => expected.length.to_s } )
-      expect( body.body ).to eq( [ expected ] )
+      expect( body ).to eq( [ expected ] )
     end
 
     it 'returns non-error condition Rack data correctly with both an accurate and an estimated dataset size' do
@@ -252,7 +252,7 @@ describe Hoodoo::Services::Response do
 
       expect( status    ).to eq( 200 )
       expect( headers   ).to eq( { 'Content-Length' => expected.length.to_s } )
-      expect( body.body ).to eq( [ expected ] )
+      expect( body ).to eq( [ expected ] )
     end
 
     it 'should allow pre-encoded strings in the body' do
@@ -261,7 +261,7 @@ describe Hoodoo::Services::Response do
       status, headers, body = @r.for_rack
 
       expect(status).to eq(200)
-      expect(body.body).to eq(['Hello World!'])
+      expect(body).to eq(['Hello World!'])
     end
 
     it 'should raise an exception when the body is in an unsupported format' do

data/spec/utilities/utilities_spec.rb

@@ -604,7 +604,7 @@ describe Hoodoo::Utilities do
     end
 
     after :each do
-      @old_tz.blank? ? ENV.delete( 'TZ' ) : ENV[ 'TZ' ] = @old_tz
+      (@old_tz.nil? || @old_tz == '') ? ENV.delete( 'TZ' ) : ENV[ 'TZ' ] = @old_tz
     end
 
     it 'accepts a non-UTC Time and renders a UTC date-time' do
@@ -678,11 +678,11 @@ describe Hoodoo::Utilities do
     it 'rejects invalid input with an exception' do
       expect {
         Hoodoo::Utilities.rationalise_datetime( "hello" )
-      }.to raise_exception
+      }.to raise_exception( /Invalid parameter 'hello'/ )
 
       expect {
         Hoodoo::Utilities.rationalise_datetime( Array.new )
-      }.to raise_exception
+      }.to raise_exception( /Invalid parameter '\[\]'/ )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.12.6
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -184,28 +184,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -598,8 +598,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Opinionated APIs