allpurpose 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Craig Sullivan
+
+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,48 @@
+# Allpurpose
+
+Ruby client for the [All Purpose Removals and Storage](www.allpurposeremovals.com.au) freight API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'allpurpose'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install allpurpose
+```
+
+## Usage
+
+Obtaining a quote from All Purpose, you will need to pass in the destination suburb name, destination post code and volume of your items that you want shipped.
+
+All Purpose API assumes that your items will be picked up from the Brisbane Metro area only so there is no need to define pickup destination.
+
+Here is an example of getting a quote from All Purpose ...
+
+```
+suburb = 'Brisbane Market'
+post_code = 4106	# post code for Brisbane Market
+volume = 1.58
+
+ap = Allpurpose::Quote.quote(suburb, post_code_, volume)
+puts ap.amount
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+task :default => :test

data/allpurpose.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/allpurpose/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Craig Sullivan"]
+  gem.email         = ["craig@melbourne-systems.com"]
+  gem.description   = %q{Get a freight cost estimate from AllPurpose Removals and Storage}
+  gem.summary       = %q{This gem queries the AllPupose Removals and Storage web service to get a freight quote for shipping items. AllPurpose assumes shipping from Brisbane Metro area only.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "allpurpose"
+  gem.require_paths = ["lib"]
+  gem.version       = Allpurpose::VERSION
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'turn'
+  gem.add_development_dependency 'rake'
+
+  gem.add_dependency 'httparty'
+
+end

data/lib/allpurpose.rb

@@ -0,0 +1,5 @@
+require "allpurpose/version"
+
+module Allpurpose
+  # Your code goes here...
+end

data/lib/allpurpose/quote.rb

@@ -0,0 +1,40 @@
+require "httparty"
+require 'open-uri'
+
+module Allpurpose
+
+  class Quote
+
+    include HTTParty
+    format :json
+    base_uri "https://www.allpurposeremovals.com.au/api/quote/json"
+
+    attr_accessor :suburb, :post_code, :volume, :amount
+
+    def initialize(suburb, post_code, volume, amount=0)
+      self.suburb = suburb
+      self.post_code = post_code
+      self.volume = volume
+      self.amount = amount
+    end
+
+    def self.quote(suburb, post_code, volume)
+
+      response = get("/#{URI::encode(suburb)}/#{post_code}/#{volume}")
+
+      if response.success?
+        if response.parsed_response.nil?
+          nil
+        else
+          resp = response.parsed_response["ShippingQuote"]
+          self.new(resp["Suburb"], resp["Postcode"].to_i, volume, resp["Quote"].to_f)
+        end
+      else
+        raise response.response    
+      end
+
+    end
+
+  end
+  
+end

data/lib/allpurpose/version.rb

@@ -0,0 +1,3 @@
+module Allpurpose
+  VERSION = "0.0.1"
+end

data/spec/allpurpose/quote_spec.rb

@@ -0,0 +1,31 @@
+require 'turn/autorun'
+
+require_relative "../../lib/allpurpose/quote"
+
+describe "AllPurpose Quote" do
+
+  describe "when a suburb exists" do
+    it "is must equal 75" do
+      
+      suburb = 'Brisbane Market'
+      post_code = 4106 
+      volume = 1.58
+      
+      q = Allpurpose::Quote.quote(suburb, post_code, volume)
+      
+      q.amount.must_equal 75.00
+      q.amount.must_be_kind_of Float
+      q.suburb.must_equal suburb.upcase
+      q.post_code.must_equal post_code
+      
+    end
+  end
+
+  describe "when volume is zero" do
+    it "is must be nil" do
+      q = Allpurpose::Quote.quote('Brisbane Market', 4106, 0)
+      q.must_be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'turn/autorun'
+
+Turn.config do |c|
+  c.format  = :outline
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: allpurpose
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Craig Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get a freight cost estimate from AllPurpose Removals and Storage
+email:
+- craig@melbourne-systems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRQ==
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  YWxscHVycG9zZS5nZW1zcGVj
+- !binary |-
+  bGliL2FsbHB1cnBvc2UucmI=
+- !binary |-
+  bGliL2FsbHB1cnBvc2UvcXVvdGUucmI=
+- !binary |-
+  bGliL2FsbHB1cnBvc2UvdmVyc2lvbi5yYg==
+- !binary |-
+  c3BlYy9hbGxwdXJwb3NlL3F1b3RlX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem queries the AllPupose Removals and Storage web service to get a
+  freight quote for shipping items. AllPurpose assumes shipping from Brisbane Metro
+  area only.
+test_files:
+- !binary |-
+  c3BlYy9hbGxwdXJwb3NlL3F1b3RlX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==