inpost_uk_api 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dda1cffb81e05a5949565a77a66129e85ee1265abd65ecb0c153f1d8f43f724
-  data.tar.gz: bd4b3ea8f0c8f10efeda5c2857a1f7a7da9ded6c81ddcb5716a3de5f3af3e66f
+  metadata.gz: 8ca535feef8feacc23eea8c863db020eaddce4b2e18605c8ecd902d094b19bf4
+  data.tar.gz: 8ae0307a7022ad320e2dc15e25bf759cf7a8681db35a07c95f98b238c44764ca
 SHA512:
-  metadata.gz: 7d5e923cbcc947a6bf8420498757998bfaf6cb3f640ba8bc78fcc731a484cfa4e9910265c725ed70e39452a6215ac5ade56c88a75e8947f297a5a7ce8ff33cf4
-  data.tar.gz: 77559295091da1a0c4fedcad2fbd4aa2a6d68203aaaad0d0f4cb1335b27cf657aa7ed04600244819180f04e416f4c7895976c45c93aa69a606793609e65265f4
+  metadata.gz: 4657f6257d958d733004523e7fd82f3fc61a6d563173531d49482a14072dfd1e6c3f52f23dec1c052efca0dd04b99525d86ad889833c9d4721266cd0ff3b97c4
+  data.tar.gz: de3171aec2b3f3a169178f39fc92d42dd478eac22b379a1fa74e6511be7cd1dbcce8d05343e1c11825329c1fb8d5423521f7bd67a0c5ad502d42b36ccb862ba3

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    inpost_uk_api (0.2.0)
-      activeresource (>= 6.0.0)
+    inpost_uk_api (0.2.1)
+      activeresource (>= 4.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -17,6 +17,15 @@ Or install it yourself as:
     $ gem install inpost_uk_api
 
 ## Usage
+### Configurations
+```ruby
+InPostUKAPI.configure do |config|
+    config.site = ENV['SITE']
+    config.retailer = ENV['RETAILER']
+    config.api_token = ENV['API_TOKEN']
+end
+```
+
 ### Returns
 #### Create a Returns Request
 Doc: https://developers.inpost.co.uk/#operation/createReturns
@@ -38,9 +47,24 @@ Doc: https://developers.inpost.co.uk/#operation/getReturnsLabel
 ```ruby
 label = InPostUKAPI::ReturnLabel.find("CS0000000009778")
 label # => a pdf blob string
+
+begin
+    invalid_label = InPostUKAPI::ReturnLabel.find("CS00000000ABC")
+rescue ActiveResource::ResourceNotFound => e
+    e.response.body # => "{\"status_code\":404,\"error_code\":\"return_not_found\",\"message\":\"Return CS0000000009778d not found.\",\"errors\":{}}"
+
+    # activeresource version >= 6.0.0
+    e.message # => Return CS00000000ABC not found.
+
+    # activeresource version < 6.0.0
+    e.message # => Failed.  Response code = 200.  Response message = OK.    
+end
 ```
-#### Request Tracking Data (only for PROD)
-The tracking data you got might not be the right one if you are querying using the Return id from the staging server.
+### Request Tracking Data
+This endpoint only available for PROD labels.
+
+The tracking data you got might not be the right one if you are querying using the tracking id from the staging server.
+
 Doc: https://developers.inpost.co.uk/#operation/getTracking
 ```ruby
 tracking = InPostUKAPI::Tracking.find("CS0000000009778")
@@ -53,6 +77,26 @@ tracking = InPostUKAPI::Tracking.where("CS0000000009778;CS0000000009777;CSDDD")
 CSDDD_trackings = tracking.CSDDD
 CSDDD_trackings.error # => "No events found for consignment CSDDD"
 ```
+### Temporary credentials
+You can use the `InPostUKAPI::Base.with_account` method which accept a block to set a temporary credentials. Useful for platform to set different InPost account for each retailer.
+
+Applicable to [Create a Returns Request](#create-a-returns-request) and [Get Returns QR Code](#get-returns-qr-code).
+```ruby
+re, label = nil
+account = {retailer: "temp@postco.co", api_token: "temp token 123" }
+InPostUKAPI::Base.with_account(account) do
+    re = InPostUKAPI::Return.new(
+        sender_email: "sender@postco.co",
+        sender_phone: "7999999999",
+        size: "A",
+        customer_reference: "customer reference number",
+        show_quick_send_code: "true"
+    )
+    re.save
+    label = InPostUKAPI::ReturnLabel.find(re.id)
+end
+```
+
 
 ## Development
 

data/lib/inpost_uk_api/configuration.rb

@@ -1,6 +1,6 @@
 module InPostUKAPI
   class Configuration
-    attr_accessor :site, :retailer
+    attr_accessor :site, :retailer, :api_token
   end
 
   class << self

data/lib/inpost_uk_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InPostUKAPI
-  VERSION = '0.2.1'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inpost_uk_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Andy Chong
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement