vindi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b6a28994b0f5108cc5c11887854de4db578eddb
+  data.tar.gz: 9c77d88efb1d79de6abc352bc25a2a633a920a5d
+SHA512:
+  metadata.gz: 7b470b6602760c7787bcd5b53b77651cff3e0043f368a8a2d02cefa54d88fb967f67beeeb71f59fafca5c94553383b744fad104c78b6e67b9edf51b3d554baf4
+  data.tar.gz: c22faffb32cfe3dd9be3cf98916c6eb8c1495e64fad00faa46d41bcb2d19035f6a21dfc2d097ad2d3432ca7428d3df637d44eda12614673f64c80e2f27065963

data/README.md

@@ -0,0 +1,75 @@
+# Vindi Ruby
+
+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)
+
+## Instalação
+
+```ruby
+gem 'vindi-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vindi-ruby
+
+## Uso
+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')
+``` 
+
+### 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 
+
+```ruby
+  # Listando planos de um lojista
+  client.list_plans
+  # => [{:id=>15, :name=>"My awesome plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...
+
+  # Consultando um plano
+  client.plan(15)
+  # => {:id=>15, :name=>"My awesome plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...
+
+  # Atualizando um plano
+  client.update_plan(15, {name: 'My plan'})
+  # => {:id=>15, :name=>"My plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...
+
+  # Criando um plano
+  client.create_plan({name: 'My new plan', interval: 'months', interval_count: 1,  billing_trigger_type: 'beginning_of_period'})
+``` 
+
+### Acessando respostas HTTP
+
+```ruby
+  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).
+
+## Segurança
+Se você descobrir qualquer questão relacionada a segurança, por favor, envie um e-mail para seguranca@vindi.com.br ao invés de utilizar os issues.
+
+## Changelog
+Todas as informações sobre cada release podem ser consultadas em [CHANGELOG.md](CHANGELOG.md).
+
+## Créditos
+- [Vindi][link-author]
+- [Todos os Contribuidores][link-contributors]
+
+## Licença
+GNU GPLv3. Por favor, veja o [Arquivo de Licença](license.txt) para mais informações.
+
+[link-vindi]: https://www.vindi.com.br
+[link-introducao-api]: http://atendimento.vindi.com.br/hc/pt-br/articles/203020644-Introdu%C3%A7%C3%A3o-%C3%A0-API-de-Recorr%C3%AAncia
+[link-author]: https://github.com/vindi
+[link-contributors]: https://github.com/vindi/vindi-ruby/graphs/contributors

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['README.md', 'lib/**/*.rb']
+      task.options = [
+        '--output-dir', 'doc/yard',
+        '--markup', 'markdown',
+      ]
+    end
+  rescue LoadError
+  end
+end

data/lib/vindi.rb

@@ -0,0 +1,4 @@
+require 'vindi/client'
+
+module Vindi
+end

data/lib/vindi/client.rb

@@ -0,0 +1,15 @@
+require 'vindi/configuration'
+require 'vindi/request'
+require 'vindi/rest'
+
+module Vindi
+  class Client
+    include Vindi::Configuration
+    include Vindi::Request
+    include Vindi::Rest
+
+    def initialize(options = {}, &block)
+      setup && configure(options, &block)
+    end
+  end
+end

data/lib/vindi/configuration.rb

@@ -0,0 +1,36 @@
+require 'vindi/default'
+
+module Vindi
+
+  # Configuration options for Client
+  module Configuration
+    attr_reader :user_agent, :middleware, :connection_options
+    attr_accessor :key, :default_media_type, :api_endpoint
+
+    class << self
+      def keys
+        @keys ||= [:key, :default_media_type, :api_endpoint, :user_agent,
+                   :middleware, :connection_options]
+      end
+    end
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [Vindi::Client]
+    def configure(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      yield(self) if block_given?
+    end
+
+    def reset!
+      Vindi::Configuration.keys.each do |key|
+        instance_variable_set("@#{key}", Vindi::Default.options[key])
+      end
+    end
+    alias :setup :reset!
+  end
+end

data/lib/vindi/connection.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'json'
+
+module Vindi
+  module Connection
+
+    # HTTP client for the Vindi API
+    #
+    # @return Faraday::Connection
+    def http_client
+      @http_client = Faraday.new(api_endpoint, connection_options) do |http|
+        http.request(:multipart)
+        http.request(:url_encoded)
+        http.basic_auth(@key, '')
+        http.builder.use @middleware
+        http.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def last_response
+      @last_response if defined?(@last_response)
+    end
+
+    private
+
+    def request(method, path, data, options = {})
+      @last_response = response = http_client
+        .public_send(method, URI::Parser.new.escape(path.to_s), data, options)
+
+      response.body.empty? ? '' : symbolize_keys!(JSON.parse(response.body))
+    end
+
+    def symbolize_keys!(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys!(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys!(object.delete(key))
+        end
+      end
+      object
+    end
+  end
+end

data/lib/vindi/default.rb

@@ -0,0 +1,63 @@
+require 'vindi/response/raise_error'
+require 'vindi/version'
+
+module Vindi
+  module Default
+    # Default API endpoint
+    API_ENDPOINT = 'https://app.vindi.com.br/api/v1/'.freeze
+
+    # Default media type
+    MEDIA_TYPE   = 'application/vnd.api+json'.freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Vindi-Ruby/#{Vindi::VERSION}".freeze
+
+    MIDDLEWARE   = Vindi::Response::RaiseError
+
+    class << self
+
+      # Default api endpoint string from ENV or API_ENDPOINT
+      # @return [String]
+      def api_endpoint
+        ENV['VINDI_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default media type header string from ENV or MEDIA_TYPE
+      # @return [String]
+      def default_media_type
+        ENV['VINDI_MEDIA_TYPE'] || MEDIA_TYPE
+      end
+
+      # Default user KEY string from ENV
+      # @return [String]
+      def key
+        ENV['VINDI_KEY']
+      end
+
+      # Default User-Agent header string from ENV or USER_AGENT
+      # @return [String]
+      def user_agent
+        ENV['VINDI_USER_AGENT'] || USER_AGENT
+      end
+
+      def middleware
+        MIDDLEWARE
+      end
+
+      def connection_options
+        {
+          headers: {
+            'User-Agent': user_agent
+          }
+        }
+      end
+
+      # Default Settings for Vindi Ruby Gem
+      # @return [Hash]
+      def options
+        Hash[Vindi::Configuration.keys
+          .map{ |key| [key, send(key)] }]
+      end
+    end
+  end
+end

data/lib/vindi/error.rb

@@ -0,0 +1,77 @@
+module Vindi
+  # Custom error class for rescuing from all Vindi errors
+  class Error < StandardError
+
+    # Raised when Vindi returns a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised when Vindi returns the HTTP status code 400
+    BadRequest = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 401
+    Unauthorized = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 406
+    NotAcceptable = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 422
+    UnprocessableEntity = Class.new(ClientError)
+
+    # Raised when Vindi returns the HTTP status code 429
+    TooManyRequests = Class.new(ClientError)
+
+    # Raised when Vindi returns a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised when Vindi returns the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised when Vindi returns the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # Raised when Vindi returns the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
+    class << self
+      def from_response(response)
+        status = response.status.to_i
+
+        if klass = case status
+                   when 400      then Vindi::Error::BadRequest
+                   when 401      then Vindi::Error::Unauthorized
+                   when 403      then Vindi::Error::Forbidden
+                   when 404      then Vindi::Error::NotFound
+                   when 406      then Vindi::Error::NotAcceptable
+                   when 415      then Vindi::Error::UnsupportedMediaType
+                   when 422      then Vindi::Error::UnprocessableEntity
+                   when 429      then Vindi::Error::TooManyRequests
+                   when 400..499 then Vindi::Error::ClientError
+                   when 500      then Vindi::Error::InternalServerError
+                   when 502      then Vindi::Error::BadGateway
+                   when 503      then Vindi::Error::ServiceUnavailable
+                   when 504      then Vindi::Error::GatewayTimeout
+                   when 500..599 then Vindi::Error::ServerError
+                   end
+          klass.new(response) if klass
+        end
+      end
+    end
+
+    def initialize(response)
+      super(build_error_message(response))
+    end
+
+    def build_error_message(response)
+      return if response.nil?
+
+      message  = "#{response[:method].to_s.upcase} "
+      message
+    end
+  end
+end

data/lib/vindi/request.rb

@@ -0,0 +1,61 @@
+require 'vindi/connection'
+
+module Vindi
+  module Request
+    include Vindi::Connection
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Hash]
+    def get(url, options = {})
+      request :get, url, options
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return Hash
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return Hash
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return Hash
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return Hash
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return Hash
+    def head(url, options = {})
+      request :head, url, options
+    end
+  end
+end

data/lib/vindi/response/raise_error.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'vindi/error'
+
+module Vindi
+  module Response
+    
+    # This class raises exceptions based HTTP status codes retuned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = Vindi::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/vindi/rest.rb

@@ -0,0 +1,32 @@
+Dir[File.expand_path("../rest/**/*.rb", __FILE__)].each do |file|
+  require file
+end
+
+module Vindi
+  module Rest
+    include Vindi::Rest::Plan
+    include Vindi::Rest::Product
+    include Vindi::Rest::Customer
+    include Vindi::Rest::PaymentMethod
+    include Vindi::Rest::Discount
+    include Vindi::Rest::Subscription
+    include Vindi::Rest::ProductItem
+    include Vindi::Rest::Period
+    include Vindi::Rest::Bill
+    include Vindi::Rest::BillItem
+    include Vindi::Rest::Charge
+    include Vindi::Rest::Transaction
+    include Vindi::Rest::PaymentProfile
+    include Vindi::Rest::Usage
+    include Vindi::Rest::Movement
+    include Vindi::Rest::Invoice
+    include Vindi::Rest::Message
+    include Vindi::Rest::ImportBatch
+    include Vindi::Rest::Notification
+    include Vindi::Rest::Issue
+    include Vindi::Rest::Merchant
+    include Vindi::Rest::Role
+    include Vindi::Rest::User
+    include Vindi::Rest::MerchantUser
+  end
+end