Class: Trackerific::Service

Inherits:

Object

• Object
• Trackerific::Service

show all

Includes:

OptionsHelper

Defined in:

lib/trackerific/service.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)

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

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

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

  Gets the tracking information for the package from the server.

Methods included from OptionsHelper

#validate_options

8
9
10
11

# File 'lib/trackerific/service.rb', line 8

def initialize(options = {})
  validate_options options, self.class.required_options
  @options = options
end

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

46
47
48

# File 'lib/trackerific/service.rb', line 46

def package_id_matchers
  nil
end

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

61
62
63

# File 'lib/trackerific/service.rb', line 61

def required_options
  []
end

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

29
30
31

# File 'lib/trackerific/service.rb', line 29

def track_package(package_id)
  @package_id = package_id
end