nova-api 0.4.0

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

@@ -0,0 +1,84 @@
+module Nova
+  module API
+    module Resource
+      class FinancialAccount < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[financial_account_id name]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute :name, Dry::Types['coercible.string']
+        attribute? :reason, Dry::Types['coercible.integer'].optional
+        attribute? :financial_account_id, Dry::Types['coercible.integer'].optional
+        attribute? :financial_account, Dry::Types['coercible.string'].optional
+        attribute? :income, Dry::Types['strict.bool'].optional
+        attribute? :outcome, Dry::Types['strict.bool'].optional
+        attribute? :children, Dry::Types['strict.array'].of(Nova::API::Resource::FinancialAccount).optional
+
+        def self.endpoint
+          '/api/financial_accounts'
+        end
+
+        def self.list
+          do_get_search(endpoint, nil)
+        end
+
+        def self.income_accounts
+          do_get_search("#{endpoint}/income_accounts", nil)
+        end
+
+        def self.payable_accounts
+          do_get_search("#{endpoint}/payable_accounts", nil)
+        end
+
+        def self.receivable_accounts
+          do_get_search("#{endpoint}/receivable_accounts", nil)
+        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)
+
+          model.destroy
+        end
+
+        def endpoint
+          protect_operation_from_missing_value
+
+          "/api/financial_accounts/#{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/response/current_asset_statement.rb

@@ -0,0 +1,12 @@
+module Nova
+  module API
+    module Resource
+      module Response
+        class CurrentAssetStatement < Nova::API::Utils::BaseStruct
+          attribute? :last_statement, Dry::Types['coercible.decimal'].optional
+          attribute? :write_offs, Dry::Types['strict.array'].of(Nova::API::Resource::WriteOff).optional
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+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]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute :trading_name, Dry::Types['coercible.string']
+        attribute? :identification, Dry::Types['coercible.string'].optional
+        attribute? :address, Dry::Types['coercible.string'].optional
+        attribute? :phone, Dry::Types['coercible.string'].optional
+        attribute? :social_reason, Dry::Types['coercible.string'].optional
+        attribute? :municipal_inscription, Dry::Types['coercible.string'].optional
+        attribute? :state_inscription, Dry::Types['coercible.string'].optional
+        attribute? :email, Dry::Types['coercible.string'].optional
+        attribute? :notes, Dry::Types['coercible.string'].optional
+        attribute? :supplier, Dry::Types['strict.bool'].optional
+        attribute? :customer, Dry::Types['strict.bool'].optional
+        attribute? :retention, Dry::Types['strict.bool'].optional
+        attribute? :whatsapp, Dry::Types['coercible.string'].optional
+        attribute? :twitter, Dry::Types['coercible.string'].optional
+        attribute? :facebook, Dry::Types['coercible.string'].optional
+        attribute? :linkedin, Dry::Types['coercible.string'].optional
+        attribute? :google, Dry::Types['coercible.string'].optional
+        attribute? :instagram, Dry::Types['coercible.string'].optional
+        attribute? :site, Dry::Types['coercible.string'].optional
+        attribute? :csll, Dry::Types['coercible.decimal'].optional
+        attribute? :pis, Dry::Types['coercible.decimal'].optional
+        attribute? :cofins, Dry::Types['coercible.decimal'].optional
+        attribute? :irpj, Dry::Types['coercible.decimal'].optional
+        attribute? :values_past, Dry::Types['coercible.decimal'].optional
+
+        def self.endpoint
+          '/api/third_parties'
+        end
+
+        def self.list(parameters = {})
+          do_get_search(endpoint, parameters.to_h)
+        end
+
+        def self.customers(parameters = {})
+          do_get_search("/api/customers", parameters.to_h)
+        end
+
+        def self.suppliers(parameters = {})
+          do_get_search("/api/suppliers", parameters.to_h)
+        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)
+
+          model.destroy
+        end
+
+        def endpoint
+          protect_operation_from_missing_value
+
+          "/api/third_parties/#{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/write_off.rb

@@ -0,0 +1,14 @@
+module Nova
+  module API
+    module Resource
+      class WriteOff < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX).optional
+        attribute? :value, Dry::Types['coercible.decimal'].optional
+        attribute? :financial_account, Nova::API::Resource::FinancialAccount.optional
+        attribute? :third_party, Nova::API::Resource::ThirdParty.optional
+      end
+    end
+  end
+end

data/lib/nova/api/response.rb

@@ -0,0 +1,39 @@
+require 'httparty'
+require 'dry-struct'
+require 'dry-types'
+
+module Nova
+  module API
+    class Response < Nova::API::Utils::BaseStruct
+      attribute? :record, Dry::Types['nominal.any']
+      attribute :errors, Dry::Types['strict.array'].of(Dry::Types['coercible.string']) 
+      attribute :success, Dry::Types['strict.bool']
+
+      def self.build(response, object = nil)
+        success = response.success?
+
+        parsed_response = response.parsed_response.to_h
+
+        record = nil
+
+        errors = extract_error_from_response('error', parsed_response)
+        errors ||= extract_error_from_response('errors', parsed_response)
+        errors ||= []
+
+        if object
+          record = object.class.new(object.attributes.merge(parsed_response))
+        end
+
+        new(success: success, errors: errors, record: record)
+      end
+
+      private
+
+      def self.extract_error_from_response(field, response)
+        return unless response.has_key?(field)
+
+        response[field].is_a?(Array) ? response[field] : [response[field]]
+      end
+    end
+  end
+end

data/lib/nova/api/search_params/apportionment.rb

@@ -0,0 +1,10 @@
+module Nova
+  module API
+    module SearchParams
+      class Apportionment < Nova::API::Utils::BaseStruct
+        attribute? :q, Dry::Types['coercible.string'].optional
+        attribute? :with_inactive, Dry::Types['strict.bool'].optional
+      end
+    end
+  end
+end

data/lib/nova/api/search_params/current_asset.rb

@@ -0,0 +1,10 @@
+module Nova
+  module API
+    module SearchParams
+      class CurrentAsset < Nova::API::Utils::BaseStruct
+        attribute? :company_id, Dry::Types['coercible.integer'].optional
+        attribute? :with_inactive, Dry::Types['strict.bool'].optional
+      end
+    end
+  end
+end

data/lib/nova/api/search_params/current_asset_statement.rb

@@ -0,0 +1,12 @@
+module Nova
+  module API
+    module SearchParams
+      class CurrentAssetStatement < Nova::API::Utils::BaseStruct
+        attribute :company_id, Dry::Types['coercible.integer']
+        attribute :current_asset_id, Dry::Types['coercible.integer']
+        attribute :initial_date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX)
+        attribute :final_date, Dry::Types['coercible.string'].constrained(format: DATE_REGEX)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Nova
+  module API
+    module SearchParams
+      class ThirdParty < Nova::API::Utils::BaseStruct
+        attribute? :q, Dry::Types['coercible.string'].optional
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'dry-struct'
+require 'dry-types'
+
+module Nova
+  module API
+    module Utils
+      class BaseStruct < Dry::Struct
+        DATE_REGEX = /\A\d{4}-\d{2}-\d{2}\z/
+
+        transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/nova/api/version.rb

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

data/lib/nova/configuration.rb

@@ -0,0 +1,9 @@
+module Nova
+  module API
+    class Configuration
+      attr_accessor :api_key, :subdomain
+      attr_reader :host
+      attr_reader :scheme
+    end
+  end
+end

data/nova-api.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nova/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nova-api"
+  spec.version       = Nova::API::VERSION
+  spec.authors       = ["Coyô Software"]
+  spec.email         = ["ti@coyo.com.br"]
+
+  spec.summary       = %q{Nova.Money API gem}
+  spec.description   = %q{This gem was designed to be used as an easy way to comunicate with the Nova.Money API}
+  spec.homepage      = "https://app.swaggerhub.com/apis-docs/coyosoftware/Nova.Money/v1"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/coyosoftware/nova-api"
+    spec.metadata["changelog_uri"] = "https://github.com/coyosoftware/nova-api/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "byebug", "~> 11.1.3"
+  spec.add_development_dependency "webmock", "~> 3.11.2"
+  spec.add_development_dependency "rspec-dry-struct", "~> 0.1"
+
+  spec.add_dependency "httparty", "~> 0.1"
+  spec.add_dependency "dry-struct", "~> 1.4.0"
+  spec.add_dependency "dry-types", "~> 1.5.1"
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: nova-api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Coyô Software
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.2
+- !ruby/object:Gem::Dependency
+  name: rspec-dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: This gem was designed to be used as an easy way to comunicate with the
+  Nova.Money API
+email:
+- ti@coyo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nova/api.rb
+- lib/nova/api/base.rb
+- lib/nova/api/list_response.rb
+- lib/nova/api/resource/apportionment.rb
+- lib/nova/api/resource/apportionment_value.rb
+- lib/nova/api/resource/bank.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/response/current_asset_statement.rb
+- lib/nova/api/resource/third_party.rb
+- lib/nova/api/resource/write_off.rb
+- lib/nova/api/response.rb
+- lib/nova/api/search_params/apportionment.rb
+- lib/nova/api/search_params/current_asset.rb
+- lib/nova/api/search_params/current_asset_statement.rb
+- lib/nova/api/search_params/third_party.rb
+- lib/nova/api/utils/base_struct.rb
+- lib/nova/api/version.rb
+- lib/nova/configuration.rb
+- nova-api.gemspec
+homepage: https://app.swaggerhub.com/apis-docs/coyosoftware/Nova.Money/v1
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://app.swaggerhub.com/apis-docs/coyosoftware/Nova.Money/v1
+  source_code_uri: https://github.com/coyosoftware/nova-api
+  changelog_uri: https://github.com/coyosoftware/nova-api/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Nova.Money API gem
+test_files: []