tuffnells_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccd50044f244f59f463c3e1fbcf3dacf21f980ee
+  data.tar.gz: feee571c04c3f8a46efbb5272d5762226efdd95b
+SHA512:
+  metadata.gz: bd1d5e7a0302202c74483a689c29ed89ce00cfb0f5f52f707bd6eb009c5fbe78a63a4a845183660190bc76859d10d01d91a147bf2f7fce9089199c9e0295121f
+  data.tar.gz: '081d009ccb72feb53ab339d01a39ef3c962de310e9ea10ad392b47b217e8c2a706895cd4a67971f000ec8c0220a842b6abcf665c9db8f398c5e085533475a708'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tuffnells_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jamie Barton
+
+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,47 @@
+# TuffnellsApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tuffnells_api'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install tuffnells_api
+
+## Configuration
+Before making a request, you must configure an account code.
+
+```ruby
+TuffnellsApi.configure do |config|
+  config.account_code = 123456
+end
+```
+
+## Usage
+
+```ruby
+@consigment = TuffnellsApi::Consignment.find(consignment_no)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tuffnells_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tuffnells_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tuffnells_api.rb

@@ -0,0 +1,19 @@
+require "tuffnells_api/version"
+require "tuffnells_api/configuration"
+require "tuffnells_api/base"
+require "tuffnells_api/consignment"
+require "tuffnells_api/errors"
+
+module TuffnellsApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/tuffnells_api/base.rb

@@ -0,0 +1,57 @@
+require 'uri'
+require 'open-uri'
+require "happymapper"
+require 'tuffnells_api/tracking_record'
+
+module TuffnellsApi
+  class Base
+    include HappyMapper
+
+    attr_reader :account_code
+
+    def initialize consignment_no
+      @consignment_no = consignment_no
+      @account_code = TuffnellsApi.configuration.account_code
+      read_timeout = TuffnellsApi.configuration.read_timeout || 5
+
+      proxy = TuffnellsApi.configuration.proxy
+
+      request = Nokogiri::XML(open(base_uri,
+        proxy_http_basic_authentication: proxy,
+        read_timeout: read_timeout
+      ))
+
+      @response = TuffnellsApi::TrackingRecord.parse(request, single: true)
+    end
+
+    def postcode
+      @response.delivery_address.postcode
+    end
+
+    def total_pieces
+      @response.consignment_information.pieces
+    end
+
+    def delivery_status
+      @response.movement_information.movements.last.description
+    end
+
+    def signed_by
+      @response.timed_information.deliveries.last.signature
+    end
+
+    def pod_image
+      @response.image_information.images.last.uri
+    end
+
+    private
+
+    def base_uri
+      "http://www.tpeweb.co.uk/WebServices/Customer/PODTrackingData.asmx/GetTrackingRecord?#{query_string}"
+    end
+
+    def query_string
+      "AccountCode=#{@account_code}&Reference=#{@consignment_no}"
+    end
+  end
+end

data/lib/tuffnells_api/collection_address.rb

@@ -0,0 +1,20 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class CollectionAddress
+    include HappyMapper
+
+    tag 'ArrayOfTrackingRecord'
+    tag 'TrackingRecord'
+    tag 'CollectionAddress'
+
+    element :company_name, String, tag: 'CompanyName'
+    element :address_1, String, tag: 'Address1'
+    element :address_2, String, tag: 'Address2'
+    element :address_3, String, tag: 'Address3'
+    element :town, String, tag: 'Town'
+    element :postcode, String, tag: 'Postcode'
+    element :contact_name, String, tag: 'ContactName'
+    element :contact_phone, String, tag: 'ContactTelephone'
+  end
+end

data/lib/tuffnells_api/configuration.rb

@@ -0,0 +1,5 @@
+module TuffnellsApi
+  class Configuration
+    attr_accessor :account_code, :proxy, :read_timeout
+  end
+end

data/lib/tuffnells_api/consignment_information.rb

@@ -0,0 +1,20 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class ConsignmentInformation
+    include HappyMapper
+
+    tag 'ArrayOfTrackingRecord'
+    tag 'TrackingRecord'
+    tag 'ConsignmentInformation'
+
+    element :pieces, Integer, tag: 'Pieces'
+    element :pallets, Integer, tag: 'Pallets'
+    element :weight, Integer, tag: 'Weight'
+    element :service, String, tag: 'Service'
+    element :delivery_date, String, tag: 'DeliveryDate'
+    element :items_delivered, Integer, tag: 'ItemsDelivered'
+    element :consignment_ref, String, tag: 'ConsignmentRef'
+    element :special_instructions, String, tag: 'SpecialInstructions'
+  end
+end

data/lib/tuffnells_api/delivery_address.rb

@@ -0,0 +1,20 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class DeliveryAddress
+    include HappyMapper
+
+    tag 'ArrayOfTrackingRecord'
+    tag 'TrackingRecord'
+    tag 'DeliveryAddress'
+
+    element :company_name, String, tag: 'CompanyName'
+    element :address_1, String, tag: 'Address1'
+    element :address_2, String, tag: 'Address2'
+    element :address_3, String, tag: 'Address3'
+    element :town, String, tag: 'Town'
+    element :postcode, String, tag: 'Postcode'
+    element :contact_name, String, tag: 'ContactName'
+    element :contact_phone, String, tag: 'ContactTelephone'
+  end
+end

data/lib/tuffnells_api/errors.rb

@@ -0,0 +1,4 @@
+module TuffnellsApi
+  class Error < StandardError; end
+  class NoAccessPermitted < Error; end
+end

data/lib/tuffnells_api/image_information.rb

@@ -0,0 +1,12 @@
+require 'happymapper'
+require 'tuffnells_api/pod_image'
+
+module TuffnellsApi
+  class ImageInformation
+    include HappyMapper
+
+    tag 'ImageInformation'
+
+    has_many :images, TuffnellsApi::PodImage
+  end
+end

data/lib/tuffnells_api/movement.rb

@@ -0,0 +1,18 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class Movement
+    include HappyMapper
+
+    tag 'Movement'
+
+    element :movement_date, String, tag: 'MovementDate'
+    element :movement_time, String, tag: 'MovementTime'
+    element :description, String, tag: 'Description'
+    element :depot, String, tag: 'DeliveryDepot'
+    element :round, String, tag: 'Round'
+    element :delivery_date, String, tag: 'DeliveryDate'
+    element :packages_received, String, tag: 'PackagesReceived'
+    element :packaged_delivered, String, tag: 'PackagedDelivered'
+  end
+end

data/lib/tuffnells_api/movement_information.rb

@@ -0,0 +1,14 @@
+require 'happymapper'
+require 'tuffnells_api/movement'
+
+module TuffnellsApi
+  class MovementInformation
+    include HappyMapper
+
+    tag 'ArrayOfTrackingRecord'
+    tag 'TrackingRecord'
+    tag 'MovementInformation'
+
+    has_many :movements, TuffnellsApi::Movement
+  end
+end

data/lib/tuffnells_api/pod_image.rb

@@ -0,0 +1,11 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class PodImage
+    include HappyMapper
+
+    tag 'PODImage'
+
+    element :uri, String, tag: 'URL'
+  end
+end

data/lib/tuffnells_api/scan.rb

@@ -0,0 +1,16 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class Scan
+    include HappyMapper
+
+    tag 'Scan'
+
+    element :piece_id, Integer, tag: 'PieceID'
+    element :description, String, tag: 'Description'
+    element :depot, String, tag: 'Depot'
+    element :date, String, tag: 'ScanDate'
+    element :time, String, tag: 'ScanTime'
+    element :scanned_by, String, tag: 'ScannedBy'
+  end
+end

data/lib/tuffnells_api/scan_information.rb

@@ -0,0 +1,12 @@
+require 'happymapper'
+require 'tuffnells_api/scan'
+
+module TuffnellsApi
+  class ScanInformation
+    include HappyMapper
+
+    tag 'ScanInformation'
+
+    has_many :scans, TuffnellsApi::Scan
+  end
+end

data/lib/tuffnells_api/timed_delivery.rb

@@ -0,0 +1,13 @@
+require 'happymapper'
+
+module TuffnellsApi
+  class TimedDelivery
+    include HappyMapper
+
+    tag 'TimedDelivery'
+
+    element :signature, String, tag: 'Signature'
+    element :date, String, tag: 'SignatureDate'
+    element :time, String, tag: 'SignatureTime'
+  end
+end

data/lib/tuffnells_api/timed_information.rb

@@ -0,0 +1,12 @@
+require 'happymapper'
+require 'tuffnells_api/timed_delivery'
+
+module TuffnellsApi
+  class TimedInformation
+    include HappyMapper
+
+    tag 'TimedInformation'
+
+    has_many :deliveries, TuffnellsApi::TimedDelivery
+  end
+end

data/lib/tuffnells_api/tracking_record.rb

@@ -0,0 +1,26 @@
+require "happymapper"
+require "tuffnells_api/delivery_address"
+require "tuffnells_api/collection_address"
+require "tuffnells_api/consignment_information"
+require "tuffnells_api/movement_information"
+require "tuffnells_api/timed_information"
+require "tuffnells_api/scan_information"
+require "tuffnells_api/image_information"
+
+module TuffnellsApi
+  class TrackingRecord
+    include HappyMapper
+
+    tag 'ArrayOfTrackingRecord'
+    tag 'TrackingRecord'
+
+    element :authorised, String, tag: 'Authorised'
+    element :delivery_address, TuffnellsApi::DeliveryAddress, tag: 'DeliveryAddress'
+    element :collection_address, TuffnellsApi::CollectionAddress, tag: 'CollectionAddress'
+    element :consignment_information, TuffnellsApi::ConsignmentInformation, tag: 'ConsignmentInformation'
+    element :movement_information, TuffnellsApi::MovementInformation, tag: 'MovementInformation'
+    element :timed_information, TuffnellsApi::TimedInformation, tag: 'TimedInformation'
+    element :scan_information, TuffnellsApi::ScanInformation, tag: 'ScanInformation'
+    element :image_information, TuffnellsApi::ImageInformation, tag: 'ImageInformation'
+  end
+end

data/lib/tuffnells_api/version.rb

@@ -0,0 +1,3 @@
+module TuffnellsApi
+  VERSION = "0.1.1"
+end

data/tuffnells_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tuffnells_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tuffnells_api"
+  spec.version       = TuffnellsApi::VERSION
+  spec.authors       = ["Jamie Barton"]
+  spec.email         = ["hi_jamie@me.com"]
+
+  spec.summary       = "Access Tuffnells POD via simple Ruby DSL."
+  spec.description   = "This Rubygem handles tuffnells access and converts XML to JSON."
+  spec.homepage      = "https://github.com/notrab/tuffnells_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri-happymapper", "~> 0.5.9"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tuffnells_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jamie Barton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri-happymapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This Rubygem handles tuffnells access and converts XML to JSON.
+email:
+- hi_jamie@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tuffnells_api.rb
+- lib/tuffnells_api/base.rb
+- lib/tuffnells_api/collection_address.rb
+- lib/tuffnells_api/configuration.rb
+- lib/tuffnells_api/consignment_information.rb
+- lib/tuffnells_api/delivery_address.rb
+- lib/tuffnells_api/errors.rb
+- lib/tuffnells_api/image_information.rb
+- lib/tuffnells_api/movement.rb
+- lib/tuffnells_api/movement_information.rb
+- lib/tuffnells_api/pod_image.rb
+- lib/tuffnells_api/scan.rb
+- lib/tuffnells_api/scan_information.rb
+- lib/tuffnells_api/timed_delivery.rb
+- lib/tuffnells_api/timed_information.rb
+- lib/tuffnells_api/tracking_record.rb
+- lib/tuffnells_api/version.rb
+- tuffnells_api.gemspec
+homepage: https://github.com/notrab/tuffnells_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Access Tuffnells POD via simple Ruby DSL.
+test_files: []