hubrise_client 2.0.14 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89e7c3b037501ae07c44e6cfef51a9e39d5d0aa06c229493716957835146c64e
-  data.tar.gz: 34643d28e45cad280f62bc8e826cfaf0d7bbd19cedcd003faeeda087d3d5e428
+  metadata.gz: b05c00e55ba2498337eacf6f67d8d8e4c56a48d41c7bdb280dd475219efff7c6
+  data.tar.gz: '079dc44ad7cd1728fbf50fe5c8a6226d78615a8738a01655fe23e9ba8f5af056'
 SHA512:
-  metadata.gz: 78e35af2ae3b43e4a3e73339abd261cbe515cddac733dbd930831f6fea512ec686683b4e681875d429d9d07edbe4d396ba44858d95a134ef6e4cab0c922a3852
-  data.tar.gz: 15ad66f6d58e868117ead6678921b0f70b9954525b60e28930c0af6e599daca371f1faf6105399f904980d5dcb73bfc9ae2dfdf0f15bbadef88a2a972afd3bde
+  metadata.gz: 25477048e5358e52ed29bc5a32294dbfad3c9a703388bb8a5fa698c64fcc3a236596d0c1e70fe7f7c22217322ab6ce52881c35ade25b062599229d5828ef5a8c
+  data.tar.gz: 1e51ad7068e667ed17640456e80d6ecf3802bb7d1904ac6d0860f2f33a1a0939ef9654c81bbd4f5eb6f1f1808e8ceb98e38ab9f19d6a2977d8079303b3d92596

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.9
 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/lib/hubrise_client/v1.rb

@@ -177,10 +177,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: 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.15"
 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.15
 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-06-12 00:00:00.000000000 Z
 dependencies: []
 description:
 email: