seatsio 30.1.1 → 32.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44234075632c1fe4cfa465b6126460d13746c868b6be77ac3ccecd67124a8f28
-  data.tar.gz: 6bffcd3107ce8d844668c305e7fcfb4c0487045cdfd75f2729fe53b97260eb25
+  metadata.gz: deb37b4551b15d8819e8609a2a79ee8e0924bcb0cbc1eb3734ab511865e98127
+  data.tar.gz: f63149c1521404c4d9a968717b985a85fb8fc19f90d3f46fd829b694c117d938
 SHA512:
-  metadata.gz: 9af7435cf39b7c220257875cc9505a2b3cf1ee7197452a80a9d4504194130d27be0fcbd30bc0a6bc44999b88bfbb85ac2db8c47cd2e842538b5014af2389bc36
-  data.tar.gz: c92c2b86ed00974b16c3eb582be1a573c45fda8d490b9c9642593c4cfcf983984176b808814ed490508293d460df4f2d8122e99ae46f28b675139180aa09c3c1
+  metadata.gz: 672aaf5a46b7e2419e4fc62848dc3b195607a1b86e4273bd5704ac51ed70a800f8fa5ba91ffe728df653623cde7963326f78581b5f3ae79fb49aba33e0d7703f
+  data.tar.gz: db47b8d5fa509a644d35b7ced4c7a02c526c6b096ef358afc53fb033ca8c034abc7a466f3fc9e81ab0e9e86d25d2854f5f6f44549ee6406296a2e21c0f2ca8e8

data/.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: 'Build'
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3']
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - uses: zcong1993/setup-timezone@master
+      with:
+        timezone: Europe/Brussels
+    - run: bundle exec rake

data/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: 'Publish'
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/Gemfile.lock

@@ -1,36 +1,38 @@
 PATH
   remote: .
   specs:
-    seatsio (30.1.1)
+    seatsio (32.2.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.7.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.3)
+    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.12.2)
       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 Status](https://travis-ci.org/seatsio/seatsio-ruby.svg?branch=master)](https://travis-ci.org/seatsio/seatsio-ruby)
+[![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+
 
@@ -14,7 +15,7 @@ seatsio-ruby follows semver since v23.3.0.
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key") # can be found on https://app.seats.io/workspace-settings
+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
 ```
@@ -23,7 +24,7 @@ event = client.events.create key: chart.key
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 client.events.book(event.key, ["A-1", "A-2"])
 ```
 
@@ -31,7 +32,7 @@ client.events.book(event.key, ["A-1", "A-2"])
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 client.events.release(event.key, ["A-1", "A-2"])
 ```
 
@@ -39,7 +40,7 @@ client.events.release(event.key, ["A-1", "A-2"])
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 client.events.book(event.key, ["A-1", "A-2"], hold_token: "a-hold-token")
 ```
 
@@ -47,7 +48,7 @@ client.events.book(event.key, ["A-1", "A-2"], hold_token: "a-hold-token")
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key")
+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")
 ```
 
@@ -55,7 +56,7 @@ client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-sta
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-workspace-secret-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
 charts = client.charts.list
 charts.each do |chart|
   puts chart.key
@@ -101,7 +102,7 @@ end
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new("my-company-admin-key")
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key")
 client.workspaces.create name: "a workspace"
 ```
 
@@ -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.rb

@@ -9,12 +9,12 @@ require 'seatsio/event_reports'
 require 'seatsio/usage_reports'
 
 module Seatsio
-  # Main Seatsio Class
   class Client
     attr_reader :charts, :subaccounts, :workspaces, :events,
                 :hold_tokens, :chart_reports, :event_reports, :usage_reports
 
-    def initialize(secret_key, workspace_key = nil, base_url = 'https://api.seatsio.net')
+    def initialize(region, secret_key, workspace_key = nil)
+      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)
@@ -25,4 +25,32 @@ module Seatsio
       @usage_reports = UsageReportsClient.new(secret_key, workspace_key, base_url)
     end
   end
+
+  class Region
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def self.EU()
+      return Region.new(Region.url_for_id("eu"))
+    end
+
+    def self.NA()
+      return Region.new(Region.url_for_id("na"))
+    end
+
+    def self.SA()
+      return Region.new(Region.url_for_id("sa"))
+    end
+
+    def self.OC()
+      return Region.new(Region.url_for_id("oc"))
+    end
+
+    def self.url_for_id(id)
+      return "https://api-" + id + ".seatsio.net"
+    end
+  end
 end

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

@@ -264,7 +264,7 @@ 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
+                :left_neighbour, :right_neighbour, :book_as_a_whole, :distance_to_focal_point
 
     def initialize(data)
       @label = data['label']
@@ -278,6 +278,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
 
@@ -329,7 +330,7 @@ module Seatsio
                 :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']
@@ -359,6 +360,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 = "30.1.1"
+  VERSION = "32.2.0"
 end

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: 30.1.1
+  version: 32.2.0
 platform: ruby
 authors:
 - Seats.io
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-04-26 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,9 +100,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/build.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -132,7 +133,7 @@ files:
 homepage: http://seats.io
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: the official Seats.io Ruby client library
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- 2.3.0
-before_install: gem install bundler -v 1.16.1
-notifications:
-  slack:
-    rooms:
-    - seatsio:AGaZISx4HlvoEx6WTbVaX50V
-    on_pull_requests: false
-    on_failure: always
-    on_success: change
-deploy:
-  provider: rubygems
-  gem: seatsio
-  on:
-    tags: true
-  api_key:
-    secure: mQmsVgbIYF16i0rzDYQoOzcXwG8ppJl/czjTWf/KaEtSCWG5tQKBzflXFIkrfoP7EyjC+2TvT4Z5tWIBUVR4gG2KjcV2lGgq2vV/sVYrmUIXO2LZHBu5n35QHBF//0IOvbZMufm7W8PIVM6do1tMxdRE+qMZVtb5M9YIQpDHc6jXru/PKxOffwTNEWMVX1Xjfz4wtuJCpvhR+BHuBoi9uE4dyWrF5WgkL2aELUvHpUmc2wn0gGypqJ9Whrcxq8n3EREvO0kiSMww+MMdWd57ACo4q5J8Za+h4tXvVd49EyEdevjWMvT0wYx+nSz+/vk4B9vOmd5Un9/gzoLbq8qEpAgEHXKw/J6l9KHlJDMNy2dVsMzqSOceEtBx5LA0fizWD4U2XfI0GaiM5Rdt96iNtVlU9lQuiXPhcz7igEFVRSZAkzTNHlh0cAr2FJIBBh27fffrblF/xRw1ziLwDnjutTg8lZsxmdjTrnMkAAuNWMIXKzWvh7n2bZ+jqwzp5bSqp1ckOCae7ozsG1Kx1eS8pMepsvMtmb5w6dsuWGVAI8ASd8XmYFHKisKmi6xHYOGw7uy7yE7rXHa0Ypx/K4xKCoqhv+5Y7RdTvT2tkqC0mwMOh/Io2eslgjTA0vy87sVKyLTCU/ElKRTd2165cRL2JRNH3l/X0gxglT4WpXQEEXs=