trackerific 0.3.5 → 0.4.0

data/spec/lib/trackerific/event_spec.rb

@@ -1,20 +1,33 @@
 require 'spec_helper'
 
 describe Trackerific::Event do
-  before(:all) do
+  
+  before do
     @date = Time.now
-    @event = Trackerific::Event.new(Time.new, String.new, String.new)
+    @description = "description"
+    @location = "location"
+    @event = Trackerific::Event.new(@date, @description, @location)
+  end
+  
+  describe :date do
+    subject { @event.date }
+    it { should be @date }
   end
   
-  describe "date" do
-    specify { @event.date.should be_a Time }
+  describe :description do
+    subject { @event.description }
+    it { should be @description }
   end
   
-  describe "description" do
-    specify { @event.description.should be_a String }
+  describe :location do
+    subject { @event.location }
+    it { should be @location }
   end
   
-  describe "location" do
-    specify { @event.location.should be_a String }
+  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

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class TestServiceClass < Trackerific::Service
+  def self.required_options
+    [:required, :also_required]
+  end
+end
+
+describe Trackerific::Service do
+  
+  context "with a new Trackerific::Service class that has required options" do
+    
+    context "has all the required options" do
+      it "should be able to create a new instance" do
+        t = TestServiceClass.new(:required => true, :also_required => :yup)
+        t.should be_a TestServiceClass
+      end
+    end
+    
+    context "is missing some required options" do
+      it "should raise an ArgumentError" do
+        lambda { TestServiceClass.new() }.should raise_error(ArgumentError)
+      end
+    end
+    
+    context "has an invalid option" do
+      it "should raise an ArgumentError" do
+        lambda { TestServiceClass.new(:unknown => :argument ) }.should raise_error(ArgumentError)
+      end
+    end
+    
+  end
+  
+end

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

@@ -13,9 +13,8 @@ describe "Trackerific::FedEx" do
   end
   
   describe :package_id_matchers do
-    it "should be an Array of Regexp" do
-      Trackerific::FedEx.package_id_matchers.should each { |m| m.should be_a Regexp }
-    end
+    subject { Trackerific::FedEx.package_id_matchers }
+    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
   end
   
   describe :track_package do
@@ -25,25 +24,40 @@ describe "Trackerific::FedEx" do
     end
     
     context "with a successful response from the server" do
-      before(:each) do
+      
+      before(:all) do
         FakeWeb.register_uri(:post, FEDEX_TRACK_URL, :body => load_fixture(:fedex_success_response))
+      end
+      
+      before(:each) do
         @tracking = @fedex.track_package(@package_id)
       end
-      specify { @tracking.should be_a Trackerific::Details }
-      it "should have at least one event" do
-        @tracking.events.length.should >= 1
+      
+      subject { @tracking }
+      it("should return a Trackerific::Details") { should be_a Trackerific::Details }
+      
+      describe "events.length" do
+        subject { @tracking.events.length }
+        it { should >= 1}
       end
-      it "should have a summary" do
-        @tracking.summary.should_not be_empty
+      
+      describe :summary do
+        subject { @tracking.summary }
+        it { should_not be_empty }
       end
+      
     end
     
     context "with an error response from the server" do
+      
       before(:all) do
         FakeWeb.register_uri(:post, FEDEX_TRACK_URL, :body => load_fixture(:fedex_error_response))
       end
+      
       specify { lambda { @fedex.track_package("invalid package id") }.should raise_error(Trackerific::Error) }
+      
     end
+    
   end
   
 end

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

@@ -14,9 +14,8 @@ describe "Trackerific::UPS" do
   end
   
   describe :package_id_matchers do
-    it "should be an Array of Regexp" do
-      Trackerific::UPS.package_id_matchers.should each { |m| m.should be_a Regexp }
-    end
+    subject { Trackerific::UPS.package_id_matchers }
+    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
   end
   
   describe :track_package do
@@ -26,24 +25,40 @@ describe "Trackerific::UPS" do
     end
     
     context "with a successful response from the server" do
+      
       before(:all) do
         FakeWeb.register_uri(:post, UPS_TRACK_URL, :body => load_fixture(:ups_success_response))
+      end
+      
+      before(:each) do
         @tracking = @ups.track_package(@package_id)
       end
-      specify { @tracking.should be_a Trackerific::Details }
-      it "should have at least one event" do
-        @tracking.events.length.should >= 1
+      
+      subject { @tracking }
+      it("should return a Trackerific::Details") { should be_a Trackerific::Details }
+      
+      describe "events.length" do
+        subject { @tracking.events.length }
+        it { should >= 1 }
       end
-      it "should have a summary" do
-        @tracking.summary.should_not be_empty
+      
+      describe :summary do
+        subject { @tracking.summary }
+        it { should_not be_empty }
       end
+      
     end
     
     context "with an error response from the server" do
+      
       before(:all) do
         FakeWeb.register_uri(:post, UPS_TRACK_URL, :body => load_fixture(:ups_error_response))
       end
+      
       specify { lambda { @ups.track_package("invalid package id") }.should raise_error(Trackerific::Error) }
+      
     end
+    
   end
+  
 end

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

@@ -12,36 +12,50 @@ describe Trackerific::USPS do
   end
   
   describe :package_id_matchers do
-    it "should be an Array of Regexp" do
-      Trackerific::UPS.package_id_matchers.should each { |m| m.should be_a Regexp }
-    end
+    subject { Trackerific::UPS.package_id_matchers }
+    it("should be an Array of Regexp") { should each { |m| m.should be_a Regexp } }
   end
   
   describe :track_package do
+    
     before(:all) do
       @package_id = 'EJ958083578US'
       @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_TRACK_URL, :body => load_fixture(:usps_success_response))
+      end
+      
+      before(:each) do
         @tracking = @usps.track_package(@package_id)
       end
-      specify { @tracking.should be_a Trackerific::Details }
-      it "should have at least one event" do
-        @tracking.events.length.should >= 1
+      
+      subject { @tracking }
+      it("should return a Trackerific::Details") { should be_a Trackerific::Details }
+      
+      describe "events.length" do
+        subject { @tracking.events.length }
+        it { should >= 1 }
       end
-      it "should have a summary" do
-        @tracking.summary.should_not be_empty
+      
+      describe :summary do
+        subject { @tracking.summary }
+        it { should_not be_empty }
       end
+      
     end
     
     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))
       end
+      
       specify { lambda { @usps.track_package(@package_id) }.should raise_error(Trackerific::Error) }
+      
     end
   end
     

data/spec/lib/trackerific_spec.rb

@@ -1,25 +1,47 @@
 require 'spec_helper'
 
-describe "Trackerific" do
+describe Trackerific do
   include Trackerific
   
-  describe "tracking_service" do
-    include Trackerific
+  describe :services do
+    subject { Trackerific.services }
+    it("should be an Array of Symbols") { should each { |m| m.should be_a Symbol } }
+  end
+  
+  describe :service_get do
+    
+    context "with a valid service symbol" do
+      subject { Trackerific.service_get(:fedex).superclass }
+      it("should be a descendant of Trackerific::Service "){ should be Trackerific::Service }
+    end
+    
+    context "with an invalid service symbol" do
+      subject { Trackerific.service_get :ksjdfklsjdf }
+      it { should be_nil }
+    end
+    
+  end
+  
+  describe :tracking_service do
     
     context "when given a UPS tracking number" do
-      specify { tracking_service("1Z12345E0291980793").should eq Trackerific::UPS }
+      subject { tracking_service "1Z12345E0291980793" }
+      it { should be Trackerific::UPS}
     end
     
     context "when given a USPS tracking number" do
-      specify { tracking_service("EJ958083578US").should eq Trackerific::USPS }
+      subject { tracking_service "EJ958083578US" }
+      it { should be Trackerific::USPS }
     end
     
     context "when given a FedEx tracking number" do
-      specify { tracking_service("183689015000001").should eq Trackerific::FedEx }
+      subject { tracking_service "183689015000001" }
+      it { should be Trackerific::FedEx }
     end
     
     context "when given an invalid tracking number" do
-      specify { tracking_service("invalid tracking number").should be_nil }
+      subject { tracking_service "invalid tracking number" }
+      it { should be_nil }
     end
     
   end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# Code coverage
 require 'simplecov'
 SimpleCov.start
 

data/spec/support/fixtures.rb

@@ -1,14 +1,20 @@
+# Provides easy access to XML fixtures
 module Fixtures
-  
+  # Gets the path to the fixtures
+  # @return [String]
+  # @api private
+  def fixture_path
+    File.join(File.dirname(__FILE__), "..", "fixtures")
+  end
+  # Loads a fixture
+  # @param [Symbol] name the fixture to load
+  # @param [Symbol] ext the exention of the fixture. defaults to :xml
+  # @example Load ups_success_response.xml
+  #   response = load_fixture :ups_success_response
+  # @return [String] the contents of the file
+  # @api private
   def load_fixture(name, ext = :xml)
-    
-    file_name = File.join("spec/fixtures/", "#{name.to_s}.#{ext.to_s}")
-    f = File.open(file_name, 'r')
-    data = "";
-    f.lines.each { |line| data += line }
-    f.close
-    return data
-    
+    file_name = File.join(fixture_path, "#{name.to_s}.#{ext.to_s}")
+    File.read(file_name)
   end
-  
 end

data/spec/support/trackerific.rb

@@ -1,5 +1,3 @@
-# Provides a Rails application environment to use when running the specs.
-
 require 'rails'
 
 require "action_controller/railtie"
@@ -7,12 +5,14 @@ require "action_mailer/railtie"
 require "active_resource/railtie"
 
 module Trackerific
+  # Provides a Rails application environment to use when running the specs
   class Application < Rails::Application
     config.encoding = 'utf-8'
   end
   
   Application.configure do
     config.active_support.deprecation = :stderr
+    config.logger = Logger.new(STDOUT)
   end
 end
 

data/trackerific.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackerific}
-  s.version = "0.3.5"
+  s.version = "0.4.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-14}
+  s.date = %q{2011-06-15}
   s.description = %q{Trackerific provides USPS, FedEx and UPS package tracking to Rails.}
   s.email = %q{travis.j.haynes@gmail.com}
   s.extra_rdoc_files = [
@@ -24,12 +24,14 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "doc/OptionsHelper.html",
     "doc/Trackerific.html",
-    "doc/Trackerific/Base.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",
@@ -46,11 +48,13 @@ Gem::Specification.new do |s|
     "doc/js/jquery.js",
     "doc/method_list.html",
     "doc/top-level-namespace.html",
+    "lib/helpers/options_helper.rb",
     "lib/trackerific.rb",
-    "lib/trackerific/base.rb",
+    "lib/trackerific/configuration.rb",
     "lib/trackerific/details.rb",
     "lib/trackerific/error.rb",
     "lib/trackerific/event.rb",
+    "lib/trackerific/service.rb",
     "lib/trackerific/services/fedex.rb",
     "lib/trackerific/services/ups.rb",
     "lib/trackerific/services/usps.rb",
@@ -60,10 +64,11 @@ Gem::Specification.new do |s|
     "spec/fixtures/ups_success_response.xml",
     "spec/fixtures/usps_error_response.xml",
     "spec/fixtures/usps_success_response.xml",
-    "spec/lib/trackerific/base_spec.rb",
+    "spec/lib/trackerific/configuration_spec.rb",
     "spec/lib/trackerific/details_spec.rb",
     "spec/lib/trackerific/error_spec.rb",
     "spec/lib/trackerific/event_spec.rb",
+    "spec/lib/trackerific/service_spec.rb",
     "spec/lib/trackerific/services/fedex_spec.rb",
     "spec/lib/trackerific/services/ups_spec.rb",
     "spec/lib/trackerific/services/usps_spec.rb",
@@ -89,20 +94,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.13"])
       s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_development_dependency(%q<yardstick>, [">= 0.4.0"])
       s.add_development_dependency(%q<rspec-rails>, [">= 2.6.1"])
       s.add_development_dependency(%q<rspec_multi_matchers>, [">= 1.1.0"])
       s.add_development_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-      s.add_development_dependency(%q<yardstick>, [">= 0.4.0"])
     else
       s.add_dependency(%q<rails>, [">= 3.0.0"])
       s.add_dependency(%q<httparty>, [">= 0.7.7"])
       s.add_dependency(%q<builder>, [">= 2.1.2"])
       s.add_dependency(%q<bundler>, [">= 1.0.13"])
       s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_dependency(%q<yardstick>, [">= 0.4.0"])
       s.add_dependency(%q<rspec-rails>, [">= 2.6.1"])
       s.add_dependency(%q<rspec_multi_matchers>, [">= 1.1.0"])
       s.add_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-      s.add_dependency(%q<yardstick>, [">= 0.4.0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.0.0"])
@@ -110,10 +115,10 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<builder>, [">= 2.1.2"])
     s.add_dependency(%q<bundler>, [">= 1.0.13"])
     s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+    s.add_dependency(%q<yardstick>, [">= 0.4.0"])
     s.add_dependency(%q<rspec-rails>, [">= 2.6.1"])
     s.add_dependency(%q<rspec_multi_matchers>, [">= 1.1.0"])
     s.add_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-    s.add_dependency(%q<yardstick>, [">= 0.4.0"])
   end
 end