usps 0.1.0

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|
+      klass.secure.should be_false
+      klass.api.should == 'ZipCodeLookup'
+      klass.tag.should == 'ZipCodeLookupRequest'
+    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'
+      )
+    )
+
+    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'
+    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)
+
+    standard.address.should == '6406 IVY LN'
+    standard.city.should == 'GREENBELT'
+    standard.state.should == 'MD'
+    standard.zip.should == '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)
+
+    standard.address.should == '8 WILDWOOD DR'
+    standard.city.should == 'OLD LYME'
+    standard.state.should == 'CT'
+    standard.zip.should == '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')
+    )
+
+    response.get(address).name.should == '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|
+      r.zip.should   == 90210
+      r.city.should  == 'BEVERLY HILLS'
+      r.state.should == '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|
+      r.zip.should   == 20770
+      r.city.should  == 'GREENBELT'
+      r.state.should == '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')
+    )
+
+    response.confirmation.should == '420381199101805213907126809651'
+    response.label.should == 'LABEL DATA GOES HERE'
+    response.postnet.should == '38119571851'
+
+    # Check the address
+    addy = response.address
+    addy.name.should == 'Joe Customer'
+    addy.address.should == '6060 PRIMACY PKWY'
+    addy.address2.should == 'STE 201'
+    addy.city.should == 'Memphis'
+    addy.state.should == 'TN'
+    addy.zip.should == '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')
+    )
+
+    response.confirmation.should == '420381199101805213907116323891'
+    response.label.should == 'LABEL DATA GOES HERE'
+    response.postnet.should == '38119571851'
+
+    # Check the address
+    addy = response.address
+    addy.company.should == 'U.S. Postal Service NCSC'
+    addy.name.should == 'Joe Customer'
+    addy.address.should == '6060 PRIMACY PKWY'
+    addy.address2.should == 'STE 201'
+    addy.city.should == 'MEMPHIS'
+    addy.state.should == 'TN'
+    addy.zip.should == '38119-5718'
+  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"))
+
+    response.summary.should == "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."
+    response.details.length.should == 3
+
+    response.details[0].should == "May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801."
+    response.details[1].should == "May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850."
+    response.details[2].should == "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"))
+
+    response.summary.should == "Your item was delivered at 1:39 pm on June 1 in WOBURN MA 01815."
+    response.details.length.should == 3
+
+    response.details[0].should == "May 30 7:44 am NOTICE LEFT WOBURN MA 01815."
+    response.details[1].should == "May 30 7:36 am ARRIVAL AT UNIT NORTH READING MA 01889."
+    response.details[2].should == "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,25 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), %w(.. lib)))
+
+require 'rubygems'
+
+require 'usps'
+require 'spec'
+require 'spec/autorun'
+
+require 'builder'
+require 'nokogiri'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+USPS.username = 'TESTING'
+
+def load_data(path)
+  (@_file_cache ||= {})[path] ||= File.read(File.expand_path(File.join(File.dirname(__FILE__), 'data', path)))
+end
+
+def load_xml(path)
+  Nokogiri::XML.parse(load_data(path))
+end

data/spec/usps_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe USPS do
+  it "should allow setting the USPS API username" do
+    USPS.username = 'melvin'
+    USPS.username.should == 'melvin'
+  end
+end

data/usps.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{usps}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Gaffney"]
+  s.date = %q{2010-02-05}
+  s.description = %q{USPS Webtools API for Ruby.}
+  s.email = %q{gaffneyc@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/usps.rb",
+     "lib/usps/address.rb",
+     "lib/usps/client.rb",
+     "lib/usps/configuration.rb",
+     "lib/usps/errors.rb",
+     "lib/usps/request.rb",
+     "lib/usps/request/address_standardization.rb",
+     "lib/usps/request/base.rb",
+     "lib/usps/request/city_and_state_lookup.rb",
+     "lib/usps/request/delivery_confirmation.rb",
+     "lib/usps/request/delivery_confirmation_certify.rb",
+     "lib/usps/request/tracking_lookup.rb",
+     "lib/usps/request/zip_code_lookup.rb",
+     "lib/usps/response.rb",
+     "lib/usps/response/address_standardization.rb",
+     "lib/usps/response/base.rb",
+     "lib/usps/response/city_and_state_lookup.rb",
+     "lib/usps/response/delivery_confirmation.rb",
+     "lib/usps/response/tracking_lookup.rb",
+     "lib/usps/test.rb",
+     "lib/usps/test/address_verification.rb",
+     "lib/usps/test/city_and_state_lookup.rb",
+     "lib/usps/test/delivery_confirmation.rb",
+     "lib/usps/test/tracking_lookup.rb",
+     "lib/usps/test/zip_code_lookup.rb",
+     "spec/address_spec.rb",
+     "spec/configuration_spec.rb",
+     "spec/data/address_standardization_1.xml",
+     "spec/data/address_standardization_2.xml",
+     "spec/data/city_and_state_lookup_1.xml",
+     "spec/data/city_and_state_lookup_2.xml",
+     "spec/data/delivery_confirmation_1.xml",
+     "spec/data/delivery_confirmation_2.xml",
+     "spec/data/tracking_lookup_1.xml",
+     "spec/data/tracking_lookup_2.xml",
+     "spec/request/address_standardization_spec.rb",
+     "spec/request/base_spec.rb",
+     "spec/request/city_and_state_lookup_spec.rb",
+     "spec/request/delivery_confirmation_certify_spec.rb",
+     "spec/request/delivery_confirmation_spec.rb",
+     "spec/request/tracking_spec.rb",
+     "spec/request/zip_code_lookup_spec.rb",
+     "spec/response/address_standardization_spec.rb",
+     "spec/response/base_spec.rb",
+     "spec/response/city_and_state_lookup_spec.rb",
+     "spec/response/delivery_confirmation_spec.rb",
+     "spec/response/tracking_lookup_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/usps_spec.rb",
+     "usps.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gaffneyc/usps}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{USPS Webtools API for Ruby}
+  s.test_files = [
+    "spec/address_spec.rb",
+     "spec/configuration_spec.rb",
+     "spec/request/address_standardization_spec.rb",
+     "spec/request/base_spec.rb",
+     "spec/request/city_and_state_lookup_spec.rb",
+     "spec/request/delivery_confirmation_certify_spec.rb",
+     "spec/request/delivery_confirmation_spec.rb",
+     "spec/request/signature_confirmation_spec.rb",
+     "spec/request/tracking_spec.rb",
+     "spec/request/zip_code_lookup_spec.rb",
+     "spec/response/address_standardization_spec.rb",
+     "spec/response/base_spec.rb",
+     "spec/response/city_and_state_lookup_spec.rb",
+     "spec/response/delivery_confirmation_spec.rb",
+     "spec/response/signature_confirmation_spec.rb",
+     "spec/response/tracking_lookup_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/usps_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0.1.18"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_dependency(%q<typhoeus>, [">= 0.1.18"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+    s.add_dependency(%q<typhoeus>, [">= 0.1.18"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: usps
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Gaffney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.18
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: USPS Webtools API for Ruby.
+email: gaffneyc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/usps.rb
+- lib/usps/address.rb
+- lib/usps/client.rb
+- lib/usps/configuration.rb
+- lib/usps/errors.rb
+- lib/usps/request.rb
+- lib/usps/request/address_standardization.rb
+- lib/usps/request/base.rb
+- lib/usps/request/city_and_state_lookup.rb
+- lib/usps/request/delivery_confirmation.rb
+- lib/usps/request/delivery_confirmation_certify.rb
+- lib/usps/request/tracking_lookup.rb
+- lib/usps/request/zip_code_lookup.rb
+- lib/usps/response.rb
+- lib/usps/response/address_standardization.rb
+- lib/usps/response/base.rb
+- lib/usps/response/city_and_state_lookup.rb
+- lib/usps/response/delivery_confirmation.rb
+- lib/usps/response/tracking_lookup.rb
+- lib/usps/test.rb
+- lib/usps/test/address_verification.rb
+- lib/usps/test/city_and_state_lookup.rb
+- lib/usps/test/delivery_confirmation.rb
+- lib/usps/test/tracking_lookup.rb
+- lib/usps/test/zip_code_lookup.rb
+- spec/address_spec.rb
+- spec/configuration_spec.rb
+- spec/data/address_standardization_1.xml
+- spec/data/address_standardization_2.xml
+- spec/data/city_and_state_lookup_1.xml
+- spec/data/city_and_state_lookup_2.xml
+- spec/data/delivery_confirmation_1.xml
+- spec/data/delivery_confirmation_2.xml
+- spec/data/tracking_lookup_1.xml
+- spec/data/tracking_lookup_2.xml
+- spec/request/address_standardization_spec.rb
+- spec/request/base_spec.rb
+- spec/request/city_and_state_lookup_spec.rb
+- spec/request/delivery_confirmation_certify_spec.rb
+- spec/request/delivery_confirmation_spec.rb
+- spec/request/tracking_spec.rb
+- spec/request/zip_code_lookup_spec.rb
+- spec/response/address_standardization_spec.rb
+- spec/response/base_spec.rb
+- spec/response/city_and_state_lookup_spec.rb
+- spec/response/delivery_confirmation_spec.rb
+- spec/response/tracking_lookup_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/usps_spec.rb
+- usps.gemspec
+has_rdoc: true
+homepage: http://github.com/gaffneyc/usps
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: USPS Webtools API for Ruby
+test_files: 
+- spec/address_spec.rb
+- spec/configuration_spec.rb
+- spec/request/address_standardization_spec.rb
+- spec/request/base_spec.rb
+- spec/request/city_and_state_lookup_spec.rb
+- spec/request/delivery_confirmation_certify_spec.rb
+- spec/request/delivery_confirmation_spec.rb
+- spec/request/signature_confirmation_spec.rb
+- spec/request/tracking_spec.rb
+- spec/request/zip_code_lookup_spec.rb
+- spec/response/address_standardization_spec.rb
+- spec/response/base_spec.rb
+- spec/response/city_and_state_lookup_spec.rb
+- spec/response/delivery_confirmation_spec.rb
+- spec/response/signature_confirmation_spec.rb
+- spec/response/tracking_lookup_spec.rb
+- spec/spec_helper.rb
+- spec/usps_spec.rb