nova-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a266432dc94cd0389130d02b53febc820c44077340febee798db6a731fecdf61
-  data.tar.gz: 29c58b11990b3deae87ff55a678058a830cb6c652677eb6509818e1b85310609
+  metadata.gz: 0a8e79b9a9865e156d8a56b694ba90e42f2f484b4b4000c4aab312387ebbf292
+  data.tar.gz: 8412dbb5038ce302b39fe96fd3fb723a4b0bd48b008f7747dfe908e7672f2576
 SHA512:
-  metadata.gz: 85e4c7c5a6858b21d66421438ca04fb86343c3ee4e7592bb56fa80a2c8807f5f133b6794238fae36be6617ffd95c363523c7aab4aafbb5e21fcf1cd6e34eb50d
-  data.tar.gz: 787e55980884ceb41fbc99c3f7337317da15c2a4d6410ee83773ded174d9a61c629d2d27c7395b2d5637a007dec456d00425891779eb2edb9d28dfbe380d7371
+  metadata.gz: 005e85aeb3b00d333df06230e5efbfba42a1f219bd09615cfdf5fc5a6be93e68ad89921ec4d19b21b2628fca85693bf4ffd2826bfe140960fea33dd715e44ea9
+  data.tar.gz: 9b9079d0ed717d5c6f6c45c988059724f8e40e85b67bd03a163485686b543e52864cfd385075a7e0998bf39c8bf3aca28e1b0e5bb489e518ff2a4b954efac1cc

data/CHANGELOG.md

@@ -5,7 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.5.0] - 2021-03-09
+
+### Added
+
+- Payables & Receivables related stuff
+
+- Card taxes to cards asset
 
 ## [0.4.0] - 2021-03-05
 
@@ -41,7 +47,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Apportionment related stuff
 
-[unreleased]: https://github.com/coyosoftware/nova-api/compare/0.3.0...HEAD
+[unreleased]: https://github.com/coyosoftware/nova-api/compare/0.5.0...HEAD
+[0.5.0]: https://github.com/coyosoftware/nova-api/releases/tag/0.5.0
+[0.4.0]: https://github.com/coyosoftware/nova-api/releases/tag/0.4.0
 [0.3.0]: https://github.com/coyosoftware/nova-api/releases/tag/0.3.0
 [0.2.0]: https://github.com/coyosoftware/nova-api/releases/tag/0.2.0
 [0.1.1]: https://github.com/coyosoftware/nova-api/releases/tag/0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nova-api (0.4.0)
+    nova-api (0.5.0)
       dry-struct (~> 1.4.0)
       dry-types (~> 1.5.1)
       httparty (~> 0.1)

data/lib/nova/api.rb

@@ -10,6 +10,11 @@ require "nova/api/resource/apportionment_value"
 require "nova/api/resource/apportionment"
 require "nova/api/resource/company"
 
+require "nova/api/resource/installment"
+require "nova/api/resource/bill"
+require "nova/api/resource/payable"
+require "nova/api/resource/receivable"
+
 require "nova/api/resource/current_asset"
 require "nova/api/resource/bank"
 require "nova/api/resource/card"
@@ -76,6 +81,14 @@ module Nova
         Nova::API::Resource::FinancialAccount
       end
 
+      def payables
+        Nova::API::Resource::Payable
+      end
+
+      def receivables
+        Nova::API::Resource::Receivable
+      end
+
       def third_parties
         Nova::API::Resource::ThirdParty
       end

data/lib/nova/api/base.rb

@@ -28,18 +28,18 @@ module Nova
 
       protected
 
-      def allowed_attributes
-        return attributes unless self.class.const_defined?('ALLOWED_ATTRIBUTES')
-
-        data = attributes.dup
-
-        data.keys.each { |key| data.delete(key.to_sym) unless self.class.const_get('ALLOWED_ATTRIBUTES').include?(key.to_sym) }
+      def self.initialize_empty_model_with_id(klass, id, additional_attributes = {})
+        data = klass.schema.type.keys.map do |field|
+          name = field.name
 
-        data
-      end
+          if additional_attributes[name]
+            [name, additional_attributes[name]]
+          else
+            type = field.type
 
-      def self.initialize_empty_model_with_id(klass, id, additional_attributes = {})
-        data = klass.attribute_names.map { |key| additional_attributes[key] ? [key, additional_attributes[key]] : [key, nil] }
+            type.optional? ? [name, nil] :  [name, generate_valid_value_for(type)]
+          end
+        end
 
         klass.new(Hash[*data.flatten].merge(id: id))
       end
@@ -121,6 +121,18 @@ module Nova
         base_uri base_url
       end
       def_delegator self, :set_base_uri
+
+      def self.generate_valid_value_for(type)
+        case type.name
+        when Dry::Types['integer'].name, Dry::Types['float'].name, Dry::Types['decimal'].name
+          0
+        when Dry::Types['bool'].name
+          false
+        else
+          nil
+        end
+      end
+      def_delegator self, :generate_valid_value_for
     end
   end
 end

data/lib/nova/api/resource/bill.rb

@@ -0,0 +1,39 @@
+module Nova
+  module API
+    module Resource
+      class Bill < Nova::API::Base
+        class Apportionment < Nova::API::Utils::BaseStruct
+          ALLOWED_ATTRIBUTES = [:value, :apportionment_value_ids]
+
+          attribute :apportionment_value_ids, Dry::Types['strict.array'].of(Dry::Types['coercible.integer'].optional)
+          attribute :value, Dry::Types['coercible.decimal']
+        end
+
+        ALLOWED_ATTRIBUTES = [
+          :additional_information, :apportionments, :company_id, :date, :document_type, :document_number, :due_type, :financial_account_id,
+          :first_due_date, :forecast, :installments, :installments_number, :third_party_id, :total_value
+        ]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute? :additional_information, Dry::Types['coercible.string'].optional
+        attribute? :apportionments, Dry::Types['strict.array'].of(Nova::API::Resource::Bill::Apportionment).optional
+        attribute :company_id, Dry::Types['coercible.integer']
+        attribute :date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX)
+        attribute :document_type, Dry::Types['coercible.integer']
+        attribute? :document_number, Dry::Types['coercible.string']
+        attribute? :due_type, Dry::Types['coercible.integer']
+        attribute :financial_account_id, Dry::Types['coercible.integer']
+        attribute :first_due_date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX)
+        attribute :forecast, Dry::Types['strict.bool']
+        attribute? :installments, Dry::Types['strict.array'].of(Nova::API::Resource::Installment).optional
+        attribute :installments_number, Dry::Types['coercible.integer']
+        attribute :third_party_id, Dry::Types['coercible.integer']
+        attribute :total_value, Dry::Types['coercible.decimal']
+
+        def self.endpoint
+          '/api/bills'
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/card.rb

@@ -2,10 +2,21 @@ module Nova
   module API
     module Resource
       class Card < Nova::API::Resource::CurrentAsset
+        class Tax < Nova::API::Utils::BaseStruct
+          ALLOWED_ATTRIBUTES = %i[]
+
+          attribute :percentage, Dry::Types['coercible.decimal']
+          attribute :fixed, Dry::Types['coercible.decimal']
+          attribute :type, Dry::Types['coercible.string']
+          attribute :installments, Dry::Types['coercible.integer']
+          attribute :days, Dry::Types['coercible.integer']
+        end
+
         ALLOWED_ATTRIBUTES = %i[]
 
         attribute? :description, Dry::Types['coercible.string'].optional
         attribute? :institution, Dry::Types['coercible.string'].optional
+        attribute :taxes, Dry::Types['strict.array'].of(Nova::API::Resource::Card::Tax)
 
         def self.endpoint
           '/api/cards'

data/lib/nova/api/resource/installment.rb

@@ -0,0 +1,19 @@
+module Nova
+  module API
+    module Resource
+      class Installment < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[due_date gross_value number value]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute :due_date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX)
+        attribute? :gross_value, Dry::Types['coercible.decimal'].optional
+        attribute :number, Dry::Types['coercible.integer']
+        attribute :value, Dry::Types['coercible.decimal']
+
+        def self.endpoint
+          '/api/installments'
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/payable.rb

@@ -0,0 +1,57 @@
+module Nova
+  module API
+    module Resource
+      class Payable < Nova::API::Resource::Bill
+        def self.endpoint
+          '/api/payables'
+        end
+
+        def self.create(parameters)
+          model = new parameters
+
+          model.attributes.delete(:id)
+
+          model.save
+        end
+
+        def self.update(id, parameters)
+          model = new parameters.merge(id: id)
+
+          model.update
+        end
+
+        def self.destroy(id)
+          model = initialize_empty_model_with_id(self, id, date: Date.today.iso8601, first_due_date: Date.today.iso8601)
+
+          model.destroy
+        end
+
+        def endpoint
+          protect_operation_from_missing_value
+
+          "/api/payables/#{id}"
+        end
+
+        def save
+          if id.nil?
+            do_post(self.class.endpoint, allowed_attributes)
+          else
+            do_patch("#{endpoint}", allowed_attributes)
+          end
+        end
+
+        def update
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}", allowed_attributes)
+        end
+
+        def destroy
+          protect_operation_from_missing_value
+
+          do_delete("#{endpoint}")
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/receivable.rb

@@ -0,0 +1,61 @@
+module Nova
+  module API
+    module Resource
+      class Receivable < Nova::API::Resource::Bill
+        ALLOWED_ATTRIBUTES = Nova::API::Resource::Bill::ALLOWED_ATTRIBUTES.dup << :gross_value
+
+        attribute? :gross_value, Dry::Types['coercible.decimal'].optional
+
+        def self.endpoint
+          '/api/receivables'
+        end
+
+        def self.create(parameters)
+          model = new parameters
+
+          model.attributes.delete(:id)
+
+          model.save
+        end
+
+        def self.update(id, parameters)
+          model = new parameters.merge(id: id)
+
+          model.update
+        end
+
+        def self.destroy(id)
+          model = initialize_empty_model_with_id(self, id, date: Date.today.iso8601, first_due_date: Date.today.iso8601)
+
+          model.destroy
+        end
+
+        def endpoint
+          protect_operation_from_missing_value
+
+          "/api/receivables/#{id}"
+        end
+
+        def save
+          if id.nil?
+            do_post(self.class.endpoint, allowed_attributes)
+          else
+            do_patch("#{endpoint}", allowed_attributes)
+          end
+        end
+
+        def update
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}", allowed_attributes)
+        end
+
+        def destroy
+          protect_operation_from_missing_value
+
+          do_delete("#{endpoint}")
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/third_party.rb

@@ -2,7 +2,10 @@ module Nova
   module API
     module Resource
       class ThirdParty < Nova::API::Base
-        ALLOWED_ATTRIBUTES = %i[trading_name identification address phone social_reason municipal_inscription state_inscription email notes supplier customer retention whatsapp twitter facebook linkedin google instagram site csll pis cofins irpj values_past]
+        ALLOWED_ATTRIBUTES = %i[
+          trading_name identification address phone social_reason municipal_inscription state_inscription email notes supplier
+          customer retention whatsapp twitter facebook linkedin google instagram site csll pis cofins irpj values_past
+        ]
 
         attribute? :id, Dry::Types['coercible.integer'].optional
         attribute :trading_name, Dry::Types['coercible.string']

data/lib/nova/api/utils/base_struct.rb

@@ -8,6 +8,32 @@ module Nova
         DATE_REGEX = /\A\d{4}-\d{2}-\d{2}\z/
 
         transform_keys(&:to_sym)
+
+        def allowed_attributes
+          return attributes unless self.class.const_defined?('ALLOWED_ATTRIBUTES')
+
+          data = {}
+
+          self.class.const_get('ALLOWED_ATTRIBUTES').each do |key|
+            next unless attributes.keys.include? key
+
+            value = attributes[key]
+
+            if value.is_a? Array
+              data[key.to_sym] = value.map { |attribute| permit_value(key, attribute) }
+            else
+              data[key.to_sym] = permit_value(key, value)
+            end
+          end
+
+          data
+        end
+
+        private
+
+        def permit_value(key, value)
+          value.respond_to?(:allowed_attributes) ?  value.allowed_attributes : value
+        end
       end
     end
   end

data/lib/nova/api/version.rb

@@ -1,5 +1,5 @@
 module Nova
   module API
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nova-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Coyô Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,11 +177,15 @@ files:
 - lib/nova/api/resource/apportionment.rb
 - lib/nova/api/resource/apportionment_value.rb
 - lib/nova/api/resource/bank.rb
+- lib/nova/api/resource/bill.rb
 - lib/nova/api/resource/card.rb
 - lib/nova/api/resource/cash.rb
 - lib/nova/api/resource/company.rb
 - lib/nova/api/resource/current_asset.rb
 - lib/nova/api/resource/financial_account.rb
+- lib/nova/api/resource/installment.rb
+- lib/nova/api/resource/payable.rb
+- lib/nova/api/resource/receivable.rb
 - lib/nova/api/resource/response/current_asset_statement.rb
 - lib/nova/api/resource/third_party.rb
 - lib/nova/api/resource/write_off.rb