binarylogic-shippinglogic 1.0.8 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 1.1.0 released 2009-07-16
+
+* Added another layer to tracking. You dont get an array of events anymore, you get a Shippinglogic::Fedex::Track::Details object that has information the single shipment. Such as delivery date, signature name, etc. To access the events you just call the events method on this object.
+* Added speed to rates.
+
 == 1.0.8 released 2009-07-09
 
 * Fix insurance request format.

data/README.rdoc

@@ -148,7 +148,7 @@ Here is what I did in an application of mine and it worked out great. I also hav
 
   class Shipment < ActiveRecord::Base
     class Service
-      attr_accessor :carrier, :name, delivered_by, :rate
+      attr_accessor :carrier, :name, "delivered_by, :rate
     end
     
     def services
@@ -157,7 +157,7 @@ Here is what I did in an application of mine and it worked out great. I also hav
     
     private
       def fedex_services
-        rate_options = {} # fill me with options accepted by Shippinglogic::FedEx::Rate
+        rate_options = {} # replace me with your own options accepted by Shippinglogic::FedEx::Rate
         fedex.rate(rate_options).collect do |rate|
           service = Service.new
           service.carrier = :fedex

data/Rakefile

@@ -15,9 +15,7 @@ begin
     gem.add_dependency "activesupport", ">= 2.2.0"
     gem.add_dependency "httparty", ">= 0.4.4"
   end
-  Jeweler::RubyforgeTasks.new do |rubyforge|
-    rubyforge.doc_task = nil
-  end
+  Jeweler::RubyforgeTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
@@ -34,4 +32,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
+task :spec => :check_dependencies
+
 task :default => :spec

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
-:patch: 8
+:minor: 1
+:patch: 0
 :major: 1

data/lib/shippinglogic/fedex.rb

@@ -1,5 +1,6 @@
 require "shippinglogic/fedex/enumerations"
 require "shippinglogic/fedex/error"
+require "shippinglogic/fedex/proxy"
 require "shippinglogic/fedex/service"
 require "shippinglogic/fedex/cancel"
 require "shippinglogic/fedex/rate"

data/lib/shippinglogic/fedex/proxy.rb

@@ -0,0 +1,21 @@
+module Shippinglogic
+  class FedEx
+    class Proxy
+      alias_method :real_class, :class
+      instance_methods.each { |m| undef_method m unless m =~ /(^__|^real_class$|^send$|^object_id$)/ }
+      
+      attr_accessor :target
+      
+      def initialize(target)
+        self.target = target
+      end
+      
+      protected
+        # We undefined a lot of methods at the beginning of this class. The only methods present in this
+        # class are ones that we need, everything else is delegated to our target object.
+        def method_missing(name, *args, &block)
+          target.send(name, *args, &block)
+        end
+    end
+  end
+end

data/lib/shippinglogic/fedex/rate.rb

@@ -87,7 +87,7 @@ module Shippinglogic
     #   # => "First Overnight"
     class Rate < Service
       # Each rate result is an object of this class
-      class Service; attr_accessor :name, :type, :saturday, :delivered_by, :rate, :currency; end
+      class Service; attr_accessor :name, :type, :saturday, :delivered_by, :speed, :rate, :currency; end
       
       VERSION = {:major => 6, :intermediate => 0, :minor => 0}
       
@@ -176,6 +176,14 @@ module Shippinglogic
             shipment_detail = details[:rated_shipment_details].is_a?(Array) ? details[:rated_shipment_details].first : details[:rated_shipment_details]
             cost = shipment_detail[:shipment_rate_detail][:total_net_charge]
             delivered_by = details[:delivery_timestamp] && Time.parse(details[:delivery_timestamp])
+            speed = case details[:service_type]
+            when /overnight/i
+              1.day
+            when /2_day/i
+              2.days
+            else
+              3.days
+            end
             
             if meets_deadline?(delivered_by)
               service = Service.new
@@ -183,6 +191,7 @@ module Shippinglogic
               service.type = details[:service_type]
               service.saturday = details[:applied_options] == "SATURDAY_DELIVERY"
               service.delivered_by = delivered_by
+              service.speed = speed
               service.rate = BigDecimal.new(cost[:amount])
               service.currency = cost[:currency]
               service

data/lib/shippinglogic/fedex/service.rb

@@ -5,10 +5,7 @@ require "shippinglogic/fedex/validation"
 
 module Shippinglogic
   class FedEx
-    class Service
-      alias_method :real_class, :class
-      instance_methods.each { |m| undef_method m unless m =~ /(^__|^real_class$|^send$|^object_id$)/ }
-      
+    class Service < Proxy
       include Attributes
       include HTTParty
       include Request
@@ -25,12 +22,6 @@ module Shippinglogic
       end
       
       private
-        # We undefined a lot of methods at the beginning of this class. The only methods present in this
-        # class are ones that we need, everything else is delegated to our target object.
-        def method_missing(name, *args, &block)
-          target.send(name, *args, &block)
-        end
-        
         # Allows the cached response to be reset, specifically when an attribute changes
         def reset_target
           @target = nil

data/lib/shippinglogic/fedex/track.rb

@@ -27,8 +27,66 @@ module Shippinglogic
     # be fairly simple to add, but I could not think of a reason why anyone would want to track
     # a package with anything other than a tracking number.
     class Track < Service
-      # Each tracking result is an object of this class
-      class Event; attr_accessor :name, :type, :occured_at, :city, :state, :postal_code, :country, :residential; end
+      class Details
+        # Each tracking result is an object of this class
+        class Event; attr_accessor :name, :type, :occured_at, :city, :state, :postal_code, :country, :residential; end
+        
+        attr_accessor :origin_city,
+          :origin_state,
+          :origin_country,
+          :origin_residential,
+          :destination_city,
+          :destination_state,
+          :destination_country,
+          :destination_residential,
+          :signature_name,
+          :service_type,
+          :status,
+          :delivery_at,
+          :tracking_number,
+          :events
+        
+        def origin_residential?
+          origin_residential == true
+        end
+        
+        def destination_residential?
+          destination_residential == true
+        end
+        
+        def initialize(response)
+          details = response[:track_details]
+          
+          self.origin_city = details[:origin_location_address][:city]
+          self.origin_state = details[:origin_location_address][:state_or_province_code]
+          self.origin_country = details[:origin_location_address][:country_code]
+          self.origin_residential = details[:origin_location_address][:residential] == "true"
+          
+          self.destination_city = details[:destination_address][:city]
+          self.destination_state = details[:destination_address][:state_or_province_code]
+          self.destination_country = details[:destination_address][:country_code]
+          self.destination_residential = details[:destination_address][:residential] == "true"
+          
+          self.signature_name = details[:delivery_signature_name]
+          self.service_type = details[:service_type]
+          self.status = details[:status_description]
+          self.delivery_at = Time.parse(details[:actual_delivery_timestamp])
+          self.tracking_number = details[:tracking_number]
+          
+          self.events = response[:track_details][:events].collect do |details|
+            event = Event.new
+            event.name = details[:event_description]
+            event.type = details[:event_type]
+            event.occured_at = Time.parse(details[:timestamp])
+            event.city = details[:address][:city]
+            event.state = details[:address][:state_or_province_code]
+            event.postal_code = details[:address][:postal_code]
+            event.country = details[:address][:country_code]
+            event.residential = details[:address][:residential] == "true"
+            event
+          end
+        end
+      end
       
       VERSION = {:major => 3, :intermediate => 0, :minor => 0}
       
@@ -38,7 +96,7 @@ module Shippinglogic
         # The parent class Service requires that we define this method. This is our kicker. This method is only
         # called when we need to deal with information from FedEx. Notice the caching into the @target variable.
         def target
-          @target ||= parse_response(request(build_request))
+          @target ||= Details.new(request(build_request))
         end
         
         # Just building some XML to send off to FedEx. FedEx require this particualr format.
@@ -56,23 +114,6 @@ module Shippinglogic
             b.IncludeDetailedScans true
           end
         end
-        
-        # Grabbing the response from FedEx and making sense of it. There is a lot of unneeded information
-        # in the response.
-        def parse_response(response)
-          response[:track_details][:events].collect do |details|
-            event = Event.new
-            event.name = details[:event_description]
-            event.type = details[:event_type]
-            event.occured_at = Time.parse(details[:timestamp])
-            event.city = details[:address][:city]
-            event.state = details[:address][:state_or_province_code]
-            event.postal_code = details[:address][:postal_code]
-            event.country = details[:address][:country_code]
-            event.residential = details[:address][:residential] == "true"
-            event
-          end
-        end
     end
   end
 end

data/shippinglogic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shippinglogic}
-  s.version = "1.0.8"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2009-08-09}
+  s.date = %q{2009-08-16}
   s.description = %q{Easily use FedEx, UPS, USPS web services with an elegant and simple syntax.}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/shippinglogic/fedex/cancel.rb",
      "lib/shippinglogic/fedex/enumerations.rb",
      "lib/shippinglogic/fedex/error.rb",
+     "lib/shippinglogic/fedex/proxy.rb",
      "lib/shippinglogic/fedex/rate.rb",
      "lib/shippinglogic/fedex/request.rb",
      "lib/shippinglogic/fedex/response.rb",

data/spec/fedex/rate_spec.rb

@@ -17,6 +17,7 @@ describe "FedEx Rate" do
     rate.type.should == "FIRST_OVERNIGHT"
     rate.saturday.should == false
     rate.delivered_by.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
+    rate.speed.should == 1.day
     rate.rate.should == 70.01
     rate.currency.should == "USD"
   end
@@ -39,6 +40,7 @@ describe "FedEx Rate" do
     rate.type.should == "FIRST_OVERNIGHT"
     rate.saturday.should == false
     rate.delivered_by.should == Time.parse("Mon Aug 10 08:00:00 -0400 2009")
+    rate.speed.should == 1.day
     rate.rate.should == 50.43
     rate.currency.should == "USD"
   end

data/spec/fedex/service_spec.rb

@@ -14,6 +14,6 @@ describe "FedEx Service" do
   
   it "should delegate the class method to the target" do
     use_response(:track_defaults)
-    new_fedex.track(:tracking_number => fedex_tracking_number).class.should == Array
+    new_fedex.track(:tracking_number => fedex_tracking_number).class.should == Shippinglogic::FedEx::Track::Details
   end
 end

data/spec/fedex/track_spec.rb

@@ -5,10 +5,26 @@ describe "FedEx Track" do
     use_response(:track_defaults)
     
     fedex = new_fedex
-    events = fedex.track(:tracking_number => fedex_tracking_number)
+    track_details = fedex.track(:tracking_number => fedex_tracking_number)
     
-    events.size.should == 7
-    event = events.first
+    track_details.origin_city.should == "NASHVILLE"
+    track_details.origin_state.should == "TN"
+    track_details.origin_country.should == "US"
+    track_details.should_not be_origin_residential
+    
+    track_details.destination_city.should == "Sacramento"
+    track_details.destination_state.should == "CA"
+    track_details.destination_country.should == "US"
+    track_details.should_not be_destination_residential
+    
+    track_details.signature_name.should == "KKING"
+    track_details.service_type.should == "FEDEX_GROUND"
+    track_details.status.should == "Delivered"
+    track_details.delivery_at.should == Time.parse("2008-12-08T07:43:37-08:00")
+    track_details.tracking_number.should == "077973360403984"
+    
+    track_details.events.size.should == 7
+    event = track_details.events.first
     event.name.should == "Delivered"
     event.type.should == "DL"
     event.occured_at.should == Time.parse("Mon Dec 08 10:43:37 -0500 2008")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binarylogic-shippinglogic
 version: !ruby/object:Gem::Version 
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-09 00:00:00 -07:00
+date: 2009-08-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - lib/shippinglogic/fedex/cancel.rb
 - lib/shippinglogic/fedex/enumerations.rb
 - lib/shippinglogic/fedex/error.rb
+- lib/shippinglogic/fedex/proxy.rb
 - lib/shippinglogic/fedex/rate.rb
 - lib/shippinglogic/fedex/request.rb
 - lib/shippinglogic/fedex/response.rb