odeon_uk 4.0.0 → 5.0.0

data/lib/odeon_uk/performance.rb

@@ -20,18 +20,25 @@ module OdeonUk
     #   @option options [String] :dimension ('2d') dimension of the screening
     #   @option options [String] :film_name name of the film
     #   @option options [Time] :starting_at listed start time of the performance
+    #   @option options [Cinebase::Festival] :festival (nil) festival edition
+    #   @option options [String] :language (nil) audio language of the screening
 
-    # All currently listed films showing at a cinema
-    # @param [Integer] cinema_id id of the cinema on the website
+    # Performances within an inclusive range of cinema business dates.
+    # @param [Integer, String] cinema_id id of the cinema on the website
+    # @param [Date] from first date (defaults to today in London)
+    # @param [Date] to last date (defaults to 13 days after from)
     # @return [Array<OdeonUk::Performance>]
-    def self.at(cinema_id)
-      film_ids_at(cinema_id).flat_map do |film_id|
-        api_response.film_times(cinema_id, film_id).flat_map do |day|
-          performance_days(day).map do |hash|
-            new(hash.merge(cinema_hash(cinema_id))
-                    .merge(film_name: film_name(film_id)))
-          end
-        end
+    def self.at(
+      cinema_id,
+      from: TZInfo::Timezone.get('Europe/London').now.to_date,
+      to: from + 13
+    )
+      raise ArgumentError, 'to must not precede from' if to < from
+
+      api = OdeonUk::Internal::ApiResponse.new
+      cinema = Cinema.new(cinema_id)
+      (from..to).flat_map do |date|
+        performances_on(api, cinema, date)
       end
     end
 
@@ -47,41 +54,28 @@ module OdeonUk
     #   The kinds of screening (IMAX, kids, baby, senior)
     #   @return <Array[String]>
 
-    # private
-
-    def self.api_response
-      @api_response ||= OdeonUk::Internal::ApiResponse.new
-    end
-    private_class_method :api_response
-
-    def self.cinema_hash(cinema_id)
-      { cinema_id: cinema_id, cinema_name: Cinema.new(cinema_id).name }
-    end
-    private_class_method :cinema_hash
-
-    def self.films_at(cinema_id)
-      film_lookup.at(cinema_id)
-    end
-    private_class_method :films_at
 
-    def self.film_lookup
-      @film_lookup ||= OdeonUk::Internal::Parser::Api::FilmLookup.new
-    end
-    private_class_method :film_lookup
+    # private
 
-    def self.film_ids_at(cinema_id)
-      films_at(cinema_id).keys
-    end
-    private_class_method :film_ids_at
+    def self.performances_on(api, cinema, date)
+      response = api.showtimes(cinema.id, date)
+      related = response.fetch('relatedData')
+      films = by_id(related.fetch('films'))
+      attributes = by_id(related.fetch('attributes'))
 
-    def self.film_name(film_id)
-      film_lookup.to_hash[film_id]['title']
+      response.fetch('showtimes').map do |data|
+        showtime = OdeonUk::Internal::Parser::Api::Showtime.new(
+          data, films: films, attributes: attributes
+        )
+        new(showtime.to_hash.merge(cinema_id: cinema.id,
+                                   cinema_name: cinema.name))
+      end
     end
-    private_class_method :film_name
+    private_class_method :performances_on
 
-    def self.performance_days(data)
-      OdeonUk::Internal::Parser::Api::PerformanceDay.new(data).to_a
+    def self.by_id(items)
+      items.to_h { |item| [item.fetch('id'), item] }
     end
-    private_class_method :performance_days
+    private_class_method :by_id
   end
 end

data/lib/odeon_uk/version.rb

@@ -1,6 +1,6 @@
-# Ruby interface for http://www.odeon.co.uk
-# @version 4.0.0
+# Ruby interface for https://www.odeon.co.uk
+# @version 5.0.0
 module OdeonUk
   # Gem version
-  VERSION = '4.0.0'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/lib/odeon_uk.rb

@@ -1,16 +1,30 @@
+require 'json'
+
 require 'cinebase'
+require 'cinebase/vista'
 
 require_relative './odeon_uk/version'
 
 require_relative './odeon_uk/internal/api_response'
+require_relative './odeon_uk/internal/guest_token'
 require_relative './odeon_uk/internal/title_sanitizer'
 
-require_relative './odeon_uk/internal/parser/api/film_lookup'
-require_relative './odeon_uk/internal/parser/api/performance_day'
+require_relative './odeon_uk/internal/parser/api/showtime'
 
 require_relative './odeon_uk/cinema'
 require_relative './odeon_uk/performance'
 
 # odeon_uk gem
 module OdeonUk
+  AuthenticationError = Cinebase::Vista::AuthenticationError
+
+  # A raw guest JWT, without the "Bearer " prefix. Never persisted by the gem.
+  class << self
+    attr_accessor :token
+
+    # Explicit acquisition/renewal; ordinary API calls never launch a subprocess.
+    def acquire_token!(curl: nil)
+      self.token = Internal::GuestToken.new(curl: curl).fetch
+    end
+  end
 end

data/odeon_uk.gemspec

@@ -7,21 +7,25 @@ Gem::Specification.new do |spec|
   spec.version       = OdeonUk::VERSION
   spec.authors       = ['Andy Croll']
   spec.email         = ['andy@goodscary.com']
-  spec.description   = 'Pull movie & cinema information from the Odeon iOS API'
+  spec.description   = 'Pull movie & cinema information from the ODEON Vista API'
   spec.summary       = "It's a scraper, but a nice one"
-  spec.homepage      = 'http://github.com/andycroll/odeon_uk'
+  spec.homepage      = 'https://github.com/andycroll/odeon_uk'
   spec.licenses      = %w(AGPL MIT)
 
-  spec.files         = `git ls-files`.split($RS)
+  spec.required_ruby_version = '>= 3.4'
+
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'base64'
+  spec.add_development_dependency 'bundler', '>= 2.0'
+  spec.add_development_dependency 'minitest-mock'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov', '< 1'
   spec.add_development_dependency 'webmock'
 
-  spec.add_runtime_dependency 'CFPropertyList'
-  spec.add_runtime_dependency 'cinebase', '~> 3.0'
+  spec.add_runtime_dependency 'cinebase', '~> 5.2'
 end

data/test/fixtures/api/showtimes-824.json

@@ -0,0 +1,66 @@
+{
+  "businessDate": "2026-10-24",
+  "showtimes": [
+    {
+      "id": "824-1001",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T09:00:00+01:00" },
+      "attributeIds": ["A-AD"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "824-1002",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T14:30:00+01:00" },
+      "attributeIds": ["A-3D", "A-IMAX"],
+      "requires3dGlasses": true
+    },
+    {
+      "id": "824-1003",
+      "filmId": "FILM-2",
+      "schedule": { "startsAt": "2026-10-24T18:00:00+01:00" },
+      "attributeIds": ["A-KOREAN", "A-SUB", "A-EVENT"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "824-1004",
+      "filmId": "FILM-3",
+      "schedule": { "startsAt": "2026-10-24T20:15:00+01:00" },
+      "attributeIds": ["A-TAMIL", "A-SUB"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "824-1005",
+      "filmId": "FILM-4",
+      "schedule": { "startsAt": "2026-10-24T10:00:00+01:00" },
+      "attributeIds": ["A-KIDS", "A-CAPT"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "824-1006",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-25T00:15:00+01:00" },
+      "attributeIds": [],
+      "requires3dGlasses": false
+    }
+  ],
+  "relatedData": {
+    "films": [
+      { "id": "FILM-1", "title": { "text": "The Example Film 3D" } },
+      { "id": "FILM-2", "title": { "text": "Made Up Concert: Live" } },
+      { "id": "FILM-3", "title": { "text": "Imaginary Picture (Tamil)" } },
+      { "id": "FILM-4", "title": { "text": "Pretend Pups" } }
+    ],
+    "attributes": [
+      { "id": "A-AD", "shortName": { "text": "AudioDes" }, "name": { "text": "Audio Described" } },
+      { "id": "A-3D", "shortName": { "text": "3D" }, "name": { "text": "3D" } },
+      { "id": "A-IMAX", "shortName": { "text": "IMAX" }, "name": { "text": "IMAX" } },
+      { "id": "A-KOREAN", "shortName": { "text": "KoreanLang" }, "name": { "text": "Korean (Audio)" } },
+      { "id": "A-TAMIL", "shortName": { "text": "TamilA" }, "name": { "text": "Tamil (Audio)" } },
+      { "id": "A-SUB", "shortName": { "text": "EnglishSub" }, "name": { "text": "English (Sub)" } },
+      { "id": "A-EVENT", "shortName": { "text": "EventCinem" }, "name": { "text": "Event Cinema" } },
+      { "id": "A-KIDS", "shortName": { "text": "ODEON Kids" }, "name": { "text": "ODEON Kids" } },
+      { "id": "A-CAPT", "shortName": { "text": "OpenCapt" }, "name": { "text": "Open Captioned" } }
+    ]
+  }
+}

data/test/fixtures/api/sites.json

@@ -0,0 +1,32 @@
+{
+  "sites": [
+    {
+      "id": "017",
+      "name": { "text": "Birmingham New Street" },
+      "contactDetails": {
+        "address": { "line1": "1 Example Arcade", "line2": "New Street", "city": "Birmingham" }
+      }
+    },
+    {
+      "id": "153",
+      "name": { "text": "London Leicester Square" },
+      "contactDetails": {
+        "address": { "line1": "2 Example Square", "line2": "", "city": "London" }
+      }
+    },
+    {
+      "id": "824",
+      "name": { "text": "Brighton" },
+      "contactDetails": {
+        "address": { "line1": "3 Example Parade", "line2": "Seafront", "city": "Brighton" }
+      }
+    },
+    {
+      "id": "955",
+      "name": { "text": "Trafford Centre" },
+      "contactDetails": {
+        "address": { "line1": "4 Example Dome", "line2": "", "city": "Manchester" }
+      }
+    }
+  ]
+}

data/test/lib/odeon_uk/cinema_test.rb

@@ -1,262 +1,113 @@
 require_relative '../../test_helper'
 
-describe OdeonUk::Cinema do
-  include ApiFixturesHelper
-
-  let(:described_class) { OdeonUk::Cinema }
-  let(:api_response) { FakeApiResponse.new }
-
-  before { WebMock.disable_net_connect! }
-  after { WebMock.allow_net_connect! }
-
-  describe '.new(id)' do
-    subject { described_class.new(id) }
-
-    describe 'Brighton' do
-      let(:id) { 71 }
-
-      it 'returns a cinema with a string id' do
-        subject.must_be_instance_of(described_class)
-        subject.id.must_equal(id.to_s)
-      end
-    end
+class OdeonUk::CinemaTest < Minitest::Test
+  def setup
+    @api_response = FakeApiResponse.new
   end
 
-  describe '.all' do
-    subject { described_class.all }
+  def test_new_returns_cinema_with_string_id
+    cinema = OdeonUk::Cinema.new(824)
 
-    it 'returns an array of cinemas' do
-      OdeonUk::Internal::ApiResponse.stub :new, api_response do
-        subject.must_be_instance_of(Array)
-        subject.each do |element|
-          element.must_be_instance_of(described_class)
-        end
-        subject.count.must_be :>, 100
-      end
-    end
+    assert_instance_of OdeonUk::Cinema, cinema
+    assert_equal '824', cinema.id
   end
 
-  describe '#adr' do
-    subject { described_class.new(id).adr }
-
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal(street_address:   'Kingswest',
-                             extended_address: nil,
-                             locality:         'Brighton',
-                             region:           nil,
-                             postal_code:      'BN1 2RE',
-                             country_name:     'United Kingdom')
-        end
-      end
-    end
+  def test_new_zero_pads_id
+    assert_equal '017', OdeonUk::Cinema.new(17).id
   end
 
-  describe '#address' do
-    subject { described_class.new(id).address }
-
-    describe 'London address' do
-      let(:id) { 105 }
+  def test_all_returns_cinemas
+    with_fake_api do
+      cinemas = OdeonUk::Cinema.all
 
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal(street_address:   '24-26 Leicester Square',
-                             extended_address: nil,
-                             locality:         'London',
-                             region:           nil,
-                             postal_code:      'WC2H 7JY',
-                             country_name:     'United Kingdom')
-        end
-      end
+      assert(cinemas.all? { |cinema| cinema.instance_of?(OdeonUk::Cinema) })
+      assert_equal %w(017 153 824 955), cinemas.map(&:id)
     end
   end
 
-  describe '#brand' do
-    subject { described_class.new(id).brand }
-    describe 'short address' do
-      let(:id) { 71 }
+  def test_adr_has_no_postcode
+    expected = {
+      street_address:   '3 Example Parade',
+      extended_address: 'Seafront',
+      locality:         'Brighton',
+      region:           nil,
+      postal_code:      nil,
+      country_name:     'United Kingdom'
+    }
 
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Odeon'
-        end
-      end
+    with_fake_api do
+      assert_equal expected, OdeonUk::Cinema.new(824).adr
     end
   end
 
-  describe '#country_name' do
-    subject { described_class.new(id).country_name }
-    describe 'short address' do
-      let(:id) { 71 }
+  def test_address_for_london
+    expected = {
+      street_address:   '2 Example Square',
+      extended_address: '',
+      locality:         'London',
+      region:           nil,
+      postal_code:      nil,
+      country_name:     'United Kingdom'
+    }
 
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'United Kingdom'
-        end
-      end
+    with_fake_api do
+      assert_equal expected, OdeonUk::Cinema.new(153).address
     end
   end
 
-  describe '#extended_address' do
-    subject { described_class.new(id).extended_address }
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal ''
-        end
-      end
-    end
+  def test_brand
+    assert_equal 'Odeon', OdeonUk::Cinema.new(824).brand
   end
 
-  describe '#full_name' do
-    subject { described_class.new(id).full_name }
-    describe 'Brighton' do
-      let(:id) { 71 }
-
-      it 'returns cinema name' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Odeon Brighton'
-        end
-      end
-    end
-
-    describe 'Leicester Square' do
-      let(:id) { 105 }
-
-      it 'returns cinema name' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Odeon Leicester Square'
-        end
-      end
+  def test_full_name
+    with_fake_api do
+      assert_equal 'Odeon Brighton', OdeonUk::Cinema.new(824).full_name
+      assert_equal 'Odeon Leicester Square', OdeonUk::Cinema.new(153).full_name
     end
   end
 
-  describe '#locality' do
-    subject { described_class.new(id).locality }
-    describe 'Short Address (Brighton)' do
-      let(:id) { 71 }
-
-      it 'returns town name' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Brighton'
-        end
-      end
+  def test_name_removes_london_prefix
+    with_fake_api do
+      assert_equal 'Leicester Square', OdeonUk::Cinema.new(153).name
     end
   end
 
-  describe '#name' do
-    subject { described_class.new(id).name }
-    describe 'Brighton' do
-      let(:id) { 71 }
-
-      it 'returns cinema name' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Brighton'
-        end
-      end
-    end
-
-    describe 'Leicester Square' do
-      let(:id) { 105 }
-
-      it 'returns cinema name' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Leicester Square'
-        end
-      end
+  def test_postal_code_is_empty
+    with_fake_api do
+      assert_equal '', OdeonUk::Cinema.new(824).postal_code
     end
   end
 
-  describe '#postal_code' do
-    subject { described_class.new(id).postal_code }
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'BN1 2RE'
-        end
-      end
-    end
-
-    describe 'short address (London)' do
-      let(:id) { 211 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'SE1 8XR'
-        end
-      end
-    end
-
-    describe 'short address (extra London Postcode)' do
-      let(:id) { 105 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'WC2H 7JY'
-        end
-      end
+  def test_slug
+    with_fake_api do
+      assert_equal 'odeon-brighton', OdeonUk::Cinema.new(824).slug
     end
   end
 
-  describe '#region' do
-    subject { described_class.new(id).region }
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns the postcode' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal ''
-        end
-      end
+  def test_url
+    with_fake_api do
+      assert_equal 'https://www.odeon.co.uk/cinemas/brighton/',
+                   OdeonUk::Cinema.new(824).url
     end
   end
 
-  describe '#slug' do
-    subject { described_class.new(id).slug }
-
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns first line of address' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'odeon-brighton'
-        end
-      end
+  def test_url_keeps_london_prefix
+    with_fake_api do
+      assert_equal 'https://www.odeon.co.uk/cinemas/london-leicester-square/',
+                   OdeonUk::Cinema.new(153).url
     end
   end
 
-  describe '#street_address' do
-    subject { described_class.new(id).street_address }
-
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns first line of address' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'Kingswest'
-        end
-      end
+  def test_url_uses_slug_that_differs_from_name
+    with_fake_api do
+      assert_equal 'https://www.odeon.co.uk/cinemas/manchester-trafford-centre/',
+                   OdeonUk::Cinema.new(955).url
     end
   end
 
-  describe '#url' do
-    subject { described_class.new(id).url }
+  private
 
-    describe 'short address' do
-      let(:id) { 71 }
-
-      it 'returns first line of address' do
-        OdeonUk::Internal::ApiResponse.stub :new, api_response do
-          subject.must_equal 'http://www.odeon.co.uk/cinemas/brighton/71/'
-        end
-      end
-    end
+  def with_fake_api(&block)
+    OdeonUk::Internal::ApiResponse.stub(:new, @api_response, &block)
   end
 end