auspost-drc 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Darcy Laycock
+
+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,46 @@
+# auspost-drc #
+
+A rubygem for accessing the Australia Post Delivery Rate Calculator.
+
+Please note that in order to use this service, you must agree to the [Australia Post DRC terms and conditions](http://www.edeliver.com.au/Templates/ifs/IFS_DRC_Terms.htm) - I take no responsibility for
+how you use this library, it is simply a wrapper around the DRC api.
+
+## Usage ##
+
+    require 'aus_post/drc'
+    
+    result = AusPost::DRC.calculate(:length => 100, :height => 100, :width => 100,
+      :destination => 'XXXX', :pickup => 'YYYY', :country => 'AU', :service_type => :express,
+      :weight => 1, :quantity => 1)
+      
+The following are optional with the following defaults:
+
+* `:quantity` - defaults to `1`
+* `:service_type` - defaults to `:standard`
+* `:country` - defaults to `'AU'`. As a 2 character country code
+
+The calculator has the following methods:
+
+- `result.charge` - charge as a float, nil on error
+- `result.days` - days as integer, nil on error
+- `result.charge_as_string` - charge as string, nil on error
+
+With exception-throwing variants:
+
+- `result.charge!` - charge as a float, throwing an error otherwise.
+- `result.days!` - days as integer, throwing an error otherwise.
+- `result.charge_as_string!` - charge as string, throwing an error otherwise.
+
+## Note on Patches/Pull Requests ##
+ 
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.
+
+Australia Post and other assorted trademarks are copyright Australia Post.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+require "lib/aus_post/drc"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "auspost-drc"
+    gem.summary     = %Q{AusPost Delivery Rate Calculator Gem}
+    gem.description = %Q{Gem for AusPost Delivery Rate Calculator - Making it easy to calculate shipping}
+    gem.email       = "sutto@sutto.net"
+    gem.homepage    = "http://github.com/Sutto/auspost-drc"
+    gem.authors     = ["Darcy Laycock"]
+    gem.version     = AusPost::DRC::VERSION
+    gem.add_development_dependency "shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "auspost_drc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/auspost-drc.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{auspost-drc}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darcy Laycock"]
+  s.date = %q{2010-05-07}
+  s.description = %q{Gem for AusPost Delivery Rate Calculator - Making it easy to calculate shipping}
+  s.email = %q{sutto@sutto.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "auspost-drc.gemspec",
+     "lib/aus_post/drc.rb",
+     "lib/aus_post/drc/calculator.rb",
+     "lib/aus_post/drc/parcel.rb",
+     "lib/aus_post/drc/service_type.rb",
+     "test/helper.rb",
+     "test/test_auspost_drc.rb"
+  ]
+  s.homepage = %q{http://github.com/Sutto/auspost-drc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{AusPost Delivery Rate Calculator Gem}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_auspost_drc.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
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/aus_post/drc.rb

@@ -0,0 +1,16 @@
+module AusPost
+  module DRC
+    
+    VERSION = "0.1.0".freeze
+    Error   = Class.new(StandardError)
+    
+    autoload :Parcel,      'aus_post/drc/parcel'
+    autoload :Calculator,  'aus_post/drc/calculator'
+    autoload :ServiceType, 'aus_post/drc/service_type'
+    
+    def self.calculate(params = {})
+      Calculator.new(Parcel.new(params))
+    end
+    
+  end
+end

data/lib/aus_post/drc/calculator.rb

@@ -0,0 +1,103 @@
+require 'uri'
+require 'net/http'
+
+module AusPost
+  module DRC
+    class Calculator
+      
+      DRC_BASE_URI = "http://drc.edeliver.com.au/rateCalc.asp"
+      
+      def initialize(parcel)
+        @parcel           = parcel
+        @calculated       = false
+        @charge           = nil
+        @charge_as_string = nil
+        @days             = nil
+      end
+      
+      # Once off thing.
+      def calculate
+        unless @calculated
+          uri = URI.parse("#{DRC_BASE_URI}?#{@parcel.to_params}")
+          response = Net::HTTP.get(uri)
+          process_response response
+          @calculated = true
+        end
+      end
+      
+      def has_charge?
+        calculate
+        !@charge.nil?
+      end
+      
+      def has_days?
+        calculate
+        !@days.nil?
+      end
+      
+      def charge
+        calculate
+        @charge
+      end
+      
+      def days
+        calculate
+        @days
+      end
+      
+      def charge_as_string
+        calculate
+        @charge_as_string
+      end
+      
+      def charge!
+        value_with_exception :charge
+      end
+      
+      def days!
+        value_with_exception :days
+      end
+      
+      def charge_as_string!
+        value_with_exception :charge_as_string
+      end
+      
+      protected
+      
+      def process_response(r)
+        body = body_to_hash(r)
+        if body[:err_msg].to_s.upcase == "OK"
+          process_success_body body
+        else
+          process_error_body body[:err_msg]
+        end
+      end
+      
+      def process_success_body(body)
+        @exception        = nil
+        @charge           = body[:charge].to_f
+        @days             = body[:days].to_i
+        @charge_as_string = body[:charge]
+      end
+      
+      def process_error_body(body)
+        @exception = Error.new(body)
+      end
+      
+      def value_with_exception(name)
+        calculate
+        @exception.nil? ? send(name) : raise(@exception)
+      end
+      
+      def body_to_hash(body)
+        hash = {}
+        body.each_line do |line|
+          key, value = line.strip.split("=", 2)
+          hash[key.to_sym] = value
+        end
+        hash
+      end
+      
+    end
+  end
+end

data/lib/aus_post/drc/parcel.rb

@@ -0,0 +1,63 @@
+require 'cgi'
+
+module AusPost
+  module DRC
+    class Parcel
+    
+      attr_accessor :destination, :pickup, :country, :service_type, :weight,
+                    :length, :width, :height, :quantity
+      
+      def initialize(options = {})
+        options.each_pair do |key, value|
+          real_key = :"#{key}="
+          send(real_key, value) if respond_to?(real_key)
+        end
+      end
+      
+      def country
+        @country ||= 'AU'
+      end
+      
+      def quantity
+        @quantity.nil? ? 1 : @quantity.to_i
+      end
+      
+      def destination
+        @destination.nil? ? nil : @destination.to_s
+      end
+      
+      def pickup
+        @pickup.nil? ? nil : @pickup.to_s
+      end
+      
+      def service_type
+        @service_type.nil? ? 'STANDARD' : @service_type
+      end
+      
+      def service_type=(value)
+        @service_type = value.to_s.strip.empty? ? nil : ServiceType[value.to_s]
+      end
+      
+      def to_params_hash
+        {'Pickup_Postcode'      => self.pickup,
+         'Destination_Postcode' => self.destination,
+         'Country'              => self.country,
+         'Service_Type'         => self.service_type,
+         'Weight'               => self.weight,
+         'Length'               => self.length,
+         'Width'                => self.width,
+         'Height'               => self.height,
+         'Quantity'             => self.quantity}
+      end
+      
+      def to_params
+        params = []
+        to_params_hash.each_pair do |key, value|
+          params << "#{key}=#{value}"
+        end
+        params.join("&")
+      end
+    
+    end
+  end
+end

data/lib/aus_post/drc/service_type.rb

@@ -0,0 +1,49 @@
+module AusPost
+  module DRC
+    class ServiceType
+      
+      def self.mapping
+        @mapping ||= []
+      end
+      
+      def self.add_mapping(short_name, code, description)
+        mapping << ServiceType.new(short_name, code, description)
+      end
+      
+      def self.[](code)
+        item = mapping.detect { |st| st.matches?(code) }
+        item && item.code
+      end
+      
+      def self.for_select
+        mapping.map { |st| [st.description, st.short_name.to_s] }
+      end
+      
+      attr_accessor :code, :short_name, :description
+      
+      def initialize(short_name, code, description)
+        @short_name  = short_name.to_s
+        @code        = code.to_s
+        @description = description.to_s
+      end
+      
+      def to_s
+        @code
+      end
+      
+      def matches?(text)
+        text = text.to_s.strip
+        !text.empty? && [short_name, code, description].any? { |v| v == text }
+      end
+      
+      add_mapping :standard,                                  'Standard', 'Regular'
+      add_mapping :express,                                   'Express',  'Express'
+      add_mapping :express_platinum,                          'Exp_Plt',  'Express Platinum'
+      add_mapping :express_courier_international_document,    'ECI_D',    'Express Courier International Document'
+      add_mapping :express_courier_international_merchandise, 'ECI_M',    'Express Courier International Merchandise'
+      add_mapping :international_air,                         'Air',      'International Air'
+      add_mapping :international_sea,                         'Sea',      'International Sea'
+      
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'auspost_drc'
+
+class Test::Unit::TestCase
+end

data/test/test_auspost_drc.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAuspostDrc < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: auspost-drc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-07 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Gem for AusPost Delivery Rate Calculator - Making it easy to calculate shipping
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- auspost-drc.gemspec
+- lib/aus_post/drc.rb
+- lib/aus_post/drc/calculator.rb
+- lib/aus_post/drc/parcel.rb
+- lib/aus_post/drc/service_type.rb
+- test/helper.rb
+- test/test_auspost_drc.rb
+has_rdoc: true
+homepage: http://github.com/Sutto/auspost-drc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: AusPost Delivery Rate Calculator Gem
+test_files: 
+- test/helper.rb
+- test/test_auspost_drc.rb