invofox-api-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b00b513fe176cfdbcb4d62613895e50b3eeecf33f1b8f9b07ed29de98c6c7a36
-  data.tar.gz: b40d4e0c9f8e8f41591c08f88fee0a7d16748c25fd25522668ee8c3c9311e25a
+  metadata.gz: eae8ebc082cdba1058d0753a39ff406d14dc0bec4f74434a2210db78287e2300
+  data.tar.gz: 6294b3ab459a7548702086d2cac5b1bdb0f53e71304d5b43e4de227a2cfd2c51
 SHA512:
-  metadata.gz: 210d9cf33066ee484f40acb375c1820abb16436e9951cf23afbc559402c189958bbdef6ff565f30d465f9c7a7b5cc12309743376c66a491ad84b2959166f10bd
-  data.tar.gz: 8548ec572c3c1276f4ca11117528142a227da74dfcf566944204983a8305c4d975e579cf74b29fb6d1755b59fe0fed9dfc0b6c9c6c400d2aecca9f73b2f635d7
+  metadata.gz: dea3aaf07d57a3a617c9cd468d0e6861d3f547cb6f369a2cf2ce0425a8d401e83924c960d395b79c5d7e1a5c2306a3df15a4b79d36d834dc14262a7e708fa590
+  data.tar.gz: 41300f3574b9bbaec5529ebcdcfe035aa71c60bbc32a5c749c2409763059049617f6ddf70e3acb6c9e4347fc5ae33d081d759ff8fbca9f1673f514a730511cf1

data/.rubocop_exclusions.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-04-17 14:37:05 UTC using RuboCop version 1.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/invofox/collection.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    invofox-api-ruby (0.1.1)
+    invofox-api-ruby (0.1.2)
       rest-client (~> 2.0.2)
 
 GEM

data/README.md

@@ -33,6 +33,7 @@ You can set a `logger` as well.
 Changelog
 ---------
 
+* v.0.1.2 Added support for companies' list endpoint.
 * v.0.1.1 Added support for documents' update_type endpoint.
 * v.0.1.0 First vull version, including resource wrapping for companies (get, create and update), documents (get, bulk and update) and load batches (get), plus logger integration.
 

data/lib/invofox/base.rb

@@ -56,18 +56,16 @@ module Invofox
       # 2. If all went fine, we locate the body result
       result_in_body = block.call(response_body)
 
-      # 3. Then we extract account and environment
-      account = result_in_body.delete("account")
-      environment = result_in_body.delete("environment")
-
-      # 4. We build the resource result
-      result = clazz.new(result_in_body)
+      # 3. We build the resource result
+      result = if result_in_body.is_a?(Array)
+                 Collection.new(result_in_body, clazz)
+               else
+                 clazz.new(result_in_body)
+               end
 
       # 4. And return everything together
       Invofox::Response.new(
-        result:      result,
-        account:     account,
-        environment: environment
+        result:      result
       )
     end
 

data/lib/invofox/collection.rb

@@ -0,0 +1,7 @@
+class Invofox::Collection < Array
+  def initialize(response, item_klass)
+    response.each do |item|
+      self << item_klass.new(item)
+    end
+  end
+end

data/lib/invofox/resource.rb

@@ -5,7 +5,14 @@ class Invofox::Resource
   end
 
   def fields_information
-    self.class.fields_information
+    # We add account and environment, which are common in all resources
+    self
+      .class
+      .fields_information
+      .merge(
+        account:     :string,
+        environment: :string
+      )
   end
 
   private

data/lib/invofox/resources/company.rb

@@ -7,6 +7,21 @@ class Invofox::Company < Invofox::Resource
              data:        :hash
 
   class << self
+    # TODO allow not required fields; for now we just need this scenario at Quipu
+    def list(country_code:, tax_id:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :get,
+        path:   "/companies",
+        params: {
+          countryCode: country_code,
+          taxId:       tax_id
+        }
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+
     def get(id:)
       Invofox.api_call(
         clazz:  self,

data/lib/invofox/version.rb

@@ -1,3 +1,3 @@
 module Invofox
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/invofox.rb

@@ -3,6 +3,7 @@ require 'invofox/configuration'
 require 'invofox/base'
 require 'invofox/error'
 require 'invofox/resource'
+require 'invofox/collection'
 require 'invofox/response'
 
 require 'invofox/resources/company'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invofox-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Albert Bellonch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -142,6 +142,7 @@ files:
 - invofox.gemspec
 - lib/invofox.rb
 - lib/invofox/base.rb
+- lib/invofox/collection.rb
 - lib/invofox/configuration.rb
 - lib/invofox/error.rb
 - lib/invofox/resource.rb