tinyerp_ruby 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec70d0fb1f61b45caf432e187c1a6a09a02a248
+  data.tar.gz: 1cf63c259c6c9e6e74c67a7b03a6fda76bf31705
+SHA512:
+  metadata.gz: fa9c2a76c29646ff6a1aab5cc6be05b6622af5976db9749b34f22d74f061d61296c5ae59e20fdcb3afefd6b4e589ef77f1188bd578e8e7ca972284e994dcabe7
+  data.tar.gz: b61ccca8e3ecacfd00d8894872c3d641742387226288d920ec1ea24fb28d268eee2373f871a126bb9113bd4fd9db0d6bcbd55dca6b62402a483e786472c27720

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+spec/support/api_key.rb
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+script: "bundle exec rspec spec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tinyerp_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Denis Tierno
+
+MIT License
+
+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,73 @@
+# TinyerpRuby
+
+[![Build Status](https://travis-ci.org/locomotivapro/tinyerp_ruby.svg?branch=master)](https://travis-ci.org/locomotivapro/tinyerp_ruby)
+[![Code Climate](https://codeclimate.com/github/locomotivapro/tinyerp_ruby.png)](https://codeclimate.com/github/locomotivapro/tinyerp_ruby)
+
+Gem for integration with [TinyERP](http://www.tiny.com.br) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tinyerp_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tinyerp_ruby
+
+## Usage
+
+In first place you need an account in TinyERP. This gem iis just a
+wrapper to make calls to TinyERP api (v2) using a ruby hash and
+parsing the response as a ruby hash object.
+
+Start creating a connection with you api key, by default it will be started in production env but you can provide another env in connection initialization.
+
+    connection = TinyerpRuby::Connection.new 'yourawesomeapikey'
+
+Then we create a service object.
+
+    poster = TinyerpRuby::Service.new connection
+
+With service object created we just need to call the api methods and pass a hash according api description.
+
+    params = {....}
+    return_params = poster.pesquisar_vendedores_service(params)
+
+The list with complete api method is found [here.](http://www.tiny.com.br/manuais/api2/)
+
+## Testing
+
+TinyerpRuby uses VCR to mock the api requests, but if you want to test
+with another api key just do the following:
+
+At the moment TinyERP doesn`t have a test environment, so you need to
+create an account (free) and generate a new key for you. With your key,
+create a file named api_key.rb inside spec/support with this code:
+
+    API_KEY = "yourawesomeeapikeyhere"
+
+This way you are set up to run the tests
+
+    $ rspec spec
+
+## TODO
+
+This is an early release and can be much improved. Next steps planned are;
+
+  - Add builder object to complex methods as incluir_pedido and incluir_nota_fiscal
+  - Add better docs for params hash object
+  - Add support for better logs
+  - ...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tinyerp_ruby/connection.rb

@@ -0,0 +1,11 @@
+module TinyerpRuby
+  class Connection
+    attr_reader :base_url, :environment, :api_key
+
+    def initialize(api_key, environment = :production)
+      @environment = eval(environment.to_s.capitalize)
+      @base_url = @environment::BASE_URL
+      @api_key = api_key
+    end
+  end
+end

data/lib/tinyerp_ruby/poster.rb

@@ -0,0 +1,36 @@
+require 'savon'
+
+module TinyerpRuby
+  module Poster
+
+    class << self
+
+      def call(connection, service, params)
+        @connection = connection
+        webservice = Savon.client(wsdl: @connection.base_url, convert_request_keys_to: :none)
+        response = webservice.call(service, message: formatted_params(params))
+        parse service, response
+      end
+
+      private
+      def formatted_params(params)
+        formatted = { token: @connection.api_key }
+        formatted.delete(:formato)
+        formatted.merge!(params)
+        formatted.merge!({formato: 'json'})
+        formatted
+      end
+
+      # For some reason Savon isnt parsing the response, so we do
+      def parse(service, response)
+        node = [service.to_s, "response"].join("_").to_sym
+        body = response.body[node][:return]
+        parser = Nori.new(convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
+        parsed = parser.parse(body)
+        parsed[:retorno]
+      end
+
+    end
+
+  end
+end

data/lib/tinyerp_ruby/service.rb

@@ -0,0 +1,30 @@
+module TinyerpRuby
+  class Service
+    SERVICES = [:pesquisar_vendedores_service, :pesquisar_contatos_service, :obter_contato_service, :incluir_contato_service, :alterar_contato_service, :pesquisar_grupos_tag_service, :incluir_grupo_tag_service, :alterar_grupo_tag_service, :pesquisar_tag_service, :incluir_tag_service, :alterar_tag_service, :pesquisar_produtos_service, :obter_produto_service, :incluir_produto_service, :alterar_produto_service, :obter_estoque_produto_service, :obter_estrutura_produto_service, :obter_tags_produto_service, :lista_atualizacoes_produtos_service, :lista_atualizacoes_estoque_service, :pesquisar_pedidos_service, :obter_pedido_service, :incluir_pedido_service, :pesquisar_notas_fiscais_service, :obter_nota_fiscal_service, :incluir_nota_fiscal_service, :obter_xml_nota_fiscal, :pesquisar_notas_servico_service, :obter_nota_servico_service, :incluir_nota_servico_service, :pesquisar_contratos_service, :obter_contrato_service, :incluir_contrato_service, :gerar_ordem_produca_pedido_service, :pesquisar_contatos_xml, :obter_contato_xml, :incluir_contato_xml, :alterar_contato_xml, :pesquisar_grupos_tag_xml, :incluir_grupo_tag_xml, :alterar_grupo_tag_xml, :pesquisar_tag_xml, :incluir_tag_xml, :alterar_tag_xml, :pesquisar_produtos_xml, :obter_produto_xml, :incluir_produto_xml, :alterar_produto_xml, :obter_estoque_produto_xml, :obter_estrutura_produto_xml, :obter_tags_produto_xml, :lista_atualizacoes_produtos_xml, :lista_atualizacoes_estoque_xml, :pesquisar_pedidos_xml, :obter_pedido_xml, :incluir_pedido_xml, :pesquisar_notas_fiscais_xml, :obter_nota_fiscal_xml, :incluir_nota_fiscal_xml, :pesquisar_notas_servico_xml, :obter_nota_servico_xml, :incluir_nota_servico_xml, :pesquisar_contratos_xml, :obter_contrato_xml, :incluir_contrato_xml]
+
+    def initialize(connection)
+      raise StandartError unless connection.kind_of?(TinyerpRuby::Connection)
+      @connection = connection
+    end
+
+    def method_missing(method, *args, &block)
+      method = method.to_sym
+      if SERVICES.include?(method)
+        poster(method, args)
+      else
+        super
+      end
+    end
+
+    private
+
+    def poster(method, args)
+      params = args.first
+      raise ArgumentError unless params.kind_of?(Hash)
+      poster = Poster.call(@connection, method, params)
+      poster
+    end
+
+  end
+end
+

data/lib/tinyerp_ruby/version.rb

@@ -0,0 +1,3 @@
+module TinyerpRuby
+  VERSION = "0.3.0"
+end

data/lib/tinyerp_ruby.rb

@@ -0,0 +1,14 @@
+require "tinyerp_ruby/version"
+require "tinyerp_ruby/connection"
+require "tinyerp_ruby/service"
+require "tinyerp_ruby/poster"
+
+module TinyerpRuby
+  class Production
+    BASE_URL = "http://www.tiny.com.br/api2.php?wsdl"
+  end
+
+  class Test
+    BASE_URL = "http://test.com"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'support/vcr'
+require 'webmock/rspec'
+require 'savon'
+require 'tinyerp_ruby'
+require 'support/api_key'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.mock_with :rspec
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+