listo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71fa066f9c0d4b8989daa59834aab045bb058876f9b1c729fc0ca9a9111f71ba
+  data.tar.gz: 41a1274e380080acb24a3a12b571e810e25578e034080efa1e21370a3bc30633
+SHA512:
+  metadata.gz: ec9b96f1ff54f039070c40ed419dbea0b8affa60da5792585ed5897557342ab2d52e7869badc4db622cc8ab7a9d42a3590865d2f483180714f0c66699351d451
+  data.tar.gz: cbc4be2daa4f820ec1e6a778199d934a69134b4c1df339c5aa4b351b33f66fb6ddf822ef7a75d55a31018e3e730e51462bc7c15eaa1efccb055a65abe8f79912

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset                  = utf-8
+end_of_line              = lf
+trim_trailing_whitespace = true
+insert_final_newline     = false
+
+[*.{rb,yml}]
+indent_style = space
+indent_size  = 2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    listo (0.1.0)
+      faraday (~> 0.12.2)
+      faraday_middleware (~> 0.10.0)
+      openssl (~> 2.1, >= 2.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    multipart-post (2.0.0)
+    openssl (2.1.1)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  listo!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 3.0, >= 3.0.3)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,64 @@
+# Listo
+
+A Ruby client for the [listo.mx](https://listo.mx/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'listo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install listo
+
+## Usage
+
+### Client setup
+
+```Ruby
+Listo::Client.configure do |client|
+  client.token           = 'LISTO_API_TOKEN'
+  client.cert_file       = './path/cert.cer'
+  client.pkey_file       = './path/pkcs8.pem'
+  client.pkey_passphrase = 'passphrase'
+  client.debug_mode      = false # default
+end
+```
+
+The PKEY is usually provided in a DER format, you can create a copy in a PEM format with the following command:
+
+```sh
+openssl pkcs8 -inform DER -outform PEM -in pkcs8.key -out pkcs8.pem
+```
+
+### Invoicing
+
+##### Generate XML
+
+```Ruby
+Listo::Invoicing.generate_xml(invoice_data)
+```
+
+##### Certify XML
+
+```Ruby
+Listo::Invoicing.certify_xml(xml, original_chain, data)
+```
+
+For more details checkout the listo.mx [api docs](https://apidocs.listo.mx).
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aliada-mx/listo.

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 "listo"
+
+# 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/listo/certificate.rb

@@ -0,0 +1,17 @@
+require 'openssl'
+require 'base64'
+
+module Listo
+  class Certificate < SimpleDelegator
+    def initialize(cert_file)
+      cert_der = File.read(cert_file)
+      cert     = OpenSSL::X509::Certificate.new(cert_der)
+
+      super(cert)
+    end
+
+    def to_der64
+      Base64.encode64(to_der)
+    end
+  end
+end

data/lib/listo/client.rb

@@ -0,0 +1,40 @@
+require 'listo/connection'
+require 'listo/invoicing'
+require 'listo/certificate'
+require 'listo/pkey'
+
+module Listo
+  class Client
+    attr_reader :connection, :cert, :pkey
+
+    attr_accessor(
+      :token,
+      :cert_file,
+      :pkey_passphrase,
+      :pkey_file,
+      :debug_mode,
+    )
+
+    def self.current
+      @client
+    end
+
+    def self.configure(&config)
+      yield @client = new
+
+      @client
+    end
+
+    def cert
+      @cert ||= Listo::Certificate.new(cert_file)
+    end
+
+    def pkey
+      @pkey ||= Listo::PKey.new(pkey_file, pkey_passphrase)
+    end
+
+    def connection
+      Listo::Connection.new(token, debug_mode: debug_mode)
+    end
+  end
+end

data/lib/listo/connection.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'listo/middleware/raise_error'
+
+module Listo
+  class Connection < SimpleDelegator
+    def initialize(token, debug_mode: false)
+      @debug_mode = debug_mode
+
+      connection = Faraday.new(url: url) do |faraday|
+        faraday.use Listo::Middleware::RaiseError
+
+        faraday.request  :json
+        faraday.response :json, content_type: 'application/json'
+
+        faraday.adapter Faraday.default_adapter
+      end
+
+      connection.headers['Authorization'] = "Token #{token}"
+      connection.headers['Content-Type']  = 'application/json'
+      connection.headers['Accept']        = 'application/json'
+
+      super(connection)
+    end
+
+    private
+
+      def url
+        @debug_mode ? 'https://staging.listo.mx/api' : 'https://listo.mx/api'
+      end
+  end
+end

data/lib/listo/error.rb

@@ -0,0 +1,21 @@
+module Listo
+  module Error
+    class Error < StandardError
+    end
+
+    class ClientError < Error
+      attr_reader :status, :headers, :body
+
+      def initialize(env)
+        @status  = env.dig(:status)
+        @headers = env.dig(:headers)
+        @body    = env.dig(:body)
+
+        super("the server responded with status #{@status}")
+      end
+    end
+
+    class StampError < Error
+    end
+  end
+end

data/lib/listo/invoicing.rb

@@ -0,0 +1,56 @@
+require 'openssl'
+require 'base64'
+
+module Listo
+  class Invoicing
+    class << self
+      extend Forwardable
+
+      def_delegators :client, :cert, :pkey
+
+      def generate_xml(params = [])
+        client.connection.post('invoicing/generate_xml', params).body
+      end
+
+      def certify_xml(xml, original_chain, data)
+        params = {
+          xml:             xml,
+          certificate_num: certificate_num,
+          certificate:     certificate,
+          signature:       signature(original_chain),
+          data:            data,
+        }
+
+        response = client.connection.post('invoicing/certify_xml', params).body
+
+        # warning: listo reponds stamp errors with HTTP 200
+        if response.dig('status') == 'error'
+          raise Listo::Error::StampError, response.dig('error_description')
+        end
+
+        response
+      end
+
+      private
+
+        def client
+          Listo::Client.current
+        end
+
+        def certificate
+          cert.to_der64.delete("\n")
+        end
+
+        def certificate_num
+          cert.serial.to_s(2)
+        end
+
+        def signature(original_chain)
+          original_chain.gsub!("|#{'0' * 20}|", "|#{certificate_num}|")
+          signature = pkey.sign(OpenSSL::Digest::SHA256.new, original_chain)
+
+          Base64.encode64(signature).delete("\n")
+        end
+    end
+  end
+end

data/lib/listo/middleware/raise_error.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+require 'listo/error'
+
+module Listo
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+      ClientErrorStatuses = 400...600
+
+      def on_complete(env)
+        case env[:status]
+        when ClientErrorStatuses
+          raise Listo::Error::ClientError, response_values(env)
+        end
+      end
+
+      private
+
+      def response_values(env)
+        {
+          status:  env.status,
+          headers: env.response_headers,
+          body:    env.body
+        }
+      end
+    end
+  end
+end

data/lib/listo/pkey.rb

@@ -0,0 +1,12 @@
+require 'openssl'
+
+module Listo
+  class PKey < SimpleDelegator
+    def initialize(key_file, pass_phrase = nil)
+      key_pem = File.read(key_file)
+      key     = OpenSSL::PKey::RSA.new(key_pem, pass_phrase)
+
+      super(key)
+    end
+  end
+end

data/lib/listo/version.rb

@@ -0,0 +1,3 @@
+module Listo
+  VERSION = '0.1.0'
+end

data/lib/listo.rb

@@ -0,0 +1,5 @@
+require 'listo/client'
+require 'listo/version'
+
+module Listo
+end

data/listo.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'listo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'listo'
+  spec.version       = Listo::VERSION
+  spec.authors       = ['Luis Alfredo Lorenzo']
+  spec.email         = ['babasbot@gmail.com']
+
+  spec.summary       = 'A Ruby wrapper for the listo.mx API'
+  spec.description   = 'A Ruby implementation for the listo.mx web API.'
+  spec.homepage      = 'https://github.com/aliada-mx/listo'
+  spec.license       = 'Nonstandard'
+
+  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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'vcr',     '~> 3.0', '>= 3.0.3'
+
+  spec.add_development_dependency 'webmock', '~> 2.1'
+
+  spec.add_dependency 'faraday',            '~> 0.12.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'openssl',            '~> 2.1',  '>= 2.1.1'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: listo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luis Alfredo Lorenzo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: A Ruby implementation for the listo.mx web API.
+email:
+- babasbot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/listo.rb
+- lib/listo/certificate.rb
+- lib/listo/client.rb
+- lib/listo/connection.rb
+- lib/listo/error.rb
+- lib/listo/invoicing.rb
+- lib/listo/middleware/raise_error.rb
+- lib/listo/pkey.rb
+- lib/listo/version.rb
+- listo.gemspec
+homepage: https://github.com/aliada-mx/listo
+licenses:
+- Nonstandard
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the listo.mx API
+test_files: []