has_tracking 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+test/*.log
+test/*.db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,17 @@
+HasTracking
+===========
+
+Package tracking for Posten / Bring (Norway), might implement other solutions later.
+
+Example
+=======
+
+Add the has\_tracking to your model (if the field containing the tracking number is not named "tracking\_number" you can supply your own field with the :tracking\_number option).
+<class Package < ActiveRecord::Base
+  has_tracking :tracking_number => "number">
+
+<@package.track.details> will now get you the packages weight (in kg), volume (in cm3) and the height, lenght and width (in cm).
+<@package.track.received?> will return true or false if package has arrived at its destination
+<@package.track.events> returns an array of the shipment route so far
+
+Copyright (c) 2009 Erlend Finvåg, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_tracking plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_tracking plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasTracking'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "has_tracking"
+    gemspec.summary = "Package tracking for Bring"
+    gemspec.description = "Adds quick and dirty package tracking for Bring (Posten Norway)"
+    gemspec.email = "erlend.finvag@gmail.com"
+    gemspec.homepage = "http://github.com/zircon/has_tracking"
+    gemspec.authors = ["Erlend Finvåg"]
+    gemspec.has_rdoc = false
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/has_tracking.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_tracking}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Erlend Finv\303\245g"]
+  s.date = %q{2009-11-30}
+  s.description = %q{Adds quick and dirty package tracking for Bring (Posten Norway)}
+  s.email = %q{erlend.finvag@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "has_tracking.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/has_tracking.rb",
+     "tasks/has_tracking_tasks.rake",
+     "test/database.yml",
+     "test/has_tracking_test.rb",
+     "test/schema.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/zircon/has_tracking}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Package tracking for Bring}
+  s.test_files = [
+    "test/has_tracking_test.rb",
+     "test/schema.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+require "has_tracking"
+require "json"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/has_tracking.rb

@@ -0,0 +1,68 @@
+module HasTracking
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def has_tracking(options = {})
+      cattr_accessor :tracking_number
+      self.tracking_number = (options[:tracking_number] || :tracking_number).to_s
+      send :include, InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    def track
+      return Track.new(read_attribute(self.class.tracking_number))
+    end
+  end
+end
+
+class Track
+  def initialize(number)
+    begin
+      require "open-uri"
+      buffer = open("http://sporing.bring.no/sporing.json?q=#{number}").read
+      @result = JSON.parse(buffer)["consignmentSet"][0]["packageSet"][0]
+    rescue OpenURI::HTTPError
+      return false
+    end
+  end
+  
+  def received?
+    begin
+      if self.events.last["postalcode"].blank?
+        return true
+      else
+        return false
+      end
+    rescue
+      return false
+    end
+  end
+  
+  def events
+    events = []
+    for event in @result["eventSet"]
+      e = {}
+      e["city"] = event["city"]
+      e["postalcode"] = event["postalCode"]
+      e["date"] = DateTime.parse(event["dateIso"])
+      e["description"] = event["description"]
+      events << e
+    end
+    return events.reverse!
+  end
+  
+  def details
+    details = {}
+    details["weight"] = @result["weightInKgs"]
+    details["length"] = @result["lengthInCm"]
+    details["height"] = @result["heightInCm"]
+    details["width"] = @result["widthInCm"]
+    details["volume"] = @result["volumeInDm3"]
+    return details
+  end
+end
+
+ActiveRecord::Base.send :include, HasTracking

data/tasks/has_tracking_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_tracking do
+#   # Task goes here
+# end

data/test/database.yml

@@ -0,0 +1,7 @@
+sqlite:
+  :adapter: sqlite
+  :database: vendor/plugins/has_tracking/test/has_tracking_plugin.sqlite.db
+
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/has_tracking/test/has_tracking_plugin.sqlite3.db

data/test/has_tracking_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class HasTrackingTest < Test::Unit::TestCase
+  load_schema
+  
+  class Package < ActiveRecord::Base
+    has_tracking :tracking_number => :number
+  end
+    
+  def test_tracking_should_get_package_details
+    @tracking = Package.first.track
+    assert_equal 0.9, @tracking.details["weight"]
+    assert_equal 26, @tracking.details["length"]
+    assert_equal 18, @tracking.details["height"]
+    assert_equal 25, @tracking.details["width"]
+    assert_equal 11.7, @tracking.details["volume"]
+  end
+  
+  def test_tracking_should_get_package_events
+    @tracking = Package.first.track
+    assert_equal 4, @tracking.events.length
+    assert_equal "OSLO", @tracking.events.first["city"]
+    assert_equal "0024", @tracking.events.first["postalcode"]
+    assert_equal DateTime, @tracking.events.first["date"].class
+    assert_not_equal nil, @tracking.events.first["description"]
+  end
+  
+  def test_tracking_should_get_package_received
+    assert_equal true, Package.first.track.received?
+  end
+end

data/test/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :packages, :force => true do |t|
+    t.string :number
+  end
+  
+  Package.create(:number => "CH140585246NO")
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+#  require File.dirname(__FILE__) + '/../rails/init.rb'
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: has_tracking
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Erlend Finv\xC3\xA5g"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-30 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Adds quick and dirty package tracking for Bring (Posten Norway)
+email: erlend.finvag@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- has_tracking.gemspec
+- init.rb
+- install.rb
+- lib/has_tracking.rb
+- tasks/has_tracking_tasks.rake
+- test/database.yml
+- test/has_tracking_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/zircon/has_tracking
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Package tracking for Bring
+test_files: 
+- test/has_tracking_test.rb
+- test/schema.rb
+- test/test_helper.rb