seatsio 33.0.0 → 33.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9b9ede155afb77e4c55fac2ac7a9da697e5cf7f4f80e9a772002879718166d
-  data.tar.gz: ed80c3e21eca4567f4e613bfe1ed7e4dba90e62f4605dc2b4b47d1aface142aa
+  metadata.gz: 33473b549ec1ccc19d4cd335a986402488cb147e6578a5f02cfb841ef319e3a3
+  data.tar.gz: e0242b450577e6497845bd29a43435169f5e7c9425912c2097282382d5636bee
 SHA512:
-  metadata.gz: d4e792dcbdc73e9967de1c377b3a092dc4ba0f00615e8b57724580aa3cd93e29dcad82086f1ec1e9cd6ffc494ed6be4b85addcc01f422c4dd5462e286df836db
-  data.tar.gz: 31648860929a47b3b368504c32d573dda0f3bfa2b6f679d645c8c7577a0764aedf27660061f81800c2852769386e238b2644b892fc728bb2e55785631738fa13
+  metadata.gz: d66a102bba053bffd67fe4c99d8f43e57307aa2b4d8c90fd79c19ccea7b5c8f7ab5c58bf84cef2312555ae0c4adab0bb1075546147d0b146582232d7cc06dad3
+  data.tar.gz: 37904aca59ceb8321f4cf1ffdb75ce4f445222737cf4aab12536064848b8cd23b3824a9130938ac8eeb04d29710870f35d4fe7ce5bdc7852b130b03c4c7cfc16

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seatsio (33.0.0)
+    seatsio (33.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -52,6 +52,22 @@ client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-status")
 ```
 
+### Retrieving object category and status (and other information)
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
+object_infos = client.events.retrieve_object_infos key: event.key, labels: ['A-1', 'A-2']
+
+puts object_infos['A-1'].category_key
+puts object_infos['A-1'].category_label
+puts object_infos['A-1'].status
+
+puts object_infos['A-2'].category_key
+puts object_infos['A-2'].category_label
+puts object_infos['A-2'].status
+```
+
 ### Listing all charts
 
 ```ruby
@@ -73,7 +89,8 @@ Each page is Enumerable, and it has `next_page_starts_after` and `previous_page_
 
 ```ruby
 # ... user initially opens the screen ...
-
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 firstPage = client.charts.list.first_page()
 firstPage.each do |chart|
   puts chart.key
@@ -82,7 +99,8 @@ end
 
 ```ruby
 # ... user clicks on 'next page' button ...
-
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 nextPage = client.charts.list.page_after(firstPage.next_page_starts_after)
 nextPage.each do |chart|
   puts chart.key
@@ -91,7 +109,8 @@ end
 
 ```ruby
 # ... user clicks on 'previous page' button ...
-
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 previousPage = client.charts.list.page_before(nextPage.previous_page_ends_before)
 previousPage.each do |chart|
   puts chart.key
@@ -102,10 +121,21 @@ end
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key") # can be found on https://app.seats.io/company-settings
 client.workspaces.create name: "a workspace"
 ```
 
+### Creating a chart and an event with the company admin key
+
+```ruby
+require('seatsio')
+# company admin key can be found on https://app.seats.io/company-settings
+# workspace public key can be found on https://app.seats.io/workspace-settings
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key", "my-workspace-public-key")
+chart = client.charts.create
+event = client.events.create chart_key: chart.key
+```
+
 # Error handling
 
 When an API call results in a 4xx or 5xx error (e.g. when a chart could not be found), a SeatsioException is thrown.
@@ -123,6 +153,8 @@ This library supports [exponential backoff](https://en.wikipedia.org/wiki/Expone
 When you send too many concurrent requests, the server returns an error `429 - Too Many Requests`. The client reacts to this by waiting for a while, and then retrying the request.
 If the request still fails with an error `429`, it waits a little longer, and try again. By default this happens 5 times, before giving up (after approximately 15 seconds).
 
+We throw a `RateLimitExceededException` (which is a subclass of `SeatsioException`) when exponential backoff eventually fails.
+
 To change the maximum number of retries, create the client as follows:
 
 ```ruby

data/lib/seatsio/exception.rb

@@ -3,6 +3,9 @@ module Seatsio
     class SeatsioException < StandardError
     end
 
+    class RateLimitExceededException < SeatsioException
+    end
+
     class NoMorePagesException < SeatsioException
     end
 

data/lib/seatsio/httpClient.rb

@@ -31,7 +31,6 @@ module Seatsio
           end
         end
 
-
         request_options = { method: args[0], url: url, headers: headers }
 
         if args[0] == :post
@@ -49,7 +48,11 @@ module Seatsio
       rescue RestClient::NotFound => e
         raise Exception::NotFoundException.new(e.response)
       rescue RestClient::ExceptionWithResponse => e
-        raise Exception::SeatsioException.new(e.response)
+        if e.response.code == 429
+          raise Exception::RateLimitExceededException.new(e.response)
+        else
+          raise Exception::SeatsioException.new(e.response)
+        end
       rescue RestClient::Exceptions::Timeout
         raise Exception::SeatsioException.new("Timeout ERROR")
       rescue SocketError

data/lib/seatsio/version.rb

@@ -1,3 +1,3 @@
 module Seatsio
-  VERSION = "33.0.0"
+  VERSION = "33.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: 33.0.0
+  version: 33.1.0
 platform: ruby
 authors:
 - Seats.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler