ebanx 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6199e3f2a9c361e756af0826fca2bbc2a48f11b
-  data.tar.gz: 95dfdfde61a1d96da9e15187cb17d3f05be0c051
+  metadata.gz: 457ce2e7ec65501d6a9cc5aa6751220dd02e8525
+  data.tar.gz: a3133d9e22217d01ef0bc35071dbc2cf309b366d
 SHA512:
-  metadata.gz: 65245844edf359c97ae313f59ab19eff89959f4e28b46fd4ad972f063f2bf630b7d36cf42a261fb743bf5852e24dd5f2ffab2dffa1f1ce97c15ca61a5ba0cc51
-  data.tar.gz: f16ca6ad24dc33081e58c12f4f143270745cb2903ac27e8acf947da9962eaff9e4ba02acc87044828b76699e9407d50ac2ec100e6fbf72268e393447b75187e7
+  metadata.gz: 46e1c94cd33109f050d628bca2b9deaba68852016cc2c13b8612022d335d116f853241753eb5817d4c000384b67e85259105300bdc9c90219117394294389548
+  data.tar.gz: d3cc2e19b0427d1291fe327229313b760da40416d62df5365acdff0ee35007862ed42f45aafb408b71175475e81dd8f4aeae2cf33b922664262d0bd49cf990b5

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode

data/CONTRIBUTORS

@@ -1 +1,2 @@
+Ariel Patschiki <arielpts@me.com>
 Gustavo Henrique Mascarenhas Machado <guhemama@gmail.com>

data/README.md

@@ -1,16 +1,16 @@
-# Ebanx
+# EBANX Ruby gem [![Build Status](https://travis-ci.org/ebanx-integration/ebanx-ruby.svg?branch=master)](https://travis-ci.org/ebanx-integration/ebanx-ruby) [![Code Climate](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/badges/gpa.svg)](https://codeclimate.com/github/ebanx-integration/ebanx-ruby) [![Test Coverage](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/badges/coverage.svg)](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/coverage)
+Gem to communicate with EBANX.
 
-TODO: Write a gem description
+Documentation: https://developers.ebanx.com/
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile, and bundle it:
 
-    gem 'ebanx'
-
-And then execute:
-
-    $ bundle
+```
+gem 'ebanx'
+$ bundle
+```
 
 Or install it yourself as:
 
@@ -18,7 +18,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Create a new Boleto using Direct API
+```ruby
+response = ebanx.do_direct {
+  operation: 'request',
+  mode: 'full',
+  payment: {
+    name: 'João da Silva',
+    email: 'joao@mailinator.com',
+    currency_code: 'USD',
+    amount_total: 100.50,
+    merchant_payment_code: Random.rand(10000000000),
+    payment_type_code: 'boleto',
+    person_type: 'personal',
+    document: '13326724691',
+    birth_date: '01/01/1980',
+    zipcode: '70000-000',
+    address: 'Rua Brasil',
+    street_number: '1',
+    city: 'Brasília',
+    state: 'DF',
+    country: 'br',
+    phone_number: '6130001111',
+    due_date: (Time.now + 86400).strftime('%d/%m/%Y')
+  }
+}
+
+```
+
+## Automated Tests
+We use minitest for testing this Gem.
+
+```
+rake test
+```
 
 ## Contributing
 
@@ -26,4 +59,4 @@ TODO: Write usage instructions here
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/ebanx.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "codeclimate-test-reporter"
 
-  spec.add_dependency('rest-client', '~> 1.5')
-end
+  spec.add_dependency 'rest-client', '~> 1.7.3'
+  spec.add_dependency 'json'
+end

data/lib/ebanx.rb

@@ -2,35 +2,41 @@ require 'rest-client'
 require 'json'
 
 require_relative 'ebanx/version'
+require_relative 'ebanx/response'
 require_relative 'ebanx/command/command'
 require_relative 'ebanx/command/cancel'
 require_relative 'ebanx/command/capture'
+require_relative 'ebanx/command/direct'
 require_relative 'ebanx/command/exchange'
-require_relative 'ebanx/command/print_html'
+require_relative 'ebanx/command/print'
 require_relative 'ebanx/command/query'
 require_relative 'ebanx/command/refund'
 require_relative 'ebanx/command/refund_or_cancel'
 require_relative 'ebanx/command/request'
-
+require_relative 'ebanx/command/token'
+require_relative 'ebanx/command/zipcode'
 
 module Ebanx
   @test_mode = false
 
   class << self
-    attr_accessor :integration_key, :test_mode
+    attr_accessor :integration_key, :test_mode, :parse_response
   end
 
   def self.base_uri
     if @test_mode
-      'https://www.ebanx.com/test/ws/'
+      'https://sandbox.ebanx.com/ws/'
     else
       'https://www.ebanx.com/pay/ws/'
     end
   end
 
+  protected
   def self.run_command(method, params)
     klass = get_command_class method
 
+    raise ArgumentError if !params[0] || params[0].length == 0
+
     params = params[0].merge! integration_key: @integration_key
     command = klass.new params
 
@@ -41,8 +47,13 @@ module Ebanx
 
   def self.request(command)
     uri = Ebanx::base_uri + command.request_action
-    result = RestClient.send command.request_method, uri, params: command.params, content_type: command.response_type
-    JSON.parse result
+
+    case command.request_method
+      when :post then response = RestClient.post uri, command.params, content_type: command.response_type
+      when :get  then response = RestClient.get uri, params: command.params
+    end
+
+    Ebanx::Response.new response, command.response_type
   end
 
   def self.method_missing(method, *args, &block)

data/lib/ebanx/command/command.rb

@@ -1,12 +1,23 @@
 module Ebanx
   module Command
     class Command
-      attr_accessor :params, :request_method, :request_action, :response_type
+      @request_body = false
+
+      attr_accessor :params, :request_method, :request_action, :response_type, :request_body
 
       def valid?
         validate
       end
 
+      def params
+        # Wraps parameters into request_body
+        if @request_body
+          { request_body: @params.to_json }
+        else
+          @params
+        end
+      end
+
       protected
       def validate
         raise NotImplementedError

data/lib/ebanx/command/direct.rb

@@ -0,0 +1,19 @@
+module Ebanx
+  module Command
+    class Direct < Command
+      def initialize(params)
+        @params         = params
+        @request_method = :post
+        @request_action = 'direct'
+        @response_type  = :json
+        @request_body   = true
+      end
+
+      def validate
+        validate_presence :operation
+        validate_presence :mode
+        validate_presence :payment
+      end
+    end
+  end
+end

data/lib/ebanx/command/{print_html.rb → print.rb}

@@ -1,10 +1,10 @@
 module Ebanx
   module Command
-    class PrintHtml < Command
+    class Print < Command
       def initialize(params)
         @params         = params
         @request_method = :get
-        @request_action = 'boleto/printHTML'
+        @request_action = 'print'
         @response_type  = 'text/html'
       end
 

data/lib/ebanx/command/token.rb

@@ -0,0 +1,21 @@
+module Ebanx
+  module Command
+    class Zipcode < Command
+      def initialize(params)
+        @params         = params
+        @request_method = :post
+        @request_action = 'token'
+        @response_type  = :json
+      end
+
+      def validate
+        validate_presence :currency_code
+        validate_presence :amount
+        validate_presence :merchant_payment_code
+        validate_presence :name
+        validate_presence :email
+        validate_presence :payment_type_code
+      end
+    end
+  end
+end

data/lib/ebanx/command/zipcode.rb

@@ -0,0 +1,16 @@
+module Ebanx
+  module Command
+    class Zipcode < Command
+      def initialize(params)
+        @params         = params
+        @request_method = :get
+        @request_action = 'zipcode'
+        @response_type  = :json
+      end
+
+      def validate
+        validate_presence :zipcode
+      end
+    end
+  end
+end

data/lib/ebanx/response.rb

@@ -0,0 +1,13 @@
+module Ebanx
+  class Response
+    attr_accessor :http_code, :raw_response, :response
+
+    def initialize(response, response_type)
+      @http_code    = response.code
+      @raw_response = response.to_str
+      @response     = response.to_str
+
+      @response = JSON.parse @response if response_type == :json
+    end
+  end
+end

data/lib/ebanx/version.rb

@@ -1,3 +1,3 @@
 module Ebanx
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/test/ebanx/cancel_command_test.rb

@@ -0,0 +1,7 @@
+require_relative '../test_helper'
+
+describe Ebanx::Command::Cancel do
+  it "can't run without arguments" do
+    lambda { ebanx.do_cancel }.must_raise ArgumentError
+  end
+end

data/test/ebanx/direct_command_test.rb

@@ -0,0 +1,38 @@
+require_relative '../test_helper'
+
+describe Ebanx::Command::Direct do
+  before do
+    @params = {
+      operation: 'request',
+      mode: 'full',
+      payment: {
+        name: 'João da Silva',
+        email: 'joao@mailinator.com',
+        currency_code: 'BRL',
+        amount_total: 100.50,
+        merchant_payment_code: Random.rand(10000000000),
+        payment_type_code: 'boleto',
+        document: '13326724691',
+        birth_date: '01/01/1980',
+        zipcode: '70000-000',
+        address: 'Rua Brasil',
+        street_number: '1',
+        city: 'Brasília',
+        state: 'DF',
+        country: 'br',
+        phone_number: '6130001111',
+        due_date: (Time.now + 86400).strftime('%d/%m/%Y')
+      }
+    }
+  end
+
+  it "can't run without arguments" do
+    lambda { ebanx.do_direct }.must_raise ArgumentError
+  end
+
+  it "performs a successful request" do
+    response = ebanx.do_direct @params
+    response.http_code.must_equal 200
+    response.response['status'].must_equal 'SUCCESS'
+  end
+end

data/test/ebanx/request_command_test.rb

@@ -0,0 +1,24 @@
+require_relative '../test_helper'
+
+describe Ebanx::Command::Request do
+  before do
+    @params = {
+      name: 'João da Silva',
+      email: 'joao@mailinator.com',
+      currency_code: 'BRL',
+      amount: 100.00,
+      merchant_payment_code: Random.rand(10000000000),
+      payment_type_code: 'boleto',
+    }
+  end
+
+  it "can't run without arguments" do
+    lambda { ebanx.do_request }.must_raise ArgumentError
+  end
+
+  it "performs a successful request" do
+    response = ebanx.do_request @params
+    response.http_code.must_equal 200
+    response.response['status'].must_equal 'SUCCESS'
+  end
+end

data/test/ebanx/zipcode_command_test.rb

@@ -0,0 +1,20 @@
+require_relative '../test_helper'
+
+describe Ebanx::Command::Zipcode do
+  before do
+    @params = {
+      zipcode: '80230010'
+    }
+  end
+
+  it "can't run without arguments" do
+    lambda { ebanx.do_zipcode }.must_raise ArgumentError
+  end
+
+  # Evil integration test
+  it "performs a successful request" do
+    response = ebanx.do_zipcode @params
+    response.http_code.must_equal 200
+    response.response['status'].must_equal 'SUCCESS'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'ebanx'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+
+class MiniTest::Spec
+  def ebanx
+    Ebanx.tap do |e|
+      e.integration_key = ENV.fetch('INTEGRATION_KEY')
+      e.test_mode       = true
+    end
+  end
+end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ebanx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gustavo Henrique Mascarenhas Machado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: codeclimate-test-reporter
+  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: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: 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'
 description: EBANX is the market leader in e-commerce payment solutions for International
   Merchants selling online to Brazil
 email:
@@ -60,7 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
 - LICENSE.txt
@@ -72,13 +101,22 @@ files:
 - lib/ebanx/command/cancel.rb
 - lib/ebanx/command/capture.rb
 - lib/ebanx/command/command.rb
+- lib/ebanx/command/direct.rb
 - lib/ebanx/command/exchange.rb
-- lib/ebanx/command/print_html.rb
+- lib/ebanx/command/print.rb
 - lib/ebanx/command/query.rb
 - lib/ebanx/command/refund.rb
 - lib/ebanx/command/refund_or_cancel.rb
 - lib/ebanx/command/request.rb
+- lib/ebanx/command/token.rb
+- lib/ebanx/command/zipcode.rb
+- lib/ebanx/response.rb
 - lib/ebanx/version.rb
+- test/ebanx/cancel_command_test.rb
+- test/ebanx/direct_command_test.rb
+- test/ebanx/request_command_test.rb
+- test/ebanx/zipcode_command_test.rb
+- test/test_helper.rb
 homepage: https://www.ebanx.com
 licenses:
 - BSD
@@ -89,18 +127,23 @@ 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.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the EBANX API
-test_files: []
+test_files:
+- test/ebanx/cancel_command_test.rb
+- test/ebanx/direct_command_test.rb
+- test/ebanx/request_command_test.rb
+- test/ebanx/zipcode_command_test.rb
+- test/test_helper.rb