fastshop_catalog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6979a2dd0fb12fbe9763eb4c513ae9eb99ee4929
+  data.tar.gz: 0ae72216d29c1259cda93d76360b8ad87267729a
+SHA512:
+  metadata.gz: a130fae20c101e7b86d617f54594de693487180acd9fdda906315acff3d9220b4becafcd6f9c40b08e72d7ee90957d03924375a06c1d5923eeed940afaa74904
+  data.tar.gz: 1d326bc2c4d90c913311d3da91a24c2116a6bc8b28a01ed4146a864c1c4f314d8495a1627948b000647ac0fb8c1ee02491f1bd77030b02ad7e3b927064fda464

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.rvmrc
+.ruby-version
+.ruby-gemset
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    fastshop_catalog (0.0.1)
+      savon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    gyoku (1.1.0)
+      builder (>= 2.1.2)
+    httpi (2.1.0)
+      rack
+      rubyntlm (~> 0.3.2)
+    nokogiri (1.5.10)
+    nori (2.3.0)
+    rack (1.5.2)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rubyntlm (0.3.4)
+    savon (2.3.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0, < 1.6)
+      nori (~> 2.3.0)
+      wasabi (~> 3.2.0)
+    wasabi (3.2.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0, < 1.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fastshop_catalog!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thiago Ganzarolli
+
+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,69 @@
+[![BuildStatus](https://semaphoreapp.com/api/v1/projects/1c84d1cef62189c3a446f7350568013fc8ab5551/76234/badge.png)](https://semaphoreapp.com/api/v1/projects/1c84d1cef62189c3a446f7350568013fc8ab5551/76234/badge.png)
+[![Code Climate](https://codeclimate.com/repos/521e17247e00a40bce048945/badges/a9685ebf4138c4e2e2d4/gpa.png)](https://codeclimate.com/repos/521e17247e00a40bce048945/feed)
+
+# FastshopCatalog
+
+Integrates with Fastshop's catalog webservices.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fastshop_catalog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fastshop_catalog
+
+## Testing
+
+The project was tested with ruby 1.9.3 and 2.0.0-p247.
+
+Just run:
+
+    rake
+
+To skip integration tests, pass an environment variable as follows:
+
+    integration=false rake
+
+## Usage
+
+Global parameters
+
+FastshopCatalog::BaseService.log_level, defaults to ':info'. You can change it to :debug, for example:
+
+    FastshopCatalog::BaseService.log_level = :debug
+
+FastshopCatalog::BaseService.base_url, defaults to FastshopCatalog::BaseService::DEFAULT_BASE_URL. To change it:
+
+    FastshopCatalog::BaseService.base_url = 'http://your_server_here'
+
+FastshopCatalog::BaseService.crypto_key which is described on its own section, under password generation.
+
+## Password generation for encrypted services
+
+Outside the gem, there is the PasswordUtil class, which depends on the proprietary library chilkat,
+specifically the crypto modules. This is the only way to generate a .NET compatible PBKDF1 key. The default result
+from PasswordUtil.derive_fastshop_default is already configured. If you need to change your password, follow these steps:
+
+  1) Download this gem source code
+  2) Install the chilkat gem (instructions here http://www.example-code.com/ruby/default.asp)
+  3) Invoke this method on the console, given that you're already on the project source directory:
+
+    $irb
+    > PasswordUtil.derive_fastshop_default('your new password', 'your salt')
+    => YOUR_NEW_KEY
+
+And then you can set the new default with:
+
+    FastshopCatalog::BaseService.crypto_key = 'YOUR_KEY'
+
+Notice that you might have to purchase a chilkat license if the trial does not work anymore. If you have a license you
+can invoke irb like this:
+
+    $ chilkat_license='your_license' irb

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/fastshop_catalog.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastshop_catalog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fastshop_catalog"
+  spec.version       = FastshopCatalog::VERSION
+  spec.authors       = ["Thiago Ganzarolli"]
+  spec.email         = ["thiago.ganzarolli@gmail.com"]
+  spec.description   = %q{Integração com webservices da FastShop}
+  spec.summary       = %q{FastShop integrações}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "savon"
+end

data/lib/fastshop_catalog/base_entity.rb

@@ -0,0 +1,30 @@
+module FastshopCatalog
+  class BaseEntity
+    
+    def self.translate(map)
+      #instantiates the translation map and creates accessors 
+      @translate_map = map
+      self.instance_eval do
+        map.each_key{|k| attr_accessor k}
+      end
+    end
+    
+    def self.translate_symbol(symbol)
+      @translate_map[symbol]
+    end
+    
+    def to_map
+      map = {}
+      #translates the variables to it's synonyms
+      self.class.public_instance_methods(optional=false).grep(/.*[^\=]$/).each do |m| 
+        map[self.class.translate_symbol(m.to_sym)] = self.send(m) if self.send(m)
+      end
+      #orders the map by the synonym
+      map.keys.sort.inject({}){|o, k| o[k] = map[k]; o}
+    end
+
+    def to_json(*a)
+      to_map.to_json(*a)
+    end
+  end
+end

data/lib/fastshop_catalog/base_service.rb

@@ -0,0 +1,71 @@
+module FastshopCatalog
+  class BaseService
+
+    AUX_LOG = Logger.new(STDOUT)
+    AUX_LOG.level = Logger::WARN
+
+    DEFAULT_BASE_URL = 'http://www.fastincentivos.com.br'
+
+    class << self
+      attr_accessor :log_level
+      attr_accessor :base_url
+      attr_accessor :crypto_key
+    end
+
+    def service_url
+      @service_url ||= "#{FastshopCatalog::BaseService.base_url || DEFAULT_BASE_URL}/#{@service}"
+    end
+
+    def action
+      @action ||= "#{@interface}/#{BaseService.camelize(@soap_method)}"
+    end
+
+    def self.camelize(val)
+      val.to_s.split('_').map {|w| w.capitalize}.join
+    end
+    
+    def encrypt(payload)
+      require_relative 'crypto'
+      Crypto.new.encrypt(payload.to_s)
+    end
+
+    def initialize(params={})
+      @@log_level ||= :info
+      default_params = {:wsdl => "#{service_url}?wsdl", :soap_version => 2, :namespaces => 
+        {"xmlns:x" => "http://www.w3.org/2005/08/addressing"}, :soap_header => 
+        {"x:To" => service_url, "x:Action" => "http://tempuri.org/#{action}"}, :log_level => 
+        @log_level}
+      @client = Savon.client(recursive_merge(default_params, params))
+      HTTPI.log = false
+    end
+
+    protected
+
+    def service_invoker(parameters={})
+      response = @client.call(@soap_method, :message => adapt_output(parameters))
+      result = JSON.parse(response.body["#{@soap_method}_response".to_sym]["#{@soap_method}_result".to_sym])
+      result_status = result['Retorno']
+      if result_status['IdRetorno'] != 0
+        raise ServiceException.new(:code => result_status['IdRetorno'], :description => result_status['MsgRetorno'])
+      end
+      result[@return_key]
+    end
+    
+    def service_invoker_with_encryption(encrypted_payload_key, parameters={})
+      encrypted_payload = encrypt(parameters[encrypted_payload_key])
+      FastshopCatalog::BaseService::AUX_LOG.debug('Encrypted payload: ' + encrypted_payload)
+      parameters[encrypted_payload_key] = encrypted_payload
+      service_invoker(parameters.merge(:salt => ''))
+    end
+
+    private
+
+    def adapt_output(params={}, namespace='tns')
+      Hash[params.map {|k, v| ["#{namespace}:#{k}", v] }]
+    end
+
+    def recursive_merge(h1, h2)
+      h1.merge(h2) { |k, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2) : v2 }
+    end
+  end
+end

data/lib/fastshop_catalog/catalog_service.rb

@@ -0,0 +1,17 @@
+module FastshopCatalog
+  class CatalogService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsCatalogo/Catalogo.svc/service'
+      @interface = 'ICatalogo'
+      @soap_method = :busca_catalogo
+      @return_key = 'Lista'
+      super
+    end
+
+    def search(contract_code)
+      service_invoker('contrato' => contract_code)
+    end
+
+  end
+end

data/lib/fastshop_catalog/check_availability_service.rb

@@ -0,0 +1,23 @@
+module FastshopCatalog
+  class CheckAvailabilityService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsConsultaDisponibilidade/ConsultaDisponibilidade.svc/service'
+      @interface = 'IConsultaDisponibilidade'
+      @soap_method = :retorna_dados
+      @return_key = 'Disponibilidade'
+      super(:namespaces => {'xmlns:fas' => 'http://schemas.datacontract.org/2004/07/FastServices.WsConsultaDisponibilidade.Componentes'})
+    end
+
+    def check(order)
+      root_attributes = order.to_map
+      adapted_items = []
+      root_attributes['Itens'].each do |item|
+        adapted_items << {'fas:PedidoItensEntity' => adapt_output(item.to_map)}
+      end
+      root_attributes['Itens'] = adapted_items
+      service_invoker('dadosPedido' => adapt_output(root_attributes, 'fas'))
+    end
+
+  end
+end

data/lib/fastshop_catalog/crypto.rb

@@ -0,0 +1,41 @@
+module FastshopCatalog
+
+  require 'openssl'
+  require 'base64'
+  
+  #if the iv changes, you can reconfigure it here
+  FAST_IV = [0xf, 0x6f, 0x13, 0x2e, 0x35, 0xc2, 0xcd, 0xf9, 0x5, 0x46, 0x9c, 0xea, 0xa8, 0x4b, 0x73, 0xcc]
+  #if this key changes, check the readme for instructions
+  DEFAULT_KEY = 'D027CF4E32A9A69363DB9D72234F97B4'
+  
+  class Crypto
+    
+    def initialize(key=FastshopCatalog::Crypto.default_key, iv=FastshopCatalog::Crypto.default_iv)
+      @cypher = OpenSSL::Cipher::Cipher.new("AES-128-CBC")
+      @cypher.encrypt
+      @cypher.key = key
+      @cypher.iv = iv
+    end
+
+    def encrypt(payload)
+      encrypted = @cypher.update(payload) << @cypher.final
+      Base64.strict_encode64(encrypted)
+    end
+    
+    private
+
+    def self.hex_to_bin(s) 
+      s.scan(/../).map { |x| x.hex.chr }.join
+    end
+
+    def self.default_iv
+      @@default_iv ||= FAST_IV.map{|x| x.chr}.join('')
+    end
+    
+    def self.default_key
+      @@default_key ||= hex_to_bin(DEFAULT_KEY)
+    end
+
+  end
+
+end

data/lib/fastshop_catalog/entity/address.rb

@@ -0,0 +1,30 @@
+module FastshopCatalog
+  module Entity
+    class Address < BaseEntity
+
+      HOME_TYPE_HOUSE = '1'
+      HOME_TYPE_APARTMENT = '2'
+      HOME_TYPE_CONDO = '3'
+      HOME_TYPE_COMPANY = '4'
+
+      HOME_TYPE_DESCRIPTION_MAP = {'1' => 'CASA', '2' => 'APARTAMENTO',
+        '3' => 'CONDOMINIO', '4' => 'EMPRESA'}
+
+      translate :description => 'Descricao', 
+      :address_type => 'TipoEndereco', :document => 'CPF', :registry => 'RG',
+      :birth_date => 'DataNascimento', :address => 'Endereco', 
+      :number => 'Numero', :complement => 'Complemento',
+      :neighborhood  => 'Bairro', :city => 'Cidade',
+      :state => 'Estado', :zip_code => 'Cep',
+      :home_type_id => 'TipoMoradiaId', 
+      :home_type_description => 'TipoMoradiaDescricao'
+      
+      def home_type=(home_type)
+        raise ArgumentError.new('Invalid home type') unless (1..4).member? home_type.to_i
+        self.home_type_id = home_type
+        self.home_type_description = HOME_TYPE_DESCRIPTION_MAP[home_type]
+      end
+
+    end
+  end
+end

data/lib/fastshop_catalog/entity/business_unity.rb

@@ -0,0 +1,9 @@
+module FastshopCatalog
+  module Entity
+    class BusinessUnity < BaseEntity
+      translate :company_document => 'Cnpj',
+      :company_name => 'RazaoSocial',
+      :trading_name => 'Fantasia'
+    end
+  end
+end

data/lib/fastshop_catalog/entity/order.rb

@@ -0,0 +1,12 @@
+module FastshopCatalog
+  module Entity
+    class Order < BaseEntity
+      translate :contract_code => 'Contrato', 
+      :partner_order_number => 'NumeroPedidoParceiro', :document => 'Cpf',
+      :zip_code => 'Cep', :number => 'Numero', :total_amount => 'ValorTotal',
+      :delivery_type => 'TipoEntrega', :delivery_date => 'DataEntrega',
+      :period_id => 'PeriodoId', :period_name => 'PeriodoNome',
+      :items => 'Itens'
+    end
+  end
+end

data/lib/fastshop_catalog/entity/order_item.rb

@@ -0,0 +1,7 @@
+module FastshopCatalog
+  module Entity
+    class OrderItem < BaseEntity
+      translate :sku => 'Sku', :price => 'ValorUnitario', :quantity => 'Quantidade'
+    end
+  end
+end

data/lib/fastshop_catalog/entity/participant.rb

@@ -0,0 +1,15 @@
+module FastshopCatalog
+  module Entity
+    class Participant < BaseEntity
+      translate :contract_code => 'Contrato', 
+      :name => 'Nome', :document => 'Cpf', :registry => 'RG',
+      :birth_date => 'DataNascimento', :gender => 'Sexo', 
+      :category => 'Categoria',
+      :home_phone_prefix => 'DddResidencial', :home_phone => 'TelefoneResidencial',
+      :work_phone_prefix => 'DddComercial', :work_phone => 'TelefoneComercial',
+      :mobile_phone_prefix => 'DddCelular', :mobile_phone => 'Celular',
+      :email => 'Email', :status => 'Status', :operation_type => 'TipoOperacao',
+      :address => 'Endereco', :business_unity => 'UnidadeNegocio'
+    end
+  end
+end

data/lib/fastshop_catalog/external_dne_service.rb

@@ -0,0 +1,17 @@
+module FastshopCatalog
+  class ExternalDneService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsConsultaDneExterno/ConsultaDneExterno.svc/service'
+      @interface = 'IConsultaDneExterno'
+      @soap_method = :consultar
+      @return_key = 'Dne'
+      super
+    end
+
+    def query(contract_code, zip_code)
+      service_invoker('cep' => zip_code, 'contrato' => contract_code)
+    end
+
+  end
+end

data/lib/fastshop_catalog/order_placement_service.rb

@@ -0,0 +1,20 @@
+module FastshopCatalog
+  class OrderPlacementService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsColocacaoPedido/ColocacaoPedido.svc/service'
+      @interface = 'IColocacaoPedido'
+      @soap_method = :incluir_pedido
+      @return_key = 'NumeroPedidoFast'
+      super
+    end
+
+    def place_order(order)
+      payload = order.to_json.to_s
+      AUX_LOG.debug('Order as json: ' + payload)
+      service_invoker_with_encryption('entrada', 'contrato' => order.contract_code, 
+      'entrada' => payload)
+    end
+
+  end
+end

data/lib/fastshop_catalog/order_status_service.rb

@@ -0,0 +1,18 @@
+module FastshopCatalog
+  class OrderStatusService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsConsultaStatusPedido/ConsultaStatusPedido.svc/service'
+      @interface = 'IConsultaStatusPedido'
+      @soap_method = :retorna_dados
+      @return_key = 'Lista'
+      super
+    end
+
+    def check(contract_code, order_number, partner_order_number)
+      service_invoker('numeroPedidoFast' => order_number, 'numeroPedidoParceiro' => partner_order_number,
+      'contrato' => contract_code)
+    end
+
+  end
+end

data/lib/fastshop_catalog/participant_service.rb

@@ -0,0 +1,20 @@
+module FastshopCatalog
+  class ParticipantService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsParticipante/Participante.svc/service'
+      @interface = 'IParticipante'
+      @soap_method = :cadastrar_participante
+      @return_key = 'Token'
+      super
+    end
+
+    def insert(participant)
+      payload = participant.to_json.to_s
+      AUX_LOG.debug('Participant as json: ' + payload)
+      service_invoker_with_encryption('entrada', 'contrato' => participant.contract_code, 
+      'entrada' => payload)
+    end
+
+  end
+end

data/lib/fastshop_catalog/product_service.rb

@@ -0,0 +1,17 @@
+module FastshopCatalog
+  class ProductService < FastshopCatalog::BaseService
+
+    def initialize
+      @service = 'FastServices.WsConsultaProduto/ConsultaProduto.svc/service'
+      @interface = 'IConsultaProduto'
+      @soap_method = :busca_produto
+      @return_key = 'ProdutoDados'
+      super
+    end
+
+    def search(contract_code, sku)
+      service_invoker('contrato' => contract_code, 'sku' => sku)
+    end
+
+  end
+end

data/lib/fastshop_catalog/service_exception.rb

@@ -0,0 +1,11 @@
+module FastshopCatalog
+  class ServiceException < Exception
+    attr_accessor :code, :description
+
+    def initialize(params={})
+      @code = params[:code]
+      @description = params[:description]
+    end
+
+  end
+end

data/lib/fastshop_catalog/time.rb

@@ -0,0 +1,15 @@
+module FastshopCatalog
+
+  class Time < Time
+    def to_json(*a)
+      date_serializer(self)
+    end
+
+    protected
+    # .NET compatible formatter
+    def date_serializer(datetime)
+      "\"\\/Date(#{(datetime.to_f*1000).to_i}#{datetime.utc_offset})\\/\""
+    end
+
+  end
+end

data/lib/fastshop_catalog/version.rb

@@ -0,0 +1,3 @@
+module FastshopCatalog
+  VERSION = "0.0.1"
+end

data/lib/fastshop_catalog.rb

@@ -0,0 +1,20 @@
+require "savon"
+require "json"
+require_relative "fastshop_catalog/version"
+require_relative "fastshop_catalog/base_entity"
+require_relative "fastshop_catalog/time"
+require_relative "fastshop_catalog/entity/order"
+require_relative "fastshop_catalog/entity/order_item"
+require_relative "fastshop_catalog/entity/participant"
+require_relative "fastshop_catalog/entity/address"
+require_relative "fastshop_catalog/entity/business_unity"
+require_relative "fastshop_catalog/base_service"
+require_relative "fastshop_catalog/catalog_service"
+require_relative "fastshop_catalog/product_service"
+require_relative "fastshop_catalog/external_dne_service"
+require_relative "fastshop_catalog/order_placement_service"
+require_relative "fastshop_catalog/check_availability_service"
+require_relative "fastshop_catalog/order_status_service"
+require_relative "fastshop_catalog/participant_service"
+require_relative "fastshop_catalog/service_exception"
+HTTPI.log_level = :info