invofox-api-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e69d4f366e946575f63b99e3e0a548a08e65e4cce642b817e6798da51b03171a
+  data.tar.gz: fdd5fb3ac989ef8d331a289bb230b832a630f88718d6277bdc67a55ce0353aa2
+SHA512:
+  metadata.gz: 4fb6b9ab3f8dd738f536640138a40bfc147c6c6b33a3e337cad74907e53c70b4bfaf097774c41ea596da99768d9f5c53ecb7778a19cb92540821f5b2ca0fb93c
+  data.tar.gz: ca395634f1ac51266410fc959944e1b90cc8ba58a3aafaf4f7dd95a9399a65d02f7deca9fa7e6d99b67ed7187043e2fefbcecf23f3c2e8a7019d7a1cb527f754

data/.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2.1
+
+executors:
+  gem-executor:
+    working_directory: ~/tmp/gem
+    docker:
+      - image: cimg/ruby:3.0.6
+    environment:
+      TZ: "Europe/Madrid"
+
+jobs:
+  build-test-gem:
+    executor: gem-executor
+    steps:
+      - checkout
+
+      - run:
+          name: Update bundler
+          command: gem install bundler -v 2.2.25
+
+      - restore_cache:
+          keys:
+            - invofox-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+            - invofox-api-ruby-bundle-v2-
+
+      - run: bundle install
+
+      - save_cache:
+          key: invofox-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec spec/
+
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+
+workflows:
+  build-test-gem:
+    jobs:
+      - build-test-gem

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,45 @@
+inherit_from: .rubocop_exclusions.yml
+
+# General configuration
+AllCops:
+  DisabledByDefault: true
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0.6
+
+# Explicit configuration
+Bundler:
+  Enabled: true
+
+Lint:
+  Enabled: true
+
+Layout:
+  Enabled: true
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/HashAlignment:
+  AllowMultipleStyles: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver
+
+Security:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    inject: "inject"
+    collect: "map"
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.6-jemalloc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in invofox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    invofox-api-ruby (0.1.0)
+      rest-client (~> 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.6.20240107)
+    hashdiff (1.0.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    json (2.6.2)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2024.0206)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.1.1)
+    rake (13.0.1)
+    regexp_parser (2.6.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    timecop (0.9.1)
+    unicode-display_width (2.3.0)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  invofox-api-ruby!
+  rake
+  rspec
+  rubocop
+  rubocop-rspec
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.2.20

data/README.md

@@ -0,0 +1,42 @@
+# Ruby client for Invofox API
+
+[![CircleCI](https://circleci.com/gh/quipuapp/invofox-api-ruby.svg?style=shield)](https://circleci.com/gh/quipuapp/invofox-api-ruby)
+
+This is a Ruby client for the Invofox' API
+
+Installation
+---------
+
+Install the gem (`gem install invofox-api-ruby`) or include it in your Gemfile and `bundle`.
+
+Configuration
+---------
+
+Just set the API key by doing this:
+
+```ruby
+Invofox.api_key = 'your-api-key'
+```
+
+Or, if you use it in a Rails application, create an initializer with this content:
+
+```ruby
+require 'invofox'
+
+Invofox.configure do |config|
+  config.api_key = 'your-api-key'
+end
+```
+
+You can set a `logger` as well.
+
+Changelog
+---------
+
+* 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.
+
+About Invofox
+------------
+
+* [Public site](https://invofox.com)
+* [Documentation](https://developers.invofox.com)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/invofox.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invofox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invofox-api-ruby"
+  spec.version       = Invofox::VERSION
+  spec.authors       = ["Albert Bellonch"]
+  spec.email         = ["albert@getquipu.com"]
+
+  spec.summary       = "Ruby client for the Invofox' API"
+  spec.homepage      = "https://getquipu.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "rest-client", "~> 2.0.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "webmock"
+end

data/lib/invofox/base.rb

@@ -0,0 +1,115 @@
+require 'rest-client'
+require 'json'
+
+module Invofox
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def api_call(clazz:, method:, path:, params: {}, &block)
+      # Prepare the URL
+      url = 'https://api.invofox.com' + path
+
+      # Prepare headers & params
+      request_headers = {
+        accept:       'application/json',
+        "x-api-key" => Invofox.configuration.api_key
+      }
+
+      request_params = {
+        headers: request_headers,
+        method:  method,
+        url:     url,
+      }
+
+      if method == :post || method == :put
+        request_params[:payload] = params
+      else
+        request_headers[:params] = params
+      end
+
+      # Do the request
+      response = begin
+        RestClient::Request.execute(request_params)
+      rescue RestClient::BadRequest, RestClient::ExpectationFailed => bad_request
+        bad_request.response
+      end
+
+      # Log it
+      log_request(
+        method: method,
+        url:    url,
+        params: params
+      )
+
+      # Deal with the response
+      response_body = JSON.parse(response.body)
+
+      # 1. First, we treat errors if any
+      treat_errors_if_any(response_body: response_body)
+
+      # 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)
+
+      # 4. And return everything together
+      Invofox::Response.new(
+        result:      result,
+        account:     account,
+        environment: environment
+      )
+    end
+
+    def log_request(method:, url:, params: {})
+      logger = Invofox.configuration.logger
+      return if logger.nil?
+
+      now = Time.now
+
+      safe_params = {}
+      params.each do |key, value|
+        safe_value = value
+
+        if safe_value.is_a?(Symbol)
+          safe_value = safe_value.to_s
+        end
+
+        safe_params[key] = safe_value
+      end
+
+      logger.info(
+        message:   'Invofox request',
+        method:    method.upcase.to_s,
+        url:       url,
+        time:      now.to_s,
+        timestamp: now.to_i,
+        params:    safe_params
+      )
+    end
+
+    private
+
+    def treat_errors_if_any(response_body:)
+      code = response_body['code']
+      return if code.nil?
+
+      additional_info = response_body['additionalInfo']
+
+      raise Invofox::Error.new(
+        code:            code,
+        additional_info: additional_info
+      )
+    end
+  end
+end

data/lib/invofox/configuration.rb

@@ -0,0 +1,3 @@
+class Invofox::Configuration
+  attr_accessor :api_key, :logger
+end

data/lib/invofox/error.rb

@@ -0,0 +1,10 @@
+class Invofox::Error < ::StandardError
+  attr_reader :code, :additional_info
+
+  def initialize(code:, additional_info:)
+    super
+
+    @code = code
+    @additional_info = additional_info
+  end
+end

data/lib/invofox/resource.rb

@@ -0,0 +1,55 @@
+class Invofox::Resource
+  def initialize(data)
+    generate_attr_readers
+    set_data(data)
+  end
+
+  def fields_information
+    self.class.fields_information
+  end
+
+  private
+
+  def generate_attr_readers
+    fields_information.each do |field, _|
+      define_singleton_method(field) do
+        instance_variable_get("@#{field}")
+      end
+    end
+  end
+
+  def set_data(data)
+    fields_information.each do |field, type|
+      next unless data.key?(field.to_s) || data[field.to_sym]
+
+      raw_value = data[field.to_s] || data[field.to_sym]
+      value = value_for(raw_value, type)
+      instance_variable_set("@#{field}", value)
+    end
+  end
+
+  def value_for(raw_value, type)
+    case type
+    when :boolean
+      [true, "1", 1].include?(raw_value)
+    when :time
+      if raw_value.is_a?(Time)
+        raw_value
+      else
+        Time.parse(raw_value)
+      end
+    else
+      raw_value
+    end
+  end
+
+  class << self
+    def fields_information
+      @fields_information
+    end
+
+    def has_fields(fields_information)
+      @fields_information = fields_information.merge("_id" => :string)
+    end
+  end
+end

data/lib/invofox/resources/company.rb

@@ -0,0 +1,50 @@
+class Invofox::Company < Invofox::Resource
+  has_fields name:        :string,
+             countryCode: :string,
+             taxId:       :string,
+             creator:     :string,
+             creation:    :time,
+             data:        :hash
+
+  class << self
+    def get(id:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :get,
+        path:   "/companies/#{id}"
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+
+    def create(country_code:, tax_id:, name:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :post,
+        path:   "/companies",
+        params: {
+          countryCode: country_code,
+          taxId:       tax_id,
+          name:        name
+        }
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+
+    def update(id:, country_code:, tax_id:, name:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :put,
+        path:   "/companies/#{id}",
+        params: {
+          countryCode: country_code,
+          taxId:       tax_id,
+          name:        name
+        }
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+  end
+end

data/lib/invofox/resources/document.rb

@@ -0,0 +1,67 @@
+class Invofox::Document < Invofox::Resource
+  has_fields company:        :string,
+             creator:        :string,
+             creation:       :time,
+             name:           :string,
+             type:           :string,
+             clientData:     :hash,
+             images:         :array,
+             original:       :string,
+             mimetype:       :string,
+             data:           :hash,
+             publicState:    :string,
+             confidence:     :high,
+             validationInfo: :hash,
+             approvalInfo:   :hash,
+             approvedBy:     :array,
+             requiredSigns:  :array,
+             import:         :hash,
+             exports:        :array,
+             archived:       :boolean,
+             geometry:       :hash,
+             skippedBy:      :array
+
+  class << self
+    def get(id:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :get,
+        path:   "/documents/#{id}"
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+
+    def bulk(company_id:, url:)
+      Invofox.api_call(
+        clazz:  Invofox::LoadBatch,
+        method: :post,
+        path:   '/documents/bulk',
+        params: {
+          company:       company_id,
+          urls:          url,
+          closeBatch:    true,
+          useClassifier: true
+        }
+      ) do |response_body|
+        response_body['result']['loadBatch']
+      end
+    end
+
+    def update(id:, data: nil, publicState: nil)
+      payload = {
+        data:        data,
+        publicState: publicState
+      }.compact
+
+      Invofox.api_call(
+        clazz:  self,
+        method: :put,
+        path:   "/documents/#{id}",
+        params: payload
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+  end
+end

data/lib/invofox/resources/load_batch.rb

@@ -0,0 +1,22 @@
+class Invofox::LoadBatch < Invofox::Resource
+  has_fields company:   :string,
+             creator:   :string,
+             creation:  :time,
+             lastLoad:  :time,
+             end:       :time,
+             documents: :array,
+             info:      :hash,
+             state:     :string
+
+  class << self
+    def get(id:)
+      Invofox.api_call(
+        clazz:  self,
+        method: :get,
+        path:   "/loadBatches/#{id}"
+      ) do |response_body|
+        response_body['result']
+      end
+    end
+  end
+end

data/lib/invofox/response.rb

@@ -0,0 +1,9 @@
+class Invofox::Response
+  attr_accessor :result, :account, :environment
+
+  def initialize(result:, account: nil, environment: nil)
+    @result = result
+    @account = account
+    @environment = environment
+  end
+end

data/lib/invofox/version.rb

@@ -0,0 +1,3 @@
+module Invofox
+  VERSION = "0.1.0"
+end

data/lib/invofox.rb

@@ -0,0 +1,10 @@
+require 'invofox/version'
+require 'invofox/configuration'
+require 'invofox/base'
+require 'invofox/error'
+require 'invofox/resource'
+require 'invofox/response'
+
+require 'invofox/resources/company'
+require 'invofox/resources/document'
+require 'invofox/resources/load_batch'

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: invofox-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Albert Bellonch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- albert@getquipu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_exclusions.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- invofox.gemspec
+- lib/invofox.rb
+- lib/invofox/base.rb
+- lib/invofox/configuration.rb
+- lib/invofox/error.rb
+- lib/invofox/resource.rb
+- lib/invofox/resources/company.rb
+- lib/invofox/resources/document.rb
+- lib/invofox/resources/load_batch.rb
+- lib/invofox/response.rb
+- lib/invofox/version.rb
+homepage: https://getquipu.com
+licenses: []
+metadata: {}
+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.4.12
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Invofox' API
+test_files: []