dhl_freight_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14f4f30f6bfbda380d164874d31076aacfc12e25795e909abd671506c0aef68b
+  data.tar.gz: 2357e6b0d4c2acc36f995d21cd79ed014511b9cf8f71e4abe1e1c0d226af5813
+SHA512:
+  metadata.gz: 2405c87e851d577d1cf70665b3d2a7806d9da4b983f03f25ff11f18916893bc18a8a568002737345af8d0f01e70fe4744759f142272de65d4615fc18171a9e24
+  data.tar.gz: 925bb2695c16eb0b4c7aae80efa26cd4b66b492559da73521275d7261bdc4dace209c841b984391ffe7ba5516bcbce80be117b0caece9e7abfea470e7f644db1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-03-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Andy Chong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# DhlFreightApi
+
+A Ruby gem wrapper for the DHL Freight API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add dhl_freight_api
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install dhl_freight_api
+```
+
+## Usage
+
+Initialize the client with your DHL Freight `client-key`:
+
+```ruby
+client = DhlFreightApi::Client.new(
+  "YOUR_CLIENT_KEY",
+  prod: false # false => test, true => production
+)
+```
+
+### Environment Domains
+
+- `prod: false` uses `https://test-api.freight-logistics.dhl.com`
+- `prod: true` uses `https://api.freight-logistics.dhl.com`
+
+### Error Handling
+
+API failures raise `DhlFreightApi::Error`.
+
+```ruby
+begin
+  client.shipment_booking.create(payload)
+rescue DhlFreightApi::Error => error
+  puts error.message
+  puts error.response_http_code
+  puts error.response_body
+end
+```
+
+The wrapper raises on:
+
+- non-2xx HTTP responses
+- business validation responses with `status: "Error"` from ShipmentBooking (even when HTTP is `200`)
+
+### Shipment Booking
+
+Create a shipment booking:
+
+```ruby
+payload = {
+  "id" => "",
+  "productCode" => "107",
+  "totalNumberOfPieces" => 1,
+  "totalWeight" => 10,
+  "totalVolume" => 0.05,
+  "references" => [{ "qualifier" => "CU", "value" => "Elin000123" }],
+  "payerCode" => { "code" => "001" },
+  "parties" => [
+    {
+      "id" => "111111",
+      "type" => "Consignee",
+      "name" => "Consignor Company AB",
+      "address" => {
+        "street" => "Gustav III:s Boulevard 18",
+        "cityName" => "Solna",
+        "postalCode" => "16973",
+        "countryCode" => "SE"
+      },
+      "phone" => "+46701234567",
+      "email" => "name@consignorcompany.se"
+    }
+  ],
+  "pieces" => [
+    {
+      "packageType" => "PKT",
+      "numberOfPieces" => 1,
+      "weight" => 10,
+      "volume" => 0.05,
+      "length" => 30,
+      "width" => 20,
+      "height" => 15
+    }
+  ]
+}
+
+booking = client.shipment_booking.create(payload)
+
+puts booking.status
+puts booking.transport_instruction.id
+puts booking.raw
+```
+
+### Print Documents
+
+Request print documents by shipment IDs:
+
+```ruby
+payload = {
+  "shipmentIds" => ["2906221086"],
+  "options" => {
+    "label" => true,
+    "shipmentList" => false,
+    "waybill" => false,
+    "guarantee" => false,
+    "returnLabel" => false,
+    "licensePlateBarCode" => "GS1",
+    "pageOptions" => {
+      "pageType" => "Label",
+      "marginLeft" => 0,
+      "marginTop" => 0,
+      "padding" => 0
+    }
+  }
+}
+
+print_result = client.print.documents_by_id(payload)
+
+# Raw base64 string is preserved as-is
+base64_pdf = print_result.reports.first.content
+puts base64_pdf[0..30]
+```
+
+To decode outside the wrapper:
+
+```ruby
+require "base64"
+
+binary_pdf = Base64.decode64(base64_pdf)
+File.binwrite("label.pdf", binary_pdf)
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andychong/dhl_freight_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/andychong/dhl_freight_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DhlFreightApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andychong/dhl_freight_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/dhl_freight_api/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module DhlFreightApi
+  class Client
+    def initialize(client_key, prod: false)
+      @client_key = client_key
+      @prod = prod
+    end
+
+    def base_url
+      if @prod
+        "https://api.freight-logistics.dhl.com"
+      else
+        "https://test-api.freight-logistics.dhl.com"
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new do |f|
+        f.request :json
+        f.response :json
+        f.headers["client-key"] = @client_key
+        f.headers["Content-Type"] = "application/json"
+      end
+    end
+
+    def shipment_booking
+      Resources::ShipmentBooking.new(self)
+    end
+
+    def print
+      Resources::Print.new(self)
+    end
+  end
+end

data/lib/dhl_freight_api/objects/base.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/string"
+require "ostruct"
+
+module DhlFreightApi
+  module Objects
+    class Base < OpenStruct
+      attr_reader :original_response
+
+      def initialize(attributes)
+        @original_response = deep_freeze_object(attributes)
+        super(to_ostruct(attributes))
+      end
+
+      def to_ostruct(obj)
+        if obj.is_a?(Hash)
+          OpenStruct.new(obj.transform_keys { |key| key.to_s.underscore }.transform_values { |val| to_ostruct(val) })
+        elsif obj.is_a?(Array)
+          obj.map { |o| to_ostruct(o) }
+        else
+          obj
+        end
+      end
+
+      def to_hash
+        ostruct_to_hash(self)
+      end
+
+      def raw
+        @original_response
+      end
+
+      private
+
+      def deep_freeze_object(obj)
+        case obj
+        when Hash
+          obj.transform_values { |value| deep_freeze_object(value) }.freeze
+        when Array
+          obj.map { |item| deep_freeze_object(item) }.freeze
+        else
+          obj.respond_to?(:freeze) ? obj.freeze : obj
+        end
+      end
+
+      def ostruct_to_hash(object)
+        case object
+        when OpenStruct
+          hash = object.to_h.except(:table)
+          hash.transform_keys(&:to_s).transform_values { |value| ostruct_to_hash(value) }
+        when Array
+          object.map { |item| ostruct_to_hash(item) }
+        when Hash
+          object.transform_keys(&:to_s).transform_values { |value| ostruct_to_hash(value) }
+        else
+          object
+        end
+      end
+    end
+  end
+end

data/lib/dhl_freight_api/objects/print.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DhlFreightApi
+  module Objects
+    class Print < Base
+    end
+  end
+end

data/lib/dhl_freight_api/objects/shipment_booking.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DhlFreightApi
+  module Objects
+    class ShipmentBooking < Base
+    end
+  end
+end

data/lib/dhl_freight_api/resources/print.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DhlFreightApi
+  module Resources
+    class Print
+      def initialize(client)
+        @client = client
+      end
+
+      def base_url
+        "#{@client.base_url}/printapi/v1/print/printdocumentsbyid"
+      end
+
+      def documents_by_id(payload)
+        response = @client.connection.post(base_url, payload)
+
+        if response.success?
+          Objects::Print.new(response.body)
+        else
+          raise DhlFreightApi::Error.new(
+            "Failed to print documents by ID: #{response.status} - #{response.body}",
+            response_http_code: response.status,
+            response_body: response.body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dhl_freight_api/resources/shipment_booking.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DhlFreightApi
+  module Resources
+    class ShipmentBooking
+      def initialize(client)
+        @client = client
+      end
+
+      def base_url
+        "#{@client.base_url}/transportinstructionapi/v1/transportinstruction/sendtransportinstruction"
+      end
+
+      def create(payload)
+        response = @client.connection.post(base_url, payload)
+
+        if response.success?
+          handle_business_response(response)
+        else
+          raise_error("Failed to create shipment booking", response)
+        end
+      end
+
+      private
+
+      def handle_business_response(response)
+        if response.body.is_a?(Hash) && response.body["status"] == "Error"
+          raise_error("Shipment booking returned business validation errors", response)
+        end
+
+        Objects::ShipmentBooking.new(response.body)
+      end
+
+      def raise_error(message, response)
+        raise DhlFreightApi::Error.new(
+          "#{message}: #{response.status} - #{response.body}",
+          response_http_code: response.status,
+          response_body: response.body
+        )
+      end
+    end
+  end
+end

data/lib/dhl_freight_api/version.rb

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

data/lib/dhl_freight_api.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "dhl_freight_api/version"
+require_relative "dhl_freight_api/objects/base"
+require_relative "dhl_freight_api/objects/shipment_booking"
+require_relative "dhl_freight_api/objects/print"
+require_relative "dhl_freight_api/client"
+require_relative "dhl_freight_api/resources/shipment_booking"
+require_relative "dhl_freight_api/resources/print"
+
+module DhlFreightApi
+  class Error < StandardError
+    attr_reader :response_http_code, :response_body
+
+    def initialize(message = nil, response_http_code: nil, response_body: nil)
+      @response_http_code = response_http_code
+      @response_body = response_body
+      super(message)
+    end
+  end
+end

data/sig/dhl_freight_api.rbs

@@ -0,0 +1,44 @@
+module DhlFreightApi
+  VERSION: String
+
+  class Error < ::StandardError
+    attr_reader response_http_code: Integer?
+    attr_reader response_body: untyped
+
+    def initialize: (?String message, ?response_http_code: Integer, ?response_body: untyped) -> void
+  end
+
+  class Client
+    def initialize: (String client_key, ?prod: bool) -> void
+    def base_url: -> String
+    def connection: -> untyped
+    def shipment_booking: -> Resources::ShipmentBooking
+    def print: -> Resources::Print
+  end
+
+  module Objects
+    class Base
+      def initialize: (untyped attributes) -> void
+      def to_hash: -> Hash[String, untyped]
+      def raw: -> untyped
+    end
+
+    class ShipmentBooking < Base
+    end
+
+    class Print < Base
+    end
+  end
+
+  module Resources
+    class ShipmentBooking
+      def initialize: (Client client) -> void
+      def create: (Hash[String, untyped] payload) -> Objects::ShipmentBooking
+    end
+
+    class Print
+      def initialize: (Client client) -> void
+      def documents_by_id: (Hash[String, untyped] payload) -> Objects::Print
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: dhl_freight_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Chong
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides a Ruby interface for DHL Freight APIs including Shipment Booking
+  and Print.
+email:
+- andygg1996personal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dhl_freight_api.rb
+- lib/dhl_freight_api/client.rb
+- lib/dhl_freight_api/objects/base.rb
+- lib/dhl_freight_api/objects/print.rb
+- lib/dhl_freight_api/objects/shipment_booking.rb
+- lib/dhl_freight_api/resources/print.rb
+- lib/dhl_freight_api/resources/shipment_booking.rb
+- lib/dhl_freight_api/version.rb
+- sig/dhl_freight_api.rbs
+homepage: https://github.com/andychong/dhl_freight_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andychong/dhl_freight_api
+  source_code_uri: https://github.com/andychong/dhl_freight_api
+  changelog_uri: https://github.com/andychong/dhl_freight_api/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the DHL Freight API.
+test_files: []