usps-fork 0.1.0

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)
+
+    expect(xml.root.name).to eq('TestingTag')
+    expect(xml.root.attr('USERID')).to eq(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|
+      expect(klass.secure).to be_falsey
+      expect(klass.api).to eq('CityStateLookup')
+      expect(klass.tag).to eq('CityStateLookupRequest')
+    end
+  end
+
+  it "should not allow more than 5 addresses" do
+    expect do
+      USPS::Request::CityAndStateLookup.new([12345] * 10)
+    end.to 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)
+
+    #
+    expect(xml.search('ZipCode[@ID="0"]/Zip5').text).to eq('90210')
+    expect(xml.search('ZipCode[@ID="1"]/Zip5').text).to eq('48917')
+    expect(xml.search('ZipCode[@ID="2"]/Zip5').text).to eq('49423')
+    expect(xml.search('ZipCode[@ID="3"]/Zip5').text).to eq('99111')
+    expect(xml.search('ZipCode[@ID="4"]/Zip5').text).to eq('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|
+      expect(klass.secure).to be_truthy
+      expect(klass.api).to eq('DelivConfirmCertifyV3')
+      expect(klass.tag).to eq('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|
+      expect(klass.secure).to be_truthy
+      expect(klass.api).to eq('DeliveryConfirmationV3')
+      expect(klass.tag).to eq('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)
+    expect(xml.search('Option').text).to eq('1')
+    expect(xml.search('ImageParameters').text).to eq('')
+
+    expect(xml.search('FromName').text).to eq('John Smith')
+    expect(xml.search('FromFirm').text).to eq('')
+    expect(xml.search('FromAddress1').text).to eq('')
+    expect(xml.search('FromAddress2').text).to eq("475 L'Enfant Plaza, SW")
+    expect(xml.search('FromCity').text).to eq('Washington')
+    expect(xml.search('FromState').text).to eq('DC')
+    expect(xml.search('FromZip5').text).to eq('20260')
+    expect(xml.search('FromZip4').text).to eq('')
+
+    expect(xml.search('ToName').text).to eq('Joe Customer')
+    expect(xml.search('ToFirm').text).to eq('')
+    expect(xml.search('ToAddress1').text).to eq('STE 201')
+    expect(xml.search('ToAddress2').text).to eq('6060 PRIMACY PKWY')
+    expect(xml.search('ToCity').text).to eq('MEMPHIS')
+    expect(xml.search('ToState').text).to eq('TN')
+    expect(xml.search('ToZip5').text).to eq('')
+    expect(xml.search('ToZip4').text).to eq('')
+
+    expect(xml.search('WeightInOunces').text).to eq('2')
+    expect(xml.search('ImageType').text).to eq('TIF')
+    expect(xml.search('ServiceType').text).to eq('Priority')
+  end
+end

data/spec/request/tracking_field_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe USPS::Request::TrackingFieldLookup do
+
+  it 'should be using the proper USPS api settings' do
+    USPS::Request::TrackingFieldLookup.tap do |klass|
+      expect(klass.secure).to be_falsey
+      expect(klass.api).to eq('TrackV2')
+      expect(klass.tag).to eq('TrackFieldRequest')
+    end
+  end
+
+  it "should build a proper request" do
+    request = USPS::Request::TrackingFieldLookup.new("EJ958083578US").build
+    xml = Nokogiri::XML.parse(request)
+    expect(xml.search('TrackID').text).to eq('')
+    expect(xml.search('TrackID').attr("ID").text).to eq("EJ958083578US")
+  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|
+      expect(klass.secure).to be_falsey
+      expect(klass.api).to eq('TrackV2')
+      expect(klass.tag).to eq('TrackRequest')
+    end
+  end
+
+  it "should build a proper request" do
+    request = USPS::Request::TrackingLookup.new("EJ958083578US").build
+
+    xml = Nokogiri::XML.parse(request)
+    expect(xml.search('TrackID').text).to eq('')
+    expect(xml.search('TrackID').attr("ID").text).to eq("EJ958083578US")
+  end
+
+end

data/spec/request/zip_code_lookup_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe USPS::Request::ZipCodeLookup do
+  it "should be using the proper USPS api settings" do
+    USPS::Request::ZipCodeLookup.tap do |klass|
+      expect(klass.secure).to be_falsey
+      expect(klass.api).to eq('ZipCodeLookup')
+      expect(klass.tag).to eq('ZipCodeLookupRequest')
+    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'
+      )
+    )
+
+    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')
+    end
+  end
+end

data/spec/response/address_standardization_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe USPS::Response::AddressStandardization do
+  it "should handle test request 1" do
+    address = USPS::Address.new(
+      :address => '6406 Ivy Lane',
+      :city => 'Greenbelt',
+      :state => 'MD'
+    )
+
+    response = USPS::Response::AddressStandardization.new(
+      address, load_xml('address_standardization_1.xml')
+    )
+
+    standard = response.get(address)
+
+    expect(standard.address).to eq('6406 IVY LN')
+    expect(standard.city).to eq('GREENBELT')
+    expect(standard.state).to eq('MD')
+    expect(standard.zip).to eq('20770-1441')
+  end
+
+  it "should handle test request 2" do
+    address = USPS::Address.new(
+      :address => '8 Wildwood Dr',
+      :city => 'Old Lyme',
+      :state => 'CT',
+      :zip => '06371'
+    )
+
+    response = USPS::Response::AddressStandardization.new(
+      address, load_xml('address_standardization_2.xml')
+    )
+
+    standard = response.get(address)
+
+    expect(standard.address).to eq('8 WILDWOOD DR')
+    expect(standard.city).to eq('OLD LYME')
+    expect(standard.state).to eq('CT')
+    expect(standard.zip).to eq('06371-1844')
+  end
+
+  it "should propogate name to the result address as it is not returned from api" do
+    address = USPS::Address.new(
+      :name => 'Carl Sagan'
+    )
+
+    response = USPS::Response::AddressStandardization.new(
+      address, load_xml('address_standardization_2.xml')
+    )
+
+    expect(response.get(address).name).to eq('Carl Sagan')
+  end
+end

data/spec/response/city_and_state_lookup_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe USPS::Response::CityAndStateLookup do
+  it "should handle test request 1" do
+    response = USPS::Response::CityAndStateLookup.new(
+      load_xml('city_and_state_lookup_1.xml')
+    )
+
+    response.get(90210).tap do |r|
+      expect(r.zip).to   eq(90210)
+      expect(r.city).to  eq('BEVERLY HILLS')
+      expect(r.state).to eq('CA')
+    end
+  end
+
+  it "should handle test request 2" do
+    response = USPS::Response::CityAndStateLookup.new(
+      load_xml('city_and_state_lookup_2.xml')
+    )
+
+    response.get(20770).tap do |r|
+      expect(r.zip).to   eq(20770)
+      expect(r.city).to  eq('GREENBELT')
+      expect(r.state).to eq('MD')
+    end
+  end
+end

data/spec/response/delivery_confirmation_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe USPS::Response::DeliveryConfirmation do
+  it "should handle test request 1" do
+    response = USPS::Response::DeliveryConfirmation.new(
+      load_xml('delivery_confirmation_1.xml')
+    )
+
+    expect(response.confirmation).to eq('420381199101805213907126809651')
+    expect(response.label).to eq('LABEL DATA GOES HERE')
+    expect(response.postnet).to eq('38119571851')
+
+    # Check the address
+    addy = response.address
+    expect(addy.name).to eq('Joe Customer')
+    expect(addy.address).to eq('6060 PRIMACY PKWY')
+    expect(addy.address2).to eq('STE 201')
+    expect(addy.city).to eq('Memphis')
+    expect(addy.state).to eq('TN')
+    expect(addy.zip).to eq('38119-5718')
+  end
+
+  # TODO: Test is still missing custom fields
+  it "should handle test request 2" do
+    response = USPS::Response::DeliveryConfirmation.new(
+      load_xml('delivery_confirmation_2.xml')
+    )
+
+    expect(response.confirmation).to eq('420381199101805213907116323891')
+    expect(response.label).to eq('LABEL DATA GOES HERE')
+    expect(response.postnet).to eq('38119571851')
+
+    # Check the address
+    addy = response.address
+    expect(addy.company).to eq('U.S. Postal Service NCSC')
+    expect(addy.name).to eq('Joe Customer')
+    expect(addy.address).to eq('6060 PRIMACY PKWY')
+    expect(addy.address2).to eq('STE 201')
+    expect(addy.city).to eq('MEMPHIS')
+    expect(addy.state).to eq('TN')
+    expect(addy.zip).to eq('38119-5718')
+  end
+end

data/spec/response/tracking_field_lookup_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+
+describe USPS::Response::TrackingFieldLookup do
+
+  it "should handle test request" do
+    response = USPS::Response::TrackingFieldLookup.new(load_xml("tracking_field_lookup.xml"))
+    expect(response).to be_a_kind_of(USPS::Response::TrackingFieldLookup)
+    
+    expect(response.summary.event).to eq("DELIVERED")
+    expect(response.summary.city).to eq("NEWTON")
+    expect(response.summary.date).to eq(Time.parse("2001-05-21 12:12:00"))
+    expect(response.summary.event_time).to eq("12:12 pm")
+    expect(response.summary.event_date).to eq("May 21, 2001")
+    expect(response.summary.event_state).to eq("IA")
+    expect(response.summary.event_zip_code).to eq("50208")
+    expect(response.summary.name).to eq("")
+    expect(response.summary.firm_name).to eq("")
+    expect(response.summary.authorized_agent).to eq("")
+        
+    expect(response.details.length).to eq(2)
+    expect(response.details[0].event).to eq("ENROUTE")
+    expect(response.details[1].event).to eq("ACCEPTANCE")
+  end
+  it "should handle no detail records" do
+    response = USPS::Response::TrackingFieldLookup.new(load_xml("tracking_field_lookup_2.xml"))
+    expect(response.details.length).to eq(0)  
+  end
+end

data/spec/response/tracking_lookup_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe USPS::Response::TrackingLookup do
+
+  it "should handle test request 1" do
+    response = USPS::Response::TrackingLookup.new(load_xml("tracking_lookup_1.xml"))
+
+    expect(response.summary).to eq("Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.")
+    expect(response.details.length).to eq(3)
+
+    expect(response.details[0]).to eq("May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.")
+    expect(response.details[1]).to eq("May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.")
+    expect(response.details[2]).to eq("May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.")
+  end
+
+  it "should handle test request 2" do
+    response = USPS::Response::TrackingLookup.new(load_xml("tracking_lookup_2.xml"))
+
+    expect(response.summary).to eq("Your item was delivered at 1:39 pm on June 1 in WOBURN MA 01815.")
+    expect(response.details.length).to eq(3)
+
+    expect(response.details[0]).to eq("May 30 7:44 am NOTICE LEFT WOBURN MA 01815.")
+    expect(response.details[1]).to eq("May 30 7:36 am ARRIVAL AT UNIT NORTH READING MA 01889.")
+    expect(response.details[2]).to eq("May 29 6:00 pm ACCEPT OR PICKUP PORTSMOUTH NH 03801.")
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+require 'usps'
+USPS.username = 'TESTING'
+
+def load_data(path)
+  (@_file_cache ||= {})[path] ||= File.read(File.expand_path("../data/#{path}", __FILE__))
+end
+
+def load_xml(path)
+  Nokogiri::XML.parse(load_data(path))
+end

data/spec/track_detail_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe USPS::TrackDetail do
+  it "should have the expected fields" do
+    track_detail = USPS::TrackDetail.new
+    
+    expect(track_detail).to respond_to(
+      :event_time, :event_time=,
+      :event_date, :event_date=,
+      :event, :event=,
+      :event_city, :event_city=,
+      :event_state, :event_state=,
+      :event_zip_code, :event_zip_code=,
+      :event_country, :event_country=,
+      :firm_name, :firm_name=,
+      :name, :name=,
+      :authorized_agent, :authorized_agent=,
+      :date)
+  end
+
+  it "should be initializable with a hash" do
+    track_detail = USPS::TrackDetail.new(
+      :name => 'Chris',
+      :event_city => '123 Main St',
+      :event => 'DELIVERED'
+    )
+
+    expect(track_detail.name).to eq('Chris')
+    expect(track_detail.event_city).to eq('123 Main St')
+    expect(track_detail.event).to eq('DELIVERED')
+  end
+  
+  it "should calculate a date" do
+    track_detail = USPS::TrackDetail.new(
+      :event_time => '9:24 pm',
+      :event_date => 'March 28, 2001',
+    )
+    track_detail.date.should == Time.parse('2001-03-28 21:24:00')
+  end
+  
+  it "should handle blank dates" do
+    track_detail = USPS::TrackDetail.new(
+      :event_time => '',
+      :event_date => '',
+    )
+    expect(track_detail.event_time).to eq("")
+    expect(track_detail.event_date).to eq("")
+    expect(track_detail.date).to eq(nil)
+  end
+
+end