seatsio 35.1.0 → 36.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9e68de3cd7eac52d0604ab81e6572bc897bfed4ef71ec40f0ef2bf598d5ef0
-  data.tar.gz: 999a8991efff73ef71f0c4b0b18bb41d589c0a7aaf7a11784d2f65db5f803b8a
+  metadata.gz: 229d0d1752b24b273a977af9c0547f5aba5035756a438b7e7b8f8ca249a38473
+  data.tar.gz: a2fdbca2977e4b07e02680cd3c586bc5d360acb7709668a970b4dd12c737cb51
 SHA512:
-  metadata.gz: 2b40d67fadfc461bbf774d2ae580b467dc7b81d63e0f245b92c3532a571e061cb0ee73b0e6f3650496c0a3dbbd523756ce70414f3c243014286134143a6af434
-  data.tar.gz: 06776edd55219aee088bc763bd91e657c0b8c3f72a9358e7d6ca9b6b84fcc1149aaa8f63d9c1401008201511f7ff96870aba496690917e7b3a97fd3310cff304
+  metadata.gz: a54ead9e014c28239e158da656661013ae7ca9f5b743c7e5c13c18844884c39c16fe80515389d0e0141f7b596f964da17f1b460fd6b64dcf3301fe51599afe82
+  data.tar.gz: a9cc825746a3aa613013efa4aad2ddd03ba8b7a47a1850db032e877d5e5239a64fada00ece19e7504cbcf1c72e40674b1dd74871b457295def38ba841a5646c8

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.4']
+        ruby-version: ['2.4', '3.0']
 
     steps:
     - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seatsio (35.1.0)
+    seatsio (36.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,7 +19,7 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0225)
-    minitest (5.14.4)
+    minitest (5.15.0)
     netrc (0.11.0)
     public_suffix (4.0.6)
     rake (13.0.6)

data/README.md

@@ -13,13 +13,34 @@ seatsio-ruby follows semver since v23.3.0.
 
 You can find a full API reference at https://www.rubydoc.info/gems/seatsio/
 
-## Examples
+## Usage
+
+### General instructions
+
+To use this library, you'll need to create a `Seatsio::Client`:
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")
+...
+```
+
+You can find your _workspace secret key_ in the [settings section of the workspace](https://app.seats.io/workspace-settings).
+
+The region should correspond to the region of your account:
+
+- `Seatsio::Region.EU()`: Europe
+- `Seatsio::Region.NA()`: North-America
+- `Seatsio::Region.SA()`: South-America
+- `Seatsio::Region.OC()`: Oceania
+
+If you're unsure about your region, have a look at your [company settings page](https://app.seats.io/company-settings).
 
 ### Creating a chart and an event
 
 ```ruby
 require('seatsio')
-client = Seatsio::Client.new(Seatsio::Region.EU(), "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")
 chart = client.charts.create
 event = client.events.create chart_key: chart.key
 ```

data/lib/seatsio/chart_reports.rb

@@ -11,28 +11,54 @@ module Seatsio
     end
 
     def by_label(chart_key, book_whole_tables = nil)
-      get_chart_report('byLabel', chart_key, book_whole_tables)
+      fetch_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)
+      fetch_chart_report('byObjectType', chart_key, book_whole_tables)
+    end
+
+    def summary_by_object_type(chart_key, book_whole_tables = nil)
+      fetch_summary_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)
+      fetch_chart_report('byCategoryKey', chart_key, book_whole_tables)
+    end
+
+    def summary_by_category_key(chart_key, book_whole_tables = nil)
+      fetch_summary_report('byCategoryKey', chart_key, book_whole_tables)
     end
 
     def by_category_label(chart_key, book_whole_tables = nil)
-      get_chart_report('byCategoryLabel', chart_key, book_whole_tables)
+      fetch_chart_report('byCategoryLabel', chart_key, book_whole_tables)
+    end
+
+    def summary_by_category_label(chart_key, book_whole_tables = nil)
+      fetch_summary_report('byCategoryLabel', chart_key, book_whole_tables)
+    end
+
+    def by_section(chart_key, book_whole_tables = nil)
+      fetch_chart_report('bySection', chart_key, book_whole_tables)
+    end
+
+    def summary_by_section(event_key, book_whole_tables = nil)
+      fetch_summary_report('bySection', event_key, book_whole_tables)
     end
 
     private
 
-    def get_chart_report(report_type, chart_key, book_whole_tables)
+    def fetch_chart_report(report_type, chart_key, book_whole_tables)
       params = book_whole_tables.nil? ? {} : { bookWholeTables: book_whole_tables }
       url = "reports/charts/#{chart_key}/#{report_type}"
       body = @http_client.get(url, params)
       ChartReport.new(body)
     end
+
+    def fetch_summary_report(report_type, event_key, book_whole_tables)
+      params = book_whole_tables.nil? ? {} : { bookWholeTables: book_whole_tables }
+      url = "reports/charts/#{event_key}/#{report_type}/summary"
+      @http_client.get(url, params)
+    end
   end
 end

data/lib/seatsio/domain.rb

@@ -22,19 +22,19 @@ module Seatsio
       @archived = data['archived']
       @validation = data['validation']
       @social_distancing_rulesets = data['socialDistancingRulesets'].map {
-          |key, r| [key, SocialDistancingRuleset.new(r['name'],
-                                                     number_of_disabled_seats_to_the_sides: r['numberOfDisabledSeatsToTheSides'],
-                                                     disable_seats_in_front_and_behind: r['disableSeatsInFrontAndBehind'],
-                                                     disable_diagonal_seats_in_front_and_behind: r['disableDiagonalSeatsInFrontAndBehind'],
-                                                     number_of_disabled_aisle_seats: r['numberOfDisabledAisleSeats'],
-                                                     max_group_size: r['maxGroupSize'],
-                                                     max_occupancy_absolute: r['maxOccupancyAbsolute'],
-                                                     max_occupancy_percentage: r['maxOccupancyPercentage'],
-                                                     one_group_per_table: r['oneGroupPerTable'],
-                                                     fixed_group_layout: r['fixedGroupLayout'],
-                                                     disabled_seats: r['disabledSeats'],
-                                                     enabled_seats: r['enabledSeats'],
-                                                     index: r['index'])]
+        |key, r| [key, SocialDistancingRuleset.new(r['name'],
+                                                   number_of_disabled_seats_to_the_sides: r['numberOfDisabledSeatsToTheSides'],
+                                                   disable_seats_in_front_and_behind: r['disableSeatsInFrontAndBehind'],
+                                                   disable_diagonal_seats_in_front_and_behind: r['disableDiagonalSeatsInFrontAndBehind'],
+                                                   number_of_disabled_aisle_seats: r['numberOfDisabledAisleSeats'],
+                                                   max_group_size: r['maxGroupSize'],
+                                                   max_occupancy_absolute: r['maxOccupancyAbsolute'],
+                                                   max_occupancy_percentage: r['maxOccupancyPercentage'],
+                                                   one_group_per_table: r['oneGroupPerTable'],
+                                                   fixed_group_layout: r['fixedGroupLayout'],
+                                                   disabled_seats: r['disabledSeats'],
+                                                   enabled_seats: r['enabledSeats'],
+                                                   index: r['index'])]
       }.to_h
     end
   end
@@ -115,10 +115,10 @@ module Seatsio
 
     def == (other)
       self.key == other.key &&
-          self.name == other.name &&
-          self.color == other.color &&
-          self.index == other.index &&
-          self.objects == other.objects
+        self.name == other.name &&
+        self.color == other.color &&
+        self.index == other.index &&
+        self.objects == other.objects
     end
 
   end
@@ -139,19 +139,46 @@ module Seatsio
       @created_on = parse_date(data['createdOn'])
       @updated_on = parse_date(data['updatedOn'])
       @channels = data['channels'].map {
-          |d| Channel.new(d['key'], d['name'], d['color'], d['index'], d['objects'])
+        |d| Channel.new(d['key'], d['name'], d['color'], d['index'], d['objects'])
       } if data['channels']
       @social_distancing_ruleset_key = data['socialDistancingRulesetKey']
     end
 
+    def is_season
+      false
+    end
+
+    def self.from_json(data)
+      if data['isSeason']
+        Season.new(data)
+      else
+        Event.new(data)
+      end
+    end
+
     def self.create_list(list = [])
       result = []
 
       list.each do |item|
-        result << Event.new(item)
+        result << Event.from_json(item)
       end
 
-      return result
+      result
+    end
+  end
+
+  class Season < Event
+
+    attr_accessor :partial_season_keys, :events
+
+    def initialize(data)
+      super(data)
+      @partial_season_keys = data['partialSeasonKeys']
+      @events = data['events'] ? Event.create_list(data['events']) : nil
+    end
+
+    def is_season
+      true
     end
   end
 
@@ -521,41 +548,41 @@ module Seatsio
     end
 
     def self.fixed(name, disabled_seats: [], index: 0)
-      return SocialDistancingRuleset.new(name, index: index, disabled_seats: disabled_seats, fixed_group_layout: true)
+      SocialDistancingRuleset.new(name, index: index, disabled_seats: disabled_seats, fixed_group_layout: true)
     end
 
     def self.rule_based(name, number_of_disabled_seats_to_the_sides: 0, disable_seats_in_front_and_behind: false, disable_diagonal_seats_in_front_and_behind: false,
                         number_of_disabled_aisle_seats: 0, max_group_size: 0, max_occupancy_absolute: 0, max_occupancy_percentage: 0, one_group_per_table: false,
                         disabled_seats: [], enabled_seats: [], index: 0)
-      return SocialDistancingRuleset.new(name,
-                                         number_of_disabled_seats_to_the_sides: number_of_disabled_seats_to_the_sides,
-                                         disable_seats_in_front_and_behind: disable_seats_in_front_and_behind,
-                                         disable_diagonal_seats_in_front_and_behind: disable_diagonal_seats_in_front_and_behind,
-                                         number_of_disabled_aisle_seats: number_of_disabled_aisle_seats,
-                                         max_group_size: max_group_size,
-                                         max_occupancy_absolute: max_occupancy_absolute,
-                                         max_occupancy_percentage: max_occupancy_percentage,
-                                         one_group_per_table: one_group_per_table,
-                                         fixed_group_layout: false,
-                                         disabled_seats: disabled_seats,
-                                         enabled_seats: enabled_seats,
-                                         index: index)
+      SocialDistancingRuleset.new(name,
+                                  number_of_disabled_seats_to_the_sides: number_of_disabled_seats_to_the_sides,
+                                  disable_seats_in_front_and_behind: disable_seats_in_front_and_behind,
+                                  disable_diagonal_seats_in_front_and_behind: disable_diagonal_seats_in_front_and_behind,
+                                  number_of_disabled_aisle_seats: number_of_disabled_aisle_seats,
+                                  max_group_size: max_group_size,
+                                  max_occupancy_absolute: max_occupancy_absolute,
+                                  max_occupancy_percentage: max_occupancy_percentage,
+                                  one_group_per_table: one_group_per_table,
+                                  fixed_group_layout: false,
+                                  disabled_seats: disabled_seats,
+                                  enabled_seats: enabled_seats,
+                                  index: index)
     end
 
     def == (other)
       self.name == other.name &&
-          self.number_of_disabled_seats_to_the_sides == other.number_of_disabled_seats_to_the_sides &&
-          self.disable_seats_in_front_and_behind == other.disable_seats_in_front_and_behind &&
-          self.disable_diagonal_seats_in_front_and_behind == other.disable_diagonal_seats_in_front_and_behind &&
-          self.number_of_disabled_aisle_seats == other.number_of_disabled_aisle_seats &&
-          self.max_group_size == other.max_group_size &&
-          self.max_occupancy_absolute == other.max_occupancy_absolute &&
-          self.max_occupancy_percentage == other.max_occupancy_percentage &&
-          self.one_group_per_table == other.one_group_per_table &&
-          self.fixed_group_layout == other.fixed_group_layout &&
-          self.disabled_seats == other.disabled_seats &&
-          self.enabled_seats == other.enabled_seats &&
-          self.index == other.index
+        self.number_of_disabled_seats_to_the_sides == other.number_of_disabled_seats_to_the_sides &&
+        self.disable_seats_in_front_and_behind == other.disable_seats_in_front_and_behind &&
+        self.disable_diagonal_seats_in_front_and_behind == other.disable_diagonal_seats_in_front_and_behind &&
+        self.number_of_disabled_aisle_seats == other.number_of_disabled_aisle_seats &&
+        self.max_group_size == other.max_group_size &&
+        self.max_occupancy_absolute == other.max_occupancy_absolute &&
+        self.max_occupancy_percentage == other.max_occupancy_percentage &&
+        self.one_group_per_table == other.one_group_per_table &&
+        self.fixed_group_layout == other.fixed_group_layout &&
+        self.disabled_seats == other.disabled_seats &&
+        self.enabled_seats == other.enabled_seats &&
+        self.index == other.index
     end
   end
 

data/lib/seatsio/events.rb

@@ -4,7 +4,6 @@ require "seatsio/httpClient"
 require "seatsio/domain"
 require "json"
 require "cgi"
-require "seatsio/domain"
 require "seatsio/events/change_object_status_request"
 require "seatsio/events/change_best_available_object_status_request"
 
@@ -108,7 +107,7 @@ module Seatsio
 
     def retrieve(key:)
       response = @http_client.get("events/#{key}")
-      Event.new(response)
+      Event.from_json(response)
     end
 
     def list

data/lib/seatsio/pagination/cursor.rb

@@ -19,7 +19,7 @@ module Seatsio
         @first_page = false
       end
 
-      def each(start = 0)
+      def each(start = 0, &block)
         return to_enum(:each, start) unless block_given?
 
         Array(@collection[start..-1]).each do |element|
@@ -30,7 +30,7 @@ module Seatsio
 
         start = [@collection.size, start].max
         fetch_next_page
-        each(start, &Proc.new)
+        each(start, &block)
       end
 
       def set_query_param(key, value)
@@ -85,7 +85,7 @@ module Seatsio
         items = response['items']
         parsed_items = []
 
-        items.each {|item| parsed_items << @cls.new(item)}
+        items.each {|item| parsed_items << (@cls.respond_to?(:from_json) ? @cls.from_json(item) : @cls.new(item))}
 
         @collection += parsed_items
         set_query_param(:start_after_id, items.last['id']) unless last?

data/lib/seatsio/seasons.rb

@@ -0,0 +1,77 @@
+require 'seatsio/exception'
+require 'base64'
+require 'seatsio/httpClient'
+require 'seatsio/domain'
+require 'json'
+require 'cgi'
+
+module Seatsio
+
+  class SeasonsClient
+    def initialize(http_client, seatsio_client)
+      @http_client = http_client
+      @seatsio_client = seatsio_client
+    end
+
+    def create(chart_key:, key: nil, number_of_events: nil, event_keys: nil,
+               table_booking_config: nil, social_distancing_ruleset_key: nil)
+      request = build_create_season_request(chart_key: chart_key, key: key, number_of_events: number_of_events, event_keys: event_keys,
+                                            table_booking_config: table_booking_config, social_distancing_ruleset_key: social_distancing_ruleset_key)
+      response = @http_client.post('seasons', request)
+      Season.new(response)
+    end
+
+    def create_partial_season(top_level_season_key:, partial_season_key: nil, event_keys: nil)
+      request = {}
+      request['key'] = partial_season_key if partial_season_key
+      request['eventKeys'] = event_keys if event_keys
+      response = @http_client.post("/seasons/#{top_level_season_key}/partial-seasons", request)
+      Season.new(response)
+    end
+
+    def retrieve(key:)
+      @seatsio_client.events.retrieve(key: key)
+    end
+
+    def create_events(key:, number_of_events: nil, event_keys: nil)
+      request = {}
+      request['eventKeys'] = event_keys if event_keys
+      request['numberOfEvents'] = number_of_events if number_of_events
+      response = @http_client.post("/seasons/#{key}/actions/create-events", request)
+      Season.new(response)
+    end
+
+    def add_events_to_partial_season(top_level_season_key:, partial_season_key:, event_keys:)
+      request = {}
+      request['eventKeys'] = event_keys
+      response = @http_client.post("/seasons/#{top_level_season_key}/partial-seasons/#{partial_season_key}/actions/add-events", request)
+      Season.new(response)
+    end
+
+    def remove_event_from_partial_season(top_level_season_key:, partial_season_key:, event_key:)
+      response = @http_client.delete("/seasons/#{top_level_season_key}/partial-seasons/#{partial_season_key}/events/#{event_key}")
+      Season.new(response)
+    end
+
+    private
+
+    def build_create_season_request(chart_key: nil, key: nil, number_of_events: nil, event_keys: nil, table_booking_config: nil, social_distancing_ruleset_key: nil)
+      request = {}
+      request['chartKey'] = chart_key if chart_key
+      request['key'] = key if key
+      request['numberOfEvents'] = number_of_events if number_of_events
+      request['eventKeys'] = event_keys if event_keys
+      request['tableBookingConfig'] = table_booking_config_to_request(table_booking_config) if table_booking_config != nil
+      request['socialDistancingRulesetKey'] = social_distancing_ruleset_key if social_distancing_ruleset_key != nil
+      request
+    end
+
+    def table_booking_config_to_request(table_booking_config)
+      request = {}
+      request['mode'] = table_booking_config.mode
+      request['tables'] = table_booking_config.tables if table_booking_config.tables != nil
+      request
+    end
+
+  end
+end

data/lib/seatsio/version.rb

@@ -1,3 +1,3 @@
 module Seatsio
-  VERSION = "35.1.0"
+  VERSION = "36.0.0"
 end

data/lib/seatsio/workspaces.rb

@@ -4,7 +4,6 @@ require "seatsio/httpClient"
 require "seatsio/domain"
 require "json"
 require "cgi"
-require "seatsio/domain"
 
 module Seatsio
   class WorkspacesClient

data/lib/seatsio.rb

@@ -3,6 +3,7 @@ require 'seatsio/charts'
 require 'seatsio/subaccounts'
 require 'seatsio/workspaces'
 require 'seatsio/events'
+require 'seatsio/seasons'
 require 'seatsio/hold_tokens'
 require 'seatsio/chart_reports'
 require 'seatsio/event_reports'
@@ -10,7 +11,7 @@ require 'seatsio/usage_reports'
 
 module Seatsio
   class Client
-    attr_reader :charts, :subaccounts, :workspaces, :events,
+    attr_reader :charts, :subaccounts, :workspaces, :events, :seasons,
                 :hold_tokens, :chart_reports, :event_reports, :usage_reports
 
     def initialize(region, secret_key, workspace_key = nil, max_retries = 5)
@@ -20,15 +21,14 @@ module Seatsio
       @subaccounts = SubaccountsClient.new(@http_client)
       @workspaces = WorkspacesClient.new(@http_client)
       @events = EventsClient.new(@http_client)
+      @seasons = SeasonsClient.new(@http_client, self)
       @hold_tokens = HoldTokensClient.new(@http_client)
       @chart_reports = ChartReportsClient.new(@http_client)
       @event_reports = EventReportsClient.new(@http_client)
       @usage_reports = UsageReportsClient.new(@http_client)
     end
-
   end
 
-
   class Region
     attr_reader :url
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: 35.1.0
+  version: 36.0.0
 platform: ruby
 authors:
 - Seats.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,7 @@ files:
 - lib/seatsio/hold_tokens.rb
 - lib/seatsio/httpClient.rb
 - lib/seatsio/pagination/cursor.rb
+- lib/seatsio/seasons.rb
 - lib/seatsio/subaccounts.rb
 - lib/seatsio/usage_reports.rb
 - lib/seatsio/util.rb