dhl_ecommerce_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6997d6fa361fe163afb7ce2d69325ad6cd20f8d3902cbc6b51c891b910766160
-  data.tar.gz: 231ba82b1d8507a15b1b3e4883451473ddd8d431726aece3c755d5ff523a7b9d
+  metadata.gz: 70b103b3e293f5bf2eadc1523941aae5fac275aec3938992f8783aadd9453923
+  data.tar.gz: 77a6ffb5fd07addba613727d388fe7ab526aa8d7a712731eb43783c128e4824f
 SHA512:
-  metadata.gz: 30db0bcf3d8c54f66923af39e39f38996a7de36943d4834fd20ee716dd915a2cd84f147bfd589e8644fc1e7381190e59b3b7c25b97d2753bb2a13c8901a76a31
-  data.tar.gz: '08607e7d379b167cd469f43a4bded2606b4dedc6994bc5a8f24fe40f094c6c9d1a68ca9dd04afdbea091a5afb84d7a7e908535150aad8277207d2cb377e8d681'
+  metadata.gz: 24eb00b962f86ec2ad509745f7fc36392d8c209a745444042594a38811f64045e6009a73006a40adf5ca32aa14d435cfd9920632ebf5725a269be8237c7fa170
+  data.tar.gz: ac57594eedff7e8e5cce2818864e9d6ce1c5ce13a9cfc57251c3b9c1040fc3168c93ae8c2a8acce64c81c95126ca3c1b24cbcaf35b1984e8c5ceec126fc0c0d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dhl_ecommerce_api (0.1.0)
+    dhl_ecommerce_api (0.1.1)
       activeresource (>= 4.1.0, < 6.0.0)
 
 GEM

data/README.md

@@ -4,7 +4,7 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 TODO: Delete this and the text above, and describe your gem
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -20,33 +20,156 @@ Or install it yourself as:
 
     $ gem install dhl_ecommerce_api
 
-## Configuration
+# Configuration
 In `config/initializers` create a `dhl_ecommerce_api.rb` config file
 ```ruby
 DHLEcommerceAPI.configure do |config|
-  config.env = ENV["DHL_ECOMMERCE_API_ENV"]
   config.client_id = ENV["DHL_ECOMMERCE_API_CLIENT_ID"]
   config.password = ENV["DHL_ECOMMERCE_API_PASSWORD"]
+  config.pickup_account_id = ENV["DHL_ECOMMERCE_API_PICKUP_ACCOUNT_ID"]
+  config.sold_to_account_id = ENV["DHL_ECOMMERCE_API_SOLD_TO_ACCOUNT_ID"]
+
+  # optional, will refer to Rails.env
+  # config.env = ENV["DHL_ECOMMERCE_API_ENV"]
 end
 ```
-## Usage
-### Create Shipment
+# Usage
+## Create Shipment with Pickup
+[DHL Shipment Documentation](https://sandbox.dhlecommerce.asia/API/docs/v2/pickup.html)
+```ruby
+# Shipment::Pickup params
+{
+  "pickup_date_time": DateTime.now.to_s,
+  "pickup_address": {
+    "company_name": "Pickup From Company",
+    "name": "Pickup From Name",
+    "address1": "Holistic Pharmacy PostCo, 55, Jalan Landak",
+    "city": " Kuala Lumpur",
+    "state": " Kuala Lumpur",
+    "post_code": "55100",
+    "country": "MY",
+    "phone": "0123456789",
+    "email": "hello@example.com"
+  },
+  "shipment_items": [
+    {
+      "shipment_id": "MYPTC00001", # unique
+      "package_desc": "Laptop Sleeve", 
+      "total_weight": 500,
+      "total_weight_uom": "G",
+      "dimension_uom": "CM",
+      "product_code": "PDO",
+      "total_value": 300,
+      "currency": "MYR",
+      "is_routing_info_required": "Y",
+      "consignee_address": {
+        "company_name": "Sleeve Company",
+        "name": "Sleeve Sdn Bhd",
+        "address1": "No. 3, Jalan Bangsar, Kampung Haji Abdullah Hukum",
+        "city": "Kuala Lumpur",
+        "state": "Kuala Lumpur",
+        "country": "MY",
+        "postCode": "57000",
+        "phone": "0123456789"
+      }
+    },
+  ]
+}
+```
+
 ```ruby
-DHLEcommerceAPI::Shipment.create(params)
+DHLEcommerceAPI::Shipment::Pickup.create(params)
+```
+
+
+## Create Shipment w/o Pickup
+Create a Shipment in DHLs system only. Used when we want to create a Shipment but not book a pickup. I.e. Generate the Shipment label for customers to print. (Use in conjunction with Pickup API.)
+```ruby
+# Shipment::Dropoff params
+{
+  "shipment_items" => [
+    { 
+      "shipment_id" => "MYPTC00002", # unique
+      "package_desc" => "Bread Materials",
+      "total_weight" => 2000,
+      "total_weight_uom" => "G",
+      "dimension_uom" => "CM",
+      "product_code" => "PDO",
+      "total_value" => 300,
+      "currency" => "MYR",
+      "is_routing_info_required" => "Y",
+      "consignee_address" => { 
+        "company_name" => "Test",
+        "name" => "Test1",
+        "address1" => "NO 3 JALAN PPU 1",
+        "address2" => "TAMAN PERINDUSTRIAN PUCHONG UTAMA",
+        "city" => "PUCHONG",
+        "state" => "SELANGOR",
+        "country" => "MY",
+        "post_code" => "57000",
+        "phone" => "0123456798"
+      }
+    }
+  ]
+}
+```
+
+```ruby
+DHLEcommerceAPI::Shipment::Dropoff.create(params)
+```
+
+## Create Pickup
+DHL will send a courier to pickup parcels from the `shipper_details` address. The courier will only pickup parcels with a valid DHL label.
+
+[DHL Pickup Documentation](https://sandbox.dhlecommerce.asia/API/docs/v2/pickup.html)
+
+```ruby
+# Pickup params
+{
+  "handover_items": [
+    {
+      "pickup_date": "2022-03-09",
+      "pickup_start_time": "09:00",
+      "pickup_end_time": "18:00",
+      "shipment_type": "1",
+      "shipper_details": {
+        "company": "PostCo",
+        "name": "PostCo",
+        "phone_number": "0123456789",
+        "address_line_1": "No 31, Jalan 123/123",
+        "city": "Petaling Jaya",
+        "state": "Selangor",
+        "postal_code": "57000",
+        "country": "MY",
+      },
+      "shipments": {
+        "quantity": 1,
+        "totalWeight": 100
+      }
+    }
+  ]
+}
 ```
-### Create Pickup
 ```ruby
 DHLEcommerceAPI::Pickup.create(params)
 ```
+## Tracking
+[DHL Tracking Documentation](https://sandbox.dhlecommerce.asia/API/docs/v2/pickup.html)
+```ruby
+DHLEcommerceAPI::Tracking.find('MYPOS0001') 
+# => [ShipmentItem]
+```
 
-### Tracking
 ```ruby
-DHLEcommerceAPI::Tracking.track(array_of_string_tracking_numbers)
+DHLEcommerceAPI::Tracking.find(['MYPOS0001', 'MYPOS0002']) 
+# => [...ShipmentItems]
 ```
 
 
-## Development
+___
 
+
+## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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).

data/dhl_ecommerce_api.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/dhl_ecommerce_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dhl_ecommerce_api"
+  spec.version = DHLEcommerceAPI::VERSION
+  spec.authors = ["Er Whey"]
+  spec.email = ["erwhey@postco.co"]
+
+  spec.summary = "Unofficial Ruby object based DHL eCommerce API wrapper."
+  spec.description = "Unofficial Ruby object based DHL eCommerce API wrapper."
+  spec.homepage = "https://github.com/PostCo/dhl_ecommerce_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PostCo/dhl_ecommerce_api"
+  spec.metadata["changelog_uri"] = "https://github.com/PostCo/dhl_ecommerce_api/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "activeresource", ">= 4.1.0", "< 6.0.0"
+  
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry", "~> 0.14.1"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "gem-release"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dhl_ecommerce_api/resources/shipment.rb

@@ -78,8 +78,8 @@ end
 #     "state": " Kuala Lumpur",
 #     "postCode": "55100",
 #     "country": "MY",
-#     "phone": "0169822645",
-#     "email": "erwhey@postco.co"
+#     "phone": "0123456789",
+#     "email": "hello@example.com"
 #   },
 #   "shipmentItems": [
 #     {

data/lib/dhl_ecommerce_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DHLEcommerceAPI
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhl_ecommerce_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Er Whey
@@ -130,6 +130,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- dhl_ecommerce_api.gemspec
 - lib/dev/config.rb
 - lib/dev/zeitwerk_loader.rb
 - lib/dhl_ecommerce_api.rb