seatsio 29.0.0 → 32.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcf524f68021a82f0ffd1fe6b3cd3ba9f0ab3db78ae014f0da0e73f1627bccd5
-  data.tar.gz: 5b5bce5ae300c40909cea6b116b3d6c7ac65037253ac66f57fc6ad0e017c1513
+  metadata.gz: 2a4c05feef8448daa977bdc2148b893bd92986ba8da80765f23b5dc80ac57f9e
+  data.tar.gz: aa0229bf2f040f406ac18b788b74fa540a16420de533cdecbe8ed1aec5abdf26
 SHA512:
-  metadata.gz: 67a2f3b7610fae718e882c2742bd1310d47f61a84971b8990a70ccffd565351a8a9e9f739e965c6478bdbdd0d5b54bfd69176b65094e9372cac7bc8acf979ccc
-  data.tar.gz: '009503e48798bfa219cbc03832483b0fffdafa1bd087bfe226afb93f295c6e6326c80da15e243203e42b07fd68fcecd0125f4b3256ef16aab89d0db0fd0fcefc'
+  metadata.gz: 8f6d5d72e8e7defd3f34b8bbb042e60440047a0e705d62b6f71053cd8f59eacc34bdc62f1bf55c56cd44433ba621fa053eff782382bceb8978c8446140f0f23a
+  data.tar.gz: 2ff422ca32191907b0c22659ad8f6a295f74e4843c2bc3c96be27c2a208486e36ad410696159f27c3665fffc64307ba20e9e64e024b2fc0c46abbfb59d499ddc

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seatsio (29.0.0)
+    seatsio (32.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
 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 +14,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 +23,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 +31,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 +39,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 +47,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 +55,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 +101,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 +113,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`. We react to this by waiting for a while, and then retrying the request.
+If the request still fails with an error `429`, we wait a little longer, and try again. This happens at most 5 times, before we give 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/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
+                :left_neighbour, :right_neighbour, :book_as_a_whole
 
     def initialize(data)
       @label = data['label']
@@ -277,6 +277,7 @@ module Seatsio
       @object_type = data['objectType']
       @left_neighbour = data['leftNeighbour']
       @right_neighbour = data['rightNeighbour']
+      @book_as_a_whole = data['bookAsAWhole']
     end
   end
 
@@ -327,7 +328,8 @@ 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_selectable, :is_disabled_by_social_distancing, :channel,
+                :book_as_a_whole
 
     def initialize(data)
       @status = data['status']
@@ -356,6 +358,7 @@ module Seatsio
       @is_selectable = data['isSelectable']
       @is_disabled_by_social_distancing = data['isDisabledBySocialDistancing']
       @channel = data['channel']
+      @book_as_a_whole = data['bookAsAWhole']
     end
   end
 
@@ -383,23 +386,14 @@ module Seatsio
 
   class UsageDetails
 
-    attr_reader :workspace
+    attr_reader :workspace, :usage_by_chart
 
     def initialize(data)
-      @workspace = data['workspace'] ? UsageWorkspace.new(data['workspace']) : nil
+      @workspace = data['workspace']
       @usage_by_chart = data['usageByChart'].map { |usage| UsageByChart.new(usage) }
     end
   end
 
-  class UsageWorkspace
-
-    attr_reader :id
-
-    def initialize(data)
-      @id = data['id']
-    end
-  end
-
   class UsageByChart
 
     attr_reader :chart, :usage_by_event

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 = "29.0.0"
+  VERSION = "32.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: 29.0.0
+  version: 32.0.0
 platform: ruby
 authors:
 - Seats.io
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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=