trackerific 0.7.2 → 0.7.3

data/lib/trackerific/parsers/fedex.rb

@@ -1,59 +1,55 @@
-module Trackerific
-  module Parsers
-    class FedEx < Parsers::Base
-      protected
-
-      def response_error
-        @response_error ||= if highest_severity == 'ERROR'
-          Trackerific::Error.new(notifications[:message])
-        else
-          false
-        end
-      end
+class Trackerific::Parsers::FedEx < Trackerific::Parsers::Base
+  protected
+
+  def response_error
+    @response_error ||= if highest_severity == 'ERROR'
+      Trackerific::Error.new(notifications[:message])
+    else
+      false
+    end
+  end
 
-      def summary
-        nil
-      end
+  def summary
+    nil
+  end
 
-      def events
-        track_details.map do |detail|
-          Trackerific::Event.new(parse_date(detail), nil, location(detail))
-        end
-      end
+  def events
+    track_details.map do |detail|
+      Trackerific::Event.new(parse_date(detail), nil, location(detail))
+    end
+  end
 
-      private
+  private
 
-      def location(detail)
-        a = detail[:destination_address]
-        "#{a[:city]}, #{a[:state_or_province_code]} #{a[:country_code]}"
-      end
+  def location(detail)
+    a = detail[:destination_address]
+    "#{a[:city]}, #{a[:state_or_province_code]} #{a[:country_code]}"
+  end
 
-      def parse_date(detail)
-        detail[:ship_timestamp]
-      end
+  def parse_date(detail)
+    detail[:ship_timestamp]
+  end
 
-      def track_reply
-        @response.hash[:envelope][:body][:track_reply]
-      end
+  def track_reply
+    @response.hash[:envelope][:body][:track_reply]
+  end
 
-      def track_details
-        @track_details ||= begin
-          details = track_reply[:completed_track_details][:track_details]
-          details.select do |d|
-            d[:ship_timestamp].present? && d[:destination_address].present? &&
-            d[:destination_address][:city].present? &&
-            d[:destination_address][:state_or_province_code].present?
-          end
-        end
+  def track_details
+    @track_details ||= begin
+      details = track_reply[:completed_track_details][:track_details]
+      details.select do |d|
+        d[:ship_timestamp].present? && d[:destination_address].present? &&
+        d[:destination_address][:city].present? &&
+        d[:destination_address][:state_or_province_code].present?
       end
+    end
+  end
 
-      def highest_severity
-        track_reply[:highest_severity]
-      end
+  def highest_severity
+    track_reply[:highest_severity]
+  end
 
-      def notifications
-        track_reply[:notifications]
-      end
-    end
+  def notifications
+    track_reply[:notifications]
   end
 end

data/lib/trackerific/parsers/ups.rb

@@ -1,66 +1,62 @@
-module Trackerific
-  module Parsers
-    class UPS < Parsers::Base
-      protected
-
-      def response_error
-        @response_error ||= if @response.code != 200
-          Trackerific::Error.new("HTTP returned status #{@response.code}")
-        elsif response_status_code == :error
-          Trackerific::Error.new(error_response)
-        elsif response_status_code == :success
-          false
-        else
-          Trackerific::Error.new("Unknown status code from server.")
-        end
-      end
+class Trackerific::Parsers::UPS < Trackerific::Parsers::Base
+  protected
+
+  def response_error
+    @response_error ||= if @response.code != 200
+      Trackerific::Error.new("HTTP returned status #{@response.code}")
+    elsif response_status_code == :error
+      Trackerific::Error.new(error_response)
+    elsif response_status_code == :success
+      false
+    else
+      Trackerific::Error.new("Unknown status code from server.")
+    end
+  end
 
-      def summary
-        description(activity.first)
-      end
+  def summary
+    description(activity.first)
+  end
 
-      def events
-        activity.map do |a|
-          date = parse_ups_date_time(a['Date'], a['Time'])
-          Trackerific::Event.new(date, description(a), location(a))
-        end
-      end
+  def events
+    activity.map do |a|
+      date = parse_ups_date_time(a['Date'], a['Time'])
+      Trackerific::Event.new(date, description(a), location(a))
+    end
+  end
 
-      private
+  private
 
-      def track_response
-        @response['TrackResponse']
-      end
+  def track_response
+    @response['TrackResponse']
+  end
 
-      def response_status_code
-        { "0" => :error,
-          "1" => :success
-        }[track_response['Response']['ResponseStatusCode']]
-      end
+  def response_status_code
+    { "0" => :error,
+      "1" => :success
+    }[track_response['Response']['ResponseStatusCode']]
+  end
 
-      def error_response
-        track_response['Response']['Error']['ErrorDescription']
-      end
+  def error_response
+    track_response['Response']['Error']['ErrorDescription']
+  end
 
-      def parse_ups_date_time(date, time)
-        hours, minutes, seconds = time.scan(/.{2}/)
-        DateTime.parse("#{Date.parse(date)} #{hours}:#{minutes}:#{seconds}")
-      end
+  def parse_ups_date_time(date, time)
+    hours, minutes, seconds = time.scan(/.{2}/)
+    DateTime.parse("#{Date.parse(date)} #{hours}:#{minutes}:#{seconds}")
+  end
 
-      def description(a)
-        a['Status']['StatusType']['Description']
-      end
+  def description(a)
+    a['Status']['StatusType']['Description']
+  end
 
-      def location(a)
-        a['ActivityLocation']['Address'].map {|k,v| v}.join(" ")
-      end
+  def location(a)
+    a['ActivityLocation']['Address'].map {|k,v| v}.join(" ")
+  end
 
-      def activity
-        @activity ||= begin
-          a = track_response['Shipment']['Package']['Activity']
-          a.is_a?(Array) ? a : [a]
-        end
-      end
+  def activity
+    @activity ||= begin
+      a = track_response['Shipment']['Package']['Activity']
+      a.is_a?(Array) ? a : [a]
     end
   end
 end

data/lib/trackerific/parsers/usps.rb

@@ -1,51 +1,47 @@
-module Trackerific
-  module Parsers
-    class USPS < Parsers::Base
-      protected
-
-      def response_error
-        @response_error ||= if @response.code != 200
-          Trackerific::Error.new("HTTP returned status #{@response.code}")
-        elsif @response['Error']
-          Trackerific::Error.new(@response['Error']['Description'])
-        elsif @response['TrackResponse'].nil? && @response['CityStateLookupResponse'].nil?
-          Trackerific::Error.new("Invalid response from server.")
-        else
-          false
-        end
-      end
-
-      def summary
-        tracking_info['TrackSummary']
-      end
-
-      def events
-        tracking_info.fetch('TrackDetail', []).map do |e|
-          Trackerific::Event.new(date(e), description(e), location(e))
-        end
-      end
-
-      private
-
-      def tracking_info
-        @response['TrackResponse']['TrackInfo']
-      end
-
-      def date(event)
-        d = event.split(" ")
-        DateTime.parse(d[0..3].join(" "))
-      end
-
-      def description(event)
-        d = event.split(" ")
-        d[4..d.length-4].join(" ")
-      end
-
-      def location(event)
-        d = event.gsub(".", "").split(" ")
-        city, state, zip = d.last(3)
-        "#{city}, #{state} #{zip}"
-      end
+class Trackerific::Parsers::USPS < Trackerific::Parsers::Base
+  protected
+
+  def response_error
+    @response_error ||= if @response.code != 200
+      Trackerific::Error.new("HTTP returned status #{@response.code}")
+    elsif @response['Error']
+      Trackerific::Error.new(@response['Error']['Description'])
+    elsif @response['TrackResponse'].nil? && @response['CityStateLookupResponse'].nil?
+      Trackerific::Error.new("Invalid response from server.")
+    else
+      false
     end
   end
+
+  def summary
+    tracking_info['TrackSummary']
+  end
+
+  def events
+    tracking_info.fetch('TrackDetail', []).map do |e|
+      Trackerific::Event.new(date(e), description(e), location(e))
+    end
+  end
+
+  private
+
+  def tracking_info
+    @response['TrackResponse']['TrackInfo']
+  end
+
+  def date(event)
+    d = event.split(" ")
+    DateTime.parse(d[0..3].join(" "))
+  end
+
+  def description(event)
+    d = event.split(" ")
+    d[4..d.length-4].join(" ")
+  end
+
+  def location(event)
+    d = event.gsub(".", "").split(" ")
+    city, state, zip = d.last(3)
+    "#{city}, #{state} #{zip}"
+  end
 end

data/lib/trackerific/services.rb

@@ -37,5 +37,15 @@ module Trackerific
         @services.map {|n,s| s if s.can_track?(id) }.compact
       end
     end
+
+    module Concerns
+      require 'trackerific/services/concerns/soap'
+      require 'trackerific/services/concerns/xml'
+    end
+
+    require 'trackerific/services/base'
+    require 'trackerific/services/fedex'
+    require 'trackerific/services/ups'
+    require 'trackerific/services/usps'
   end
 end

data/lib/trackerific/services/base.rb

@@ -1,58 +1,85 @@
-module Trackerific
-  module Services
-    class Base
-      @name = nil
-
-      class << self
-        attr_accessor :name
-
-        # Registers the service with Trackerific
-        # @api semipublic
-        def register(name)
-          self.name = name.to_sym
-          Trackerific::Services[self.name] = self
-        end
-
-        # Creates a new instance and calls #track with the given id
-        # @param id The package identifier
-        # @return Either a Trackerific::Details or Trackerific::Error
-        def track(id)
-          new.track(id)
-        end
-
-        # Reads the credentials from Trackerific.config
-        # @return [Hash] The service's credentials
-        def credentials
-          Trackerific.config[name]
-        end
-
-        # Checks if the given package ID can be tracked by this service
-        # @param [String] id The package ID
-        # @return [Boolean] true when this service can track the given ID
-        # @note This will always be false if no credentials were found for the
-        # service in Trackerific.config
-        def can_track?(id)
-          return false if credentials.nil?
-          package_id_matchers.each {|m| return true if id =~ m }
-          false
-        end
-
-        # An Array of Regexp that matches valid package ids for the service
-        # @api semipublic
-        def package_id_matchers
-          raise NotImplementedError,
-            "You must implement this method in your service", caller
-        end
-      end
-
-      def initialize(credentials=self.class.credentials)
-        @credentials = credentials
-
-        if credentials.nil?
-          raise Trackerific::Error,
-            "Missing credentials for #{self.class.name}", caller
-        end
-      end
+class Trackerific::Services::Base
+  class << self
+    attr_accessor :name
+    attr_accessor :config
+
+    # Configures the service
+    # @api semipublic
+    def configure(&block)
+      yield self.config = OpenStruct.new
+    end
+
+    # Includes the service concerns for the given service type
+    # @param [Symbol] service_type The module name for the service type
+    # @api semipublic
+    def concerns(service_type)
+      self.send :include,
+        "Trackerific::Services::Concerns::#{service_type}".constantize
+    end
+
+    # Registers the service with Trackerific
+    # @api semipublic
+    def register(name, options={})
+      concerns(options[:as]) if options[:as].present?
+      self.name = name.to_sym
+      Trackerific::Services[self.name] = self
+    end
+
+    # Creates a new instance and calls #track with the given id
+    # @param id The package identifier
+    # @return Either a Trackerific::Details or Trackerific::Error
+    def track(id)
+      new.track(id)
+    end
+
+    # Reads the credentials from Trackerific.config
+    # @return [Hash] The service's credentials
+    def credentials
+      Trackerific.config[name]
+    end
+
+    # Checks if the given package ID can be tracked by this service
+    # @param [String] id The package ID
+    # @return [Boolean] true when this service can track the given ID
+    # @note This will always be false if no credentials were found for the
+    # service in Trackerific.config
+    def can_track?(id)
+      return false if credentials.nil?
+      package_id_matchers.each {|m| return true if id =~ m }
+      false
+    end
+
+    # An Array of Regexp that matches valid package ids for the service
+    # @api semipublic
+    def package_id_matchers
+      config.package_id_matchers
+    end
+  end
+
+  def initialize(credentials=self.class.credentials)
+    @credentials = credentials
+
+    if credentials.nil?
+      raise Trackerific::Error,
+        "Missing credentials for #{self.class.name}", caller
     end
   end
+
+  def config
+    self.class.config
+  end
+
+  def track(id)
+    result = config.parser.new(id, request(id)).parse
+    result.is_a?(Trackerific::Error) ? raise(result) : result
+  end
+
+  protected
+
+  def builder(id)
+    members = config.builder.members - [:package_id]
+    credentials = @credentials.values_at(*members)
+    credentials << id
+    config.builder.new(*credentials)
+  end
 end