seatsio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efff7272547e4765151626aaa6a42d90d334954098906ee1d0f3222e896c77c8
+  data.tar.gz: 95f20cfc064c466dea4e8c7d7e57a45cc6b9269068a2bbb9de0b865407b539e9
+SHA512:
+  metadata.gz: 17b0870cd210ab7aa811c1a98afd96b4429c1782313e47b1ef15554ee44cf18e27047cd64c3bad50dd503f8b2cb22c5da81c259f571efbc4bdd278276a24d89e
+  data.tar.gz: b5e058d594c300716bee307b40b3306807265fd5f5313c41c363a1a7dc98f31f8a6fa5b2b33bcc46213f833cb080d634800200880047102b0fe2bd297a338a6e

data/.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in seatsio.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# 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)
+[![Coverage Status](https://coveralls.io/repos/github/seatsio/seatsio-ruby/badge.svg?branch=master)](https://coveralls.io/github/seatsio/seatsio-ruby?branch=master)
+
+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+
+
+
+# Versioning
+
+seatsio-ruby only uses major version numbers: v5, v6, v7 etc. Each release - backwards compatible or not - receives a new major version number.
+
+The reason: we want to play safe and assume that each release might break backwards compatibility.
+
+## Examples
+
+### Creating a chart and an event
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key") # can be found on https://app.seats.io/settings
+chart = client.charts.create
+event = client.events.create(chart.key)
+```
+
+### Booking objects
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+client.events.book(event.key, ["A-1", "A-2"])
+```
+
+### Releasing objects
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+client.events.release(event.key, ["A-1", "A-2"])
+```
+
+### Booking objects that have been held
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+client.events.book(event.key, ["A-1", "A-2"], "a-hold-token")
+```
+
+### Changing object status
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-status")
+```
+
+### Listing all charts
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+charts = client.charts.list # returns a Enumerable
+```
+
+### Listing the first page of charts (default page size is 20)
+
+```ruby
+require('seatsio')
+client = Seatsio::Client.new("my-secret-key")
+charts = client.charts.list.first_page # returns a Enumerable
+```
+
+# 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.
+
+This exception contains a message string describing what went wrong, and also two other properties:
+
+* *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.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seatsio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/seatsio/accounts.rb

@@ -0,0 +1,20 @@
+require "seatsio/exception"
+require "base64"
+require "seatsio/httpClient"
+require "seatsio/domain"
+require "json"
+require "cgi"
+require "seatsio/domain"
+
+module Seatsio
+  class AccountsClient
+    def initialize(secret_key, base_url)
+      @http_client = ::Seatsio::HttpClient.new(secret_key, base_url)
+    end
+
+    def retrieve_my_account
+      response = @http_client.get('accounts/me')
+      Domain::Account.new(response)
+    end
+  end
+end

data/lib/seatsio/chart_reports.rb

@@ -0,0 +1,19 @@
+require 'seatsio/exception'
+require 'seatsio/httpClient'
+require 'seatsio/domain'
+require 'json'
+require 'cgi'
+
+module Seatsio
+  class ChartReportsClient
+    def initialize(secret_key, base_url)
+      @http_client = ::Seatsio::HttpClient.new(secret_key, base_url)
+    end
+
+    def by_label(chart_key)
+      url = "reports/charts/#{chart_key}/byLabel"
+      body = @http_client.get(url)
+      Domain::ChartReport.new(body)
+    end
+  end
+end

data/lib/seatsio/charts.rb

@@ -0,0 +1,124 @@
+require 'seatsio/exception'
+require 'base64'
+require 'seatsio/httpClient'
+require 'seatsio/domain'
+require 'seatsio/pagination/cursor'
+require 'json'
+require 'cgi'
+
+module Seatsio
+  # Seatsio Charts client
+  class ChartsClient
+    attr_reader :archive
+
+    def initialize(secret_key, base_url)
+      @http_client = Seatsio::HttpClient.new(secret_key, base_url)
+      @archive = Pagination::Cursor.new(Domain::Chart, 'charts/archive', @http_client)
+    end
+
+    # @return [Seatsio::Domain::Chart]
+    def retrieve(chart_key)
+      response = @http_client.get("charts/#{chart_key}")
+      Domain::Chart.new(response)
+    end
+
+    def retrieve_with_events(chart_key)
+      response = @http_client.get("charts/#{chart_key}?expand=events")
+      Domain::Chart.new(response)
+    end
+
+    def create(name = nil, venue_type = nil, categories = nil)
+      payload = build_chart_request name: name, venue_type: venue_type, categories: categories
+      response = @http_client.post('charts', payload)
+      Domain::Chart.new(response)
+    end
+
+    def update(key, new_name = nil, categories = nil)
+      payload = build_chart_request name: new_name, categories: categories
+      @http_client.post("charts/#{key}", payload)
+    end
+
+    def add_tag(key, tag)
+      @http_client.post("charts/#{key}/tags/#{CGI::escape(tag)}")
+    end
+
+    def remove_tag(key, tag)
+      @http_client.delete("charts/#{key}/tags/#{tag}")
+    end
+
+    def copy(key)
+      response = @http_client.post("charts/#{key}/version/published/actions/copy")
+      Domain::Chart.new(response)
+    end
+
+    def copy_to_subaccount(chart_key, subaccount_id)
+      url = "charts/#{chart_key}/version/published/actions/copy-to/#{subaccount_id}"
+      response = @http_client.post url
+      Domain::Chart.new(response)
+    end
+
+    def copy_draft_version(key)
+      response = @http_client.post("charts/#{key}/version/draft/actions/copy")
+      Domain::Chart.new(response)
+    end
+
+    def retrieve_published_version(key)
+      response = @http_client.get("charts/#{key}/version/published")
+      Domain::Chart.new(response)
+    end
+
+    def retrieve_draft_version(key)
+      response = @http_client.get("charts/#{key}/version/draft")
+      Domain::ChartDraft.new(response)
+    end
+
+    def retrieve_draft_version_thumbnail(key)
+      @http_client.get_raw("charts/#{key}/version/draft/thumbnail")
+    end
+
+    def retrieve_published_version_thumbnail(key)
+      @http_client.get_raw("charts/#{key}/version/published/thumbnail")
+    end
+
+    def discard_draft_version(key)
+      @http_client.post("charts/#{key}/version/draft/actions/discard")
+    end
+
+    def publish_draft_version(chart_key)
+      @http_client.post("charts/#{chart_key}/version/draft/actions/publish")
+    end
+
+    def list(chart_filter = nil, tag = nil, expand_events = nil)
+      cursor = Pagination::Cursor.new(Domain::Chart, 'charts', @http_client)
+      cursor.set_query_param('filter', chart_filter)
+      cursor.set_query_param('tag', tag)
+
+      cursor.set_query_param('expand', 'events') if expand_events
+
+      cursor
+    end
+
+    def list_all_tags
+      response = @http_client.get('charts/tags')
+      response['tags']
+    end
+
+    def move_to_archive(chart_key)
+      @http_client.post("charts/#{chart_key}/actions/move-to-archive")
+    end
+
+    def move_out_of_archive(chart_key)
+      @http_client.post("charts/#{chart_key}/actions/move-out-of-archive")
+    end
+
+    private
+
+    def build_chart_request(name: nil, venue_type: nil, categories: nil)
+      result = {}
+      result['name'] = name if name
+      result['venueType'] = venue_type if venue_type
+      result['categories'] = categories if categories
+      result
+    end
+  end
+end

data/lib/seatsio/domain.rb

@@ -0,0 +1,283 @@
+require 'seatsio/util'
+
+module Seatsio::Domain
+
+  class ChartCategories
+    attr_accessor :list, :max_category_key
+
+    def initialize(data)
+      if data
+        @list = data['list']
+        @max_category_key = data['maxCategoryKey']
+      else
+        @list = []
+        @max_category_key = ''
+      end
+    end
+  end
+
+  class Chart
+
+    attr_reader :id, :key, :status, :name, :published_version_thumbnail_url,
+                :draft_version_thumbnail_url, :events, :tags, :archived, :venue_type,
+                :categories
+
+    def initialize(data)
+      @id = data['id']
+      @key = data['key']
+      @status = data['status']
+      @name = data['name']
+      @published_version_thumbnail_url = data['publishedVersionThumbnailUrl']
+      @draft_version_thumbnail_url = data['draftVersionThumbnailUrl']
+      @events = Event.create_list(data['events']) if data['events']
+      @tags = data['tags']
+      @archived = data['archived']
+      @venue_type = data['venueType']
+      @categories = ChartCategories.new(data['categories'])
+
+    end
+  end
+
+  class ChartDraft < Chart
+    attr_reader :version
+    def initialize(data)
+      super(data)
+      @version = data['version']
+    end
+  end
+
+  class ForSaleConfig
+
+    attr_reader :for_sale, :objects, :categories
+
+    def initialize(data)
+      if data
+        @for_sale = data['forSale']
+        @objects = data['objects']
+        @categories = data['categories']
+      end
+    end
+  end
+
+  class Event
+
+    attr_accessor :id, :key, :chart_key, :book_whole_tables, :supports_best_available,
+                  :table_booking_modes, :for_sale_config, :created_on, :updated_on
+
+    def initialize(data)
+      @id = data['id']
+      @key = data['key']
+      @chart_key = data['chartKey']
+      @book_whole_tables = data['bookWholeTables']
+      @supports_best_available = data['supportsBestAvailable']
+      @table_booking_modes = data['tableBookingModes']
+      @for_sale_config = ForSaleConfig.new(data['forSaleConfig']) if data['forSaleConfig']
+      @created_on = parse_date(data['createdOn'])
+      @updated_on = parse_date(data['updatedOn'])
+    end
+
+    def self.create_list(list = [])
+      result = []
+
+      list.each do |item|
+        result << Event.new(item)
+      end
+
+      return result
+    end
+  end
+
+  class APIResponse
+
+    attr_reader :next_page_starts_after, :previous_page_ends_before, :items
+
+    def initialize(data)
+      @next_page_starts_after = data.fetch('next_page_starts_after', nil).to_i
+      @previous_page_ends_before = data.fetch('previous_page_ends_before', nil).to_i
+      @items = data.fetch('items', [])
+    end
+  end
+
+  class ChartValidationSettings
+    attr_reader :validate_duplicate_labels, :validate_objects_without_categories,
+                :validate_unlabeled_objects
+
+    def initialize(data)
+      @validate_duplicate_labels = data['VALIDATE_DUPLICATE_LABELS']
+      @validate_objects_without_categories = data['VALIDATE_OBJECTS_WITHOUT_CATEGORIES']
+      @validate_unlabeled_objects = data['VALIDATE_UNLABELED_OBJECTS']
+    end
+  end
+
+  class AccountSettings
+    attr_reader :draft_chart_drawings_enabled, :chart_validation
+
+    def initialize(data)
+      @draft_chart_drawings_enabled = data['draftChartDrawingsEnabled']
+      @chart_validation = ChartValidationSettings.new(data['chartValidation'])
+    end
+  end
+
+  class Account
+    attr_reader :id, :secret_key, :designer_key, :public_key, :name,
+                :email, :active, :settings
+
+    def initialize(data)
+      @id = data['id']
+      @secret_key = data['secretKey']
+      @designer_key = data['designerKey']
+      @public_key = data['publicKey']
+      @name = data['name']
+      @email = data['email']
+      @active = data['active']
+      @settings = AccountSettings.new(data['settings']) if data['settings'] != nil
+    end
+  end
+
+  class Subaccount < Account
+  end
+
+  class ObjectStatus
+    FREE = 'free'
+    BOOKED = 'booked'
+    HELD = 'reservedByToken'
+
+    attr_reader :status, :hold_token, :order_id, :ticket_type,
+                :quantity, :extra_data
+
+    def initialize(data)
+      @status = data['status']
+      @hold_token = data['holdToken']
+      @order_id = data['orderId']
+      @ticket_type = data['ticketType']
+      @quantity = data['quantity']
+      @extra_data = data['extraData']
+    end
+  end
+
+  class ChangeObjectStatusResult
+
+    attr_reader :labels
+
+    def initialize(data)
+      if data
+        @labels = data['labels'] if data.include? 'labels'
+      end
+    end
+  end
+
+  class HoldToken
+
+    attr_reader :hold_token, :expires_at, :expires_in_seconds
+
+    def initialize(data)
+      @hold_token = data['holdToken']
+      @expires_at = Time.parse(data['expiresAt'])
+      @expires_in_seconds = data['expiresInSeconds']
+    end
+  end
+
+  class BestAvailableObjects
+
+    attr_reader :next_to_each_other, :objects, :labels
+
+    def initialize(data)
+      @next_to_each_other = data['nextToEachOther']
+      @objects = data['objects']
+      @labels = data['labels']
+    end
+  end
+
+  class ChartReportItem
+
+    attr_reader :label, :labels, :category_key, :category_label, :section, :entrance, :capacity, :object_type
+
+    def initialize(data)
+      @label = data['label']
+      @labels = data['labels']
+      @category_label = data['categoryLabel']
+      @category_key = data['categoryKey']
+      @section = data['section']
+      @entrance = data['entrance']
+      @capacity = data['capacity']
+      @object_type = data['objectType']
+    end
+  end
+
+  class ChartReport
+
+    attr_reader :items
+
+    def initialize(data)
+      items = {}
+      data.each do |key, values|
+        items[key] = []
+        values.each do |value|
+          items[key] << ChartReportItem.new(value)
+        end
+      end
+      @items = items
+    end
+  end
+
+  class EventReport
+
+    attr_reader :items
+
+    def initialize(data)
+      if data.is_a? Array
+        items = []
+        data.each do |item|
+          items << EventReportItem.new(item)
+        end
+        @items = items
+      else
+        items = {}
+        data.each do |key, values|
+          items[key] = []
+          values.each do |value|
+            items[key] << EventReportItem.new(value)
+          end
+        end
+        @items = items
+      end
+    end
+  end
+
+  class EventReportItem
+    attr_reader :labels, :label, :order_id, :extra_data, :capacity, :status,
+                :category_key, :entrance, :object_type, :hold_token, :category_label,
+                :ticket_type, :num_booked, :for_sale, :section
+
+    def initialize(data)
+      @status = data['status']
+      @label = data['label']
+      @labels = data['labels']
+      @category_label = data['categoryLabel']
+      @category_key = data['categoryKey']
+      @ticket_type = data['ticketType']
+      @order_id = data['orderId']
+      @for_sale = data['forSale']
+      @hold_token = data['holdToken']
+      @section = data['section']
+      @entrance = data['entrance']
+      @num_booked = data['numBooked']
+      @capacity = data['capacity']
+      @object_type = data['objectType']
+      @extra_data = data['extraData']
+    end
+  end
+
+  class StatusChange
+    attr_reader :extra_data, :object_label, :date, :id, :status, :event_id
+
+    def initialize(data)
+      @id = data['id']
+      @status = data['status']
+      @date = data['date']# TODO: parse_date(data.get("date"))
+      @object_label = data['objectLabel']
+      @event_id = data['eventId']
+      @extra_data = data['extraData']
+    end
+  end
+end

data/lib/seatsio/event_reports.rb

@@ -0,0 +1,73 @@
+require 'seatsio/exception'
+require 'seatsio/httpClient'
+require 'seatsio/domain'
+require 'json'
+require 'cgi'
+
+module Seatsio
+  # Client for fetching event reports
+  class EventReportsClient
+    def initialize(secret_key, base_url)
+      @http_client = ::Seatsio::HttpClient.new(secret_key, base_url)
+    end
+
+    def summary_by_status(event_key)
+      fetch_summary_report('byStatus', event_key)
+    end
+
+    def summary_by_category_key(event_key)
+      fetch_summary_report('byCategoryKey', event_key)
+    end
+
+    def summary_by_category_label(event_key)
+      fetch_summary_report('byCategoryLabel', event_key)
+    end
+
+    def summary_by_section(event_key)
+      fetch_summary_report('bySection', event_key)
+    end
+
+    def by_label(event_key, label = nil)
+      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
+
+    private
+
+    def fetch_summary_report(report_type, event_key)
+      url = "reports/events/#{event_key}/#{report_type}/summary"
+      @http_client.get(url)
+    end
+
+    def fetch_report(report_type, event_key, report_filter = nil)
+      if report_filter
+        url = "reports/events/#{event_key}/#{report_type}/#{report_filter}"
+        body = @http_client.get(url)
+        Domain::EventReport.new(body[report_filter])
+      else
+        url = "reports/events/#{event_key}/#{report_type}"
+        body = @http_client.get(url)
+        Domain::EventReport.new(body)
+      end
+    end
+  end
+end