canada_post 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tsokurov Alex <me@ximik.net>
+
+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.rdoc

@@ -0,0 +1,59 @@
+= Canada Post
+
+Canada Post PHP Class will communicates with Canada Post Server and gets the shipping estimate. Its basic 
+and can be extended.
+
+
+== How to Use
+ 
+As per Canada Post's specification, make sure Port 30000 is opened.
+
+At first require the gem.
+
+  require 'canada_post'
+  
+  cPost = CanadaPost.new
+
+Set your manufacturer CPCID, postal code by calling the function setManufacturer  
+
+  merchant = {
+    :merchantCPCID => 'CPC_DEMO_XML',
+    :fromPostalCode => 'L1JK9',
+    :turnAroundTime => 24,
+    :itemsPrice => 14
+  }
+  cPost.setMerchant merchant
+
+Then set the Customer address in the format shown below, again in associative array format.
+
+*Note*: city and provOrState are optional. Only Postal Code and country is required. 
+
+  customer = {
+    :city => 'Brampton',
+    :provOrState => 'Ontario,
+    :country => 'CA',        
+    :postalCode => 'L1JK9'   
+  }
+  cPost.setCustomer customer
+
+Then, add the products needed to be shipped (add as many as you want), in the format shown below:
+  
+  item = {
+    :quantity => 1,
+    :weight => 2,
+    :length => 3,
+    :width => 1,
+    :height => 8,
+    :description => 'some Description about Product'
+  }
+  cPost.addItem item
+
+Then, invoke the method below (returns XML format of details from Canada Post Server):
+
+  response = cPost.getRates
+       
+== License
+
+The gem is based on {CanadaPost PHP class}[http://github.com/itsalif/CanadaPost].
+
+The script has been released under MIT License.

data/canada_post.gemspec

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.platform     = Gem::Platform::RUBY
+  s.name         = 'canada_post'
+  s.version      = '0.1.0'
+  s.author       = 'Alex Tsokurov'
+  s.email        = 'me@ximik.net'
+  s.summary      = 'A Simple Ruby Class that communicates with Canada Post Server and provides a shipping estimate.'
+  s.homepage     = 'http://github.com/Ximik/CanadaPost'
+
+  s.files        = `git ls-files`.split("\n")
+
+  s.add_dependency 'builder'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files << 'README.rdoc'
+end

data/lib/canada_post.rb

@@ -0,0 +1,102 @@
+# :main: README.rdoc
+
+require 'net/http'
+require 'rexml/document'
+require 'builder'
+ 
+class CanadaPost
+
+  def initialize :nodoc:
+    @items = []
+  end
+
+  #
+  # This method sets the merchant information
+  #     
+  def setMerchant(merchant)
+    @merchantInfo = merchant;
+  end  
+  
+  #
+  # This method sets the customer information
+  #  
+  def setCustomer(customer)
+    @customerInfo = customer;
+  end
+  
+  #
+  # This method allows you to add items to be shipped
+  #  
+  def addItem(item)
+    @items << item;
+  end    
+  
+  #
+  # The main method. Makes request and parse the response
+  #
+  def getRates
+    url = URI.parse 'http://sellonline.canadapost.ca:30000/'
+    request = Net::HTTP::Post.new(url.path)
+    request.content_type = 'application/x-www-form-urlencoded'
+    request.body = prepareXML
+    response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+    xml = REXML::Document.new(response.body).root
+    if error = xml.elements['error']
+      error = error.elements['statusMessage'].text
+      raise StandardError.new(error)
+    end
+    xml = xml.elements['ratesAndServicesResponse']
+    result = {}
+    result[:products] = []
+    xml.elements.each('product') do |p|
+      product = {}
+      p.elements.each do |t|
+        product[t.name.to_sym] = t.text
+      end
+      result[:products] << product
+    end
+    result[:options] = {}
+    xml.elements['shippingOptions'].elements.each do |t|
+      result[:options][t.name.to_sym] = t.text
+    end
+    return result
+  end
+  
+  private 
+  
+  
+  #
+  # This method prepares the XML to be send to Canada Posts's Server.
+  #
+  def prepareXML
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.eparcel do
+      xml.language 'en'
+      xml.ratesAndServicesRequest do
+        buildTags(xml, [:merchantCPCID, :fromPostalCode, :turnAroundTime, :itemsPrice], @merchantInfo])
+        xml.lineItems do
+          @items.each do |item|
+            xml.item do
+              buildTags(xml, [:quantity, :weight, :length, :width, :height, :description], item)
+            end
+            xml.readyToShip if item[:readyToShip]
+          end
+        end
+        buildTags(xml, [:city, :provOrState, :country, :postalCode], @customerInfo])
+      end
+    end
+    return xml.target!
+  end
+  
+  #
+  # This method just build tags in right order.
+  #
+  def buildTags(xml, tags, hash)
+    tags.each do |t|
+      text = hash[t]
+      xml.method_missing t, text if text
+    end
+  end
+        
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: canada_post
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Tsokurov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: me@ximik.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- canada_post.gemspec
+- lib/canada_post.rb
+homepage: http://github.com/Ximik/CanadaPost
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Simple Ruby Class that communicates with Canada Post Server and provides a shipping estimate.
+test_files: []
+