parcel_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdcd9ebea24a37f29ed1417078791e96ae59470b
-  data.tar.gz: 10626cce08a88d97bd32692ad2aeb0eb3b67f095
+  metadata.gz: e278f6f435884f1fbb1a9cd7995ea76d3abe62d0
+  data.tar.gz: b15d8b9a3817821c4f2d9cb9d4ac26e014d45772
 SHA512:
-  metadata.gz: f959eed9357c58808b3305f5f5fbfb58fb32c7eec335c9614f40a9848af2d88bf02878fe0315478f13800e951428c4a1c9760373eb3555aad2831160607bc9e4
-  data.tar.gz: add3bf34df5be59889a28e7f091ac70547903f07fd914e7f671da025e149202d9be28679a909eaffbee0589dab2c72a3f96d8a6f58c86a1a1e45ab2d7d3b9a62
+  metadata.gz: 321f295e0e881ebe615e1bb1b565c47a816fafaf0a9b4123ea9f59eef47790d816f690855733560d54f0641296ec717a847ae134668a729a54b1c083fc99f969
+  data.tar.gz: 935c5fcc08fd7de9874371060bd5aa7aa505abe166d3032d28162b02714dcf422e6ef8522a3a18cce25bdb0de0ffcaed12cba2f27218d7824ebfbb65185579bb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parcel_api (1.0.0)
+    parcel_api (1.1.0)
       activesupport (~> 4.2)
       oauth2 (~> 1.0)
       recursive-open-struct (~> 0.6)

data/example/mock.rb

@@ -265,3 +265,17 @@ pickup_params = {
 pickup = ParcelApi::Pickup.new(client.connection) # use a custom connection
 pickup_results = pickup.create(pickup_params)
 pickup_results.to_h.each {|k, v| puts "#{k}: #{v}"}
+
+# Notification Example
+
+notification_params = {
+  tracking_reference: 'LE123454152NZ',
+  email: 'j.receiver@example.com',
+  receiver_first_name: 'John',
+  receiver_last_name: 'Receiver',
+  collection_location_id: '84320',
+}
+
+notification = ParcelApi::Notification.new
+notification_results = notification.create(notification_params)
+notification_results.to_h.each {|k, v| puts "#{k}: #{v}"}

data/lib/parcel_api.rb

@@ -6,6 +6,7 @@ require 'parcel_api/track'
 require 'parcel_api/label'
 require 'parcel_api/shipping_options'
 require 'parcel_api/pickup'
+require 'parcel_api/notification'
 require 'parcel_api/client'
 
 module ParcelApi; end

data/lib/parcel_api/notification.rb

@@ -0,0 +1,27 @@
+module ParcelApi
+
+  # Creates a PCD (collection point) subscription with provided delivery email address
+  # and tracking reference. Customers will receive an email when the parcel reaches the
+  # collection point and then subsequent reminders.
+
+  class Notification
+    PARCELNOTIFICATION_URL = '/parcelnotifications/v1/subscription/pcd'
+
+    # Creates a new ParcelApi::Notification instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Create a new parcel notification
+    # @param notification_options [Hash]
+    # @return Object of notification details
+
+    def create(notification_options)
+      response = @connection.post PARCELNOTIFICATION_URL, body: notification_options.to_json, headers: { 'Content-Type' => 'application/json' }
+      RecursiveOpenStruct.new(response.parsed, recurse_over_arrays: true)
+    end
+
+  end
+
+end

data/lib/parcel_api/version.rb

@@ -1,3 +1,3 @@
 module ParcelApi
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parcel_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -203,6 +203,7 @@ files:
 - lib/parcel_api/cli.rb
 - lib/parcel_api/client.rb
 - lib/parcel_api/label.rb
+- lib/parcel_api/notification.rb
 - lib/parcel_api/pickup.rb
 - lib/parcel_api/shipping_options.rb
 - lib/parcel_api/track.rb