trackerific 0.5.5 → 0.6.0

data/spec/lib/helpers/options_helper_spec.rb

@@ -5,7 +5,7 @@ describe OptionsHelper do
   
   describe :validate_options do
   
-    context "with all required options" do
+    context "with all required parameters" do
       before do
         @required = [:hello, :world]
         @options = {:hello => true, :world => true}
@@ -14,7 +14,7 @@ describe OptionsHelper do
       it { should be true }
     end
     
-    context "with missing required options" do
+    context "with missing required parameters" do
       before do
         @required = [:hello, :world]
         @options = {:hello => true}
@@ -22,7 +22,7 @@ describe OptionsHelper do
       specify { lambda { validate_options(@options, @required) }.should raise_error(ArgumentError) }
     end
     
-    context "with no required options" do
+    context "with no required parameters" do
       before do
         @required = []
         @options = {}

data/spec/lib/trackerific/configuration_spec.rb

@@ -6,4 +6,39 @@ describe "Trackerific.configuration" do
   subject { Trackerific.configuration }
   it { should be_a Trackerific::Configuration }
   
+  context "with valid options" do
+    it "should not raise any errors" do
+      lambda {
+        Trackerific.configure do |config|
+          config.usps :user_id => 'userid'
+        end
+      }.should_not raise_error
+    end
+    it "should save a valid option" do
+      Trackerific.configure do |config|
+        config.usps :user_id => 'userid'
+      end
+      Trackerific.configuration.usps[:user_id].should eq 'userid'
+    end
+  end
+  
+  context "with invalid options" do
+    it "should raise ArgumentError" do
+      lambda {
+        Trackerific.configure do |config|
+          config.usps :invalid => 'option'
+        end
+      }.should raise_error ArgumentError
+    end
+  end
+  
+  context "with invalid configuration group - not a Trackerific:Service" do
+    it "should raise NoMethodError" do
+      lambda {
+        Trackerific.configure do |config|
+          config.qwertyuiop :invalid => 'group'
+        end
+      }.should raise_error(NoMethodError)
+    end
+  end
 end

data/spec/lib/trackerific/details_spec.rb

@@ -1,22 +1,82 @@
 require 'spec_helper'
 
 describe Trackerific::Details do
-
-  before { @details = Trackerific::Details.new(String.new, String.new, Array.new) }
   
-  describe :events do
-    subject { @details.events }
-    it { should be_a Array }
+  before do
+    @required_details = {
+      :package_id => String.new,
+      :summary    => String.new,
+      :events     => Array.new
+    }
+    @valid_options = {
+      :weight     => Hash.new,
+      :via        => String.new
+    }
+  end
+  
+  context "with required options only" do
+    before { @details = Trackerific::Details.new(@required_details) }
+    
+    describe :events do
+      subject { @details.events }
+      it { should be_a Array }
+    end
+    
+    describe :package_id do
+      subject { @details.package_id }
+      it { should be_a String }
+    end
+    
+    describe :summary do
+      subject { @details.summary }
+      it { should be_a String }
+    end
+    
+    describe :weight do
+      subject { @details.weight }
+      it { should be_nil }
+    end
+    
+    describe :via do
+      subject { @details.via }
+      it { should be_nil }
+    end
   end
   
-  describe :package_id do
-    subject { @details.package_id }
-    it { should be_a String }
+  context "with all options" do
+    before { @details = Trackerific::Details.new(@required_details.merge(@valid_options)) }
+    
+    describe :events do
+      subject { @details.events }
+      it { should be_a Array }
+    end
+    
+    describe :package_id do
+      subject { @details.package_id }
+      it { should be_a String }
+    end
+    
+    describe :summary do
+      subject { @details.summary }
+      it { should be_a String }
+    end
+    
+    describe :weight do
+      subject { @details.weight }
+      it { should be_a Hash }
+    end
+    
+    describe :via do
+      subject { @details.via }
+      it { should be_a String }
+    end
   end
   
-  describe :summary do
-    subject { @details.summary }
-    it { should be_a String }
+  context "with no options" do
+    specify { lambda { Trackerific::Details.new }.should raise_error(ArgumentError) }
   end
   
+  context "with invalid options" do
+    specify { lambda { Trackerific::Details.new(:hello => "world")}.should raise_error(ArgumentError) }
+  end
 end

data/spec/lib/trackerific/event_spec.rb

@@ -4,30 +4,45 @@ describe Trackerific::Event do
   
   before do
     @date = Time.now
-    @description = "description"
-    @location = "location"
-    @event = Trackerific::Event.new(@date, @description, @location)
+    @description = 'description'
+    @location = 'location'
+    @required_parameters = {
+      :date         => @date,
+      :description  => @description,
+      :location     => @location
+    }
   end
   
-  describe :date do
-    subject { @event.date }
-    it { should be @date }
+  context "with all required options" do
+    before { @event = Trackerific::Event.new(@required_parameters) }
+    
+    describe :date do
+      subject { @event.date }
+      it { should be @date }
+    end
+    
+    describe :description do
+      subject { @event.description }
+      it { should be @description }
+    end
+    
+    describe :location do
+      subject { @event.location }
+      it { should be @location }
+    end
+    
+    describe :to_s do
+      before { @regex = /(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (0[1-9]|[1-2][0-9]|3[01]) \d{2}:\d{2} (am|pm).*/ }
+      subject { @event.to_s }
+      it("should be in format mmm dd hh:mm am/pm.*") { should =~ @regex }
+    end
   end
   
-  describe :description do
-    subject { @event.description }
-    it { should be @description }
+  context "missing some options" do
+    specify { lambda { Trackerific::Event.new(:date => Time.now, :description => '') }.should raise_error(ArgumentError) }
   end
   
-  describe :location do
-    subject { @event.location }
-    it { should be @location }
+  context "with invalid options" do
+    specify { lambda { Trackerific::Event.new(:hello => "world") }.should raise_error(ArgumentError) }
   end
-  
-  describe :to_s do
-    before { @regex = /(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (0[1-9]|[1-2][0-9]|3[01]) \d{2}:\d{2} (am|pm).*/ }
-    subject { @event.to_s }
-    it("should be in format mmm dd hh:mm am/pm.*") { should =~ @regex }
-  end
-  
 end

data/spec/lib/trackerific/service_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 class TestServiceClass < Trackerific::Service
   class << self
-    def required_options
+    def required_parameters
       [:required, :also_required]
     end
   end
@@ -10,8 +10,8 @@ end
 
 describe Trackerific::Service do
   
-  describe :required_options do
-    specify { Trackerific::Service.required_options.should be_kind_of Array }
+  describe :required_parameters do
+    specify { Trackerific::Service.required_parameters.should be_kind_of Array }
   end
   
   describe :service_name do

data/spec/lib/trackerific/services/fedex_spec.rb

@@ -3,15 +3,28 @@ require 'fakeweb'
 
 FEDEX_TRACK_URL = "https://gateway.fedex.com/GatewayDC"
 
-describe "Trackerific::FedEx" do
+describe Trackerific::FedEx do
   include Fixtures
   
-  describe :required_options do
-    subject { Trackerific::FedEx.required_options }
+  specify("it should descend from Trackerific::Service") {
+    Trackerific::FedEx.superclass.should be Trackerific::Service
+  }
+  
+  describe :required_parameters do
+    subject { Trackerific::FedEx.required_parameters }
     it { should include(:account) }
     it { should include(:meter) }
   end
   
+  describe :valid_options do
+    it "should include required_parameters" do
+      valid = Trackerific::FedEx.valid_options
+      Trackerific::FedEx.required_parameters.each do |opt|
+        valid.should include opt
+      end
+    end
+  end
+  
   describe :package_id_matchers do
     subject { Trackerific::FedEx.package_id_matchers }
     it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }

data/spec/lib/trackerific/services/mock_service_spec.rb

@@ -1,14 +1,29 @@
 require 'spec_helper'
 
 describe Trackerific::MockService do
-  describe :required_options do
-    subject { Trackerific::MockService.required_options }
+
+  specify("it should descend from Trackerific::Service") {
+    Trackerific::MockService.superclass.should be Trackerific::Service
+  }
+  
+  describe :required_parameters do
+    subject { Trackerific::MockService.required_parameters }
     it { should be_empty }
   end
   
   describe :package_id_matchers do
-    subject { Trackerific::MockService.package_id_matchers }
-    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
+  
+    context "when in development or test mode" do
+      subject { Trackerific::MockService.package_id_matchers }
+      it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
+    end
+    
+    context "when in production mode" do
+      before { Rails.env = "production" }
+      subject { Trackerific::MockService.package_id_matchers }
+      it { should be_empty }
+      after { Rails.env = "test"}
+    end
   end
   
   describe :track_package do

data/spec/lib/trackerific/services/ups_spec.rb

@@ -6,13 +6,26 @@ UPS_TRACK_URL = 'https://wwwcie.ups.com/ups.app/xml/Track'
 describe "Trackerific::UPS" do
   include Fixtures
   
-  describe :required_options do
-    subject { Trackerific::UPS.required_options }
+  specify("it should descend from Trackerific::Service") {
+    Trackerific::UPS.superclass.should be Trackerific::Service
+  }
+  
+  describe :required_parameters do
+    subject { Trackerific::UPS.required_parameters }
     it { should include(:key) }
     it { should include(:user_id) }
     it { should include(:password) }
   end
   
+  describe :valid_options do
+    it "should include required_parameters" do
+      valid = Trackerific::UPS.valid_options
+      Trackerific::UPS.required_parameters.each do |opt|
+        valid.should include opt
+      end
+    end
+  end
+  
   describe :package_id_matchers do
     subject { Trackerific::UPS.package_id_matchers }
     it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
@@ -59,6 +72,8 @@ describe "Trackerific::UPS" do
       
     end
     
+    pending "when server returns corrupted xml"
+    
   end
   
 end

data/spec/lib/trackerific/services/usps_spec.rb

@@ -1,19 +1,47 @@
 require 'spec_helper'
 require 'fakeweb'
 
-USPS_TRACK_URL = %r|http://testing\.shippingapis\.com/.*|
+USPS_URL = %r|http://testing\.shippingapis\.com/.*|
 
 describe Trackerific::USPS do
   include Fixtures
   
-  describe :required_options do
-    subject { Trackerific::USPS.required_options }
-    it { should include(:user_id) }
-  end
+  specify("it should descend from Trackerific::Service") {
+    Trackerific::USPS.superclass.should be Trackerific::Service
+  }
   
-  describe :package_id_matchers do
-    subject { Trackerific::UPS.package_id_matchers }
-    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
+  describe :city_state_lookup do
+    
+    before(:all) do
+      @usps = Trackerific::USPS.new :user_id => '123USERID4567'
+    end
+    
+    context "with a successful response from the server" do
+      
+      before(:all) do
+        FakeWeb.register_uri(:get, USPS_URL, :body => load_fixture(:usps_city_state_lookup_response))
+      end
+      
+      before(:each) do
+        @lookup = @usps.city_state_lookup("90210")
+      end
+      
+      subject { @lookup }
+      it { should include(:city) }
+      it { should include(:state) }
+      it { should include(:zip) }
+      
+    end
+    
+    context "with an error response from the server" do
+      
+      before(:all) do
+        FakeWeb.register_uri(:get, USPS_URL, :body => load_fixture(:usps_error_response))
+      end
+      
+      specify { lambda { @usps.city_state_lookup("90210") }.should raise_error(Trackerific::Error) }
+      
+    end
   end
   
   describe :track_package do
@@ -26,7 +54,7 @@ describe Trackerific::USPS do
     context "with a successful response from the server" do
       
       before(:all) do
-        FakeWeb.register_uri(:get, USPS_TRACK_URL, :body => load_fixture(:usps_success_response))
+        FakeWeb.register_uri(:get, USPS_URL, :body => load_fixture(:usps_success_response))
       end
       
       before(:each) do
@@ -48,15 +76,36 @@ describe Trackerific::USPS do
       
     end
     
+    pending "when use_city_state_lookup == true"
+    
     context "with an error response from the server" do
       
       before(:all) do
-        FakeWeb.register_uri(:get, USPS_TRACK_URL, :body => load_fixture(:usps_error_response))
+        FakeWeb.register_uri(:get, USPS_URL, :body => load_fixture(:usps_error_response))
       end
       
       specify { lambda { @usps.track_package(@package_id) }.should raise_error(Trackerific::Error) }
       
     end
   end
-    
+  
+  describe :required_parameters do
+    subject { Trackerific::USPS.required_parameters }
+    it { should include(:user_id) }
+  end
+  
+  describe :valid_options do
+    it "should include required_parameters" do
+      valid = Trackerific::USPS.valid_options
+      Trackerific::USPS.required_parameters.each do |opt|
+        valid.should include opt
+      end
+    end
+  end
+  
+  describe :package_id_matchers do
+    subject { Trackerific::UPS.package_id_matchers }
+    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
+  end
+  
 end

data/spec/lib/trackerific_spec.rb

@@ -48,13 +48,15 @@ describe Trackerific do
   
   describe :track_package do
     
-    before do
-      @details = track_package "XXXXXXXXXX"
+    context "with a valid package id" do
+      before { @details = track_package "XXXXXXXXXX" }
+      subject { @details }
+      it { should be_kind_of Trackerific::Details }
     end
     
-    subject { @details }
-    
-    it { should be_kind_of Trackerific::Details }
+    context "with an invalid package id" do
+      specify { lambda { track_package "XXXxxxxxxx" }.should raise_error(Trackerific::Error) }
+    end
   end
   
 end

data/trackerific.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackerific}
-  s.version = "0.5.5"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Haynes"]
-  s.date = %q{2011-06-24}
-  s.description = %q{Trackerific provides USPS, FedEx and UPS package tracking to Rails.}
+  s.date = %q{2011-06-27}
+  s.description = %q{Package tracking made easy for Rails. Currently supported services include FedEx, UPS, and USPS.}
   s.email = %q{travis.j.haynes@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -24,30 +24,7 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "doc/OptionsHelper.html",
-    "doc/Trackerific.html",
-    "doc/Trackerific/Configuration.html",
-    "doc/Trackerific/Details.html",
-    "doc/Trackerific/Error.html",
-    "doc/Trackerific/Event.html",
-    "doc/Trackerific/FedEx.html",
-    "doc/Trackerific/Service.html",
-    "doc/Trackerific/UPS.html",
-    "doc/Trackerific/USPS.html",
-    "doc/_index.html",
-    "doc/class_list.html",
-    "doc/css/common.css",
-    "doc/css/full_list.css",
-    "doc/css/style.css",
-    "doc/file.README.html",
-    "doc/file_list.html",
-    "doc/frames.html",
-    "doc/index.html",
-    "doc/js/app.js",
-    "doc/js/full_list.js",
-    "doc/js/jquery.js",
-    "doc/method_list.html",
-    "doc/top-level-namespace.html",
+    "changelog",
     "lib/helpers/options_helper.rb",
     "lib/trackerific.rb",
     "lib/trackerific/configuration.rb",
@@ -63,6 +40,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/fedex_success_response.xml",
     "spec/fixtures/ups_error_response.xml",
     "spec/fixtures/ups_success_response.xml",
+    "spec/fixtures/usps_city_state_lookup_response.xml",
     "spec/fixtures/usps_error_response.xml",
     "spec/fixtures/usps_success_response.xml",
     "spec/lib/helpers/options_helper_spec.rb",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 5
-  version: 0.5.5
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Travis Haynes
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 -07:00
+date: 2011-06-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -152,7 +152,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id009
-description: Trackerific provides USPS, FedEx and UPS package tracking to Rails.
+description: Package tracking made easy for Rails. Currently supported services include FedEx, UPS, and USPS.
 email: travis.j.haynes@gmail.com
 executables: []
 
@@ -169,30 +169,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- doc/OptionsHelper.html
-- doc/Trackerific.html
-- doc/Trackerific/Configuration.html
-- doc/Trackerific/Details.html
-- doc/Trackerific/Error.html
-- doc/Trackerific/Event.html
-- doc/Trackerific/FedEx.html
-- doc/Trackerific/Service.html
-- doc/Trackerific/UPS.html
-- doc/Trackerific/USPS.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
+- changelog
 - lib/helpers/options_helper.rb
 - lib/trackerific.rb
 - lib/trackerific/configuration.rb
@@ -208,6 +185,7 @@ files:
 - spec/fixtures/fedex_success_response.xml
 - spec/fixtures/ups_error_response.xml
 - spec/fixtures/ups_success_response.xml
+- spec/fixtures/usps_city_state_lookup_response.xml
 - spec/fixtures/usps_error_response.xml
 - spec/fixtures/usps_success_response.xml
 - spec/lib/helpers/options_helper_spec.rb
@@ -239,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2587276828587916767
+      hash: -4113113106742539098
       segments: 
       - 0
       version: "0"