shipppit-canada-post 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00ff5aab5456ba9e2c713466439d72de463a8a9a
+  data.tar.gz: 6e68939726c48b6b49272421d8118fd62f5a0cdb
+SHA512:
+  metadata.gz: 267d00ca8147cd62d41788b8f20a7ee49732c6ce6e79af1da8921e8908523758a49fe1bf68c07f2c00aa39a3393c8614791566549c5ff1bc47c67cf634f39b45
+  data.tar.gz: 386c4d513111ef8fd82e423eedf62e7ed9a2b957dc752af9084a2765e4a991bc1891a72a3c9f0f8deacd752d308529a4b93efa5d089ff741843a0f916c41c1cf

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+spec/vcr
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+canada_post_credentials.yml
+TODO.md
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 JONBRWN
+
+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,312 @@
+# CanadaPost REST API V3 Wrapper
+
+[![Build Status](https://semaphoreci.com/api/v1/projects/719f5dd5-e5ff-47f3-a6ff-833ad667ef76/646929/badge.svg)](https://semaphoreci.com/olimart/shipppit-canada-post)
+
+A Ruby wrapper for the CanadaPost REST API. Based extensively off the [fedex](https://github.com/jazminschroeder/fedex) gem.
+Thanks to [jazminschroeder](https://github.com/jazminschroeder) and all contributors who helped make that a gem worth recreating for the Canada Post API
+
+For more info see the [Official Canada Post Developer Docs](https://www.canadapost.ca/cpotools/apps/drc/home)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shipppit-canada-post'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shipppit-canada-post
+
+## Usage
+
+Require the gem:
+
+```ruby
+require 'canada_post'
+```
+
+Create a service:
+
+```ruby
+canada_post_service = CanadaPost::Client.new( username: 'xxxx',
+                  password: 'xxxx',
+                  customer_number: 'xxxx',
+                  mode: 'development' )
+# mode can be 'development' or 'production'
+```
+
+### Define shipper:
+
+```ruby
+shipper = { postal_code: 'M5X1B8', country_code: 'CA' }
+# Post Code is required for US and CA shipments, not for International Shipments
+```
+
+### Define recipient:
+
+```ruby
+recipient = { postal_code: 'M5R1C6', country_code: 'CA' }
+```
+
+### Define package:
+
+```ruby
+package = { weight: { value: 1, units: 'KG' },
+            dimensions: { length: 25, width: 15, height: 10, units: 'CM' } }
+# weight is the only requirement for your package, Canada Post only accepts KG and CM for the time being
+```
+
+### To get service codes:
+see [Canada Post Rating API docs](https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/rating/getrates/default.jsf) for service code descriptions
+```ruby
+$ CanadaPost::Request::Rate::SERVICE_CODES
+$ => ["DOM.RP", "DOM.EP", "DOM.XP", "DOM.XP.CERT", "DOM.PC.CERT", "DOM.PC", "DOM.DT", "DOM.LIB", "USA.EP", "USA.PW.ENV", "USA.PW.PAK", "USA.PW.PARCEL", "USA.SP.AIR", "USA.TP", "USA.TP.LVM", "USA.XP", "INT.XP", "INT.IP.AIR", "INT.IP.SURF", "INT.PW.ENV", "INT.PW.PAK", "INT.PW.PARCEL", "INT.SP.AIR", "INT.SP.SURF", "INT.TP"]
+```
+
+### Get Rates:
+
+```ruby
+$ rates = canada_post_service.rate(
+  shipper: shipper, recipient: recipient, package: package)
+```
+
+Not specifying a service type will return an array of all available rates
+
+```ruby
+# complete response
+$ [#<CanadaPost::Rate:0x007fd783f42a88 @service_type="Expedited Parcel", @service_code="DOM.EP", @total_net_charge="8.76", @total_base_charge="7.77", @gst_taxes="0.00", @pst_taxes="0.00", @hst_taxes="1.01", @expected_transit_time="1">, #<CanadaPost::Rate:0x007fd783f42a60 @service_type="Priority", @service_code="DOM.PC", @total_net_charge="19.14", @total_base_charge="16.21", @gst_taxes="0.00", @pst_taxes="0.00", @hst_taxes="2.20", @expected_transit_time="1">, #<CanadaPost::Rate:0x007fd783f42a10 @service_type="Regular Parcel", @service_code="DOM.RP", @total_net_charge="8.76", @total_base_charge="7.77", @gst_taxes="0.00", @pst_taxes="0.00", @hst_taxes="1.01", @expected_transit_time="2">, #<CanadaPost::Rate:0x007fd783f429e8 @service_type="Xpresspost", @service_code="DOM.XP", @total_net_charge="11.31", @total_base_charge="9.58", @gst_taxes="0.00", @pst_taxes="0.00", @hst_taxes="1.30", @expected_transit_time="1">]
+```
+
+Specifying the service type will return one result
+
+```ruby
+$ service_type = 'DOM.EP'
+$ rates = canada_post_service.rate( shipper: shipper,
+                                    recipient: recipient,
+                                    package: package,
+                                    service_type: service_type )
+# complete response
+$ [
+  #<CanadaPost::Rate:0x007fd783fea238
+    @service_type="Expedited Parcel",
+    @service_code="DOM.EP",
+    @total_net_charge="8.76",
+    @total_base_charge="7.77",
+    @gst_taxes="0.00",
+    @pst_taxes="0.00",
+    @hst_taxes="1.01",
+    @expected_transit_time="1",
+    @expected_delivery_date="2015-12-25",
+    @guaranteed_delivery="false",
+    @am_delivery="false">
+  ]
+```
+
+Your final amount will be under `total_net_charge`:
+
+```ruby
+$ rates.first.total_net_charge => '8.76' # all monetary values are CAD
+```
+
+### Create Shipping
+
+```ruby
+sender = {
+  name: 'John Doe',
+  company: 'sender company',
+  shipping_point: 'M5X1B8',
+  address_details: {
+    address: '123 street',
+    phone: '343434',
+    state: 'QC'
+    zip: 'M5X1B8',
+    city: 'Gatineau',
+    country: 'CA'
+  }
+}
+destination = {
+  name: 'John Doe',
+  company: 'receiver company',
+  address_details: {
+    address: '4394 Rue Saint-Denis',
+    state: 'QC'
+    zip: 'H2J2L1',
+    city: 'Montréal',
+    country: 'CA'
+  }
+}
+package = {
+ weight: 2,
+ unpackaged: false,
+ mailing_tube: false,
+ dimensions: {
+   length: 2,
+   width: 2
+   height: 2
+ }
+}
+notification = {
+  email: 'example@gmail.com',
+  on_shipment: true,
+  on_exception: true,
+  on_delivery: true
+}
+preferences = {
+  show_packing_instructions: true,
+  show_postage_rate: true,
+  show_insured_value: true
+}
+settlement_info = {
+  contract_id: 2514533 // 2514533 for sendbox mode
+}
+
+canada_post_service.create(
+  sender: sender,
+  destination: destination,
+  package: package,
+  notification: notification,
+  preferences: preferences,
+  settlement_info: settlement_info,
+  group_id: '5241556',
+  mailing_date: '2016-01-20',
+  contract_id: '2514533',
+  service_code: 'DOM.RP'
+)
+
+Response:
+{
+  create_shipping: {create shipping response},
+  transmit_shipping: {transmit shipping response}
+}
+
+Error Code:
+
+{
+  create_shipping: {errors: 'comma separated error essages'},
+  transmit_shipping: {errors: 'comma separated error messages'}
+}
+```
+
+### Create shipping on behalf of
+
+```ruby
+Pass additional information to create shipment on behalf of merchant.
+Merchant information can be retrieved after registering merchant in your platform.
+
+canada_post_service.create(
+  mobo: {
+     username: 'xxx',
+     password: 'password',
+     customer_number: '123456789',
+     contract_number: '987654321'
+  }
+)
+```
+
+### Merchant registration
+
+Use this call to get a unique registration token (token-id) required to launch a merchant into the Canada Post sign-up process.
+
+```ruby
+@token = canada_post_service.registration
+{'token-id' => '11111111111111111111111'}
+```
+
+With the token-id in hand, complete the registration process by making another POST request to https://www.canadapost.ca/cpotools/apps/drc/merchant with the following fields:
+- return-url // callback url to your application
+- token-id
+- platform-id
+
+Canada Post service will redirect the user to the designated callback URL along with the required information to perform shipping transactions for the merchant (username, password, customer_number and contract_number).
+
+### Get shipping price
+
+```ruby
+response = canada_post_service.get_price(shipping_id, mobo = optional)
+
+{
+  :shipment_price=>{
+    :xmlns=>"http://www.canadapost.ca/ws/shipment-v7", :service_code=>"DOM.EP", :base_amount=>"10.21",
+    :priced_options=>{
+      :priced_option=> {:option_code=>"DC", :option_price=>"0.00"}
+    },
+    :adjustments=>{
+      :adjustment=>{
+        :adjustment_code=>"FUELSC", :adjustment_amount=>"0.43"
+      }
+    },
+    :pre_tax_amount=>"10.64", :gst_amount=>"0.53", :pst_amount=>"0.00", :hst_amount=>"0.00", :due_amount=>"11.17", :service_standard=>{
+      :am_delivery=>"false", :guaranteed_delivery=>"true", :expected_transmit_time=>"1", :expected_delivery_date=>"2016-01-14"
+    },
+    :rated_weight=>"2.000"
+  }
+}
+```
+
+### Get shipping details
+
+```ruby
+response = canada_post_service.details(shipping_id, mobo = optional)
+
+{:shipment_details=>{:xmlns=>"http://www.canadapost.ca/ws/shipment-v7", :shipment_status=>"created", :final_shipping_point=>"M5X1C0", :shipping_point_id=>"7100", :tracking_pin=>"123456789012", :shipment_detail=>{:group_id=>"5241556", :expected_mailing_date=>"2016-01-13", :delivery_spec=>{:service_code=>"DOM.EP", :sender=>{:name=>"John Doe", :company=>"Apple", :contact_phone=>"343434", :address_details=>{:address_line_1=>"600 blvd Alexandre Taché", :city=>"Gatineau", :prov_state=>"QC", :country_code=>"CA", :postal_zip_code=>"M5X1B8"}}, :destination=>{:name=>"receiver", :company=>"receiver company", :address_details=>{:address_line_1=>"4394 Rue Saint-Denis", :city=>"Montréal", :prov_state=>"QC", :country_code=>"CA", :postal_zip_code=>"H2J2L1"}}, :options=>{:option=>{:option_code=>"DC"}}, :parcel_characteristics=>{:weight=>"2.000", :dimensions=>{:length=>"2.0", :width=>"2.0", :height=>"2.0"}, :unpackaged=>"false", :mailing_tube=>"false", :oversized=>"false"}, :notification=>{:email=>"user@gmail.com", :on_shipment=>"true", :on_exception=>"false", :on_delivery=>"true"}, :print_preferences=>{:output_format=>"8.5x11", :encoding=>"PDF"}, :preferences=>{:show_packing_instructions=>"true", :show_postage_rate=>"false", :show_insured_value=>"true"}, :settlement_info=>{:paid_by_customer=>"0002004381", :contract_id=>"0042708517", :intended_method_of_payment=>"Account"}}}}}
+
+```
+
+### Get shipping label
+
+```ruby
+canada_post_service.get_label(label_url)
+```
+this return a pdf response with label details.
+
+### Get manifest
+
+```ruby
+response = canada_post_service.get_manifest(manifest_url)
+
+{:manifest=>{:xmlns=>"http://www.canadapost.ca/ws/manifest-v7", :po_number=>"P123456789", :links=>{:link=>[{:rel=>"self", :href=>"https://ct.soa-gw.canadapost.ca/rs/0002004381/0002004381/manifest/96011452532284803", :media_type=>"application/vnd.cpc.manifest-v7+xml"}, {:rel=>"details", :href=>"https://ct.soa-gw.canadapost.ca/rs/0002004381/0002004381/manifest/96011452532284803/details", :media_type=>"application/vnd.cpc.manifest-v7+xml"}, {:rel=>"manifestShipments", :href=>"https://ct.soa-gw.canadapost.ca/rs/0002004381/0002004381/shipment?manifestId=96011452532284803", :media_type=>"application/vnd.cpc.shipment-v7+xml"}, {:rel=>"artifact", :href=>"https://ct.soa-gw.canadapost.ca/ers/artifact/6e93d53968881714/400811/0", :media_type=>"application/pdf"}]}}}
+```
+
+### Get artifact
+
+```ruby
+response = canada_post_service.get_artifact(artifact_url)
+Response:
+{
+  status: true,
+  artifact: artifact // pdf response
+}
+
+Error:
+{
+  status: false,
+  error: 'artifact error message'
+}
+```
+
+### Void shipping
+
+```ruby
+response = canada_post_service.void_shipping(shipping_id, mobo = optional)
+Error: {
+  status: false,
+  error: 'void shipping error'
+}
+```
+
+This is still a work in progress but feel free to contribute if it will benefit you!
+
+## Contributing
+
+1. Fork it ( https://github.com/shipppit/shipppit-canada-post/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run test suite `bundle exec rspec spec`
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

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

data/canada-post-api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'canada_post/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shipppit-canada-post"
+  spec.version       = CanadaPost::VERSION
+  spec.authors       = ["Olivier"]
+  spec.email         = ["olivier@yafoy.com"]
+  spec.summary       = %q{Canada Post API}
+  spec.description   = %q{Ruby wrapper for the Canada Post API V3}
+  spec.homepage      = "https://github.com/shipppit/shipppit-canada-post"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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", "~> 0.13.7"
+  spec.add_dependency "nokogiri", '~> 1.6', '>= 1.6.7.1'
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler",  "~> 1.7"
+  spec.add_development_dependency "rake",     "~> 10.0"
+
+  # FOR TESTING ONLY
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "webmock", "~> 1.22"
+  spec.add_development_dependency "vcr", "~> 3.0"
+end

data/lib/canada_post.rb

@@ -0,0 +1,14 @@
+require "canada_post/version"
+require "canada_post/request/base"
+require "canada_post/request/rate"
+require "canada_post/request/shipping"
+require "canada_post/request/registration"
+require "canada_post/shipment"
+require "canada_post/rate"
+require "canada_post/credentials"
+
+module CanadaPost
+  # Exceptions: CandaPost::RateError
+  class RateError < StandardError; end
+  class ShipmentError < StandardError; end
+end

data/lib/canada_post/client.rb

@@ -0,0 +1,45 @@
+module CanadaPost
+  class Client
+
+    def initialize(options={})
+      @credentials = Credentials.new(options)
+    end
+
+    def rate(options={})
+      Request::Rate.new(@credentials, options).process_request
+    end
+
+    def shipment(options={})
+      Request::Shipment.new(@credentials, options).process_request
+    end
+
+    def create(options = {})
+      Request::Shipping.new(@credentials, options).process_request
+    end
+
+    def get_price(shipping_id, mobo = @credentials.customer_number)
+      Request::Shipping.new(@credentials).get_price(shipping_id, mobo)
+    end
+
+    def get_label(label_url)
+      Request::Shipping.new(@credentials).get_label(label_url)
+    end
+
+    def details(shipping_id, mobo = @credentials.customer_number)
+      Request::Shipping.new(@credentials).details(shipping_id, mobo)
+    end
+
+    def void_shipment(shipping_id, mobo = @credentials.customer_number)
+      Request::Shipping.new(@credentials).void_shipping(shipping_id, mobo)
+    end
+
+    def manifest(options={})
+      Request::Manifest.new(@credentials, options).process_request
+    end
+
+    def registration_token
+      Request::Registration.new(@credentials).get_token
+    end
+
+  end
+end