inpost_uk_api 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a4173972e8bd2ba21493c62ddc469b523e8d5ce5e06f5dcc533037556eacfa
-  data.tar.gz: 30fab7c9f3b86cf249153c55c8d7559c1dfaad953d41ea32579ee00425698054
+  metadata.gz: e1e46d004bdcb1a0136cfb1cc2d45ddfd453eb96b0db8ee6849a1eb7ffb63e24
+  data.tar.gz: 38499fbfd6de6a2ceafa8dd847f41b32d5a22f6ef7d8a27573747e09cd9846db
 SHA512:
-  metadata.gz: '059e75f99fcb60131555089b9d5210e01ab002e3db6b1a4cdcea818ddb1856a76a728d930bf6b0bafb64e5cd2036dba3acfa41826d65cd9b7d6e8d30f7ba6608'
-  data.tar.gz: c488fb94973cdb6a92f93c4a0285f9b304878b14e8dca6efde76dd051337340a9146128304b1646045969d92e63b469451ef6d09c2cbcdea16a3b5c79a639cea
+  metadata.gz: ef748dc4b5389b7b500ebba112b8700c572689dc8cd012bdfe6461e66a3bc62678b55ab4f4b9f4706d4b317300799f7ea60b211bd732a9b542a25a1530a1d4a6
+  data.tar.gz: bee2421b55233a6c5ea6567227a564357036cd62c16cc218f9cc6ce8c6109ce44aeeded74cc951789c27ba09581597b7e9024aa4f76c987e043779ef9c6d9a52

data/.env.sample

@@ -0,0 +1,3 @@
+RETAILER=
+API_TOKEN=
+SITE=

data/Gemfile.lock

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

data/README.md

@@ -1,9 +1,5 @@
 # InPostUKAPI
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/inpost_uk_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+This is an unofficial Ruby API wrapper for `https://developers.inpost.co.uk/`
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,8 +17,57 @@ Or install it yourself as:
     $ gem install inpost_uk_api
 
 ## Usage
+### Returns
+#### Create a Returns Request
+Doc: https://developers.inpost.co.uk/#operation/createReturns
+```ruby
+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
+
+re.id # => "CS0000000009778"
+re.status # => "customer_delivering
+```
+#### Get Returns QR Code
+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\":{}}"
 
-TODO: Write usage instructions here
+    # 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
+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")
+CS0000000009778_trackings = tracking.CS0000000009778
+CS0000000009778_trackings.first.ts # => "29/03/2021 15:43:56pm"
+CS0000000009778_trackings.first.description # => "Ready For Dispatch"
+
+# Can query for multiple parcels by separating the ids by ";".
+tracking = InPostUKAPI::Tracking.where("CS0000000009778;CS0000000009777;CSDDD")
+CSDDD_trackings = tracking.CSDDD
+CSDDD_trackings.error # => "No events found for consignment CSDDD"
+```
 
 ## Development
 
@@ -30,9 +75,21 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Pending Endpoints
+- [ ] [APM Locations API](https://developers.inpost.co.uk/#tag/APM-Locations-API)
+   - [ ] [getAPMLocations](https://developers.inpost.co.uk/#operation/getAPMLocations)
+- [ ] [Address to Locker Label Creation](https://developers.inpost.co.uk/#tag/Address-to-Locker-Label-Creation)
+    - [ ] [Create Address to Locker Label](https://developers.inpost.co.uk/#operation/addressToLocker)
+    - [ ] [Pay for Address to Locker Parcel](https://developers.inpost.co.uk/#operation/addressToLockerPayment)
+    - [ ] [Get Address to Locker Parcel Label](https://developers.inpost.co.uk/#operation/getAddressToLockerLabel)
+- [ ] [Locker to Address Label Creation](https://developers.inpost.co.uk/#tag/Locker-to-Address-Label-Creation)
+    - [ ] [Create Locker to Address Label](https://developers.inpost.co.uk/#operation/lockerToAdddress)
+    - [ ] [Pay for Locker to Address Parcel](https://developers.inpost.co.uk/#operation/lockerToAddressPayment)
+    - [ ] [Get Locker to Address Parcel Label](https://developers.inpost.co.uk/#operation/getLockerToAddressLabel)
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/inpost_uk_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/inpost_uk_api/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/postco/inpost_uk_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/postco/inpost_uk_api/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +97,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the InPostUKAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/inpost_uk_api/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the InPostUKAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/postco/inpost_uk_api/blob/main/CODE_OF_CONDUCT.md).

data/bin/setup

@@ -3,6 +3,8 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
+cp .env.sample .env
+
 bundle install
 
 # Do any other automated setup that you need to do here

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/resources/return.rb

@@ -7,9 +7,10 @@ module InPostUKAPI
     DEFAULT_ATTRS = {
       sender_email: 'customer_email@inpost.co.uk',
       sender_phone: '7999999999',
-      size: 'A',
       customer_reference: 'customer reference number',
-      show_quick_send_code: 'true'
+      show_quick_send_code: 'false'
     }
+
+    validates_presence_of :sender_email, :sender_phone
   end
 end

data/lib/inpost_uk_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inpost_uk_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -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
@@ -143,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md