hubrise_client 2.0.14 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89e7c3b037501ae07c44e6cfef51a9e39d5d0aa06c229493716957835146c64e
-  data.tar.gz: 34643d28e45cad280f62bc8e826cfaf0d7bbd19cedcd003faeeda087d3d5e428
+  metadata.gz: 5a5efc4d9d115b36d1644adbdb7760808eed52c6532272520bbed995e0a18425
+  data.tar.gz: 3a930aec0a980055b08694c3af4e76db5f5a477dd3d0cd46aae4e8fe55b54172
 SHA512:
-  metadata.gz: 78e35af2ae3b43e4a3e73339abd261cbe515cddac733dbd930831f6fea512ec686683b4e681875d429d9d07edbe4d396ba44858d95a134ef6e4cab0c922a3852
-  data.tar.gz: 15ad66f6d58e868117ead6678921b0f70b9954525b60e28930c0af6e599daca371f1faf6105399f904980d5dcb73bfc9ae2dfdf0f15bbadef88a2a972afd3bde
+  metadata.gz: 7d184e875c81ef04dcf3d839afbe07345011eb01ac2705c4ccb9f8ae6ee2362bba6159b2e00cf7c170b8af755b78bab3aeba72e8df0c7f117b9d5d262c56fa1a
+  data.tar.gz: 718bffe6ff5551ea8b011922ae194d63831a513130b24a7bf9266ee8354117f5d92488ce17f5f2d7da278a3ca61a24883491e55b5ee13bd0e02440b594a9d956

data/README.md

@@ -14,59 +14,57 @@ Or install via [gem](http://rubygems.org/)
 gem install hubrise_client
 ```
 
-
 # Prerequisites
 
-1) Read the [docs](https://www.hubrise.com/developers)
-
-2) [Create a Hubrise Client](https://www.hubrise.com/developers/quick-start#create-the-oauth-client) to get your `CLIENT_ID` and `CLIENT_SECRET`.
+1. Read the [docs](https://www.hubrise.com/developers)
 
+2. [Create a Hubrise Client](https://www.hubrise.com/developers/quick-start#create-the-oauth-client) to get your `CLIENT_ID` and `CLIENT_SECRET`.
 
 # Get an access token
 
 1. Initialize anonymous `HubriseClient`
-    ```ruby
-    client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET)
-    ```
+
+   ```ruby
+   client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET)
+   ```
 
 2. Prepare a route to handle `REDIRECT_URI` callback
-    ```ruby
-    # routes.rb
-    namespace :hubrise_oauth do
-      get :authorize_callback
-      # => creates hubrise_oauth_authorize_callback_url helper
-    end
-    ```
-  
 
-3. Initiate an OAuth flow by redirecting a user to [OAuth Authorization URL](https://www.hubrise.com/developers/authentication#request-authorisation)
-    ```ruby
-    oauth_scope = "location[orders.read]" # adjust to your needs
-    authorization_url = client.build_authorization_url(hubrise_oauth_authorize_callback_url, oauth_scope)
-    ...
-    redirect_to(authorization_url)
-    ```
+   ```ruby
+   # routes.rb
+   namespace :hubrise_oauth do
+     get :authorize_callback
+     # => creates hubrise_oauth_authorize_callback_url helper
+   end
+   ```
 
-4. Complete the OAuth flow
+3. Initiate an OAuth flow by redirecting a user to [OAuth Authorization URL](https://www.hubrise.com/developers/authentication#request-authorisation)
 
-    Once the user accepts your request he or she will be redirected to the REDIRECT_URI
-    At this step you need to [exchange](https://www.hubrise.com/developers/authentication#get-an-access-token) the `authorization_code` (received as a query param) for a new `access_token`
+   ```ruby
+   oauth_scope = "location[orders.read]" # adjust to your needs
+   authorization_url = client.build_authorization_url(hubrise_oauth_authorize_callback_url, oauth_scope)
+   ...
+   redirect_to(authorization_url)
+   ```
 
+4. Complete the OAuth flow
 
-    ```ruby
-    # controllers/hubrise_oauth_controller.rb
+   Once the user accepts your request he or she will be redirected to the REDIRECT_URI
+   At this step you need to [exchange](https://www.hubrise.com/developers/authentication#get-an-access-token) the `authorization_code` (received as a query param) for a new `access_token`
 
-    def authorize_callback
-      client.authorize!(params[:code])
+   ```ruby
+   # controllers/hubrise_oauth_controller.rb
 
-      current_user.update!(hubrise_access_token: client.access_token)
-      # account_id = client.account_id
-      # location_id = client.location_id
-    end
-    ```
+   def authorize_callback
+     client.authorize!(params[:code])
 
-    The `access_token` reffers to this specific user's permission so it should be securely persisted and not shared with other users.
+     current_user.update!(hubrise_access_token: client.access_token)
+     # account_id = client.account_id
+     # location_id = client.location_id
+   end
+   ```
 
+   The `access_token` reffers to this specific user's permission so it should be securely persisted and not shared with other users.
 
 # Use the access token
 
@@ -75,6 +73,7 @@ client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET, access_token: current_u
 ```
 
 Now you can call the [helper methods](https://github.com/HubRise/ruby-client/blob/master/V1_ENDPOINTS.md) on behalf of the user
+
 ```ruby
 client.get_account
 ```
@@ -98,7 +97,16 @@ response.each_page do |page_response|
 end
 ```
 
-# Publish changes to this gem
+# Development
+
+## Run tests
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## Release
 
 1. Make sure all local changes are committed.
 
@@ -107,7 +115,7 @@ end
 3. Tag the repository:
 
 ```bash
-VERSION=2.0.14
+VERSION=2.0.16
 git add lib/hubrise_client/version.rb
 git commit -m "Version $VERSION"
 git tag v$VERSION
@@ -122,4 +130,4 @@ rm -f hubrise_client-*.gem
 gem build hubrise_client
 gem push hubrise_client-*.gem
 rm -f hubrise_client-*.gem
-``` 
+```

data/V1_ENDPOINTS.md

@@ -119,6 +119,38 @@ client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET, client_attrs)
   # [PATCH] /locations/locationIdX/orders/orderIdX/delivery with { headers: { "Content-Type": "application/json" }, body: "{\"status\":\"delivered\" }" }
   ```
 
+### GET_DELIVERY_QUOTES
+
+- Initialized with `client_attrs = { access_token: "accessTokenX" }`
+  ```ruby
+  client.get_delivery_quotes("locationIdX", "orderIdX")
+  # [GET] /locations/locationIdX/orders/orderIdX/delivery_quotes with { headers: { "X-Access-Token": "accessTokenX" }}
+  ```
+
+### GET_DELIVERY_QUOTE
+
+- Initialized with `client_attrs = { access_token: "accessTokenX" }`
+  ```ruby
+  client.get_delivery_quote("locationIdX", "orderIdX", "quoteIdX")
+  # [GET] /locations/locationIdX/orders/orderIdX/delivery_quotes/quoteIdX with { headers: { "X-Access-Token": "accessTokenX" }}
+  ```
+
+### CREATE_DELIVERY_QUOTE
+
+- Initialized with `client_attrs = { access_token: "accessTokenX" }`
+  ```ruby
+  client.create_delivery_quote("locationIdX", "orderIdX", { carrier: "UPS" })
+  # [POST] /locations/locationIdX/orders/orderIdX/delivery_quotes with { headers: { "Content-Type": "application/json" }, body: "{\"carrier\":\"UPS\" }" }
+  ```
+
+### ACCEPT_DELIVERY_QUOTE
+
+- Initialized with `client_attrs = { access_token: "accessTokenX" }`
+  ```ruby
+  client.accept_delivery_quote("locationIdX", "orderIdX", "quoteIdX")
+  # [POST] /locations/locationIdX/orders/orderIdX/delivery_quotes/quoteIdX/accept with { headers: { "X-Access-Token": "accessTokenX" }}
+  ``` 
+
 ### GET_CALLBACK
 
 - Initialized with `client_attrs = { access_token: "accessTokenX" }`

data/lib/hubrise_client/base.rb

@@ -38,8 +38,8 @@ module HubriseClient
 
     def build_authorization_url(redirect_uri, scope, params = {})
       params = params.merge(
-        redirect_uri: redirect_uri,
-        scope: scope,
+        redirect_uri:,
+        scope:,
         client_id: @app_id
       )
 
@@ -83,9 +83,9 @@ module HubriseClient
       raise(HubriseAccessTokenMissing) if @access_token.nil?
 
       api_request(
-        "#{@api_host}:#{@api_port}/#{version}", path, method, data: data,
-                                                              json: json,
-                                                              headers: headers,
+        "#{@api_host}:#{@api_port}/#{version}", path, method, data:,
+                                                              json:,
+                                                              headers:,
                                                               access_token: @access_token,
                                                               callback: @request_callback
       ).perform
@@ -94,9 +94,9 @@ module HubriseClient
     def api_request(hostname, path, method, attrs = {})
       Request.from_h(
         {
-          hostname: hostname,
-          path: path,
-          method: method,
+          hostname:,
+          path:,
+          method:,
           use_https: @use_https,
           logger: @verbous && @logger,
           json: true,

data/lib/hubrise_client/v1.rb

@@ -83,6 +83,25 @@ module HubriseClient
       call_api("/locations/#{location_id}/orders/#{order_id}/delivery", :patch, data: params)
     end
 
+    # --------------------
+    # Delivery quotes
+    # --------------------
+    def get_delivery_quotes(location_id, order_id)
+      call_api("/locations/#{location_id}/orders/#{order_id}/delivery_quotes")
+    end
+
+    def get_delivery_quote(location_id, order_id, quote_id)
+      call_api("/locations/#{location_id}/orders/#{order_id}/delivery_quotes/#{quote_id}")
+    end
+
+    def create_delivery_quote(location_id, order_id, params)
+      call_api("/locations/#{location_id}/orders/#{order_id}/delivery_quotes", :post, data: params)
+    end
+
+    def accept_delivery_quote(location_id, order_id, quote_id)
+      call_api("/locations/#{location_id}/orders/#{order_id}/delivery_quotes/#{quote_id}/accept", :post)
+    end
+
     # --------------------
     # Callback, events
     # --------------------
@@ -177,10 +196,10 @@ module HubriseClient
     # --------------------
     # Images
     # --------------------
-    def create_image(data, mime_type, catalog_id = nil)
-      call_api("/catalogs/#{catalog_id_fallback(catalog_id)}/images", :post, data: data,
-                                                                             headers: { "Content-Type" => mime_type },
-                                                                             json: false)
+    def create_image(data, mime_type, catalog_id = nil, options = {})
+      path = "/catalogs/#{catalog_id_fallback(catalog_id)}/images"
+      path += "?private_ref=#{CGI.escape(options[:private_ref])}" if options[:private_ref]
+      call_api(path, :post, data:, headers: { "Content-Type" => mime_type }, json: false)
     end
 
     def get_images(catalog_id = nil)

data/lib/hubrise_client/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module HubriseClient
-  VERSION = "2.0.14"
+  VERSION = "2.0.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_client
 version: !ruby/object:Gem::Version
-  version: 2.0.14
+  version: 2.0.16
 platform: ruby
 authors:
 - Antoine Monnier
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-09-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -39,14 +39,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.7
+      version: 3.1.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: HubRise Ruby client