usps-fork 0.1.0

data/lib/usps/test/address_verification.rb

@@ -0,0 +1,31 @@
+class USPS::Test
+  module AddressVerification
+    def test_address_standardization_1
+      address = USPS::Address.new(
+        :address => '6406 Ivy Lane',
+        :city => 'Greenbelt',
+        :state => 'MD'
+      ).standardize!
+      
+      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_address_standardization_2
+      address = USPS::Address.new(
+        :address => '8 Wildwood Drive',
+        :city => 'Old Lyme',
+        :state => 'CT'
+      ).standardize!
+
+      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/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/lib/usps/track_detail.rb

@@ -0,0 +1,49 @@
+require 'time'
+# TODO: Documentation
+#
+class USPS::TrackDetail < Struct.new(:event_time, :event_date, :event, :event_city, :event_state, :event_zip_code, :event_country, :firm_name, :name, :authorized_agent)
+
+  # Alias address getters and setters for a slightly more expressive api
+  alias :city  :event_city
+  alias :city= :event_city=
+  alias :state :event_state
+  alias :state= :event_state=
+  alias :zip_code :event_zip_code
+  alias :zip_code= :event_zip_code=
+  alias :country :event_country
+  alias :country= :event_country=
+
+  attr_reader :error
+
+  def initialize(options = {}, &block)
+    options.each_pair do |k, v|
+      self.send("#{k}=", v)
+    end
+
+    block.call(self) if block
+  end
+  
+  def date
+    time = "#{event_date} #{event_time}".strip
+    begin
+      Time.parse(time) unless time.empty?
+    rescue ArgumentError
+      return nil
+    end
+  end
+
+  # Similar to Hash#replace, overwrite the values of this object with the other.
+  # It will not replace a provided key on the original object that does not exist
+  # on the replacing object (such as name with verification requests).
+  def replace(other)
+    raise ArgumentError unless other.is_a?(USPS::Address)
+
+    other.each_pair do |key, val|
+      # Do not overwrite values that may exist on the original but not on
+      # the replacement.
+      self[key] = val unless val.nil?
+    end
+
+    self
+  end
+end

data/lib/usps/version.rb

@@ -0,0 +1,3 @@
+module USPS
+  VERSION = '0.1.0'
+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
+
+    expect(address).to 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'
+    )
+
+    expect(address.name).to eq('Chris')
+    expect(address.address).to eq('123 Main St')
+    expect(address.city).to eq('Holland')
+  end
+
+  it "know how to combine the zip coes" do
+    expect(USPS::Address.new(:zip5 => 12345).zip).to eq('12345')
+    expect(USPS::Address.new(:zip5 => 12345, :zip4 => 9999).zip).to eq('12345-9999')
+  end
+
+  it "should be able to parse zip into individual parts" do
+    addy = USPS::Address.new(:zip => '12345-9988')
+    expect(addy.zip5).to eq('12345')
+    expect(addy.zip4).to eq('9988')
+    expect(addy.zip).to  eq('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
+    )
+
+    expect(USPS.client).to receive(:request).and_return(
+      USPS::Response::AddressStandardization.new(
+        addy, load_xml('address_standardization_1.xml')
+      )
+    )
+
+    expect(addy.valid?).to be_truthy
+
+    error = USPS::Error.new('error', '1234', 'source')
+    # Failure
+    expect(USPS.client).to receive(:request).and_raise(error)
+    expect(addy.valid?).to be_falsey
+    expect(addy.error).to 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
+    expect(@config.username).to be_nil
+    expect(@config.timeout).to eq(5)
+    expect(@config.testing).to be_falsey
+  end
+
+  it "should grab the username from the environment if available" do
+    ENV['USPS_USER'] = 'malcom77'
+    expect(USPS::Configuration.new.username).to eq('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_field_lookup.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <TrackInfo ID="01805213907042762274">
+    <TrackSummary>
+      <EventTime>12:12 pm</EventTime>
+      <EventDate>May 21, 2001</EventDate>
+      <Event>DELIVERED</Event>
+      <EventCity>NEWTON</EventCity>
+      <EventState>IA</EventState>
+      <EventZIPCode>50208</EventZIPCode>
+      <EventCountry/>
+      <FirmName></FirmName>
+      <Name></Name>
+      <AuthorizedAgent></AuthorizedAgent>
+    </TrackSummary>
+    <TrackDetail>
+      <EventTime>9:24 pm</EventTime>
+      <EventDate>March 28, 2001</EventDate>
+      <Event>ENROUTE</Event>
+      <EventCity>DES MOINES</EventCity>
+      <EventState>IA</EventState>
+      <EventZIPCode>50395</EventZIPCode>
+      <EventCountry/>
+      <FirmName/>
+      <Name/>
+      <AuthorizedAgent/>
+    </TrackDetail>
+    <TrackDetail>
+      <EventTime>10:00 pm</EventTime>
+      <EventDate>March 27, 2001</EventDate>
+      <Event>ACCEPTANCE</Event>
+      <EventCity>BLAINE</EventCity>
+      <EventState>WA</EventState>
+      <EventZIPCode>98231</EventZIPCode>
+      <EventCountry/>
+      <FirmName/>
+      <Name/>
+      <AuthorizedAgent/>
+    </TrackDetail>
+  </TrackInfo>
+</TrackResponse>

data/spec/data/tracking_field_lookup_2.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <TrackInfo ID="01805213907042762274">
+    <TrackSummary>
+      <EventTime></EventTime>
+      <EventDate></EventDate>
+      <Event>DELIVERED</Event>
+      <EventCity>NEWTON</EventCity>
+      <EventState>IA</EventState>
+      <EventZIPCode>50208</EventZIPCode>
+      <EventCountry/>
+      <FirmName></FirmName>
+      <Name></Name>
+      <AuthorizedAgent></AuthorizedAgent>
+    </TrackSummary>
+  </TrackInfo>
+</TrackResponse>

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|
+      expect(klass.secure).to be_falsey
+      expect(klass.api).to eq('Verify')
+      expect(klass.tag).to eq('AddressValidateRequest')
+    end
+  end
+
+  it "should not allow more than 5 addresses" do
+    expect do
+      USPS::Request::AddressStandardization.new([USPS::Address.new] * 6)
+    end.to 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|
+      expect(node.attr('ID')).to eq('0')
+
+      expect(node.search('FirmName').text).to eq('Widget Tel Co.')
+      expect(node.search('Address1').text).to eq('Suite 2000')
+      expect(node.search('Address2').text).to eq('999 Serious Business Av')
+      expect(node.search('City').text).to eq('Awesome Town')
+      expect(node.search('State').text).to eq('FL')
+      expect(node.search('Zip5').text).to eq('12345')
+      expect(node.search('Zip4').text).to eq('9900')
+    end
+  end
+end