stamps 0.2.0

data/test/fixtures/InsufficientPostage.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <soap:Fault>
+      <faultcode>soap:Server</faultcode>
+      <faultstring>Insufficient Postage</faultstring>
+      <faultactor>https://swsim.testing.stamps.com/swsim/swsimv12.asmx</faultactor>
+      <detail>
+        <sdcerror code="80040414" xmlns="http://stamps.com/xml/namespace/2008/01/fault">Insufficient Postage</sdcerror>
+        <authenticator xmlns="http://stamps.com/xml/namespace/2008/01/fault">exp=1305501129&amp;uid=2745084&amp;cty=swsim&amp;ctk=c95RLEdT0mD2bvRUvdvrkFegFU0=&amp;iid=J877UP/dP0qTQCRj3F421g==&amp;rsid=0&amp;eac=1820294591&amp;eacx=194559&amp;rrsid=0&amp;raid=0&amp;resellerid=0&amp;mac=rp93YQqG1Kix/+RAhddzSv4M4PM=</authenticator>
+      </detail>
+    </soap:Fault>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/InvalidSoap.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <soap:Fault>
+      <faultcode>soap:Client</faultcode>
+      <faultstring>Invalid SOAP message due to XML Schema validation failure. The 'http://stamps.com/xml/namespace/2010/11/swsim/swsimv12:ServiceType' element is invalid - The value 'US-KI' is invalid according to its datatype 'http://stamps.com/xml/namespace/2010/11/swsim/swsimv12:ServiceType' - The Enumeration constraint failed.</faultstring>
+      <faultactor>https://swsim.testing.stamps.com/swsim/swsimv12.asmx</faultactor>
+      <detail>
+        <stamps_exception code="00490102" xmlns="http://stamps.com/xml/namespace/2008/02/stamps/fault" />
+      </detail>
+    </soap:Fault>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/PurchasePostage.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <PurchasePostageResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>AlLpXHensVNYPEHFaG8OS+kNd/4=</Authenticator>
+      <PurchaseStatus>Pending</PurchaseStatus>
+      <TransactionID>66919357</TransactionID>
+      <PostageBalance>
+        <AvailablePostage>23.4300</AvailablePostage>
+        <ControlTotal>60.00</ControlTotal>
+      </PostageBalance>
+      <RejectionReason>order being processed</RejectionReason>
+      <MIRequired>false</MIRequired>
+    </PurchasePostageResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/TrackShipment.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <TrackShipmentResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>***authenticator***</Authenticator>
+      <TrackingEvents>
+        <TrackingEvent>
+          <Timestamp>2008-02-19T10:32:00</Timestamp>
+          <Event>DELIVERED</Event>
+          <TrackingEventType>Delivered</TrackingEventType>
+          <City>FORT WAYNE</City>
+          <State>IN</State>
+          <Zip>46809</Zip>
+          <Country>US</Country>
+          <SignedBy />
+          <AuthorizedAgent>true</AuthorizedAgent>
+        </TrackingEvent>
+        <TrackingEvent>
+          <Timestamp>2008-02-15T16:58:00</Timestamp>
+          <Event>PROCESSED</Event>
+          <TrackingEventType>Enroute</TrackingEventType>
+          <City>INDIANAPOLIS</City>
+          <State>IN</State>
+          <Zip>46206</Zip>
+          <Country>US</Country>
+          <SignedBy />
+          <AuthorizedAgent>true</AuthorizedAgent>
+        </TrackingEvent>
+        <TrackingEvent>
+          <Timestamp>2008-02-13T16:09:00</Timestamp>
+          <Event>Electronic Notification</Event>
+          <TrackingEventType>ElectronicNotification</TrackingEventType>
+          <City />
+          <State />
+          <Zip>90066</Zip>
+          <Country>US</Country>
+          <SignedBy />
+          <AuthorizedAgent>true</AuthorizedAgent>
+        </TrackingEvent>
+      </TrackingEvents>
+    </TrackShipmentResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/helper.rb

@@ -0,0 +1,58 @@
+require "bundler"
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.merge_timeout 3600
+SimpleCov.start do
+  add_group 'Stamps', 'lib/stamps'
+end
+
+require 'mocha'
+require 'test/unit'
+require 'stamps'
+require 'shoulda'
+require 'webmock/test_unit'
+require 'json'
+require 'multi_json'
+require 'awesome_print'
+
+Stamps.configure do |config|
+  config.integration_id = 'XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
+  config.username       = 'USERNAME'
+  config.password       = 'PASSXXXX'
+  config.endpoint       = 'https://stamps.example.com/swsim/swsimv12.asmx'
+  config.return_address  = {
+    :full_name    => 'Big E-commerce Company',
+    :address1     => '500 Wall Street',
+    :address2     => 'Suite 234',
+    :city         => 'New York',
+    :state        => 'NY',
+    :zip_code     => '10004',
+    :phone_number => '9375551234'
+  }
+end
+
+# Stub requests
+def stub_post(web_method, soap_action = nil)
+  soap_action = web_method if soap_action.nil?
+  stub_request(:post, Stamps.endpoint).
+    with(:headers => {"SoapAction" => "#{Stamps.namespace}/#{soap_action}"}).
+    to_return(:body => fixture("#{web_method}.xml"))
+end
+
+def stub_response(web_method, code = 200)
+  http_response = HTTPI::Response.new(code, {}, fixture("#{web_method}.xml").read)
+  Stamps::Response.new(Savon::SOAP::Response.new(http_response))
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+Savon.configure do |config|
+  config.log = false # disable logging
+end

data/test/mapping_test.rb

@@ -0,0 +1,33 @@
+$:.unshift File.dirname(__FILE__) # allows command line to execute tests
+require 'helper'
+
+class MappingTest < Test::Unit::TestCase
+
+  context 'a new instance' do
+
+    setup do
+      @rate = Stamps::Mapping::Rate.new({
+          :from_zip_code => '45440',
+          :to_zip_code   => '45458',
+          :weight_oz     => '7.8',
+          :package_type  => 'Package',
+          :service_type  => 'US-PM',
+          :add_ons       => {
+            :add_on => [
+              { :amount  => '2.30', :type => 'US-A-RR' },
+              { :amount  => '0.19', :type => 'US-A-DC' }
+            ]
+          }
+        })
+    end
+
+    should 'map :to property fields' do
+      assert_equal @rate.to_hash['FromZIPCode'], '45440'
+      assert_equal @rate.to_hash['ToZIPCode'], '45458'
+      assert_equal @rate.to_hash['WeightOz'], '7.8'
+      assert_equal @rate.to_hash['PackageType'], 'Package'
+      assert_equal @rate.to_hash['ServiceType'], 'US-PM'
+    end
+
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,66 @@
+$:.unshift File.dirname(__FILE__) # allows command line to execute tests
+require 'helper'
+
+class ResponseTest < Test::Unit::TestCase
+
+  context "with valid response" do
+    setup do
+      @response = stub_response("GetRates")
+    end
+
+    should 'be valid' do
+      assert @response.valid?
+    end
+
+    should 'have no errors' do
+      assert @response.errors.empty?
+    end
+  end
+
+  context 'with non-success responses' do
+
+    should 'raise BadRequest' do
+      assert_raise(Stamps::BadRequest) { stub_response('GetRates', 400)}
+    end
+
+    should 'raise Unauthorized' do
+      assert_raise(Stamps::Unauthorized) { stub_response('GetRates', 401)}
+    end
+
+    should 'raise Forbidden' do
+      assert_raise(Stamps::Forbidden) { stub_response('GetRates', 403)}
+    end
+
+    should 'raise NotFound' do
+      assert_raise(Stamps::NotFound) { stub_response('GetRates', 404)}
+    end
+
+    should 'raise NotAcceptable' do
+      assert_raise(Stamps::NotAcceptable) { stub_response('GetRates', 406)}
+    end
+
+    should 'raise InternalServerError' do
+      assert_raise(Stamps::InternalServerError) { stub_response('GetRates', 500)}
+    end
+
+    should 'raise ServiceUnavailable' do
+      assert_raise(Stamps::ServiceUnavailable) { stub_response('GetRates', 502) }
+    end
+
+  end
+
+  context "with invalid soap response" do
+    setup do
+      @response = stub_response("InvalidSoap")
+    end
+
+    should 'return not valid' do
+      assert_equal false, @response.valid?
+    end
+
+    should 'contain error messages' do
+      assert @response.errors.any?
+    end
+  end
+
+end

data/test/stamps_test.rb

@@ -0,0 +1,26 @@
+$:.unshift File.dirname(__FILE__) # allows command line to execute tests
+require 'helper'
+
+class StampsTest < Test::Unit::TestCase
+
+  context "when delegating to a client" do
+
+    setup do
+      stub_post("AuthenticateUser")
+      @client = Stamps::Client.new
+    end
+
+    should 'respond to client methods' do
+      Stamps.respond_to?(:cleanse_address)
+      Stamps.respond_to?(:account)
+    end
+
+    should 'have a default configuration settings' do
+      assert @client.endpoint
+      assert @client.integration_id
+      assert @client.username
+      assert @client.password
+    end
+  end
+
+end

data/test/types_test.rb

@@ -0,0 +1,25 @@
+$:.unshift File.dirname(__FILE__) # allows command line to execute tests
+require 'helper'
+
+class TypesTest < Test::Unit::TestCase
+
+  context "types" do
+
+    should 'return a hash of service type' do
+      assert_equal Hash, Stamps::Types::SERVICE.class
+    end
+
+    should 'return a hash of add ons' do
+      assert_equal Hash, Stamps::Types::ADD_ONS.class
+    end
+
+    should 'return a hash of carrier pickup locations' do
+      assert_equal Hash, Stamps::Types::CARRIER_PICKUP_LOCATION.class
+    end
+
+    should 'return an array of package types' do
+      assert_equal Array, Stamps::Types::PACKAGE.class
+    end
+  end
+
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification 
+name: stamps
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matt Sears
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.11.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: httpi
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.7.9
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.6
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id010
+description: Stamps is Stamps.com backed library for creating postage labels, calculate the shipping cost of packages, standardize domestic addresses via USPS CASS certified Address Matching Software, and track shipments.
+email: 
+- matt@mattsears.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/stamps.rb
+- lib/stamps/api.rb
+- lib/stamps/client.rb
+- lib/stamps/client/account.rb
+- lib/stamps/client/address.rb
+- lib/stamps/client/rate.rb
+- lib/stamps/client/stamp.rb
+- lib/stamps/configuration.rb
+- lib/stamps/errors.rb
+- lib/stamps/mapping.rb
+- lib/stamps/request.rb
+- lib/stamps/response.rb
+- lib/stamps/trash.rb
+- lib/stamps/types.rb
+- lib/stamps/version.rb
+- stamps.gemspec
+- test/client/account_test.rb
+- test/client/address_test.rb
+- test/client/rate_test.rb
+- test/client/stamp_test.rb
+- test/fixtures/AuthenticateUser.xml
+- test/fixtures/CancelIndicium.xml
+- test/fixtures/CarrierPickup.xml
+- test/fixtures/CleanseAddress.xml
+- test/fixtures/CreateIndicium.xml
+- test/fixtures/GetAccountInfo.xml
+- test/fixtures/GetRate.xml
+- test/fixtures/GetRates.xml
+- test/fixtures/InsufficientPostage.xml
+- test/fixtures/InvalidSoap.xml
+- test/fixtures/PurchasePostage.xml
+- test/fixtures/TrackShipment.xml
+- test/helper.rb
+- test/mapping_test.rb
+- test/response_test.rb
+- test/stamps_test.rb
+- test/types_test.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/stamps
+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: stamps
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Stamps.com Web Services API
+test_files: 
+- test/client/account_test.rb
+- test/client/address_test.rb
+- test/client/rate_test.rb
+- test/client/stamp_test.rb
+- test/fixtures/AuthenticateUser.xml
+- test/fixtures/CancelIndicium.xml
+- test/fixtures/CarrierPickup.xml
+- test/fixtures/CleanseAddress.xml
+- test/fixtures/CreateIndicium.xml
+- test/fixtures/GetAccountInfo.xml
+- test/fixtures/GetRate.xml
+- test/fixtures/GetRates.xml
+- test/fixtures/InsufficientPostage.xml
+- test/fixtures/InvalidSoap.xml
+- test/fixtures/PurchasePostage.xml
+- test/fixtures/TrackShipment.xml
+- test/helper.rb
+- test/mapping_test.rb
+- test/response_test.rb
+- test/stamps_test.rb
+- test/types_test.rb