seatsio 33.0.0 → 35.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9b9ede155afb77e4c55fac2ac7a9da697e5cf7f4f80e9a772002879718166d
-  data.tar.gz: ed80c3e21eca4567f4e613bfe1ed7e4dba90e62f4605dc2b4b47d1aface142aa
+  metadata.gz: 4e9e68de3cd7eac52d0604ab81e6572bc897bfed4ef71ec40f0ef2bf598d5ef0
+  data.tar.gz: 999a8991efff73ef71f0c4b0b18bb41d589c0a7aaf7a11784d2f65db5f803b8a
 SHA512:
-  metadata.gz: d4e792dcbdc73e9967de1c377b3a092dc4ba0f00615e8b57724580aa3cd93e29dcad82086f1ec1e9cd6ffc494ed6be4b85addcc01f422c4dd5462e286df836db
-  data.tar.gz: 31648860929a47b3b368504c32d573dda0f3bfa2b6f679d645c8c7577a0764aedf27660061f81800c2852769386e238b2644b892fc728bb2e55785631738fa13
+  metadata.gz: 2b40d67fadfc461bbf774d2ae580b467dc7b81d63e0f245b92c3532a571e061cb0ee73b0e6f3650496c0a3dbbd523756ce70414f3c243014286134143a6af434
+  data.tar.gz: 06776edd55219aee088bc763bd91e657c0b8c3f72a9358e7d6ca9b6b84fcc1149aaa8f63d9c1401008201511f7ff96870aba496690917e7b3a97fd3310cff304

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/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 /.idea
 /seatsio-ruby.iml
+/out

data/.ruby-version

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seatsio (33.0.0)
+    seatsio (35.1.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

@@ -315,7 +315,7 @@ module Seatsio
                 :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,
+                :left_neighbour, :right_neighbour, :is_available, :is_disabled_by_social_distancing, :channel,
                 :book_as_a_whole, :distance_to_focal_point, :holds
 
     def initialize(data)
@@ -343,7 +343,7 @@ 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']

data/lib/seatsio/event_reports.rb

@@ -71,16 +71,28 @@ 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_availability_reason(event_key, availability_reason = nil)
+      fetch_report('byAvailabilityReason', event_key, availability_reason)
+    end
+
+    def summary_by_availability_reason(event_key)
+      fetch_summary_report('byAvailabilityReason', event_key)
+    end
+
+    def deep_summary_by_availability_reason(event_key)
+      fetch_deep_summary_report('byAvailabilityReason', event_key)
     end
 
     def by_channel(event_key, channelKey = nil)

data/lib/seatsio/events/change_object_status_request.rb

@@ -1,4 +1,4 @@
-def create_change_object_status_request(object_or_objects, status, hold_token, order_id, event_key_or_keys, keep_extra_data, ignore_channels, channel_keys, ignore_social_distancing)
+def create_change_object_status_request(object_or_objects, status, hold_token, order_id, event_key_or_keys, keep_extra_data, ignore_channels, channel_keys, ignore_social_distancing, allowed_previous_statuses, rejected_previous_statuses)
   result = {}
   result[:objects] = normalize(object_or_objects)
   result[:status] = status
@@ -13,6 +13,8 @@ def create_change_object_status_request(object_or_objects, status, hold_token, o
   result[:ignoreChannels] = ignore_channels if ignore_channels != nil
   result[:channelKeys] = channel_keys if channel_keys != nil
   result[:ignoreSocialDistancing] = ignore_social_distancing if ignore_social_distancing != nil
+  result[:allowedPreviousStatuses] = allowed_previous_statuses if allowed_previous_statuses != nil
+  result[:rejectedPreviousStatuses] = rejected_previous_statuses if rejected_previous_statuses != nil
   result
 end
 

data/lib/seatsio/events.rb

@@ -62,12 +62,12 @@ module Seatsio
       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)
-      request = create_change_object_status_request(object_or_objects, status, hold_token, order_id, event_key_or_keys, keep_extra_data, ignore_channels, channel_keys, ignore_social_distancing)
+    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, allowed_previous_statuses: nil, rejected_previous_statuses: nil)
+      request = create_change_object_status_request(object_or_objects, status, hold_token, order_id, event_key_or_keys, keep_extra_data, ignore_channels, channel_keys, ignore_social_distancing, allowed_previous_statuses, rejected_previous_statuses)
       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
 

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 = "35.1.0"
 end

metadata

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