trackerific 0.7.2 → 0.7.3

data/lib/trackerific/services/concerns/soap.rb

@@ -1,45 +1,15 @@
-module Trackerific
-  module Services
-    module Concerns
-      module SOAP
-        extend ActiveSupport::Concern
+module Trackerific::Services::Concerns::SOAP
+  extend ActiveSupport::Concern
 
-        included do
-          @soap_track_operation = :track
-          @soap_builder = nil
-          @soap_parser = nil
-          @soap_wsdl = ""
-        end
+  protected
 
-        module ClassMethods
-          attr_accessor :soap_track_operation
-          attr_accessor :soap_builder
-          attr_accessor :soap_parser
-          attr_accessor :soap_wsdl
-        end
-
-        def track(id)
-          operation = self.class.soap_track_operation
-          request = client.call(operation, message: builder(id).hash)
-          response = self.class.soap_parser.new(id, request).parse
-          response.is_a?(Trackerific::Error) ? raise(response) : response
-        end
-
-        protected
-
-        def builder(id)
-          members = self.class.soap_builder.members - [:package_id]
-          credentials = @credentials.values_at(*members)
-          credentials << id
-          self.class.soap_builder.new(*credentials)
-        end
+  def request(id)
+    client.call(config.track_operation, message: builder(id).hash)
+  end
 
-        def client
-          @client ||= Savon.client(
-            convert_request_keys_to: :camelcase,
-            wsdl: Trackerific::SOAP::WSDL.path(self.class.soap_wsdl))
-        end
-      end
-    end
+  def client
+    @client ||= Savon.client(
+      convert_request_keys_to: :camelcase,
+      wsdl: Trackerific::SOAP::WSDL.path(config.wsdl))
   end
 end

data/lib/trackerific/services/concerns/xml.rb

@@ -1,44 +1,22 @@
-module Trackerific
-  module Services
-    module Concerns
-      module XML
-        extend ActiveSupport::Concern
+module Trackerific::Services::Concerns::XML
+  extend ActiveSupport::Concern
 
-        included do
-          @xml_endpoint = ""
-          @xml_parser = nil
-          @xml_builder = nil
-        end
+  included do
+    include HTTParty
 
-        module ClassMethods
-          attr_accessor :xml_endpoint
-          attr_accessor :xml_parser
-          attr_accessor :xml_builder
-        end
-
-        # Gets the tracking information for the package from the server
-        # @param [String] id The package identifier
-        # @return [Trackerific::Details] The tracking details
-        # @api semipublic
-        def track(id)
-          response = self.class.xml_parser.new(id, http_response(id)).parse
-          raise(response) if response.is_a?(Trackerific::Error)
-          return response
-        end
+    format :xml
+  end
 
-        protected
+  module ClassMethods
+    def configure(&block)
+      super
+      base_uri(config.base_uri)
+    end
+  end
 
-        def http_response(id)
-          self.class.post(self.class.xml_endpoint, body: builder(id).xml)
-        end
+  protected
 
-        def builder(id)
-          members = self.class.xml_builder.members - [:package_id]
-          credentials = @credentials.values_at(*members)
-          credentials << id
-          self.class.xml_builder.new(*credentials)
-        end
-      end
-    end
+  def request(id)
+    self.class.post(config.endpoint, body: builder(id).xml)
   end
 end

data/lib/trackerific/services/fedex.rb

@@ -1,21 +1,11 @@
-module Trackerific
-  module Services
-    class FedEx < Base
-      require 'trackerific/builders/fedex'
-      require 'trackerific/parsers/fedex'
-
-      include Concerns::SOAP
-
-      register :fedex
-
-      self.soap_track_operation = :track
-      self.soap_builder = Builders::FedEx
-      self.soap_parser = Parsers::FedEx
-      self.soap_wsdl = 'fedex/TrackService_v8'
-
-      def self.package_id_matchers
-        [ /^[0-9]{15}$/ ]
-      end
-    end
+class Trackerific::Services::FedEx < Trackerific::Services::Base
+  register :fedex, as: :SOAP
+
+  configure do |config|
+    config.track_operation = :track
+    config.builder = Trackerific::Builders::FedEx
+    config.parser = Trackerific::Parsers::FedEx
+    config.wsdl = 'fedex/TrackService_v8'
+    config.package_id_matchers = [ /^[0-9]{15}$/ ]
   end
 end

data/lib/trackerific/services/mock_service.rb

@@ -1,44 +1,33 @@
-module Trackerific
-  module Services
-     # Provides a mock service for using in test and development
-    class MockService < Base
-      require 'date'
+# Provides a mock service for using in test and development
+class Trackerific::Services::MockService < Trackerific::Services::Base
+  require 'date'
 
-      self.register :mock_service
+  register :mock_service
 
-      def self.credentials
-        {}
-      end
+  configure do |config|
+    config.package_id_matchers = [ /XXXXXXXXXX/, /XXXxxxxxxx/ ]
+  end
+
+  def self.credentials
+    {}
+  end
+
+  def track(id)
+    if id == "XXXXXXXXXX"
+      Trackerific::Details.new(id, "Your package was delivered.", events)
+    else
+      raise Trackerific::Error, "Package not found."
+    end
+  end
 
-      def self.package_id_matchers
-        [ /XXXXXXXXXX/, /XXXxxxxxxx/ ]
-      end
+  private
 
-      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
+  def events
+    [ [Date.today, "Package delivered.", "SANTA MARIA, CA"],
+      [Date.today - 1, "Package scanned.", "SANTA BARBARA, CA"],
+      [Date.today - 2, "Package picked up for delivery.", "LOS ANGELES, CA"]
+    ].map do |event|
+      Trackerific::Event.new(*event)
     end
   end
 end

data/lib/trackerific/services/ups.rb

@@ -1,27 +1,14 @@
-module Trackerific
-  module Services
-    class UPS < Base
-      require 'trackerific/builders/ups'
-      require 'trackerific/parsers/ups'
-
-      include Concerns::XML, HTTParty
-
-      register :ups
-
-      self.xml_endpoint = '/Track'
-      self.xml_parser = Parsers::UPS
-      self.xml_builder = Builders::UPS
-
-      format :xml
-
-      base_uri case Trackerific.env
-      when 'production' then 'https://www.ups.com/ups.app/xml'
-      else 'https://wwwcie.ups.com/ups.app/xml'
-      end
-
-      def self.package_id_matchers
-        [ /^.Z/, /^[HK].{10}$/ ]
-      end
+class Trackerific::Services::UPS < Trackerific::Services::Base
+  register :ups, as: :XML
+
+  configure do |config|
+    config.endpoint = '/Track'
+    config.parser = Trackerific::Parsers::UPS
+    config.builder = Trackerific::Builders::UPS
+    config.package_id_matchers = [ /^.Z/, /^[HK].{10}$/ ]
+    config.base_uri = case Trackerific.env
+    when 'production' then 'https://www.ups.com/ups.app/xml'
+    else 'https://wwwcie.ups.com/ups.app/xml'
     end
   end
 end

data/lib/trackerific/services/usps.rb

@@ -1,40 +1,28 @@
-module Trackerific
-  module Services
-    class USPS < Base
-      require 'trackerific/builders/usps'
-      require 'trackerific/parsers/usps'
-
-      include Concerns::XML, HTTParty
-
-      register :usps
-
-      self.xml_parser = Parsers::USPS
-      self.xml_builder = Builders::USPS
-
-      case Trackerific.env
-      when 'production'
-        self.xml_endpoint = '/ShippingAPI.dll'
-        base_uri 'http://production.shippingapis.com'
-      else
-        self.xml_endpoint = '/ShippingAPITest.dll'
-        base_uri 'http://testing.shippingapis.com'
-      end
-
-      format :xml
-
-      def self.package_id_matchers
-        [ /^E\D{1}\d{9}\D{2}$|^9\d{15,21}$/ ]
-      end
+class Trackerific::Services::USPS < Trackerific::Services::Base
+  register :usps, as: :XML
+
+  configure do |config|
+    config.parser = Trackerific::Parsers::USPS
+    config.builder = Trackerific::Builders::USPS
+    config.package_id_matchers = [ /^E\D{1}\d{9}\D{2}$|^9\d{15,21}$/ ]
+
+    case Trackerific.env
+    when 'production'
+      config.endpoint = '/ShippingAPI.dll'
+      config.base_uri = 'http://production.shippingapis.com'
+    else
+      config.endpoint = '/ShippingAPITest.dll'
+      config.base_uri = 'http://testing.shippingapis.com'
+    end
+  end
 
-      protected
+  protected
 
-      def http_response(id)
-        http_response = self.class.get(self.class.xml_endpoint, http_query(id))
-      end
+  def request(id)
+    self.class.get(config.endpoint, http_query(id))
+  end
 
-      def http_query(id)
-        { query: { :API => 'TrackV2', :XML => builder(id).xml }.to_query }
-      end
-    end
+  def http_query(id)
+    { query: { :API => 'TrackV2', :XML => builder(id).xml }.to_query }
   end
 end

data/lib/trackerific/soap.rb

@@ -0,0 +1,5 @@
+module Trackerific
+  module SOAP
+    require 'trackerific/soap/wsdl'
+  end
+end

data/lib/trackerific/soap/wsdl.rb

@@ -1,17 +1,13 @@
-module Trackerific
-  module SOAP
-    module WSDL
-      ROOT = File.expand_path("../../../../vendor/wsdl", __FILE__)
+module Trackerific::SOAP::WSDL
+  ROOT = File.expand_path("../../../../vendor/wsdl", __FILE__)
 
-      def self.path(name)
-        path = File.join(ROOT, "#{name}.wsdl")
+  def self.path(name)
+    path = File.join(ROOT, "#{name}.wsdl")
 
-        unless File.exists?(path)
-          raise IOError, "WSDL not found #{name}", caller
-        end
-
-        path
-      end
+    unless File.exists?(path)
+      raise IOError, "WSDL not found #{name}", caller
     end
+
+    path
   end
 end

data/lib/trackerific/version.rb

@@ -1,3 +1,3 @@
 module Trackerific
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

data/spec/lib/trackerific/services/base_spec.rb

@@ -11,6 +11,18 @@ describe Trackerific::Services::Base do
     end
   end
 
+  describe "#configure" do
+    it "should set @config properties passed from the given block" do
+      TestService.configure {|c| c.value = 'this' }
+      TestService.config.value.should eq 'this'
+    end
+  end
+
+  describe "#config" do
+    subject { TestService.new.config }
+    it { should eq TestService.config }
+  end
+
   describe "#track" do
     it "should create a new instance and call #track with the given id" do
       TestService.any_instance.should_receive(:track).with('ID')
@@ -51,11 +63,16 @@ describe Trackerific::Services::Base do
   end
 
   describe "#package_id_matchers" do
-    it "should raise a NotImplementedError when not overridden" do
-      expect {
-        Trackerific::Services::Base.package_id_matchers
-      }.to raise_error NotImplementedError
+    let(:matchers) { ['these','matchers'] }
+
+    before do
+      Trackerific::Services::Base.configure do |config|
+        config.package_id_matchers = matchers
+      end
     end
+
+    subject { Trackerific::Services::Base.package_id_matchers }
+    it { should eq matchers }
   end
 
   context "when creating a new instance without credentials" do

data/spec/lib/trackerific/services/concerns/soap_spec.rb

@@ -1,25 +1,8 @@
 require 'spec_helper'
 
 describe Trackerific::Services::Concerns::SOAP do
-  class TestConcernsSOAP
-    include Trackerific::Services::Concerns::SOAP
-
-    def initialize
-      @credentials = { user_id: 'USER ID' }
-    end
-  end
-
   subject { TestConcernsSOAP }
 
-  it { should respond_to :soap_track_operation }
-  it { should respond_to :soap_track_operation= }
-  it { should respond_to :soap_builder }
-  it { should respond_to :soap_builder= }
-  it { should respond_to :soap_parser }
-  it { should respond_to :soap_parser= }
-  it { should respond_to :soap_wsdl }
-  it { should respond_to :soap_wsdl= }
-
   describe "#track" do
     let(:track_operation) { double(:track_operation) }
     let(:package_id) { "PACKAGE ID" }
@@ -38,10 +21,12 @@ describe Trackerific::Services::Concerns::SOAP do
     let(:soap_request) { double(:soap_request) }
 
     before do
-      TestConcernsSOAP.stub(:soap_track_operation).and_return(track_operation)
-      TestConcernsSOAP.stub(:soap_wsdl).and_return(wsdl)
-      TestConcernsSOAP.stub(:soap_builder).and_return(builder)
-      TestConcernsSOAP.stub(:soap_parser).and_return(parser)
+      TestConcernsSOAP.configure do |config|
+        config.track_operation = track_operation
+        config.wsdl = wsdl
+        config.builder = builder
+        config.parser = parser
+      end
 
       builder.stub(:members).and_return([:user_id, :package_id])
       builder.should_receive(:new).with("USER ID", package_id).and_return(builder_instance)