gmxcheckout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c68f89645f170e00a84f9da926ea5ab2b7bb05b
+  data.tar.gz: f6eaa493caec54c102355b92443653823c8ff472
+SHA512:
+  metadata.gz: 5b3970e16aa005269c3d62462fb853fb562d2083025f5114e5d11f5d36eadf9cb2c2c2e96a36b29259d47fdc9e28ec0d91b59423fd4321f593d3991f3567ddc3
+  data.tar.gz: ad43d3182ea19a0fcd510b5f0784921f7a720944bf961276e664ee915c126b14a0a241d8a61f008f3a1e1c268c2d3d9856757e9507b5292050b5502528c6ca45

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rainer Borene
+
+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,81 @@
+# gmxCheckout
+
+[![Build Status](https://travis-ci.org/rainerborene/gmxcheckout.svg)](https://travis-ci.org/rainerborene/gmxcheckout)
+
+A simple library to charge your customers in a monthly basis using
+[gmxCheckout](https://www.gmxcheckout.com.br/) payment system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gmxcheckout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gmxcheckout
+
+## Usage
+
+Start by configuring the required `api_key` in your initializer.
+
+```ruby
+GmxCheckout.configure do |config|
+  config.api_key = ENV['GMXCHECKOUT_API_KEY']
+end
+```
+
+Now you might want to use this pseudo-code in your `User` model on `after_commit` callback.
+
+```ruby
+def charge_credit_card
+  gmx = GmxCheckout::API.new
+
+  response = gmx.subscriptions.create \
+    amounts: [199_00],
+    browser: extras[:browser],
+    remote_ip: extras[:remote_ip],
+    notification_url: extras[:notification_url],
+    description: 'Awesome SaaS',
+    invoice_name: 'Awesome SaaS',
+    address: subscription.address,
+    customer: {
+      name: user.full_name,
+      email: user.email,
+      phone: subscription.phone,
+      cpf: CPF.new(subscription.cpf).stripped
+    },
+    credit_card: subscription.credit_card_params.merge(
+      holder_name: user.full_name
+    )
+
+  if response.success?
+    subscription.code = response.body.subscription_code
+    subscription.status = response.body.subscription_status
+    subscription.expires_at = 30.days.from_now
+    subscription.save
+  else
+    invalidate_credit_card
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/rainerborene/gmxcheckout.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gmxcheckout"
+
+# 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/gmxcheckout.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gmxcheckout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gmxcheckout'
+  spec.version       = GmxCheckout::VERSION
+  spec.authors       = ['Rainer Borene']
+  spec.email         = ['rainerborene@gmail.com']
+
+  spec.summary       = 'Charge your customers in a monthly basis using gmxCheckout'
+  spec.description   = 'A simple and easy to use library to integrate with gmxCheckout'
+  spec.homepage      = 'https://github.com/rainerborene/gmxcheckoR'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'multi_json'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'vcr'
+end

data/lib/gmxcheckout/api.rb

@@ -0,0 +1,30 @@
+module GmxCheckout
+  class API
+    extend Forwardable
+
+    def_delegators :@connection, :get, :post, :put, :patch
+
+    def self.build_notification(params)
+      Models::Notification.new params
+    end
+
+    def initialize(api_key = nil)
+      @api_key = api_key
+      @connection = Faraday.new url: 'https://www.gmxcheckout.com.br' do |conn|
+        conn.use JsonMiddleware
+        conn.request :url_encoded
+        conn.adapter :net_http
+      end
+    end
+
+    def subscriptions
+      @subscriptions ||= Subscriptions.new(self)
+    end
+
+    def api_key
+      @api_key || GmxCheckout.api_key
+    end
+
+    alias key api_key
+  end
+end

data/lib/gmxcheckout/base.rb

@@ -0,0 +1,25 @@
+module GmxCheckout
+  class Base
+    attr_reader :api
+
+    def initialize(api)
+      @api = api
+    end
+
+    def process_transaction(response)
+      Response.new response.body, Models::Transaction
+    end
+
+    def process_body(response)
+      Hashie::Mash.new response.body
+    end
+
+    def prepare!(params)
+      params.tap do |hash|
+        hash['empresa.hashEmpresa'] = api.key
+        hash['restApi'] = true
+        hash.compact!
+      end
+    end
+  end
+end

data/lib/gmxcheckout/json_middleware.rb

@@ -0,0 +1,17 @@
+module GmxCheckout
+  class JsonMiddleware < Faraday::Response::Middleware
+    dependency 'multi_json'
+
+    def parse(body)
+      MultiJson.load clean!(body)
+    end
+
+    private
+
+    def clean!(body)
+      body.delete!('\\')
+          .gsub!(/^"/, '')
+          .gsub!(/[";\n]+$/, '')
+    end
+  end
+end

data/lib/gmxcheckout/model.rb

@@ -0,0 +1,6 @@
+module GmxCheckout
+  class Model < Hashie::Dash
+    include Hashie::Extensions::Dash::PropertyTranslation
+    include Hashie::Extensions::IgnoreUndeclared
+  end
+end

data/lib/gmxcheckout/models/notification.rb

@@ -0,0 +1,50 @@
+module GmxCheckout
+  module Models
+    class Notification < Model
+      # property :subscription_code, from: 'recorrencia.idRecorrenciaEmpresa'
+      # property :transaction_amount, from: 'venda.valor'
+      # property :transaction_owner_id, from: 'venda.idVendaEmpresa'
+
+      property :subscription_code, from: 'recorrencia.idRecorrencia'
+
+      property :subscription_status, from: 'recorrencia.status',
+                                     with: -> (value) { value.to_i }
+
+      property :subscription_created_at, from: 'recorrencia.dataRegistro',
+                                         with: -> (value) { value.to_date }
+
+      property :subscription_latest_payment,
+               from: 'recorrencia.valorUltimoProcessamento'
+
+      property :transaction_date, from: 'venda.dataRegistro',
+                                  with: -> (value) { value.to_date }
+
+      property :transaction_amount, from: 'venda.valor',
+                                    with: -> (value) { value.to_i }
+
+      property :transaction_id, from: 'venda.idVenda',
+                                with: -> (value) { value.to_i }
+
+      property :transaction_status, from: 'venda.status',
+                                    with: -> (value) { value.to_i }
+
+      property :transaction_gateway_id, from: 'venda.tid'
+      property :transaction_gateway_uuid, from: 'venda.nsu'
+      property :transaction_rejected_status, from: 'venda.lr'
+      property :transaction_rejected_message, from: 'venda.lrDescricao'
+      property :transaction_rejected_suggestion, from: 'venda.lrOrientacao'
+
+      property :credit_card_mask, from: 'venda.cartaoCredito.numeroMask'
+      property :credit_card_brand, from: 'venda.formaPagamento'
+
+      property :transaction_auth_code, from: 'venda.arp'
+      property :transaction_eci, from: 'venda.eci'
+      property :transaction_message, from: 'venda.msgErro'
+      property :transaction_gateway, from: 'venda.adquirente'
+
+      def success?
+        transaction_message.blank?
+      end
+    end
+  end
+end

data/lib/gmxcheckout/models/transaction.rb

@@ -0,0 +1,11 @@
+module GmxCheckout
+  module Models
+    class Transaction < Model
+      with = -> (hash) { hash&.fetch('value', nil) }
+
+      property :credit_card_mask, from: 'venda.cartaoCredito.numeroMask'
+      property :subscription_code, from: 'recorrencia.idRecorrencia', with: with
+      property :subscription_status, from: 'recorrencia.status', with: with
+    end
+  end
+end

data/lib/gmxcheckout/response.rb

@@ -0,0 +1,20 @@
+module GmxCheckout
+  class Response
+    attr_reader :message, :errors, :body
+
+    def initialize(body, klass = nil)
+      @errors = body.dig('errors', '@items') || []
+      @message = body['msgRetorno'] || body['msgRetornoAdquirente']
+      @reason = body['status']
+      @body = klass.respond_to?(:new) ? klass.new(body) : body
+    end
+
+    def reason_phrase
+      @reason
+    end
+
+    def success?
+      errors.empty? && reason_phrase != 'fail'
+    end
+  end
+end

data/lib/gmxcheckout/subscriptions.rb

@@ -0,0 +1,73 @@
+module GmxCheckout
+  class Subscriptions < Base
+    def create(hash)
+      response = api.post '/txn/post', create_params(hash)
+      process_transaction response
+    end
+
+    def update(hash)
+      response = api.post '/txn/post', update_params(hash)
+      process_transaction response
+    end
+
+    def cancel(code)
+      response = api.post '/txn/cancelaRecorrencia',
+                          'hashEmpresa' => api.api_key,
+                          'recorrencia.idRecorrencia' => code
+
+      process_body response
+    end
+
+    private
+
+    def update_params(hash)
+      prepare! \
+        'venda.recorrencia.idRecorrencia' => hash[:id],
+        'venda.consumidor.nome'           => hash.dig(:customer, :name),
+        'venda.consumidor.cpf'            => hash.dig(:customer, :cpf),
+        'venda.valor'                     => hash[:amount],
+        'venda.capturaAuto'               => false,
+
+        'cartaoCredito.numero'       => hash.dig(:credit_card, :number),
+        'cartaoCredito.codSeguranca' => hash.dig(:credit_card, :cvc),
+        'cartaoCredito.mesValidade'  => hash.dig(:credit_card, :exp_month),
+        'cartaoCredito.anoValidade'  => hash.dig(:credit_card, :exp_year),
+        'cartaoCredito.bandeira'     => hash.dig(:credit_card, :brand)
+    end
+
+    def create_params(hash)
+      amounts = hash[:amounts].join('|') if hash[:amounts].is_a? Array
+
+      prepare! \
+        'recorrencia.modalidaderecorrencia' => 1,
+        'recorrencia.idrecorrenciaEmpresa'  => hash[:id],
+        'recorrencia.urlCampainha'          => hash[:notification_url],
+        'recorrencia.ipOrigem'              => hash[:remote_ip],
+        'recorrencia.browser'               => hash[:browser],
+        'recorrencia.produto'               => hash[:description],
+        'recorrencia.descricaoFatura'       => hash[:invoice_name],
+        'recorrencia.parcelas'              => hash[:installments],
+        'recorrencia.valor'                 => hash[:amount],
+        'recorrencia.valorParcelas'         => amounts,
+
+        'recorrencia.consumidor.nome'      => hash.dig(:customer, :name),
+        'recorrencia.consumidor.email'     => hash.dig(:customer, :email),
+        'recorrencia.consumidor.telefone1' => hash.dig(:customer, :phone),
+        'recorrencia.consumidor.cpf'       => hash.dig(:customer, :cpf),
+
+        'recorrencia.consumidor.endereco' => hash.dig(:address, :street),
+        'recorrencia.consumidor.numero'   => hash.dig(:address, :number),
+        'recorrencia.consumidor.bairro'   => hash.dig(:address, :district),
+        'recorrencia.consumidor.cidade'   => hash.dig(:address, :city),
+        'recorrencia.consumidor.cep'      => hash.dig(:address, :postal_code),
+        'recorrencia.consumidor.pais'     => hash.dig(:address, :country),
+
+        'cartaoCredito.portador'     => hash.dig(:credit_card, :holder_name),
+        'cartaoCredito.numero'       => hash.dig(:credit_card, :number),
+        'cartaoCredito.codSeguranca' => hash.dig(:credit_card, :cvc),
+        'cartaoCredito.mesValidade'  => hash.dig(:credit_card, :exp_month),
+        'cartaoCredito.anoValidade'  => hash.dig(:credit_card, :exp_year),
+        'cartaoCredito.bandeira'     => hash.dig(:credit_card, :brand)
+    end
+  end
+end

data/lib/gmxcheckout/version.rb

@@ -0,0 +1,3 @@
+module GmxCheckout
+  VERSION = '0.1.0'.freeze
+end

data/lib/gmxcheckout.rb

@@ -0,0 +1,38 @@
+require 'hashie'
+require 'faraday'
+
+require 'gmxcheckout/version'
+
+module GmxCheckout
+  autoload :API,            'gmxcheckout/api'
+  autoload :Base,           'gmxcheckout/base'
+  autoload :JsonMiddleware, 'gmxcheckout/json_middleware'
+  autoload :Model,          'gmxcheckout/model'
+  autoload :Response,       'gmxcheckout/response'
+  autoload :Subscriptions,  'gmxcheckout/subscriptions'
+
+  module Models
+    autoload :Transaction,  'gmxcheckout/models/transaction'
+    autoload :Notification, 'gmxcheckout/models/notification'
+  end
+
+  class << self
+    attr_accessor :api_key
+  end
+
+  def self.configure(&block)
+    instance_eval(&block)
+  end
+
+  def self.statuses
+    @statuses ||= {
+      initiated: 0,
+      captured: 1,
+      cancelled: 3,
+      suspended: 4,
+      approved: 5,
+      rejected: 6,
+      incommunicable: 7
+    }
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: gmxcheckout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rainer Borene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: A simple and easy to use library to integrate with gmxCheckout
+email:
+- rainerborene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gmxcheckout.gemspec
+- lib/gmxcheckout.rb
+- lib/gmxcheckout/api.rb
+- lib/gmxcheckout/base.rb
+- lib/gmxcheckout/json_middleware.rb
+- lib/gmxcheckout/model.rb
+- lib/gmxcheckout/models/notification.rb
+- lib/gmxcheckout/models/transaction.rb
+- lib/gmxcheckout/response.rb
+- lib/gmxcheckout/subscriptions.rb
+- lib/gmxcheckout/version.rb
+homepage: https://github.com/rainerborene/gmxcheckoR
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Charge your customers in a monthly basis using gmxCheckout
+test_files: []