ups_time_in_transit_plus 0.1.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGMxNTA2ZGEwNWFlYWJjZGU4YWQxYmE5NmZmYzU3ZGRhZWNmYzI3OA==
+  data.tar.gz: !binary |-
+    ZjY5YTczZWUzYmMyOTdhZGJmYzhmNzc4NDk3NTYyNTFlNTAwNTlkZg==
+SHA512:
+  metadata.gz: !binary |-
+    ZjljNWFhNzJjODdhZTU1Y2U1OGNhZDQwYjUwNGNhZTBkM2MxYzUwMWRjMzJj
+    NmQxZGM3MWI3N2JjNjY2ZTgyY2I5N2VjZDhlN2M5M2UwNmJhNjNlOWFhMjE3
+    MjYyY2JjZWE5NjQwMmQwZTBmZmQ2MDdkYjgyZWZkNjc2NDNhZWQ=
+  data.tar.gz: !binary |-
+    MjNjYzE1ZjY3ZmNmNTU1Y2UyYWU5N2MzYTc3OTJkNGM2ZWVjMjcyYmQ3YTFk
+    NzA3MGNmZGY3N2UyYWIzNzFiY2RhODc0MWM0YWQ2OTE5YTZjN2U1MmVkOTQx
+    ZTI4OTMzZjZjYjNlMDYzNjYyMjJjZDVkMTQ3MGVhMzBhMDhhMDc=

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2010 Joseph Stelmach
+
+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/Manifest

@@ -0,0 +1,6 @@
+LICENSE
+Manifest
+README
+Rakefile
+lib/ups_time_in_transit.rb
+ups_time_in_transit.gemspec

data/README

@@ -0,0 +1,58 @@
+ups_time_in_transit is an easy to use interface to the UPS Time in Transit API.
+
+== installation ==
+gem install ups_time_in_transit
+
+== usage ==
+
+# define your access options.  These are options that won't change 
+# between requests.  Take care to specify the proper UPS url:
+# 'https://wwwcie.ups.com/ups.app/xml/TimeInTransit' for testing and
+# development, and 'https://onlinetools.ups.com/ups.app/xml/TimeInTransit'
+# for production.
+access_options = {
+  :url => 'https://wwwcie.ups.com/ups.app/xml/TimeInTransit',
+  :access_license_number => 'foo',
+  :user_id => 'bar',
+  :password => 'baz',
+  :order_cutoff_time => 17 ,
+  :sender_city => 'Hoboken',
+  :sender_state => 'NJ',
+  :sender_country_code => 'US',
+  :sender_zip => '07030'}
+
+# It's best to store these these options in a yaml file and load them
+# into a map when you need them:
+yaml = YAML.load_file("#{RAILS_ROOT}/config/ups_time_in_transit.yml")
+access_options = yaml[RAILS_ENV].inject({}){|h,(k, v)| h[k.to_sym] = v; h}
+
+# create an api instance with your access options
+time_in_transit_api = UPS::TimeInTransit.new(access_options)
+
+# for each request, generate a map of request options describing
+# the shipment and where it's going
+request_options = {
+  :total_packages => 1,
+  :unit_of_measurement => 'LBS',
+  :weight => 10,
+  :city => 'Newark',
+  :state => 'DE',
+  :zip => '19711',
+  :country_code => 'US'}
+
+# request the map of delivery types (overnight, ground, etc.) to the expected 
+# delivery date for that type.  Be sure to rescue any errors.
+begin
+  delivery_dates = time_in_transit_api.request(request_options)
+rescue => error
+  puts error.inspect
+end
+
+== changelog ==
+
+v.0.1.1
+  some erroneous documentation 
+
+v.0.1.0
+  initial release
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('ups_time_in_transit', '0.1.1') do |p|
+  p.description    = "Provides an easy to use interface to the UPS time in transit API"
+  p.url            = "http://github.com/joestelmach/ups_time_in_transit"
+  p.author         = "Joe Stelmach"
+  p.email          = "joestelmach @nospam@ gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ['activesupport']
+end

data/lib/ups_time_in_transit.rb

@@ -0,0 +1,257 @@
+require 'date'
+require 'rexml/document'
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'active_support'
+
+module UPS
+  # Provides a simple api to to ups's time in transit service.
+  class TimeInTransit
+    XPCI_VERSION = '1.0002'
+    DEFAULT_CUTOFF_TIME = 18
+    DEFAULT_TIMEOUT = 30
+    DEFAULT_RETRY_COUNT = 3
+    DEFAULT_COUNTRY_CODE = 'US'
+    DEFAULT_UNIT_OF_MEASUREMENT = 'LBS'
+
+    # Creates a TimeInTransit instance based on the given hash of access 
+    # options The following access options are available and are required 
+    # unless a default value is specified:
+    #
+    # [<tt>:url</tt>]
+    #   The ups api url to use
+    #
+    # [<tt>:access_license_number</tt>]
+    #   Your ups license number
+    #
+    # [<tt>:user_id</tt>]
+    #    Your ups user id
+    #
+    # [<tt>password</tt>]
+    #   Your ups password
+    #
+    # [<tt>:order_cutoff_time</tt>]
+    #   Your own arbitrary cutoff time that is some time before the actual ups cutoff 
+    #   time.  Requests made after this time will use the following day as the send 
+    #   date (or the following monday if the request is made on a weekend or on a 
+    #   friday after this time.)
+    #
+    # [<tt>:sender_city</tt>]
+    #   The city you are shipping from
+    #
+    # [<tt>:sender_state</tt>]
+    #   The state you are shipping from
+    #
+    # [<tt>:sender_zip</tt>]
+    #   The zip code you are shipping from
+    #
+    # [<tt>:sender_country_code</tt>]
+    #   The country you are shipping from (defaults to 'US')
+    #
+    # [<tt>:retry_count</tt>]
+    #   The number of times you would like to retry when a connection 
+    #   fails (defaults to 3)
+    #
+    # [<tt>:timeout</tt>]
+    #   The number of seconds you would like to wait for a response before 
+    #   giving up (defaults to 30)
+    #
+    def initialize(access_options)
+      @order_cutoff_time = access_options[:order_cutoff_time] || DEFAULT_CUTOFF_TIME
+      @url = access_options[:url]
+      @timeout = access_options[:timeout] || DEFAULT_TIMEOUT 
+      @retry_count = access_options[:retry_count] || DEFAULT_CUTOFF_TIME 
+
+      @access_xml = generate_xml({
+        :AccessRequest => {
+          :AccessLicenseNumber => access_options[:access_license_number],
+          :UserId => access_options[:user_id],
+          :Password => access_options[:password]
+        }
+      })
+
+      @transit_from_attributes = {
+        :AddressArtifactFormat => {
+          :PoliticalDivision2 => access_options[:sender_city],
+          :PoliticalDivision1 => access_options[:sender_state],
+          :CountryCode => access_options[:sender_country_code] || DEFAULT_COUNTRY_CODE,
+          :PostcodePrimaryLow => access_options[:sender_zip]
+        }
+      }
+    end
+
+    # Requests time in transit information based on the given hash of options:
+    #
+    # [<tt>:total_packages</tt>]
+    #   the number of packages in the shipment (defaults to 1)
+    #
+    # [<tt>:unit_of_measurement</tt>]
+    #   the unit of measurement to use (defaults to 'LBS')
+    #
+    # [<tt>:weight</tt>]
+    #   the weight of the shipment in the given units
+    #
+    # [<tt>:city</tt>]
+    #   the city you are shipping to
+    #
+    # [<tt>:state</tt>]
+    #   the state you are shipping to
+    #
+    # [<tt>:zip</tt>]
+    #   the zip code you are shipping to
+    #
+    # [<tt>:country_code</tt>]
+    #   the country you are shipping to (defaults to 'US')
+    #
+    # An error will be raised if the request is unsuccessful.
+    #
+    def request(options)
+      
+      # build our request xml
+      pickup_date = calculate_pickup_date
+      options[:pickup_date] = pickup_date.strftime('%Y%m%d')
+      xml = @access_xml + generate_xml(build_transit_attributes(options))
+
+      # attempt the request in a timeout
+      delivery_dates = {}
+      attempts = 0
+      begin 
+        Timeout.timeout(@timeout) do
+          response = send_request(@url, xml)
+          delivery_dates = response_to_map(response)
+        end
+
+      # We can only attempt to recover from Timeout errors, all other errors
+      # should be raised back to the user
+      rescue Timeout::Error => error
+        if(attempts < @retry_count)
+          attempts += 1
+          retry
+
+        else
+          raise error
+        end
+      end
+
+      delivery_dates
+    end
+
+    private 
+
+    # calculates the next available pickup date based on the current time and the 
+    # configured order cutoff time
+    def calculate_pickup_date
+      now = Time.now
+      day_of_week = now.strftime('%w').to_i
+      in_weekend = [6,0].include?(day_of_week)
+      in_friday_after_cutoff = day_of_week == 5 and now.hour > @order_cutoff_time
+      # Rails.logger.debug "Time now is: #{now}\nOrder cutoff time is: #{@order_cutoff_time}\n"
+
+      # If we're in a weekend (6 is Sat, 0 is Sun,) or we're in Friday after
+      # the cutoff time, then our ship date will move
+      if(in_weekend or in_friday_after_cutoff)
+        pickup_date = now.next_week
+
+      # if we're in another weekday but after the cutoff time, our ship date
+      # moves to tomorrow
+      elsif(now.hour > @order_cutoff_time)
+	      # Rails.logger.debug "\nSetting the time in transit to tomorrow #{now.tomorrow}, since now.hour > @order_cutoff_time = #{now.hour > @order_cutoff_time}\n"
+        pickup_date = now.tomorrow
+      else
+        pickup_date = now
+      end
+      # Rails.logger.debug "UPS pickup_date is: #{pickup_date} and the time now is #{now}"
+      return pickup_date
+    end
+
+    # Builds a hash of transit request attributes based on the given values
+    def build_transit_attributes(options)
+      # set defaults if none given
+      options[:total_packages] = 1 unless options[:total_packages]
+
+      # convert all options to string values
+      options.each_value {|option| option = options.to_s}
+
+      transit_attributes = {
+        :TimeInTransitRequest => {
+          :Request => {
+            :RequestAction => 'TimeInTransit',
+            :TransactionReference => {
+              :XpciVersion => XPCI_VERSION
+            }
+          },
+          :TotalPackagesInShipment => options[:total_packages],
+          :ShipmentWeight => {
+            :UnitOfMeasurement => {
+              :Code => options[:unit_of_measurement] || DEFAULT_UNIT_OF_MEASUREMENT
+            },
+            :Weight => options[:weight],
+          },
+          :PickupDate => options[:pickup_date],
+          :TransitFrom => @transit_from_attributes,
+          :TransitTo => {
+            :AddressArtifactFormat => {
+              :PoliticalDivision2 => options[:city],
+              :PoliticalDivision1 => options[:state],
+              :CountryCode => options[:country_code] || DEFAULT_COUNTRY_CODE,
+              :PostcodePrimaryLow => options[:zip],
+            }
+          }
+        }
+      }
+    end
+
+    # generates an xml document for the given attributes
+    def generate_xml(attributes)
+      xml = REXML::Document.new
+      xml << REXML::XMLDecl.new
+      emit(attributes, xml)
+      xml.root.add_attribute("xml:lang", "en-US")
+      xml.to_s
+    end
+
+    # recursively emits xml nodes under the given node for values in the given hash
+    def emit(attributes, node)
+      attributes.each do |k,v|
+        child_node = REXML::Element.new(k.to_s, node)
+        (v.respond_to? 'each_key') ? emit(v, child_node) : child_node.add_text(v.to_s)
+      end
+    end
+
+    # Posts the given data to the given url, returning the raw response
+    def send_request(url, data)
+      # Rails.logger.debug "Sending the following data in a request to UPS time in transit API:\n#{data}\n"
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.port == 443
+        http.use_ssl	= true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = http.post(uri.path, data)
+      response.code == '200' ? response.body : response.error!
+    end
+
+    # converts the given raw xml response to a map of local service codes
+    # to estimated delivery dates
+    def response_to_map(response) 
+      # Rails.logger.debug "Received the following data in a response from UPS time in transit API:\n#{response}\n"
+      response_doc = REXML::Document.new(response)
+      response_code = response_doc.elements['//ResponseStatusCode'].text.to_i
+      raise "Invalid response from ups:\n#{response_doc.to_s}" if(!response_code || response_code != 1)
+
+      service_codes_to_delivery_dates = {}
+      response_code = response_doc.elements.each('//ServiceSummary') do |service_element|
+        service_code = service_element.elements['Service/Code'].text
+        if(service_code)
+          date_string     = service_element.elements['EstimatedArrival/Date'].text
+          time_string     = service_element.elements['EstimatedArrival/Time'].text
+	        days_in_transit  = service_element.elements['EstimatedArrival/BusinessTransitDays'].text.to_i
+          delivery_date = Time.parse("#{date_string} #{time_string}")
+          service_codes_to_delivery_dates[service_code] = {:delivery_date => delivery_date, :days_in_transit => days_in_transit}
+        end
+      end
+      service_codes_to_delivery_dates
+    end
+  end
+end

data/ups_time_in_transit_plus.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ups_time_in_transit_plus}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joe Stelmach, Benjamin Crudo"]
+  # s.cert_chain = ["/Users/joe/workspace/personal/gem-public_cert.pem"]
+  s.date = %q{2013-10-07}
+  s.description = %q{Provides an easy to use interface to the UPS time in transit API}
+  s.email = %q{gems @nospam@ gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README", "lib/ups_time_in_transit.rb"]
+  s.files = ["LICENSE", "Manifest", "README", "Rakefile", "lib/ups_time_in_transit.rb", "ups_time_in_transit_plus.gemspec"]
+  s.homepage = %q{http://github.com/BENGMN/ups_time_in_transit}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ups_time_in_transit", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ups_time_in_transit_plus}
+  s.rubygems_version = %q{1.3.7}
+  # s.signing_key = %q{/Users/joe/workspace/personal/gem-private_key.pem}
+  s.summary = %q{Provides an easy to use interface to the UPS time in transit API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: ups_time_in_transit_plus
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Joe Stelmach, Benjamin Crudo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides an easy to use interface to the UPS time in transit API
+email: gems @nospam@ gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README
+- lib/ups_time_in_transit.rb
+files:
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- lib/ups_time_in_transit.rb
+- ups_time_in_transit_plus.gemspec
+homepage: http://github.com/BENGMN/ups_time_in_transit
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Ups_time_in_transit
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: ups_time_in_transit_plus
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 3
+summary: Provides an easy to use interface to the UPS time in transit API
+test_files: []