haveapi 0.27.1 → 0.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1d65a2661353ff707b5b33f0bf8df446bfd4dcc6c669b5af8fdc46dbbf8a0a5
-  data.tar.gz: ddb0c92670d615f22468c91c96f8e83e34cf53a3680cf55c588936aa95a34df7
+  metadata.gz: ec45b62af7fa8653e5f1a304b57746a9a2858db8b75c6a1d8a3deb5536cc7946
+  data.tar.gz: 0a991e394ccf4a4629f8d755fcfdfa9fd76af6fe37c696d361c1d9340ea8763c
 SHA512:
-  metadata.gz: 908348858c2829a57531813ceb696c47768ec9a5e29133e8fb64e2c33613949ef70dd52468480a5a2e33c25c9c204541946ccfb982a17cec27656f4b184c2724
-  data.tar.gz: 82e5b873d368caf4914895b24fa4e57d6b0b39c55357910c307496c535cacbdfebb35cd4036b2d07bb1627625a951f5e04fa440416f1eaa141980a22e943468e
+  metadata.gz: 693eb912e8215aa93c1c7b009475d91a752bfee1a2d4faeb33d59728168def03128dc7738c264e52f6cef3a87b7e7e11362a4da2f227deb057a9a89e50813705
+  data.tar.gz: e11fd922568a2ed631a702ec71e8e4631759bee27ecd122029e50af3fb389cde4f7167a0c26876b79b1db220d434b4c3117cb338e1a1fb3f529d85675fa91f1d

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.1'
+  s.add_dependency 'haveapi-client', '~> 0.27.3'
   s.add_dependency 'json'
   s.add_dependency 'mail'
   s.add_dependency 'nesty', '~> 1.0'

data/lib/haveapi/model_adapters/active_record.rb

@@ -142,15 +142,22 @@ module HaveAPI::ModelAdapters
 
     class Input < ::HaveAPI::ModelAdapter::Input
       def self.clean(model, raw, extra)
-        return nil if raw.nil?
-
         original = raw
+        allow_null = if extra
+                       extra.has_key?(:nullable) ? extra[:nullable] : extra[:optional]
+                     end
+
+        if raw.nil?
+          return nil if allow_null
+
+          raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+        end
 
         if raw.is_a?(String)
           stripped = raw.strip
 
           if stripped.empty?
-            return nil if extra && extra[:optional]
+            return nil if allow_null
 
             raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
           end

data/lib/haveapi/parameters/resource.rb

@@ -5,7 +5,7 @@ module HaveAPI::Parameters
 
     def initialize(resource, name: nil, label: nil, desc: nil,
                    choices: nil, value_id: :id, value_label: :label, required: nil,
-                   db_name: nil, fetch: nil)
+                   db_name: nil, fetch: nil, nullable: nil)
       @resource = resource
       @resource_path = build_resource_path(resource)
       @name = name || resource.resource_name.underscore.to_sym
@@ -15,6 +15,7 @@ module HaveAPI::Parameters
       @value_id = value_id
       @value_label = value_label
       @required = required
+      @nullable = nullable
       @db_name = db_name
       @extra = {
           fetch:
@@ -33,6 +34,10 @@ module HaveAPI::Parameters
       !@required
     end
 
+    def nullable?
+      @nullable == true && optional?
+    end
+
     def show_action
       @resource::Show
     end
@@ -56,6 +61,7 @@ module HaveAPI::Parameters
 
       {
         required: required?,
+        nullable: nullable?,
         label: @label,
         description: @desc,
         type: 'Resource',
@@ -92,12 +98,18 @@ module HaveAPI::Parameters
     end
 
     def clean(raw)
+      if raw.nil?
+        return nil if nullable?
+
+        raise HaveAPI::ValidationError, 'cannot be null'
+      end
+
       if raw.is_a?(String)
         stripped = raw.strip
-        return nil if stripped.empty? && optional?
+        return nil if stripped.empty? && nullable?
       end
 
-      extra = @extra.merge(optional: optional?)
+      extra = @extra.merge(optional: optional?, nullable: nullable?)
 
       ::HaveAPI::ModelAdapter.for(
         show_action.input.layout, @resource.model

data/lib/haveapi/parameters/typed.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module HaveAPI::Parameters
   class Typed
-    ATTRIBUTES = %i[label desc type db_name default fill clean protected load_validators].freeze
+    ATTRIBUTES = %i[label desc type db_name default fill clean protected load_validators nullable].freeze
 
     attr_reader :name, :label, :desc, :type, :default
 
@@ -36,6 +36,10 @@ module HaveAPI::Parameters
       !required?
     end
 
+    def nullable?
+      @nullable == true && optional?
+    end
+
     def fill?
       @fill
     end
@@ -47,6 +51,7 @@ module HaveAPI::Parameters
     def describe(context)
       {
         required: required?,
+        nullable: nullable?,
         label: @label,
         description: @desc,
         type: @type ? @type.to_s : String.to_s,
@@ -76,9 +81,17 @@ module HaveAPI::Parameters
       return instance_exec(raw, &@clean) if @clean
 
       if raw.nil?
-        @default
+        return nil if nullable?
+
+        raise HaveAPI::ValidationError, 'cannot be null'
+      end
+
+      if raw.is_a?(String)
+        stripped = raw.strip
+        return nil if stripped.empty? && nullable?
+      end
 
-      elsif @type.nil?
+      if @type.nil?
         nil
 
       elsif @type == Integer

data/lib/haveapi/resources/action_state.rb

@@ -85,10 +85,11 @@ module HaveAPI::Resources
         float :timeout, label: 'Timeout', desc: 'in seconds', default: 15, fill: true
         float :update_in, label: 'Progress',
                           desc: 'number of seconds after which the state is returned if the progress ' \
-                                'has changed'
-        bool :status, desc: 'status to check with if update_in is set'
-        integer :current, desc: 'progress to check with if update_in is set'
-        integer :total, desc: 'progress to check with if update_in is set'
+                                'has changed',
+                          nullable: true
+        bool :status, desc: 'status to check with if update_in is set', nullable: true
+        integer :current, desc: 'progress to check with if update_in is set', nullable: true
+        integer :total, desc: 'progress to check with if update_in is set', nullable: true
       end
 
       output(:hash) do

data/lib/haveapi/version.rb

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

data/spec/model_adapters/active_record_spec.rb

@@ -343,8 +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(described_class::Input.clean(ARAdapterSpec::Environment, '', { nullable: true })).to be_nil
+    expect(described_class::Input.clean(ARAdapterSpec::Environment, '   ', { nullable: true })).to be_nil
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, 'abc', {})

data/spec/parameters/typed_spec.rb

@@ -79,10 +79,14 @@ describe 'Parameters::Typed' do
     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(nil) }.to raise_error(HaveAPI::ValidationError)
     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)
@@ -90,10 +94,14 @@ describe 'Parameters::Typed' do
     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(nil) }.to raise_error(HaveAPI::ValidationError)
     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)
 
@@ -110,8 +118,12 @@ describe 'Parameters::Typed' do
     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(nil) }.to raise_error(HaveAPI::ValidationError)
     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
@@ -120,10 +132,15 @@ 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 raise_error(HaveAPI::ValidationError)
+    expect { p.clean(nil) }.to raise_error(HaveAPI::ValidationError)
+
+    p = p_arg(type: Datetime, required: true)
+    expect { p.clean('') }.to raise_error(HaveAPI::ValidationError)
 
     # String, Text
     p = p_type(String)
     expect(p.clean('bzz')).to eq('bzz')
+    expect(p.clean('')).to eq('')
     expect(p.clean(123)).to eq('123')
     expect(p.clean(true)).to eq('true')
     expect { p.clean([]) }.to raise_error(HaveAPI::ValidationError)
@@ -131,17 +148,38 @@ describe 'Parameters::Typed' do
 
     p = p_type(Text)
     expect(p.clean('bzz')).to eq('bzz')
+    expect(p.clean('')).to eq('')
     expect(p.clean(123)).to eq('123')
     expect(p.clean(true)).to eq('true')
     expect { p.clean([]) }.to raise_error(HaveAPI::ValidationError)
     expect { p.clean({}) }.to raise_error(HaveAPI::ValidationError)
 
-    # Defaults
-    p = p_type(String)
+    # Nullable
+    p = p_arg(type: Integer, nullable: true)
+    expect(p.clean('')).to be_nil
     expect(p.clean(nil)).to be_nil
 
+    p = p_arg(type: Float, nullable: true)
+    expect(p.clean('')).to be_nil
+    expect(p.clean(nil)).to be_nil
+
+    p = p_arg(type: Boolean, nullable: true)
+    expect(p.clean('')).to be_nil
+    expect(p.clean(nil)).to be_nil
+
+    p = p_arg(type: Datetime, nullable: true)
+    expect(p.clean('')).to be_nil
+    expect(p.clean(nil)).to be_nil
+
+    p = p_arg(type: String, nullable: true)
+    expect(p.clean('')).to be_nil
+    expect(p.clean(nil)).to be_nil
     p.patch(default: 'bazinga')
-    expect(p.clean(nil)).to eq('bazinga')
+    expect(p.clean(nil)).to be_nil
+
+    p = p_arg(type: Text, nullable: true)
+    expect(p.clean('')).to be_nil
+    expect(p.clean(nil)).to be_nil
   end
 
   it 'can be protected' do

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, nullable: true
+          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, nullable: true
+          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'
@@ -479,7 +527,7 @@ module HaveAPI
           route 'echo_resource_optional'
           http_method :get
           input(:hash) do
-            resource HaveAPI::ClientTestAPI::Resources::Project, required: false
+            resource HaveAPI::ClientTestAPI::Resources::Project, required: false, nullable: true
           end
           output(:hash) do
             bool :project_provided, required: true

metadata

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