vindi 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa9ad99820c63edef8c56003e328dd221ce994cd
-  data.tar.gz: 834423a9ffabfad33678cf29fae92cb371e4ede2
+SHA256:
+  metadata.gz: 9f01bf9d6e3a22835cd557854ba2a872d8d93f00bac91eb39173c0d1a053eded
+  data.tar.gz: 55fca250dcb434eda27d0c622ebda23af2e297c78f670b1663e0771704a8aa5e
 SHA512:
-  metadata.gz: b6d6f22cba50f50a2ca96eb6d99e78555c8699af0feafac40ab6eba87ca4bc2da665ee2bcd0d842df6a1ad6cd37dd0ed4c53cc7c3ba63c876f95db2412f05d8f
-  data.tar.gz: b59bbdcaa255677a7d964a0bc57f0b24c42606031b2ca7051587d29d7720a0ec8c6b0c553bda78f62cdfcf120f6958559b30b5d608b2a53b9ade55cd0022fa01
+  metadata.gz: 1ba007ab34bb9d2e5df9806395eace7ffff91b7f2982ab48e878862f8eea39232d579d66af1ea660fe8e210c81fa914f7b12e1419cf866a4cd2d0037f9dbea26
+  data.tar.gz: 5e550b5914ce0ec3b191f058c56d7a88274d16a49f707a6b6a5c7a2467507e2f3ebf7d487de9a713f5f929cfe004d7d14fb98917c194cac7f7177cbbcf301504

data/README.md

@@ -1,8 +1,16 @@
 # Vindi Ruby
 
+[![Build Status](https://semaphoreci.com/api/v1/projects/48986e75-f1a3-4ca3-ae41-2d6cf64ac507/1512354/badge.svg)](https://semaphoreci.com/vindi/vindi-ruby)
+
+## Descrição
+
 Ruby toolkit para a [API de Recorrência][link-introducao-api] da [Vindi][link-vindi].
 
-[![Build Status](https://semaphoreci.com/api/v1/projects/48986e75-f1a3-4ca3-ae41-2d6cf64ac507/1512354/badge.svg)](https://semaphoreci.com/vindi/vindi-ruby)
+## Requisitos
+
+* Ruby >=2.3;
+* Certificado digital HTTPS assinado por uma entidade certificadora;
+* Conta ativa na [Vindi](https://www.vindi.com.br).
 
 ## Instalação
 
@@ -10,11 +18,11 @@ Ruby toolkit para a [API de Recorrência][link-introducao-api] da [Vindi][link-v
 gem 'vindi'
 ```
 
-And then execute:
+Então execute:
 
     $ bundle
 
-Or install it yourself as:
+Ou instale você mesmo:
 
     $ gem install vindi
 
@@ -22,11 +30,24 @@ Or install it yourself as:
 Os métodos da API estão disponíveis atraves dos métodos da instancia de um cliente
 
 ```ruby
-  client = Vindi::Client.new(key: 'VINDI_KEY')
-``` 
+  client = Vindi::Client.new(key: '<sua_vindi_api_key>')
+```
+
+Para testar no ambiente Sandbox, use o endpoint da API para efetuar requisições:
+
+```ruby
+  client = Vindi::Client.new(key: '<sua_vindi_api_key>', api_endpoint: 'https://sandbox-app.vindi.com.br/api/v1')
+```
+
+Caso prefira utilizar variáveis de ambiente para prover credenciais de acesso:
+
+```
+export VINDI_KEY="<sua_vindi_api_key>"
+export VINDI_API_ENDPOINT="https://sandbox-app.vindi.com.br/api/v1"
+```
 
 ### Consumindo recursos
-Os recursos são fornecidos através do objeto de retono e os campos retornados podem ser acessados pela notação de attributos de um Hash 
+Os recursos são fornecidos através do objeto de retorno e os campos retornados podem ser acessados pela notação de attributos de um Hash
 
 ```ruby
   # Listando planos de um lojista
@@ -43,7 +64,7 @@ Os recursos são fornecidos através do objeto de retono e os campos retornados
 
   # Criando um plano
   client.create_plan({name: 'My new plan', interval: 'months', interval_count: 1,  billing_trigger_type: 'beginning_of_period'})
-``` 
+```
 
 ### Acessando respostas HTTP
 
@@ -51,7 +72,7 @@ Os recursos são fornecidos através do objeto de retono e os campos retornados
   client.list_plans
   response  = client.last_response
   status = response.status
-``` 
+```
 
 ## Dúvidas
 Caso necessite de informações sobre a plataforma ou API, por favor acesse o [Atendimento Vindi](http://atendimento.vindi.com.br/hc/pt-br).

data/lib/vindi/error.rb

@@ -1,6 +1,7 @@
 module Vindi
   # Custom error class for rescuing from all Vindi errors
   class Error < StandardError
+    attr_accessor :status_code
 
     # Raised when Vindi returns a 4xx HTTP status code
     ClientError = Class.new(self)
@@ -29,6 +30,9 @@ module Vindi
     # Raised when Vindi returns a 5xx HTTP status code
     ServerError = Class.new(self)
 
+    # Raised when Vindi returns the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
     # Raised when Vindi returns the HTTP status code 502
     BadGateway = Class.new(ServerError)
 
@@ -68,10 +72,11 @@ module Vindi
     end
 
     def build_error_message(response)
-      return if response.nil?
+      return unless response&.body
+
+      self.status_code = response.status
 
-      message  = "#{response[:method].to_s.upcase} "
-      message
+      response.body
     end
   end
 end

data/lib/vindi/rest.rb

@@ -22,6 +22,7 @@ module Vindi
     include Vindi::Rest::Invoice
     include Vindi::Rest::Message
     include Vindi::Rest::ImportBatch
+    include Vindi::Rest::ExportBatch
     include Vindi::Rest::Notification
     include Vindi::Rest::Issue
     include Vindi::Rest::Merchant

data/lib/vindi/rest/charge.rb

@@ -11,7 +11,8 @@ module Vindi
       def list_charges(options = {})
         get('charges', options)[:charges]
       end
-      
+
+
       # Get a single charge from a merchant
       #
       # @param charge_id [Integer] ID of the charge
@@ -89,6 +90,19 @@ module Vindi
       def delete_charge(charge_id, options = {})
         delete("charges/#{charge_id}", options)[:charge]
       end
+
+
+      # Capture a charge from merchant vindi
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/POST_version_charges_id_capture_format
+      # @example Capture charge #2
+      #   client.capture_charge(2)
+      def capture_charge(charge_id, options = {})
+        post("charges/#{charge_id}/capture", options)[:charge]
+      end
     end
   end
 end

data/lib/vindi/rest/customer.rb

@@ -11,7 +11,7 @@ module Vindi
       def list_customers(options = {})
         get('customers', options)[:customers]
       end
-      
+
       # Get a single customer from a merchant
       #
       # @param customer_id [Integer] ID of the customer
@@ -24,9 +24,9 @@ module Vindi
       end
 
       # Create a customer for a merchant vindi
-      # 
+      #
       # @option options [Hash] :options customer attributes
-      # @see https://vindi.github.io/api-docs/dist/#!/customers/POST_version_customers_format 
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/POST_version_customers_format
       # @return [Hash] The customer created
       # @example Create a customer for a merchant vindi
       #   client.create_customer(name: 'John Doe', email: 'john.doe@mail.com')
@@ -56,6 +56,19 @@ module Vindi
       def delete_customer(customer_id, options = {})
         delete("customers/#{customer_id}", options)[:customer]
       end
+
+
+      # Unarchive a customer from merchant vindi
+      #
+      # @params customer_id [Integer] ID of the customer
+      # @option options [Hash] :options customer attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/POST_version_customers_id_unarchive_format
+      # @example Unarchive customer #2
+      #   client.unarchive_customer(2)
+      def unarchive_customer(customer_id, options = {})
+        post("customers/#{customer_id}/unarchive", options)[:customer]
+      end
     end
   end
 end

data/lib/vindi/rest/export_batch.rb

@@ -0,0 +1,52 @@
+module Vindi
+  module Rest
+
+    # Methods for the export_batches API
+    # @see https://vindi.github.io/api-docs/dist/#!/export_batches
+    module ExportBatch
+
+      # List export batches for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of export batches for a merchant.
+      # @example Get all export batches from merchant vindi
+      def list_export_batches(options = {})
+        get('export_batches', options)[:export_batches]
+      end
+
+      # Get a single export batch from a merchant
+      #
+      # @param export_batch_id [Integer] ID of the export batch
+      # @return [Hash] The export batch you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/GET_version_export_batches_id_format
+      # @example Get export batch #154 from vindi
+      #   client.export_batch(154)
+      def export_batch(export_batch_id, options = {})
+        get("export_batches/#{export_batch_id}", options)[:export_batch]
+      end
+
+      # Create an export batch for a merchant vindi
+      #
+      # @option options [Hash] :options export_batch attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/POST_version_export_batches_format
+      # @return [Hash] The export batch created
+      # @example Create an export batch for a merchant vindi
+      #   client.create_export_batch({ "payment_method_code": 2, "payment_company_code": "itau" })
+      def create_export_batch(options = {})
+        post('export_batches', options)[:export_batch]
+      end
+
+
+      # Approve an export batch for a merchant vindi
+      #
+      # @option options [Hash] :options export_batch attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/POST_version_export_batches_id_approve_format
+      # @return [Hash] The export batch approved
+      # @example Approve an export batch for a merchant vindi
+      #   client.approve_export_batch(2)
+      def approve_export_batch(export_batch_id, options = {})
+        post("export_batches/#{export_batch_id}/approve", options)[:export_batch]
+      end
+    end
+  end
+end

data/lib/vindi/rest/import_batch.rb

@@ -5,7 +5,7 @@ module Vindi
     # @see https://vindi.github.io/api-docs/dist/#!/import_batches
     module ImportBatch
 
-      # List import_batchs for the authenticate user
+      # List import_batches for the authenticate user
       # @option options [Integer] :page (1) Page number.
       # @option options [Integer] :merchant Merchant account
       # @return [Array<Hash>] A list of imported batches for a merchant.

data/lib/vindi/rest/period.rb

@@ -47,6 +47,18 @@ module Vindi
       def update_period(period_id, options = {})
         put("periods/#{period_id}", options)[:period]
       end
+
+      # List period usages
+      #
+      # @params period_id [Integer] ID of the period
+      # @option options [Integer] :page (1) Page number.
+      # @return [Array<Hash>] A list of usages for a period.
+      # @see https://vindi.github.io/api-docs/dist/#/periods/getV1PeriodsIdUsages
+      # @example List period usages
+      #   client.list_period_usages(2)
+      def list_period_usages(period_id, options = {})
+        get("periods/#{period_id}/usages", options)[:usages]
+      end
     end
   end
 end

data/lib/vindi/rest/subscription.rb

@@ -80,6 +80,16 @@ module Vindi
       def delete_subscription(subscription_id, options = {})
         delete("subscriptions/#{subscription_id}", options)[:subscription]
       end
+
+      # List product items for a subscription
+      #
+      # @params subscription_id
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/GET_version_subscriptions_id_product_items_format
+      # @example List subscription product items #2
+      #   client.list_subscription_product_items(2)
+      def list_subscription_product_items(subscription_id, options = {})
+        get("subscriptions/#{subscription_id}/product_items", options)[:product_items]
+      end
     end
   end
 end

data/lib/vindi/version.rb

@@ -1,3 +1,3 @@
 module Vindi
-  VERSION = '0.0.2'
+  VERSION = '0.0.7'
 end

data/vindi.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |spec|
   spec.files        +=  Dir.glob("lib/**/*.rb")
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 0.13.1'
-  spec.add_development_dependency "bundler", "~> 1.15"
+
+  spec.add_dependency 'faraday', '~> 0.13'
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vindi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Vindi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ files:
 - lib/vindi/rest/charge.rb
 - lib/vindi/rest/customer.rb
 - lib/vindi/rest/discount.rb
+- lib/vindi/rest/export_batch.rb
 - lib/vindi/rest/import_batch.rb
 - lib/vindi/rest/invoice.rb
 - lib/vindi/rest/issue.rb
@@ -113,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the Vindi API