stamps 0.2.0

data/lib/stamps/trash.rb

@@ -0,0 +1,29 @@
+require 'hashie/trash'
+
+module Hashie
+  class Trash
+
+    class << self
+      attr_reader :properties
+    end
+
+    # Use a n Array instead of a set since order is important
+    # TODO:  Look at https://github.com/ahoward/map
+    instance_variable_set('@properties', Array.new)
+
+
+    # Sort the hash by the order in which the properties are declared
+    def to_hash
+      sorted_keys = self.class.properties.map{|prop| prop.to_s} & self.keys
+
+      # Use active_support for ordering hashes for Ruby < 1.9
+      out = RUBY_VERSION >= '1.9' ? {} : ActiveSupport::OrderedHash.new
+      sorted_keys.each do |k|
+        next if self[k].nil?
+        out[k] = Hashie::Hash === self[k] ? self[k].to_hash : self[k]
+      end
+      out
+    end
+
+  end
+end

data/lib/stamps/types.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+module Stamps
+  module Types
+
+    # TODO:  Need to figure out how to parse the wsdl file for types
+    # instead of hard-coding them here
+    PACKAGE = [
+      'Postcard',
+      'Letter',
+      'Large envelope or flat',
+      'Thick envelope',
+      'Package',
+      'Flat Rate Box',
+      'Small Flat Rate Box',
+      'Large Flat Rate Box',
+      'Flat Rate Envelope',
+      'Flat Rate Padded Envelope',
+      'Large Package',
+      'Oversized Package'].freeze
+
+    SERVICE = {
+      'US-FC'  => 'USPS First-Class Mail',
+      'US-MM'  => 'USPS Media Mail',
+      'US-PP'  => 'USPS Parcel Post',
+      'US-PM'  => 'USPS Priority Mail',
+      'US-XM'  => 'USPS Express Mail',
+      'US-EMI' => 'USPS Express Mail International',
+      'US-PMI' => 'USPS Priority Mail International',
+      'US-FCI' => 'USPS First Class Mail International'
+    }
+
+    ADD_ONS = {
+      'SC-A-HP'    => 'Hidden Postage',
+      'SC-A-INS'   => 'Insurance',
+      'SC-A-INSRM' => 'Insurance for Registered Mail',
+      'US-A-CM'    => 'Certified Mail',
+      'US-A-COD'   => 'Collect on Delivery',
+      'US-A-COM'   => 'Certificate of Mailing',
+      'US-A-DC'    => 'USPS Delivery Confirmation',
+      'US-A-ESH'   => 'USPS Express - Sunday / Holiday Guaranteed',
+      'US-A-INS'   => 'USPS Insurance',
+      'US-A-NDW'   => 'USPS Express - No Delivery on Saturdays',
+      'US-A-RD'    => 'Restricted Delivery',
+      'US-A-REG'   => 'Registered Mail',
+      'US-A-RR'    => 'Return Receipt Requested',
+      'US-A-RRM'   => 'Return Receipt for Merchandise',
+      'US-A-SC'    => 'USPS Signature Confirmation',
+      'US-A-SH'    => 'Special Handling',
+      'US-A-WDS'   => 'USPS Express - Waive Delivery Signature',
+      'US-A-NDW'   => 'Do not Deliver on Saturday',
+      'US-A-ESH'   => 'Sunday/Holiday Delivery Guaranteed',
+      'US-A-NND'   => 'Notice of non-delivery',
+    }
+
+    CARRIER_PICKUP_LOCATION = {
+      'FrontDoor'             => 'Packages are at front door',
+      'BackDoor'              => 'Packages are at back door',
+      'SideDoor'              => 'Packages are at side door',
+      'KnockOnDoorOrRingBell' => 'Knock on door or ring bell',
+      'MailRoom'              => 'Packages are in mail room',
+      'Office'                => 'Packages are in office',
+      'Reception'             => 'Packages are at reception area',
+      'InOrAtMailbox'         => 'Packages are in mail box',
+      'Other'                 => 'Other Location'
+    }
+
+  end
+end

data/lib/stamps/version.rb

@@ -0,0 +1,3 @@
+module Stamps
+  VERSION = "0.2.0"
+end

data/stamps.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "stamps/version"
+
+Gem::Specification.new do |s|
+  s.name        = "stamps"
+  s.version     = Stamps::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Sears"]
+  s.email       = ["matt@mattsears.com"]
+  s.homepage    = "http://rubygems.org/gems/stamps"
+  s.summary     = %q{Ruby wrapper for the Stamps.com Web Services API}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "stamps"
+
+  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"]
+
+  s.add_development_dependency('simplecov', '~> 0.4.0')
+  s.add_development_dependency('shoulda', '~> 2.11.3')
+  s.add_development_dependency('mocha', '~> 0.9.11')
+  s.add_development_dependency('webmock', '~> 1.6.2')
+  s.add_development_dependency('awesome_print')
+
+  s.add_runtime_dependency('httpi', '0.7.9')
+  s.add_runtime_dependency('savon', '>= 0.8.6')
+  s.add_runtime_dependency('json', '~> 1.5.1')
+  s.add_runtime_dependency('multi_json', '~> 0.0.5')
+  s.add_runtime_dependency('hashie', '~> 1.0.0')
+end

data/test/client/account_test.rb

@@ -0,0 +1,64 @@
+$:.unshift File.dirname(__FILE__) + '/../' # allows command line to execute tests
+require 'helper'
+
+class AccountTest < Test::Unit::TestCase
+
+  context '#account' do
+    setup { stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+      setup do
+        stub_post('GetAccountInfo')
+        @account = Stamps.account
+      end
+
+      should 'assign the user id' do
+        assert_equal '1111111', @account[:user_id]
+      end
+    end
+  end
+
+  context '#purchase_postage' do
+    setup { stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+      setup do
+        stub_post('PurchasePostage')
+        @purchase = Stamps.purchase_postage
+      end
+
+      should 'return reject reason' do
+        assert_equal 'order being processed', @purchase[:rejection_reason]
+      end
+
+      should 'return postage balannce' do
+        assert_equal '23.4300', @purchase[:postage_balance][:available_postage]
+      end
+
+    end
+  end
+
+  context '#carrier_pickup' do
+    setup { stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+
+      setup do
+        stub_post('CarrierPickup')
+        @carrier_pickup = Stamps.carrier_pickup()
+      end
+
+      should 'return pickup date' do
+        assert '01/29/2011', @carrier_pickup[:pickup_date]
+      end
+
+      should 'return pickup day of the week' do
+        assert 'Saturday', @carrier_pickup[:pick_up_day_of_week]
+      end
+
+      should 'return a confirmation number' do
+        assert 'WTC7812296', @carrier_pickup[:confirmation_number]
+      end
+    end
+  end
+end

data/test/client/address_test.rb

@@ -0,0 +1,36 @@
+$:.unshift File.dirname(__FILE__) + '/../' # allows command line to execute tests
+require 'helper'
+
+class AddressTest < Test::Unit::TestCase
+
+  context '#clean_address' do
+    setup {stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+      setup do
+        stub_post('CleanseAddress')
+        @address = Stamps.clean_address(
+           :address => {
+             :full_name    => 'Matt Sears'
+           }
+        )
+      end
+
+      should 'return the clean address' do
+        assert_equal 'MATT SEARS', @address[:address][:full_name]
+        assert_equal 'MATT SEARS', @address[:address][:full_name]
+      end
+
+      should 'return a cleanse hash' do
+        assert 'W9pHbVsNIdYE8/B6SyQ4wOkIIr9kZWFkYmVlZg==20110713', @address[:address][:cleanse_hash]
+      end
+
+      should 'indicate if the address match' do
+        assert @address[:address_match]
+        assert @address[:city_state_zip_ok]
+      end
+    end
+
+  end
+
+end

data/test/client/rate_test.rb

@@ -0,0 +1,44 @@
+$:.unshift File.dirname(__FILE__) + '/../' # allows command line to execute tests
+require 'helper'
+
+class StampsTest < Test::Unit::TestCase
+  context "Stamp::Client:Rate" do
+    setup do
+      stub_post("AuthenticateUser")
+    end
+
+    context ".get_rates" do
+
+      setup do
+        stub_post("GetRates")
+        @rates = Stamps.get_rates
+      end
+
+      should 'return an array of rates' do
+        assert_equal Array, @rates.class
+      end
+
+      should 'assign the amount for a given rate' do
+        assert_equal '2.41', @rates.first[:amount]
+      end
+
+    end
+
+    context '.get_rates with package and service types' do
+
+      setup do
+        stub_post("GetRate", 'GetRates')
+        @rate = Stamps.get_rate
+      end
+
+      should 'return an hash for the single rate' do
+        assert_equal Hash, @rate.class
+      end
+
+      should 'return an array of addons' do
+        assert_equal Hash, @rate[:add_ons].class
+      end
+
+    end
+  end
+end

data/test/client/stamp_test.rb

@@ -0,0 +1,89 @@
+$:.unshift File.dirname(__FILE__) + '/../' # allows command line to execute tests
+require 'helper'
+
+class StampTest < Test::Unit::TestCase
+
+  context '.create' do
+    setup {stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+      setup do
+        stub_post('CreateIndicium')
+        @stamp = Stamps.create!(
+          :transaction_id  => "1234567890ABCDEFG",
+          :rate          => {
+            :add_ons       => {
+              :add_on => [
+                { :type => 'US-A-COD' },
+                { :amount  => '0.19', :type => 'US-A-DC' }
+              ]
+            }
+          },
+          :to => {:full_name => 'Matt Sears'},
+          :customs => {
+            :customs_lines => [
+              :custom => {
+                :description => 'Tee Shirt',
+                :quantity    => 1,
+                :weight_oz   => '7.8',
+                :value       => 18.00
+              }
+            ]
+          })
+      end
+
+      should 'return the url for the stamp' do
+        assert @stamp[:url]
+      end
+
+      should 'return the postage balance' do
+        assert_equal '5.8600', @stamp[:postage_balance][:available_postage]
+        assert_equal '10.00',  @stamp[:postage_balance][:control_total]
+      end
+
+    end
+  end
+
+  context '.cancel' do
+    setup {stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+      setup do
+        stub_post('CancelIndicium')
+        @cancel = Stamps.cancel!
+      end
+
+      should 'return just the authenticator' do
+        assert @cancel[:authenticator]
+      end
+
+    end
+  end
+
+  context '.track' do
+    setup {stub_post('AuthenticateUser') }
+
+    context 'with valid data' do
+
+      setup do
+        stub_post('TrackShipment')
+        @track = Stamps.track('342343243243')
+      end
+
+      should 'return an list of tracking events' do
+        assert_equal 3,  @track[:tracking_events][:tracking_event].size
+      end
+
+      should 'map individual tracking event properties' do
+        tracking_event = @track[:tracking_events][:tracking_event].first
+        assert_equal 'DELIVERED', tracking_event[:event]
+        assert_equal 'FORT WAYNE', tracking_event[:city]
+        assert_equal 'IN', tracking_event[:state]
+        assert_equal '46809', tracking_event[:zip]
+        assert_equal 'US', tracking_event[:country]
+      end
+
+    end
+
+  end
+end

data/test/fixtures/AuthenticateUser.xml

@@ -0,0 +1,9 @@
+<?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>
+    <AuthenticateUserResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>SdU5rk6BkFZahwAsmH6EwLVu2Iw=</Authenticator>
+    </AuthenticateUserResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/CancelIndicium.xml

@@ -0,0 +1,8 @@
+<?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>
+    <CancelIndiciumResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>yxj7EBWLh1EraJrawFhslf+L+Qs=</Authenticator>
+    </CancelIndiciumResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/CarrierPickup.xml

@@ -0,0 +1,11 @@
+<?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>
+    <CarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>***authenticator***</Authenticator>
+      <PickupDate>01/29/2011</PickupDate>
+      <PickUpDayOfWeek>Saturday</PickUpDayOfWeek>
+      <ConfirmationNumber>WTC7812296</ConfirmationNumber>
+    </CarrierPickupResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/CleanseAddress.xml

@@ -0,0 +1,24 @@
+<?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>
+    <CleanseAddressResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>ZVk2fjKAIR8AgCYYo+3EQuylEHg=</Authenticator>
+      <Address>
+        <FullName>MATT SEARS</FullName>
+        <Address1>123 MOCKINGBIRD LANE</Address1>
+        <Address2 />
+        <City>NEW YORK</City>
+        <State>NY</State>
+        <ZIPCode>11111</ZIPCode>
+        <ZIPCodeAddOn>222</ZIPCodeAddOn>
+        <DPB>06</DPB>
+        <CheckDigit>5</CheckDigit>
+        <Urbanization />
+        <CleanseHash>W9pHbVsNIdYE8/B6SyQ4wOkIIr9kZWFkYmVlZg==20110713</CleanseHash>
+        <OverrideHash>PxU7xsTh5+lebMpE9IcjOWQS0alkZWFkYmVlZg==20110713</OverrideHash>
+      </Address>
+      <AddressMatch>true</AddressMatch>
+      <CityStateZipOK>true</CityStateZipOK>
+    </CleanseAddressResponse>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/CreateIndicium.xml

@@ -0,0 +1,32 @@
+<?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>
+    <CreateIndiciumResponse xmlns="http://stamps.com/xml/namespace/2010/11/swsim/swsimv12">
+      <Authenticator>SfOQgTEPIqQRO6ZgZvfcegLDUzA=</Authenticator>
+      <IntegratorTxID>1234567890ABCDEF</IntegratorTxID>
+      <Rate>
+        <FromZIPCode>10008</FromZIPCode>
+        <ToZIPCode>45458</ToZIPCode>
+        <Amount>2.07</Amount>
+        <ServiceType>US-FC</ServiceType>
+        <PrintLayout>Untrackable</PrintLayout>
+        <DeliverDays>1</DeliverDays>
+        <WeightLb>0.5</WeightLb>
+        <PackageType>Large Envelope or Flat</PackageType>
+        <ShipDate>2011-04-07</ShipDate>
+        <DimWeighting>N</DimWeighting>
+        <EffectiveWeightInOunces>8</EffectiveWeightInOunces>
+        <IsIntraBMC>true</IsIntraBMC>
+        <Zone>1</Zone>
+        <RateCategory>268959776</RateCategory>
+      </Rate>
+      <StampsTxID>fa7618c4-013c-4e5f-b42e-7591dd55bea6</StampsTxID>
+      <URL>https://swsim.testing.example.com.com/Label/label.ashx/label-200-r90.png</URL>
+      <PostageBalance>
+        <AvailablePostage>5.8600</AvailablePostage>
+        <ControlTotal>10.00</ControlTotal>
+      </PostageBalance>
+      <Mac>KDTpVEcj3SyynhawyTYT1ikB5IE=</Mac>
+    </CreateIndiciumResponse>
+  </soap:Body>
+</soap:Envelope>