trackerific 0.6.2 → 0.7.0

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

@@ -1,111 +1,97 @@
 require 'spec_helper'
-require 'fakeweb'
 
 USPS_URL = %r|http://testing\.shippingapis\.com/.*|
 
-describe Trackerific::USPS do
-  include Fixtures
-  
-  specify("it should descend from Trackerific::Service") {
-    Trackerific::USPS.superclass.should be Trackerific::Service
-  }
-  
-  describe :city_state_lookup do
-    
-    before(:all) do
-      @usps = Trackerific::USPS.new :user_id => '123USERID4567'
+describe Trackerific::Services::USPS do
+  it { should be_a Trackerific::Services::Base }
+
+  let(:valid_ids) { ["EJ958083578US"] }
+  let(:invalid_ids) { %w[these are not valid tracking ids] }
+
+  it "should match valid tracking ids" do
+    valid_ids.all? {|id| described_class.can_track?(id) }.should be_true
+  end
+
+  it "should not match invalid tracking ids" do
+    invalid_ids.all? {|id| described_class.can_track?(id) }.should be_false
+  end
+
+  let(:credentials) { { user_id: '123USERID4567' } }
+  let(:usps) { described_class.new(credentials) }
+
+  describe "#city_state_lookup" do
+    before do
+      FakeWeb.register_uri(:get, USPS_URL, body: fixture)
     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")
+
+    after(:all) { FakeWeb.clean_registry }
+
+    context "with a successful response" do
+      let(:fixture) { Fixture.read('usps/city_state_lookup.xml') }
+      subject { usps.city_state_lookup("90210") }
+      it "should have the correct values" do
+        subject[:city].should eq "BEVERLY HILLS"
+        subject[:state].should eq "CA"
+        subject[:zip].should eq "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))
+
+    context "with an error response" do
+      let(:fixture) { Fixture.read('usps/error.xml') }
+      it "should raise a Trackerific::Error" do
+        expect {
+          usps.city_state_lookup("90210")
+        }.to raise_error Trackerific::Error
       end
-      
-      specify { lambda { @usps.city_state_lookup("90210") }.should raise_error(Trackerific::Error) }
-      
     end
   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_URL, :body => load_fixture(:usps_success_response))
-      end
-      
-      before(:each) do
-        @tracking = @usps.track_package(@package_id)
-      end
-      
-      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
-      
-      describe :summary do
-        subject { @tracking.summary }
-        it { should_not be_empty }
-      end
-      
+
+  describe "#track" do
+    let(:id) { 'EJ958083578US' }
+
+    before do
+      FakeWeb.register_uri(:get, USPS_URL, body: fixture)
     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_URL, :body => load_fixture(:usps_error_response))
+
+    after(:all) { FakeWeb.clean_registry }
+
+    context "with a successful response" do
+      let(:fixture) { Fixture.read('usps/success.xml') }
+
+      subject { usps.track(id) }
+
+      it { should be_a Trackerific::Details }
+
+      its(:package_id) { should eq id }
+      its(:summary) { should eq "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801." }
+      its(:events) { should be_a Array }
+      its(:weight) { should be_nil }
+      its(:via) { should be_nil }
+
+      describe "#events" do
+        subject { usps.track(id).events }
+        its(:length) { should eq 3 }
+        it "should have the correct values" do
+          subject[0].date.to_s.should eq "2013-05-30T11:07:00+00:00"
+          subject[0].description.should eq "Notice left"
+          subject[0].location.should eq "WILMINGTON, DE 19801"
+          subject[1].date.to_s.should eq "2013-05-30T10:08:00+00:00"
+          subject[1].description.should eq "Arrival at unit"
+          subject[1].location.should eq "WILMINGTON, DE 19850"
+          subject[2].date.to_s.should eq "2013-05-29T09:55:00+00:00"
+          subject[2].description.should eq "Accept or pickup"
+          subject[2].location.should eq "EDGEWATER, NJ 07020"
+        end
       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
+
+    context "with an error response" do
+      let(:fixture) { Fixture.read('usps/error.xml') }
+      it "should raise a Trackerific::Error" do
+        expect {
+          usps.track(id)
+        }.to raise_error Trackerific::Error
       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/services_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Trackerific::Services do
+  describe "#[]=" do
+    context "with a Trackerific::Services::Base" do
+      it "should add service" do
+        Trackerific::Services[:test] = TestService
+        Trackerific::Services[:test].should eq TestService
+      end
+    end
+
+    context "with a class other than Trackerific::Services::Base" do
+      it "should raise an ArgumentError" do
+        expect {
+          Trackerific::Services[:string] = String
+        }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "#[]" do
+    it "should find registered services" do
+      Trackerific::Services[:another_test_service].should eq AnotherTestService
+    end
+
+    it "should return nil for unknown services" do
+      Trackerific::Services[:not_found].should be_nil
+    end
+  end
+
+  describe "#find_by_package_id" do
+    let(:id) { "TEST" }
+    subject { Trackerific::Services.find_by_package_id(id) }
+    it { should include TestService }
+    it { should include AnotherTestService }
+  end
+end

data/spec/lib/trackerific/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Trackerific::VERSION do
+  it { should eq "0.7.0" }
+end

data/spec/lib/trackerific_spec.rb

@@ -1,62 +1,24 @@
 require 'spec_helper'
 
 describe Trackerific do
-  include Trackerific
-  
-  describe :services do
-    subject { Trackerific.services }
-    it("should be an Array of Symbols") { should each { |m| m.should be_a Symbol } }
+  describe "#configuration" do
+    subject { Trackerific.configuration }
+    it { should eq Trackerific::Configuration.config }
   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
-      subject { tracking_service "1Z12345E0291980793" }
-      it { should be Trackerific::UPS}
-    end
-    
-    context "when given a USPS tracking number" do
-      subject { tracking_service "EJ958083578US" }
-      it { should be Trackerific::USPS }
-    end
-    
-    context "when given a FedEx tracking number" do
-      subject { tracking_service "183689015000001" }
-      it { should be Trackerific::FedEx }
-    end
-    
-    context "when given an invalid tracking number" do
-      subject { tracking_service "invalid tracking number" }
-      it { should be_nil }
+
+  describe "#configure" do
+    it "should delegate to Trackerific::Configuration.configure" do
+      Trackerific.configure {|config| config.this = :value }
+      Trackerific.configuration.this.should eq :value
     end
-    
   end
-  
-  describe :track_package do
-    
-    context "with a valid package id" do
-      before { @details = track_package "XXXXXXXXXX" }
-      subject { @details }
-      it { should be_kind_of Trackerific::Details }
-    end
-    
-    context "with an invalid package id" do
-      specify { lambda { track_package "XXXxxxxxxx" }.should raise_error(Trackerific::Error) }
+
+  describe "#track" do
+    it "should return an Array of Trackerific::Details" do
+      results = Trackerific.track("TEST")
+      results.should be_a Array
+      results.count.should eq 2
+      results.all? {|r| r.should be_a Trackerific::Details }
     end
   end
-  
 end

data/spec/spec_helper.rb

@@ -1,16 +1,9 @@
-# Code coverage
-require 'simplecov'
-SimpleCov.start
+ENV['RAILS_ENV'] = 'test'
 
 require 'rubygems'
 require 'bundler/setup'
 require 'trackerific'
-require 'rspec_multi_matchers'
+require 'fakeweb'
 
 # load all the support files
 Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
-require 'rspec/rails' # this has to be loaded after the support files
-
-RSpec.configure do |config|
-  config.mock_with :rspec
-end

data/spec/support/fixtures.rb

@@ -1,20 +1,6 @@
-# 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(fixture_path, "#{name.to_s}.#{ext.to_s}")
-    File.read(file_name)
+class Fixture
+  def self.read(name)
+    fixtures_path = File.expand_path("../../fixtures", __FILE__)
+    File.read(File.join(fixtures_path, name))
   end
 end

data/spec/support/test_services.rb

@@ -0,0 +1,23 @@
+class TestService < Trackerific::Services::Base
+  self.register :test
+
+  def self.package_id_matchers
+    [ /^TEST$/ ]
+  end
+
+  def track(id)
+    return Trackerific::Details.new
+  end
+end
+
+class AnotherTestService < Trackerific::Services::Base
+  self.register :another_test_service
+
+  def self.package_id_matchers
+    [ /^TEST$/ ]
+  end
+
+  def track(id)
+    return Trackerific::Details.new
+  end
+end

data/trackerific.gemspec

@@ -1,107 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trackerific/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{trackerific}
-  s.version = "0.6.2"
+Gem::Specification.new do |spec|
+  spec.name          = "trackerific"
+  spec.version       = Trackerific::VERSION
+  spec.authors       = ["Travis Haynes"]
+  spec.email         = ["travis.j.haynes@gmail.com"]
+  spec.description   = %q{Package tracking made easy. Currently supported services include FedEx, UPS, and USPS.}
+  spec.summary       = %q{Package tracking made easy.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Travis Haynes"]
-  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",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "changelog",
-    "examples/custom_service_spec.rb",
-    "lib/helpers/options_helper.rb",
-    "lib/trackerific.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/mock_service.rb",
-    "lib/trackerific/services/ups.rb",
-    "lib/trackerific/services/usps.rb",
-    "spec/fixtures/fedex_error_response.xml",
-    "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",
-    "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/mock_service_spec.rb",
-    "spec/lib/trackerific/services/ups_spec.rb",
-    "spec/lib/trackerific/services/usps_spec.rb",
-    "spec/lib/trackerific_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/support/fixtures.rb",
-    "spec/support/trackerific.rb",
-    "trackerific.gemspec"
-  ]
-  s.homepage = %q{http://github.com/travishaynes/trackerific}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{trackerific}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Trackerific provides package tracking to Rails.}
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  spec.add_dependency 'httparty', '~> 0.12.0'
+  spec.add_dependency 'builder', '~> 3.2.2'
+  spec.add_dependency 'activesupport'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0.7.7"])
-      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"])
-    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"])
-    end
-  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"])
-  end
+  spec.add_development_dependency 'bundler', '>= 1.3.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.6.0'
+  spec.add_development_dependency 'fakeweb', '~> 1.3.0'
 end
-