moip2 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 015adab12411ead291fe058fd03c731acec47181
-  data.tar.gz: cee1090c633e11fb965d57be09ff0f6970c33cf7
+SHA256:
+  metadata.gz: 00d898f2cb2434c403e3c3bd39d3796bdb03f8c8f84d518f6b85007cda8abdfe
+  data.tar.gz: c6492ffd7175b9eb2f3ed6988193e209dbac777a022f1f60f670b417a0314abb
 SHA512:
-  metadata.gz: 63ec3ecf7c8493d551fd136bd34c461a8722d60d6b291cda2f7d2df05894f553de8e35a3dc3c8fe70532f581ef10252f35357cae4030b6e74537eae36302faa9
-  data.tar.gz: 73844787d62a4904870d36729665522ee0c9055b97fd3110be7568ee6f6cb13bc79e5d2ec31098fd3f7417448ab2acd2584be8e27403ea49069505fd67e89018
+  metadata.gz: 5f421da475b278633400cce50d16c982459440ae97f587a570101408fa805fd950b91d741a83aaea7871c4679866f905e2626d8d2b44d6359d45da1c80484018
+  data.tar.gz: 123a11f6907d8be0d5728d359bf724c76ca395ef0b8adab8bc372b48fafb5477dabfa2caba5298b3975488e33936c796eb5e30623a37336db08be7ad578b737f

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # Adapted from Thoughtbot's recommended config (https://github.com/thoughtbot/guides/blob/master/style/ruby/.rubocop.yml)
 
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Description: Check the naming of accessor methods for get_/set_.
   Enabled: false
 
@@ -19,7 +19,7 @@ Style/AsciiComments:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
   Enabled: false
 
-Style/AsciiIdentifiers:
+Naming/AsciiIdentifiers:
   Description: 'Use only ascii symbols in identifiers.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'
   Enabled: false
@@ -139,7 +139,7 @@ Style/EvenOdd:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Description: 'Use snake_case for source file names.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
   Enabled: false
@@ -264,7 +264,7 @@ Style/OneLineConditional:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
   Enabled: false
 
-Style/OpMethod:
+Naming/BinaryOperatorParameterName:
   Description: 'When defining binary operators, name the argument other.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
   Enabled: false
@@ -284,7 +284,7 @@ Style/PerlBackrefs:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
   Enabled: false
 
-Style/PredicateName:
+Naming/PredicateName:
   Description: 'Check the names of predicate methods.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
   NamePrefixBlacklist:
@@ -480,12 +480,6 @@ Lint/HandleExceptions:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
   Enabled: false
 
-Lint/InvalidCharacterLiteral:
-  Description: >-
-                 Checks for invalid character literals with a non-escaped
-                 whitespace character.
-  Enabled: false
-
 Lint/LiteralInCondition:
   Description: 'Checks of literals used in conditions.'
   Enabled: false
@@ -641,4 +635,4 @@ Rails/TimeZone:
 
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
-  Enabled: false
+  Enabled: false

data/Gemfile

@@ -1,4 +1,3 @@
 source "https://rubygems.org"
-
 # Specify your gem's dependencies in moip2.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moip2 (0.1.5)
+    moip2 (1.0.0)
       httparty
       recursive-open-struct
 
@@ -36,7 +36,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hitimes (1.2.2)
-    httparty (0.14.0)
+    httparty (0.15.5)
       multi_xml (>= 0.5.2)
     json (1.8.3)
     listen (2.10.0)
@@ -64,7 +64,7 @@ GEM
     rb-fsevent (0.9.5)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    recursive-open-struct (1.0.2)
+    recursive-open-struct (1.0.5)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -118,4 +118,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.15.1
+   1.16.0.pre.2

data/README.md

@@ -7,7 +7,7 @@
 [![Code Climate](https://codeclimate.com/github/moip/moip-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/moip/moip-sdk-ruby)
 [![Test Coverage](https://codeclimate.com/github/moip/moip-sdk-ruby/badges/coverage.svg)](https://codeclimate.com/github/moip/moip-sdk-ruby/coverage)
 
-**Índice** 
+**Índice**
 
 - [Instalação](#instalação)
 - [Configurando a autenticação](#configurando-a-autenticação)
@@ -28,6 +28,7 @@
         - [Sem Filtro](#sem-filtro)
         - [Com Filtros](#com-filtros)
         - [Com Paginação](#com-paginação)
+        - [Consulta Valor Específico](#consulta-valor-específico)
   - [Pagamentos](#pagamentos)
     - [Criação](#criação-2)
       - [Cartão de Crédito](#cartão-de-crédito)
@@ -48,19 +49,35 @@
   - [Multipagamentos](#multipagamentos)
     - [Criação](#criação-5)
     - [Consulta](#consulta-5)
+    - [Capturar multipagamento pré-autorizado](#capturar-multipagamento-pré-autorizado)
+    - [Cancelar multipagamento pré-autorizado](#cancelar-multipagamento-pré-autorizado)
   - [Conta Moip](#conta-moip)
     - [Criação](#criação-6)
     - [Consulta](#consulta-6)
     - [Verifica se usuário já possui Conta Moip](#verifica-se-usuário-já-possui-conta-moip)
+  - [Conta Bancária](#conta-bancária)
+    - [Criação](#criação-7)
+    - [Consulta](#consulta-7)
+    - [Listagem](#listagem)
+    - [Atualizar conta bancária](#atualizar-conta-bancaria)
+    - [Deletar conta bancária](#deletar-conta-bancaria)
   - [OAuth (Moip Connect)](#oauth-(moip-connect))
     - [Solicitar permissões de acesso ao usuário](#solicitar-permissões-de-acesso-ao-usuário)
     - [Gerar Token OAuth](#gerar-token-oauth)
     - [Atualizar Token OAuth](#atualizar-token-oauth)
+    - [Obter Chave Pública](#obter-chave-pública)
   - [Preferências de Notificação](#preferências-de-notificação)
-    -  [Criação](#criação-7)
-    -  [Consulta](#consulta-7)
+    -  [Criação](#criação-8)
+    -  [Consulta](#consulta-8)
     -  [Exclusão](#exclusão)
     -  [Listagem](#listagem)
+  - [Webhooks](#webhooks)
+    - [Todos Webhooks](#todos-webhooks)
+    - [Com Paginação](#com-paginação2)
+    - [Evento Específico](#evento-específico)
+    - [Recurso Específico](#recurso-específico)
+  - [Saldo Moip](#saldo-moip)
+    -  [Consulta](#consulta-10)
 - [Tratamento de Exceções](#tratamento-de-exceções)
 - [Documentação](#documentação)
 - [Licença](#licença)
@@ -96,6 +113,13 @@ Após isso, é necessário instanciar um ponto de acesso a partir do qual você
 api = Moip2::Api.new(client)
 ```
 
+Você pode customizar o client passando um hash de opções na inicialização. Essas opções serão passadas adiante para o client HTTParty, que aceita as opções descritas [na documentação](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods).
+
+Por exemplo, para alterar o timeout das requisições para 5 segundos:
+```ruby
+client = Moip2::Client.new(:sandbox/:production, auth, timeout: 5)
+```
+
 ## Clientes
 ### Criação
 ```ruby
@@ -125,7 +149,7 @@ customer = api.customer.show("CUS-V41BR451L")
 
 ### Adicionar cartão de crédito
 ```ruby
-credit_card = api.customer.add_credit_card("CUSTOMER-ID", 
+credit_card = api.customer.add_credit_card("CUSTOMER-ID",
     {
       method: "CREDIT_CARD",
       creditCard: {
@@ -153,18 +177,12 @@ credit_card = api.customer.add_credit_card("CUSTOMER-ID",
 
 ### Deletar cartão de crédito
 
-> Retorna uma Exception do tipo `NotFoundError` caso não encontre o cartão de crédito para deletar
+> Retorna uma Exception do tipo `NotFoundError` caso não encontre o cartão de crédito para deletar.
 
 ```ruby
 api.customer.delete_credit_card!("CREDIT-CARD-ID")
 ```
 
-> Retorna `false` caso não encontre o cartão de crédito para deletar
-
-```ruby
-api.customer.delete_credit_card("CREDIT-CARD-ID")
-```
-
 ## Pedidos
 ### Criação
 
@@ -208,10 +226,15 @@ orders = api.order.find_all(filters: { status: { in: ["PAID", "WAITING"] }, amou
 orders = api.order.find_all(limit: 10, offset: 50)
 ```
 
+##### Consulta Valor Específico
+```ruby
+orders = api.order.find_all(q: "your_value")
+```
+
 ## Pagamentos
 
 ### Criação
-#### Cartão de Crédito 
+#### Cartão de Crédito
 ##### Com Hash
 
 ```ruby
@@ -236,7 +259,7 @@ api.payment.create(order.id,
 )
 ```
 
-##### Com Dados do Cartão 
+##### Com Dados do Cartão
 > Esses método requer certificação PCI. [Consulte a documentação.](https://documentao-moip.readme.io/v2.0/reference#criar-pagamento)
 
 ```ruby
@@ -344,7 +367,7 @@ multi_pag = api.multi_payment.create("MOR-V41BR451L",
   {
     installmentCount: 1,
     fundingInstrument: {
-      # ... 
+      # ...
     }
   }
 )
@@ -354,6 +377,15 @@ multi_pag = api.multi_payment.create("MOR-V41BR451L",
 multi_pag = api.multi_payment.show("MPY-V41BR451L")
 ```
 
+### Capturar multipagamento pré-autorizado
+```ruby
+multi = api.multi_payment.capture("MPY-V41BR451L")
+```
+### Cancelar multipagamento pré-autorizado
+```ruby
+multi = api.multi_payment.void("MPY-V41BR451L")
+```
+
 ## Conta Moip
 ### Criação
 ```ruby
@@ -406,6 +438,59 @@ account = api.accounts.show("MPA-12312312312")
 api.accounts.exists?("123.456.789.10")
 ```
 
+## Conta bancária
+### Criação
+```ruby
+bank_account = api.bank_accounts.create("MPA-14C9EE706C55",
+      bank_number: "237",
+      agency_number: "12345",
+      agency_check_number: "0",
+      account_number: "12345678",
+      account_check_number: "7",
+      type: "CHECKING",
+      holder: {
+        tax_document: {
+          type: "CPF",
+          number: "164.664.426-32",
+        },
+        fullname: "Sales Machine da Silva",
+      })
+```
+
+### Consulta
+```ruby
+api.bank_accounts.show("BKA-DWTSK16UQI9N")
+```
+
+### Listagem
+```ruby
+api.bank_accounts.find_all("MPA-14C9EE706C55")
+```
+
+### Atualizar conta bancaria
+```ruby
+api.bank_accounts.update("BKA-DWTSK16UQI9N",
+      bank_number: "237",
+      agency_number: "12345",
+      agency_check_number: "0",
+      account_number: "87654323",
+      account_check_number: "7",
+      type: "CHECKING",
+      holder: {
+        tax_document: {
+          type: "CPF",
+          number: "164.664.426-32",
+        },
+        fullname: "Sales Machine da Silva",
+      })
+```
+
+### Deletar conta bancaria
+> Retorna uma Exception do tipo `NotFoundError` caso não encontre a conta bancária para deletar
+```ruby
+  api.bank_accounts.delete("BKA-DWTSK16UQI9N")
+```
+
 ## OAuth (Moip Connect)
 ### Solicitar permissões de acesso ao usuário
 ```ruby
@@ -431,6 +516,11 @@ api.connect.authorize(
 )
 ```
 
+### Obter Chave Pública
+```ruby
+keys = api.keys.show
+```
+
 ## Preferências de notificação
 
 ### Criação
@@ -459,6 +549,44 @@ api.notifications.delete("NOTIFICATION-ID")
 api.notifications.find_all
 ```
 
+## Webhooks
+### Consulta
+
+##### Todos Webhooks
+```ruby
+webhooks = api.webhooks.find_all
+```
+
+##### Com Paginação
+```ruby
+webhooks = api.webhooks.find_all(limit: 10, offset: 50)
+```
+
+##### Consulta Evento
+```ruby
+webhooks = api.webhooks.find_all(event: "PAYMENT.WAITING")
+```
+
+##### Consulta Valor Específico
+```ruby
+webhooks = api.webhooks.find_all(resource_id: "PAY-REJJ9F12MF7R")
+```
+
+
+## Saldo Moip
+### Consulta
+```ruby
+api.balances.show()
+```
+
+### Show all entries
+```ruby
+  api.entries.find_all
+```
+### Show one entry
+```ruby
+  api.entries.show(entry_id)
+```
 ## Tratamento de Exceções
 
 Caso algum recurso não seja encontrado uma exceção do tipo `NotFoundError` será lançada.

data/changelog.md

@@ -1,3 +1,58 @@
+<a name="v1.1.0"></a>
+## v1.1.0 (2017-11-14)
+
+
+#### Features
+
+*   Create method to generate OAuth token ((cc5dcad7))
+* **Accounts**
+  *  added `create` method and Account resource ((a8ec5469))
+  *  added `create` method and Account resource ((399b49b9))
+* **Balances**  added initial support ( `show`) ((8b46be43))
+* **Connect**  Create method to generate authorize url ((8fcbd67d))
+* **Customer**
+  *  Overload method to delete credit card ((1b920029))
+  *  Create method to delete a credit card from customer ((71e1b6a9))
+  *  Create method to add credit card to customer ((edc5c67e))
+* **MultiPayment**
+  *  added `void` ((c7eb0a99))
+  *  added `.capture` ((a8b4fcbc))
+* **Notifications**
+  *  Add method to delete a notification preference ((79354cb0))
+  *  Add parameter to create notification to apps ((98735f0a))
+  *  Add method to find all notification preferences ((c97383f0))
+  *  Add method to get a notification ((7e853d6c))
+  *  Add method to create notification preference ((80c09bbb))
+* **Order**  added `q` param support for ownID searches ((24ba5138))
+* **Payment**  Add show, void and capture methods to Payment ((4f266390))
+* **accounts**
+  *  added #show ((1da02bee))
+  *  added #exists? ((e97fbd2d))
+  *  added #show ((cebf937a))
+  *  added #exists? ((d75ad84c))
+* **api**
+  *  add balances and entries APIs endpoints ((30d4b932))
+  *  Added .accounts ((4ed3d625))
+  *  Added .accounts ((74df6adb))
+* **bank-accounts**
+  *  add show, delete, update and find_all actions ((401c3ef6))
+  *  add create action ((0afde060))
+* **entries**  add action show and index ((3a95df1e))
+* **order**
+  *  added `filters` support to `find_all` ((55d3cb8b))
+  *  added `find_all` ((7e66c07d))
+* **response**
+  *  added ability to handle non-json response payloads ((526e53d6))
+  *  added ability to handle non-json response payloads ((593966ad))
+* **webhooks**
+  *  add webhooks endpoint ((f9247ceb))
+
+#### Bug Fixes
+
+* **Balances**  added needed `Accept` header ((bb928548))
+
+
+
 <a name="1.0.0"></a>
 ## 1.0.0 (2017-09-26)
 
@@ -31,6 +86,3 @@
   *  added `find_all` ((7e66c07d))
 * **Response**
   *  added ability to handle non-json response payloads ((526e53d6))
-
-
-

data/examples/ecommerce/payment-with-boleto.rb

@@ -0,0 +1,129 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::Basic.new("TOKEN", "SECRET")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# If you want to persist your customer data and save later, now is
+# the time to create it.
+# TIP: Don't forget to generate your `own_id` or use one you already have
+
+customer = api.customer.create(
+  ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+  fullname: "Integração Moip",
+  email: "integracaomoip@moip.com.br",
+  taxDocument: {
+    type: "CPF",
+    number: "22222222222",
+  },
+  phone: {
+    countryCode: "55",
+    areaCode: "11",
+    number: "66778899",
+  },
+  shippingAddress: {
+    city: "Sao Paulo",
+    complement: "8",
+    district: "Itaim",
+    street: "Avenida Faria Lima",
+    streetNumber: "2927",
+    zipCode: "01234000",
+    state: "SP",
+    country: "BRA",
+  },
+)
+
+# Here we build the order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example
+
+order = api.order.create(
+  own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+  items: [
+    {
+      product: "Nome do produto",
+      quantity: 1,
+      detail: "Mais info...",
+      price: 1000,
+    },
+  ],
+  customer: {
+    ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+    fullname: "Integração Moip",
+    email: "integracaomoip@moip.com.br",
+    taxDocument: {
+      type: "CPF",
+      number: "22222222222",
+    },
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "66778899",
+    },
+    shippingAddress: {
+      city: "Sao Paulo",
+      complement: "8",
+      district: "Itaim",
+      street: "Avenida Faria Lima",
+      streetNumber: "2927",
+      zipCode: "01234000",
+      state: "SP",
+      country: "BRA",
+    },
+  },
+)
+
+# Now with the order ID in hands, you can start creating payments.
+# Here is an example of creating a boleto payment:
+payment = api.payment.create(
+  order.id, funding_instrument: {
+    method: "BOLETO",
+    boleto: {
+      expirationDate: "2020-01-01",
+      instructionLines: {
+        first: "First line of instructions",
+        second: "Second line of instructions",
+        third: "Third line of instructions",
+      },
+    },
+  }
+)
+
+# This is how you get the boleto from the payment response and be able to show
+# it in your checkout
+boleto = payment[:_links][:pay_boleto][:print_href]
+
+# Example of getting boleto line code
+boleto_line_code = payment[:funding_instrument][:boleto][:line_code]
+
+# This is how you can create a boleto refund to a bank account:
+order_refund = api.refund.create(
+  order.id, refundingInstrument: {
+    method: "BANK_ACCOUNT",
+    bankAccount: {
+      bankNumber: "237",
+      agencyNumber: "12345",
+      agencyCheckNumber: "0",
+      accountNumber: "12345678",
+      accountCheckNumber: "7",
+      type: "CHECKING",
+      holder: {
+        taxDocument: {
+          type: "CPF",
+          number: "22222222222",
+        },
+        fullname: "Demo Moip",
+      },
+    },
+  }
+)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)

data/examples/ecommerce/payment-with-credit-card.rb

@@ -0,0 +1,119 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::Basic.new("TOKEN", "SECRET")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# If you want to persist your customer data and save later, now is
+# the time to create it.
+# TIP: Don't forget to generate your `own_id` or use one you already have
+
+customer = api.customer.create(
+  ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+  fullname: "Integração Moip",
+  email: "integracaomoip@moip.com.br",
+  taxDocument: {
+    type: "CPF",
+    number: "22222222222",
+  },
+  phone: {
+    countryCode: "55",
+    areaCode: "11",
+    number: "66778899",
+  },
+  shippingAddress: {
+    city: "Sao Paulo",
+    complement: "8",
+    district: "Itaim",
+    street: "Avenida Faria Lima",
+    streetNumber: "2927",
+    zipCode: "01234000",
+    state: "SP",
+    country: "BRA",
+  },
+)
+
+# Creating a credit card for a customer
+customer_credit_card = api.customer.add_credit_card(
+  customer.id,
+  method: "CREDIT_CARD",
+  creditCard: {
+    expirationMonth: "05",
+    expirationYear: "22",
+    number: "5555666677778884",
+    cvc: "123",
+    holder: {
+      fullname: "Jose Portador da Silva",
+      birthdate: "1988-12-30",
+      taxDocument: {
+        type: "CPF",
+        number: "33333333333",
+      },
+      phone: {
+        countryCode: "55",
+        areaCode: "11",
+        number: "66778899",
+      },
+    },
+  },
+)
+
+# TIP: Now you can access the Moip ID to save it to your database, if you want
+# Ex.:
+# Customer.find_by(id: 123).update!(moip_id: customer.id)
+
+# Here we build the order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example
+
+order = api.order.create(
+  own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+  items: [
+    {
+      product: "Nome do produto",
+      quantity: 1,
+      detail: "Mais info...",
+      price: 1000,
+    },
+  ],
+  customer: {
+    id: customer.id,
+  },
+)
+
+payment = api.payment.create(
+  order.id,
+  installment_count: 1,
+  funding_instrument: {
+    method: "CREDIT_CARD",
+    credit_card: {
+      id: customer_credit_card.credit_card.id,
+      holder: {
+        fullname: "Integração Moip",
+        birthdate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "33333333333",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "000000000",
+        },
+      },
+    },
+  },
+)
+
+# You can create a full payment refunds:
+full_payment_refund = api.refund.create(payment.id)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)