seatsio 9 → 10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35646a1ec4697502bc100b5262ef158385b709ad2a3e172fad6a7fd0604fbe80
-  data.tar.gz: 103c9e88f8b012cd209e39dbb48e71d0d1b20bd464974a7bc17c6f5c71d18b68
+  metadata.gz: 0d3280a812ca7a901bf41f74327383ce34b3839953c1add15c3a228c0460ee4e
+  data.tar.gz: e6d4c2cbc0ebdb81120eee3b622523c88a0d3660e5a4ce13de5784658ba08ebc
 SHA512:
-  metadata.gz: 136436e9396f9b964d16993c8a6385bbfbb2dbf9ef25d468bad0f70e47c8a04534dd960c2948951754d40b2baef9a9738f2d59a50a4e1bdebf2132600d6bc3a8
-  data.tar.gz: 00dc9d80777a01e29b78833196cc2f161e45d0ce3b20c09855f7734f5621bf5c781845b545d58ec74707cb01df3f2eb33982f973a18cbb621885b2907aa007c4
+  metadata.gz: 6cb439523b5b1e3b4384207158274de5654d7aeffa643c0e41645dcd122d23f4caa29983f5a36b8dd20cce08c4324745141cc0cc98f751941b7f0f2865baa128
+  data.tar.gz: 8a264e8920d4354f602c332268c69e8a1c943820e635f30456006b7fc32e6da17247bf60358483a9eb4bfa2ca7c7c855f7246262c70de55d3165dddf3f708c03

data/README.md

@@ -20,7 +20,7 @@ The reason: we want to play safe and assume that each release might break backwa
 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)
+event = client.events.create key: chart.key
 ```
 
 ### Booking objects
@@ -60,15 +60,45 @@ client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-sta
 ```ruby
 require('seatsio')
 client = Seatsio::Client.new("my-secret-key")
-charts = client.charts.list # returns a Enumerable
+charts = client.charts.list
+charts.each do |chart|
+  puts chart.key
+end
 ```
 
-### Listing the first page of charts (default page size is 20)
+Note: `list` returns an `Enumerable`, which under the hood calls the seats.io API to fetch charts page by page. So multiple API calls may be done underneath to fetch all charts.
+
+### Listing charts page by page
+
+E.g. to show charts in a paginated list on a dashboard.
+
+Each page is Enumerable, and it has `next_page_starts_after` and `previous_page_ends_before` properties. Those properties are the chart IDs after which the next page starts or the previous page ends.
 
 ```ruby
-require('seatsio')
-client = Seatsio::Client.new("my-secret-key")
-charts = client.charts.list.first_page # returns a Enumerable
+# ... user initially opens the screen ...
+
+firstPage = client.charts.list.first_page()
+firstPage.each do |chart|
+  puts chart.key
+end
+```
+
+```ruby
+# ... user clicks on 'next page' button ...
+
+nextPage = client.charts.list.page_after(firstPage.next_page_starts_after)
+nextPage.each do |chart|
+  puts chart.key
+end
+```
+
+```ruby
+# ... user clicks on 'previous page' button ...
+
+previousPage = client.charts.list.page_before(nextPage.previous_page_ends_before)
+previousPage.each do |chart|
+  puts chart.key
+end
 ```
 
 # Error handling

data/lib/seatsio/chart_reports.rb

@@ -11,7 +11,21 @@ module Seatsio
     end
 
     def by_label(chart_key)
-      url = "reports/charts/#{chart_key}/byLabel"
+      get_chart_report('byLabel', chart_key)
+    end
+
+    def by_category_key(chart_key)
+      get_chart_report('byCategoryKey', chart_key)
+    end
+
+    def by_category_label(chart_key)
+      get_chart_report('byCategoryLabel', chart_key)
+    end
+
+    private
+
+    def get_chart_report(report_type, chart_key)
+      url = "reports/charts/#{chart_key}/#{report_type}"
       body = @http_client.get(url)
       Domain::ChartReport.new(body)
     end

data/lib/seatsio/version.rb

@@ -1,3 +1,3 @@
 module Seatsio
-  VERSION = "9"
+  VERSION = "10"
 end

data/releasing.md

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seatsio
 version: !ruby/object:Gem::Version
-  version: '9'
+  version: '10'
 platform: ruby
 authors:
 - Seats.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,7 @@ files:
 - lib/seatsio/subaccounts.rb
 - lib/seatsio/util.rb
 - lib/seatsio/version.rb
+- releasing.md
 - seatsio.gemspec
 homepage: http://seats.io
 licenses: []
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: the official Seats.io Ruby client library