erede-ruby-sdk 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f78b294fe99eac23b6c777004e45627e0ea3e52eec84687655692aa5d81cce0
+  data.tar.gz: f6e272fa91b3ba3c4d7227f951be790212c0d213c8a125ab04a09df86c1e8cbd
+SHA512:
+  metadata.gz: e19817353bd278b779a51c36ce07555f40e19c3fae1f0a3c912db65b1795c8fbac5e34f95f31cd8b9f4bef176de996a6a65a702b786fc0078eab8f7a49de1cab
+  data.tar.gz: 9568d91d4fc7273e1f6ffdc485fec35156309649d7748c959488d9476976ce401200db4dbf8db379427d8100ba19ade663cd25061b50db31278000bdc5a2bb91

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  dockerfile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build Dockerfile
+        run: docker build -t erede_ruby .
+
+      - name: Run tests inside Docker container
+        run: docker run -v $(pwd):/app/ -i erede_ruby bundle exec rake spec
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests with Ruby ${{ matrix.ruby-version }}
+        run: bundle exec rake spec

data/.github/workflows/rubygems.yml

@@ -0,0 +1,30 @@
+name: Publish to Rubygems
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Publish to Rubygems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.idea/
+.rspec_status

data/.rspec

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

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:3.0.0-alpine
+RUN apk update && apk add git make gcc musl-dev
+WORKDIR /app
+COPY . .
+RUN bundle install

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    erede-ruby-sdk (3.0.0)
+      bundler
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux-musl
+
+DEPENDENCIES
+  erede-ruby-sdk!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rede
+
+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,104 @@
+# ERede Ruby
+
+SDK Ruby de integração eRede.
+
+![](./erede-logo.png)
+
+## Guia de uso
+
+```ruby
+# Configuração do ambiente
+store             = Erede::Models::Store.new
+store.token       = '6069a026cf454706990a801ab5fe8e36'
+store.filiation   = '73854967'
+store.logger      = Logger.new(STDOUT)
+store.environment = Erede::Environment.sandbox | Erede::Environment.production
+
+# Inicialização da SDK
+sdk = Erede::Sdk.new(store)
+
+# Realizar uma transação
+# POST /v1/transactions
+# https://developer.userede.com.br/e-rede#swagger_operations-Transa%C3%A7%C3%A3o-realizarTransacao
+create_transaction                        = Erede::Models::Transaction.new
+create_transaction.capture                = false
+create_transaction.kind                   = 'credit'
+create_transaction.reference              = 'pedido123'
+create_transaction.amount                 = 2099
+create_transaction.installments           = 2
+create_transaction.cardholderName         = 'John Snow'
+create_transaction.cardNumber             = '5448280000000007'
+create_transaction.expirationMonth        = 12
+create_transaction.expirationYear         = 2028
+create_transaction.securityCode           = '235'
+create_transaction.softDescriptor         = 'string'
+create_transaction.subscription           = false
+create_transaction.origin                 = 1
+create_transaction.distributorAffiliation = 0
+create_transaction.brandTid               = 'string'
+create_transaction.storageCard            = '1'
+sdk.create(create_transaction)
+
+# Confirmar autorização da transação (captura)
+# PUT /v1/transactions/{tid}
+# https://developer.userede.com.br/e-rede#swagger_operations-Transa%C3%A7%C3%A3o-confirmarAutorizacaoDaTransacaoCaptura
+capture_transaction        = Erede::Models::Transaction.new
+capture_transaction.tid    = 123
+capture_transaction.amount = 2099
+sdk.capture(capture_transaction)
+
+# Cancelar transação
+# POST /v1/transactions/{tid}/refunds
+# https://developer.userede.com.br/e-rede#swagger_operations-Cancelamento-cancelarTransacao
+callback_url      = Erede::Models::Url.new
+callback_url.kind = 'callback'
+callback_url.url  = 'https://cliente.callback.com.br'
+cancel_transaction        = Erede::Models::Transaction.new
+cancel_transaction.tid    = 123
+cancel_transaction.amount = 2000
+cancel_transaction.urls   = [callback_url]
+sdk.cancel(cancel_transaction)
+
+# Consultar transação por tid
+# GET /v1/transactions/{tid}
+# https://developer.userede.com.br/e-rede#swagger_operations-Transa%C3%A7%C3%A3o-consultarTransacaoPorTid
+sdk.get_by_tid(233123)
+
+# Consultar cancelamentos por tid
+# GET /v1/transactions/{tid}/refunds
+# https://developer.userede.com.br/e-rede#swagger_operations-Cancelamento-consultarCancelamentoPorTid
+sdk.get_refunds(123)
+
+# Consultar cancelamento por refundId
+# GET /v1/transactions/{tid}/refunds/{refundId}
+# https://developer.userede.com.br/e-rede#swagger_operations-Cancelamento-consultarCancelamentoPorRefundId
+sdk.get_refund(123, 567)
+
+# Consultar transação por reference
+# GET /v1/transactions?reference={reference}
+# https://developer.userede.com.br/e-rede#swagger_operations-Transa%C3%A7%C3%A3o-consultarTransacaoPorReference
+sdk.get_by_reference(123)
+```
+
+## Testes
+
+```bash
+# Entrar na pasta-raiz do repositório
+cd erede-ruby
+
+# Construir a imagem Docker
+docker build -t erede_ruby .
+
+# Executar os testes
+docker run --rm -v $(pwd):/app/ -w /app/ -it erede_ruby bundle exec rake spec
+
+# Executar um console para testes manuais na gem
+docker run --rm -v $(pwd):/app/ -w /app/ -it erede_ruby irb -I lib -r erede
+```
+
+## Links úteis
+
+- https://developer.userede.com.br/dev-portal-swaggers/erede/swagger.json
+- https://developer.userede.com.br/files/erede/integration_manual.pdf
+- https://developer.userede.com.br/e-rede
+- https://github.com/DevelopersRede

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/erede.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'erede/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'erede-ruby-sdk'
+  spec.version     = Erede::VERSION
+  spec.authors     = ['Rede']
+  spec.email       = ['neto.joaobatista@gmail.com']
+  spec.summary     = 'SDK eRede'
+  spec.description = 'SDK de integração eRede'
+  spec.homepage    = 'https://github.com/developersrede/erede-ruby'
+  spec.license     = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/})}
+  end
+
+  spec.require_paths = ['lib']
+  spec.add_dependency 'bundler'
+  spec.add_dependency 'json'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/erede/environment.rb

@@ -0,0 +1,32 @@
+module Erede
+  class Environment
+    PRODUCTION  = 'https://api.userede.com.br/erede'
+    SANDBOX     = 'https://api.userede.com.br/desenvolvedores'
+    API_VERSION = 'v1'
+
+    attr_accessor :ip,
+                  :session_id,
+                  :endpoint
+
+    def initialize(endpoint)
+      @endpoint = "#{endpoint}/#{API_VERSION}"
+    end
+
+    def self.production
+      new(PRODUCTION)
+    end
+
+    def self.sandbox
+      new(SANDBOX)
+    end
+
+    def to_json(*)
+      {
+        consumer: {
+          ip: @ip,
+          sessionId: @sessionId
+        }
+      }.delete_if { |k, v| v.nil? }.to_json
+    end
+  end
+end

data/lib/erede/errors/erede_error.rb

@@ -0,0 +1,6 @@
+module Erede
+  module Errors
+    class EredeError < StandardError
+    end
+  end
+end

data/lib/erede/models/address.rb

@@ -0,0 +1,17 @@
+module Erede
+  module Models
+    class Address < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :address,
+        :addresseeName,
+        :city,
+        :complement,
+        :neighbourhood,
+        :number,
+        :state,
+        :type,
+        :zipCode
+      ]
+    end
+  end
+end

data/lib/erede/models/authorization.rb

@@ -0,0 +1,25 @@
+module Erede
+  module Models
+    class Authorization < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :affiliation,
+        :amount,
+        :authorizationCode,
+        :cardBin,
+        :cardholderName,
+        :dateTime,
+        :installments,
+        :kind,
+        :last4,
+        :nsu,
+        :origin,
+        :reference,
+        :status,
+        :subscription,
+        :softDescriptor,
+        :distributorAffiliation,
+        :tid
+      ]
+    end
+  end
+end

data/lib/erede/models/base.rb

@@ -0,0 +1,29 @@
+module Erede
+  module Models
+    class Base
+      def initialize
+        set_accessors_for_api_attributes
+      end
+
+      def set_accessors_for_api_attributes
+        self.class.const_get(:API_ATTRIBUTES).each do |attr_name|
+          define_singleton_method attr_name do
+            instance_variable_get("@#{attr_name}")
+          end
+
+          define_singleton_method "#{attr_name}=" do |value|
+            instance_variable_set("@#{attr_name}", value)
+          end
+        end
+      end
+
+      def to_json(*)
+        Hash[
+          self.class.const_get(:API_ATTRIBUTES).map { |attr_name| [attr_name, send(attr_name)] }
+        ]
+        .delete_if { |k, v| v.nil? }
+        .to_json
+      end
+    end
+  end
+end

data/lib/erede/models/brand.rb

@@ -0,0 +1,9 @@
+module Erede
+  module Models
+    class Brand < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :name
+      ]
+    end
+  end
+end

data/lib/erede/models/capture.rb

@@ -0,0 +1,11 @@
+module Erede
+  module Models
+    class Capture < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :amount,
+        :dateTime,
+        :nsu
+      ]
+    end
+  end
+end

data/lib/erede/models/cart.rb

@@ -0,0 +1,14 @@
+module Erede
+  module Models
+    class Cart < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :billing,
+        :consumer,
+        :environment,
+        :iata,
+        :items,
+        :shipping
+      ]
+    end
+  end
+end

data/lib/erede/models/consumer.rb

@@ -0,0 +1,14 @@
+module Erede
+  module Models
+    class Consumer < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :name,
+        :email,
+        :phone,
+        :cpf,
+        :documents,
+        :gender
+      ]
+    end
+  end
+end

data/lib/erede/models/device.rb

@@ -0,0 +1,14 @@
+module Erede
+  module Models
+    class Device < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :colorDepth,
+        :deviceType3ds,
+        :javaEnabled,
+        :language,
+        :screenHeight,
+        :screenWidth
+      ]
+    end
+  end
+end

data/lib/erede/models/document.rb

@@ -0,0 +1,10 @@
+module Erede
+  module Models
+    class Document < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :type,
+        :number
+      ]
+    end
+  end
+end

data/lib/erede/models/flight.rb

@@ -0,0 +1,13 @@
+module Erede
+  module Models
+    class Flight < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :date,
+        :from,
+        :number,
+        :passenger,
+        :to
+      ]
+    end
+  end
+end

data/lib/erede/models/iata.rb

@@ -0,0 +1,11 @@
+module Erede
+  module Models
+    class Iata < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :code,
+        :departureTax,
+        :flight
+      ]
+    end
+  end
+end

data/lib/erede/models/item.rb

@@ -0,0 +1,16 @@
+module Erede
+  module Models
+    class Item < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :amount,
+        :description,
+        :discount,
+        :freight,
+        :id,
+        :quantity,
+        :shippingType,
+        :type
+      ]
+    end
+  end
+end

data/lib/erede/models/passenger.rb

@@ -0,0 +1,12 @@
+module Erede
+  module Models
+    class Passenger < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :email,
+        :name,
+        :phone,
+        :ticket
+      ]
+    end
+  end
+end

data/lib/erede/models/phone.rb

@@ -0,0 +1,11 @@
+module Erede
+  module Models
+    class Phone < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :ddd,
+        :number,
+        :type
+      ]
+    end
+  end
+end

data/lib/erede/models/refund.rb

@@ -0,0 +1,12 @@
+module Erede
+  module Models
+    class Refund < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :amount,
+        :refundDateTime,
+        :refundId,
+        :status
+      ]
+    end
+  end
+end

data/lib/erede/models/store.rb

@@ -0,0 +1,13 @@
+module Erede
+  module Models
+    class Store < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :token,
+        :filiation
+      ]
+
+      attr_accessor :environment,
+                    :logger
+    end
+  end
+end

data/lib/erede/models/submerchant.rb

@@ -0,0 +1,19 @@
+module Erede
+  module Models
+    class SubMerchant < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :mcc,
+        :city,
+        :country,
+        :subMerchantID,
+        :address,
+        :city,
+        :state,
+        :country,
+        :cep,
+        :cnpj,
+        :taxIdNumber
+      ]
+    end
+  end
+end

data/lib/erede/models/three_d_secure.rb

@@ -0,0 +1,19 @@
+module Erede
+  module Models
+    class ThreeDSecure < ::Erede::Models::Base
+      API_ATTRIBUTES = [
+        :cavv,
+        :eci,
+        :embedded,
+        :onFailure,
+        :device,
+        :url,
+        :urls,
+        :userAgent,
+        :xid,
+        :threeDIndicator,
+        :directoryServerTransactionId
+      ]
+    end
+  end
+end