bling-ruby-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6eb9b91e71c99be3d5190eabfd2f7e095eca9922
+  data.tar.gz: 434969bce4d2ceeb8836901ff30f7594c3d52d8a
+SHA512:
+  metadata.gz: dcca2d34ba06f39f3700f6f5bc7eba751e54f9085b6501073125ba41a54582227ae22faa6b4581574a41b27f20e8d469c8e20739c6cafc12656668be6a1f1067
+  data.tar.gz: da163e6cd8f2fcddf8e63b9ceea721075b9db59bd4de4fa071dbe6b7caf547e906b2454d2e3406c32aa4548de373f387a8876d747b91d02fd68e09264a0cc5eb

data/.gitignore

@@ -0,0 +1,30 @@
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    bling (0.0.1)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bling!
+  codeclimate-test-reporter
+  rspec
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2016
+Denis Tierno
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Ruby Bling API
+
+Essa gem consiste em uma interface ruby para comunicação com a API do [Bling ERP](https://www.bling.com.br).
+
+[![Code Climate](https://codeclimate.com/github/locomotivapro/bling/badges/gpa.svg)](https://codeclimate.com/github/locomotivapro/bling)
+[![Test Coverage](https://codeclimate.com/github/locomotivapro/bling/badges/coverage.svg)](https://codeclimate.com/github/locomotivapro/bling/coverage)
+
+## Configuração
+
+Instale a versão mais recente
+
+```
+$ gem install bling
+```
+
+Configure sua chave de integração:
+
+```ruby
+Bling::Config.api_key = '55fxs324dsk3....'
+```
+
+Por padrão a gem é configurada para aceitar os parâmetros em inglês,
+caso deseje é possível configurar a gem para aceitar em português:
+
+```ruby
+Bling::Config.default_language= :pt # :en default
+```
+
+## Uso
+
+A chamada para os possíveis endpoints da API do Bling são todas feitas
+utilizando a class Bling::API ex:
+
+```ruby
+users = Bling::API.users.list
+```
+
+*Cliente*
+
+Listagem de todos clientes inseridos no Bling:
+
+```ruby
+user_client = Bling::API.users
+users = user_client.list
+```
+
+Inserir um cliente no Bling:
+
+```ruby
+user = Bling::API.user.create(
+  {
+  name: 'Jonh Doe',
+  company_name: '',
+  tax_type: 1,
+  document: '35165478662',
+  ir_rg: '306153420',
+  address: 'My great street',
+  number: '33',
+  additional_address: 'apt 12',
+  zipcode: '03454020',
+  city: 'Sao Paulo',
+  uf: 'SP',
+  phone: '(11) 2233-3322',
+  email: jonh@@doe.com'
+  }
+)
+
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "./spec/**/*_spec.rb"
+  task.rspec_opts = ['--color']
+end
+
+task :default => %w{spec}

data/bling.gemspec

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bling/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'bling-ruby-api'
+  s.version     = Bling::VERSION
+  s.summary     = 'Gem to access Bling API in ruby'
+  s.description = 'Gem to access Bling API in ruby'
+  s.required_ruby_version = '>= 2.1'
+
+  s.author    = 'Denis Tierno'
+  s.email     = 'contato@locomotiva.pro'
+  s.homepage  = 'http://locomotiva.pro'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = s.files.grep(%r{^(spec|features)/})
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'rake'
+
+  s.add_development_dependency 'rspec'
+end

data/lib/bling.rb

@@ -0,0 +1,16 @@
+require 'bling/base'
+require 'bling/version'
+
+require 'bling/api'
+require 'bling/api/client'
+require 'bling/api/translator'
+require 'bling/api/parser'
+require 'bling/api/request'
+require 'bling/api/response'
+require 'bling/api/record'
+require 'bling/api/product'
+require 'bling/api/user'
+require 'bling/api/order'
+
+
+require 'bling/railtie' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3

data/lib/bling/api.rb

@@ -0,0 +1,26 @@
+module Bling
+  module API
+    # This module encapsulates all API groups
+    # and creates an instance for it. You can make a direct
+    # call like Bling::API::Product.new.list but it`s best and
+    # less verbose to use this module ex: Bling::API.product.list
+    #
+    # To see all methods available to each instance, please look
+    # in each respectively class
+
+    extend self
+
+    def product
+      Product.new
+    end
+
+    def user
+      User.new
+    end
+
+    def order
+      Order.new
+    end
+
+  end
+end

data/lib/bling/api/client.rb

@@ -0,0 +1,67 @@
+require 'net/http'
+
+module Bling
+  module API
+    class Client
+
+      # @param [String, Hash, Symbol] The constructor to build an HTTP request
+      # and a response_class used to parse the response
+      def initialize(url, params={}, response_class)
+        @uri = build_uri(url)
+        @params = params
+        @response_class = response_class
+      end
+
+      # @return [Response] The accessor to a get request.
+      def get
+        uri.query = URI.encode_www_form(get_params(params))
+        request = Net::HTTP.get_response(uri)
+        Response.new(request, response_class)
+      end
+
+      # @return [Response] The accessor to a post request.
+      def post
+        Response.new(post_request, response_class)
+      end
+
+      # @return [Response] The accessor to a post request.
+      def delete
+        Response.new(delete_request, response_class)
+      end
+
+      private
+
+      attr_reader :uri, :params, :response_class
+
+      def delete_request
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == 'https')
+        request = Net::HTTP::Delete.new(uri.path)
+        request.set_form_data({ apikey: api_key })
+        http.request(request)
+      end
+
+      def post_request
+        post_params = {
+          apikey: api_key,
+          xml: params
+        }
+        Net::HTTP.post_form(uri, post_params)
+      end
+
+      def get_params(params)
+        { apikey: api_key }.merge!(params)
+      end
+
+      def api_key
+        Bling.config.api_key
+      end
+
+      def build_uri(url)
+        format_type = Bling.config.response_format.to_s
+        URI(Bling.config.api_url + url + '/' + format_type)
+      end
+
+    end
+  end
+end

data/lib/bling/api/locales/translations.yml

@@ -0,0 +1,71 @@
+produtos: products
+produto: product
+contato: user
+contatos: users
+pedido: order
+pedidos: orders
+
+resultado: result
+retorno: return
+erros: errors
+
+codigo: code
+descricao: description
+descricao_complementar: additional_description
+un: unit
+vlr_unit: price
+preco_custo: cost_price
+peso_bruto: raw_weight
+peso_liq: weight
+class_fiscal: tax_category
+origem: origin
+estoque: quantity
+gtin: gtin
+gtin_embalagem: gtin_package
+largura: width
+altura: height
+profundidade: depth
+estoque_minimo: min_quantity
+estoque_maximo: max_quantity
+
+nome: name
+fantasia: company_name
+tipo_pessoa: tax_type
+cpf_cnpj: document
+ie_rg: ie_rg
+endereco: address
+numero: number
+complemento: additional_address
+bairro: neighborhood
+cep: zipcode
+cidade: city
+uf: state
+fone: phone
+email: email
+
+celular: cellphone
+transportadora: carrier
+tipo_frete: :shipment_type
+servico_correios: correios_service
+
+numero_loja: ecommerce_order_number
+loja: store
+nat_operacao: selling_category
+contribuinte: tax_classification
+situacao: status
+
+nome_etiqueta_envio: shipment_label_name
+endereco_etiqueta_envio: shipment_label_address
+numero_etiqueta_envio: shipment_label_number
+complemento_etiqueta_envio: shipment_label_additional_address
+municipio_etiqueta_envio: shipment_label_city
+estado_etiqueta_envio: shipment_label_state
+cep_etiqueta_envio: shipment_label_zipcode
+bairro_etiqueta_envio: shipment_label_neighborhood
+qtde: item_quantity
+data: date
+vlr: amount
+obs: additional_info
+vlr_frete: shipment_amount
+vlr_desconto: discount_amount
+obs_internas: private_additional_info

data/lib/bling/api/order.rb

@@ -0,0 +1,224 @@
+module Bling
+  module API
+    # This class is used to make requests to all available
+    # actions related to orders in Bling api. Is strongly recommended
+    # to use the Bling::API module wrapper
+    #
+    class Order < Request
+      # Get a list of available orders
+      #
+      # @example
+      #   orders = Bling::API::Order.new.list
+      #
+      # @return [Array] Call orders index and return an array with records
+      #
+      def list
+        get_request(t_url(:orders))
+      end
+
+      # Get a specific object based on order_id
+      #
+      # @example
+      #   order = Bling::API::order.new.get
+      #
+      # @param [String] cpf or cnpj from the order in Bling
+      #
+      # @return [Array] Call order#show and return an array with one record
+      #
+      def get(order_id)
+        get_request(t_url(:order, order_id))
+      end
+
+      # Insert a order in Bling
+      #
+      # @example
+      #   order = Bling::API::Order.new.create(
+      #     {
+      #     order_number: '123',
+      #     ecommerce_order_number: 'R123',
+      #     store: 'Foo',
+      #     selling_category: '',
+      #     user: {
+      #      name: 'Jonh Doe',
+      #      company_name: '',
+      #      tax_type: 1,
+      #      document: '35165478662',
+      #      ir_rg: '306153420',
+      #      tax_classification: 1,
+      #      address: 'My great street',
+      #      number: '33',
+      #      additional_address: 'apt 12',
+      #      zipcode: '03454020',
+      #      city: 'Sao Paulo',
+      #      uf: 'SP',
+      #      phone: '(11) 2233-3322',
+      #      cellphone: '(11) 2233-3322',
+      #      email: jonh@@doe.com'
+      #     },
+      #     shipment: {
+      #       carrier: 'Correios',
+      #       shipment_type: 'R'
+      #       shipment_label: {}
+      #     },
+      #     items: [
+      #       { code: '001', description: 'lorem', unit: 'pc', item_quantity: 3, price: 12.30 },
+      #       { code: '002', description: 'lorem', unit: 'pc', item_quantity: 4, price: 32.30 },
+      #     ],
+      #     installments: [
+      #       { date: '28/06/2016', amount: 140.00, additional_info: '' },
+      #       { date: '28/07/2016', amount: 140.00, additional_info: '' },
+      #     ],
+      #     shipment_amount: 10.0,
+      #     discount_amount: 0.0,
+      #     additional_info: '',
+      #     private_additional_info: ''
+      #     }
+      #   )
+      #
+      # @param [Hash] params  A hash with order options
+      #
+      # @return [Array] Call order#create and return an array with one record
+      #
+      def create(params)
+        post_request(t_url(:order), parsed_xml(params))
+      end
+
+      # Put an order status update based on order_id
+      #
+      # Available statuses
+      #
+      #  - 0 (Em Aberto)
+      #  - 1 (Atendido)
+      #  - 2 (Cancelado)
+      #  - 3 (Em Andamento)
+      #  - 4 (Venda Agenciada)
+      #  - 10 (Em Digitação)
+      #  - 11 (Verificado)
+      #
+      # @example
+      #   order = Bling::API::order.new.update(order_id, status)
+      #
+      # @param [String] cpf or cnpj from the order in Bling
+      # @param [Integer] status number for order in Bling
+      #
+      # @return [Array] Call order#show and return an array with one record
+      #
+      def put(order_id, status)
+        raise ArgumentError unless [0, 1, 2, 3, 4, 10, 11].include?(status.to_i)
+        xml = order_update_template % { status: status.to_i }
+        put_request(t_url(:order, order_id), xml)
+      end
+
+      private
+
+
+      def parsed_xml(params)
+        @params = params
+        @params = translate(@params) unless Bling.config.default_language == :en
+
+        validate(@params, :name)
+
+        validate_object(:items, Array)
+        @params[:items].each do |item|
+          validate(item, :description, :code, :item_quantity, :price)
+        end
+
+        @params[:installments].each do |installment|
+          validate(installment, :amount)
+        end if @params[:installments]
+
+        items = @params.delete :items
+        installments = @params.delete :installments
+
+        @params[:items] = parse_items(items)
+        @params[:installments] = parse_installments(installments)
+
+        build_missing_params
+        order_template % @params
+      end
+
+      def validate_object(key, klass)
+        raise ArgumentError unless @params.has_key?(key) & @params[key].is_a?(klass)
+      end
+
+      def parse_items(items)
+        build_item_missing_nodes(items)
+          .each_with_object('') { |item, string| string.concat(order_item_template % item)  }
+      end
+
+      def parse_installments(installments)
+        build_installment_missing_nodes(installments)
+          .each_with_object('') { |installment, string| string.concat(order_installment_template % installment)  }
+      end
+
+      def build_missing_params
+        xml_nodes.each { |node| @params[node] = nil unless @params.has_key?(node) }
+      end
+
+      def build_installment_missing_nodes(installments)
+        build_missing_nodes(:installments_xml_nodes, installments)
+      end
+
+      def build_item_missing_nodes(items)
+        build_missing_nodes(:item_xml_nodes, items)
+      end
+
+      def build_missing_nodes(node_array, records)
+        records.each do |record|
+          send(node_array).each { |node| record[node] = nil unless record.has_key?(node) }
+        end
+        records
+      end
+
+      def installments_xml_nodes
+        [:date, :amount, :additional_info]
+      end
+
+      def item_xml_nodes
+        [ :code, :description, :unit, :item_quantity, :price ]
+      end
+
+      def xml_nodes
+        [
+          :date,
+          :order_number,
+          :ecommerce_order_number,
+          :store,
+          :selling_category,
+          :name,
+          :tax_type,
+          :address,
+          :document,
+          :ie_rg,
+          :tax_classification,
+          :number,
+          :additional_address,
+          :neighborhood,
+          :zipcode,
+          :city,
+          :state,
+          :phone,
+          :cellphone,
+          :email,
+          :carrier,
+          :shipment_type,
+          :correios_service,
+          :shipment_label_name,
+          :shipment_label_address,
+          :shipment_label_number,
+          :shipment_label_additional_address,
+          :shipment_label_city,
+          :shipment_label_state,
+          :shipment_label_zipcode,
+          :shipment_label_neighborhood,
+          :shipment_amount,
+          :discount_amount,
+          :additional_info,
+          :private_additional_info
+        ]
+      end
+
+    end
+  end
+end
+