binarylogic-shippinglogic 1.1.0 → 1.1.1

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 1.1.1 released 2009-07-17
+
+* Added :just_validate options for creating shipments, that leverages FedExs validation option without creating a shipment.
+* Added more shipper and recipient options, also standardized those options between rating and shipping to create consistency.
+
 == 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.

data/README.rdoc

@@ -36,24 +36,30 @@ See below for usage examples.
 What I think is unique about this library is it's usage / syntax:
   
   fedex = Shippinglogic::FedEx.new(key, password, account, meter)
-  tracking = fedex.track(:tracking_number => "XXXXXXXXXXXXXXXXX")
+  tracking_details = fedex.track(:tracking_number => "XXXXXXXXXXXXXXXXX")
   # => A proxy object that delegates calls to an array of Shippinglogic::FedEx::Track::Event objects
   
   # this shows that the tracking object is a proxy for the underlying array
-  tracking.tracking_number
+  tracking_details.tracking_number
   # => "XXXXXXXXXXXXXXXXX"
   
-  tracking.tracking_number = "YYYYYYYYYYYYYYYYYY"
+  tracking_details.tracking_number = "YYYYYYYYYYYYYYYYYY"
   # => "YYYYYYYYYYYYYYYYYY"
   
-  tracking.class
-  # => Array
+  tracking_details.class
+  # => Shippinglogic::FedEx::Track::Details
   
-  tracking.first
+  tracking_details.status
+  # => "Delivered"
+  
+  tracking_details.signature_name
+  # => "KKING"
+  
+  tracking_details.events.first
   # => #<Shippinglogic::FedEx::Track::Event @postal_code="95817", @name="Delivered", @state="CA", @residential=false,
   #    @city="Sacramento", @type="DL", @country="US", @occured_at=Mon Dec 08 10:43:37 -0500 2008>
   
-  tracking.first.name
+  tracking_details.first.name
   # => "Delivered"
 
 == Calls to the web services are lazy
@@ -69,21 +75,21 @@ This is similar to how ActiveRecord's association proxies work. When you call "u
 You will notice above we assign the result of the 'track' method to a variable called 'tracking'. That object has more to it:
 
   # Initializing
-  tracking = fedex.track(:tracking_number => "XXXXXXXXXXXXX")
-  tracking.tracking_number
+  tracking_details = fedex.track(:tracking_number => "XXXXXXXXXXXXX")
+  tracking_details.tracking_number
   # => "XXXXXXXXXXXXX"
   
   # Attribute accessors
-  tracking.tracking_number = "YYYYYYYYYYYYYYY"
-  tracking.tracking_number
+  tracking_details.tracking_number = "YYYYYYYYYYYYYYY"
+  tracking_details.tracking_number
   # => "YYYYYYYYYYYYYYY"
   
   # Mass attribute setting
-  tracking.attributes = {:tracking_number => "ZZZZZZZZZZZZZZZZ"}
-  tracking.tracking_number
+  tracking_details.attributes = {:tracking_number => "ZZZZZZZZZZZZZZZZ"}
+  tracking_details.tracking_number
   # => "ZZZZZZZZZZZZZZZZ"
   
-  tracking.attributes
+  tracking_details.attributes
   # => {:tracking_number => "ZZZZZZZZZZZZZZZZ"}
 
 == Available services and their features
@@ -110,11 +116,11 @@ What's nice about having an object is that you can pass it around. Let's say you
 
   class TrackingController < ApplicationController
     def new
-      @tracking = fedex.track(params[:tracking])
+      @tracking_details = fedex.track(params[:tracking])
     end
     
     def create
-      @tracking = fedex.track(params[:tracking])
+      @tracking_details = fedex.track(params[:tracking])
       render :action => :new if !@tracking.successful?
     end
     
@@ -127,7 +133,7 @@ What's nice about having an object is that you can pass it around. Let's say you
 That's pretty simple. Now check out your form:
   
   # new.html.haml
-  - form_for @tracking do |f|
+  - form_for @tracking_details do |f|
     = f.error_messages
     = f.text_field :tracking_number
     = f.submit "Track"
@@ -135,7 +141,8 @@ That's pretty simple. Now check out your form:
 Then your results:
 
   # create.html.haml
-  - @tracking.each do |event|
+  .signature_name= @tracking_details.signature_name
+  - @tracking_details.events.each do |event|
     .event
       .name= event.name
       .occured_at= event.occured_at.to_s(:long)

data/VERSION.yml

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

data/lib/shippinglogic/fedex/rate.rb

@@ -6,6 +6,11 @@ module Shippinglogic
     # == Options
     # === Shipper options
     #
+    # * <tt>shipper_name</tt> - name of the shipper.
+    # * <tt>shipper_title</tt> - title of the shipper.
+    # * <tt>shipper_company_name</tt> - company name of the shipper.
+    # * <tt>shipper_phone_number</tt> - phone number of the shipper.
+    # * <tt>shipper_email</tt> - email of the shipper.
     # * <tt>shipper_streets</tt> - street part of the address, separate multiple streets with a new line, dont include blank lines.
     # * <tt>shipper_city</tt> - city part of the address.
     # * <tt>shipper_state_</tt> - state part of the address, use state abreviations.
@@ -15,6 +20,11 @@ module Shippinglogic
     #
     # === Recipient options
     #
+    # * <tt>recipient_name</tt> - name of the recipient.
+    # * <tt>recipient_title</tt> - title of the recipient.
+    # * <tt>recipient_company_name</tt> - company name of the recipient.
+    # * <tt>recipient_phone_number</tt> - phone number of the recipient.
+    # * <tt>recipient_email</tt> - email of the recipient.
     # * <tt>recipient_streets</tt> - street part of the address, separate multiple streets with a new line, dont include blank lines.
     # * <tt>recipient_city</tt> - city part of the address.
     # * <tt>recipient_state</tt> - state part of the address, use state abreviations.
@@ -92,6 +102,11 @@ module Shippinglogic
       VERSION = {:major => 6, :intermediate => 0, :minor => 0}
       
       # shipper options
+      attribute :shipper_name,                :string
+      attribute :shipper_title,               :string
+      attribute :shipper_company_name,        :string
+      attribute :shipper_phone_number,        :string
+      attribute :shipper_email,               :string
       attribute :shipper_streets,             :string
       attribute :shipper_city,                :string
       attribute :shipper_state,               :string
@@ -100,6 +115,11 @@ module Shippinglogic
       attribute :shipper_residential,         :boolean,     :default => false
       
       # recipient options
+      attribute :recipient_name,              :string
+      attribute :recipient_title,             :string
+      attribute :recipient_company_name,      :string
+      attribute :recipient_phone_number,      :string
+      attribute :recipient_email,             :string
       attribute :recipient_streets,           :string
       attribute :recipient_city,              :string
       attribute :recipient_state,             :string

data/lib/shippinglogic/fedex/request.rb

@@ -46,9 +46,11 @@ module Shippinglogic
         # A convenience method for building the contact block in your XML request
         def build_contact(b, type)
           b.Contact do
-            b.Contact send("#{type}_name") if send("#{type}_name")
+            b.PersonName send("#{type}_name") if send("#{type}_name")
+            b.Title send("#{type}_title") if send("#{type}_title")
             b.CompanyName send("#{type}_company_name") if send("#{type}_company_name")
             b.PhoneNumber send("#{type}_phone_number") if send("#{type}_phone_number")
+            b.EmailAddress send("#{type}_email") if send("#{type}_email")
           end
         end
         

data/lib/shippinglogic/fedex/ship.rb

@@ -6,6 +6,11 @@ module Shippinglogic
     # == Options
     # === Shipper options
     #
+    # * <tt>shipper_name</tt> - name of the shipper.
+    # * <tt>shipper_title</tt> - title of the shipper.
+    # * <tt>shipper_company_name</tt> - company name of the shipper.
+    # * <tt>shipper_phone_number</tt> - phone number of the shipper.
+    # * <tt>shipper_email</tt> - email of the shipper.
     # * <tt>shipper_streets</tt> - street part of the address, separate multiple streets with a new line, dont include blank lines.
     # * <tt>shipper_city</tt> - city part of the address.
     # * <tt>shipper_state_</tt> - state part of the address, use state abreviations.
@@ -15,6 +20,11 @@ module Shippinglogic
     #
     # === Recipient options
     #
+    # * <tt>recipient_name</tt> - name of the recipient.
+    # * <tt>recipient_title</tt> - title of the recipient.
+    # * <tt>recipient_company_name</tt> - company name of the recipient.
+    # * <tt>recipient_phone_number</tt> - phone number of the recipient.
+    # * <tt>recipient_email</tt> - email of the recipient.
     # * <tt>recipient_streets</tt> - street part of the address, separate multiple streets with a new line, dont include blank lines.
     # * <tt>recipient_city</tt> - city part of the address.
     # * <tt>recipient_state</tt> - state part of the address, use state abreviations.
@@ -65,6 +75,7 @@ module Shippinglogic
     #
     # === Misc options
     #
+    # * <tt>just_validate</tt> - will tell FedEx to ONLY validate the shipment, not actually create it. (default: false)
     # * <tt>rate_request_types</tt> - one or more of RATE_REQUEST_TYPES. (default: ACCOUNT)
     #
     # == Simple Example
@@ -98,8 +109,10 @@ module Shippinglogic
       
       # shipper options
       attribute :shipper_name,                :string
+      attribute :shipper_title,               :string
       attribute :shipper_company_name,        :string
       attribute :shipper_phone_number,        :string
+      attribute :shipper_email,               :string
       attribute :shipper_streets,             :string
       attribute :shipper_city,                :string
       attribute :shipper_state,               :string
@@ -109,8 +122,10 @@ module Shippinglogic
       
       # recipient options
       attribute :recipient_name,              :string
+      attribute :recipient_title,             :string
       attribute :recipient_company_name,      :string
       attribute :recipient_phone_number,      :string
+      attribute :recipient_email,             :string
       attribute :recipient_streets,           :string
       attribute :recipient_city,              :string
       attribute :recipient_state,             :string
@@ -149,6 +164,7 @@ module Shippinglogic
       attribute :signature,                   :string
       
       # misc options
+      attribute :just_validate,               :boolean,     :default => false
       attribute :rate_request_types,          :array,       :default => ["ACCOUNT"]
       
       private
@@ -159,7 +175,7 @@ module Shippinglogic
         # Just building some XML to send off to FedEx using our various options
         def build_request
           b = builder
-          xml = b.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v#{VERSION[:major]}") do
+          xml = b.tag!(just_validate ? "ValidateShipmentRequest" : "ProcessShipmentRequest", :xmlns => "http://fedex.com/ws/ship/v#{VERSION[:major]}") do
             build_authentication(b)
             build_version(b, "ship", VERSION[:major], VERSION[:intermediate], VERSION[:minor])
             b.SpecialServicesRequested special_services_requested.join(",") if special_services_requested.any?

data/lib/shippinglogic/fedex/track.rb

@@ -12,12 +12,19 @@ module Shippinglogic
     # Here is a very simple example:
     #
     #   fedex = Shippinglogic::FedEx.new(key, password, account, meter)
-    #   tracking = fedex.track(:tracking_number => "my number")
-    #   tracking.first
+    #   tracking_details = fedex.track(:tracking_number => "my number")
+    #
+    #   tracking_details.status
+    #   # => "Delivered"
+    #   
+    #   tracking_details.signature_name
+    #   # => "KKING"
+    #   
+    #   tracking_details.events.first
     #   # => #<Shippinglogic::FedEx::Track::Event @postal_code="95817", @name="Delivered", @state="CA", @residential=false,
     #   #     @city="Sacramento", @type="DL", @country="US", @occured_at=Mon Dec 08 10:43:37 -0500 2008>
     #   
-    #   tracking.first.name
+    #   tracking_details.events.first.name
     #   # => "Delivered"
     #
     # === Note
@@ -43,7 +50,6 @@ module Shippinglogic
           :service_type,
           :status,
           :delivery_at,
-          :tracking_number,
           :events
         
         def origin_residential?
@@ -71,7 +77,6 @@ module Shippinglogic
           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

data/shippinglogic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shippinglogic}
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   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-16}
+  s.date = %q{2009-08-17}
   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 = [

data/spec/fedex/ship_spec.rb

@@ -1,22 +1,37 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "FedEx Ship" do
+  before(:each) do
+    fedex = new_fedex
+    @shipment = fedex.ship
+    
+    @shipment.service_type = "FEDEX_2_DAY"
+    @shipment.attributes = fedex_shipper
+    @shipment.attributes = fedex_recipient
+    @shipment.attributes = fedex_package
+  end
+  
   it "should create a new shipment" do
     use_response(:ship_defaults)
     
-    fedex = new_fedex
-    shipment = fedex.ship
+    @shipment.rate.should == 17.02
+    @shipment.currency.should == "USD"
+    @shipment.delivery_date.should == Date.parse("Tue, 11 Aug 2009")
+    @shipment.tracking_number.should == "794797892957"
+    @shipment.label.should_not be_nil
+    @shipment.barcode.should_not be_nil
+  end
+  
+  it "should only validate the shipment" do
+    pending
+    DONT_SAVE = true
     
-    shipment.service_type = "FEDEX_2_DAY"
-    shipment.attributes = fedex_shipper
-    shipment.attributes = fedex_recipient
-    shipment.attributes = fedex_package
+    @shipment.just_validate = true
     
-    shipment.rate.should == 17.02
-    shipment.currency.should == "USD"
-    shipment.delivery_date.should == Date.parse("Tue, 11 Aug 2009")
-    shipment.tracking_number.should == "794797892957"
-    shipment.label.should_not be_nil
-    shipment.barcode.should_not be_nil
+    begin
+      @shipment.rate.should == 'fdsf'
+    rescue Shippinglogic::FedEx::Error => e
+      raise e.request
+    end
   end
 end

data/spec/spec_helper.rb

@@ -46,8 +46,11 @@ Spec::Runner.configure do |config|
   
   def fedex_shipper
     {
+      :shipper_name => "Name",
+      :shipper_title => "Title",
       :shipper_company_name => "Company",
       :shipper_phone_number => "2222222222",
+      :shipper_email => "a@a.com",
       :shipper_streets => "260 Broadway",
       :shipper_city => "New York",
       :shipper_state => "NY",
@@ -58,8 +61,11 @@ Spec::Runner.configure do |config|
   
   def fedex_recipient
     {
+      :recipient_name => "Name",
+      :recipient_title => "Title",
       :recipient_company_name => "Dallas City Hall",
       :recipient_phone_number => "2222222222",
+      :recipient_email => "a@a.com",
       :recipient_streets => "1500 Marilla Street",
       :recipient_city => "Dallas",
       :recipient_state => "TX",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binarylogic-shippinglogic
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-16 00:00:00 -07:00
+date: 2009-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency