seatsio 32.5.0 → 34.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d21c2748ea74524c6c7889fd9ef694673a5fb9d52c31a8feac6b4de8ec43f69
-  data.tar.gz: 51678457cdd12e5e6f1ea7f0793d91c2b9cb1560b7fd924a3610cf6d09e4aaa9
+  metadata.gz: d8cf426e69e7b398fe7f656998b5918baaadb7366a34d3f69ba6923944e1a5e6
+  data.tar.gz: 535d5c8073412db116e808ab2ed465ce788e195396d88660ad4c9aaa682c3465
 SHA512:
-  metadata.gz: '08be1edebfa338f7f2563dd4cb00755c2092bb2582c0b24356d0ed33c6764b1b4d3ae8f8e33f4b6b743183d14bafdf063c9e26ab5121fb269e37ff8c62d04c4b'
-  data.tar.gz: 9394d8015e7314e6543c7de272e687ebfb9267da58cf4d68374f205c98403414765e61c40534fe54ba74b48d43b5bd1929105a722e9897759370ffcb005fa8f3
+  metadata.gz: 6c002279fb10b41d5c1c17d4994eb74f6d4e43f5c565475e70abff3bd6944598c004163cd16acda88827e1ea436d909bb181822b20c2900bb7ad2aa4be630997
+  data.tar.gz: f1216cf4ed428193d8cc3a2450b090fc49cc226b95ca6cd2efd3033ff00de494a365f398cc21d191f1bec3b533cff32d7eb60d35b2018994e8b04369a50cf536

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.3']
+        ruby-version: ['2.4']
 
     steps:
     - uses: actions/checkout@v2

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seatsio (32.5.0)
+    seatsio (34.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,8 +32,8 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -49,4 +49,4 @@ DEPENDENCIES
   webmock (~> 3.4, >= 3.4.2)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -3,7 +3,7 @@
 [![Build](https://github.com/seatsio/seatsio-ruby/workflows/Build/badge.svg)](https://github.com/seatsio/seatsio-ruby/actions/workflows/build.yml)
 [![Gem Version](https://badge.fury.io/rb/seatsio.svg)](https://badge.fury.io/rb/seatsio)
 
-This is the official Ruby client library for the [Seats.io V2 REST API](https://docs.seats.io/docs/api-overview), supporting Ruby 2.2.0+
+This is the official Ruby client library for the [Seats.io V2 REST API](https://docs.seats.io/docs/api-overview), supporting Ruby 2.4.0+
 
 ## Versioning
 
@@ -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.
@@ -121,4 +151,15 @@ This exception contains a message string describing what went wrong, and also tw
 This library supports [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff).
 
 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. This happens at most 5 times, before giving up (after approximately 15 seconds).
+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
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key", max_retries = 3)
+```
+
+Passing in 0 disables exponential backoff completely. In that case, the client will never retry a failed request.

data/lib/seatsio/chart_reports.rb

@@ -6,8 +6,8 @@ require 'cgi'
 
 module Seatsio
   class ChartReportsClient
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def by_label(chart_key, book_whole_tables = nil)

data/lib/seatsio/charts.rb

@@ -11,8 +11,8 @@ module Seatsio
   class ChartsClient
     attr_reader :archive
 
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
       @archive = Pagination::Cursor.new(Chart, 'charts/archive', @http_client)
     end
 

data/lib/seatsio/domain.rb

@@ -201,25 +201,6 @@ module Seatsio
     end
   end
 
-  class ObjectStatus
-    FREE = 'free'
-    BOOKED = 'booked'
-    HELD = 'reservedByToken'
-
-    attr_reader :status, :hold_token, :order_id, :ticket_type,
-                :quantity, :extra_data, :for_sale
-
-    def initialize(data)
-      @status = data['status']
-      @hold_token = data['holdToken']
-      @order_id = data['orderId']
-      @ticket_type = data['ticketType']
-      @quantity = data['quantity']
-      @extra_data = data['extraData']
-      @for_sale = data['forSale']
-    end
-  end
-
   class ChangeObjectStatusResult
 
     attr_reader :objects
@@ -261,7 +242,7 @@ module Seatsio
     end
   end
 
-  class ChartReportItem
+  class ChartObjectInfo
 
     attr_reader :label, :labels, :ids, :category_key, :category_label, :section, :entrance, :capacity, :object_type,
                 :left_neighbour, :right_neighbour, :book_as_a_whole, :distance_to_focal_point
@@ -292,7 +273,7 @@ module Seatsio
       data.each do |key, values|
         items[key] = []
         values.each do |value|
-          items[key] << ChartReportItem.new(value)
+          items[key] << ChartObjectInfo.new(value)
         end
       end
       @items = items
@@ -307,7 +288,7 @@ module Seatsio
       if data.is_a? Array
         items = []
         data.each do |item|
-          items << EventReportItem.new(item)
+          items << EventObjectInfo.new(item)
         end
         @items = items
       elsif data.nil?
@@ -317,7 +298,7 @@ module Seatsio
         data.each do |key, values|
           items[key] = []
           values.each do |value|
-            items[key] << EventReportItem.new(value)
+            items[key] << EventObjectInfo.new(value)
           end
         end
         @items = items
@@ -325,13 +306,17 @@ module Seatsio
     end
   end
 
-  class EventReportItem
+  class EventObjectInfo
+    FREE = 'free'
+    BOOKED = 'booked'
+    HELD = 'reservedByToken'
+
     attr_reader :labels, :ids, :label, :order_id, :extra_data, :capacity, :status,
                 :category_key, :entrance, :object_type, :hold_token, :category_label,
                 :ticket_type, :num_booked, :num_free, :num_held, :for_sale, :section,
                 :is_accessible, :is_companion_seat, :has_restricted_view, :displayed_object_type,
                 :left_neighbour, :right_neighbour, :is_selectable, :is_disabled_by_social_distancing, :channel,
-                :book_as_a_whole, :distance_to_focal_point
+                :book_as_a_whole, :distance_to_focal_point, :holds
 
     def initialize(data)
       @status = data['status']
@@ -363,6 +348,7 @@ module Seatsio
       @channel = data['channel']
       @book_as_a_whole = data['bookAsAWhole']
       @distance_to_focal_point = data['distanceToFocalPoint']
+      @holds = data['holds']
     end
   end
 
@@ -506,7 +492,7 @@ module Seatsio
   def to_object_details(data)
     object_details = {}
     data.each do |key, value|
-      object_details[key] = EventReportItem.new(value)
+      object_details[key] = EventObjectInfo.new(value)
     end
     object_details
   end

data/lib/seatsio/event_reports.rb

@@ -7,8 +7,8 @@ require 'cgi'
 module Seatsio
   # Client for fetching event reports
   class EventReportsClient
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def by_status(event_key, status = nil)

data/lib/seatsio/events.rb

@@ -11,8 +11,8 @@ require "seatsio/events/change_best_available_object_status_request"
 module Seatsio
 
   class EventsClient
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def create(chart_key: nil, event_key: nil, table_booking_config: nil, social_distancing_ruleset_key: nil)
@@ -43,14 +43,23 @@ module Seatsio
       @http_client.post("events/#{key}/actions/update-extra-data", payload)
     end
 
-    def retrieve_object_status(key:, object_key:)
-      url = "events/#{key}/objects/#{CGI::escape(object_key).gsub('+', '%20')}"
-      response = @http_client.get(url)
-      ObjectStatus.new(response)
+    def retrieve_object_info(key:, label:)
+      result = retrieve_object_infos key: key, labels: [label]
+      result[label]
+    end
+
+    def retrieve_object_infos(key:, labels:)
+      url = "events/#{key}/objects"
+      query_params = URI.encode_www_form(labels.map { |label| ['label', label]})
+      response = @http_client.get(url, query_params)
+      response.each do |key, value|
+        response[key] = EventObjectInfo.new(value)
+      end
+      response
     end
 
     def book(event_key_or_keys, object_or_objects, hold_token: nil, order_id: nil, keep_extra_data: nil, ignore_channels: nil, channel_keys: nil, ignore_social_distancing: nil)
-      self.change_object_status(event_key_or_keys, object_or_objects, ObjectStatus::BOOKED, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys, ignore_social_distancing: ignore_social_distancing)
+      self.change_object_status(event_key_or_keys, object_or_objects, Seatsio::EventObjectInfo::BOOKED, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys, ignore_social_distancing: ignore_social_distancing)
     end
 
     def change_object_status(event_key_or_keys, object_or_objects, status, hold_token: nil, order_id: nil, keep_extra_data: nil, ignore_channels: nil, channel_keys: nil, ignore_social_distancing: nil)
@@ -72,7 +81,7 @@ module Seatsio
     end
 
     def hold(event_key_or_keys, object_or_objects, hold_token, order_id: nil, keep_extra_data: nil, ignore_channels: nil, channel_keys: nil, ignore_social_distancing: nil)
-      change_object_status(event_key_or_keys, object_or_objects, ObjectStatus::HELD, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys, ignore_social_distancing: ignore_social_distancing)
+      change_object_status(event_key_or_keys, object_or_objects, Seatsio::EventObjectInfo::HELD, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys, ignore_social_distancing: ignore_social_distancing)
     end
 
     def change_best_available_object_status(key, number, status, categories: nil, hold_token: nil, extra_data: nil, ticket_types: nil, order_id: nil, keep_extra_data: nil, ignore_channels: nil, channel_keys: nil)
@@ -82,15 +91,15 @@ module Seatsio
     end
 
     def book_best_available(key, number, categories: nil, hold_token: nil, order_id: nil, keep_extra_data: nil, extra_data: nil, ticket_types: nil, ignore_channels: nil, channel_keys: nil)
-      change_best_available_object_status(key, number, ObjectStatus::BOOKED, categories: categories, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, extra_data: extra_data, ticket_types: ticket_types, ignore_channels: ignore_channels, channel_keys: channel_keys)
+      change_best_available_object_status(key, number, Seatsio::EventObjectInfo::BOOKED, categories: categories, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, extra_data: extra_data, ticket_types: ticket_types, ignore_channels: ignore_channels, channel_keys: channel_keys)
     end
 
     def hold_best_available(key, number, hold_token, categories: nil, order_id: nil, keep_extra_data: nil, extra_data: nil, ticket_types: nil, ignore_channels: nil, channel_keys: nil)
-      change_best_available_object_status(key, number, ObjectStatus::HELD, categories: categories, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, extra_data: extra_data, ticket_types: ticket_types, ignore_channels: ignore_channels, channel_keys: channel_keys)
+      change_best_available_object_status(key, number, Seatsio::EventObjectInfo::HELD, categories: categories, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, extra_data: extra_data, ticket_types: ticket_types, ignore_channels: ignore_channels, channel_keys: channel_keys)
     end
 
     def release(event_key_or_keys, object_or_objects, hold_token: nil, order_id: nil, keep_extra_data: nil, ignore_channels: nil, channel_keys: nil)
-      change_object_status(event_key_or_keys, object_or_objects, ObjectStatus::FREE, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys)
+      change_object_status(event_key_or_keys, object_or_objects, Seatsio::EventObjectInfo::FREE, hold_token: hold_token, order_id: order_id, keep_extra_data: keep_extra_data, ignore_channels: ignore_channels, channel_keys: channel_keys)
     end
 
     def delete(key:)

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/hold_tokens.rb

@@ -11,8 +11,8 @@ module Seatsio
 
   class HoldTokensClient
     # @return [Seatsio::HoldTokensClient]
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def create(expires_in_minutes: nil)

data/lib/seatsio/httpClient.rb

@@ -6,10 +6,11 @@ require "uri"
 
 module Seatsio
   class HttpClient
-    def initialize(secret_key, workspace_key, base_url)
+    def initialize(secret_key, workspace_key, base_url, max_retries)
       @secret_key = Base64.encode64(secret_key)
       @workspace_key = workspace_key
       @base_url = base_url
+      @max_retries = max_retries
     end
 
     def execute(*args)
@@ -18,12 +19,18 @@ module Seatsio
         unless @workspace_key.nil?
           headers[:'X-Workspace-Key'] = @workspace_key
         end
-        if args[2].include? :params
-          headers[:params] = args[2][:params]
-        end
 
         url = "#{@base_url}/#{args[1]}"
 
+        if args[2].include? :params
+          params = args[2][:params]
+          if params.is_a? Hash
+            headers[:params] = params
+          else
+            url += "?" + params
+          end
+        end
+
         request_options = { method: args[0], url: url, headers: headers }
 
         if args[0] == :post
@@ -41,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
@@ -55,7 +66,7 @@ module Seatsio
         begin
           return RestClient::Request.execute(request_options)
         rescue RestClient::ExceptionWithResponse => e
-          if e.response.code != 429 || retry_count >= 5
+          if e.response.code != 429 || retry_count >= @max_retries
             raise e
           else
             wait_time = (2 ** (retry_count + 2)) / 10.0

data/lib/seatsio/subaccounts.rb

@@ -8,8 +8,8 @@ require "seatsio/domain"
 
 module Seatsio
   class SubaccountsClient
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def create(name: nil)

data/lib/seatsio/usage_reports.rb

@@ -6,8 +6,8 @@ require 'cgi'
 
 module Seatsio
   class UsageReportsClient
-    def initialize(secret_key, workspace_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def summary_for_all_months

data/lib/seatsio/version.rb

@@ -1,3 +1,3 @@
 module Seatsio
-  VERSION = "32.5.0"
+  VERSION = "34.0.0"
 end

data/lib/seatsio/workspaces.rb

@@ -9,8 +9,8 @@ require "seatsio/domain"
 module Seatsio
   class WorkspacesClient
 
-    def initialize(secret_key, base_url)
-      @http_client = ::Seatsio::HttpClient.new(secret_key, nil, base_url)
+    def initialize(http_client)
+      @http_client = http_client
     end
 
     def create(name:, is_test: nil)

data/lib/seatsio.rb

@@ -13,19 +13,22 @@ module Seatsio
     attr_reader :charts, :subaccounts, :workspaces, :events,
                 :hold_tokens, :chart_reports, :event_reports, :usage_reports
 
-    def initialize(region, secret_key, workspace_key = nil)
+    def initialize(region, secret_key, workspace_key = nil, max_retries = 5)
       base_url = region.url
-      @charts = ChartsClient.new(secret_key, workspace_key, base_url)
-      @subaccounts = SubaccountsClient.new(secret_key, workspace_key, base_url)
-      @workspaces = WorkspacesClient.new(secret_key, base_url)
-      @events = EventsClient.new(secret_key, workspace_key, base_url)
-      @hold_tokens = HoldTokensClient.new(secret_key, workspace_key, base_url)
-      @chart_reports = ChartReportsClient.new(secret_key, workspace_key, base_url)
-      @event_reports = EventReportsClient.new(secret_key, workspace_key, base_url)
-      @usage_reports = UsageReportsClient.new(secret_key, workspace_key, base_url)
+      @http_client = Seatsio::HttpClient.new(secret_key, workspace_key, base_url, max_retries)
+      @charts = ChartsClient.new(@http_client)
+      @subaccounts = SubaccountsClient.new(@http_client)
+      @workspaces = WorkspacesClient.new(@http_client)
+      @events = EventsClient.new(@http_client)
+      @hold_tokens = HoldTokensClient.new(@http_client)
+      @chart_reports = ChartReportsClient.new(@http_client)
+      @event_reports = EventReportsClient.new(@http_client)
+      @usage_reports = UsageReportsClient.new(@http_client)
     end
+
   end
 
+
   class Region
     attr_reader :url
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: 32.5.0
+  version: 34.0.0
 platform: ruby
 authors:
 - Seats.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler