trackerific 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1310f1dbf143518a58178390a664b23b697cadba
-  data.tar.gz: 709ab9cdaa8df43975eff61b797b98586fab4e34
+  metadata.gz: fb9a2f038fb1728c6dd60128d782e5fae4d89d85
+  data.tar.gz: 43fd9368b5d08f8f7f75307ba579ac2734b615b1
 SHA512:
-  metadata.gz: b398a2bfaab2602d8cb0624d48f7936750abb13bdfb36828a27cd4ec1f4b0a5a0763996de30edf2aa38a4270fecb31e5158a77a2d242542a3c3be6d1094b0158
-  data.tar.gz: dfe45ddfe2c76098a2e9b6c917f6b825fb91d993f92236f9b5b28595f539b48b13d758bae1dbe1fd6ede6928ea202b95638d010ac0cf6e5b06ef81e930781ded
+  metadata.gz: 001ff6e68f9078c5241368d5910f1225fba1c51cfea39d19a150eb0a715cce9e709a2474f954b66e9d21dc5d29568ccd7236a5932ba25e686e1b66ea60caee8b
+  data.tar.gz: 0ea9be6f1b79664e963534e3e542b87a9f5c50407df442867ebf251dbb19c7e21cd965b75a7bf11c679733a1641bde1b8087e7f3db286caa810d2deb1c26f251

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trackerific (0.7.2)
+    trackerific (0.7.3)
       activesupport
       builder (>= 3.1.4)
       httparty (>= 0.12.0)

data/README.rdoc

@@ -33,7 +33,8 @@ You will need to configure the credentials for each service you're utilizing.
 Services without credentials will not be accessed by the gem.
 
   Trackerific.configure do |config|
-    config.fedex  = { account: 'account', meter: '123456789' }
+    config.fedex  = { key: 'key', password: 'password', account_number: 'acct',
+                      meter_number: '123' }
     config.ups    = { key: 'key', user_id: 'userid', password: 'secret' }
     config.usps   = { user_id: 'userid' }
   end

data/lib/dependencies.rb

@@ -0,0 +1,9 @@
+# 3rd party gems and dependencies
+
+require 'active_support/all'
+require 'securerandom'
+require 'date'
+require 'savon'
+require 'httparty'
+require 'builder'
+require 'ostruct'

data/lib/trackerific.rb

@@ -1,28 +1,14 @@
-require 'active_support'
-require 'active_support/core_ext/object/to_query'
-require 'securerandom'
-require 'date'
-require 'savon'
-require 'httparty'
-require 'builder'
+require 'dependencies'
+
 require 'trackerific/version'
 require 'trackerific/environment'
 require 'trackerific/error'
 require 'trackerific/details'
 require 'trackerific/event'
-require 'trackerific/soap/wsdl'
-require 'trackerific/builders/base/soap'
-require 'trackerific/builders/base/xml'
-require 'trackerific/parsers/base'
-require 'trackerific/services/concerns/soap'
-require 'trackerific/services/concerns/xml'
+require 'trackerific/soap'
+require 'trackerific/builders'
+require 'trackerific/parsers'
 require 'trackerific/services'
-require 'trackerific/services/base'
-
-# add tracking services here
-require 'trackerific/services/fedex'
-require 'trackerific/services/ups'
-require 'trackerific/services/usps'
 
 module Trackerific
   include ActiveSupport::Configurable

data/lib/trackerific/builders.rb

@@ -0,0 +1,12 @@
+module Trackerific
+  module Builders
+    module Base
+      require 'trackerific/builders/base/soap'
+      require 'trackerific/builders/base/xml'
+    end
+
+    require 'trackerific/builders/fedex'
+    require 'trackerific/builders/ups'
+    require 'trackerific/builders/usps'
+  end
+end

data/lib/trackerific/builders/base/soap.rb

@@ -1,21 +1,19 @@
-module Trackerific
-  module Builders
-    module Base
-      class SOAP < Struct
-        attr_reader :hash
+# Base class for SOAP request builders
+# @api public
+class Trackerific::Builders::Base::SOAP < Struct
+  attr_reader :hash
 
-        def initialize(*args)
-          super(*args)
-          @hash = build
-        end
+  def initialize(*args)
+    super(*args)
+    @hash = build
+  end
 
-        protected
+  protected
 
-        def build
-          raise NotImplementedError,
-            "Implement this method in your builder subclass", caller
-        end
-      end
-    end
+  # Implement this method in your builder
+  # @api public
+  def build
+    raise NotImplementedError,
+      "Implement this method in your builder subclass", caller
   end
 end

data/lib/trackerific/builders/base/xml.rb

@@ -1,38 +1,32 @@
-module Trackerific
-  module Builders
-    module Base
-      class XML < Struct
-        @xml_version = "1.0"
+class Trackerific::Builders::Base::XML < Struct
+  @xml_version = "1.0"
 
-        class << self
-          attr_accessor :xml_version
-        end
+  class << self
+    attr_accessor :xml_version
+  end
 
-        attr_reader :xml
+  attr_reader :xml
 
-        def initialize(*args)
-          super(*args)
-          @xml = ""
-          build
-        end
+  def initialize(*args)
+    super(*args)
+    @xml = ""
+    build
+  end
 
-        protected
+  protected
 
-        def build
-          raise NotImplementedError,
-            "Implement this method in your builder subclass", caller
-        end
+  def build
+    raise NotImplementedError,
+      "Implement this method in your builder subclass", caller
+  end
 
-        private
+  private
 
-        def builder
-          @builder ||= begin
-            builder = Builder::XmlMarkup.new(target: @xml)
-            builder.instruct! :xml, version: self.class.xml_version
-            builder
-          end
-        end
-      end
+  def builder
+    @builder ||= begin
+      builder = Builder::XmlMarkup.new(target: @xml)
+      builder.instruct! :xml, version: self.class.xml_version
+      builder
     end
   end
 end

data/lib/trackerific/builders/fedex.rb

@@ -1,46 +1,68 @@
-module Trackerific
-  module Builders
-    class FedEx < Base::SOAP.new(:key, :password, :account_number, :meter_number, :package_id)
-      protected
-
-      def build
-        root_elements.inject({}) {|r, k| r[k] = send(k); r }
-      end
-
-      private
-
-      def root_elements
-        [ :web_authentication_detail, :client_detail, :transaction_detail,
-          :version, :selection_details, :processing_options ]
-      end
-
-      def web_authentication_detail
-        { user_credential: { key: key, password: password } }
-      end
-
-      def client_detail
-        { account_number: account_number, meter_number: meter_number }
-      end
-
-      def transaction_detail
-        { customer_transaction_id: "Trackerific" }
-      end
-
-      def version
-        { service_id: 'trck', major: '8', intermediate: '0', minor: '0' }
-      end
-
-      def selection_details
-        { carrier_code: 'FDXE', package_identifier: package_identifier }
-      end
-
-      def package_identifier
-        { type: 'TRACKING_NUMBER_OR_DOORTAG', value: package_id }
-      end
-
-      def processing_options
-        'INCLUDE_DETAILED_SCANS'
-      end
-    end
+class Trackerific::Builders::FedEx < Trackerific::Builders::Base::SOAP.new(
+  :key, :password, :account_number, :meter_number, :package_id)
+
+  protected
+
+  # Builds the FedEx track request XML
+  # @api private
+  def build
+    root_nodes.inject({}) {|r, k| r[k] = send(k); r }
+  end
+
+  private
+
+  # Array of XML root nodes
+  # @api private
+  def root_nodes
+    [ :web_authentication_detail, :client_detail, :transaction_detail,
+      :version, :selection_details, :processing_options ]
+  end
+
+  # Descriptive data to be used in authentication of the sender's identity
+  # (and right to use FedEx web services)
+  # @api private
+  def web_authentication_detail
+    { user_credential: { key: key, password: password } }
+  end
+
+  # Descriptive data identifying the client submitting the transaction
+  # @api private
+  def client_detail
+    { account_number: account_number, meter_number: meter_number }
+  end
+
+  # Contains a free form field that is echoed back in the reply to match
+  # requests with replies and data that governs the data payload
+  # language/translations
+  # @api private
+  def transaction_detail
+    { customer_transaction_id: "Trackerific" }
+  end
+
+
+  # The version of the FedEx API being used
+  # @api private
+  def version
+    { service_id: 'trck', major: '8', intermediate: '0', minor: '0' }
+  end
+
+  # Specifies the details needed to select the shipment being requested to
+  # be tracked
+  # @api private
+  def selection_details
+    { carrier_code: 'FDXE', package_identifier: package_identifier }
+  end
+
+  # The type and value of the package identifier that is to be used to
+  # retrieve the tracking information for a package or group of packages
+  # @api private
+  def package_identifier
+    { type: 'TRACKING_NUMBER_OR_DOORTAG', value: package_id }
+  end
+
+  # Include detailed scan results
+  # @api private
+  def processing_options
+    'INCLUDE_DETAILED_SCANS'
   end
 end

data/lib/trackerific/builders/ups.rb

@@ -1,32 +1,36 @@
-module Trackerific
-  module Builders
-    class UPS < Base::XML.new(:key, :user_id, :password, :package_id)
-      protected
+class Trackerific::Builders::UPS < Trackerific::Builders::Base::XML.new(
+  :key, :user_id, :password, :package_id)
 
-      def build
-        add_access_request
-        add_track_request
-      end
+  protected
 
-      private
+  # Builds the UPS track request XML
+  # @api private
+  def build
+    add_access_request
+    add_track_request
+  end
 
-      def add_access_request
-        builder.AccessRequest do |ar|
-          ar.AccessLicenseNumber key
-          ar.UserId user_id
-          ar.Password password
-        end
-      end
+  private
+
+  # Adds the user credentials to the XML
+  # @api private
+  def add_access_request
+    builder.AccessRequest do |ar|
+      ar.AccessLicenseNumber key
+      ar.UserId user_id
+      ar.Password password
+    end
+  end
 
-      def add_track_request
-        builder.TrackRequest do |tr|
-          tr.Request do |r|
-            r.RequestAction 'Track'
-            r.RequestOption 'activity'
-          end
-          tr.TrackingNumber package_id
-        end
+  # Adds the track request and package id to the XML
+  # @api private
+  def add_track_request
+    builder.TrackRequest do |tr|
+      tr.Request do |r|
+        r.RequestAction 'Track'
+        r.RequestOption 'activity'
       end
+      tr.TrackingNumber package_id
     end
   end
 end

data/lib/trackerific/builders/usps.rb

@@ -1,19 +1,21 @@
-module Trackerific
-  module Builders
-    class USPS < Base::XML.new(:user_id, :package_id)
-      protected
+class Trackerific::Builders::USPS < Trackerific::Builders::Base::XML.new(
+  :user_id, :package_id)
 
-      def build
-        add_track_request
-      end
+  protected
 
-      private
+  # Builds the USPS track request XML
+  # @api private
+  def build
+    add_track_request
+  end
+
+  private
 
-      def add_track_request
-        builder.TrackRequest(:USERID => user_id) do |t|
-          t.TrackID(:ID => package_id)
-        end
-      end
+  # Adds the track request and package id to the XML
+  # @api private
+  def add_track_request
+    builder.TrackRequest(:USERID => user_id) do |t|
+      t.TrackID(:ID => package_id)
     end
   end
 end

data/lib/trackerific/parsers.rb

@@ -0,0 +1,8 @@
+module Trackerific
+  module Parsers
+    require 'trackerific/parsers/base'
+    require 'trackerific/parsers/fedex'
+    require 'trackerific/parsers/ups'
+    require 'trackerific/parsers/usps'
+  end
+end

data/lib/trackerific/parsers/base.rb

@@ -1,35 +1,31 @@
-module Trackerific
-  module Parsers
-    class Base
-      def initialize(package_id, response)
-        @package_id = package_id
-        @response = response
-      end
+class Trackerific::Parsers::Base
+  def initialize(package_id, response)
+    @package_id = package_id
+    @response = response
+  end
 
-      def parse
-        @result ||= if response_error
-          response_error
-        else
-          Trackerific::Details.new(@package_id, summary, events)
-        end
-      end
+  def parse
+    @result ||= if response_error
+      response_error
+    else
+      Trackerific::Details.new(@package_id, summary, events)
+    end
+  end
 
-      protected
+  protected
 
-      def response_error
-        raise NotImplementedError,
-          "Override this method in your parser", caller
-      end
+  def response_error
+    raise NotImplementedError,
+      "Override this method in your parser", caller
+  end
 
-      def summary
-        raise NotImplementedError,
-          "Override this method in your parser", caller
-      end
+  def summary
+    raise NotImplementedError,
+      "Override this method in your parser", caller
+  end
 
-      def events
-        raise NotImplementedError,
-          "Override this method in your parser", caller
-      end
-    end
+  def events
+    raise NotImplementedError,
+      "Override this method in your parser", caller
   end
 end