usps 0.1.0

data/lib/usps/test/city_and_state_lookup.rb

@@ -0,0 +1,19 @@
+class USPS::Test
+  module CityAndStateLookup
+    def test_city_and_state_lookup_1
+      data = USPS.get_city_and_state_for_zip(90210)
+      
+      assert_equal 90210, data[:zip]
+      assert_equal 'BEVERLY HILLS', data[:city]
+      assert_equal 'CA', data[:state]
+    end
+
+    def test_city_and_state_lookup_2
+      data = USPS.get_city_and_state_for_zip(20770)
+      
+      assert_equal 20770, data.zip
+      assert_equal 'GREENBELT', data.city
+      assert_equal 'MD', data.state
+    end
+  end
+end

data/lib/usps/test/delivery_confirmation.rb

@@ -0,0 +1,59 @@
+class USPS::Test
+  # This module is here only for completeness. The USPS test server does not
+  # currently support the label printing APIs despite what the documentation
+  # says.
+  module DeliveryConfirmation
+    def test_delivery_confirmation_1
+      from = USPS::Address.new(
+        :name => 'John Smith',
+        :address => "475 L'Enfant Plaza, SW",
+        :city => 'Washington',
+        :state => 'DC',
+        :zip => '20260'
+      )
+
+      to = USPS::Address.new(
+        :name => 'Joe Customer',
+        :address => '6060 PRIMACY PKWY',
+        :address2 => 'STE 201',
+        :state => 'TN',
+        :city => 'MEMPHIS'
+      )
+
+      request = USPS::Request::DeliveryConfirmationCertify.new(to, from, 2)
+      request.send!
+    end
+
+    def test_delivery_confirmation_2
+      from = USPS::Address.new(
+        :name => 'John Smith',
+        :company => 'U.S. Postal Headquarters',
+        :address => "475 L'Enfant Plaza, SW",
+        :city => 'Washington',
+        :state => 'DC',
+        :zip => '20260-0004'
+      )
+
+      to = USPS::Address.new(
+        :name => 'Joe Customer',
+        :address => '6060 PRIMACY PKWY',
+        :address2 => 'STE 201',
+        :state => 'TN',
+        :city => 'MEMPHIS',
+        :zip => '38119-5718'
+      )
+
+      options = {
+        :service_type => 'Priority',
+        :po_zip_code => 20260,
+        :format => 'tif',
+        :label_date => '07/08/2004',
+        :customer_reference => 'A45-3928',
+        :address_service => true
+      }
+
+      request = USPS::Request::DeliveryConfirmationCertify.new(to, from, 2, options)
+      request.send!
+    end
+  end
+end

data/lib/usps/test/tracking_lookup.rb

@@ -0,0 +1,29 @@
+class USPS::Test
+  module TrackingLookup
+    def test_tracking_lookup_1
+      tracker_id = "EJ958083578US"
+      request = USPS::Request::TrackingLookup.new(tracker_id)
+      results = request.send!
+
+      assert_equal "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.", results.summary
+      assert_equal 3, results.details.length
+
+      assert_equal "May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.", results.details[0]
+      assert_equal "May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.", results.details[1]
+      assert_equal "May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.", results.details[2]
+    end
+
+    def test_tracking_lookup_2
+      tracker_id = "EJ958088694US"
+      request = USPS::Request::TrackingLookup.new(tracker_id)
+      results = request.send!
+
+      assert_equal "Your item was delivered at 1:39 pm on June 1 in WOBURN MA 01815.", results.summary
+      assert_equal 3, results.details.length
+
+      assert_equal "May 30 7:44 am NOTICE LEFT WOBURN MA 01815.", results.details[0]
+      assert_equal "May 30 7:36 am ARRIVAL AT UNIT NORTH READING MA 01889.", results.details[1]
+      assert_equal "May 29 6:00 pm ACCEPT OR PICKUP PORTSMOUTH NH 03801.", results.details[2]
+    end
+  end
+end

data/lib/usps/test/zip_code_lookup.rb

@@ -0,0 +1,37 @@
+class USPS::Test
+  module ZipCodeLookup
+    def test_zip_code_lookup_1
+      address = USPS::Address.new(
+        :address => '6406 Ivy Lane',
+        :city => 'Greenbelt',
+        :state => 'MD'
+      )
+
+      request = USPS::Request::ZipCodeLookup.new(address)
+      address = request.send![address]
+      
+      assert_equal '6406 IVY LN', address.address
+      assert_equal 'GREENBELT', address.city
+      assert_equal 'MD', address.state
+      assert_equal '20770', address.zip5
+      assert_equal '1440', address.zip4
+    end
+
+    def test_zip_code_lookup_2
+      address = USPS::Address.new(
+        :address => '8 Wildwood Drive',
+        :city => 'Old Lyme',
+        :state => 'CT'
+      )
+
+      request = USPS::Request::ZipCodeLookup.new(address)
+      address = request.send![address]
+
+      assert_equal '8 WILDWOOD DR', address.address
+      assert_equal 'OLD LYME', address.city
+      assert_equal 'CT', address.state
+      assert_equal '06371', address.zip5
+      assert_equal '1844', address.zip4
+    end
+  end
+end

data/spec/address_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe USPS::Address do
+  it "should have the expected fields" do
+    address = USPS::Address.new
+
+    address.should respond_to(
+      :name, :name=,
+      :address1, :address1=,
+      :address2, :address2=,
+      :city, :city=,
+      :state, :state=,
+      :zip5, :zip5=,
+      :zip4, :zip4=
+    )
+  end
+
+  it "should be initializable with a hash" do
+    address = USPS::Address.new(
+      :name => 'Chris',
+      :address => '123 Main St',
+      :city => 'Holland'
+    )
+
+    address.name.should == 'Chris'
+    address.address.should == '123 Main St'
+    address.city.should == 'Holland'
+  end
+
+  it "know how to combine the zip coes" do
+    USPS::Address.new(:zip5 => 12345).zip.should == '12345'
+    USPS::Address.new(:zip5 => 12345, :zip4 => 9999).zip.should == '12345-9999'
+  end
+
+  it "should be able to parse zip into individual parts" do
+    addy = USPS::Address.new(:zip => '12345-9988')
+    addy.zip5.should == '12345'
+    addy.zip4.should == '9988'
+    addy.zip.should  == '12345-9988'
+  end
+
+  it "should be able to be verified with the USPS" do
+    addy = USPS::Address.new(
+      :name => 'President Lincoln',
+      :address => '1600 Pennsylvania Avenue NW',
+      :city => 'Washington',
+      :state => 'DC',
+      :zip => 20006
+    )
+
+    USPS.client.expects(:request).returns(
+      USPS::Response::AddressStandardization.new(
+        addy, load_xml('address_standardization_1.xml')
+      )
+    )
+
+    addy.valid?.should be_true
+
+    error = USPS::Error.new('error', '1234', 'source')
+    # Failure
+    USPS.client.expects(:request).raises(error)
+    addy.valid?.should be_false
+    addy.error.should be(error)
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe USPS::Configuration do
+  before(:each) do
+    ENV['USPS_USER'] = nil
+    @config = USPS::Configuration.new
+  end
+
+  it "should have some sensible defaults" do
+    @config.username.should be_nil
+    @config.timeout.should == 5000
+    @config.testing.should be_false
+  end
+
+  it "should grab the username from the environment if available" do
+    ENV['USPS_USER'] = 'malcom77'
+    USPS::Configuration.new.username.should == 'malcom77'
+  end
+end

data/spec/data/address_standardization_1.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><AddressValidateResponse><Address ID="0"><Address2>6406 IVY LN</Address2><City>GREENBELT</City><State>MD</State><Zip5>20770</Zip5><Zip4>1441</Zip4></Address></AddressValidateResponse>

data/spec/data/address_standardization_2.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><AddressValidateResponse><Address ID="0"><Address2>8 WILDWOOD DR</Address2><City>OLD LYME</City><State>CT</State><Zip5>06371</Zip5><Zip4>1844</Zip4></Address></AddressValidateResponse>

data/spec/data/city_and_state_lookup_1.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><CityStateLookupResponse><ZipCode ID="0"><Zip5>90210</Zip5><City>BEVERLY HILLS</City><State>CA</State></ZipCode></CityStateLookupResponse>

data/spec/data/city_and_state_lookup_2.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><CityStateLookupResponse><ZipCode ID="0"><Zip5>20770</Zip5><City>GREENBELT</City><State>MD</State></ZipCode></CityStateLookupResponse>

data/spec/data/delivery_confirmation_1.xml

@@ -0,0 +1 @@
+<DeliveryConfirmationV3.0Response><DeliveryConfirmationNumber>420381199101805213907126809651</DeliveryConfirmationNumber><DeliveryConfirmationLabel>TEFCRUwgREFUQSBHT0VTIEhFUkU=</DeliveryConfirmationLabel><ToName>Joe Customer</ToName><ToFirm /><ToAddress1>STE 201</ToAddress1><ToAddress2>6060 PRIMACY PKWY</ToAddress2><ToCity>Memphis</ToCity><ToState>TN</ToState><ToZip5>38119</ToZip5><ToZip4>5718</ToZip4><Postnet>38119571851</Postnet></DeliveryConfirmationV3.0Response>

data/spec/data/delivery_confirmation_2.xml

@@ -0,0 +1 @@
+<DeliveryConfirmationV3.0Response><DeliveryConfirmationNumber>420381199101805213907116323891</DeliveryConfirmationNumber><DeliveryConfirmationLabel>TEFCRUwgREFUQSBHT0VTIEhFUkU=</DeliveryConfirmationLabel><ToName>Joe Customer</ToName><ToFirm>U.S. Postal Service NCSC</ToFirm><ToAddress1>STE 201</ToAddress1><ToAddress2>6060 PRIMACY PKWY</ToAddress2><ToCity>MEMPHIS</ToCity><ToState>TN</ToState><ToZip5>38119</ToZip5><ToZip4>5718</ToZip4><Postnet>38119571851</Postnet></DeliveryConfirmationV3.0Response>

data/spec/data/tracking_lookup_1.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><TrackResponse><TrackInfo ID="EJ958083578US"><TrackSummary>Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.</TrackSummary><TrackDetail>May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.</TrackDetail><TrackDetail>May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.</TrackDetail><TrackDetail>May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.</TrackDetail></TrackInfo></TrackResponse>

data/spec/data/tracking_lookup_2.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><TrackResponse><TrackInfo ID="EJ958088694US"><TrackSummary>Your item was delivered at 1:39 pm on June 1 in WOBURN MA 01815.</TrackSummary><TrackDetail>May 30 7:44 am NOTICE LEFT WOBURN MA 01815.</TrackDetail><TrackDetail>May 30 7:36 am ARRIVAL AT UNIT NORTH READING MA 01889.</TrackDetail><TrackDetail>May 29 6:00 pm ACCEPT OR PICKUP PORTSMOUTH NH 03801.</TrackDetail></TrackInfo></TrackResponse>

data/spec/request/address_standardization_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe USPS::Request::AddressStandardization do
+  it "should be using the proper USPS api settings" do
+    USPS::Request::AddressStandardization.tap do |klass|
+      klass.secure.should be_false
+      klass.api.should == 'Verify'
+      klass.tag.should == 'AddressValidateRequest'
+    end
+  end
+
+  it "should not allow more than 5 addresses" do
+    Proc.new do
+      USPS::Request::AddressStandardization.new([USPS::Address.new] * 6)
+    end.should raise_exception(ArgumentError)
+  end
+    
+  it "should be able to build a proper request" do
+    request = USPS::Request::AddressStandardization.new(
+      USPS::Address.new(
+        :name => 'Joe Jackson',
+        :company => 'Widget Tel Co.',
+        :address => '999 Serious Business Av',
+        :address2 => 'Suite 2000',
+        :city  => 'Awesome Town',
+        :state => 'FL',
+        :zip => '12345-9900'
+      )
+    )
+
+    xml = Nokogiri::XML.parse(request.build)
+
+    xml.search('Address').first.tap do |node|
+      node.attr('ID').should == '0'
+
+      node.search('FirmName').text.should == 'Widget Tel Co.'
+      node.search('Address1').text.should == 'Suite 2000'
+      node.search('Address2').text.should == '999 Serious Business Av'
+      node.search('City').text.should == 'Awesome Town'
+      node.search('State').text.should == 'FL'
+      node.search('Zip5').text.should == '12345'
+      node.search('Zip4').text.should == '9900'
+    end
+  end
+end

data/spec/request/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe USPS::Request::Base do
+  class RequestSubclassForTesting < USPS::Request::Base
+    config(:api => 'testing', :tag => 'TestingTag')
+  end
+
+  it "should prepend the configured tag and USPS username" do
+    sub = RequestSubclassForTesting.new
+
+    xml = Nokogiri::XML.parse(sub.build)
+
+    xml.root.name.should == 'TestingTag'
+    xml.root.attr('USERID').should == USPS.username
+  end
+end

data/spec/request/city_and_state_lookup_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe USPS::Request::CityAndStateLookup do
+  it "should be using the proper USPS api settings" do
+    USPS::Request::CityAndStateLookup.tap do |klass|
+      klass.secure.should be_false
+      klass.api.should == 'CityStateLookup'
+      klass.tag.should == 'CityStateLookupRequest'
+    end
+  end
+
+  it "should not allow more than 5 addresses" do
+    Proc.new do
+      USPS::Request::CityAndStateLookup.new([12345] * 10)
+    end.should raise_exception(ArgumentError)
+  end
+
+  it "should be able to build a proper request" do
+    request = USPS::Request::CityAndStateLookup.new(
+      90210, 48917, 49423, 99111, 12345
+    )
+
+    xml = Nokogiri::XML.parse(request.build)
+
+    #
+    xml.search('ZipCode[@ID="0"]/Zip5').text.should == '90210'
+    xml.search('ZipCode[@ID="1"]/Zip5').text.should == '48917'
+    xml.search('ZipCode[@ID="2"]/Zip5').text.should == '49423'
+    xml.search('ZipCode[@ID="3"]/Zip5').text.should == '99111'
+    xml.search('ZipCode[@ID="4"]/Zip5').text.should == '12345'
+  end
+end

data/spec/request/delivery_confirmation_certify_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe USPS::Request::DeliveryConfirmationCertify do
+  it 'should be using the proper USPS api settings' do
+    USPS::Request::DeliveryConfirmationCertify.tap do |klass|
+      klass.secure.should be_true
+      klass.api.should == 'DelivConfirmCertifyV3'
+      klass.tag.should == 'DelivConfirmCertifyV3.0Request'
+    end
+  end
+end

data/spec/request/delivery_confirmation_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe USPS::Request::DeliveryConfirmation do
+  it 'should be using the proper USPS api settings' do
+    USPS::Request::DeliveryConfirmation.tap do |klass|
+      klass.secure.should be_true
+      klass.api.should == 'DeliveryConfirmationV3'
+      klass.tag.should == 'DeliveryConfirmationV3.0Request'
+    end
+  end
+
+  it 'should conform to test request 1' do
+    to = USPS::Address.new(
+      :name => 'Joe Customer',
+      :address => '6060 PRIMACY PKWY',
+      :address2 => 'STE 201',
+      :city => 'MEMPHIS',
+      :state => 'TN'
+    )
+
+    from = USPS::Address.new(
+      :name => 'John Smith',
+      :address => "475 L'Enfant Plaza, SW",
+      :city => 'Washington',
+      :state => 'DC',
+      :zip => 20260
+    )
+
+    request = USPS::Request::DeliveryConfirmation.new(to, from, 2).build
+
+    xml = Nokogiri::XML.parse(request)
+    xml.search('Option').text.should == '1'
+    xml.search('ImageParameters').text.should == ''
+
+    xml.search('FromName').text.should == 'John Smith'
+    xml.search('FromFirm').text.should == ''
+    xml.search('FromAddress1').text.should == ''
+    xml.search('FromAddress2').text.should == "475 L'Enfant Plaza, SW"
+    xml.search('FromCity').text.should == 'Washington'
+    xml.search('FromState').text.should == 'DC'
+    xml.search('FromZip5').text.should == '20260'
+    xml.search('FromZip4').text.should == ''
+
+    xml.search('ToName').text.should == 'Joe Customer'
+    xml.search('ToFirm').text.should == ''
+    xml.search('ToAddress1').text.should == 'STE 201'
+    xml.search('ToAddress2').text.should == '6060 PRIMACY PKWY'
+    xml.search('ToCity').text.should == 'MEMPHIS'
+    xml.search('ToState').text.should == 'TN'
+    xml.search('ToZip5').text.should == ''
+    xml.search('ToZip4').text.should == ''
+
+    xml.search('WeightInOunces').text.should == '2'
+    xml.search('ImageType').text.should == 'TIF'
+    xml.search('ServiceType').text.should == 'Priority'
+  end
+end

data/spec/request/tracking_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe USPS::Request::TrackingLookup do
+
+  it 'should be using the proper USPS api settings' do
+    USPS::Request::TrackingLookup.tap do |klass|
+      klass.secure.should be_false
+      klass.api.should == 'TrackV2'
+      klass.tag.should == 'TrackRequest'
+    end
+  end
+
+  it "should build a proper request" do
+    request = USPS::Request::TrackingLookup.new("EJ958083578US").build
+
+    xml = Nokogiri::XML.parse(request)
+    xml.search('TrackID').text.should == ''
+    xml.search('TrackID').attr("ID").text.should == "EJ958083578US"
+  end
+
+end