Class: Trackerific::Base

Inherits:

Object

• Object
• Trackerific::Base

show all

Defined in:

lib/trackerific/base.rb

Overview

Class Method Summary (collapse)

• + (Array, Regexp) package_id_matchers

  An Array of Regexp that matches valid package identifiers for your service.

• + (Array) required_options

  An array of options that are required to create a new instance of this class.

Instance Method Summary (collapse)

• - (Base) initialize(options = {}) constructor Private

  Creates a new instance of Trackerific::Base with required options.

• - (Trackerific::Details) track_package(package_id)

  Gets the tracking information for the package from the server.

6
7
8
9
10
11
12
13
14
15
16
17

# File 'lib/trackerific/base.rb', line 6

def initialize(options = {})
  required = self.class.required_options
  # make sure all the required options exist
  required.each do |k|
    raise ArgumentError.new("Missing required parameter: #{k}") unless options.has_key?(k)
  end
  # make sure no invalid options exist
  options.each do |k, v|
    raise ArgumentError.new("Invalid parameter: #{k}") unless required.include?(k)
  end
  @options = options
end

module Trackerific
  class MyTrackingService < Base
    def self.package_id_matchers
      [ /^.Z/, /^[HK].{10}$/ ]  # matchers for UPS package identifiers
    end
  end
end

50
51
52

# File 'lib/trackerific/base.rb', line 50

def self.package_id_matchers
  nil
end

module Trackerific
  class MyTrackingService < Base
    def self.required_options
      [:all, :these, :are, :required]
    end
  end
end

65
66
67

# File 'lib/trackerific/base.rb', line 65

def self.required_options
  []
end

module Trackerific
  class MyTrackingService < Base
    def track_package
      # your tracking code here
      Trackerific::Details.new(
        "summary of tracking events",
        [Trackerific::Event.new(Time.now, "summary", "location")]
      )
    end
  end
end

35
36
37

# File 'lib/trackerific/base.rb', line 35

def track_package(package_id)
  @package_id = package_id
end