dhl_api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b9e7851e32f915f557f1f81c90d0e2b7b9ef7f5eae20e9d8613ccff62de0d77
-  data.tar.gz: 3888aef749658440d8190416d2ff1b82e5b725b974f6634457ab40d7e9d952ea
+  metadata.gz: 926c694d2d3c2c5f278c62e10f8aa014b86480f8d2f3207f7fe42ab8891febd0
+  data.tar.gz: 838f29f55a1693c6d007537b65c970a1e59e5c4ce45d54775eb818f658668b1f
 SHA512:
-  metadata.gz: 286fd63847484916402a2ad6edb8f67325e283fd22f48415e91279bad0ad1b38310ffb4ca85757f556a86aa4aff2692163698ce59ce32dc1d522e7932b6bd29a
-  data.tar.gz: 617b1f4841fe8721f79e7210485bd74b53452330304a1663b21fc45eab66fe1bdd763e671a4d9a876adb75fe6d4b01187bf1922ecddfdb85f2f603b3f60b397d
+  metadata.gz: bc318898989145a21275132969bf2e891d86e9cba18117f58ba2db428152d1b249099595828b4a9c9b9ddffab65a057d3290ce22c5ac9e664a36e1084898c559
+  data.tar.gz: 6dd5d180bb173446a7bde4e21188c2d50ae0ee8e697141bf22ef4e56fa4fd191f0048e762f8b51299d23aa39d0dccd246eb7fcc34d51046f8a9daf9308a584f1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
-## [Unreleased]
+## [0.1.2] - 2023-06-27
 
-## [0.1.0] - 2023-06-22
+- Transform payload keys to lowerCamel before send.
+
+## [0.1.1] - 2023-06-26
+
+- Rename DHL constant to DHLAPI
+- Rename dhl to dhl_api
+
+## [0.1.0] - 2023-06-26
 
 - Initial release
+- Add Retoure label creation
+- Add Unified Tracking

data/Gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in dhl.gemspec
+# Specify your gem's dependencies in dhl_api.gemspec
 gemspec
 
 gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dhl (0.1.0)
+    dhl_api (0.1.0)
       activesupport (>= 4.0.2)
       http (~> 5.0)
 
@@ -142,7 +142,7 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
-  dhl!
+  dhl_api!
   dotenv
   gem-release
   guard-rspec

data/README.md

@@ -1,15 +1,13 @@
-# DHL
+# DHL API
 
-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/dhl`. 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 a Ruby API wrapper for DHL. Right now, we only cover Retoure & Tracking. Feel free to extend the gem t cover more DHL services.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dhl'
+gem 'dhl_api'
 ```
 
 And then execute:
@@ -18,25 +16,25 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install dhl
+    $ gem install dhl_api
 
 ## Usage
 
 ```ruby
-DHL.configure do |config|
+DHLAPI.configure do |config|
     config.api_key = "your api key"
     config.testing = true # or false
 end
 
-# DHL Retoure
+# DHL Retoure (https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany)
 #
-retoure_client = DHL::RetoureClient.new(username: 'retoure username', password: 'retoure password')
+retoure_client = DHLAPI::RetoureClient.new(username: 'retoure username', password: 'retoure password')
 #
 # OR if you only creating label for 1 account all the time,
-# you can set the ENV variables: DHL_RETOURE_USERNAME, DHL_RETOURE_PASSWORD,
+# you can set the ENV variables: DHLAPI_RETOURE_USERNAME, DHLAPI_RETOURE_PASSWORD,
 # and then just initialize the client like below:
 #
-# retoure_client = DHL::RetoureClient.new
+# retoure_client = DHLAPI::RetoureClient.new
 
 label = retoure_client.create_label(
   "receiver_id": 'deu',
@@ -49,7 +47,7 @@ label = retoure_client.create_label(
     "address_street": 'Charles-de-Gaulle Str.',
     "address_house": '20',
     "city": 'Bonn',
-    "email": 'Max.Mustermann@dhl.local',
+    "email": 'Max.Mustermann@dhl_api.local',
     "phone": '+49 421 987654321',
     "postal_code": '53113',
     "state": 'NRW'
@@ -64,15 +62,15 @@ label = retoure_client.create_label(
   }
 )
 
-# DHL Tracking
+# Tracking (https://developer.dhl.com/api-reference/shipment-tracking)
 #
-track_client=DHL::TrackingClient.new
+track_client=DHLAPI::TrackingClient.new
 # Also accept service:, origin_country_code:, requester_country_code:
-tracking = track_client.track(tracking_number: 611665700181)
+tracking = track_client.track(tracking_number: '420025369374810912402173942693')
 
 # You can access the raw response by calling by calling the #response:
 retoure_client.response
-tracking_client.response
+track_client.response
 # It is a HTTP::Response object. See https://github.com/httprb/http/wiki/Response-Handling for more info.
 
 # You can access the raw attributes before the keys is parsed to snake_case by calling the #attributes:
@@ -88,7 +86,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/postco/dhl. 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/dhl/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/postco/dhl_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/dhl_api/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -96,4 +94,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DHL project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/postco/dhl/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the DHLAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/postco/dhl_api/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -6,7 +6,7 @@ require 'bundler/setup'
 require 'dotenv/load'
 require 'dev/zeitwerk_loader'
 require 'dev/config'
-require 'dhl'
+require 'dhl_api'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/dev/config.rb

@@ -1,7 +1,7 @@
 require 'dotenv/load'
 
 def set_config
-  DHL.configure do |config|
+  DHLAPI.configure do |config|
     config.api_key = ENV['API_KEY']
   end
 end

data/lib/dev/zeitwerk_loader.rb

@@ -3,11 +3,11 @@ require_relative 'config'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
-  'dhl' => 'DHL'
+  'dhl_api' => 'DHLAPI'
 )
 loader.push_dir('./lib')
-loader.collapse('./lib/dhl/clients')
-loader.collapse('./lib/dhl/objects')
+loader.collapse('./lib/dhl_api/clients')
+loader.collapse('./lib/dhl_api/objects')
 loader.ignore("#{__dir__}/config.rb")
 loader.enable_reloading
 # loader.log!

data/lib/{dhl → dhl_api}/clients/base_client.rb

@@ -1,12 +1,12 @@
 require 'http'
 
-module DHL
+module DHLAPI
   class BaseClient
     attr_writer :http_client
     attr_reader :response
 
     def connection
-      @connection ||= HTTP.headers(content_type: 'application/json', dhl_api_key: DHL.config.api_key)
+      @connection ||= HTTP.headers(content_type: 'application/json', dhl_api_key: DHLAPI.config.api_key)
     end
 
     private
@@ -14,7 +14,7 @@ module DHL
     attr_writer :response
 
     def url
-      DHL.config.testing ? self.class::TEST_URL : self.class::URL
+      DHLAPI.config.testing ? self.class::TEST_URL : self.class::URL
     end
 
     def handle_response
@@ -33,7 +33,7 @@ module DHL
         raise Error, "The API rate limit for your application has been exceeded. #{error_message}"
       when 500
         raise Error,
-              "An unhandled error with the . Contact the DHL team if problems persist. #{error_message}"
+              "An unhandled error with the . Contact the DHLAPI team if problems persist. #{error_message}"
       when 503
         raise Error,
               "API is currently unavailable – typically due to a scheduled outage – try again soon. #{error_message}"

data/lib/{dhl → dhl_api}/clients/retoure_client.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class RetoureClient < BaseClient
     URL = 'https://api-eu.dhl.com/parcel/de/shipping/returns/v1/orders'
     TEST_URL = 'https://api-sandbox.dhl.com/parcel/de/shipping/returns/v1/orders'
@@ -17,7 +17,8 @@ module DHL
     attr_accessor :label_type
 
     def create_label(attributes = {})
-      self.response = connection.post(url, json: attributes, params: { labelType: label_type })
+      payload = attributes.deep_transform_keys { |key| key.to_s.camelize(:lower) }
+      self.response = connection.post(url, json: payload, params: { labelType: label_type })
       RetoureLabel.new handle_response.parse
     end
 
@@ -28,11 +29,11 @@ module DHL
     private
 
     def username
-      @username ||= ENV['DHL_RETOURE_USERNAME']
+      @username ||= ENV['DHLAPI_RETOURE_USERNAME']
     end
 
     def password
-      @password ||= ENV['DHL_RETOURE_PASSWORD']
+      @password ||= ENV['DHLAPI_RETOURE_PASSWORD']
     end
   end
 end

data/lib/{dhl → dhl_api}/clients/tracking_client.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class TrackingClient < BaseClient
     URL = 'https://api-eu.dhl.com/track/shipments'
     TEST_URL = 'https://api-test.dhl.com/track/shipments'

data/lib/{dhl → dhl_api}/configuration.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class Configuration
     attr_accessor :api_key, :testing
   end
@@ -16,7 +16,7 @@ module DHL
     def after_configure
       config.testing ||= false
 
-      # register special mime type for DHL error responses
+      # register special mime type for DHLAPI error responses
       HTTP::MimeType.register_adapter 'application/problem+json', HTTP::MimeType::JSON
     end
   end

data/lib/{dhl → dhl_api}/error.rb

@@ -1,3 +1,3 @@
-module DHL
+module DHLAPI
   class Error < StandardError; end
 end

data/lib/{dhl → dhl_api}/objects/base_object.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class BaseObject < OpenStruct
     attr_reader :attributes
 

data/lib/{dhl → dhl_api}/objects/retoure_label.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class RetoureLabel < BaseObject
   end
 end

data/lib/{dhl → dhl_api}/objects/tracking.rb

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   class Tracking < BaseObject
   end
 end

data/lib/{dhl → dhl_api}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module DHL
-  VERSION = '0.1.0'
+module DHLAPI
+  VERSION = '0.1.2'
 end

data/lib/dhl_api.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'dhl_api/version'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+
+require 'http'
+
+module DHLAPI
+  require 'dhl_api/configuration'
+
+  autoload :Error, 'dhl_api/error'
+
+  autoload :BaseClient, 'dhl_api/clients/base_client'
+  autoload :RetoureClient, 'dhl_api/clients/retoure_client'
+  autoload :TrackingClient, 'dhl_api/clients/tracking_client'
+
+  autoload :BaseObject, 'dhl_api/objects/base_object'
+  autoload :RetoureLabel, 'dhl_api/objects/retoure_label'
+  autoload :Tracking, 'dhl_api/objects/tracking'
+end

data/sig/dhl_api.rbs

@@ -1,4 +1,4 @@
-module DHL
+module DHLAPI
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhl_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-26 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,25 +143,25 @@ files:
 - bin/setup
 - lib/dev/config.rb
 - lib/dev/zeitwerk_loader.rb
-- lib/dhl.rb
-- lib/dhl/clients/base_client.rb
-- lib/dhl/clients/retoure_client.rb
-- lib/dhl/clients/tracking_client.rb
-- lib/dhl/configuration.rb
-- lib/dhl/error.rb
-- lib/dhl/objects/base_object.rb
-- lib/dhl/objects/retoure_label.rb
-- lib/dhl/objects/tracking.rb
-- lib/dhl/version.rb
+- lib/dhl_api.rb
+- lib/dhl_api/clients/base_client.rb
+- lib/dhl_api/clients/retoure_client.rb
+- lib/dhl_api/clients/tracking_client.rb
+- lib/dhl_api/configuration.rb
+- lib/dhl_api/error.rb
+- lib/dhl_api/objects/base_object.rb
+- lib/dhl_api/objects/retoure_label.rb
+- lib/dhl_api/objects/tracking.rb
+- lib/dhl_api/version.rb
 - sig/dhl_api.rbs
-homepage: https://github.com/PostCo/dhl
+homepage: https://github.com/PostCo/dhl_api
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/PostCo/dhl
-  source_code_uri: https://github.com/PostCo/dhl
-  changelog_uri: https://github.com/PostCo/dhl/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/PostCo/dhl_api
+  source_code_uri: https://github.com/PostCo/dhl_api
+  changelog_uri: https://github.com/PostCo/dhl_api/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -180,5 +180,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Ruby API Wrapper for DHL
+summary: Ruby API Wrapper for DHL API
 test_files: []

data/lib/dhl.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'dhl/version'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/string/inflections'
-
-require 'http'
-
-module DHL
-  require 'dhl/configuration'
-
-  autoload :Error, 'dhl/error'
-
-  autoload :BaseClient, 'dhl/clients/base_client'
-  autoload :RetoureClient, 'dhl/clients/retoure_client'
-  autoload :TrackingClient, 'dhl/clients/tracking_client'
-
-  autoload :BaseObject, 'dhl/objects/base_object'
-  autoload :RetoureLabel, 'dhl/objects/retoure_label'
-  autoload :Tracking, 'dhl/objects/tracking'
-
-end