odeon_uk 4.0.1 → 5.1.0

data/test/support/api_fixtures_helper.rb

@@ -2,40 +2,15 @@
 module ApiFixturesHelper
   private
 
-  def all_cinemas_plist
-    read_fixture('api/all_cinemas')
+  def sites_json
+    read_fixture('api/sites')
   end
 
-  def app_init_plist
-    read_fixture('api/app_init')
-  end
-
-  def film_times_plist(cinema_id, film_id)
-    read_fixture("api/film_times/#{cinema_id}-#{film_id}")
-  end
-
-  def film_times_plist_random
-    read_fixture("api/film_times/#{film_times_plist_names(71).sample}")
-  end
-
-  def film_times_plist_names(cinema_id)
-    Dir.entries(File.expand_path('../../fixtures/api/film_times', __FILE__))
-       .reject { |filename| !filename.match(/\A#{cinema_id}-/) }
-       .map { |filename| filename.gsub('.plist', '') }
-  end
-
-  def parse(content)
-    plist = CFPropertyList::List.new(data: content).value
-    CFPropertyList.native_types(plist).fetch('data', {})
+  def showtimes_json(cinema_id)
+    read_fixture("api/showtimes-#{cinema_id}")
   end
 
   def read_fixture(filepath)
-    File.read(File.expand_path("../../fixtures/#{filepath}.plist", __FILE__))
-  end
-
-  def stub_post(site_path, request_body, response_body)
-    url      = "https://api.odeon.co.uk/2.1/api/#{site_path}"
-    response = { status: 200, body: response_body, headers: {} }
-    stub_request(:post, url).with(body: request_body).to_return(response)
+    File.read(File.expand_path("../../fixtures/#{filepath}.json", __FILE__))
   end
 end

data/test/support/api_shapes.rb

@@ -0,0 +1,46 @@
+require 'time'
+
+# The parts of Vista responses the gem reads. Checked against the hand-written
+# fixtures and, in the live suite, against real responses held only in memory.
+module ApiShapes
+  private
+
+  def assert_sites_shape(data)
+    sites = data.fetch('sites')
+    refute_empty sites
+    sites.each do |site|
+      assert_match(/\A\d{3}\z/, site.fetch('id'))
+      assert_kind_of String, site.dig('name', 'text')
+      address = site.fetch('contactDetails').fetch('address')
+      %w(line1 line2 city).each do |key|
+        assert_kind_of String, address.fetch(key), "site #{site['id']} #{key}"
+      end
+    end
+  end
+
+  def assert_showtimes_shape(data)
+    related = data.fetch('relatedData')
+    films = related.fetch('films').to_h { |film| [film.fetch('id'), film] }
+    attributes = related.fetch('attributes').to_h do |attribute|
+      [attribute.fetch('id'), attribute]
+    end
+
+    films.each_value { |film| assert_kind_of String, film.dig('title', 'text') }
+    attributes.each_value do |attribute|
+      assert_kind_of String, attribute.dig('shortName', 'text')
+      assert_kind_of String, attribute.dig('name', 'text')
+    end
+
+    showtimes = data.fetch('showtimes')
+    refute_empty showtimes
+    showtimes.each do |showtime|
+      assert_kind_of String, showtime.fetch('id')
+      assert_includes films.keys, showtime.fetch('filmId')
+      assert_kind_of Time, Time.iso8601(showtime.fetch('schedule').fetch('startsAt'))
+      assert_includes [true, false], showtime.fetch('requires3dGlasses')
+      showtime.fetch('attributeIds').each do |id|
+        assert_includes attributes.keys, id
+      end
+    end
+  end
+end

data/test/support/fake_api_response.rb

@@ -3,15 +3,18 @@ require_relative 'api_fixtures_helper'
 class FakeApiResponse
   include ApiFixturesHelper
 
-  def app_init
-    parse(app_init_plist)
+  attr_reader :requested_dates
+
+  def initialize
+    @requested_dates = []
   end
 
-  def all_cinemas
-    parse(all_cinemas_plist)
+  def sites
+    JSON.parse(sites_json).fetch('sites')
   end
 
-  def film_times(cinema_id, film_id)
-    parse(film_times_plist(cinema_id, film_id))
+  def showtimes(cinema_id, date)
+    @requested_dates << date
+    JSON.parse(showtimes_json(cinema_id))
   end
 end

data/test/test_helper.rb

@@ -1,7 +1,10 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
 
 require 'minitest/autorun'
+require 'minitest/mock'
 require 'minitest/reporters'
 
 Minitest::Reporters.use! [
@@ -9,9 +12,9 @@ Minitest::Reporters.use! [
 ]
 
 require 'webmock/minitest'
-WebMock.allow_net_connect!
 
 require File.expand_path('../../lib/odeon_uk.rb', __FILE__)
 
 require_relative 'support/api_fixtures_helper'
+require_relative 'support/api_shapes'
 require_relative 'support/fake_api_response'

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: odeon_uk
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Andy Croll
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,13 +80,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: CFPropertyList
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -86,23 +113,25 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Pull movie & cinema information from the Odeon iOS API
+        version: '5.4'
+description: Pull movie & cinema information from the ODEON Vista API
 email:
 - andy@goodscary.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - COMM-LICENSE
 - Gemfile
@@ -112,60 +141,35 @@ files:
 - lib/odeon_uk.rb
 - lib/odeon_uk/cinema.rb
 - lib/odeon_uk/internal/api_response.rb
-- lib/odeon_uk/internal/parser/api/film_lookup.rb
-- lib/odeon_uk/internal/parser/api/performance_day.rb
+- lib/odeon_uk/internal/guest_token.rb
+- lib/odeon_uk/internal/parser/api/showtime.rb
 - lib/odeon_uk/internal/title_sanitizer.rb
 - lib/odeon_uk/performance.rb
 - lib/odeon_uk/version.rb
 - odeon_uk.gemspec
-- rake/fixture_creator.rb
-- test/fixtures/api/all_cinemas.plist
-- test/fixtures/api/app_init.plist
-- test/fixtures/api/film_times/71-14876.plist
-- test/fixtures/api/film_times/71-15408.plist
-- test/fixtures/api/film_times/71-15684.plist
-- test/fixtures/api/film_times/71-15866.plist
-- test/fixtures/api/film_times/71-15868.plist
-- test/fixtures/api/film_times/71-15961.plist
-- test/fixtures/api/film_times/71-15963.plist
-- test/fixtures/api/film_times/71-15965.plist
-- test/fixtures/api/film_times/71-15967.plist
-- test/fixtures/api/film_times/71-15969.plist
-- test/fixtures/api/film_times/71-15977.plist
-- test/fixtures/api/film_times/71-15980.plist
-- test/fixtures/api/film_times/71-16037.plist
-- test/fixtures/api/film_times/71-16136.plist
-- test/fixtures/api/film_times/71-16142.plist
-- test/fixtures/api/film_times/71-16143.plist
-- test/fixtures/api/film_times/71-16187.plist
-- test/fixtures/api/film_times/71-16369.plist
-- test/fixtures/api/film_times/71-16370.plist
-- test/fixtures/api/film_times/71-16374.plist
-- test/fixtures/api/film_times/71-16386.plist
-- test/fixtures/api/film_times/71-16387.plist
-- test/fixtures/api/film_times/71-16388.plist
-- test/fixtures/api/film_times/71-16438.plist
-- test/fixtures/api/film_times/71-16454.plist
-- test/fixtures/api/film_times/71-16457.plist
-- test/fixtures/api/film_times/71-16477.plist
-- test/fixtures/api/film_times/71-16478.plist
-- test/fixtures/api/film_times/71-16480.plist
-- test/fixtures/api/film_times/71-16482.plist
-- test/fixtures/api/film_times/71-16489.plist
+- test/fixtures/api/showtimes-824.json
+- test/fixtures/api/sites.json
 - test/lib/odeon_uk/cinema_test.rb
 - test/lib/odeon_uk/internal/api_response_test.rb
+- test/lib/odeon_uk/internal/fixture_shape_test.rb
+- test/lib/odeon_uk/internal/guest_token_test.rb
+- test/lib/odeon_uk/internal/parser/api/showtime_test.rb
 - test/lib/odeon_uk/internal/title_sanitizer_test.rb
 - test/lib/odeon_uk/performance_test.rb
 - test/lib/odeon_uk/version_test.rb
+- test/live/api_shape_test.rb
+- test/live/integration_test.rb
+- test/live/live_helper.rb
+- test/package_test.rb
 - test/support/api_fixtures_helper.rb
+- test/support/api_shapes.rb
 - test/support/fake_api_response.rb
 - test/test_helper.rb
-homepage: http://github.com/andycroll/odeon_uk
+homepage: https://github.com/andycroll/odeon_uk
 licenses:
 - AGPL
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -173,58 +177,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: It's a scraper, but a nice one
 test_files:
-- test/fixtures/api/all_cinemas.plist
-- test/fixtures/api/app_init.plist
-- test/fixtures/api/film_times/71-14876.plist
-- test/fixtures/api/film_times/71-15408.plist
-- test/fixtures/api/film_times/71-15684.plist
-- test/fixtures/api/film_times/71-15866.plist
-- test/fixtures/api/film_times/71-15868.plist
-- test/fixtures/api/film_times/71-15961.plist
-- test/fixtures/api/film_times/71-15963.plist
-- test/fixtures/api/film_times/71-15965.plist
-- test/fixtures/api/film_times/71-15967.plist
-- test/fixtures/api/film_times/71-15969.plist
-- test/fixtures/api/film_times/71-15977.plist
-- test/fixtures/api/film_times/71-15980.plist
-- test/fixtures/api/film_times/71-16037.plist
-- test/fixtures/api/film_times/71-16136.plist
-- test/fixtures/api/film_times/71-16142.plist
-- test/fixtures/api/film_times/71-16143.plist
-- test/fixtures/api/film_times/71-16187.plist
-- test/fixtures/api/film_times/71-16369.plist
-- test/fixtures/api/film_times/71-16370.plist
-- test/fixtures/api/film_times/71-16374.plist
-- test/fixtures/api/film_times/71-16386.plist
-- test/fixtures/api/film_times/71-16387.plist
-- test/fixtures/api/film_times/71-16388.plist
-- test/fixtures/api/film_times/71-16438.plist
-- test/fixtures/api/film_times/71-16454.plist
-- test/fixtures/api/film_times/71-16457.plist
-- test/fixtures/api/film_times/71-16477.plist
-- test/fixtures/api/film_times/71-16478.plist
-- test/fixtures/api/film_times/71-16480.plist
-- test/fixtures/api/film_times/71-16482.plist
-- test/fixtures/api/film_times/71-16489.plist
+- test/fixtures/api/showtimes-824.json
+- test/fixtures/api/sites.json
 - test/lib/odeon_uk/cinema_test.rb
 - test/lib/odeon_uk/internal/api_response_test.rb
+- test/lib/odeon_uk/internal/fixture_shape_test.rb
+- test/lib/odeon_uk/internal/guest_token_test.rb
+- test/lib/odeon_uk/internal/parser/api/showtime_test.rb
 - test/lib/odeon_uk/internal/title_sanitizer_test.rb
 - test/lib/odeon_uk/performance_test.rb
 - test/lib/odeon_uk/version_test.rb
+- test/live/api_shape_test.rb
+- test/live/integration_test.rb
+- test/live/live_helper.rb
+- test/package_test.rb
 - test/support/api_fixtures_helper.rb
+- test/support/api_shapes.rb
 - test/support/fake_api_response.rb
 - test/test_helper.rb
-has_rdoc: 

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.4
-  - 2.3.0
-addons:
-  code_climate:
-    repo_token: 2999a45e7504799e1153d82fcb36fcc8f603388ca3d7df3caae1dd20f753a8c1

data/lib/odeon_uk/internal/parser/api/film_lookup.rb

@@ -1,34 +0,0 @@
-module OdeonUk
-  # @api private
-  module Internal
-    module Parser
-      module Api
-        # Parses a string to derive address
-        class FilmLookup
-          # @param [Integer] cinema_id id of the cinema
-          # @return [Hash{Integer => OdeonUk::Internal::Parser::Api::Film}]
-          # contains all films keyed by id for a cinema
-          def at(cinema_id)
-            to_hash.select do |_, film_hash|
-              film_hash['sites'].include?(cinema_id)
-            end
-          end
-
-          # @return [Hash{Integer => OdeonUk::Internal::Parser::Api::Film}]
-          # contains all films & upcoming films keyed by id
-          def to_hash
-            @to_hash ||= api.each_with_object({}) do |film_hash, result|
-              result[film_hash['filmMasterId'].to_i] = film_hash
-            end
-          end
-
-          private
-
-          def api
-            @api ||= OdeonUk::Internal::ApiResponse.new.app_init['films']
-          end
-        end
-      end
-    end
-  end
-end

data/lib/odeon_uk/internal/parser/api/performance_day.rb

@@ -1,92 +0,0 @@
-module OdeonUk
-  # @api private
-  module Internal
-    module Parser
-      module Api
-        # A single day of performances for a particular film
-        class PerformanceDay
-          def initialize(data)
-            @data = data
-          end
-
-          def to_a
-            performance_kinds.each_with_index.flat_map do |_, index|
-              starting_times(index).map do |time|
-                {
-                  dimension: dimension(index),
-                  starting_at: TimeParser.new(date, time).to_utc,
-                  variant: variant(index)
-                }
-              end
-            end
-          end
-
-          private
-
-          def date
-            @data['date']
-          end
-
-          def dimension(index)
-            performance_kind(index).include?('3D') ? '3d' : '2d'
-          end
-
-          def performance_kinds
-            @data['attributes']
-          end
-
-          def performance_kind(index)
-            performance_kinds[index]['attribute']
-          end
-
-          def starting_times(index)
-            performance_kinds[index]['showtimes'][0].map do |h|
-              h['performanceTime']
-            end
-          end
-
-          def variant(index)
-            {
-              'Culture'       => 'arts',
-              'Kids'          => 'kids',
-              'IMAX'          => 'imax',
-              'Newbies'       => 'baby',
-              'Silver Cinema' => 'senior'
-            }.select { |k, _| performance_kind(index).include?(k) }.values.uniq
-          end
-
-          # parse a time to utc time
-          TimeParser = Struct.new(:date, :time) do
-            def to_utc
-              tz.local_to_utc(parsed_time)
-            end
-
-            private
-
-            def early_morning_screening?
-              time.match(/\A00/)
-            end
-
-            def parsed_date
-              case date
-              when 'Today'    then Time.now.strftime '%Y-%m-%d'
-              when 'Tomorrow' then (Time.now + 60 * 60 * 24).strftime '%Y-%m-%d'
-              else date.gsub('.', '').match(/\d+\s\w+\z/)[0]
-              end
-            end
-
-            def parsed_time
-              parsed_time = Time.parse("#{parsed_date} #{time} UTC")
-              # Odeon deliberately mislabel their 00:01 screenings as the day before
-              early_morning_screening? ? parsed_time + 60 * 60 * 24 : parsed_time
-            end
-
-            def tz
-              @tz ||= TZInfo::Timezone.get('Europe/London')
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/rake/fixture_creator.rb

@@ -1,46 +0,0 @@
-module FixtureCreator
-  class Api
-    def all_cinemas!
-      write_fixture(:all_cinemas)
-    end
-
-    def app_init!
-      write_fixture(:app_init)
-    end
-
-    def film_times!(cinema_id)
-      OdeonUk::Performance.send(:film_ids_at, cinema_id).each do |i|
-        write_film_times_fixture(cinema_id, i)
-      end
-    end
-
-    private
-
-    def fixture(name)
-      File.expand_path("../../test/fixtures/api/#{name}.plist", __FILE__)
-    end
-
-    def log(message)
-      puts "Create API fixture: #{message}"
-    end
-
-    def write_film_times_fixture(cinema_id, film_id)
-      FileUtils.mkdir_p 'film_times'
-      text = "film_times/#{cinema_id}-#{film_id}"
-      File.open(fixture(text), 'w+') do |file|
-        log(text)
-        file.write OdeonUk::Internal::ApiResponse.new.send(:film_times_raw,
-                                                           cinema_id,
-                                                           film_id)
-      end
-    end
-
-    def write_fixture(kind)
-      FileUtils.mkdir_p kind.to_s
-      File.open(fixture(kind), 'w+') do |file|
-        log(kind)
-        file.write OdeonUk::Internal::ApiResponse.new.send("#{kind}_raw".to_sym)
-      end
-    end
-  end
-end