fulfil_api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b6b63d1460a3a0d6b6c5ef3b33b018291d6919a27c32664c7649922a930852
-  data.tar.gz: 0a87ce490bca0026c5764ded0e887a3cdffd4cf0d9a3f13bcfd8e5a5a888cb43
+  metadata.gz: 0b2f385c53e1a0cb8df12a9869060c93d5e0cf24dbdf9277f104a68ac36d5d62
+  data.tar.gz: 82981d13dcb644beb81712d8c6784990007f926c44137890ce1cb6d28a3e59df
 SHA512:
-  metadata.gz: dedeecd3042e63045c2a5215d5bc6121c99a0863a65db953657cef068ff75f060271533d8ce2dd39a9b24ca94834b5b0b1282778ba6f0fb8d18efd419ecdff32
-  data.tar.gz: b39a10b911e3c9909cb7f21bfdf4cde91db64438eb6060a54700e4596ec4fe32961b691e49f4370211fdca0f8b343b0c63421ccfeb6d5959b6c05524ba415a94
+  metadata.gz: fafc5b8317be062615e13d6a390f5f7e49557d9039957faad958225f7a264be29da6e556803bd914654a77b2c30365d19f431592748459c7dcba5f810546bb22
+  data.tar.gz: 5ff7b0cef942956dc814d7761fc97c939111e299abe54e228af8e3dde10bd257de4772b83389126be001236f0a9b8f0f80fe17b493ff981b4821be0fe766c9e1

data/README.md

@@ -153,16 +153,16 @@ The 3PL client is accessible via `FulfilApi.tpl_client` and supports the standar
 
 ```ruby
 # GET request with optional URL parameters
-FulfilApi.tpl_client.get("inbound-transfers", url_parameters: { page: 1, per_page: 25 })
+FulfilApi.tpl_client.get("inbound-transfers", page: 1, per_page: 25)
 
 # POST request with a request body
-FulfilApi.tpl_client.post("inbound-transfers/receive.json", body: { tracking_number: "ABC123" })
+FulfilApi.tpl_client.post("inbound-transfers/receive.json", { tracking_number: "ABC123" })
 
 # PUT request with a request body
-FulfilApi.tpl_client.put("inbound-transfers/receive.json", body: { status: "received" })
+FulfilApi.tpl_client.put("inbound-transfers/receive.json", { status: "received" })
 
 # PATCH request with a request body
-FulfilApi.tpl_client.patch("inbound-transfers/receive.json", body: { status: "received" })
+FulfilApi.tpl_client.patch("inbound-transfers/receive.json", { status: "received" })
 
 ```
 

data/lib/fulfil_api/tpl_client.rb

@@ -9,8 +9,8 @@ module FulfilApi
   # the 3PL supplier API using standard HTTP methods.
   #
   # @example Using the TPL client
-  #   FulfilApi.tpl_client.get("inbound-transfers", url_parameters: { page: 1 })
-  #   FulfilApi.tpl_client.post("inbound-transfers/receive.json", body: { tracking_number: "123" })
+  #   FulfilApi.tpl_client.get("inbound-transfers", page: 1)
+  #   FulfilApi.tpl_client.post("inbound-transfers/receive.json", { tracking_number: "123" })
   class TplClient
     class ConfigurationError < FulfilApi::Error; end
 
@@ -33,10 +33,10 @@ module FulfilApi
     # Performs an HTTP GET request to a 3PL API endpoint.
     #
     # @param relative_path [String] The relative path to the endpoint.
-    # @param url_parameters [Hash, nil] The optional URL parameters for the API endpoint.
+    # @param url_parameters [Hash] The optional URL parameters for the API endpoint.
     # @return [Array, Hash, String] The parsed response body.
-    def get(relative_path, url_parameters: nil)
-      request(:get, relative_path, url_parameters)
+    def get(relative_path, **url_parameters)
+      request(:get, relative_path, url_parameters.presence)
     end
 
     # Performs an HTTP PATCH request to a 3PL API endpoint.
@@ -44,7 +44,7 @@ module FulfilApi
     # @param relative_path [String] The relative path to the endpoint.
     # @param body [Array, Hash, nil] The request body for the PATCH HTTP request.
     # @return [Array, Hash, String] The parsed response body.
-    def patch(relative_path, body: {})
+    def patch(relative_path, body = {})
       request(:patch, relative_path, body)
     end
 
@@ -53,7 +53,7 @@ module FulfilApi
     # @param relative_path [String] The relative path to the endpoint.
     # @param body [Array, Hash, nil] The request body for the POST HTTP request.
     # @return [Array, Hash, String] The parsed response body.
-    def post(relative_path, body: {})
+    def post(relative_path, body = {})
       request(:post, relative_path, body)
     end
 
@@ -62,7 +62,7 @@ module FulfilApi
     # @param relative_path [String] The relative path to the endpoint.
     # @param body [Array, Hash, nil] The optional request body for the PUT HTTP request.
     # @return [Array, Hash, String] The parsed response body.
-    def put(relative_path, body: nil)
+    def put(relative_path, body = nil)
       return request(:put, relative_path) if body.nil?
 
       request(:put, relative_path, body)
@@ -137,7 +137,7 @@ module FulfilApi
   #
   # @example
   #   FulfilApi.tpl_client.get("inbound-transfers")
-  #   FulfilApi.tpl_client.post("inbound-transfers/receive.json", body: { tracking_number: "123" })
+  #   FulfilApi.tpl_client.post("inbound-transfers/receive.json", { tracking_number: "123" })
   #
   # @return [FulfilApi::TplClient]
   def self.tpl_client

data/lib/fulfil_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FulfilApi
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Stefan Vermaas