bling-ruby-api 0.0.1

data/lib/bling/api/user.rb

@@ -0,0 +1,72 @@
+module Bling
+  module API
+    # This class is used to make requests to all available
+    # actions related to users in Bling api. Is strongly recommended
+    # to use the Bling::API module wrapper
+    #
+    class User < Request
+      # Get a list of available users
+      #
+      # @example
+      #   users = Bling::API::User.new.list
+      #
+      # @return [Array] Call users index and return an array with records
+      #
+      def list
+        get_request(t_url(:users))
+      end
+
+      # Get a specific object based on user_id
+      #
+      # @example
+      #   user = Bling::API::user.new.get
+      #
+      # @param [String] cpf or cnpj from the user in Bling
+      #
+      # @return [Array] Call user#show and return an array with one record
+      #
+      def get(user_id)
+        get_request(t_url(:user, user_id))
+      end
+
+      # Insert a user in Bling
+      #
+      # @example
+      #   user = Bling::API::User.new.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'
+      #     }
+      #   )
+      #
+      # @param [Hash] params  A hash with user options
+      #
+      # @return [Array] Call user#create and return an array with one record
+      #
+      def create(params)
+        post_request(t_url(:user), parsed_xml(params))
+      end
+
+      private
+
+      def parsed_xml(params)
+        params = translate(params) unless Bling.config.default_language == :en
+        validate(params, :name, :user_type, :tax_type, :document)
+        user_template % params
+      end
+
+    end
+  end
+end
+

data/lib/bling/base.rb

@@ -0,0 +1,15 @@
+require 'bling/config'
+
+module Bling
+  class Error < ::StandardError
+  end
+
+  # @return [Config] The config singleton.
+  def self.config
+    @config ||= Bling::Config.new
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+end

data/lib/bling/config.rb

@@ -0,0 +1,50 @@
+module Bling
+  class Config
+
+    def initialize
+      @api_url = 'https://bling.com.br/Api/v2/'
+      @response_format = :json
+    end
+
+    # The api key supplied by Bling service.
+    #
+    # @return [String]
+    attr_accessor :api_key
+
+    # Set response format from Bling, can be :xml or :json (default).
+    #
+    # @param [:xml, :json, 'xml', 'json']
+    def response_format=(response_format)
+      @response_format = response_format.to_sym
+    end
+
+    # The base API url
+    #
+    # @return [String]
+    attr_reader :api_url
+
+    # The response format from Bling, can be :xml or :json (default).
+    #
+    # @return [Symbol]
+    def response_format
+      @response_format || :json
+    end
+
+    # The default language if set to english lib will translate
+    # to portuguese before actually make request. Default to :en
+    #
+    # @param [:pt, :en]
+    def default_language=(language)
+      raise ArgumentError unless [:en, :pt].include?(language.to_sym)
+      @default_language = language.to_sym
+    end
+
+    # The default language of API params
+    #
+    # @return [Symbol]
+    def default_language
+      @default_language || :en
+    end
+
+  end
+end

data/lib/bling/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+# @private
+class Bling::Railtie < ::Rails::Railtie
+
+  config.before_configuration do
+    config.bling = Bling.config
+  end
+end

data/lib/bling/version.rb

@@ -0,0 +1,3 @@
+module Bling
+  VERSION = '0.0.1'
+end

data/spec/lib/bling/api/client_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Bling::API::Client do
+  before(:each) { allow(Net::HTTP).to receive(:get_response) }
+  let(:client) { Bling::API::Client.new('path', {}, :product) }
+
+  it 'always return a Response object' do
+    expect(client.get).to be_kind_of(Bling::API::Response)
+  end
+
+  it 'always set api key' do
+    expect(Bling.config).to receive(:api_key)
+    client.get
+  end
+
+  it 'get default response format' do
+    expect(Bling.config).to receive(:response_format)
+    client.get
+  end
+
+  it 'get default api endpoint' do
+    expect(Bling.config).to receive(:api_url).and_return('https://foo.bar')
+    client.get
+  end
+
+  describe '#get' do
+    it 'set parameter to uri' do
+      expect( URI ).to receive(:encode_www_form)
+      client.get
+    end
+
+    it 'makes a get request' do
+      expect(Net::HTTP).to receive(:get_response)
+      client.get
+    end
+  end
+
+  describe '#post' do
+    it 'makes a post request' do
+      expect(Net::HTTP).to receive(:post_form)
+      client.post
+    end
+  end
+
+end

data/spec/lib/bling/api/product_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Bling::API::Product do
+
+  describe 'parsed hash' do
+    it 'correctly parses it to template' do
+      params = {
+        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,
+        cest: ''
+      }
+      product = Bling::API::Product.new
+      product.instance_variable_set(:@params, params)
+
+      parsed_params = product.send :parsed_xml
+      expect(parsed_params).to match(/Awesome/)
+    end
+
+
+    it 'works with the min required params' do
+      params = {
+        description: 'Awesome product',
+        price: 20.50,
+      }
+
+      product = Bling::API::Product.new
+      product.instance_variable_set(:@params, params)
+
+      parsed_params = product.send :parsed_xml
+      expect(parsed_params).to match(/20.5/)
+    end
+  end
+
+end

data/spec/lib/bling/api/record_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Bling::API::Record do
+
+  it 'create readers to each hash key' do
+    params = { name: 'Bilbo', age: 111 }
+    hobbit = Bling::API::Record.new(params)
+    expect(hobbit.name).to eq 'Bilbo'
+    expect(hobbit.age).to eq 111
+  end
+
+end

data/spec/lib/bling/api/response_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Bling::API::Response do
+
+
+  context 'with a valid http response' do
+    let(:http_response) { Net::HTTPOK.new('1.1', '200', 'OK') }
+
+    it 'is a success' do
+      pending
+      expect(described_class.new(http_response, 'foo').success?).to be_truthy
+    end
+
+  end
+
+  context 'with a invalid http response' do
+    let(:http_response) { Net::HTTPBadRequest.new('1.1', '400', 'Bad request') }
+
+    it 'is a failure' do
+      expect(described_class.new(http_response, 'foo').success?).to be_falsey
+    end
+  end
+end

data/spec/lib/bling/api/translator_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Bling::API::Translator do
+
+  describe '#translate_url' do
+    it 'accepts a Symbol as key'  do
+      expect(described_class.translate_url(:product)).to eq 'produto'
+    end
+
+    it 'accepts a String as key' do
+      expect(described_class.translate_url('product')).to eq 'produto'
+    end
+
+    it 'return a nested id if passed' do
+      expect(described_class.translate_url(:product, id: 1)).to eq 'produto/1'
+    end
+
+    it 'accepts anything as id' do
+      expect(described_class.translate_url(:product, id: 'foobar')).to eq 'produto/foobar'
+    end
+  end
+
+  describe '#translate_hash' do
+    context 'to en' do
+      let(:response) { { code: '001', description: 'Awesome thing' } }
+
+      it 'translate a hash of Symbol keys' do
+        params = { codigo: '001', descricao: 'Awesome thing' }
+        expect(described_class.translate_hash(params)).to eq response
+      end
+
+      it 'converts non-snakecase to snakecase' do
+        params = { 'pesoBruto' => '1', descricao: 'Awesome thing' }
+        response = { :raw_weight => '1', description: 'Awesome thing' }
+        expect(described_class.translate_hash(params)).to eq response
+      end
+
+      it 'accepts Strings and Symbols as keys' do
+        params = { 'codigo' => '001', descricao: 'Awesome thing' }
+        expect(described_class.translate_hash(params)).to eq response
+      end
+
+      it 'recursively translate hashes and arrays' do
+        params = { resultado: { produtos: [{codigo: '001'}, {codigo: '002'}] }  }
+        result = { result: { products: [{code: '001'}, {code: '002'}] }  }
+        expect(described_class.translate_hash(params)).to eq result
+      end
+
+      it 'keeps keys missing on yml' do
+        params = { codigo:  '001', nao_existente: 'foo'  }
+        result = { code:  '001', nao_existente: 'foo'  }
+        expect(described_class.translate_hash(params)).to eq result
+      end
+    end
+
+    context 'to pt' do
+      let(:response) { { codigo: '001', descricao: 'Awesome thing' } }
+
+      it 'translate a hash of Symbol keys' do
+        params = { code: '001', description: 'Awesome thing' }
+        expect(described_class.translate_hash(params, to: :pt)).to eq response
+      end
+
+      it 'accepts Strings and Symbols as keys' do
+        params = { 'code' => '001', description: 'Awesome thing' }
+        expect(described_class.translate_hash(params, to: :pt)).to eq response
+      end
+
+      it 'recursively translate hashes and arrays' do
+        params = { result: { products: [{code: '001'}, {code: '002'}] }  }
+        result = { resultado: { produtos: [{codigo: '001'}, {codigo: '002'}] }  }
+        expect(described_class.translate_hash(params, to: :pt)).to eq result
+      end
+
+      it 'keeps keys missing on yml' do
+        params = { code:  '001', nao_existente: 'foo'  }
+        result = { codigo:  '001', nao_existente: 'foo'  }
+        expect(described_class.translate_hash(params, to: :pt)).to eq result
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'bling'
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bling-ruby-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denis Tierno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to access Bling API in ruby
+email: contato@locomotiva.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bling.gemspec
+- lib/bling.rb
+- lib/bling/api.rb
+- lib/bling/api/client.rb
+- lib/bling/api/locales/translations.yml
+- lib/bling/api/order.rb
+- lib/bling/api/parser.rb
+- lib/bling/api/product.rb
+- lib/bling/api/record.rb
+- lib/bling/api/request.rb
+- lib/bling/api/response.rb
+- lib/bling/api/templates/order_installment_template
+- lib/bling/api/templates/order_item_template
+- lib/bling/api/templates/order_template
+- lib/bling/api/templates/order_update_template
+- lib/bling/api/templates/product_template
+- lib/bling/api/templates/user_template
+- lib/bling/api/translator.rb
+- lib/bling/api/user.rb
+- lib/bling/base.rb
+- lib/bling/config.rb
+- lib/bling/railtie.rb
+- lib/bling/version.rb
+- spec/lib/bling/api/client_spec.rb
+- spec/lib/bling/api/product_spec.rb
+- spec/lib/bling/api/record_spec.rb
+- spec/lib/bling/api/response_spec.rb
+- spec/lib/bling/api/translator_spec.rb
+- spec/spec_helper.rb
+homepage: http://locomotiva.pro
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem to access Bling API in ruby
+test_files:
+- spec/lib/bling/api/client_spec.rb
+- spec/lib/bling/api/product_spec.rb
+- spec/lib/bling/api/record_spec.rb
+- spec/lib/bling/api/response_spec.rb
+- spec/lib/bling/api/translator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: