bling-ruby-api 0.0.1

data/lib/bling/api/parser.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module Bling
+  module API
+    class Parser
+
+      def initialize(text, klass_name)
+        @text, @klass_name = text, klass_name
+      end
+
+      def result
+        raw_response = JSON.parse(@text)
+        Translator.translate_hash(raw_response, to: :en)
+      end
+
+      def records
+        raw_records = result[:return][plural_klass_name]
+        return [] if raw_records.nil?
+        raw_records.each_with_object([]) { |record, result| result << Record.new(record[@klass_name]) }
+      end
+
+      private
+
+      def plural_klass_name
+        @klass_name.to_s.pluralize.to_sym
+      end
+
+    end
+  end
+end

data/lib/bling/api/product.rb

@@ -0,0 +1,143 @@
+module Bling
+  module API
+    # This class is used to make requests to all available
+    # actions related to products in Bling api. Is strongly recommended
+    # to use the Bling::API module wrapper
+    #
+    class Product < Request
+
+      # Get a list of available products
+      #
+      # @example
+      #   products = Bling::API::Product.new.list
+      #
+      # @return [[Record]] Call products index and return an array with records
+      #
+      def list
+        get_request(t_url(:products))
+      end
+
+      # Get a specific object based on product_id
+      #
+      # @example
+      #   product = Bling::API::Product.new.get
+      #
+      # @param [Integer,String] product_id The product id in Bling
+      #
+      # @return [[Record]] Call product show and return an arrayn with one record
+      #
+      def get(product_id)
+        get_request(t_url(:product, product_id))
+      end
+
+      # Insert a product in Bling
+      #
+      # @example
+      #   product = Bling::API::Product.new.create(
+      #     {
+      #     code: '92314',
+      #     description: 'Awesome product',
+      #     additional_description: 'In lovely colors',
+      #     unit: 'Pc',
+      #     price: 20.50,
+      #     cost_price: 14.30,
+      #     raw_weight: 2,
+      #     weight: 1.8,
+      #     tax_category: '1000.01.01',
+      #     origin: 0,
+      #     quantity: 10,
+      #     gtin: 832222,
+      #     gtin_package: 13414,
+      #     width: 25,
+      #     height: 15,
+      #     depth: 10,
+      #     min_quantity: 1,
+      #     max_quantity: 200
+      #     }
+      #   )
+      #
+      # @param [Hash] params  A hash with product options
+      #
+      # @return [[Record]] Call product show and return an array with one record
+      #
+      def create(params)
+        @params = params
+        post_request(t_url(:product), parsed_xml)
+      end
+
+      # Update a product in Bling
+      #
+      # @example
+      #   product = Bling::API::Product.new.create(
+      #     {
+      #     code: '92314',
+      #     description: 'Awesome product',
+      #     additional_description: 'In lovely colors',
+      #     unit: 'Pc',
+      #     price: 20.50,
+      #     cost_price: 14.30,
+      #     raw_weight: 2,
+      #     weight: 1.8,
+      #     tax_category: '1000.01.01',
+      #     origin: 0,
+      #     quantity: 10,
+      #     gtin: 832222,
+      #     gtin_package: 13414,
+      #     width: 25,
+      #     height: 15,
+      #     depth: 10,
+      #     min_quantity: 1,
+      #     max_quantity: 200
+      #     }
+      #   )
+      #
+      # @param [Integer, String] product_id  The product id in Bling
+      # @param [Hash] params  A hash with product options
+      #
+      # @return [[Record]] Call product show and return an array with one record
+      #
+      def update(product_id, params)
+        @params = params
+        post_request(t_url(:product, product_id), parsed_xml)
+      end
+
+      # Delete a product in Bling
+      #
+      # @example
+      #   Bling::API::Product.new.delete(1)
+      #
+      # @param [Integer,String] product_id The product id in Bling
+      #
+      # @return [[Record]] Call product show and return an array with one record
+      #
+      def delete(product_id)
+        delete_request(t_url(:product, product_id))
+      end
+
+      private
+
+      def parsed_xml
+        @params = translate(@params) unless Bling.config.default_language == :en
+        validate(@params, :description, :price)
+        build_missing_keys
+        product_template % @params
+      end
+
+      def build_missing_keys
+        xml_nodes.each do |node|
+          @params[node] = nil unless @params.has_key?(node)
+        end
+      end
+
+      def xml_nodes
+        %i(code description
+           additional_description unit price
+           cost_price raw_weight weight
+           tax_category origin quantity gtin
+           gtin_package width height depth
+           min_quantity max_quantity cest)
+      end
+
+    end
+  end
+end

data/lib/bling/api/record.rb

@@ -0,0 +1,25 @@
+module Bling
+  module API
+    class Record
+
+      # @return [Hash] The original hash attributes passed on initialize
+      attr_reader :attrs
+
+      # @params [Hash] A hash that will generate accessors for each key
+      def initialize(hash)
+        @attrs = hash
+      end
+
+      private
+
+      def method_missing(method, *args, &block)
+        if attrs.has_key?(method)
+          attrs[method]
+        else
+          super(method, args, block)
+        end
+      end
+
+    end
+  end
+end

data/lib/bling/api/request.rb

@@ -0,0 +1,53 @@
+module Bling
+  module API
+    class Request
+
+      private
+
+      def get_request(url)
+        Client.new(url, {}, klass_name).get
+      end
+
+      def post_request(url, params)
+        Client.new(url, params, klass_name).post
+      end
+
+      def put_request(url, params)
+        Client.new(url, params, klass_name).post
+      end
+
+      def delete_request(url)
+        Client.new(url, {}, klass_name).delete
+      end
+
+      def klass_name
+        self.class.to_s.split('::').last.downcase.to_sym
+      end
+
+      def t_url(url, id=nil)
+        Translator.translate_url(url, id: id)
+      end
+
+      def translate(params)
+        Translator.translate_hash(params)
+      end
+
+      def validate(params, *required_params)
+        required_params.each do |param|
+          if params[param].nil? || params[param] =~ /^\s*$/
+            raise ArgumentError, "The required parameter `:#{param}' is missing."
+          end
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~/\A.+_template\z/
+          IO.read(File.join(File.dirname(__FILE__), "templates", method.to_s))
+        else
+          super(method, args, &block)
+        end
+      end
+
+    end
+  end
+end

data/lib/bling/api/response.rb

@@ -0,0 +1,46 @@
+module Bling
+  module API
+    class Response
+
+      # @return [Net::HTTPResponse] The response object returned by Net::HTTP.
+      attr_reader :http_response
+
+      # @param [Net::HTTPResponse] http_response The response object returned by Net::HTTP.
+      def initialize(http_response, klass_name)
+        @http_response = http_response
+        @klass_name = klass_name
+      end
+
+      # @return [String] The raw body of the response object.
+      def body
+        @http_response.body
+      end
+
+      # @return [Boolean] Whether or not the request was successful.
+      def success?
+        !http_failure? && without_errors
+      end
+
+      # @return [Boolean] Whether or not the HTTP request was a success.
+      def http_failure?
+        !@http_response.is_a?(Net::HTTPSuccess)
+      end
+
+      # @return [Array] with parsed response body.
+      def records
+        parsed_response.records if success?
+      end
+
+      private
+
+      def without_errors
+        parsed_response.result[:return] && parsed_response.result[:return][:errors].nil?
+      end
+
+      def parsed_response
+        @parsed_response ||= Parser.new(body, @klass_name)
+      end
+
+    end
+  end
+end

data/lib/bling/api/templates/order_installment_template

@@ -0,0 +1,6 @@
+<parcela>
+  <data>%{date}</data>
+  <vlr>%{amount}</vlr>
+  <obs>%{additional_info}</obs>
+</parcela>
+

data/lib/bling/api/templates/order_item_template

@@ -0,0 +1,8 @@
+<item>
+  <codigo>%{code}</codigo>
+  <descricao>%{description}</descricao>
+  <un>%{unit}</un>
+  <qtde>%{item_quantity}</qtde>
+  <vlr_unit>%{price}</vlr_unit>
+</item>
+

data/lib/bling/api/templates/order_template

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pedido>
+  <data>%{date}</data>
+  <numero>%{order_number}</numero>
+  <numero_loja>%{ecommerce_order_number}</numero_loja>
+  <loja>%{store}</loja>
+  <nat_operacao>%{selling_category}</nat_operacao>
+  <cliente>
+    <nome>%{name}</nome>
+    <tipoPessoa>%{tax_type}</tipoPessoa>
+    <endereco>%{address}</endereco>
+    <cpf_cnpj>%{document}</cpf_cnpj>
+    <ie_rg>%{ie_rg}</ie_rg>
+    <contribuinte>%{tax_classification}</contribuinte>
+    <numero>%{number}</numero>
+    <complemento>%{additional_address}</complemento>
+    <bairro>%{neighborhood}</bairro>
+    <cep>%{zipcode}</cep>
+    <cidade>%{city}</cidade>
+    <uf>%{state}</uf>
+    <fone>%{phone}</fone>
+    <celular>%{cellphone}</celular>
+    <email>%{email}</email>
+  </cliente>
+  <transporte>
+    <transportadora>%{carrier}</transportadora>
+    <tipo_frete>%{shipment_type}</tipo_frete>
+    <servico_correios>%{correios_service}</servico_correios>
+    <dados_etiqueta>
+      <nome>%{shipment_label_name}</nome>
+      <endereco>%{shipment_label_address}</endereco>
+      <numero>%{shipment_label_number}</numero>
+      <complemento>%{shipment_label_additional_address}</complemento>
+      <municipio>%{shipment_label_city}</municipio>
+      <uf>%{shipment_label_state}</uf>
+      <cep>%{shipment_label_zipcode}</cep>
+      <bairro>%{shipment_label_neighborhood}</bairro>
+    </dados_etiqueta>
+  </transporte>
+  <itens>%{items}</itens>
+  <parcelas>%{installments}</parcelas>
+  <vlr_frete>%{shipment_amount}</vlr_frete>
+  <vlr_desconto>%{discount_amount}</vlr_desconto>
+  <obs>%{additional_info}</obs>
+  <obs_internas>%{private_additional_info}</obs_internas>
+</pedido>

data/lib/bling/api/templates/order_update_template

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pedido>
+  <situacao>%{:status}</situacao>
+</pedido>

data/lib/bling/api/templates/product_template

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<produto>
+  <codigo>%{code}</codigo>
+  <descricao>%{description}</descricao>
+  <descricaoComplementar>%{additional_description}</descricaoComplementar>
+  <un>%{unit}</un>
+  <vlr_unit>%{price}</vlr_unit>
+  <preco_custo>%{cost_price}</preco_custo>
+  <peso_bruto>%{raw_weight}</peso_bruto>
+  <peso_liq>%{weight}</peso_liq>
+  <class_fiscal>%{tax_category}</class_fiscal>
+  <origem>%{origin}</origem>
+  <estoque>%{quantity}</estoque>
+  <gtin>%{gtin}</gtin>
+  <gtinEmbalagem>%{gtin_package}</gtinEmbalagem>
+  <largura>%{width}</largura>
+  <altura>%{height}</altura>
+  <profundidade>%{depth}</profundidade>
+  <estoqueMinimo>%{min_quantity}</estoqueMinimo>
+  <estoqueMaximo>%{max_quantity}</estoqueMaximo>
+  <cest>%{cest}</cest>
+</produto>

data/lib/bling/api/templates/user_template

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<contato>
+  <nome>%{:name}</nome>
+  <fantasia>%{:company_name}</fantasia>
+  <tipoPessoa>%{:tax_type}</tipoPessoa>
+  <cpf_cnpj>%{:document}</cpf_cnpj>
+  <ie_rg>%{:ie_rg}</ie_rg>
+  <endereco>%{:address}</endereco>
+  <numero>%{:number}</numero>
+  <complemento>%{:additional_address}</complemento>
+  <bairro>%{:neighborhood}</bairro>
+  <cep>%{:zipcode}</cep>
+  <cidade>%{:city}</cidade>
+  <uf>%{:state}</uf>
+  <fone>%{:phone}</fone>
+  <email>%{:email}</email>
+</contato>

data/lib/bling/api/translator.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+
+module Bling
+  module API
+    class Translator
+
+      I18N_FILE ||= YAML
+        .load_file(File.join(File.dirname(__FILE__), 'locales/translations.yml'))
+        .each_with_object({}){|(k,v), result| result[k.to_sym] = v.to_sym}
+
+      class << self
+        def translate_url(key, id: nil)
+          url = pt[key.to_sym].to_s
+          url +="/#{id}" if id
+          url
+        end
+
+        def translate_hash(hash, to: :en)
+          conversion_hash = send(to)
+
+          hash.inject({}) do |result, (key, value)|
+            new_key = conversion_hash[underscore_symbol(key)]
+            new_key = underscore_symbol(key) if new_key.nil?
+
+            new_value = case value
+                        when Hash then translate_hash(value, to: to)
+                        when Array then value.map! { |v| translate_hash(v, to: to) }
+                        else value
+                        end
+
+            result[new_key] = new_value
+            result
+          end
+        end
+
+        private
+
+        def underscore_symbol(key)
+          key.to_s.
+            gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase.
+            to_sym
+        end
+
+        def en
+          I18N_FILE
+        end
+
+        def pt
+          @pt ||= I18N_FILE
+            .dup
+            .each_with_object({}) { |(key, value), result|  result[value] = key }
+        end
+      end
+
+    end
+  end
+end