hubrise_client 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7763aa9e092db7309780e3217dc381191e49141d8120a3dfd38791ff4af47e9c
-  data.tar.gz: 3e8288142e201c52adf9ca05b3607f0f37c8a6ffad4a2df6c8c271395e226fff
+  metadata.gz: f10358d2bbba5919834bc9209feafaa301aee68fa07153aad77a5e31c3844a28
+  data.tar.gz: 4d881d4e77a8df23a4dfc784e3b8505db21859dee1f69bfcd18e2c683b5e1044
 SHA512:
-  metadata.gz: f683839ae7f97389a8ff392d386587f6c47df0ab1b68da3c733dfd35516be74bdb20d51da1770b15b83bc08eee9bc234c09410bb845f8729f842996d9d3641e7
-  data.tar.gz: fcefcc27355f4df841b4624506dafc25d2abd0399ef14779bb72b3c39d25ed27a922f4cd1a4d415533659104c6c4f27585b9f35a0a5266a537e8fa11d5e1ef44
+  metadata.gz: 865672a43693575a2493bd2b2edf3e2e1ef95268065bf6bfa9c5398045fda40537c501f0f74741f36443541491c84a4b10ccaabb9c3dafcb7e22c80e2bfb31fd
+  data.tar.gz: eeb709dfdb5216f72d15afe73f53913847744e54c70f6119bf24d2e5377d79bbc118536544b5b6a8a70b82b3ca115dbc1503b53b56bb16527bd5f7aa06e72439

data/README.md

@@ -1,12 +1,80 @@
-# hubrise_client
+This gem is a Ruby SDK for [Hubrise API](https://www.hubrise.com/developers). It is maintained by the HubRise development team.
 
-To upload the latest version to RubyGems.org:
+# Installation
 
-1. Increase version in `lib/hubrise_client/version.rb` and commit
+Add `hubrise_client` to your `Gemfile`:
 
-2. Build & publish (assuming the new version is `2.0.1`):
+```ruby
+gem 'hubrise_client'
+```
+
+Or install via [gem](http://rubygems.org/)
 
 ```bash
-gem build hubrise_client
-gem push hubrise_client-2.0.1.gem
-``` 
+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`.
+
+
+# Get an access token
+
+1. Initialize anonymous `HubriseClient`
+    ```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)
+    ```
+
+4. Complete the OAuth flow
+
+    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
+    # controllers/hubrise_oauth_controller.rb
+
+    def authorize_callback
+      client.authorize!(params[:code])
+
+      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
+
+```ruby
+client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET, access_token: current_user.hubrise_access_token)
+```
+
+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
+```

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rake"
 require "rake/testtask"
 
@@ -7,4 +8,4 @@ Rake::TestTask.new do |t|
   t.verbose = false
 end
 
-task default: :test
+task(default: :test)

data/V1_ENDPOINTS.md

@@ -1,256 +1,403 @@
+# Full list of available methods to access the API
+
+```ruby
+client = HubriseClient::V1.new(CLIENT_ID, CLIENT_SECRET, client_attrs)
+```
+
 ### GET_ACCOUNT
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_account("zrn61")
-    // => [GET] /accounts/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_account()
-    // => [GET] /account with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_account("zrn61")
+  # [GET] /accounts/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_account
+  # [GET] /account with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ACCOUNTS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_accounts()
-    // => [GET] /accounts with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_accounts
+  # [GET] /accounts with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_USER
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_user()
-    // => [GET] /user with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_user
+  # [GET] /user with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_LOCATIONS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_locations()
-    // => [GET] /locations with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_locations
+  # [GET] /locations with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_LOCATION
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_location("zrn61")
-    // => [GET] /locations/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_location()
-    // => [GET] /location with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_location("zrn61")
+  # [GET] /locations/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_location
+  # [GET] /location with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ORDERS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_orders("zrn61", {:status=>"new"})
-    // => [GET] /locations/zrn61/orders?status=new with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_orders("zrn61", { status: "new" })
+  # [GET] /locations/zrn61/orders?status=new with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ORDER
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_order("zrn61", "wy3xz")
-    // => [GET] /locations/zrn61/orders/wy3xz with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_order("zrn61", "wy3xz")
+  # [GET] /locations/zrn61/orders/wy3xz with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### CREATE_ORDER
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_order("zrn61", {:status=>"new"})
-    // => [POST] /locations/zrn61/orders with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"status\":\"new\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_order("zrn61", { status: "new" })
+  # [POST] /locations/zrn61/orders with { headers: { "Content-Type": "application/json" }, body: "{\"status\":\"new\" }" }
+  ```
+
 ### UPDATE_ORDER
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_order("zrn61", "wy3xz", {:status=>"delivered"})
-    // => [PUT] /locations/zrn61/orders/wy3xz with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"status\":\"delivered\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_order("zrn61", "wy3xz", { status: "delivered" })
+  # [PUT] /locations/zrn61/orders/wy3xz with { headers: { "Content-Type": "application/json" }, body: "{\"status\":\"delivered\" }" }
+  ```
+
 ### GET_CALLBACK
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_callback()
-    // => [GET] /callback with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_callback
+  # [GET] /callback with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_CALLBACK_EVENTS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_callback_events()
-    // => [GET] /callback/events with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_callback_events
+  # [GET] /callback/events with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### DELETE_EVENT
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).delete_event("zrn61")
-    // => [DELETE] /callback/events/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.delete_event("zrn61")
+  # [DELETE] /callback/events/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### UPDATE_CALLBACK
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_callback({"order"=>["create"]})
-    // => [POST] /callback with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"order\":[\"create\"]}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_callback({ "order": ["create"]})
+  # [POST] /callback with { headers: { "Content-Type": "application/json" }, body: "{\"order\":[\"create\"]}" }
+  ```
+
 ### DELETE_CALLBACK
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).delete_callback()
-    // => [DELETE] /callback with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.delete_callback
+  # [DELETE] /callback with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_LOCATION_CUSTOMER_LISTS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_location_customer_lists("zrn61")
-    // => [GET] /locations/zrn61/customer_lists with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_location_customer_lists("zrn61")
+  # [GET] /locations/zrn61/customer_lists with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ACCOUNT_CUSTOMER_LISTS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_account_customer_lists("zrn61")
-    // => [GET] /accounts/zrn61/customer_lists with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_account_customer_lists("zrn61")
+  # [GET] /accounts/zrn61/customer_lists with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_CUSTOMER_LIST
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_customer_list("zrn61")
-    // => [GET] /customer_lists/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"wy3xz"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_customer_list()
-    // => [GET] /customer_lists/wy3xz with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_customer_list("zrn61")
+  # [GET] /customer_lists/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "wy3xz" }`
+  ```ruby
+  client.get_customer_list
+  # [GET] /customer_lists/wy3xz with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ALL_CUSTOMERS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_all_customers("zrn61")
-    // => [GET] /customer_lists/zrn61/customers with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"wy3xz"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_all_customers()
-    // => [GET] /customer_lists/wy3xz/customers with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_all_customers("zrn61")
+  # [GET] /customer_lists/zrn61/customers with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "wy3xz" }`
+  ```ruby
+  client.get_all_customers
+  # [GET] /customer_lists/wy3xz/customers with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### SEARCH_CUSTOMERS
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"zrn61"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).search_customers({:email=>"nsave@*"})
-    // => [GET] /customer_lists/zrn61/customers?email=nsave@* with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).search_customers({:email=>"nsave@*"}, "wy3xz")
-    // => [GET] /customer_lists/wy3xz/customers?email=nsave@* with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "zrn61" }`
+  ```ruby
+  client.search_customers({ email: "nsave@*" })
+  # [GET] /customer_lists/zrn61/customers?email=nsave@* with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.search_customers({ email: "nsave@*" }, "wy3xz")
+  # [GET] /customer_lists/wy3xz/customers?email=nsave@* with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_CUSTOMER
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"zrn61"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_customer("zrk6b")
-    // => [GET] /customer_lists/zrn61/customers/zrk6b with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_customer("zrk6b", "wy3xz")
-    // => [GET] /customer_lists/wy3xz/customers/zrk6b with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "zrn61" }`
+  ```ruby
+  client.get_customer("zrk6b")
+  # [GET] /customer_lists/zrn61/customers/zrk6b with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_customer("zrk6b", "wy3xz")
+  # [GET] /customer_lists/wy3xz/customers/zrk6b with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### CREATE_CUSTOMER
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"zrn61"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_customer({:first_name=>"nsave"})
-    // => [POST] /customer_lists/zrn61/customers with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"first_name\":\"nsave\"}"}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_customer({:first_name=>"nsave"}, "wy3xz")
-    // => [POST] /customer_lists/wy3xz/customers with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"first_name\":\"nsave\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "zrn61" }`
+  ```ruby
+  client.create_customer({ first_name: "nsave" })
+  # [POST] /customer_lists/zrn61/customers with { headers: { "Content-Type": "application/json" }, body: "{\"first_name\":\"nsave\" }" }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_customer({ first_name: "nsave" }, "wy3xz")
+  # [POST] /customer_lists/wy3xz/customers with { headers: { "Content-Type": "application/json" }, body: "{\"first_name\":\"nsave\" }" }
+  ```
+
 ### UPDATE_CUSTOMER
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :customer_list_id=>"zrn61"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_customer("zrk6b", {:first_name=>"nsave"})
-    // => [PUT] /customer_lists/zrn61/customers/zrk6b with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"first_name\":\"nsave\"}"}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_customer("zrk6b", {:first_name=>"nsave"}, "wy3xz")
-    // => [PUT] /customer_lists/wy3xz/customers/zrk6b with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"first_name\":\"nsave\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "zrn61" }`
+  ```ruby
+  client.update_customer("zrk6b", { first_name: "nsave" })
+  # [PUT] /customer_lists/zrn61/customers/zrk6b with { headers: { "Content-Type": "application/json" }, body: "{\"first_name\":\"nsave\" }" }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_customer("zrk6b", { first_name: "nsave" }, "wy3xz")
+  # [PUT] /customer_lists/wy3xz/customers/zrk6b with { headers: { "Content-Type": "application/json" }, body: "{\"first_name\":\"nsave\" }" }
+  ```
+
 ### GET_LOCATION_CATALOGS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_location_catalogs("zrn61")
-    // => [GET] /locations/zrn61/catalogs with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_location_catalogs("zrn61")
+  # [GET] /locations/zrn61/catalogs with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_ACCOUNT_CATALOGS
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_account_catalogs("zrn61")
-    // => [GET] /accounts/zrn61/catalogs with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_account_catalogs("zrn61")
+  # [GET] /accounts/zrn61/catalogs with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_CATALOG
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_catalog("zrn61")
-    // => [GET] /catalogs/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :catalog_id=>"wy3xz"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_catalog()
-    // => [GET] /catalogs/wy3xz with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_catalog("zrn61")
+  # [GET] /catalogs/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "wy3xz" }`
+  ```ruby
+  client.get_catalog
+  # [GET] /catalogs/wy3xz with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### CREATE_ACCOUNT_CATALOG
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_account_catalog({:name=>"Catalog1"})
-    // => [POST] /account/catalogs with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"name\":\"Catalog1\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_account_catalog({ name: "Catalog1" })
+  # [POST] /account/catalogs with { headers: { "Content-Type": "application/json" }, body: "{\"name\":\"Catalog1\" }" }
+  ```
+
 ### CREATE_LOCATION_CATALOG
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_location_catalog({:name=>"Catalog1"}, "zrn61")
-    // => [POST] /locations/zrn61/catalogs with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"name\":\"Catalog1\"}"}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_location_catalog({:name=>"Catalog1"})
-    // => [POST] /location/catalogs with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"name\":\"Catalog1\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_location_catalog({ name: "Catalog1" }, "zrn61")
+  # [POST] /locations/zrn61/catalogs with { headers: { "Content-Type": "application/json" }, body: "{\"name\":\"Catalog1\" }" }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_location_catalog({ name: "Catalog1" })
+  # [POST] /location/catalogs with { headers: { "Content-Type": "application/json" }, body: "{\"name\":\"Catalog1\" }" }
+  ```
+
 ### UPDATE_CATALOG
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_catalog({:name=>"Catalog1"}, "zrn61")
-    // => [PUT] /catalogs/zrn61 with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"name\":\"Catalog1\"}"}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :catalog_id=>"zrk6b"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).update_catalog({:name=>"Catalog1"})
-    // => [PUT] /catalogs/zrk6b with {:headers=>{"Content-Type"=>"application/json"}, :body=>"{\"name\":\"Catalog1\"}"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_catalog({ name: "Catalog1" }, "zrn61")
+  # [PUT] /catalogs/zrn61 with { headers: { "Content-Type": "application/json" }, body: "{\"name\":\"Catalog1\" }" }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrk6b" }`
+  ```ruby
+  client.update_catalog({ name: "Catalog1" })
+  # [PUT] /catalogs/zrk6b with { headers: { "Content-Type": "application/json" }, body: "{\"name\":\"Catalog1\" }" }
+  ```
+
 ### CREATE_IMAGE
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_image("bin1", "image/png", "zrn61")
-    // => [POST] /catalogs/zrn61/images with {:headers=>{"Content-Type"=>"image/png"}, :body=>"bin1"}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :catalog_id=>"zrk6b"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).create_image("bin1", "image/png")
-    // => [POST] /catalogs/zrk6b/images with {:headers=>{"Content-Type"=>"image/png"}, :body=>"bin1"}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_image("bin1", "image/png", "zrn61")
+  # [POST] /catalogs/zrn61/images with { headers: { "Content-Type": "image/png" }, body: "bin1" }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrk6b" }`
+  ```ruby
+  client.create_image("bin1", "image/png")
+  # [POST] /catalogs/zrk6b/images with { headers: { "Content-Type": "image/png" }, body: "bin1" }
+  ```
+
 ### GET_IMAGE
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_image("zrn61", "wy3xz")
-    // => [GET] /catalogs/wy3xz/images/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :catalog_id=>"zrk6b"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_image("zrn61")
-    // => [GET] /catalogs/zrk6b/images/zrn61 with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_image("zrn61", "wy3xz")
+  # [GET] /catalogs/wy3xz/images/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrk6b" }`
+  ```ruby
+  client.get_image("zrn61")
+  # [GET] /catalogs/zrk6b/images/zrn61 with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
 ### GET_IMAGE_DATA
-  - Initialized with `client_attrs = {:access_token=>"access_token1"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_image_data("zrn61", "wy3xz")
-    // => [GET] /catalogs/wy3xz/images/zrn61/data with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
-  - Initialized with `client_attrs = {:access_token=>"access_token1", :catalog_id=>"zrk6b"}`
-    ```
-    Hubrise::APIClients::V1.new(client_attrs).get_image_data("zrn61")
-    // => [GET] /catalogs/zrk6b/images/zrn61/data with {:headers=>{"X-Access-Token"=>"access_token1"}}
-    ```
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_image_data("zrn61", "wy3xz")
+  # [GET] /catalogs/wy3xz/images/zrn61/data with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrk6b" }`
+  ```ruby
+  client.get_image_data("zrn61")
+  # [GET] /catalogs/zrk6b/images/zrn61/data with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
+### GET_INVENTORY
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_inventory("zrn61", "wy3xz")
+  # [GET] /catalogs/zrn61/locations/wy3xz/inventory with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.get_inventory("zrn61")
+  # [GET] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrn61" }`
+  ```ruby
+  client.get_inventory
+  # [GET] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }}
+  ```
+
+### UPDATE_INVENTORY
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_inventory([{sku_ref: "m9qqs"}], "zrn61", "wy3xz")
+  # [PUT] /catalogs/zrn61/locations/wy3xz/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.update_inventory([{sku_ref: "m9qqs"}], "zrn61")
+  # [PUT] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrn61" }`
+  ```ruby
+  client.update_inventory([{sku_ref: "m9qqs"}])
+  # [PUT] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+
+### PATCH_INVENTORY
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.patch_inventory([{sku_ref: "m9qqs"}], "zrn61", "wy3xz")
+  # [PATCH] /catalogs/zrn61/locations/wy3xz/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.patch_inventory([{sku_ref: "m9qqs"}], "zrn61")
+  # [PATCH] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", catalog_id: "zrn61" }`
+  ```ruby
+  client.patch_inventory([{sku_ref: "m9qqs"}])
+  # [PATCH] /catalogs/zrn61/location/inventory with { headers: { "X-Access-Token": "access_token1" }, body: "[{\"sku_ref\":\"m9qqs\"}]"}
+  ```
+
+### CREATE_LOYALTY_CARD
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_loyalty_card({ name: "bonus" }, "wy3xz")
+  # [POST] /customer_lists/wy3xz/loyalty_cards with { headers: { "X-Access-Token": "access_token1" }, body: { name: "bonus" } }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "zrk6b" }`
+  ```ruby
+  client.create_loyalty_card({ name: "bonus" })
+  # [POST] /customer_lists/zrk6b/loyalty_cards with { headers: { "X-Access-Token": "access_token1" }, body: { name: "bonus" } }
+  ```
+
+### CREATE_LOYALTY_OPERATION
+
+- Initialized with `client_attrs = { access_token: "access_token1" }`
+  ```ruby
+  client.create_loyalty_operation("zrk6b", { delta: "4.2" }, "wy3xz")
+  # [POST] /customer_lists/wy3xz/loyalty_cards/zrk6b/operations with { headers: { "X-Access-Token": "access_token1" }, body: { delta: "4.2" } }
+  ```
+- Initialized with `client_attrs = { access_token: "access_token1", customer_list_id: "q2brk" }`
+  ```ruby
+  client.create_loyalty_operation("zrk6b", { delta: "4.2" })
+  # [POST] /customer_lists/q2brk/loyalty_cards/zrk6b/operations with { headers: { "X-Access-Token": "access_token1" }, body: { delta: "4.2" } }
+  ```

data/lib/hubrise_client/base.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module HubriseClient
   class Base
     USE_HTTPS           = true
-    DEFAULT_API_HOST    = "api.hubrise.com".freeze
-    DEFAULT_API_PORT    = "443".freeze
-    DEFAULT_OAUTH_HOST  = "manager.hubrise.com".freeze
-    DEFAULT_OAUTH_PORT  = "443".freeze
+    DEFAULT_API_HOST    = "api.hubrise.com"
+    DEFAULT_API_PORT    = "443"
+    DEFAULT_OAUTH_HOST  = "manager.hubrise.com"
+    DEFAULT_OAUTH_PORT  = "443"
 
     attr_accessor :access_token,
                   :app_instance_id,
@@ -16,7 +17,7 @@ module HubriseClient
                   :logger,
                   :request_callback
 
-    def initialize(app_id, app_secret, params = {}) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def initialize(app_id, app_secret, params = {})
       @app_id     = app_id
       @app_secret = app_secret
       @api_host   = params[:api_host] || DEFAULT_API_HOST
@@ -29,7 +30,7 @@ module HubriseClient
       initialize_scope_params(params)
 
       @verbous = !!params[:verbous]
-      unless (@logger = params[:logger]) # rubocop:disable Style/GuardClause
+      unless (@logger = params[:logger])
         @logger = Logger.new(STDOUT)
         @logger.level = @verbous ? Logger::DEBUG : Logger::WARN
       end
@@ -47,9 +48,9 @@ module HubriseClient
 
     def authorize!(authorization_code)
       api_response = api_request(oauth2_hubrise_hostname_with_version).perform(:post, "/token",
-                                                                                client_id: @app_id,
-                                                                                client_secret: @app_secret,
-                                                                                code: authorization_code)
+                                                                               client_id: @app_id,
+                                                                               client_secret: @app_secret,
+                                                                               code: authorization_code)
 
       case api_response.code
       when "200"
@@ -65,7 +66,7 @@ module HubriseClient
 
     protected
 
-    def initialize_scope_params(params) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/LineLength
+    def initialize_scope_params(params)
       @access_token     = params[:access_token] || params["access_token"]
       @app_instance_id  = params[:app_instance_id] || params["app_instance_id"]
       @user_id          = params[:user_id] || params["user_id"]
@@ -78,9 +79,13 @@ module HubriseClient
     def call_api(path, method = :get, data: {}, headers: {}, json: true)
       raise(HubriseAccessTokenMissing) if @access_token.nil?
 
-      api_request("#{@api_host}:#{@api_port}/#{version}", @access_token).perform(method, path, data, json: json,
-                                                                                                     headers: headers,
-                                                                                                     &@request_callback)
+      api_request("#{@api_host}:#{@api_port}/#{version}", @access_token)
+        .perform(method,
+                 path,
+                 data,
+                 json: json,
+                 headers: headers,
+                 &@request_callback)
     end
 
     def api_request(hostname, access_token = nil)
@@ -88,7 +93,7 @@ module HubriseClient
         hostname: hostname,
         access_token: access_token,
         use_https: @use_https,
-        logger: @logger
+        logger: @verbous && @logger
       )
     end
 

data/lib/hubrise_client/request.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
 module HubriseClient
   class Request
     REQUESTS_HASH = {
       get: Net::HTTP::Get,
       post: Net::HTTP::Post,
       put: Net::HTTP::Put,
-      delete: Net::HTTP::Delete
+      patch: Net::HTTP::Patch,
+      delete: Net::HTTP::Delete,
     }.freeze
 
+    attr_reader :http_request
     def initialize(hostname:, access_token: nil, use_https: false, logger: nil)
       @hostname     = hostname
       @access_token = access_token
@@ -15,23 +18,24 @@ module HubriseClient
       @logger       = logger
     end
 
-    def perform(method, path, data, json: true, headers: {}, callback: nil)
-      uri           = URI.parse(@protocol + "://" + @hostname + path)
-      http_request  = build_request(uri, method, data, json: json, headers: headers)
-      http_response = perform_request(uri, http_request)
+    def perform(method, path, data, json: true, headers: {})
+      uri = URI.parse(@protocol + "://" + @hostname + path)
+      @http_request = build_request(uri, method, data, json: json, headers: headers)
+      @http_response = perform_request(uri, @http_request)
+      @response = Response.new(@http_response)
 
-      case http_response
+      case @http_response
       when Net::HTTPUnauthorized
         raise InvalidHubriseToken
       else
-        raise(HubriseError, "Unexpected error") if http_response.code.start_with?("5")
+        raise(HubriseError, "Unexpected error") if @http_response.code.start_with?("5")
 
-        Response.new(http_response)
+        @response
       end
     rescue Errno::ECONNREFUSED
       raise HubriseError, "API is not reachable"
     ensure
-      yield(http_request, http_response) if http_request && block_given?
+      yield(self, @response) if @http_request && block_given?
     end
 
     protected
@@ -40,9 +44,7 @@ module HubriseClient
       headers["X-Access-Token"] = @access_token if @access_token
 
       if method == :get
-        if data && data.count > 0
-          uri = add_params_to_uri(uri, data)
-        end
+        uri = add_params_to_uri(uri, data) if data&.count&.positive?
 
         data = nil
       elsif json

data/lib/hubrise_client/response.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module HubriseClient
   class Response
     attr_reader :code, :failed, :data, :error_type, :error_message, :errors, :http_response
-    alias failed? failed
+    alias_method :failed?, :failed
 
     def initialize(http_response)
       @http_response  = http_response
@@ -9,7 +10,7 @@ module HubriseClient
 
       json_body = begin
                     JSON.parse(http_response.body)
-                  rescue StandardError
+                  rescue JSON::ParserError
                     nil
                   end
 
@@ -17,9 +18,9 @@ module HubriseClient
 
       case http_response
       when Net::HTTPSuccess
-        @failed  = false
+        @failed = false
       else
-        @failed  = true
+        @failed = true
         if json_body
           @errors         = json_body["errors"]
           @error_type     = json_body["error_type"]

data/lib/hubrise_client/v1.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # rubocop:disable Naming/AccessorMethodName
 module HubriseClient
   class V1 < Base
@@ -111,7 +112,7 @@ module HubriseClient
 
     def update_customer(customer_id, params, customer_list_id = nil)
       call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/customers/#{customer_id}", :put,
-                data: params)
+               data: params)
     end
 
     # --------------------
@@ -150,8 +151,8 @@ module HubriseClient
     # --------------------
     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)
+                                                                             headers: { "Content-Type" => mime_type },
+                                                                             json: false)
     end
 
     def get_image(image_id, catalog_id = nil)
@@ -162,6 +163,49 @@ module HubriseClient
       call_api("/catalogs/#{catalog_id_fallback(catalog_id)}/images/#{image_id}/data")
     end
 
+    # --------------------
+    # Inventory
+    # --------------------
+    def get_inventory(catalog_id = nil, location_id = nil)
+      endpoint = inventory_endpoint(catalog_id, location_id)
+      call_api(endpoint)
+    end
+
+    def update_inventory(params, catalog_id = nil, location_id = nil)
+      endpoint = inventory_endpoint(catalog_id, location_id)
+      call_api(endpoint, :put, data: params)
+    end
+
+    def patch_inventory(params, catalog_id = nil, location_id = nil)
+      endpoint = inventory_endpoint(catalog_id, location_id)
+      call_api(endpoint, :patch, data: params)
+    end
+
+    def inventory_endpoint(catalog_id = nil, location_id = nil)
+      if location_id
+        "/catalogs/#{catalog_id_fallback(catalog_id)}/locations/#{location_id}/inventory"
+      else
+        "/catalogs/#{catalog_id_fallback(catalog_id)}/location/inventory"
+      end
+    end
+
+    private :inventory_endpoint
+
+    # --------------------
+    # Loyalty cards
+    # --------------------
+    def create_loyalty_card(params, customer_list_id = nil)
+      call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/loyalty_cards", :post, data: params)
+    end
+
+    def create_loyalty_operation(loyalty_card_id, params, customer_list_id = nil)
+      call_api(
+        "/customer_lists/#{customer_list_id_fallback(customer_list_id)}/loyalty_cards/#{loyalty_card_id}/operations",
+        :post,
+        data: params
+      )
+    end
+
     private
 
     def customer_list_id_fallback(customer_list_id)

data/lib/hubrise_client/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HubriseClient
-  VERSION = "2.0.2".freeze
+  VERSION = "2.0.3"
 end

data/lib/hubrise_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "net/http"
 require "json"
 require "uri"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_client
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Antoine Monnier
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: HubRise Ruby client