trackerific 0.4.2 → 0.5.0

data/README.rdoc

@@ -7,6 +7,9 @@ and then run
 
 == Usage
 
+If you would like to see a functional example of this gem in action, check out the
+sample Rails app here: {package-tracker}[https://github.com/travishaynes/package-tracker]
+
 === Configuration
 
 To take advantage of Trackerific's automatic service discovery, you will need to
@@ -149,6 +152,14 @@ of the comments of your code. You can use the rake task:
   rake yardstick_measure
 which will generate a measurement/report.txt file.
 
+=== Testing with Trackerific
+
+Trackerific provides a mocked service you can use in your unit tests of your
+application. The mocked service will be available in development and test
+environments only, and disabled in production.
+
+  details = track_package("XXXXXXXXXX") # => returns a populated Trackerific::Details
+  details = track_package("XXXxxxxxxx") # => throws a Trackerific::Errror exception
 
 == Contributing to trackerific
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/helpers/options_helper.rb

@@ -3,17 +3,20 @@ module OptionsHelper
   # Validates a list of options against a list of required options
   # @param [Array] options list of options to validate
   # @param [Array] required list of required options
+  # @param [Array] valid list of additional valid options
   # @return true
   # @raise [ArgumentError] if the options do not pass validation
   # @api private
-  def validate_options(options, required)
+  def validate_options(options, required = [], valid = [])
+    options = {} if options.nil?
+    required = {} if required.nil?
     # make sure all the required options exist
     required.each do |k|
       raise ArgumentError.new("Missing required parameter: #{k}") unless options.has_key?(k)
     end
     # make sure no invalid options exist
     options.each do |k, v|
-      raise ArgumentError.new("Invalid parameter: #{k}") unless required.include?(k)
+      raise ArgumentError.new("Invalid parameter: #{k}") unless required.include?(k) || valid.include?(k)
     end
     true
   end

data/lib/trackerific/services/mock_service.rb

@@ -0,0 +1,54 @@
+require 'date'
+
+module Trackerific
+  
+  # Provides a mock service for using in test and development
+  class MockService < Trackerific::Service
+    
+    class << self
+      # Regular expression matchers for mocked Trackerific service
+      # @return [Array, Regexp] the regular expression
+      # @api private
+      def package_id_matchers
+        if defined?(Rails)
+          return [ /XXXXXXXXXX/, /XXXxxxxxxx/ ] unless Rails.env.production?
+        else
+          return [ ] # no matchers in production mode
+        end
+      end
+      
+      # Returns an Array of required options used when creating a new instance
+      # @return [Array] required options
+      # @api private
+      def required_options
+        [ ]
+      end
+    end
+    
+    # Sets up a mocked package details
+    # @param [String] package_id the package identifier
+    # @return [Trackerific::Details] the tracking details
+    # @raise [Trackerific::Error] raised when the server returns an error
+    # @example Track a package
+    #   service = Trackerific::MockedService.new
+    #   details = service.track_package("XXXXXXXXXX") # => valid response
+    #   details = service.track_package("XXXxxxxxxx") # => throws a Trackerific::Error exception
+    # @api public
+    def track_package(package_id)
+      super
+      if package_id == "XXXXXXXXXX"
+        Trackerific::Details.new(
+          package_id,
+          "Your package was delivered.",
+          [
+            Trackerific::Event.new(Date.today, "Package delivered.", "SANTA MARIA, CA"),
+            Trackerific::Event.new(Date.today - 1, "Package scanned.", "SANTA BARBARA, CA"),
+            Trackerific::Event.new(Date.today - 2, "Package picked up for delivery.", "LOS ANGELES, CA")
+          ]
+        )
+      else
+        raise Trackerific::Error, "Package not found."
+      end
+    end
+  end
+end

data/spec/lib/helpers/options_helper_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe OptionsHelper do
+  include OptionsHelper
+  
+  describe :validate_options do
+  
+    context "with all required options" do
+      before do
+        @required = [:hello, :world]
+        @options = {:hello => true, :world => true}
+      end
+      subject { validate_options(@options, @required) }
+      it { should be true }
+    end
+    
+    context "with missing required options" do
+      before do
+        @required = [:hello, :world]
+        @options = {:hello => true}
+      end
+      specify { lambda { validate_options(@options, @required) }.should raise_error(ArgumentError) }
+    end
+    
+    context "with no required options" do
+      before do
+        @required = []
+        @options = {}
+      end
+      subject { validate_options(@options, @required) }
+      it { should be true }
+    end
+    
+    context "when required is nil" do
+      before do
+        @required = nil
+        @options = {}
+      end
+      subject { validate_options(@options, @required) }
+      it { should be true }
+    end
+    
+    context "when options is nil" do
+      before do
+        @required = []
+        @options = nil
+      end
+      subject { validate_options(@options, @required) }
+      it { should be true }
+    end
+    
+    context "when required and options are nil" do
+      before do
+        @required = nil
+        @options = nil
+      end
+      subject { validate_options(@options, @required) }
+      it { should be true }
+    end
+    
+    context "with valid options" do
+      before do
+        @required = nil
+        @options = {:valid => true}
+        @valid = [:valid]
+      end
+      subject { validate_options(@options, @required, @valid) }
+      it { should be true }
+    end
+    
+    context "with invalid options" do
+      before do
+        @required = nil
+        @options = {:invalid => true}
+        @valid = [:valid]
+      end
+      subject { validate_options(@options, @required, @valid) }
+      specify { lambda { validate_options(@options, @required) }.should raise_error(ArgumentError) }
+    end
+  end
+  
+end

data/spec/lib/trackerific/service_spec.rb

@@ -10,6 +10,14 @@ end
 
 describe Trackerific::Service do
   
+  describe :required_options do
+    specify { Trackerific::Service.required_options.should be_kind_of Array }
+  end
+  
+  describe :service_name do
+    specify { Trackerific::Service.service_name.should be_kind_of String }
+  end
+  
   context "with a new Trackerific::Service class that has required options" do
     
     context "has all the required options" do

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Trackerific::MockService do
+  describe :required_options do
+    subject { Trackerific::MockService.required_options }
+    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 } }
+  end
+  
+  describe :track_package do
+    before(:all) do
+      @service = Trackerific::MockService.new
+    end
+    
+    context "with valid package_id" do
+      before { @tracking = @service.track_package("XXXXXXXXXX") }
+      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
+    end
+    
+    context "with invalid package_id" do
+      specify { lambda { @service.track_package("XXXxxxxxxx") }.should raise_error(Trackerific::Error) }
+    end
+    
+  end
+  
+end

data/spec/lib/trackerific_spec.rb

@@ -46,4 +46,15 @@ describe Trackerific do
     
   end
   
+  describe :track_package do
+    
+    before do
+      @details = track_package "XXXXXXXXXX"
+    end
+    
+    subject { @details }
+    
+    it { should be_kind_of Trackerific::Details }
+  end
+  
 end

data/trackerific.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackerific}
-  s.version = "0.4.2"
+  s.version = "0.5.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-16}
+  s.date = %q{2011-06-23}
   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 = [
@@ -56,6 +56,7 @@ Gem::Specification.new do |s|
     "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",
@@ -64,12 +65,14 @@ 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/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",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Travis Haynes
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 -07:00
+date: 2011-06-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -201,6 +201,7 @@ files:
 - 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
@@ -209,12 +210,14 @@ files:
 - spec/fixtures/ups_success_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
@@ -236,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -748317933
+      hash: 3271480646841924991
       segments: 
       - 0
       version: "0"