seatsio 32.6.0 → 35.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c59ef6860b18c605ab3c844cac4f320215a981421129ca2eb7d537acaea1f738
-  data.tar.gz: 25cd36b90507702986d11172e2f0345686e2bf14a372f3af42323b50b37196a5
+  metadata.gz: 874fcd1fd4238073124c6f5e5eb058dd38fc5a724d248b14eded7eef774f5c7f
+  data.tar.gz: 264386019f1f5a6260d54c6b0c94a42eb7ca4d5620717f9de2369e13e6fe0195
 SHA512:
-  metadata.gz: 0dee64ba2af519b0b0ae00cbbb68a936d280aa2aafc130c3c7d4ca9dbdcefb302971ac577d15b43b1b3e1a89620501825d02e877f298a2763cbdbdc9b08dbfed
-  data.tar.gz: 6788d6eea52021eb3d04b97533f9594270af300cee70fe80a6e822407d940a3fccd1f821a151ac78f2218d1db22618fa86c48ac5dd05fb9909917e96c3070217
+  metadata.gz: 63e8eefcf42622491e89bddc697773d6056629f89aa7d70ef6a6deeb08e6d3961fcaedc74d708fffed9ec5fc001bef1bb94e00a59e666a768878dc39536c9e64
+  data.tar.gz: 6feb7bbe4410abfbe5742ec81c4164093a9187ec1b13ae6be92650e89f4da5d17f485d150f1c8e969a8fea42c3266a993854434eeafb96d4a3553817411f096e

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.6.0)
+    seatsio (35.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -49,4 +49,4 @@ DEPENDENCIES
   webmock (~> 3.4, >= 3.4.2)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -3,12 +3,16 @@
 [![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
 
 seatsio-ruby follows semver since v23.3.0.
 
+## API reference
+
+You can find a full API reference at https://www.rubydoc.info/gems/seatsio/
+
 ## Examples
 
 ### Creating a chart and an event
@@ -52,6 +56,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 +93,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 +103,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 +113,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 +125,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 +157,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/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
+                :left_neighbour, :right_neighbour, :is_available, :is_disabled_by_social_distancing, :channel,
+                :book_as_a_whole, :distance_to_focal_point, :holds
 
     def initialize(data)
       @status = data['status']
@@ -358,11 +343,12 @@ module Seatsio
       @displayed_object_type = data['displayedObjectType']
       @left_neighbour = data['leftNeighbour']
       @right_neighbour = data['rightNeighbour']
-      @is_selectable = data['isSelectable']
+      @is_available = data['isAvailable']
       @is_disabled_by_social_distancing = data['isDisabledBySocialDistancing']
       @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

@@ -71,16 +71,16 @@ module Seatsio
       fetch_deep_summary_report('bySection', event_key)
     end
 
-    def by_selectability(event_key, selectability = nil)
-      fetch_report('bySelectability', event_key, selectability)
+    def by_availability(event_key, availability = nil)
+      fetch_report('byAvailability', event_key, availability)
     end
 
-    def summary_by_selectability(event_key)
-      fetch_summary_report('bySelectability', event_key)
+    def summary_by_availability(event_key)
+      fetch_summary_report('byAvailability', event_key)
     end
 
-    def deep_summary_by_selectability(event_key)
-      fetch_deep_summary_report('bySelectability', event_key)
+    def deep_summary_by_availability(event_key)
+      fetch_deep_summary_report('byAvailability', event_key)
     end
 
     def by_channel(event_key, channelKey = nil)

data/lib/seatsio/events.rb

@@ -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)
@@ -58,7 +67,7 @@ module Seatsio
       request[:params] = {
           :expand => 'objects'
       }
-      response = @http_client.post("seasons/actions/change-object-status", request)
+      response = @http_client.post("events/groups/actions/change-object-status", request)
       ChangeObjectStatusResult.new(response)
     end
 
@@ -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/httpClient.rb

@@ -19,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
@@ -42,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 = "32.6.0"
+  VERSION = "35.0.0"
 end

metadata

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