canadapost 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 134aaf80be1b1760b5ff916e7610f3a68c54bc84
+  data.tar.gz: 6402272921f2a0246282ac313152a2f7fe3cda7e
+SHA512:
+  metadata.gz: 66f2bb34d2dd943be4334f38e69f11e65c46b4a15cd0d9cd63c16b62034ea3aee8fda4b838d1103edb57ff486607c3428eb6a47b555c56be84b9c99c6e80d1ad
+  data.tar.gz: 9f4bcfb2dc25989786e13442af59ed18d4940c0a1322f2d3c26f7780a904f9d4438009dd4e6994fbba822b2b920dde00802ce64809556a9c3a83bac77098281b

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gordon B. Isnor
+
+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,56 @@
+# Canadapost
+
+A gem to facilitate Ruby on Rails interaction with Canada Post's REST API. 
+
+This is currently the most basic implementation that I needed for a particular project, and only has provisions for obtaining a list of shipping rates. I invite you to extend or improve as you see fit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'canadapost'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canadapost
+
+## Usage
+canada_post = CanadaPost.new({
+	 			username: "xxx", 
+			 	password: "xxx",
+			 	customer_number: 'xxx',
+			 	development: true (optional) 
+			 	})
+
+			 canada_post.origin_postal_code = "xxx"
+			 canada_post.dimensions = dimension_hash			 
+			 canada_post.customer = customer_hash
+			 canada_post.get_rates
+
+get_rates returns a hash of services, including:
+- :service_name
+- :service_code
+- :price_details[:due]
+- :service_link[:href]
+- :service_standard[:expected_transit_time]
+
+**customer hash:**
+for us: { :'united-states' => { :'zip-code' => 'xxxxx' } }
+for canada: { domestic: { :'postal-code' => 'xxxxxx' } }
+for international: { international: { :'country-code' => 'xx' } }
+
+**dimension hash**
+{weight: x.x, height: x.x, length: x.x, width: x.x } 
+Weight is kilograms; height, length, width are centimetres
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/canadapost.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "canadapost"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Gordon B. Isnor"]
+  spec.email         = ["gordonbisnor@gmail.com"]
+  spec.description   = %q{A basic gem to interface with the Canada POST REST API}
+  spec.summary       = %q{A basic gem to interface with the Canada POST REST API}
+  spec.homepage      = "http://www.github.com/gordonbisnor/canadapost"
+  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('httparty')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end
+

data/lib/canadapost.rb

@@ -0,0 +1,133 @@
+# CanadaPost gem for use with Canada Post REST API 
+class Canadapost
+	attr_accessor :username, 
+		:password, 
+		:development, 
+		:auth, 
+		:customer_number, 
+		:response,
+		:content_type_header,
+		:accept_header,
+		
+		# Get Rates
+		:dimensions, 
+		:customer, 
+		:origin_postal_code
+
+  # @param [Hash] options 
+  # @option options [String] :username your API key username
+  # @option options [String] :password your API key password
+  # @option options [Boolean] :development to specify development mode
+  # @option options [String] :customer_number your Canada Post customer account number
+	def initialize(params = {})
+		@username = params[:username]
+	 	@password = params[:password]
+	 	@development = params[:development]
+	 	@customer_number = params[:customer_number]
+	 	@auth = { username: username, password: password }
+	end
+		
+	# @return [Hash] Hash with symbolized keys
+	def results
+		resp = if response.parsed_response.is_a? String
+			Hash.from_xml(response.parsed_response.gsub("\n", ""))
+		else
+			response.parsed_response
+		end
+		hash = resp.deep_symbolize_keys!
+	end
+	private :results
+
+	# @param xml [String] A string containing the XML data
+	# @param url [String] The Canadda POST API endpoint
+	def do_request(xml, url)
+		self.response = HTTParty.post(url, 
+			body: xml, 
+			basic_auth: auth,
+			headers: {
+				'Content-type' => content_type_header,
+				'Accept' => accept_header
+				 }
+			)
+	end	
+	private :do_request
+	
+	# @return String
+	def base_url
+		if development
+			"https://ct.soa-gw.canadapost.ca"
+		else
+			"https://soa-gw.canadapost.ca"
+		end	
+	end
+	private :base_url
+
+
+	#
+	# Get Rates
+	#
+
+	# Get Rates from Canada POST REST API
+ 	# @param [Hash] options 
+  # @option options [String] :original_postal_code the postal code the parcel is being sent from
+  # @option options [Hash] :customer a hash of customer details either { :'united-states' => { :'zip-code' => '' } };  { domestic: { :'postal-code' => '' } }; or { international: { :'country-code' => '' } }
+	# @option options [Hash] :dimensions a hash of parcel dimensions, containing height, width and length in CM and weight in KG
+	# @return Hash a hash of services
+	#
+	def get_rates(params = {})
+ 		self.origin_postal_code = params[:origin_postal_code].gsub(/\s+/, "") if params[:origin_postal_code].present?
+	 	self.customer = params[:customer] if params[:customer].present?
+	 	self.dimensions = params[:dimensions] if params[:dimensions].present?
+
+	 	self.content_type_header = self.accept_header = 'application/vnd.cpc.ship.rate-v2+xml'
+
+		begin
+			do_request(get_rates_xml, get_rates_url)
+			services = results[:price_quotes][:price_quote]
+			services = services.map(&:deep_symbolize_keys!)
+			return services
+		rescue => e
+			Rails.logger.info "ERROR :#{e}"
+		end
+		return services
+	end
+
+	#
+	# @return String
+	#
+	def get_rates_url
+		"#{base_url}/rs/ship/price"
+	end
+	private :get_rates_url
+
+	#
+	# @return String
+	#
+	def get_rates_xml
+		Nokogiri::XML::Builder.new { |xml| 
+			xml.send(:"mailing-scenario", xmlns: "http://www.canadapost.ca/ws/ship/rate-v2") {
+				xml.send(:"customer-number", customer_number)
+				xml.send(:"origin-postal-code", origin_postal_code)
+				xml.send(:"parcel-characteristics") {
+					xml.weight dimensions[:weight]
+					xml.dimensions {
+						xml.height dimensions[:height].round(1)
+						xml.width dimensions[:width].round(1)
+						xml.length dimensions[:length].round(1)
+					}
+				}
+				xml.destination {
+					customer.each_pair do |key, value|
+						xml.send(key) {
+						 value.each_pair { |key,value| 
+						 	xml.send(key, value) 
+						 	}
+						} 
+					end
+				}
+			}
+		}.to_xml
+	end	
+	private :get_rates_xml
+	
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: canadapost
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gordon B. Isnor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A basic gem to interface with the Canada POST REST API
+email:
+- gordonbisnor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- canadapost.gemspec
+- lib/canadapost.rb
+homepage: http://www.github.com/gordonbisnor/canadapost
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A basic gem to interface with the Canada POST REST API
+test_files: []