royal_mail_scraper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f34da7f0b92b97623f600d4658ed8507f3b67c9
+  data.tar.gz: 0db41cda4ecd1213132d0ceb6611447859275d13
+SHA512:
+  metadata.gz: 3ef7758c075bc74a6b7ae8ccaba8138f7ce2c631f37b1f7ef91441494effe5eb2407a48b441130df69acbd694270bcc06a73f806f103446280e91a09a9b6c58f
+  data.tar.gz: a42572c88d4fc72279051e776ff278af118bb1a2f60ebd2b37eda1d90c7f5bcd728f374806c1b17ec814677af23347fd334a417f640c58d3ad236b0d9ba004c9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx-2.2
+  - jruby-19mode
+script: "bundle exec rake spec"
+

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in royal_mail.gemspec
+gemspec
+
+gem 'nokogiri', '~> 1.5'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-its'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Laurynas Butkus
+
+MIT License
+
+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.md

@@ -0,0 +1,42 @@
+# RoyalMailScraper
+
+[![Build Status](https://secure.travis-ci.org/laurynas/royal_mail_scraper.png)](http://travis-ci.org/laurynas/royal_mail_scraper)
+
+A simple page scraper for Royal Mail Track and Trace.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'royal_mail_scraper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install royal_mail_scraper
+
+## Usage
+
+    tracker = RoyalMailScraper::Tracker.fetch('TRACKING_CODE')
+
+    p tracker.status
+    p tracker.message
+    p tracker.details
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+This GEM is originally inspired by 
+[PHP-Royal-Mail-Track-and-Trace](https://github.com/roldershaw/PHP-Royal-Mail-Track-and-Trace) script.
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/royal_mail_scraper/tracker/detail.rb

@@ -0,0 +1,12 @@
+module RoyalMailScraper
+  class Tracker::Detail
+    attr_reader :datetime, :message, :location, :status
+
+    def initialize(datetime, message, location)
+      @datetime = datetime
+      @message = message
+      @location = location
+      @status = Tracker::StatusMap.resolve(message)
+    end
+  end
+end

data/lib/royal_mail_scraper/tracker/request.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+module RoyalMailScraper
+  class Tracker::Request < Struct.new(:tracking_number)
+    REQUEST_URI = URI('http://www.royalmail.com/trackdetails')
+    TIMEOUT = 10
+
+    def execute
+      params = { tracking_number: tracking_number }
+
+      req = Net::HTTP::Post.new(REQUEST_URI.request_uri)
+      req.form_data = params
+
+      http = Net::HTTP.new(REQUEST_URI.host, REQUEST_URI.port)
+      http.open_timeout = TIMEOUT
+      http.read_timeout = TIMEOUT
+
+      res = http.request(req)
+
+      Tracker::Response.new(res.body)
+    end
+  end
+end

data/lib/royal_mail_scraper/tracker/response.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+
+module RoyalMailScraper
+  class Tracker::Response
+    attr_reader :html
+
+    DETAILS_PATH = '//*[@id="bt-tracked-track-trace-form"]/div/div/div/div[1]/table/tbody/tr'
+    ERROR_PATH = '//*[@id="bt-tracked-track-trace-form"]/div/div/div/div[1]/div[5]/text()'
+
+    TIME_FORMAT = '%d/%m/%y %H:%M'
+
+    def initialize(body)
+      @html = Nokogiri::HTML(body)
+    end
+
+    def tracker
+      Tracker.new(tracking_number, details.reverse)
+    end
+
+    private
+
+    def tracking_number
+      el = @html.at('input[@name="tracking_number"]')
+      el ? el.attr(:value).to_s.strip : nil
+    end
+
+    def details
+      html.xpath(DETAILS_PATH).map do |tr|
+        date, time, message, location = tr.css('td').map(&:content).map(&:strip)
+        time = '00:00' unless time =~ /\A\d+:\d+\z/
+        datetime = DateTime.strptime([date, time].join(' '), TIME_FORMAT) rescue DateTime.new
+        Tracker::Detail.new(datetime, message, location)
+      end
+    end
+  end
+end

data/lib/royal_mail_scraper/tracker/status_map.rb

@@ -0,0 +1,27 @@
+module RoyalMailScraper
+  class Tracker::StatusMap
+    UNRECOGNISED = 'unrecognised'
+    IN_TRANSIT = 'in_transit'
+    ON_DELIVERY = 'on_delivery'
+    UNDELIVERED = 'undelivered'
+    HELD_AT_ENQUIRY_OFFICE = 'held_at_enquiry_office'
+    DELIVERED = 'delivered'
+
+    def self.resolve(message)
+      case message
+      when /^(ACCEPTED|RECEIVED|DESPATCHABLE|DESPATCHED|COLLECTED|ARRIVED)/
+        IN_TRANSIT
+      when /^ON DELIVERY/
+        ON_DELIVERY
+      when /^UNDELIVERED/
+        UNDELIVERED
+      when /^HELD AT ENQUIRY/
+        HELD_AT_ENQUIRY_OFFICE
+      when /^DELIVERED/
+        DELIVERED
+      else
+        UNRECOGNISED
+      end
+    end
+  end
+end

data/lib/royal_mail_scraper/tracker.rb

@@ -0,0 +1,35 @@
+module RoyalMailScraper
+  class Tracker < Struct.new(:tracking_number, :details)
+    def self.fetch(tracking_number)
+      request = Request.new(tracking_number)
+      response = request.execute
+      response.tracker
+    end
+
+    def datetime
+      last_detail.datetime if last_detail
+    end
+
+    def status
+      last_detail.status if last_detail
+    end
+
+    def message
+      last_detail.message if last_detail
+    end
+
+    def location
+      last_detail.location if last_detail
+    end
+
+    def recognised_details
+      details.select { |detail| detail.status != StatusMap::UNRECOGNISED }
+    end
+
+    private
+
+    def last_detail
+      @last_detail ||= details.last
+    end
+  end
+end

data/lib/royal_mail_scraper/version.rb

@@ -0,0 +1,3 @@
+module RoyalMailScraper
+  VERSION = "1.0.0"
+end

data/lib/royal_mail_scraper.rb

@@ -0,0 +1,16 @@
+require "royal_mail_scraper/version"
+require "royal_mail_scraper/tracker"
+require "royal_mail_scraper/tracker/request"
+require "royal_mail_scraper/tracker/response"
+require "royal_mail_scraper/tracker/detail"
+require "royal_mail_scraper/tracker/status_map"
+
+module RoyalMailScraper
+  TRACKING_NUMBER_FORMAT = /\A[A-Z]{2}\d{9}GB\z/i
+
+  class << self
+    def tracking_number?(tracking_number)
+      !!(tracking_number.to_s =~ TRACKING_NUMBER_FORMAT)
+    end
+  end
+end

data/royal_mail_scraper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'royal_mail_scraper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "royal_mail_scraper"
+  spec.version       = RoyalMailScraper::VERSION
+  spec.authors       = ["Laurynas Butkus"]
+  spec.email         = ["laurynas.butkus@gmail.com"]
+  spec.description   = %q{A simple page scraper for Royal Mail Track and Trace}
+  spec.summary       = %q{Fetches tracking information from Royal Mail page}
+  spec.homepage      = "https://github.com/laurynas/royal_mail_scraper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end