binarylogic-shippinglogic 1.0.4 → 1.0.5

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 1.0.5 released 2009-07-08
+
+* Added request to error objects so you can see both the raw request and response.
+
 == 1.0.4 released 2009-07-08
 
 * Added state code mapping so that we can pass full state names and have it convert it to a FedEx friendly code behind the scenes.

data/README.rdoc

@@ -88,7 +88,7 @@ You will notice above we assign the result of the 'track' method to a variable c
 
 == Available services and their features
 
-This library is still very new, as a result only FedEx is support at this time. More will come.
+This library is still very new, as a result only FedEx is supported at this time. More will come.
 
 I spent a lot of time on the documentation, for examples of how to use each service please see the docs for their respective classes.
 
@@ -142,6 +142,33 @@ Then your results:
       .location== #{event.city}, #{event.state} #{event.postal_code}, #{event.country}
       .residential= event.residential ? "Yes" : "No"
 
+== Leave abstraction to your application
+
+Here is what I did in an application of mine and it worked out great. I also have complete control of what I'm doing and the library is not limiting me:
+
+  class Shipment < ActiveRecord::Base
+    class Service
+      attr_accessor :carrier, :name, delivered_by, :rate
+    end
+    
+    def services
+      @services ||= fedex_services # + some_other_services
+    end
+    
+    private
+      def fedex_services
+        rate_options = {} # fill me with options accepted by Shippinglogic::FedEx::Rate
+        fedex.rate(rate_options).collect do |rate|
+          service = Service.new
+          service.carrier = :fedex
+          serivce.name = rate.name
+          service.rate = rate.rate
+          service.delivered_by = rate.delivered_by
+          service
+        end
+      end
+  end
+
 == Copyright
 
 Copyright (c) 2009 {Ben Johnson of Binary Logic}[http://www.binarylogic.com], released under the MIT license  

data/Rakefile

@@ -15,7 +15,9 @@ begin
     gem.add_dependency "activesupport", ">= 2.2.0"
     gem.add_dependency "httparty", ">= 0.4.4"
   end
-  Jeweler::RubyforgeTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = nil
+  end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION.yml

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

data/lib/shippinglogic/fedex/enumerations.rb

@@ -265,7 +265,7 @@ module Shippinglogic
         "United States" => "US"
       }
       
-      STATE_CODES = {
+      US_STATE_CODES = {
         "Alabama" => "AL",
         "Alaska" => "AK",
         "America Samoa" => "AS",
@@ -325,6 +325,24 @@ module Shippinglogic
         "Wisconsin" => "WI",
         "Wyoming" => "WY",
       }
+      
+      CANADA_STATE_CODES = {
+        "Alberta" => "AB",
+        "British Columbia" => "BC",
+        "Manitoba" => "MB",
+        "New Brunswick" => "NB",
+        "Newfoundland and Labrador" => "NL",
+        "Nova Scotia" => "NS",
+        "Northwest Territories" => "NT",
+        "Nunavut" => "NU",
+        "Ontario" => "ON",
+        "Prince Edward Island" => "PE",
+        "Quebec" => "QC",
+        "Saskatchewan" => "SK",
+        "Yukon" => "YT"
+      }
+      
+      STATE_CODES = US_STATE_CODES.merge(CANADA_STATE_CODES)
     end
   end
 end

data/lib/shippinglogic/fedex/error.rb

@@ -6,19 +6,21 @@ module Shippinglogic
     #
     # === Tip
     #
-    # If you want to see the raw respose catch the error object and call the response method. Ex:
+    # If you want to see the raw request / respose catch the error object and call the request / response method. Ex:
     #
     #   begin
     #     # my fedex code
     #   rescue Shippinglogic::FedEx::Error => e
     #     # do whatever you want here, just do:
+    #     # e.request
     #     # e.response
     #     # to get the raw response from fedex
     #   end
     class Error < StandardError
-      attr_accessor :errors, :response
+      attr_accessor :errors, :request, :response
       
-      def initialize(response)
+      def initialize(request, response)
+        self.request = request
         self.response = response
         
         if response.blank?

data/lib/shippinglogic/fedex/rate.rb

@@ -10,7 +10,7 @@ module Shippinglogic
     # * <tt>shipper_city</tt> - city part of the address.
     # * <tt>shipper_state_</tt> - state part of the address, use state abreviations.
     # * <tt>shipper_postal_code</tt> - postal code part of the address. Ex: zip for the US.
-    # * <tt>shipper_country</tt> - country code part of the address, use abbreviations, ex: 'US'
+    # * <tt>shipper_country</tt> - country code part of the address. FedEx expects abbreviations, but Shippinglogic will convert full names to abbreviations for you.
     # * <tt>shipper_residential</tt> - a boolean value representing if the address is redential or not (default: false)
     #
     # === Recipient options
@@ -19,7 +19,7 @@ module Shippinglogic
     # * <tt>recipient_city</tt> - city part of the address.
     # * <tt>recipient_state</tt> - state part of the address, use state abreviations.
     # * <tt>recipient_postal_code</tt> - postal code part of the address. Ex: zip for the US.
-    # * <tt>recipient_country</tt> - country code part of the address, use abbreviations, ex: 'US'
+    # * <tt>recipient_country</tt> - country code part of the address. FedEx expects abbreviations, but Shippinglogic will convert full names to abbreviations for you.
     # * <tt>recipient_residential</tt> - a boolean value representing if the address is redential or not (default: false)
     #
     # === Packaging options
@@ -33,9 +33,9 @@ module Shippinglogic
     # * <tt>package_count</tt> - the number of packages in your shipment. (default: 1)
     # * <tt>package_weight</tt> - a single packages weight.
     # * <tt>package_weight_units</tt> - either LB or KG. (default: LB)
-    # * <tt>package_length</tt> - a single packages length.
-    # * <tt>package_width</tt> - a single packages width.
-    # * <tt>package_height</tt> - a single packages height.
+    # * <tt>package_length</tt> - a single packages length, only required if using YOUR_PACKAGING for packaging_type.
+    # * <tt>package_width</tt> - a single packages width, only required if using YOUR_PACKAGING for packaging_type.
+    # * <tt>package_height</tt> - a single packages height, only required if using YOUR_PACKAGING for packaging_type.
     # * <tt>package_dimension_units</tt> - either IN or CM. (default: IN)
     #
     # === Monetary options
@@ -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, :deadline, :rate, :currency; end
+      class Service; attr_accessor :name, :type, :saturday, :delivered_by, :rate, :currency; end
       
       VERSION = {:major => 6, :intermediate => 0, :minor => 0}
       
@@ -175,14 +175,14 @@ module Shippinglogic
           response[:rate_reply_details].collect do |details|
             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]
-            deadline = details[:delivery_timestamp] && Time.parse(details[:delivery_timestamp])
+            delivered_by = details[:delivery_timestamp] && Time.parse(details[:delivery_timestamp])
             
-            if meets_deadline?(deadline)
+            if meets_deadline?(delivered_by)
               service = Service.new
               service.name = details[:service_type].titleize
               service.type = details[:service_type]
               service.saturday = details[:applied_options] == "SATURDAY_DELIVERY"
-              service.deadline = details[:delivery_timestamp] && Time.parse(details[:delivery_timestamp])
+              service.delivered_by = delivered_by
               service.rate = BigDecimal.new(cost[:amount])
               service.currency = cost[:currency]
               service
@@ -190,9 +190,9 @@ module Shippinglogic
           end.compact
         end
         
-        def meets_deadline?(deadline)
+        def meets_deadline?(delivered_by)
           return true if !delivery_deadline
-          deadline && deadline <= delivery_deadline
+          delivered_by && delivered_by <= delivery_deadline
         end
     end
   end

data/lib/shippinglogic/fedex/response.rb

@@ -6,13 +6,13 @@ module Shippinglogic
       
       private
         # Overwriting the request method to clean the response and handle errors.
-        def request(*args)
+        def request(body)
           response = clean_response(super)
           
           if success?(response)
             response
           else
-            raise Error.new(response)
+            raise Error.new(body, response)
           end
         end
         

data/lib/shippinglogic/fedex/ship.rb

@@ -10,7 +10,7 @@ module Shippinglogic
     # * <tt>shipper_city</tt> - city part of the address.
     # * <tt>shipper_state_</tt> - state part of the address, use state abreviations.
     # * <tt>shipper_postal_code</tt> - postal code part of the address. Ex: zip for the US.
-    # * <tt>shipper_country</tt> - country code part of the address, use abbreviations, ex: 'US'
+    # * <tt>shipper_country</tt> - country code part of the address. FedEx expects abbreviations, but Shippinglogic will convert full names to abbreviations for you.
     # * <tt>shipper_residential</tt> - a boolean value representing if the address is redential or not (default: false)
     #
     # === Recipient options
@@ -19,7 +19,7 @@ module Shippinglogic
     # * <tt>recipient_city</tt> - city part of the address.
     # * <tt>recipient_state</tt> - state part of the address, use state abreviations.
     # * <tt>recipient_postal_code</tt> - postal code part of the address. Ex: zip for the US.
-    # * <tt>recipient_country</tt> - country code part of the address, use abbreviations, ex: 'US'
+    # * <tt>recipient_country</tt> - country code part of the address. FedEx expects abbreviations, but Shippinglogic will convert full names to abbreviations for you.
     # * <tt>recipient_residential</tt> - a boolean value representing if the address is redential or not (default: false)
     #
     # === Label options
@@ -39,9 +39,9 @@ module Shippinglogic
     # * <tt>package_count</tt> - the number of packages in your shipment. (default: 1)
     # * <tt>package_weight</tt> - a single packages weight.
     # * <tt>package_weight_units</tt> - either LB or KG. (default: LB)
-    # * <tt>package_length</tt> - a single packages length.
-    # * <tt>package_width</tt> - a single packages width.
-    # * <tt>package_height</tt> - a single packages height.
+    # * <tt>package_length</tt> - a single packages length, only required if using YOUR_PACKAGING for packaging_type.
+    # * <tt>package_width</tt> - a single packages width, only required if using YOUR_PACKAGING for packaging_type.
+    # * <tt>package_height</tt> - a single packages height, only required if using YOUR_PACKAGING for packaging_type.
     # * <tt>package_dimension_units</tt> - either IN or CM. (default: IN)
     #
     # === Monetary options

data/shippinglogic.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shippinglogic}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]

data/spec/fedex/rate_spec.rb

@@ -16,7 +16,7 @@ describe "FedEx Rate" do
     rate.name.should == "First Overnight"
     rate.type.should == "FIRST_OVERNIGHT"
     rate.saturday.should == false
-    rate.deadline.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
+    rate.delivered_by.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
     rate.rate.should == 70.01
     rate.currency.should == "USD"
   end
@@ -38,7 +38,7 @@ describe "FedEx Rate" do
     rate.name.should == "First Overnight"
     rate.type.should == "FIRST_OVERNIGHT"
     rate.saturday.should == false
-    rate.deadline.should == Time.parse("Mon Aug 10 08:00:00 -0400 2009")
+    rate.delivered_by.should == Time.parse("Mon Aug 10 08:00:00 -0400 2009")
     rate.rate.should == 50.43
     rate.currency.should == "USD"
   end
@@ -67,6 +67,6 @@ describe "FedEx Rate" do
     rates.attributes = fedex_package
     rates.delivery_deadline = Time.parse("Aug 07 08:01:00 -0400 2009")
     rates.size.should == 1
-    rates.first.deadline.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
+    rates.first.delivered_by.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binarylogic-shippinglogic
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic