mooamba 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*~
+*.sw*
+.rvmrc
+.bundle

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "sax-machine"
+gem "nokogiri"
+
+group :test do
+  gem "jeweler"
+  gem "rspec"
+  gem "fakeweb"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    nokogiri (1.4.3.1)
+    rspec (1.3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sax-machine (0.0.15)
+      nokogiri (> 0.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  jeweler
+  nokogiri
+  rspec
+  sax-machine

data/README.markdown

@@ -0,0 +1,36 @@
+## ABOUT
+
+Ruby API to calculate shipping cost from Correios site by CEP. Currently it supports only Sedex.
+
+## USAGE
+
+You must inform 3 parameters: from, to and weight (Kg)
+
+    sedex = Mooamba::Sedex.calculate(:from => "04548-040", :to => "05414-000", :weight => "5")
+    sedex.price
+    => 14,40
+
+## LICENSE
+
+(The MIT License)
+
+Copyright © 2010
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+ENV['RSPEC_COLOR'] = 'true'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mooamba"
+    gemspec.version = "0.0.1"
+    gemspec.summary = ""
+    gemspec.description = ""
+    gemspec.homepage = "http://github.com/gonow/mooamba"
+    gemspec.authors = ["GoNow"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+

data/build.sh

@@ -0,0 +1,2 @@
+bundle install
+rake spec

data/lib/mooamba/core_ext.rb

@@ -0,0 +1,25 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end
+
+class Hash
+  def to_query_string
+    self.map { |k, v| "#{k}=#{v}" }.join("&")
+  end
+end
+
+class String
+  def blank?
+    self !~ /\S/
+  end
+
+  def invalid?
+    self !~ /^\d{5}-\d{3}$/
+  end
+
+  def clean
+    self.gsub "-", ""
+  end
+end

data/lib/mooamba/exceptions.rb

@@ -0,0 +1,14 @@
+module Mooamba
+  module Correios
+    class InvalidOriginZipCode < StandardError; end
+    class InvalidDestinyZipCode < StandardError; end
+    class InvalidWeight < StandardError; end
+    class UnavailableServiceForArea < StandardError; end
+    class UnavailableService < StandardError; end
+    class UnknownError < StandardError; end
+  end
+
+  class InvalidDestinationZipCode < StandardError; end
+  class InvalidOriginZipCode < StandardError; end
+  class UnavailableAPI < StandardError; end
+end

data/lib/mooamba/sedex.rb

@@ -0,0 +1,66 @@
+module Mooamba 
+  module Correios
+    API_URL = "http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx?"
+  end
+
+  class Sedex
+    include SAXMachine
+
+    CODE = 40010
+
+    DEFAULT_PARAMS = {
+      :nCdServico => CODE,
+      :StrRetorno => "XML"
+    }
+
+    element "Valor", :as => :price
+    element "Erro", :as => :error
+    element "cServico", :as => :service
+
+    def self.calculate(options={})
+      raise InvalidOriginZipCode if invalid_cep?(options[:from])
+      raise InvalidDestinationZipCode if invalid_cep?(options[:to])
+      response = response_for options
+      error?(response) ? (raise exception(response)) : response
+    end
+
+    private
+
+    def self.parameters_from(options)
+      translate(options).merge DEFAULT_PARAMS
+    end
+
+    def self.translate(options)
+      { :sCepOrigem => options[:from].clean,
+        :sCepDestino => options[:to].clean,
+        :nVlPeso => options[:weight] }
+    end
+
+    def self.response_for(options)
+      parse open(URI.escape(Correios::API_URL + parameters_from(options).to_query_string)).read
+    end
+
+    def self.exception(response)
+      if response.service.nil?
+        Mooamba::UnavailableAPI 
+      else
+        case response.error
+        when "-2"; Mooamba::Correios::InvalidOriginZipCode
+        when "-3"; Mooamba::Correios::InvalidDestinyZipCode
+        when "-4"; Mooamba::Correios::InvalidWeight
+        when "-6"; Mooamba::Correios::UnavailableServiceForArea
+        when "7"; Mooamba::Correios::UnavailableService
+        else; Mooamba::Correios::UnknownError
+        end
+      end
+    end
+
+    def self.error?(response)
+      response.error != "0"
+    end
+
+    def self.invalid_cep?(cep)
+      cep.blank? or cep.invalid?
+    end
+  end
+end

data/lib/mooamba.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'open-uri'
+require 'sax-machine'
+
+Dir.glob(File.dirname(__FILE__) + '/mooamba/*.rb').each { |file| require file }

data/mooamba.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mooamba}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["GoNow"]
+  s.date = %q{2010-09-23}
+  s.description = %q{}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "README.markdown",
+     "Rakefile",
+     "build.sh",
+     "lib/mooamba.rb",
+     "lib/mooamba/core_ext.rb",
+     "lib/mooamba/exceptions.rb",
+     "lib/mooamba/sedex.rb",
+     "mooamba.gemspec",
+     "spec/data/invalid.xml",
+     "spec/data/invalid_destiny.xml",
+     "spec/data/invalid_origin.xml",
+     "spec/data/invalid_weight.xml",
+     "spec/data/malformed.xml",
+     "spec/data/unavailable_service.xml",
+     "spec/data/unavailable_service_for_area.xml",
+     "spec/data/valid.xml",
+     "spec/mooamba/sedex_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gonow/mooamba}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{}
+  s.test_files = [
+    "spec/mooamba/sedex_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/data/invalid.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>-10</Erro>
+    <MsgErro>Precificação indisponível para o trecho informado.</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/invalid_destiny.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>-3</Erro>
+    <MsgErro>CEP de destino invalido.</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/invalid_origin.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>-2</Erro>
+    <MsgErro>CEP de origem invalido.</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/invalid_weight.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>-4</Erro>
+    <MsgErro>Peso excedido.</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/malformed.xml

@@ -0,0 +1 @@
+-

data/spec/data/unavailable_service.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>7</Erro>
+    <MsgErro>Serviço indisponível, tente mais tarde.</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/unavailable_service_for_area.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>0,00</Valor>
+    <PrazoEntrega>0</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar></EntregaDomiciliar>
+    <EntregaSabado></EntregaSabado>
+    <Erro>-6</Erro>
+    <MsgErro>Serviço indisponível para o trecho informado</MsgErro>
+  </cServico>
+</Servicos>

data/spec/data/valid.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<Servicos>
+  <cServico>
+    <Codigo>40010</Codigo>
+    <Valor>11,80</Valor>
+    <PrazoEntrega>1</PrazoEntrega>
+    <ValorMaoPropria>0,00</ValorMaoPropria>
+    <ValorAvisoRecebimento>0,00</ValorAvisoRecebimento>
+    <ValorValorDeclarado>0,00</ValorValorDeclarado>
+    <EntregaDomiciliar>S</EntregaDomiciliar>
+    <EntregaSabado>S</EntregaSabado>
+    <Erro>0</Erro>
+    <MsgErro></MsgErro>
+  </cServico>
+</Servicos>

data/spec/mooamba/sedex_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mooamba::Sedex do
+  before :all do
+    @default_parameters = { :from => VALID_ZIP_CODES.first,
+                            :to => VALID_ZIP_CODES.last,
+                            :weight => 1 }
+    map_parameters_to_file(@default_parameters, "valid")
+  end
+
+  context "on .calculdate" do
+    it "should use the Sedex service" do
+      Mooamba::Sedex.should_receive(:open).with(/nCdServico\=40010/).and_return(valid_xml_file)
+      Mooamba::Sedex.calculate(@default_parameters)
+    end
+
+    it "should return the price as #price" do
+      Mooamba::Sedex.calculate(@default_parameters).price.should eql "11,80"
+    end
+
+    it "should raise Mooamba::InvalidOriginZipCode when there's no origin zip code" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.except(:from)) }.should raise_error(Mooamba::InvalidOriginZipCode)
+    end
+
+    it "should raise Mooamba::InvalidDestinationZipCode when there's no destiny zip code" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.except(:to)) }.should raise_error(Mooamba::InvalidDestinationZipCode)
+    end
+
+    it "should raise Mooamba::InvalidOriginZipCode when the origin zip code is blank" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.merge(:from => "")) }.should raise_error(Mooamba::InvalidOriginZipCode)
+    end
+
+    it "should raise Mooamba::InvalidDestinationZipCode when the destiny zip code is blank" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.merge(:to => "")) }.should raise_error(Mooamba::InvalidDestinationZipCode)
+    end
+
+    it "should raise Mooamba::InvalidOriginZipCode when the origin zip code is invalid" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.merge(:from => INVALID_ZIP_CODES.last)) }.should raise_error(Mooamba::InvalidOriginZipCode)
+    end
+
+    it "should raise Mooamba::InvalidDestinationZipCode when the destiny zip code is invalid" do
+      lambda { Mooamba::Sedex.calculate(@default_parameters.merge(:to => INVALID_ZIP_CODES.first)) }.should raise_error(Mooamba::InvalidDestinationZipCode)
+    end
+
+    it "should raise Mooamba::UnavailableAPI when api returns unexpected content" do
+      map_parameters_to_file(@default_parameters, "malformed")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::UnavailableAPI)
+    end
+
+    it "should raise Mooamba::Correios::UnavaibleService when api returns service unavailable" do
+      map_parameters_to_file(@default_parameters, "unavailable_service")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::UnavailableService)
+    end
+
+    it "should raise Mooamba::Correios::InvalidOriginZipCode when the invalid origin zip code doesn't exist" do
+      map_parameters_to_file(@default_parameters, "invalid_origin")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::InvalidOriginZipCode)
+    end
+
+    it "should raise Mooamba::Correios::InvalidDestinyZipCode when the invalid destiny zip code doesn't exist" do
+      map_parameters_to_file(@default_parameters, "invalid_destiny")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::InvalidDestinyZipCode)
+    end
+
+    it "should raise Mooamba::Correios::InvalidWeight when the weight if excessive" do
+      map_parameters_to_file(@default_parameters, "invalid_weight")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::InvalidWeight)
+    end
+
+    it "should raise Mooamba::Correios::UnavailableServiceForArea when the service is unavailable for the current area" do
+      map_parameters_to_file(@default_parameters, "unavailable_service_for_area")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::UnavailableServiceForArea)
+    end
+
+    it "should raise Mooamba::Correios::UnknownError when an unknown error happened" do
+      map_parameters_to_file(@default_parameters, "invalid")
+      lambda { Mooamba::Sedex.calculate(@default_parameters) }.should raise_error(Mooamba::Correios::UnknownError)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format
+specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
+require 'mooamba'
+
+Spec::Runner.configure do |config|
+  FakeWeb.allow_net_connect = false
+end
+
+VALID_ZIP_CODES = %w(04548-040 01310-100)
+INVALID_ZIP_CODES = %w(0 00)
+
+def map_parameters_to_file(options, file)
+  parameters = {
+    :sCepOrigem => options[:from].gsub("-", ""),
+    :sCepDestino => options[:to].gsub("-", ""),
+    :nVlPeso => options[:weight],
+    :StrRetorno => "XML"
+  }.merge Mooamba::Sedex::DEFAULT_PARAMS
+
+  FakeWeb.register_uri(:get, URI.escape(Mooamba::Correios::API_URL + parameters.to_query_string), :body => data(file).read)
+end
+
+def valid_xml_file
+  data "valid"
+end
+
+def data(name)
+  File.open("#{File.dirname(__FILE__)}/data/#{name}.xml")
+end
+
+class Hash
+  def except(*blacklist)
+    {}.tap do |h|
+      (keys - blacklist).each { |k| h[k] = self[k] }
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mooamba
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- GoNow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- build.sh
+- lib/mooamba.rb
+- lib/mooamba/core_ext.rb
+- lib/mooamba/exceptions.rb
+- lib/mooamba/sedex.rb
+- mooamba.gemspec
+- spec/data/invalid.xml
+- spec/data/invalid_destiny.xml
+- spec/data/invalid_origin.xml
+- spec/data/invalid_weight.xml
+- spec/data/malformed.xml
+- spec/data/unavailable_service.xml
+- spec/data/unavailable_service_for_area.xml
+- spec/data/valid.xml
+- spec/mooamba/sedex_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gonow/mooamba
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- spec/mooamba/sedex_spec.rb
+- spec/spec_helper.rb