shippinglogic 1.2.3

data/lib/shippinglogic/validation.rb

@@ -0,0 +1,32 @@
+require "shippinglogic/error"
+
+module Shippinglogic
+  # This module is more for application integration, so you can do something like:
+  #
+  #   tracking = fedex.tracking
+  #   if tracking.valid?
+  #     # render a successful response
+  #   else
+  #     # do something with the errors: fedex.errors
+  #   end
+  module Validation
+    # Just an array of errors that were encounted if valid? returns false.
+    def errors
+      @errors ||= []
+    end
+    
+    # Allows you to determine if the request is valid or not. All validation is delegated to the API
+    # services, so what this does is make a call to the API and rescue any errors, then it puts those
+    # errors into the 'errors' array.
+    def valid?
+      begin
+        target
+        true
+      rescue Error => e
+        errors.clear
+        self.errors << e.message
+        false
+      end
+    end
+  end
+end

data/shippinglogic.gemspec

@@ -0,0 +1,120 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "shippinglogic"
+  s.version = "1.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Johnson of Binary Logic"]
+  s.date = "2012-04-20"
+  s.description = "Easily use FedEx, UPS, USPS web services with an elegant and simple syntax."
+  s.email = "bjohnson@binarylogic.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG.rdoc",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "init.rb",
+    "lib/shippinglogic.rb",
+    "lib/shippinglogic/attributes.rb",
+    "lib/shippinglogic/error.rb",
+    "lib/shippinglogic/fedex.rb",
+    "lib/shippinglogic/fedex/cancel.rb",
+    "lib/shippinglogic/fedex/enumerations.rb",
+    "lib/shippinglogic/fedex/error.rb",
+    "lib/shippinglogic/fedex/rate.rb",
+    "lib/shippinglogic/fedex/request.rb",
+    "lib/shippinglogic/fedex/response.rb",
+    "lib/shippinglogic/fedex/service.rb",
+    "lib/shippinglogic/fedex/ship.rb",
+    "lib/shippinglogic/fedex/signature.rb",
+    "lib/shippinglogic/fedex/track.rb",
+    "lib/shippinglogic/proxy.rb",
+    "lib/shippinglogic/service.rb",
+    "lib/shippinglogic/ups.rb",
+    "lib/shippinglogic/ups/cancel.rb",
+    "lib/shippinglogic/ups/enumerations.rb",
+    "lib/shippinglogic/ups/error.rb",
+    "lib/shippinglogic/ups/label.rb",
+    "lib/shippinglogic/ups/rate.rb",
+    "lib/shippinglogic/ups/request.rb",
+    "lib/shippinglogic/ups/response.rb",
+    "lib/shippinglogic/ups/service.rb",
+    "lib/shippinglogic/ups/ship_accept.rb",
+    "lib/shippinglogic/ups/ship_confirm.rb",
+    "lib/shippinglogic/ups/track.rb",
+    "lib/shippinglogic/validation.rb",
+    "shippinglogic.gemspec",
+    "spec/attributes_spec.rb",
+    "spec/config/fedex_credentials.example.yml",
+    "spec/config/ups_credentials.example.yml",
+    "spec/error_spec.rb",
+    "spec/fedex/cancel_spec.rb",
+    "spec/fedex/error_spec.rb",
+    "spec/fedex/rate_spec.rb",
+    "spec/fedex/request_spec.rb",
+    "spec/fedex/responses/blank.xml",
+    "spec/fedex/responses/cancel_not_found.xml",
+    "spec/fedex/responses/failed_authentication.xml",
+    "spec/fedex/responses/malformed.xml",
+    "spec/fedex/responses/rate_defaults.xml",
+    "spec/fedex/responses/rate_insurance.xml",
+    "spec/fedex/responses/rate_no_services.xml",
+    "spec/fedex/responses/rate_non_custom_packaging.xml",
+    "spec/fedex/responses/ship_defaults.xml",
+    "spec/fedex/responses/ship_with_no_signature.xml",
+    "spec/fedex/responses/signature_defaults.xml",
+    "spec/fedex/responses/track_defaults.xml",
+    "spec/fedex/responses/unexpected.xml",
+    "spec/fedex/service_spec.rb",
+    "spec/fedex/ship_spec.rb",
+    "spec/fedex/signature_spec.rb",
+    "spec/fedex/spec_helper.rb",
+    "spec/fedex/track_spec.rb",
+    "spec/fedex_spec.rb",
+    "spec/lib/interceptor.rb",
+    "spec/proxy_spec.rb",
+    "spec/service_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/ups/responses/blank.xml",
+    "spec/ups/responses/track_defaults.xml",
+    "spec/ups/spec_helper.rb",
+    "spec/ups_spec.rb",
+    "spec/validation_spec.rb"
+  ]
+  s.homepage = "http://github.com/binarylogic/shippinglogic"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "A simple and clean library to interface with shipping carriers"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.4"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.4.4"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.4.4"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+  end
+end
+

data/spec/attributes_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Service Attributes" do
+  before(:all) do
+    class ::ServiceWithAttributes
+      include Shippinglogic::Attributes
+      
+      attribute :tracking_number,             :string
+      attribute :packaging_type,              :string,    :default => "YOUR_PACKAGING"
+      attribute :special_services_requested,  :array
+      attribute :ship_time,                   :datetime,  :default => lambda { |shipment| Time.now }
+    end
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, :ServiceWithAttributes)
+  end
+  
+  it "should allow setting attributes upon initialization" do
+    service = ServiceWithAttributes.new(:tracking_number => "TEST")
+    service.tracking_number.should == "TEST"
+  end
+  
+  it "should allow setting attributes individually" do
+    service = ServiceWithAttributes.new
+    service.tracking_number = "TEST"
+    service.tracking_number.should == "TEST"
+  end
+  
+  it "should allow setting attributes with a hash" do
+    service = ServiceWithAttributes.new
+    service.attributes = {:tracking_number => "TEST"}
+    service.tracking_number.should == "TEST"
+  end
+  
+  it "should allow reading attributes" do
+    service = ServiceWithAttributes.new
+    service.attributes = {:tracking_number => "TEST"}
+    service.attributes.should be_a(Hash)
+    service.attributes.should have_key(:tracking_number)
+    service.attributes[:tracking_number].should == "TEST"
+  end
+  
+  it "should implement defaults" do
+    service = ServiceWithAttributes.new
+    service.packaging_type.should == "YOUR_PACKAGING"
+  end
+  
+  it "should use blank array as defaults for arrays" do
+    service = ServiceWithAttributes.new
+    service.special_services_requested.should == []
+  end
+  
+  it "should call procs during run time if a default is a proc" do
+    service = ServiceWithAttributes.new
+    service.ship_time.to_s.should == Time.now.to_s
+  end
+  
+  it "should parse string representations of times" do
+    service = ServiceWithAttributes.new
+    service.ship_time = "19551105000000"
+    service.ship_time.should be_a(Time)
+    service.ship_time.strftime("%B") == "November"
+    service.ship_time.day.should == 5
+    service.ship_time.year.should == 1955
+  end
+end

data/spec/config/fedex_credentials.example.yml

@@ -0,0 +1,4 @@
+key: your key
+password: your password
+account: your account number
+meter: your meter number

data/spec/config/ups_credentials.example.yml

@@ -0,0 +1,3 @@
+key: your key
+password: your password
+account: your account username

data/spec/error_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Shippinglogic Errors" do
+  before(:each) do
+    @error = Shippinglogic::Error.new("", "")
+  end
+  
+  it "should inherit from StandardError" do
+    @error.should be_a(StandardError)
+  end
+  
+  it "should contain an array of errors" do
+    @error.errors.should == []
+  end
+  
+  it "should be able to add error hashes" do
+    @error.errors.size.should == 0
+    @error.add_error("MESSAGE")
+    @error.errors.size.should == 1
+    @error.errors.last.should be_a(Hash)
+  end
+  
+  it "should append (not prepend) error hashes" do
+    @error.add_error("FIRST")
+    @error.errors.last[:message].should == "FIRST"
+    @error.add_error("LAST")
+    @error.errors.last[:message].should == "LAST"
+  end
+  
+  it "should have error hashes containing a required message" do
+    @error.add_error("MESSAGE")
+    @error.errors.last.should have_key(:message)
+    @error.errors.last[:message].should == "MESSAGE"
+  end
+  
+  it "should have error hashes containing an optional code" do
+    @error.add_error("WITHOUT")
+    @error.errors.last.should have_key(:code)
+    @error.errors.last[:code].should be_nil
+    @error.add_error("WITH", "CODE")
+    @error.errors.last[:code].should == "CODE"
+  end
+end

data/spec/fedex/cancel_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FedEx Track" do
+  it "should cancel the shipment" do
+    use_response(:cancel_not_found)
+    fedex = new_fedex
+    cancel = fedex.cancel(:tracking_number => fedex_tracking_number)
+    lambda { cancel.perform }.should raise_error(Shippinglogic::FedEx::Error, "Unable to retrieve record from database")
+  end
+end

data/spec/fedex/error_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FedEx Error" do
+  it "should handle blank response errors" do
+    use_response(:blank)
+    lambda { new_fedex.track(:tracking_number => fedex_tracking_number).size }.should raise_error(Shippinglogic::FedEx::Error, "The response from FedEx was blank.")
+  end
+  
+  it "should pass through malformed errors" do
+    use_response(:malformed, :content_type => "")
+    lambda { new_fedex.track(:tracking_number => fedex_tracking_number).size }.should raise_error(Shippinglogic::FedEx::Error, "The response from FedEx was malformed and was not in a valid XML format.")
+  end
+  
+  it "should pass through authentication errors" do
+    use_response(:failed_authentication)
+    fedex = Shippinglogic::FedEx.new("", "", "", "")
+    lambda { fedex.track(:tracking_number => fedex_tracking_number).size }.should raise_error(Shippinglogic::FedEx::Error, "Authentication Failed")
+  end
+  
+  it "should pass through unexpected errors" do
+    use_response(:unexpected)
+    lambda { new_fedex.track(:tracking_number => fedex_tracking_number).size }.should raise_error(Shippinglogic::FedEx::Error, "There was a problem with your fedex request, and " +
+      "we couldn't locate a specific error message. This means your response was in an unexpected format. You might try glancing at the raw response " +
+      "by using the 'response' method on this error object.")
+  end
+end

data/spec/fedex/rate_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FedEx Rate" do
+  it "should rate the shipment" do
+    use_response(:rate_defaults)
+    
+    fedex = new_fedex
+    rates = fedex.rate
+    
+    rates.attributes = fedex_shipper
+    rates.attributes = fedex_recipient
+    rates.attributes = fedex_package
+    rates.size.should == 6
+    
+    rate = rates.first
+    rate.name.should == "First Overnight"
+    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 == 86400 # 1.day
+    rate.rate.should == 70.01
+    rate.currency.should == "USD"
+  end
+  
+  it "should not require package dimensions when not using custom packaging" do
+    use_response(:rate_non_custom_packaging)
+    
+    fedex = new_fedex
+    rates = fedex.rate
+    
+    rates.attributes = fedex_shipper
+    rates.attributes = fedex_recipient
+    rates.packaging_type = "FEDEX_ENVELOPE"
+    rates.package_weight = 0.1
+    
+    rates.size.should == 5
+    
+    rate = rates.first
+    rate.name.should == "First Overnight"
+    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 == 86400 # 1.day
+    rate.rate.should == 50.43
+    rate.currency.should == "USD"
+  end
+  
+  it "should handle responses with no services" do
+    use_response(:rate_no_services)
+    
+    fedex = new_fedex
+    rates = fedex.rate
+    
+    rates.attributes = fedex_shipper
+    rates.attributes = fedex_recipient
+    rates.packaging_type = "FEDEX_ENVELOPE"
+    rates.package_weight = 2
+    rates.size.should == 0
+  end
+  
+  it "should remove any services that don't meet the deadline" do
+    use_response(:rate_defaults)
+    
+    fedex = new_fedex
+    rates = fedex.rate
+    
+    rates.attributes = fedex_shipper
+    rates.attributes = fedex_recipient
+    rates.attributes = fedex_package
+    rates.delivery_deadline = Time.parse("Aug 07 08:01:00 -0400 2009")
+    rates.size.should == 1
+    rates.first.delivered_by.should == Time.parse("Fri Aug 07 08:00:00 -0400 2009")
+  end
+  
+  it "should rate the shipment with an insured value" do
+    use_response(:rate_insurance)
+    
+    fedex = new_fedex
+    rates = fedex.rate
+    
+    rates.attributes = fedex_shipper
+    rates.attributes = fedex_recipient
+    rates.attributes = fedex_package
+    rates.insured_value = 200
+    rates.size.should == 6
+  end
+end

data/spec/fedex/request_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FedEx Attributes" do
+  it "should convert full country names to country codes" do
+    fedex = new_fedex
+    rates = fedex.rate
+    rates.send(:country_code, "United States").should == "US"
+  end
+  
+  it "should convert full state names to state codes" do
+    fedex = new_fedex
+    rates = fedex.rate
+    rates.send(:state_code, "Texas").should == "TX"
+  end
+end

data/spec/fedex/responses/cancel_not_found.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<v6:ShipmentReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:v6="http://fedex.com/ws/ship/v6"><v6:HighestSeverity>ERROR</v6:HighestSeverity><v6:Notifications><v6:Severity>ERROR</v6:Severity><v6:Source>ship</v6:Source><v6:Code>8149</v6:Code><v6:Message>Unable to retrieve record from database</v6:Message><v6:LocalizedMessage>Unable to retrieve record from database</v6:LocalizedMessage></v6:Notifications><v6:Version>
+    <v6:ServiceId>ship</v6:ServiceId>
+    <v6:Major>6</v6:Major>
+    <v6:Intermediate>0</v6:Intermediate>
+    <v6:Minor>0</v6:Minor>
+  </v6:Version></v6:ShipmentReply>

data/spec/fedex/responses/failed_authentication.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ns:TrackReply xmlns:ns="http://fedex.com/ws/track/v3"><ns:HighestSeverity>ERROR</ns:HighestSeverity><ns:Notifications><ns:Severity>ERROR</ns:Severity><ns:Source>prof</ns:Source><ns:Code>1000</ns:Code><ns:Message>Authentication Failed</ns:Message></ns:Notifications><ns:Version>
+    <ns:ServiceId>trck</ns:ServiceId>
+    <ns:Major>3</ns:Major>
+    <ns:Intermediate>0</ns:Intermediate>
+    <ns:Minor>0</ns:Minor>
+  </ns:Version></ns:TrackReply>

data/spec/fedex/responses/malformed.xml

@@ -0,0 +1,8 @@
+malformed\nfdsf
+fsd
+fds
+
+
+
+dsf
+dsfsdf