seatsio 31.0.0 → 32.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1124000be835fc50c85b57259d3cc53d0efbb3625bff185329e412f0fd9b33
-  data.tar.gz: 4f85fb99913ddb488705092c483c88ada2da298a0f9b7dbcee90df3cae558a4d
+  metadata.gz: 4d21c2748ea74524c6c7889fd9ef694673a5fb9d52c31a8feac6b4de8ec43f69
+  data.tar.gz: 51678457cdd12e5e6f1ea7f0793d91c2b9cb1560b7fd924a3610cf6d09e4aaa9
 SHA512:
-  metadata.gz: fd5ed35d871c54d7101e78eaacb2fd9925ef0894e69d56150eecd671b04b8a01cafaabe57b51b94c02326c4a9acbdfe27fe1dbed1a680e3700c6d80ebef5723e
-  data.tar.gz: 933fe7bb11ebcc7e9c15f8efbe8dafbfb5c9b584f351f5cef9c949a51a0dd243eda159077d8be2b79b042e9eaab44947b1c1b1feaabddb8ca554bc487e11e3b9
+  metadata.gz: '08be1edebfa338f7f2563dd4cb00755c2092bb2582c0b24356d0ed33c6764b1b4d3ae8f8e33f4b6b743183d14bafdf063c9e26ab5121fb269e37ff8c62d04c4b'
+  data.tar.gz: 9394d8015e7314e6543c7de272e687ebfb9267da58cf4d68374f205c98403414765e61c40534fe54ba74b48d43b5bd1929105a722e9897759370ffcb005fa8f3

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: monthly
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: minitest
+    versions:
+    - 5.14.4

data/Gemfile.lock

@@ -1,36 +1,38 @@
 PATH
   remote: .
   specs:
-    seatsio (31.0.0)
+    seatsio (32.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    domain_name (0.5.20180417)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    hashdiff (0.4.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mime-types (3.2.2)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    minitest (5.11.3)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
     netrc (0.11.0)
-    public_suffix (3.1.0)
-    rake (13.0.1)
-    rest-client (2.0.2)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    safe_yaml (1.0.5)
+    rexml (3.2.5)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
-    webmock (3.6.0)
+    unf_ext (0.0.7.7)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -39,7 +41,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   minitest (~> 5.0)
   rake (~> 13.0)
   rest-client (~> 2.0, >= 2.0.2)

data/README.md

@@ -1,6 +1,7 @@
 # seatsio-ruby, the official Seats.io Ruby client library
 
-![Build](https://github.com/seatsio/seatsio-ruby/workflows/Build/badge.svg)
+[![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+
 
@@ -16,7 +17,7 @@ seatsio-ruby follows semver since v23.3.0.
 require('seatsio')
 client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key") # can be found on https://app.seats.io/workspace-settings
 chart = client.charts.create
-event = client.events.create key: chart.key
+event = client.events.create chart_key: chart.key
 ```
 
 ### Booking objects
@@ -113,3 +114,11 @@ This exception contains a message string describing what went wrong, and also tw
 
 * *errors*: a list of errors that the server returned. In most cases, this array will contain only one element, an instance of ApiError, containing an error code and a message.
 * *requestId*: the identifier of the request you made. Please mention this to us when you have questions, as it will make debugging easier.
+
+
+## Rate limiting - exponential backoff
+
+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).

data/lib/seatsio/chart_reports.rb

@@ -14,6 +14,10 @@ module Seatsio
       get_chart_report('byLabel', chart_key, book_whole_tables)
     end
 
+    def by_object_type(chart_key, book_whole_tables = nil)
+      get_chart_report('byObjectType', chart_key, book_whole_tables)
+    end
+
     def by_category_key(chart_key, book_whole_tables = nil)
       get_chart_report('byCategoryKey', chart_key, book_whole_tables)
     end

data/lib/seatsio/domain.rb

@@ -263,12 +263,13 @@ module Seatsio
 
   class ChartReportItem
 
-    attr_reader :label, :labels, :category_key, :category_label, :section, :entrance, :capacity, :object_type,
-                :left_neighbour, :right_neighbour, :book_as_a_whole
+    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
 
     def initialize(data)
       @label = data['label']
       @labels = data['labels']
+      @ids = data['ids']
       @category_label = data['categoryLabel']
       @category_key = data['categoryKey']
       @section = data['section']
@@ -278,6 +279,7 @@ module Seatsio
       @left_neighbour = data['leftNeighbour']
       @right_neighbour = data['rightNeighbour']
       @book_as_a_whole = data['bookAsAWhole']
+      @distance_to_focal_point = data['distanceToFocalPoint']
     end
   end
 
@@ -324,17 +326,18 @@ module Seatsio
   end
 
   class EventReportItem
-    attr_reader :labels, :label, :order_id, :extra_data, :capacity, :status,
+    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
+                :book_as_a_whole, :distance_to_focal_point
 
     def initialize(data)
       @status = data['status']
       @label = data['label']
       @labels = data['labels']
+      @ids = data['ids']
       @category_label = data['categoryLabel']
       @category_key = data['categoryKey']
       @ticket_type = data['ticketType']
@@ -359,6 +362,7 @@ module Seatsio
       @is_disabled_by_social_distancing = data['isDisabledBySocialDistancing']
       @channel = data['channel']
       @book_as_a_whole = data['bookAsAWhole']
+      @distance_to_focal_point = data['distanceToFocalPoint']
     end
   end
 

data/lib/seatsio/event_reports.rb

@@ -11,6 +11,10 @@ module Seatsio
       @http_client = ::Seatsio::HttpClient.new(secret_key, workspace_key, base_url)
     end
 
+    def by_status(event_key, status = nil)
+      fetch_report('byStatus', event_key, status)
+    end
+
     def summary_by_status(event_key)
       fetch_summary_report('byStatus', event_key)
     end
@@ -19,6 +23,22 @@ module Seatsio
       fetch_deep_summary_report('byStatus', event_key)
     end
 
+    def by_object_type(event_key, object_type = nil)
+      fetch_report('byObjectType', event_key, object_type)
+    end
+
+    def summary_by_object_type(event_key)
+      fetch_summary_report('byObjectType', event_key)
+    end
+
+    def deep_summary_by_object_type(event_key)
+      fetch_deep_summary_report('byObjectType', event_key)
+    end
+
+    def by_category_key(event_key, category_key = nil)
+      fetch_report('byCategoryKey', event_key, category_key)
+    end
+
     def summary_by_category_key(event_key)
       fetch_summary_report('byCategoryKey', event_key)
     end
@@ -27,6 +47,10 @@ module Seatsio
       fetch_deep_summary_report('byCategoryKey', event_key)
     end
 
+    def by_category_label(event_key, category_label = nil)
+      fetch_report('byCategoryLabel', event_key, category_label)
+    end
+
     def summary_by_category_label(event_key)
       fetch_summary_report('byCategoryLabel', event_key)
     end
@@ -35,6 +59,10 @@ module Seatsio
       fetch_deep_summary_report('byCategoryLabel', event_key)
     end
 
+    def by_section(event_key, section = nil)
+      fetch_report('bySection', event_key, section)
+    end
+
     def summary_by_section(event_key)
       fetch_summary_report('bySection', event_key)
     end
@@ -43,6 +71,10 @@ module Seatsio
       fetch_deep_summary_report('bySection', event_key)
     end
 
+    def by_selectability(event_key, selectability = nil)
+      fetch_report('bySelectability', event_key, selectability)
+    end
+
     def summary_by_selectability(event_key)
       fetch_summary_report('bySelectability', event_key)
     end
@@ -51,6 +83,10 @@ module Seatsio
       fetch_deep_summary_report('bySelectability', event_key)
     end
 
+    def by_channel(event_key, channelKey = nil)
+      fetch_report('byChannel', event_key, channelKey)
+    end
+
     def summary_by_channel(event_key)
       fetch_summary_report('byChannel', event_key)
     end
@@ -63,34 +99,10 @@ module Seatsio
       fetch_report('byLabel', event_key, label)
     end
 
-    def by_status(event_key, status = nil)
-      fetch_report('byStatus', event_key, status)
-    end
-
-    def by_category_label(event_key, category_label = nil)
-      fetch_report('byCategoryLabel', event_key, category_label)
-    end
-
-    def by_category_key(event_key, category_key = nil)
-      fetch_report('byCategoryKey', event_key, category_key)
-    end
-
     def by_order_id(event_key, order_id = nil)
       fetch_report('byOrderId', event_key, order_id)
     end
 
-    def by_section(event_key, section = nil)
-      fetch_report('bySection', event_key, section)
-    end
-
-    def by_selectability(event_key, selectability = nil)
-      fetch_report('bySelectability', event_key, selectability)
-    end
-
-    def by_channel(event_key, channelKey = nil)
-      fetch_report('byChannel', event_key, channelKey)
-    end
-
     private
 
     def fetch_summary_report(report_type, event_key)

data/lib/seatsio/httpClient.rb

@@ -14,27 +14,24 @@ module Seatsio
 
     def execute(*args)
       begin
-        headers = {:Authorization => "Basic #{@secret_key}"}
+        headers = { :Authorization => "Basic #{@secret_key}" }
         unless @workspace_key.nil?
           headers[:'X-Workspace-Key'] = @workspace_key
         end
         if args[2].include? :params
           headers[:params] = args[2][:params]
         end
-        #if args[2] != nil || args[0] == :post
-        #  headers[:params] = args[2]
-        #end
 
         url = "#{@base_url}/#{args[1]}"
 
-        request_options = {method: args[0], url: url, headers: headers}
+        request_options = { method: args[0], url: url, headers: headers }
 
         if args[0] == :post
           args[2].delete :params
           request_options[:payload] = args[2].to_json
         end
 
-        response = RestClient::Request.execute(request_options)
+        response = execute_with_retries(request_options)
 
         # If RAW
         if args[3]
@@ -44,9 +41,6 @@ module Seatsio
       rescue RestClient::NotFound => e
         raise Exception::NotFoundException.new(e.response)
       rescue RestClient::ExceptionWithResponse => e
-        if e.response.include? "there is no page after" || e.response.empty?
-          raise Exception::NoMorePagesException
-        end
         raise Exception::SeatsioException.new(e.response)
       rescue RestClient::Exceptions::Timeout
         raise Exception::SeatsioException.new("Timeout ERROR")
@@ -55,12 +49,29 @@ module Seatsio
       end
     end
 
+    def execute_with_retries(request_options)
+      retry_count = 0
+      while true
+        begin
+          return RestClient::Request.execute(request_options)
+        rescue RestClient::ExceptionWithResponse => e
+          if e.response.code != 429 || retry_count >= 5
+            raise e
+          else
+            wait_time = (2 ** (retry_count + 2)) / 10.0
+            sleep(wait_time)
+            retry_count += 1
+          end
+        end
+      end
+    end
+
     def get_raw(endpoint, params = {})
       execute(:get, endpoint, params, true)
     end
 
     def get(endpoint, params = {})
-      payload = {:params => params}
+      payload = { :params => params }
       execute(:get, endpoint, payload)
     end
 

data/lib/seatsio/pagination/cursor.rb

@@ -89,8 +89,6 @@ module Seatsio
 
         @collection += parsed_items
         set_query_param(:start_after_id, items.last['id']) unless last?
-      rescue Seatsio::Exception::NoMorePagesException
-        @last_response_empty = true
       end
     end
   end

data/lib/seatsio/version.rb

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

data/lib/seatsio/workspaces.rb

@@ -8,6 +8,7 @@ require "seatsio/domain"
 
 module Seatsio
   class WorkspacesClient
+
     def initialize(secret_key, base_url)
       @http_client = ::Seatsio::HttpClient.new(secret_key, nil, base_url)
     end
@@ -50,6 +51,18 @@ module Seatsio
       extended_cursor
     end
 
+    def active(filter: nil)
+      extended_cursor = Pagination::Cursor.new(Workspace, 'workspaces/active', @http_client)
+      extended_cursor.set_query_param('filter', filter)
+      extended_cursor
+    end
+
+    def inactive(filter: nil)
+      extended_cursor = Pagination::Cursor.new(Workspace, 'workspaces/inactive', @http_client)
+      extended_cursor.set_query_param('filter', filter)
+      extended_cursor
+    end
+
     def retrieve(key:)
       response = @http_client.get("/workspaces/#{key}")
       Workspace.new(response)

data/releasing.md

@@ -1,4 +1,5 @@
 *Note: this is internal documentation for the seats.io team*
 
 1) Set the correct version number in lib/seatsio/version.rb
+1) Set the correct version number in Gemfile.lock
 2) Create the release in GitHub

data/seatsio.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rest-client", '~> 2.0', '>= 2.0.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: 31.0.0
+  version: 32.5.0
 platform: ruby
 authors:
 - Seats.io
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/dependabot.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/publish.yml"
 - ".gitignore"
@@ -133,7 +134,7 @@ files:
 homepage: http://seats.io
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: the official Seats.io Ruby client library
 test_files: []