fedex_web_service 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 bryce mcdonnell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= Fedex Web Service
+
+This is a ruby interface to the Fedex Web Services API. It's nowhere near complete and could use a lot of DRY'ing up, but I had an immediate need in a project I'm working on and thus began the gem.
+
+Right now it only supports the address verification and shipping label APIs. Later, it will support the track and rate (among others) APIs.
+
+== Dependencies
+Dependencies for this gem are a WSDL issued by fedex. You'll also need to apply for and be blessed with a Fedex key, password, account number and meter number. While in development, you can get away with testing credentials but you'll need production credentials to go live.
+
+Put wsdls in the lib/wsdl directory. That's where this looks for them.
+
+Put your credentials in the config/fedex_config.yml file.
+
+*Give yourself a month to get the production keys.* It won't take that long, but it's an arduous process requiring input from several levels of Fedex and your (clients) company.
+
+== TODO
+ *lots of coding
+ *everything else
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010-present bryce mcdonnell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fedex_web_service"
+    gem.summary = %Q{A quick and easy interface to the Fedex Web Services API}
+    gem.description = %Q{Provides an interface to several, but not all, of the FedEx web services. Currently provides Ship service and Address Verification. Utilizes the SOAP (blech) service so you must get a wsdl and production keys from FedEx}
+    gem.email = "bryce@bridgetownint.com"
+    gem.homepage = "http://github.com/brycem/fedex_web_service"
+    gem.authors = ["bryce mcdonnell"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fedex_web_service #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fedex_web_service.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fedex_web_service}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["bryce mcdonnell"]
+  s.date = %q{2010-04-13}
+  s.description = %q{Provides an interface to several, but not all, of the FedEx web services. Currently provides Ship service and Address Verification. Utilizes the SOAP (blech) service so you must get a wsdl and production keys from FedEx}
+  s.email = %q{bryce@bridgetownint.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fedex_web_service.gemspec",
+     "lib/fedex_web_service.rb",
+     "lib/fedex_web_service/address_verification.rb",
+     "test/helper.rb",
+     "test/test_fedex_web_service.rb"
+  ]
+  s.homepage = %q{http://github.com/brycem/fedex_web_service}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A quick and easy interface to the Fedex Web Services API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_fedex_web_service.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/fedex_web_service/address_verification.rb

@@ -0,0 +1,101 @@
+class FedexWebService
+  class AddressVerification < FedexWebService
+    #receives an order_info object and parses it into a verification request. Returns an AddressVerificationResponse (object)
+    def verify_address(order)
+      puts wsdl = wsdl = File.expand_path( RAILS_ROOT + "/lib/wsdl/" + @fedex_conf[:av_wsdl] )
+      driver = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
+    
+      call = { :WebAuthenticationDetail => {
+                  :UserCredential => {
+                    :Key => @key, 
+                    :Password => @password
+                  } 
+                },
+          :ClientDetail => {
+            :AccountNumber => @accountnumber, 
+            :MeterNumber => @meternumber 
+          },
+          :TransactionDetail => {
+            :CustomerTransactionId => "WSVC_addressvalidation"
+          },
+          :Version => {:ServiceId => 'aval', :Major => '2', :Intermediate => '0', :Minor => '0'},
+          :RequestTimestamp => self.fedex_time_stamp(),
+          :Options => {
+            :VerifyAddresses => 1,
+            :CheckResidentialStatus => 1
+          },
+          :AddressesToValidate => 
+            [:Address => {
+              :CountryCode => 'US',
+              :StreetLines => order.shipping_address_1,
+              :City => order.shipping_city,
+              :StateOrProvinceCode => order.shipping_state,
+              :PostalCode => order.shipping_zip,
+              :Residential => true
+            }]
+        
+        }
+     
+      result = driver.addressValidation(call)
+      AddressVerificationResponse.new(result)
+    end
+  end #end Class AddressVerification
+  
+  class AddressVerificationResponse
+    # this is really just a data translation object. It receives a SOAP response (blech) and translates it into a Ruby 
+    # object. Where it's not blindingly obvious, I've included notes for each attribute
+    
+    attr_accessor :responseString, 
+                  :deliveryPointValidation, #is either CONFIRMED, UNCONFIRMED, UNAVAILABLE
+                  :changes,
+                  :score, #the score Fedex gives it based on how confident they are 0..100 
+                  :residentialStatus, #one of UNDETERMINED, BUSINESS, RESIDENTIAL, INSUFFICIENT_DATA, UNAVAILABLE, NOT_APPLICABLE_TO_COUNTRY
+                  :changedAddress, #address streetlines, modified by Fedex
+                  :changedCity,
+                  :changedState,
+                  :changedPostal,
+                  :responses
+
+    def initialize(soap_response)
+        @soap_response = soap_response #so we can use it with other methods in this class
+
+        address_results = address_results_an_array? ? @soap_response.addressResults.proposedAddressDetails[0] : @soap_response.addressResults.proposedAddressDetails
+
+        self.responseString           = soap_response.notifications.severity
+        self.changes                  = address_results.changes
+        self.deliveryPointValidation  = address_results.deliveryPointValidation
+        self.score                    = address_results.score.to_i
+        self.residentialStatus        = address_results.residentialStatus 
+        self.changedAddress           = address_results.address.streetLines.to_s
+        self.changedCity              = address_results.address.city
+        self.changedState             = address_results.address.stateOrProvinceCode
+        self.changedPostal            = address_results.address.postalCode
+        self.responses                = []
+
+        set_other_responses if address_results_an_array?
+
+      end
+
+      protected
+
+      def set_other_responses
+
+          @soap_response.addressResults.proposedAddressDetails.each do |address_results|
+            response = {}
+            response[:changes]                  = address_results.changes
+            response[:deliveryPointValidation]  = address_results.deliveryPointValidation
+            response[:score]                    = address_results.score.to_i
+            response[:residentialStatus]        = address_results.residentialStatus 
+            response[:changedAddress]           = address_results.address.streetLines.to_s
+            response[:changedCity]              = address_results.address.city
+            response[:changedState]             = address_results.address.stateOrProvinceCode
+            response[:changedPostal]            = address_results.address.postalCode
+            self.responses << response
+          end
+      end
+
+      def address_results_an_array?
+        @soap_response.addressResults.proposedAddressDetails.is_a?(Array)
+      end
+  end
+end

data/lib/fedex_web_service.rb

@@ -0,0 +1,147 @@
+require "soap/wsdlDriver" #FIXME MAKE SURE TO REMOVE NEW VERSIONS OF SOAP4R 1.5.5 is the last version that is supported here
+require 'xmlrpc/client'
+require 'net/ftp'
+
+require "fedex_web_service/address_verification"
+    
+class FedexWebService
+  attr_accessor :tracking_number, :label, :full_response, :temp_image
+  
+  # There are three types of options designed to save keystokes. Gem default options are the options I use for this particular project
+  # I'm working on. These are easily overridden by providing options of the same name in the config/fedex_config.yml file. This will set
+  # the options per project. If you want to change the options PER LABEL, then just pass them in when you call the method
+  #
+  # EX: if you want to default residential to false for this project, then the yml file would look like:
+  # common: &testing
+  #     key: lotsoflettersandnumbers
+  #     ....
+  #     defaults:
+  #         residential: false
+  
+  
+  @@gem_default_options ={
+    :drop_off_type      => "REGULAR_PICKUP",
+    :residential        => true,
+    :label              => 'GROUND_HOME_DELIVERY',
+    :drop_off_type      => 'REGULAR_PICKUP',
+    :packaging_type     => 'YOUR_PACKAGING',
+    :label_format_type  => 'COMMON2D',
+    :label_stock_type   => 'PAPER_4X6',
+    :image_type         => "PNG",
+    :dimensions         => {:length => 5, :width => 5, :height => 5}
+  }
+  def initialize
+    raw_config = File.read(RAILS_ROOT + "/config/fedex_config.yml")
+    @fedex_conf = YAML.load(raw_config)[RAILS_ENV].symbolize_keys
+    
+    @key            = @fedex_conf[:key]
+    @password       = @fedex_conf[:password]
+    @accountnumber  = @fedex_conf[:accountnumber]
+    @meternumber    = @fedex_conf[:meternumber]
+    @ss_wsdl        = @fedex_conf[:ss_wsdl]
+    @default_options= @@gem_default_options.merge( @fedex_conf[:defaults] )
+  end
+  
+  def future_shipment(address_info, options = {})
+    # this method sends a request to Fedex to get the future shipment date, a tracking number and the image file of a label
+    # the method returns the tracking number as a result to show that the request was done correctly, those class attributes
+    # are set to include the tracking number, the label (img) and the full response (SOAP object ... yech)
+      
+    options = @default_options.merge( options ).symbolize_keys!
+    
+    wsdl = File.expand_path( RAILS_ROOT + '/lib/wsdl/' + @fedex_conf[:ss_wsdl] )
+    driver = build_wsdl_driver(wsdl)
+    
+
+    call = {:WebAuthenticationDetail => {:UserCredential => {:Key => @key, :Password => @password} },
+      :ClientDetail => {:AccountNumber => @accountnumber, :MeterNumber => @meternumber },
+      :TransactionDetail=> {:CustomerTransactionId => '*** Ground Domestic Shipping Request v7' },
+      :Version => {:ServiceId => 'ship', :Major => '7', :Intermediate => '0', :Minor => '0'},
+      :RequestedShipment => {
+      :ShipTimestamp => "#{3.days.from_now.strftime("%Y-%m-%d")}T9:00:00-07:00", 
+      :DropoffType => options[:drop_off_type],
+      :ServiceType => options[:label], # 'FEDEX_2_DAY' 'FEDEX_GROUND' 'GROUND_HOME_DELIVERY'
+      :PackagingType => options[:packaging_type], # valid values FEDEX_BOX, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING, ...
+      :SpecialServicesRequested => {:SpecialServiceType => "FUTURE_DATE_SHIPMENT"},
+      :Recipient => { #should have same address as Origin per docs
+        :Contact => {
+          :PersonName => address_info.first_name + " " + address_info.last_name,
+          :PhoneNumber => address_info.phone #params[:phone] 
+          
+        },
+        :Address => {
+          :CountryCode => 'US',
+          :StreetLines => address_info.shipping_address_1, #params[:shipAddress],
+          :City => address_info.shipping_city, #params[:shipCity],
+          :StateOrProvinceCode => address_info.shipping_state, #params[:shipState],
+          :PostalCode => address_info.shipping_zip, #params[:shipZip]
+          :Residential => options[:residential]
+        }
+      },
+      :Shipper => {
+        :Contact => {
+          :PersonName =>  options[:person_name],
+          :PhoneNumber => options[:phone_number]
+        },
+        :Address => {
+          :CountryCode => 'US',
+          :StreetLines => options[:address],
+          :City => options[:city],
+          :StateOrProvinceCode => options[:state],
+          :PostalCode => options[:postal_code]
+          #:Residential => TRUE
+        }
+      },
+      :ShippingChargesPayment => {
+        :PaymentType => 'SENDER',
+        :Payor => {
+          :AccountNumber => @accountnumber,
+          :CountryCode => 'US'
+        }
+      },
+      :LabelSpecification => {
+        :LabelFormatType => options[:label_format_type],
+        :LabelStockType => options[:label_stock_type],
+        :ImageType => options[:image_type], #// valid values DPL, EPL2, PDF, ZPLII and PNG
+        :CustomerSpecifiedDetail => {:MaskedData => "SHIPPER_ACCOUNT_NUMBER"}
+      },
+      :RateRequestTypes => 'ACCOUNT', #, // valid values ACCOUNT and LIST
+      :PackageCount => 1, 
+      :PackageDetail => "INDIVIDUAL_PACKAGES",
+      :RequestedPackageLineItems => [{
+        :SequenceNumber=>1, 
+        :Weight => { :Units => "LB", :Value => 1 },
+        :Dimensions => {
+          :Length => options[:dimensions][:length], 
+          :Width => options[:dimensions][:width], 
+          :Height => options[:dimensions][:height], 
+          :Units => "IN"
+        },
+        :CustomerReferences => [{:CustomerReferenceType => "INVOICE_NUMBER", :Value => "#{options[:invoice_number]}"} ],      #in a string so if it's empty it's just an empty string
+      }]
+    }
+  }
+    result = driver.processShipment(call)
+    begin
+      self.label = Base64.decode64(result.completedShipmentDetail.completedPackageDetails.label.parts.image)
+      self.full_response = result
+      self.tracking_number = result.completedShipmentDetail.completedPackageDetails.trackingIds.trackingNumber
+    rescue  Exception => e
+      #the FEDEX call returned an error
+      self.label = "error"
+      self.full_response = result
+      self.tracking_number = "error"
+    end
+  end
+  
+  protected
+  
+  def build_wsdl_driver(wsdl)
+    driver = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
+  end
+  
+  def fedex_time_stamp
+    "#{Time.now.year}-#{Time.now.month}-#{Time.now.day}T#{Time.now.hour}:#{Time.now.min}:#{Time.now.sec}-08:00"
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fedex_web_service'
+
+class Test::Unit::TestCase
+end

data/test/test_fedex_web_service.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFedexWebService < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: fedex_web_service
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- bryce mcdonnell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides an interface to several, but not all, of the FedEx web services. Currently provides Ship service and Address Verification. Utilizes the SOAP (blech) service so you must get a wsdl and production keys from FedEx
+email: bryce@bridgetownint.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- fedex_web_service.gemspec
+- lib/fedex_web_service.rb
+- lib/fedex_web_service/address_verification.rb
+- test/helper.rb
+- test/test_fedex_web_service.rb
+has_rdoc: true
+homepage: http://github.com/brycem/fedex_web_service
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A quick and easy interface to the Fedex Web Services API
+test_files: 
+- test/helper.rb
+- test/test_fedex_web_service.rb