xtract-sdk 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a4abd0dca5657fa1710bdbb1ee483fad535397269085070e1044cf462b5dca8
+  data.tar.gz: cb73e9fdf9a9f1464b48cf206c0dbb6f164b93258d6d4969c165e12817281bc3
+SHA512:
+  metadata.gz: 6fd1d043cc044e72491a3f70f6190abcf89425fc1bb44fbf4cfa8a9d44f65f0fc9aafb8f06a4b7d5dc906aebbc6120616c508f1c53c70ffbe7a1a0d671b5db18
+  data.tar.gz: 95b10e7b32f99f912e7b5e4b9846fb36d7a28b66db81e203199a83bdb515fee76ed5aef2b0efce79e3da31a6532e41f5482f6677a7639209ebc3199f5ae532cb

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - dictum.gemspec
+    - lib/tasks/dictum.rake
+    - spec/spec_helper.rb
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+RSpec/FilePath:
+  Exclude:
+    - spec/xtract_sdk/version_spec.rb

data/.travis.yml

@@ -0,0 +1,17 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+
+before_install: gem install bundler -v 2.2.31
+
+install:
+  - bundle install --retry=3
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop -R lib spec --format simple
+
+os:
+  - linux

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'byebug', '~> 11.1'
+end
+
+group :test do
+  gem 'rspec', '~> 3.10'
+  gem 'rubocop', '~> 1.23'
+  gem 'rubocop-performance', '~> 1.12'
+  gem 'rubocop-rspec', '~> 2.6'
+  gem 'simplecov', '~> 0.21'
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    xtract-sdk (0.0.3)
+      http (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  universal-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  byebug (~> 11.1)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.23)
+  rubocop-performance (~> 1.12)
+  rubocop-rspec (~> 2.6)
+  simplecov (~> 0.21)
+  xtract-sdk!
+
+BUNDLED WITH
+   2.4.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Xtract
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# XtractSDK
+
+This gem is the official library provided by Xtract to interact with our API.
+
+You can read the API docs directly from [here](https://xtractapi.docs.apiary.io).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xtract-sdk'
+```
+
+And then execute:
+
+```bash
+$> bundle
+```
+
+Or install it yourself as:
+
+```bash
+$> gem install xtract-sdk
+```
+
+## Usage
+
+First you need to configure your api key obtained from the platform:
+
+```ruby
+XtractSDK.configure do |config|
+  config.api_key = 'API_KEY'
+end
+```
+
+Also you can pass the key when creating the client directly:
+
+```ruby
+client = XtractSDK::Client.new(api_key: 'API_KEY')
+```
+
+Then you can create a client and start making requests. We provide a convenient way to do this:
+
+### Get invoices
+
+```ruby
+client = XtractSDK::Client.new
+invoices = client
+    .invoices
+    .client_tax_id('SOME_TAX_ID')
+    .call
+
+invoices.each do |invoice|
+  puts invoice.id
+  puts invoice.products
+end
+```
+
+These are all the filtering options:
+
+```ruby
+client_business_name
+client_tax_id
+provider_business_name
+provider_tax_id
+date_from
+date_to
+expiration_date_from
+expiration_date_to
+number
+electronic_authorization_id
+created_at_from
+created_at_to
+accounted ('pending', 'in_progress', 'completed', 'with_errors')
+imputed (true, false)
+```
+
+### Get an invoice
+
+```ruby
+client = XtractSDK::Client.new
+invoice = client.invoice(ID)
+
+puts invoice.id
+puts invoice.products
+```
+
+### Update an invoice
+
+```ruby
+client = XtractSDK::Client.new
+client.update_invoice(ID, { accounted: 'completed' }) #=> :ok
+```
+
+### Errors
+
+You can check [here](https://github.com/xtractapp/ruby-sdk/blob/master/lib/xtract_sdk/error.rb) all the error classes that the library raises.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xtractapp/ruby-sdk.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'xtract_sdk'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xtract_sdk/client.rb

@@ -0,0 +1,26 @@
+require_relative 'invoices/request_builder'
+
+module XtractSDK
+  class Client
+    def initialize(api_key: nil)
+      @api_key = api_key || XtractSDK.config[:api_key]
+    end
+
+    def invoices(params = {})
+      XtractSDK::Invoices::RequestBuilder.new(@api_key, params)
+    end
+
+    def invoice(id)
+      response = HTTPClient.invoice(id, @api_key)
+      Error.raise_from_code!(response.code) if response.code != 200
+      # TODO: use dry-rb structs instead of OpenStruct
+      JSON.parse(response.body.to_s, object_class: OpenStruct) # rubocop:disable Style/OpenStructUse
+    end
+
+    def update_invoice(id, options)
+      response = HTTPClient.update_invoice(id, options, @api_key)
+      Error.raise_from_code!(response.code) if response.code != 200
+      :ok
+    end
+  end
+end

data/lib/xtract_sdk/error.rb

@@ -0,0 +1,15 @@
+module XtractSDK
+  module Error
+    module_function
+
+    def raise_from_code!(code)
+      case code
+      when 404 then raise NotFound
+      else
+        raise "Response code #{code} from API"
+      end
+    end
+
+    class NotFound < StandardError; end
+  end
+end

data/lib/xtract_sdk/http_client.rb

@@ -0,0 +1,38 @@
+require 'http'
+
+module XtractSDK
+  class HTTPClient
+    API_URL = 'https://api.xtract.app/api/v1'.freeze
+
+    class << self
+      def invoices(api_key, params)
+        HTTP.get(
+          "#{API_URL}/invoices",
+          params: params,
+          headers: build_headers(api_key)
+        )
+      end
+
+      def invoice(id, api_key)
+        HTTP.get(
+          "#{API_URL}/invoices/#{id}",
+          headers: build_headers(api_key)
+        )
+      end
+
+      def update_invoice(id, params, api_key)
+        HTTP.put(
+          "#{API_URL}/invoices/#{id}",
+          body: params.to_json,
+          headers: build_headers(api_key)
+        )
+      end
+
+      private
+
+      def build_headers(api_key)
+        { 'Authorization' => api_key, 'Content-type' => 'application/json' }
+      end
+    end
+  end
+end

data/lib/xtract_sdk/invoices/request_builder.rb

@@ -0,0 +1,49 @@
+require_relative 'result'
+
+module XtractSDK
+  module Invoices
+    class RequestBuilder
+      VALID_PARAMS = %i[
+        client_business_name
+        client_tax_id
+        provider_business_name
+        provider_tax_id
+        date_from
+        date_to
+        expiration_date_from
+        expiration_date_to
+        number
+        electronic_authorization_id
+        created_at_from
+        created_at_to
+        accounted
+        imputed
+      ].freeze
+
+      def initialize(api_key, options = {})
+        @api_key = api_key
+        @options = options
+      end
+
+      VALID_PARAMS.each do |param|
+        define_method param do |value = nil|
+          return @options[param] if value.nil?
+
+          @options[param] = value
+          self
+        end
+      end
+
+      def with_market_rate(from = nil, to = nil)
+        return @options[:with_market_rate] if from.nil? && to.nil?
+
+        @options[:with_market_rate] = "#{from}-#{to}"
+        self
+      end
+
+      def call
+        XtractSDK::Invoices::Result.new(@options, @api_key, HTTPClient)
+      end
+    end
+  end
+end

data/lib/xtract_sdk/invoices/result.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module XtractSDK
+  module Invoices
+    class Result
+      include Enumerable
+
+      BATCH_SIZE = 40
+
+      def initialize(options, api_key, client)
+        @options = options
+        @api_key = api_key
+        @client = client
+        reset_cursors!
+      end
+
+      def each
+        if block_given?
+          while (element = read_from_page_or_fetch)
+            yield element
+          end
+          reset_cursors!
+        else
+          to_enum(:each)
+        end
+      end
+
+      private
+
+      def reset_cursors!
+        @page = 0
+        @total_pages = 1
+        @page_cursor = BATCH_SIZE
+        @buffer = []
+      end
+
+      def read_from_page_or_fetch
+        fetch_data if @page_cursor == BATCH_SIZE
+
+        element = @buffer[@page_cursor]
+        return nil unless element
+
+        @page_cursor += 1
+        element
+      end
+
+      def fetch_data
+        response = make_request if @page < @total_pages
+        @buffer = parse_response(response)
+        @page_cursor = 0
+      end
+
+      def parse_response(response)
+        return [] if response.nil?
+
+        Error.raise_from_code!(response.code) if response.code != 200
+        # TODO: use dry-rb structs instead of OpenStruct
+        parsed = JSON.parse(response.body.to_s, object_class: OpenStruct) # rubocop:disable Style/OpenStructUse
+        @total_pages = parsed.total_pages
+        parsed.data
+      end
+
+      def make_request
+        @page += 1
+        @client.invoices(@api_key, @options.merge(page: @page, per_page: BATCH_SIZE))
+      end
+    end
+  end
+end

data/lib/xtract_sdk/version.rb

@@ -0,0 +1,3 @@
+module XtractSDK
+  VERSION = '0.0.3'.freeze
+end

data/lib/xtract_sdk.rb

@@ -0,0 +1,22 @@
+require 'xtract_sdk/error'
+require 'xtract_sdk/client'
+require 'xtract_sdk/http_client'
+require 'xtract_sdk/version'
+
+module XtractSDK
+  @config = {
+    api_key: nil
+  }
+
+  def self.configure
+    yield self
+  end
+
+  def self.api_key=(api_key)
+    @config[:api_key] = api_key
+  end
+
+  def self.config
+    @config
+  end
+end

data/xtract_sdk.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xtract_sdk/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xtract-sdk'
+  spec.version       = XtractSDK::VERSION
+  spec.authors       = ['Alejandro Bezdjian']
+  spec.email         = ['alejandro.bezdjian@klarna.com']
+  spec.summary       = "SDK to connect with Xtract's API"
+  spec.description   = "SDK to connect with Xtract's API"
+  spec.homepage      = 'https://github.com/xtractapp/ruby-sdk'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ['lib']
+  spec.license       = 'MIT'
+
+  spec.add_dependency 'http', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: xtract-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Alejandro Bezdjian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: SDK to connect with Xtract's API
+email:
+- alejandro.bezdjian@klarna.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xtract_sdk.rb
+- lib/xtract_sdk/client.rb
+- lib/xtract_sdk/error.rb
+- lib/xtract_sdk/http_client.rb
+- lib/xtract_sdk/invoices/request_builder.rb
+- lib/xtract_sdk/invoices/result.rb
+- lib/xtract_sdk/version.rb
+- xtract_sdk.gemspec
+homepage: https://github.com/xtractapp/ruby-sdk
+licenses:
+- MIT
+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.1.6
+signing_key: 
+specification_version: 4
+summary: SDK to connect with Xtract's API
+test_files: []