kauplus 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

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

data/kauplus.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kauplus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kauplus"
+  s.version     = Kauplus::VERSION
+  s.authors     = ["Kauplus Social Commerce"]
+  s.email       = ["suporte@kauplus.com.br"]
+  s.homepage    = "http://dev.kauplus.com.br/"
+  s.summary     = %q{Kauplus - Cliente da API}
+  s.description = %q{Esta gem é um cliente que permite desenvolvedores se conectarem aos web services do Kauplus.}
+
+  s.rubyforge_project = "kauplus"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # dependencies
+  s.add_dependency 'rest-client', '>= 1.6.6'
+  s.add_dependency 'activesupport', '>= 3.1.0'
+end

data/lib/kauplus.rb

@@ -0,0 +1,9 @@
+require 'kauplus/api'
+require 'kauplus/client'
+require 'kauplus/config'
+require 'kauplus/constants'
+require 'kauplus/error'
+require "kauplus/version"
+
+module Kauplus
+end

data/lib/kauplus/api.rb

@@ -0,0 +1,22 @@
+module Kauplus
+  
+  #
+  # Kauplus.api references to Kauplus::API
+  #
+  def self.api
+    API
+  end
+  
+  class API
+    
+    
+    #
+    # Enables dynamic programming for the generation of HTTP resources.
+    #
+    def self.method_missing(method_name, *args)
+      Client.new :resource => method_name
+    end
+    
+  end
+  
+end

data/lib/kauplus/client.rb

@@ -0,0 +1,116 @@
+require 'active_support/core_ext'
+require 'rest_client'
+
+module Kauplus
+  
+  class Client
+    
+    attr_accessor :resource
+    
+    #
+    # Creates a new client with its resource_method.
+    #
+    def initialize args = {}
+      self.resource = args[:resource] || ''
+    end
+    
+    #
+    # Enables dynamic programming for the generation of HTTP methods.
+    #
+    def method_missing(method_name, *args)
+      payload = Kauplus::Client.authenticate_payload(args.first)
+      if method_name.match(/(get|post|multipart_post|put|delete|head)_(.*)/)
+        Kauplus::Client.send($1, "#{@resource}/#{$2}", payload)
+      else
+        Kauplus::Client.get("#{@resource}/#{method_name}", payload)
+      end
+    end
+    
+    #
+    # Private methods.
+    #
+    private
+    
+    #
+    # Sends an HTTP GET Request to the Kauplus Web Services
+    # and parses the json response.
+    #
+    def self.get(resource_method, payload = {})
+      url = payload.empty? ? url_for_resource_method(resource_method) : "#{url_for_resource_method(resource_method)}?#{payload.to_query}"
+      parse_json RestClient.get(url)
+    end
+
+    #
+    # Sends an HTTP POST Request to the Kauplus Web Services
+    # and parses the json response.
+    #
+    def self.post(resource_method, payload)
+      parse_json RestClient.post(url_for_resource_method(resource_method), payload.to_query)
+    end
+    
+    #
+    # Sends an HTTP MULTIPART POST Request to the Kauplus Web Services
+    # and parses the json response.
+    #
+    def self.multipart_post(resource_method, payload)
+      self.post(resource_method, payload.merge(:multipart => true))
+    end
+
+    #
+    # Sends an HTTP PUT Request to the Kauplus Web Services
+    # and parses the json response.
+    #
+    def self.put(resource_method, payload)
+      parse_json RestClient.put(url_for_resource_method(resource_method), payload.to_query)
+    end
+
+    #
+    # Sends an HTTP DELETE Request to the Kauplus Web Services
+    # and parses the json response.
+    #
+    def self.delete(resource_method, payload = {})
+      parse_json RestClient.delete("#{url_for_resource_method(resource_method)}?#{payload.to_query}")
+    end
+
+    #
+    # Sends an HTTP HEAD Request to the Kauplus Web Services.
+    #
+    def self.head(resource_method, payload = {})
+      RestClient.head("#{url_for_resource_method(resource_method)}?#{payload.to_query}")
+    end
+    
+    #
+    # Authenticates the payload by adding the api_key argument to it.
+    #
+    def self.authenticate_payload(payload)
+      if payload.blank?
+        payload = {}
+      end
+      if payload[:api_key].blank? and payload['api_key'].blank?
+        payload[:api_key] = Kauplus.config.api_key
+      end
+      payload
+    end
+    
+    #
+    # Returns the URL for consuming a specific resource_method.
+    #
+    def self.url_for_resource_method(resource_method)
+      "https://shop.kauplus.com.br/#{resource_method}"
+    end
+    
+    #
+    # Parses the json response.
+    # Raises a Kauplus::Error if the response is invalid and raise errors is active.
+    #
+    def self.parse_json body
+      parsed_response = JSON.load(body).symbolize_keys
+      if Kauplus.config.raise_errors and parsed_response[:code].to_s[0] != '6'
+        raise Kauplus::Error.new(:code => parsed_response[:code], :error => parsed_response[:error], :messages => parsed_response[:messages])
+      end
+      parsed_response
+    end
+    
+  end
+  
+end

data/lib/kauplus/config.rb

@@ -0,0 +1,40 @@
+require 'singleton'
+
+module Kauplus
+
+  def self.config
+    Kauplus::Config.instance
+  end
+
+  #
+  # Private.
+  #
+  private
+  
+  class Config
+    include Singleton
+  
+    attr_accessor :api_key, :raise_errors
+    
+    #
+    # Private methods.
+    #
+    private
+    
+    def initialize
+      # load YAML config if possible
+      if defined? Rails
+        path = "#{Rails.root}/config/kauplus.yml"
+        env = Rails.env
+      else
+        path = "#{Dir.pwd}/config/kauplus.yml"
+        env = 'kauplus'
+      end
+      conf = File.exists?(path) ? YAML.load_file(path)[env] : {}
+      self.api_key = conf['api_key']
+      self.raise_errors = conf['raise_errors'] || false
+    end
+  
+  end
+
+end

data/lib/kauplus/constants.rb

@@ -0,0 +1,102 @@
+module Kauplus
+  
+  #
+  # Constants
+  #
+  
+  #
+  # Conditions of a product
+  #
+  CONDITION = {
+    :new      => 1, # Novo
+    :used     => 2, # Usado
+    :seminew  => 3  # Seminovo
+  }
+  
+  #
+  # Available shipping methods
+  #
+  SHIPPING = {
+    :no   => 1, # Sem frete
+    :free => 2, # Frete grátis
+    :paid => 3  # Frete pago
+  }
+  
+  #
+  # Paid shipping methods
+  #
+  PAID_SHIPPING = {
+    :fixed            => 1, # Frete fixo
+    :additional_fixed => 2, # Frete adicional com valor fixo
+    :correios         => 3  # Frete dos correios
+  }
+  
+  #
+  # Shipping package formats
+  #  
+  PACKAGE_FORMAT = {
+    :box      => 1, # Caixa/Pacote
+    :cylinder => 2 # Rolo/Prisma
+  }
+  
+  #
+  # Correios Web Services types and codes
+  #
+  CORREIOS_SERVICES_TYPES = {
+    :pac=>[41106, "PAC sem contrato"],
+    :sedex=>[40010, "SEDEX sem contrato"],
+    :sedex_a_cobrar=>[40045, "SEDEX a Cobrar, sem contrato"],
+    :sedex_a_cobrar_com_contrato=>[40126, "SEDEX a Cobrar, com contrato"],
+    :sedex_10=>[40215, "SEDEX 10, sem contrato"],
+    :sedex_hoje=>[40290, "SEDEX Hoje, sem contrato"],
+    :sedex_com_contrato_1=>[40096, "SEDEX com contrato"],
+    :sedex_com_contrato_2=>[40436, "SEDEX com contrato"],
+    :sedex_com_contrato_3=>[40444, "SEDEX com contrato"],
+    :sedex_com_contrato_4=>[40568, "SEDEX com contrato"],
+    :sedex_com_contrato_5=>[40606, "SEDEX com contrato"],
+    :e_sedex_com_contrato=>[81019, "e-SEDEX, com contrato"],
+    :pac_com_contrato=>[41068, "PAC com contrato"],
+    :e_sedex_com_contrato_grupo_1=>[81868, "(Grupo 1) e-SEDEX, com contrato"],
+    :e_sedex_com_contrato_grupo_2=>[81833, "(Grupo 2) e-SEDEX, com contrato"],
+    :e_sedex_com_contrato_grupo_3=>[81850, "(Grupo 3) e-SEDEX, com contrato"]
+  }
+  
+  CORREIOS_SERVICES_CODES = Hash[CORREIOS_SERVICES_TYPES.map {|k,v| [ v[0], [k, v[1]] ] } ]   
+  
+  #
+  # Order possible statuses
+  #
+  ORDER_STATUS = {
+    :order_received               => 1,
+    :waiting_payment_confirmation => 2,
+    :payment_confirmed            => 3,
+    :shipped                      => 4,
+    :canceled                     => 5,
+    :finished                     => 6
+  }
+    
+  #
+  # Possible events for an order
+  #
+  ORDER_EVENT = {
+    :receive_order    => 1,
+    :wait_payment     => 2,
+    :confirm_payment  => 3,
+    :reject_payment   => 4,
+    :confirm_shipping => 5,
+    :confirm_delivery => 6
+  }
+  
+  #
+  # Wizard status
+  #
+  WIZARD_STATUS = {
+    :store_created    => 1,
+    :store_setup      => 2,
+    :shipping_setup   => 3,
+    :categories_setup => 4,
+    :products_setup   => 5,
+    :store_active     => 6
+  }
+  
+end

data/lib/kauplus/error.rb

@@ -0,0 +1,18 @@
+module Kauplus
+  class Error < StandardError
+    
+    attr_accessor :code, :error, :messages
+    
+    def initialize(args = {})
+      @code = args[:code]
+      @error = args[:error]
+      @messages = args[:messages]
+      super(@error)
+    end
+    
+    def to_s
+      "(#{@code}) #{super}"
+    end
+    
+  end
+end

data/lib/kauplus/version.rb

@@ -0,0 +1,3 @@
+module Kauplus
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: kauplus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kauplus Social Commerce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2156325300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156325300
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2156317860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156317860
+description: Esta gem é um cliente que permite desenvolvedores se conectarem aos web
+  services do Kauplus.
+email:
+- suporte@kauplus.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- kauplus.gemspec
+- lib/kauplus.rb
+- lib/kauplus/api.rb
+- lib/kauplus/client.rb
+- lib/kauplus/config.rb
+- lib/kauplus/constants.rb
+- lib/kauplus/error.rb
+- lib/kauplus/version.rb
+homepage: http://dev.kauplus.com.br/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: kauplus
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Kauplus - Cliente da API
+test_files: []