ninja_van_api 0.2.20 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf98d0353d3840d49fd319e69af2916a1b55562fd3ea0bc0b6213819b1b4197b
-  data.tar.gz: 7012d0cbc47bfb80ceba90efb3256ecbe21b8373811e2d1528a56eaf765f1135
+  metadata.gz: cb390bd629fd1de1252ecb49fec0d66c75fc3a53da90754c68d99e3670a6833c
+  data.tar.gz: f6c902441430971d6995f408e2aa7f322d3ece92517e1ab22b98bffb94cdde0d
 SHA512:
-  metadata.gz: 6df589c8bc14176fb7490b1a581aaa7434a8897aa323e9f200ea7605f7f37d758375c89b51d49396dc2d8404f9c07e85f1c252095194bd85687174fd54a83c97
-  data.tar.gz: 73bf32a5e80bf9c90b7e11ac46b092802ffcc4c3d1dd19b3a51dd5b78977b58e24fd9ab9c277568dda0186fe4cb8291610b2def277f7277a64ced7cea31f7813
+  metadata.gz: bc10c585a79c66643e72fb09ec692fc8451098bc056ef5078ab6ca5977167547724b2ef0cf00b56a177988f485cab14c2aaad73a3da60c8bc85be97e71a835b8
+  data.tar.gz: 4ca9516bf8002b51babfdabbafa99b0ced8de8d38d228c34d72764aa76e1029f9921bd0625873c1e914879b78c4beac2472717d35edda4f2a7c7b17a654ac70b

data/README.md

@@ -16,6 +16,38 @@ And then execute:
 
 ## Usage
 
+### Retrieving Waybills
+
+```ruby
+# Initialize the client
+client = NinjaVanApi::Client.new(
+  client_id: "your_client_id",
+  client_secret: "your_client_secret",
+  country_code: "SG",
+  test_mode: true
+)
+
+# Basic waybill retrieval
+waybill = client.waybills.get("TRACKING123")
+
+# Get waybill with optional parameters
+waybill = client.waybills.get(
+  "TRACKING123",
+  hide_shipper_details: true,  # Hide shipper's details in the waybill
+  orientation: "landscape"     # Set waybill orientation to landscape
+)
+
+# Access the PDF content
+pdf_content = waybill.pdf
+
+# Error handling
+begin
+  waybill = client.waybills.get("INVALID_TRACKING")
+rescue NinjaVanApi::Error => e
+  puts "Error retrieving waybill: #{e.message}"
+end
+```
+
 ### Mounting the Engine
 
 In your Rails application's `config/routes.rb`, mount the webhook engine. You can mount it multiple times with different country paths. For example:

data/app/controllers/ninja_van_api/webhooks_controller.rb

@@ -7,11 +7,12 @@ module NinjaVanApi
       if NinjaVanApi.configuration.webhook_job_class
         klass =
           begin
-            job_class.constantize
+            NinjaVanApi.configuration.webhook_job_class.constantize
           rescue NameError
             raise ArgumentError,
                   "webhook_job_class must be an ActiveJob class name or class that responds to perform_later"
           end
+
         klass.perform_later(webhook_params.to_h)
         head :ok
       else
@@ -27,8 +28,8 @@ module NinjaVanApi
 
     def verify_webhook_signature
       # Extract country code from the request path
-      # Example: /ninjavan/sg/webhooks -> 'sg'
-      country_code = request.path.split("/")[2]&.downcase
+      # Example: /sg -> 'sg'
+      country_code = request.path.split("/")[-1]&.downcase
       return head :unauthorized unless country_code.present?
 
       webhook_secret = NinjaVanApi.configuration.get_webhook_secret(country_code)

data/lib/ninja_van_api/client.rb

@@ -38,6 +38,10 @@ module NinjaVanApi
       @orders ||= OrderResource.new(self)
     end
 
+    def waybills
+      @waybills ||= WaybillResource.new(self)
+    end
+
     private
 
     def validate_country_code
@@ -55,7 +59,7 @@ module NinjaVanApi
     def access_token
       fetch_access_token if token_expired?
 
-      if defined?(Rails) && Rails.respond_to?(:cache)
+      if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache
         Rails.cache.read(cache_key)["access_token"]
       else
         @token_info["access_token"]
@@ -64,7 +68,7 @@ module NinjaVanApi
 
     def refresh_access_token
       @token_info = nil
-      Rails.cache.delete(cache_key) if defined?(Rails) && Rails.respond_to?(:cache)
+      Rails.cache.delete(cache_key) if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache
       fetch_access_token
     end
 
@@ -99,7 +103,7 @@ module NinjaVanApi
     def access_token
       fetch_access_token if token_expired?
 
-      if defined?(Rails) && Rails.respond_to?(:cache)
+      if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache
         Rails.cache.read(cache_key)["access_token"]
       else
         @token_info["access_token"]
@@ -108,7 +112,7 @@ module NinjaVanApi
 
     def token_expired?
       token_info =
-        if defined?(Rails) && Rails.respond_to?(:cache)
+        if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache
           Rails.cache.read(cache_key)
         else
           @token_info
@@ -125,7 +129,7 @@ module NinjaVanApi
 
       token_info = JSON.parse(response.body)
 
-      if defined?(Rails) && Rails.respond_to?(:cache)
+      if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache
         Rails.cache.write(cache_key, token_info, expires_in: token_info["expires_in"])
       else
         @token_info = token_info

data/lib/ninja_van_api/configuration.rb

@@ -10,11 +10,11 @@ module NinjaVanApi
     attr_accessor :webhook_job_class
 
     def webhook_secrets=(secrets)
-      @webhook_secrets = secrets.transform_keys(&:downcase)
+      @webhook_secrets = secrets.transform_keys { |key| key.to_sym.downcase }
     end
 
     def get_webhook_secret(country_code)
-      @webhook_secrets[country_code.to_s.downcase]
+      @webhook_secrets[country_code.to_sym.downcase]
     end
   end
 

data/lib/ninja_van_api/objects/waybill.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NinjaVanApi
+  class Waybill < Base
+    attr_reader :pdf
+
+    def initialize(content)
+      @pdf = content
+    end
+  end
+end

data/lib/ninja_van_api/resources/waybill_resource.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NinjaVanApi
+  class WaybillResource < BaseResource
+    # Retrieves a waybill for a given tracking number
+    # @param tracking_number [String] The tracking number as generated by the Order API
+    # @param hide_shipper_details [Boolean] A flag for hiding shipper's details
+    # @param orientation [String] Specifies the orientation of the generated waybill ("portrait" or "landscape")
+    # @return [Waybill] The waybill object
+    def get(tracking_number, hide_shipper_details: nil, orientation: nil)
+      params = { tid: tracking_number }
+      params[:hide_shipper_details] = hide_shipper_details unless hide_shipper_details.nil?
+      params[:orientation] = orientation if orientation
+
+      response = get_request("2.0/reports/waybill", params: params)
+      Waybill.new(response.body)
+    end
+  end
+end

data/lib/ninja_van_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NinjaVanApi
-  VERSION = "0.2.20"
+  VERSION = "0.3.1"
 end

data/lib/ninja_van_api.rb

@@ -14,10 +14,12 @@ module NinjaVanApi
   # Objects
   autoload :Base, "ninja_van_api/objects/base"
   autoload :Order, "ninja_van_api/objects/order"
+  autoload :Waybill, "ninja_van_api/objects/waybill"
 
   # Resources
   autoload :BaseResource, "ninja_van_api/resources/base_resource"
   autoload :OrderResource, "ninja_van_api/resources/order_resource"
+  autoload :WaybillResource, "ninja_van_api/resources/waybill_resource"
 
   # Core components
   autoload :Client, "ninja_van_api/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ninja_van_api
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.3.1
 platform: ruby
 authors:
 - Jane Trang Mai Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -144,8 +144,10 @@ files:
 - lib/ninja_van_api/error.rb
 - lib/ninja_van_api/objects/base.rb
 - lib/ninja_van_api/objects/order.rb
+- lib/ninja_van_api/objects/waybill.rb
 - lib/ninja_van_api/resources/base_resource.rb
 - lib/ninja_van_api/resources/order_resource.rb
+- lib/ninja_van_api/resources/waybill_resource.rb
 - lib/ninja_van_api/version.rb
 homepage: https://github.com/Postco/ninja_van_api
 licenses: