haveapi 0.27.0 → 0.27.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8307e5e40983cf927641fd3d4052058406209093520a83d89121883f64a9ba0e
-  data.tar.gz: b2d80c7621b7f8870e89dff0ae78c3f4f2d5587ddc9151733d795df0c279fbb7
+  metadata.gz: 33a06b199d36331bf03d273d528e62fad7a0fa96e78667afa3d8411734e8d966
+  data.tar.gz: 94c99822c1b06670ea2623b9faa8c9d22bc7fdfd1be9e3a7d4fb09928f812395
 SHA512:
-  metadata.gz: b93b9411fb84cf5e67763e9384746da97f32903126e802ca2a47f545f68c9d37f66c54c280e78bc7b25e9abad19ca99e3a6d9ed68a985daa8c053119d459ed6d
-  data.tar.gz: 06fff468dc3e939c838689fbd515ae280cf590c9a05d1c36dc81ba7c2723ab344acadee67ece39fb782ff10c75baf7be906fa2e786e5f7cf9a9ae47fe110d9f1
+  metadata.gz: e473cd23de9122f5e817bafbaf24147a2c67b5d311a37c690d7b474d09647e7b4b0ea6f7104f99377ca8534e352b274dcaa7403a67b3dce2dfd510a7ab75fe7a
+  data.tar.gz: c7f8b6f1ffbcf9b8f299e8ce487b8959cc631b98ac3c7b53e508ada38a3191d687b5772c8fd84eac0a14359b70ac182c98859976d81e0cacebfb2a5c436e6b5e

data/haveapi.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= #{File.read('../../.ruby-version').strip}"
 
   s.add_dependency 'activesupport', '>= 7.1'
-  s.add_dependency 'haveapi-client', '~> 0.27.0'
+  s.add_dependency 'haveapi-client', '~> 0.27.2'
   s.add_dependency 'json'
   s.add_dependency 'mail'
   s.add_dependency 'nesty', '~> 1.0'

data/lib/haveapi/model_adapters/active_record.rb

@@ -148,7 +148,12 @@ module HaveAPI::ModelAdapters
 
         if raw.is_a?(String)
           stripped = raw.strip
-          raise HaveAPI::ValidationError, "not a valid id #{original.inspect}" if stripped.empty?
+
+          if stripped.empty?
+            return nil if extra && extra[:optional]
+
+            raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+          end
 
           raw = stripped
 

data/lib/haveapi/parameters/resource.rb

@@ -92,9 +92,16 @@ module HaveAPI::Parameters
     end
 
     def clean(raw)
+      if raw.is_a?(String)
+        stripped = raw.strip
+        return nil if stripped.empty? && optional?
+      end
+
+      extra = @extra.merge(optional: optional?)
+
       ::HaveAPI::ModelAdapter.for(
         show_action.input.layout, @resource.model
-      ).input_clean(@resource.model, raw, @extra)
+      ).input_clean(@resource.model, raw, extra)
     end
 
     def validate(v, params)

data/lib/haveapi/parameters/typed.rb

@@ -75,6 +75,11 @@ module HaveAPI::Parameters
     def clean(raw)
       return instance_exec(raw, &@clean) if @clean
 
+      if raw.is_a?(String)
+        stripped = raw.strip
+        return nil if stripped.empty? && optional?
+      end
+
       if raw.nil?
         @default
 

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.27.0'.freeze
+  VERSION = '0.27.2'.freeze
 end

data/spec/model_adapters/active_record_spec.rb

@@ -343,6 +343,8 @@ describe HaveAPI::ModelAdapters::ActiveRecord do
     expect(described_class::Input.clean(ARAdapterSpec::Environment, 1, {})).to eq(environment)
     expect(described_class::Input.clean(ARAdapterSpec::Environment, '1', {})).to eq(environment)
     expect(described_class::Input.clean(ARAdapterSpec::Environment, 1.0, {})).to eq(environment)
+    expect(described_class::Input.clean(ARAdapterSpec::Environment, '', { optional: true })).to be_nil
+    expect(described_class::Input.clean(ARAdapterSpec::Environment, '   ', { optional: true })).to be_nil
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, 'abc', {})

data/spec/parameters/typed_spec.rb

@@ -78,22 +78,28 @@ describe 'Parameters::Typed' do
     expect(p.clean(12.0)).to eq(12)
     expect { p.clean('abc') }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean('12abc') }.to raise_error(HaveAPI::ValidationError)
-    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+    expect(p.clean('')).to be_nil
     expect { p.clean('12.0') }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean(12.3) }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean(true) }.to raise_error(HaveAPI::ValidationError)
 
+    p = p_arg(type: Integer, required: true)
+    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+
     # Float
     p = p_type(Float)
     expect(p.clean('3.1456')).to eq(3.1456)
     expect(p.clean('1e3')).to eq(1000.0)
     expect(p.clean(3)).to eq(3.0)
     expect { p.clean('abc') }.to raise_error(HaveAPI::ValidationError)
-    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+    expect(p.clean('')).to be_nil
     expect { p.clean('NaN') }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean(Float::NAN) }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean(Float::INFINITY) }.to raise_error(HaveAPI::ValidationError)
 
+    p = p_arg(type: Float, required: true)
+    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+
     # Boolean
     p = p_type(Boolean)
 
@@ -109,9 +115,12 @@ describe 'Parameters::Typed' do
     expect(p.clean(1)).to be true
     expect(p.clean('  YES ')).to be true
     expect { p.clean('maybe') }.to raise_error(HaveAPI::ValidationError)
-    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+    expect(p.clean('')).to be_nil
     expect { p.clean(2) }.to raise_error(HaveAPI::ValidationError)
 
+    p = p_arg(type: Boolean, required: true)
+    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
+
     # Datetime
     p = p_type(Datetime)
     t = Time.now
@@ -119,6 +128,9 @@ describe 'Parameters::Typed' do
 
     expect(p.clean(t.iso8601)).to eq(t2)
     expect { p.clean('bzz') }.to raise_error(HaveAPI::ValidationError)
+    expect(p.clean('')).to be_nil
+
+    p = p_arg(type: Datetime, required: true)
     expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
 
     # String, Text

data/test_support/client_test_api.rb

@@ -457,6 +457,54 @@ module HaveAPI
           end
         end
 
+        define_action(:EchoOptional) do
+          extend DocFilter
+          route 'echo_optional'
+          http_method :post
+          input(:hash) do
+            datetime :dt, required: false
+          end
+          output(:hash) do
+            bool :dt_provided, required: true
+            bool :dt_nil, required: true
+            datetime :dt
+          end
+          authorize { allow }
+
+          def exec
+            ret = {
+              dt_provided: input.has_key?(:dt),
+              dt_nil: input[:dt].nil?
+            }
+            ret[:dt] = input[:dt] unless input[:dt].nil?
+            ret
+          end
+        end
+
+        define_action(:EchoOptionalGet) do
+          extend DocFilter
+          route 'echo_optional_get'
+          http_method :get
+          input(:hash) do
+            datetime :dt, required: false
+          end
+          output(:hash) do
+            bool :dt_provided, required: true
+            bool :dt_nil, required: true
+            datetime :dt
+          end
+          authorize { allow }
+
+          def exec
+            ret = {
+              dt_provided: input.has_key?(:dt),
+              dt_nil: input[:dt].nil?
+            }
+            ret[:dt] = input[:dt] unless input[:dt].nil?
+            ret
+          end
+        end
+
         define_action(:EchoResource) do
           extend DocFilter
           route 'echo_resource'
@@ -473,6 +521,30 @@ module HaveAPI
             { project: input[:project] }
           end
         end
+
+        define_action(:EchoResourceOptional) do
+          extend DocFilter
+          route 'echo_resource_optional'
+          http_method :get
+          input(:hash) do
+            resource HaveAPI::ClientTestAPI::Resources::Project, required: false
+          end
+          output(:hash) do
+            bool :project_provided, required: true
+            bool :project_nil, required: true
+            integer :project
+          end
+          authorize { allow }
+
+          def exec
+            ret = {
+              project_provided: input.has_key?(:project),
+              project_nil: input[:project].nil?
+            }
+            ret[:project] = input[:project] unless input[:project].nil?
+            ret
+          end
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.27.2
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.27.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.27.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement