pagarme 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0e40625da7745cbbe9dde088d8b65940c1488a
-  data.tar.gz: 09f46eb1f7a1111cb54c26d3fb4d1e0b7bb8bdd9
+  metadata.gz: 422b2f052212e6a80ab083f50e469ff2c42f7965
+  data.tar.gz: 0991a571bbf8c149abb4c7612d9f6f10174e8189
 SHA512:
-  metadata.gz: 33084c34f78b9b799907d164c149fe7712af76daa7ff74423b97d0189bab0d6c34be295a8a72faa0b3e4d4a97013cb1ded00bff96f09e24536dfc38737fdc866
-  data.tar.gz: 938a986ef3c6c3e5f62180e6bf0d207b3dc25db52b65ef4071a2d4ba48a3368b999e46249fb24ff621365f8fc41845466fc9a106e448772c50c40f8ced83155e
+  metadata.gz: b28c35d0ade1879e5ecd4665c16b0ba33625091630a81a8f014acb3f2122612d795420a3a265a58f64f353f5396e12905bd048234484699c81d7c339097f9fc1
+  data.tar.gz: be91ee795aeb90394646f378dbd82c8183c0d52e48c22f4197ff38c73b461efe56b58dcf71016857a726e969ed3015bd6a0b8c1de6be61c4c37d636fe714b44b

data/.gitignore

@@ -19,3 +19,4 @@ Gemfile.lock
 .yardoc
 _yardoc
 doc/
+test/vcr_cassettes

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.0.0"
-  - "2.1.2"
+  - "2.1.8"
+  - "2.2.4"
+  - "2.3.0"

data/README.md

@@ -1,14 +1,295 @@
-## pagarme-ruby
+# pagarme-ruby
+[![Build Status](https://travis-ci.org/pagarme/pagarme-ruby.png)](https://travis-ci.org/pagarme/pagarme-ruby)
 
 Pagar.me Ruby library
 
 ## Documentation
 
-* [API Guide](http://pagar.me/docs)
+* [Documentation](https://pagar.me/docs)
+* [Full API Guide](https://docs.pagar.me/api)
 
-## Code Status
+## Getting Started
 
-[![Build Status](https://travis-ci.org/pagarme/pagarme-ruby.png)](https://travis-ci.org/pagarme/pagarme-ruby)
+### Install
+
+```shell
+gem install pagarme
+```
+or add the following line to Gemfile:
+
+```ruby
+gem 'pagarme'
+```
+and run `bundle install` from your shell.
+
+### Configure your API key
+
+You can set your API key in Ruby:
+
+```ruby
+PagarMe.api_key = 'YOUR_API_KEY_HERE'
+```
+
+or set the environment variable _PAGARME\_API\_KEY_ (**recommended**)
+
+### Using Pagar.me Checkout
+
+See our [demo checkout](https://pagar.me/checkout).
+
+More about how to use it [here](https://docs.pagar.me/checkout).
+
+### Transactions
+
+#### Creating a Credit Card Transaction
+
+To create a credit card transaction, you need a [card\_hash](https://docs.pagar.me/capturing-card-data).
+
+```ruby
+  PagarMe::Transaction.new(
+    amount:    1000,      # in cents
+    card_hash: card_hash  # how to get a card hash: docs.pagar.me/capturing-card-data
+  ).charge
+```
+
+More about [Creating a Credit Card Transaction](https://docs.pagar.me/transactions/#realizando-uma-transacao-de-cartao-de-credito).
+
+#### Creating a Boleto Transaction
+
+```ruby
+  transaction = PagarMe::Transaction.new(
+    amount:         1000,    # in cents
+    payment_method: 'boleto'
+  )
+  transaction.charge
+
+  transaction.boleto_url     # => boleto's URL
+  transaction.boleto_barcode # => boleto's barcode
+```
+
+More about [Creating a Boleto Transaction](https://docs.pagar.me/transactions/#realizando-uma-transacao-de-boleto-bancario).
+
+#### Split Rules
+
+With split rules, received amount could be splitted between more than one recipient.
+For example, splitting equally a transaction:
+
+```ruby
+  PagarMe::Transaction.new(
+    amount:    1000,      # in cents
+    card_hash: card_hash, # how to get a card hash: docs.pagar.me/capturing-card-data
+    split\_rules: [
+      { recipient_id: recipient_id_1, percentage: 50 },
+      { recipient_id: recipient_id_2, percentage: 50 }
+    ]
+  ).charge
+```
+
+More about [Split Rules](https://docs.pagar.me/api/#regras-do-split).
+
+### Plans & Subscriptions
+
+You can use recurring charges, learn more [here](https://docs.pagar.me/plans-subscriptions).
+
+It's important to understand the charges flow, learn more [here](https://docs.pagar.me/plans-subscriptions/#fluxo-de-cobranca)
+
+#### Creating a Plan
+
+```ruby
+  PagarMe::Plan.new(
+    amount: 4990,
+    days:   30,
+    name:   'Gold Plan'
+  ).create
+```
+
+More about [Creating a Plan](https://docs.pagar.me/plans-subscriptions/#criando-um-plano).
+
+#### Creating a Subscription
+
+```ruby
+  PagarMe::Subscription.new(
+    plan:      PagarMe::Plan.find_by_id('1234'),
+    card_hash: card_hash,
+    customer:  { email: 'customer_email@pagar.me' }
+  ).create
+```
+
+More about [Creating a Subscription](https://docs.pagar.me/plans-subscriptions/#criando-uma-assinatura).
+
+### Recipients
+
+#### Creating a Recipient
+
+To create a recipient, so it can receive payments through split rules or transfers:
+
+```ruby
+  PagarMe::Recipient.create(
+    bank_account: {
+      bank_code:       '237',
+      agencia:         '1935',
+      agencia_dv:      '9',
+      conta:           '23398',
+      conta_dv:        '9',
+      legal_name:      'Fulano da Silva',
+      document_number: '00000000000000' # CPF or CNPJ
+    },
+    transfer_enabled: false
+  )
+```
+
+More about [Creating a Recipient](https://docs.pagar.me/api/#recebedores).
+
+#### Transfer Available Amout to Bank Account Manually
+
+This is only needed if _transfer\_enabled_ is set to false. If set to true,
+_transfer\_interval_ and _transfer\_day_ will handle it automatically.
+
+```ruby
+  PagarMe::Recipient.find(recipient_id).receive amount
+```
+
+### Balance And Balance Operations
+
+#### Checking Balance
+
+```ruby
+  balance = PagarMe::Balance.balance
+  balance.waiting_funds.amount # money to be received in your account
+  balance.available.amount     # in your pagarme account
+  balance.transferred.amount   # transferred to your bank account
+```
+
+Just that!
+
+More about [Balance](https://docs.pagar.me/api/#saldo)
+
+#### Checking Balance Operations
+
+To access the history of balance operations:
+
+```ruby
+  PagarMe::BalanceOperation.balance_operations
+```
+
+Paginating:
+
+```ruby
+  PagarMe::BalanceOperation.balance_operations 2, 50 # second page, 50 per page
+```
+
+More about [Balance Operations](https://docs.pagar.me/api/#operacoes-de-saldo)
+
+#### Checking Recipient Balance
+
+```ruby
+  balance = PagarMe::Recipient.find(recipient_id).balance
+  balance.waiting_funds.amount # money to be received in his account
+  balance.available.amount     # in his pagarme account
+  balance.transferred.amount   # transferred to his bank account
+```
+
+Just that!
+
+More about [Recipient Balance](https://docs.pagar.me/api/#saldo-de-um-recebedor)
+
+#### Checking Recipient Balance Operations
+
+To access the history of balance operations:
+
+```ruby
+  PagarMe::Recipient.find(recipient_id).balance_operations
+```
+
+Paginating:
+
+```ruby
+  PagarMe::Recipient.find(recipient_id).balance_operations 2, 50 # second page, 50 per page
+```
+
+More about [Recipient Balance Operations](https://docs.pagar.me/api/#operacoes-de-saldo-de-um-recebedor)
+
+### Request Bulk Anticipation
+
+#### Checking limits
+
+```ruby
+  PagarMe::Recipient.default.bulk_anticipations_limits
+```
+
+More about [Checking Bulk Anticipation Limits](https://docs.pagar.me/api/#obtendo-os-limites-de-antecipacao)
+
+#### Requesting Bulk Anticipation
+
+```ruby
+  PagarMe::Recipient.default.bulk_anticipate(
+    timeframe:        :start,
+    payment_date:     Date.new(2016, 12, 25),
+    requested_amount: 10000 # in cents
+  )
+```
+
+More about [Requesting Bulk Anticipation](https://docs.pagar.me/api/#criando-uma-antecipacao)
+
+#### Getting Bulk Anticipation
+
+```ruby
+  PagarMe::BulkAnticipation.all page, count
+```
+
+More about [Getting Bulk Anticipation](https://docs.pagar.me/api/#retornando-todas-as-antecipacoes)
+
+### Payables
+
+### Getting Payable
+
+```ruby
+  PagarMe::Payable.find 'payable_id'
+```
+
+More about [Getting Payable](https://docs.pagar.me/api/#retornando-um-recebivel)
+
+#### Querying Payables
+
+```ruby
+  PagarMe::Payable.all page, count
+```
+
+```ruby
+  PagarMe::Payable.find_by status: 'paid'
+```
+
+More about [Querying Payables](https://docs.pagar.me/api/#retornando-recebiveis)
+
+#### Querying Payables by Transaction
+
+```ruby
+  transaction = PagarMe::Transaction.find 'transaction_id'
+  transaction.payables
+```
+
+More about [Payable Transactions](https://docs.pagar.me/api/#retornando-pagamentos-da-transacao)
+
+### Undocumented Features
+
+This gem is stable, but in constant development.
+
+This README is just a quick abstract of it's main features.
+
+You can easily browse it's source code to see all [supported resources](https://github.com/pagarme/pagarme-ruby/tree/master/lib/pagarme/resources).
+
+We will document everything while adding support to all resources listed in
+[Full API Guide](https://docs.pagar.me/api).
+
+Feel free to help us to add support to features sending pull requests.
+
+Thanks!
+
+### TODO
+
+Add support to [ElasticSearch Query DSL](https://docs.pagar.me/api/#buscas-avancadas),
+so you can search your data optimally.
+
+And document all the source code.
 
 ## License
 

data/Rakefile

@@ -1,24 +1,21 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-task :default => [:all]
+Rake::TestTask.new :test do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/pagarme/**/*_test.rb']
+end
 
-task :test, :test_file do |t, args| 
-	ret = true
-	test_file = args[:test_file]
+task :default => :test
 
-	if args[:test_file]
-		f = "test/pagarme/#{args[:test_file]}.rb"
-		ret = ret && ruby(f, '')
-	else
-		Dir["test/**/*.rb"].each do |f|
-			ret = ret && ruby(f, '')
-		end
-	end
+task :clean_vcr do
+  sh 'rm -rf test/vcr_cassettes'
 end
 
-task :all do
-	Rake::Task["test"].invoke
-	require 'active_support/all'
-	Rake::Task["test"].reenable
-	Rake::Task["test"].invoke
-end
+# task :all do
+#   Rake::Task['test'].invoke
+#   require 'active_support/all'
+#   Rake::Task['test'].reenable
+#   Rake::Task['test'].invoke
+# end

data/lib/pagarme.rb

@@ -1,46 +1,31 @@
+require 'set'
+require 'time'
 require 'digest/sha1'
+
+require_relative 'pagarme/version'
+require_relative 'pagarme/core_ext'
 require_relative 'pagarme/object'
-require_relative 'pagarme/util'
 require_relative 'pagarme/model'
+require_relative 'pagarme/nested_model'
 require_relative 'pagarme/transaction_common'
-require_relative 'pagarme/customer'
-require_relative 'pagarme/phone'
-require_relative 'pagarme/address'
-require_relative 'pagarme/subscription'
-require_relative 'pagarme/transaction'
-require_relative 'pagarme/transfer'
-require_relative 'pagarme/card'
-require_relative 'pagarme/plan'
-require_relative 'pagarme/bank_account'
 require_relative 'pagarme/request'
 require_relative 'pagarme/errors'
 
-module PagarMe
-  @@api_key = nil
-  @@api_endpoint = 'https://api.pagar.me/1'
-  @@live = true
-
-  def self.api_endpoint=(api_endpoint)
-    @@api_endpoint = api_endpoint
-  end
-
-  def self.api_endpoint
-    @@api_endpoint
-  end
-
-  def self.api_key=(api_key)
-    @@api_key = api_key
-  end
+Dir[File.expand_path('../pagarme/resources/*.rb', __FILE__)].map do |path|
+  require path
+end
 
-  def self.api_key
-    @@api_key
+module PagarMe
+  class << self
+    attr_accessor :api_endpoint, :open_timeout, :timeout, :api_key
   end
 
-  def self.full_api_url(relative_path)
-    "#{@@api_endpoint}#{relative_path}"
-  end
+  self.api_endpoint = 'https://api.pagar.me/1'
+  self.open_timeout = 30
+  self.timeout      = 90
+  self.api_key      = ENV['PAGARME_API_KEY']
 
   def self.validate_fingerprint(id, fingerprint)
-    Digest::SHA1.hexdigest(id.to_s + "#" + @@api_key) == fingerprint
+    PagarMe::Postback.validate id, fingerprint
   end
 end

data/lib/pagarme/core_ext.rb

@@ -0,0 +1,9 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+end

data/lib/pagarme/errors.rb

@@ -1,41 +1,55 @@
 module PagarMe
   class PagarMeError < StandardError
-    attr_accessor :message
-    attr_accessor :parameter_name
-    attr_accessor :type
-    attr_accessor :url
-    attr_accessor :errors
-
-    def initialize(message = "", parameter_name = "", type = "", url = "") 
-      self.message = message
-      self.type = type
-      self.parameter_name = parameter_name
-      self.errors = []
+  end
+
+  class ConnectionError < PagarMeError
+    attr_reader :error
+
+    def initialize(error)
+      @error = error
+      super error.message
     end
+  end
 
-    def self.fromServerResponse(response = {})
-      object = self.new
+  class RequestError < PagarMeError
+  end
 
-      response['errors'].map do |error|
-        object.message += error['message'] + ', '
-        object.errors << PagarMeError.new(error['message'],  error['parameter_name'], error['type'], response['url'])
-      end
+  class ResponseError < PagarMeError
+    attr_reader :request_params, :error
 
-      object
+    def initialize(request_params, error)
+      @request_params, @error = request_params, error
+      super @error.message
     end
+  end
 
-    def to_s
-      "#{self.class.to_s} - #{message}"
+  class NotFound < ResponseError
+    attr_reader :response
+    def initialize(response, request_params, error)
+      @response = response
+      super request_params, error
     end
   end
 
-  class RequestError < PagarMeError
-  end
+  class ValidationError < PagarMeError
+    attr_reader :response, :errors
 
-  class ConnectionError < PagarMeError
+    def initialize(response)
+      @response = response
+      @errors   = response['errors'].map do |error|
+        params = error.values_at('message', 'parameter_name', 'type', 'url')
+        ParamError.new *params
+      end
+      super @errors.map(&:message).join(', ')
+    end
   end
 
-  class ResponseError < PagarMeError
+  class ParamError < PagarMeError
+    attr_reader :parameter_name, :type, :url
+
+    def initialize(message, parameter_name, type, url)
+      @parameter_name, @type, @url = parameter_name, type, url
+      super message
+    end
   end
 end
-