omie-client 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a1de613fdbc2ba050cfaa890e82d04b57ce34d9715dd2b00a81dfb6816129a
-  data.tar.gz: cb79914f46a01909b57f794c09ac1b529ba6c03a4a4daa29ef67c972b5452c09
+  metadata.gz: 3363ec39f3eb50f1ce8f1555502c67837b6e9c89cb98ed44818fb1c4f29ffc15
+  data.tar.gz: 3e19a18a10d814e80e274700b3d584c114dad57196daad8a37382ea5fec58021
 SHA512:
-  metadata.gz: f08dd02f8e999d00b363d0075eca5482ee467d738ee18824883b6c2021ab103aa3bf5663e4d6adb00a7ed3e1b363df83c5265c6ea664d525ccf20780c5d5030a
-  data.tar.gz: d552b52fca09746097ee3558fa4db1aeb7f8ac74682405a858012572e2daedbe68249322011ed27a316ee4338496a8ebff94048cd1efa4a970d30b4f40dbaaa0
+  metadata.gz: 93d808cb45297237c3cf39e461d462f32e96afdcb881f1ba0e70caaa9cb55d67202e95e9c52c5c5d1316240fa3e3bca6cd6c3631f4928cad5c2f6aa7fc89be8c
+  data.tar.gz: 631ffe7c3e8f89fa7d9e0c56268824301b70e9f3d44470ce91e01ac273cc11e37b1e05bf291fd1824d7fe60e675b568e53f4f39dcc8c77e3ff87f31787706a26

data/.rubocop.yml

@@ -14,3 +14,12 @@ Metrics/BlockLength:
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*"
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omie-client (0.1.4)
+    omie-client (0.1.7)
       activesupport (>= 5.0)
       rest-client (>= 2.0)
 
@@ -70,7 +70,7 @@ GEM
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.6.1)
 
 PLATFORMS

data/README.md

@@ -104,7 +104,7 @@ from the API, please open an issue first to avoid duplicated work.
 To properly test if the gem is working properly, you can install it locally:
 ```sh
 gem build omie-client.gemspec
-gem install ./omie-client.gemspec-x.y.z.gem
+gem install ./omie-client-x.y.z.gem
 ```
 The `x.y.z` represents the version described in [lib/omie/version.rb](lib/omie/version.rb)
 
@@ -117,10 +117,10 @@ irb
 ```
 
 ```ruby
-require 'omie-client'
+require 'omie'
 => true
-Omie.version
-=> x.y.z
+Omie::VERSION
+=> "x.y.z"
 # Default credentials provided by Omie API for tests
 Omie.app_key = '1560731700'
 Omie.app_secret = '226dcf372489bb45ceede61bfd98f0f1'
@@ -129,6 +129,16 @@ Omie::Company.list
 Omie::Product.list
 ```
 
+If everything is working fine and you have the proper credentials to upload
+the new version, run:
+
+```sh
+gem push omie-client-x.y.z.gem
+Pushing gem to RubyGems.org...
+Successfully registered gem: omie-client (x.y.z)
+```
+> You may need to authenticate at rubygems first => https://guides.rubygems.org/make-your-own-gem/
+
 ## License
 
 See the [LICENSE](LICENSE) file.

data/lib/omie.rb

@@ -2,6 +2,7 @@
 
 require_relative 'omie/base_resource'
 require_relative 'omie/company'
+require_relative 'omie/tax_recommendation'
 require_relative 'omie/product'
 require_relative 'omie/connection'
 require_relative 'omie/error'

data/lib/omie/base_resource.rb

@@ -11,7 +11,15 @@ module Omie
     # values
     def initialize(args = {})
       args.each do |key, value|
-        send("#{key}=", value) if respond_to?(key)
+        key_s = key.to_sym
+        has_internal_const = self.class.const_defined?('INTERNAL_MODELS')
+        if has_internal_const && self.class::INTERNAL_MODELS.key?(key_s)
+          klass = self.class::INTERNAL_MODELS[key_s]
+          instance = klass.new(value)
+          send("#{key}=", instance)
+        elsif respond_to?(key_s)
+          send("#{key}=", value)
+        end
       end
     end
 
@@ -28,6 +36,7 @@ module Omie
 
     def self.request_and_initialize(uri, call, params)
       response = request(uri, call, params)
+
       new(response)
     end
   end

data/lib/omie/company.rb

@@ -28,7 +28,7 @@ module Omie
     attr_accessor :email, :cnpj_cpf, :razao_social, :contato, :nome_fantasia
     attr_accessor :codigo_cliente_integracao, :codigo_cliente_omie, :endereco
     attr_accessor :cidade, :complemento, :estado, :endereco_numero, :cep
-    attr_accessor :codigo_pais, :bairro, :inscricao_estadual
+    attr_accessor :codigo_pais, :bairro, :inscricao_estadual, :inativa
 
     # Record a new company using the
     # {https://app.omie.com.br/api/v1/geral/clientes/#IncluirCliente
@@ -93,16 +93,22 @@ module Omie
     # records.
     #
     # @!scope class
-    # @param page [Integer]
-    #   the page to be returned.
-    # @param per_page [Integer]
-    #   the number of items per page (max: 50).
+    # @param [Hash] options
+    #   The options param follows the same structure described by
+    #   https://app.omie.com.br/api/v1/geral/clientes/#clientes_list_request
     # @return [Array<Omie::Company>]
     #   the list of found companies
-    def self.list(page = 1, per_page = 50)
-      params = { pagina: page, registros_por_pagina: per_page }
+    def self.list(options = {})
+      default = {
+        pagina: 1, registros_por_pagina: 50,
+        apenas_importado_api: 'N'
+      }
+
+      default.each do |k, v|
+        options[k] = v unless options.key?(k)
+      end
 
-      response = request(URI, CALLS[:list], params)
+      response = request(URI, CALLS[:list], options)
       response['clientes_cadastro'].map { |client| Omie::Company.new(client) }
     rescue Omie::RequestError
       []

data/lib/omie/product.rb

@@ -20,10 +20,16 @@ module Omie
       associate: 'AssociarCodIntProduto'
     }.freeze
 
+    INTERNAL_MODELS = {
+      recomendacoes_fiscais: Omie::TaxRecommendation
+    }.freeze
+
     URI = '/v1/geral/produtos/'
 
     attr_accessor :ncm, :valor_unitario, :unidade, :descricao_status
     attr_accessor :codigo_produto_integracao, :codigo_produto, :descricao
+    attr_accessor :codigo, :tipoItem # They do not keep the same name style =(
+    attr_accessor :recomendacoes_fiscais # {Omie::TaxRecommendation}
 
     # Record a new product using the
     # {https://app.omie.com.br/api/v1/geral/produtos/#IncluirProduto
@@ -88,16 +94,22 @@ module Omie
     # records.
     #
     # @!scope class
-    # @param page [Integer]
-    #   the page to be returned.
-    # @param per_page [Integer]
-    #   the number of items per page (max: 50).
+    # @param [Hash] options
+    #   The options param follows the same structure described by
+    #   https://app.omie.com.br/api/v1/geral/produtos/#produto_servico_list_request
     # @return [Array<Omie::Product>]
     #   the list of found companies
-    def self.list(page = 1, per_page = 50)
-      params = { pagina: page, registros_por_pagina: per_page }
+    def self.list(options = {})
+      default = {
+        pagina: 1, registros_por_pagina: 50,
+        apenas_importado_api: 'N', filtrar_apenas_omiepdv: 'N'
+      }
+
+      default.each do |k, v|
+        options[k] = v unless options.key?(k)
+      end
 
-      response = request(URI, CALLS[:list], params)
+      response = request(URI, CALLS[:list], options)
       response['produto_servico_cadastro'].map do |product|
         Omie::Product.new(product)
       end

data/lib/omie/tax_recommendation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Omie
+  # This class abstracts tax recommendations related to the Product resource
+  # from Omie (Ref: Produto). It works as an embedded object inside Product
+  # payload. Take a look at this link for more details:
+  # {https://app.omie.com.br/api/v1/geral/produtos/}.
+  #
+  # Different from traditional resources that inherit from {Omie::BaseResource},
+  # internal objects does nothing but declares attributes that will comprise
+  # a higher level resource's payload. They usually does not have specific
+  # endpoints.
+  class TaxRecommendation < Omie::BaseResource
+    attr_accessor :origem_mercadoria, :id_preco_tabelado, :id_cest,
+                  :cupom_fiscal, :market_place, :indicador_escala,
+                  :cnpj_fabricante
+  end
+end

data/lib/omie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Omie
-  VERSION = '0.1.4'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omie-client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Peerdustry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,7 @@ files:
 - lib/omie/error.rb
 - lib/omie/info.rb
 - lib/omie/product.rb
+- lib/omie/tax_recommendation.rb
 - lib/omie/version.rb
 - omie-client.gemspec
 homepage: https://gitlab.com/peerdustry/floss/omie-client