trackerific 0.6.2 → 0.7.0

data/lib/trackerific/services/fedex.rb

@@ -1,101 +1,91 @@
 require 'httparty'
+require 'builder'
 
 module Trackerific
-  
-  # Provides package tracking support for FedEx
-  class FedEx < Trackerific::Service
-    # setup HTTParty
-    include ::HTTParty
-    format :xml
-    base_uri "https://gateway.fedex.com"
-    
-    class << self
+  module Services
+    class FedEx < Base
+      include ::HTTParty
+
+      format :xml
+      base_uri "https://gateway.fedex.com"
+
+      self.register :fedex
+
       # An Array of Regexp that matches valid FedEx package IDs
       # @return [Array, Regexp] the regular expression
       # @api private
-      def package_id_matchers
+      def self.package_id_matchers
         [ /^[0-9]{15}$/ ]
       end
-      
-      # Returns an Array of required parameters used when creating a new instance
-      # @return [Array] required parameters for tracking a FedEx package are :account
-      #   and :meter
-      # @api private
-      def required_parameters
-        [:account, :meter]
+
+      def initialize(options={})
+        @options = options
       end
-    end
-    
-    # Tracks a FedEx package
-    # @param [String] package_id the package identifier
-    # @return [Trackerific::Details] the tracking details
-    # @raise [Trackerific::Error] raised when the server returns an error (invalid credentials, tracking package, etc.)
-    # @example Track a package
-    #   fedex = Trackerific::FedEx.new :account => 'account', :meter => 'meter'
-    #   details = fedex.track_package("183689015000001")
-    # @api public
-    def track_package(package_id)
-      super
-      # request tracking information from FedEx via HTTParty
-      http_response = self.class.post "/GatewayDC", :body => build_xml_request
-      # raise any HTTP errors
-      http_response.error! unless http_response.code == 200
-      # get the tracking information from the reply
-      track_reply = http_response["FDXTrack2Reply"]
-      # raise a Trackerific::Error if there is an error in the reply
-      raise Trackerific::Error, track_reply["Error"]["Message"] unless track_reply["Error"].nil?
-      # get the details from the reply
-      details = track_reply["Package"]
-      # convert them into Trackerific::Events
-      events = []
-      details["Event"].each do |e|
-        date = Time.parse("#{e["Date"]} #{e["Time"]}")
-        desc = e["Description"]
-        addr = e["Address"]
-        events << Trackerific::Event.new(
-          :date         => date,
-          :description  => desc,
-          :location     => "#{addr["StateOrProvinceCode"]} #{addr["PostalCode"]}"
+
+      # Tracks a FedEx package
+      # @param [String] package_id the package identifier
+      # @return [Trackerific::Details] the tracking details
+      # @raise [Trackerific::Error] raised when the server returns an error (invalid credentials, tracking package, etc.)
+      # @example Track a package
+      #   fedex = Trackerific::FedEx.new :account => 'account', :meter => 'meter'
+      #   details = fedex.track_package("183689015000001")
+      # @api public
+      def track(package_id)
+        # request tracking information from FedEx via HTTParty
+        http_response = self.class.post "/GatewayDC", body: build_xml_request
+        # raise any HTTP errors
+        http_response.error! unless http_response.code == 200
+        # get the tracking information from the reply
+        track_reply = http_response["FDXTrack2Reply"]
+        # raise a Trackerific::Error if there is an error in the reply
+        raise Trackerific::Error, track_reply["Error"]["Message"] unless track_reply["Error"].nil?
+        # get the details from the reply
+        details = track_reply["Package"]
+        # convert them into Trackerific::Events
+        events = []
+        details["Event"].each do |e|
+          date = Time.parse("#{e["Date"]} #{e["Time"]}")
+          desc = e["Description"]
+          addr = e["Address"]
+          loc = "#{addr["StateOrProvinceCode"]} #{addr["PostalCode"]}"
+          events << Trackerific::Event.new(date, desc, loc)
+        end
+        # Return a Trackerific::Details containing all the events
+        Trackerific::Details.new(
+          details["TrackingNumber"], details["StatusDescription"], events
         )
       end
-      # Return a Trackerific::Details containing all the events
-      Trackerific::Details.new(
-        :package_id => details["TrackingNumber"],
-        :summary    => details["StatusDescription"],
-        :events     => events
-      )
-    end
-    
-    protected
-    
-    # Builds the XML request to send to FedEx
-    # @return [String] a FDXTrack2Request XML
-    # @api private
-    def build_xml_request
-      xml = ""
-      # the API namespace
-      xmlns_api = "http://www.fedex.com/fsmapi"
-      # the XSI namespace
-      xmlns_xsi = "http://www.w3.org/2001/XMLSchema-instance"
-      # the XSD namespace
-      xsi_noNSL = "FDXTrack2Request.xsd"
-      # create a new Builder to generate the XML
-      builder = ::Builder::XmlMarkup.new(:target => xml)
-      # add the XML header
-      builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
-      # Build, and return the request
-      builder.FDXTrack2Request "xmlns:api"=>xmlns_api, "xmlns:xsi"=>xmlns_xsi, "xsi:noNamespaceSchemaLocation" => xsi_noNSL do |r|
-        r.RequestHeader do |rh|
-          rh.AccountNumber @options[:account]
-          rh.MeterNumber @options[:meter]
-        end
-        r.PackageIdentifier do |pi|
-          pi.Value @package_id
+
+      private
+
+      # Builds the XML request to send to FedEx
+      # @return [String] a FDXTrack2Request XML
+      # @api private
+      def build_xml_request
+        xml = ""
+        # the API namespace
+        xmlns_api = "http://www.fedex.com/fsmapi"
+        # the XSI namespace
+        xmlns_xsi = "http://www.w3.org/2001/XMLSchema-instance"
+        # the XSD namespace
+        xsi_noNSL = "FDXTrack2Request.xsd"
+        # create a new Builder to generate the XML
+        builder = ::Builder::XmlMarkup.new(:target => xml)
+        # add the XML header
+        builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+        # Build, and return the request
+        builder.FDXTrack2Request "xmlns:api"=>xmlns_api, "xmlns:xsi"=>xmlns_xsi, "xsi:noNamespaceSchemaLocation" => xsi_noNSL do |r|
+          r.RequestHeader do |rh|
+            rh.AccountNumber @options[:account]
+            rh.MeterNumber @options[:meter]
+          end
+          r.PackageIdentifier do |pi|
+            pi.Value @package_id
+          end
+          r.DetailScans true
         end
-        r.DetailScans true
+        xml
       end
-      xml
     end
-    
   end
 end

data/lib/trackerific/services/mock_service.rb

@@ -1,62 +1,51 @@
-require 'date'
-
 module Trackerific
-  
-  # Provides a mock service for using in test and development
-  class MockService < Trackerific::Service
-    
-    class << self
+  module Services
+     # Provides a mock service for using in test and development
+    class MockService < Base
+      require 'date'
+
+      self.register :mock_service
+
       # Regular expression matchers for mocked Trackerific service
       # @return [Array, Regexp] the regular expression
       # @api private
-      def package_id_matchers
-        return [ /XXXXXXXXXX/, /XXXxxxxxxx/ ] unless Rails.env.production?
-        return [ ]
+      def self.package_id_matchers
+        [ /XXXXXXXXXX/, /XXXxxxxxxx/ ]
       end
-      
-      # Returns an Array of required parameters used when creating a new instance
-      # @return [Array] required parameters
-      # @api private
-      def required_parameters
-        [ ]
-      end
-    end
-    
-    # Sets up a mocked package details
-    # @param [String] package_id the package identifier
-    # @return [Trackerific::Details] the tracking details
-    # @raise [Trackerific::Error] raised when the server returns an error
-    # @example Track a package
-    #   service = Trackerific::MockedService.new
-    #   details = service.track_package("XXXXXXXXXX") # => valid response
-    #   details = service.track_package("XXXxxxxxxx") # => throws a Trackerific::Error exception
-    # @api public
-    def track_package(package_id)
-      super
-      if package_id == "XXXXXXXXXX"
-        Trackerific::Details.new(
-          :package_id => package_id,
-          :summary    => "Your package was delivered.",
-          :events     => [
-            Trackerific::Event.new(
-              :date         => Date.today,
-              :description  => "Package delivered.",
-              :location     => "SANTA MARIA, CA"
-            ),
-            Trackerific::Event.new(
-              :date         => Date.today - 1,
-              :description  => "Package scanned.",
-              :location     => "SANTA BARBARA, CA"
-            ),
-            Trackerific::Event.new(
-              :date         => Date.today - 2,
-              :description  => "Package picked up for delivery.",
-              :location     => "LOS ANGELES, CA"
-            )
-          ]
-        )
-      else
-        raise Trackerific::Error, "Package not found."
+
+      # Sets up a mocked package details
+      # @param [String] package_id the package identifier
+      # @return [Trackerific::Details] the tracking details
+      # @raise [Trackerific::Error] raised when the server returns an error
+      # @example Track a package
+      #   service = Trackerific::Services::MockedService.new
+      #   details = service.track("XXXXXXXXXX") # => valid response
+      #   details = service.track("XXXxxxxxxx") # => throws a Trackerific::Error exception
+      # @api public
+      def track(id)
+        if id == "XXXXXXXXXX"
+          Trackerific::Details.new(id, "Your package was delivered.",
+            [
+              Trackerific::Event.new(
+                :date         => Date.today,
+                :description  => "Package delivered.",
+                :location     => "SANTA MARIA, CA"
+              ),
+              Trackerific::Event.new(
+                :date         => Date.today - 1,
+                :description  => "Package scanned.",
+                :location     => "SANTA BARBARA, CA"
+              ),
+              Trackerific::Event.new(
+                :date         => Date.today - 2,
+                :description  => "Package picked up for delivery.",
+                :location     => "LOS ANGELES, CA"
+              )
+            ]
+          )
+        else
+          raise Trackerific::Error, "Package not found."
+        end
       end
     end
   end

data/lib/trackerific/services/ups.rb

@@ -1,120 +1,111 @@
+require 'httparty'
+require 'builder'
 require 'date'
 
 module Trackerific
-  require 'httparty'
-  
-  # Provides package tracking support for UPS.
-  class UPS < Trackerific::Service
-    # setup HTTParty
-    include ::HTTParty
-    format :xml
-    # use the test site for Rails development, production for everything else
-    base_uri defined?(Rails) ? case Rails.env
-      when 'test','development' then 'https://wwwcie.ups.com/ups.app/xml'
+  module Services
+    # Provides package tracking support for UPS.
+    class UPS < Base
+      self.register :ups
+
+      include ::HTTParty
+      format :xml
+
+      base_uri case (ENV['RAILS_ENV'] || 'production')
       when 'production' then 'https://www.ups.com/ups.app/xml'
-    end : 'https://www.ups.com/ups.app/xml'
-    
-    class << self
+      else 'https://wwwcie.ups.com/ups.app/xml'
+      end
+
+      def initialize(options={})
+        @options = options
+      end
+
       # An Array of Regexp that matches valid UPS package IDs
       # @return [Array, Regexp] the regular expression
       # @api private
-      def package_id_matchers
+      def self.package_id_matchers
         [ /^.Z/, /^[HK].{10}$/ ]
-      end    
-      # The required parameters for tracking a UPS package
-      # @return [Array] the required parameters for tracking a UPS package
-      # @api private
-      def required_parameters
-        [:key, :user_id, :password]
       end
-    end
-    
-    # Tracks a UPS package
-    # @param [String] package_id the package identifier
-    # @return [Trackerific::Details] the tracking details
-    # @raise [Trackerific::Error] raised when the server returns an error (invalid credentials, tracking package, etc.)
-    # @example Track a package
-    #   ups = Trackerific::UPS.new key: 'api key', user_id: 'user', password: 'secret'
-    #   details = ups.track_package("1Z12345E0291980793")
-    # @api public
-    def track_package(package_id)
-      super
-      # connect to UPS via HTTParty
-      http_response = self.class.post('/Track', :body => build_xml_request)
-      # throw any HTTP errors
-      http_response.error! unless http_response.code == 200
-      # Check the response for errors, return a Trackerific::Error, or parse
-      # the response from UPS and return a Trackerific::Details
-      case http_response['TrackResponse']['Response']['ResponseStatusCode']
-        when "0" then raise Trackerific::Error, parse_error_response(http_response)
-        when "1" then return parse_success_response(http_response)
-        else raise Trackerific::Error, "Invalid response code returned from server."
+
+      # Tracks a UPS package
+      # @param [String] package_id the package identifier
+      # @return [Trackerific::Details] the tracking details
+      # @raise [Trackerific::Error] raised when the server returns an error (invalid credentials, tracking package, etc.)
+      # @example Track a package
+      #   ups = Trackerific::UPS.new key: 'api key', user_id: 'user', password: 'secret'
+      #   details = ups.track_package("1Z12345E0291980793")
+      # @api public
+      def track(id)
+        @package_id = id
+        # connect to UPS via HTTParty
+        http_response = self.class.post('/Track', body: build_xml_request)
+        # throw any HTTP errors
+        http_response.error! unless http_response.code == 200
+        # Check the response for errors, return a Trackerific::Error, or parse
+        # the response from UPS and return a Trackerific::Details
+        case http_response['TrackResponse']['Response']['ResponseStatusCode']
+          when "0" then raise Trackerific::Error, parse_error_response(http_response)
+          when "1" then return parse_success_response(http_response)
+          else raise Trackerific::Error, "Invalid response code returned from server."
+        end
       end
-    end
-    
-    protected
-    
-    # Parses the response from UPS
-    # @return [Trackerific::Details]
-    # @api private
-    def parse_success_response(http_response)
-      # get the activity from the UPS response
-      activity = http_response['TrackResponse']['Shipment']['Package']['Activity']
-      # if there's only one activity in the list, we need to put it in an array
-      activity = [activity] if activity.is_a? Hash
-      # UPS does not provide a summary, so we'll just use the last tracking status
-      summary = activity.first['Status']['StatusType']['Description'].titleize
-      events = []
-      activity.each do |a|
-        # the time format from UPS is HHMMSS, which cannot be directly converted
-        # to a Ruby time.
-        hours   = a['Time'][0..1]
-        minutes = a['Time'][2..3]
-        seconds = a['Time'][4..5]
-        date    = Date.parse(a['Date'])
-        date    = DateTime.parse("#{date} #{hours}:#{minutes}:#{seconds}")
-        desc    = a['Status']['StatusType']['Description'].titleize
-        loc     = a['ActivityLocation']['Address'].map {|k,v| v}.join(" ")
-        events << Trackerific::Event.new(
-          :date         => date,
-          :description  => desc,
-          :location     => loc
-        )
+
+      protected
+
+      # Parses the response from UPS
+      # @return [Trackerific::Details]
+      # @api private
+      def parse_success_response(http_response)
+        # get the activity from the UPS response
+        activity = http_response['TrackResponse']['Shipment']['Package']['Activity']
+        # if there's only one activity in the list, we need to put it in an array
+        activity = [activity] if activity.is_a? Hash
+        # UPS does not provide a summary, so we'll just use the last tracking status
+        summary = activity.first['Status']['StatusType']['Description']
+        events = []
+        activity.each do |a|
+          # the time format from UPS is HHMMSS, which cannot be directly converted
+          # to a Ruby time.
+          hours   = a['Time'][0..1]
+          minutes = a['Time'][2..3]
+          seconds = a['Time'][4..5]
+          date    = Date.parse(a['Date'])
+          date    = DateTime.parse("#{date} #{hours}:#{minutes}:#{seconds}")
+          desc    = a['Status']['StatusType']['Description']
+          loc     = a['ActivityLocation']['Address'].map {|k,v| v}.join(" ")
+          events << Trackerific::Event.new(date, desc, loc)
+        end
+
+        Trackerific::Details.new(@package_id, summary, events)
       end
-      
-      Trackerific::Details.new(
-        :package_id => @package_id,
-        :summary    => summary,
-        :events     => events
-      )
-    end
-    
-    # Parses a UPS tracking response, and returns any errors
-    # @return [String] the UPS tracking error
-    # @api private
-    def parse_error_response(http_response)
-      http_response['TrackResponse']['Response']['Error']['ErrorDescription']
-    end
-    
-    # Builds the XML request to send to UPS for tracking a package
-    # @return [String] the XML request
-    # @api private
-    def build_xml_request
-      xml = ""
-      builder = ::Builder::XmlMarkup.new(:target => xml)
-      builder.AccessRequest do |ar|
-        ar.AccessLicenseNumber @options[:key]
-        ar.UserId @options[:user_id]
-        ar.Password @options[:password]
+
+      # Parses a UPS tracking response, and returns any errors
+      # @return [String] the UPS tracking error
+      # @api private
+      def parse_error_response(http_response)
+        http_response['TrackResponse']['Response']['Error']['ErrorDescription']
       end
-      builder.TrackRequest do |tr|
-        tr.Request do |r|
-          r.RequestAction 'Track'
-          r.RequestOption 'activity'
+
+      # Builds the XML request to send to UPS for tracking a package
+      # @return [String] the XML request
+      # @api private
+      def build_xml_request
+        xml = ""
+        builder = ::Builder::XmlMarkup.new(:target => xml)
+        builder.AccessRequest do |ar|
+          ar.AccessLicenseNumber @options[:key]
+          ar.UserId @options[:user_id]
+          ar.Password @options[:password]
+        end
+        builder.TrackRequest do |tr|
+          tr.Request do |r|
+            r.RequestAction 'Track'
+            r.RequestOption 'activity'
+          end
+          tr.TrackingNumber @package_id
         end
-        tr.TrackingNumber @package_id
+        return xml
       end
-      return xml
     end
   end
 end