odeon_uk 5.0.0-aarch64-linux-gnu

data/odeon_uk.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'odeon_uk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'odeon_uk'
+  spec.version       = OdeonUk::VERSION
+  spec.authors       = ['Andy Croll']
+  spec.email         = ['andy@goodscary.com']
+  spec.description   = 'Pull movie & cinema information from the ODEON Vista API'
+  spec.summary       = "It's a scraper, but a nice one"
+  spec.homepage      = 'https://github.com/andycroll/odeon_uk'
+  spec.licenses      = %w(AGPL MIT)
+
+  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 '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 '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

@@ -0,0 +1,113 @@
+require_relative '../../test_helper'
+
+class OdeonUk::CinemaTest < Minitest::Test
+  def setup
+    @api_response = FakeApiResponse.new
+  end
+
+  def test_new_returns_cinema_with_string_id
+    cinema = OdeonUk::Cinema.new(824)
+
+    assert_instance_of OdeonUk::Cinema, cinema
+    assert_equal '824', cinema.id
+  end
+
+  def test_new_zero_pads_id
+    assert_equal '017', OdeonUk::Cinema.new(17).id
+  end
+
+  def test_all_returns_cinemas
+    with_fake_api do
+      cinemas = OdeonUk::Cinema.all
+
+      assert(cinemas.all? { |cinema| cinema.instance_of?(OdeonUk::Cinema) })
+      assert_equal %w(017 153 824 955), cinemas.map(&:id)
+    end
+  end
+
+  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'
+    }
+
+    with_fake_api do
+      assert_equal expected, OdeonUk::Cinema.new(824).adr
+    end
+  end
+
+  def test_address_for_london
+    expected = {
+      street_address:   '2 Example Square',
+      extended_address: '',
+      locality:         'London',
+      region:           nil,
+      postal_code:      nil,
+      country_name:     'United Kingdom'
+    }
+
+    with_fake_api do
+      assert_equal expected, OdeonUk::Cinema.new(153).address
+    end
+  end
+
+  def test_brand
+    assert_equal 'Odeon', OdeonUk::Cinema.new(824).brand
+  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
+
+  def test_name_removes_london_prefix
+    with_fake_api do
+      assert_equal 'Leicester Square', OdeonUk::Cinema.new(153).name
+    end
+  end
+
+  def test_postal_code_is_empty
+    with_fake_api do
+      assert_equal '', OdeonUk::Cinema.new(824).postal_code
+    end
+  end
+
+  def test_slug
+    with_fake_api do
+      assert_equal 'odeon-brighton', OdeonUk::Cinema.new(824).slug
+    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
+
+  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
+
+  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
+
+  private
+
+  def with_fake_api(&block)
+    OdeonUk::Internal::ApiResponse.stub(:new, @api_response, &block)
+  end
+end

data/test/lib/odeon_uk/internal/api_response_test.rb

@@ -0,0 +1,66 @@
+require_relative '../../../test_helper'
+
+class OdeonUk::Internal::ApiResponseTest < Minitest::Test
+  include ApiFixturesHelper
+
+  BASE_URL = 'https://vwc.odeon.co.uk/WSVistaWebClient/ocapi/v1'.freeze
+  HEADERS = {
+    'Authorization' => 'Bearer guest-jwt', 'Connect-Region-Code' => 'UK'
+  }.freeze
+
+  def setup
+    OdeonUk.token = 'guest-jwt'
+  end
+
+  def teardown
+    OdeonUk.token = nil
+    super
+  end
+
+  def test_sites
+    stub_request(:get, "#{BASE_URL}/sites")
+      .with(headers: HEADERS)
+      .to_return(status: 200, body: sites_json)
+
+    sites = api.sites
+
+    assert_kind_of Array, sites
+    assert_includes sites.first.keys, 'id'
+  end
+
+  def test_showtimes
+    stub_request(:get, "#{BASE_URL}/showtimes/by-business-date/2026-10-24")
+      .with(query: { 'siteIds' => '824' }, headers: HEADERS)
+      .to_return(status: 200, body: showtimes_json('824'))
+
+    showtimes = api.showtimes('824', Date.new(2026, 10, 24))
+
+    assert_equal %w(businessDate relatedData showtimes), showtimes.keys.sort
+  end
+
+  def test_missing_token_raises_before_request
+    OdeonUk.token = nil
+
+    assert_raises(OdeonUk::AuthenticationError) { api.sites }
+  end
+
+  def test_rejected_token_raises
+    stub_request(:get, "#{BASE_URL}/sites").to_return(status: 401)
+
+    assert_raises(OdeonUk::AuthenticationError) { api.sites }
+  end
+
+  def test_server_error_omits_body
+    stub_request(:get, "#{BASE_URL}/sites").to_return(status: 500, body: 'secret')
+
+    error = assert_raises(RuntimeError) { api.sites }
+
+    assert_equal 'Vista HTTP error 500', error.message
+  end
+
+  private
+
+  def api
+    OdeonUk::Internal::ApiResponse.new
+  end
+end

data/test/lib/odeon_uk/internal/fixture_shape_test.rb

@@ -0,0 +1,14 @@
+require_relative '../../../test_helper'
+
+class FixtureShapeTest < Minitest::Test
+  include ApiFixturesHelper
+  include ApiShapes
+
+  def test_sites_fixture_matches_shape
+    assert_sites_shape(JSON.parse(sites_json))
+  end
+
+  def test_showtimes_fixture_matches_shape
+    assert_showtimes_shape(JSON.parse(showtimes_json('824')))
+  end
+end

data/test/lib/odeon_uk/internal/guest_token_test.rb

@@ -0,0 +1,84 @@
+require_relative '../../../test_helper'
+require 'base64'
+require 'tmpdir'
+
+class OdeonUk::Internal::GuestTokenTest < Minitest::Test
+  def setup
+    @directory = Dir.mktmpdir('odeon-guest-token')
+  end
+
+  def teardown
+    FileUtils.remove_entry(@directory)
+    OdeonUk.token = nil
+  end
+
+  def test_fetch_returns_token_from_page_data
+    token = token_expiring_at(Time.now + 3600)
+    curl = fake_curl("#{page_with(token)}\n200")
+
+    assert_equal token, guest_token(curl).fetch
+  end
+
+  def test_fetch_rejects_expired_token
+    curl = fake_curl("#{page_with(token_expiring_at(Time.now - 60))}\n200")
+
+    assert_raises(OdeonUk::AuthenticationError) { guest_token(curl).fetch }
+  end
+
+  def test_fetch_rejects_page_without_page_data
+    curl = fake_curl("<html></html>\n200")
+
+    assert_raises(OdeonUk::AuthenticationError) { guest_token(curl).fetch }
+  end
+
+  def test_fetch_rejects_redirect_to_queue
+    curl = fake_curl("\n302")
+
+    assert_raises(OdeonUk::AuthenticationError) { guest_token(curl).fetch }
+  end
+
+  def test_fetch_rejects_failed_command
+    curl = fake_curl('', exit_status: 7)
+
+    assert_raises(OdeonUk::AuthenticationError) { guest_token(curl).fetch }
+  end
+
+  def test_fetch_explains_missing_executable
+    error = assert_raises(OdeonUk::AuthenticationError) do
+      guest_token(File.join(@directory, 'missing')).fetch
+    end
+
+    assert_match(/curl-impersonate/, error.message)
+  end
+
+  def test_acquire_token_sets_token
+    token = token_expiring_at(Time.now + 3600)
+
+    OdeonUk.acquire_token!(curl: fake_curl("#{page_with(token)}\n200"))
+
+    assert_equal token, OdeonUk.token
+  end
+
+  private
+
+  def guest_token(curl)
+    OdeonUk::Internal::GuestToken.new(curl: curl)
+  end
+
+  def token_expiring_at(time)
+    payload = Base64.urlsafe_encode64(JSON.generate('exp' => time.to_i), padding: false)
+    "header.#{payload}.signature"
+  end
+
+  def page_with(token)
+    data = { 'api' => { 'apiUrl' => 'https://vwc.odeon.co.uk/WSVistaWebClient', 'authToken' => token } }
+    "<script>\n  window.initialData = #{JSON.generate(data)};\n  window.pageData = [];\n</script>"
+  end
+
+  def fake_curl(output, exit_status: 0)
+    path = File.join(@directory, 'curl-impersonate')
+    File.write(path, "#!#{RbConfig.ruby}\nSTDOUT.write(#{output.dump})\nexit #{exit_status}\n")
+    File.chmod(0o755, path)
+    path
+  end
+end

data/test/lib/odeon_uk/internal/parser/api/showtime_test.rb

@@ -0,0 +1,68 @@
+require_relative '../../../../../test_helper'
+
+class OdeonUk::Internal::Parser::Api::ShowtimeTest < Minitest::Test
+  FILMS = {
+    'HO1' => { 'title' => { 'text' => 'Jailer 2 (Tamil)' } },
+    'HO2' => { 'title' => { 'text' => 'Cine-Excess 2026: Scum Of The Earth' } }
+  }.freeze
+
+  ATTRIBUTES = {
+    '1' => { 'shortName' => { 'text' => 'TamilA' }, 'name' => { 'text' => 'Tamil (Audio)' } },
+    '2' => { 'shortName' => { 'text' => 'EnglishSub' }, 'name' => { 'text' => 'English (Sub)' } },
+    '3' => { 'shortName' => { 'text' => 'IMAX' }, 'name' => { 'text' => 'IMAX' } },
+    '4' => { 'shortName' => { 'text' => 'OpenCapt' }, 'name' => { 'text' => 'Open Captioned' } },
+    '5' => { 'shortName' => { 'text' => 'Wheelchair' }, 'name' => { 'text' => 'Wheelchair Accessible' } }
+  }.freeze
+
+  def test_to_hash
+    expected = {
+      booking_url: 'https://www.odeon.co.uk/ticketing/seat-picker/?showtimeId=824-1',
+      dimension: '2d',
+      festival: nil,
+      film_name: 'Jailer 2',
+      language: nil,
+      starting_at: Time.utc(2026, 10, 24, 17, 30),
+      variant: []
+    }
+
+    assert_equal expected, parse
+  end
+
+  def test_3d_glasses
+    assert_equal '3d', parse(requires3d: true)[:dimension]
+  end
+
+  def test_audio_language
+    assert_equal 'Tamil', parse(attribute_ids: %w(1 2 3 5))[:language]
+  end
+
+  def test_maps_known_attributes_to_variants
+    assert_equal %w(subtitled imax), parse(attribute_ids: %w(1 2 3 5))[:variant]
+  end
+
+  def test_festival_moves_from_title_to_attribute
+    showtime = parse(film_id: 'HO2')
+
+    assert_equal Cinebase::Festival.new(name: 'Cine-Excess', year: 2026), showtime[:festival]
+    assert_equal 'Scum Of The Earth', showtime[:film_name]
+  end
+
+  def test_open_captions_and_subtitles_are_one_variant
+    assert_equal %w(subtitled), parse(attribute_ids: %w(2 4))[:variant]
+  end
+
+  private
+
+  def parse(attribute_ids: [], requires3d: false, film_id: 'HO1')
+    data = {
+      'id' => '824-1',
+      'filmId' => film_id,
+      'schedule' => { 'startsAt' => '2026-10-24T18:30:00+01:00' },
+      'attributeIds' => attribute_ids,
+      'requires3dGlasses' => requires3d
+    }
+    OdeonUk::Internal::Parser::Api::Showtime.new(
+      data, films: FILMS, attributes: ATTRIBUTES
+    ).to_hash
+  end
+end

data/test/lib/odeon_uk/internal/title_sanitizer_test.rb

@@ -0,0 +1,141 @@
+require_relative '../../../test_helper'
+
+class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
+  def test_removes_2d
+    assert_sanitized 'Iron Man 3', 'Iron Man 3 2D'
+  end
+
+  def test_removes_3d
+    assert_sanitized 'Iron Man 3', 'Iron Man 3 3D'
+  end
+
+  def test_removes_autism_prefix
+    assert_sanitized 'Planes', 'Autism Friendly Screening - Planes'
+  end
+
+  def test_bolshoi
+    assert_sanitized 'Bolshoi: Spartacus', 'Bolshoi - Spartacus (Live)'
+  end
+
+  def test_removes_cinemagic_prefix
+    assert_sanitized 'Echo Planet', 'Cinemagic 2013 - Echo Planet'
+  end
+
+  def test_globe_on_screen
+    assert_sanitized 'Globe: Twelfth Night', 'Globe On Screen: Twelfth Night'
+  end
+
+  def test_met_opera
+    assert_sanitized 'Met Opera: Eugene Onegin 2013', 'Met Opera - Eugene Onegin 2013'
+  end
+
+  def test_met_opera_season
+    assert_sanitized 'Met Opera: La Fanciulla del West',
+                     'Met Opera 2026-27: La Fanciulla del West'
+  end
+
+  def test_nt_live
+    assert_sanitized 'National Theatre: War Horse', 'NT Live - War Horse'
+  end
+
+  def test_national_theatre_encore
+    assert_sanitized 'National Theatre: Frankenstein',
+                     'National Theatre Live - Frankenstein (Encore Screening)'
+  end
+
+  def test_roh
+    assert_sanitized 'Royal Opera House: Carmen', 'ROH - Carmen'
+  end
+
+  def test_rbo_season
+    assert_sanitized 'Royal Ballet and Opera: Swan Lake',
+                     'RBO Cinema Season 2026-27: Swan Lake'
+  end
+
+  def test_short_rbo_season
+    assert_sanitized "Royal Ballet and Opera: Alice's Adventures in Wonderland",
+                     "RBO 2026-27: Alice's Adventures in Wonderland"
+  end
+
+  def test_rsc
+    assert_sanitized 'Royal Shakespeare Company: Richard II', 'Richard II - RSC Live 2013'
+  end
+
+  def test_removes_ukjff_prefix
+    assert_sanitized 'From Cable Street To Brick Lane',
+                     'UKJFF - From Cable Street To Brick Lane'
+  end
+
+  def test_removes_singalong
+    assert_sanitized 'Frozen', 'Frozen Sing-a-long'
+  end
+
+  def test_html_ampersands
+    assert_sanitized 'Fast & Furious 7', 'Fast &amp; Furious 7'
+  end
+
+  def test_removes_language_suffix
+    assert_sanitized 'Jailer 2', 'Jailer 2 (Telugu)'
+  end
+
+  def test_removes_encore_suffix
+    assert_sanitized 'Avengers Endgame', 'Avengers Endgame: Encore'
+  end
+
+  def test_keeps_sing_along_within_title
+    assert_sanitized 'Bebefinn Sing-Along Movie', 'Bebefinn Sing-Along Movie'
+  end
+
+  def test_removes_dubbed
+    assert_sanitized 'Arrietty', 'Arrietty (Dubbed)'
+  end
+
+  def test_removes_subbed
+    assert_sanitized 'Arrietty', 'Arrietty (Subbed)'
+  end
+
+  def test_removes_english_dub
+    assert_sanitized 'Kung Fu Soccer', 'Kung Fu Soccer (English Dub)'
+  end
+
+  def test_removes_subtitle_description
+    assert_sanitized 'Kung Fu Soccer', 'Kung Fu Soccer (Mandarin with EN/CH subtitles)'
+  end
+
+  def test_removes_q_and_a
+    assert_sanitized 'NAZA', 'NAZA + Q&A'
+  end
+
+  def test_removes_in_person_q_and_a
+    assert_sanitized "Charlie Shaw's Revenge", "Charlie Shaw's Revenge + In-Person Q&A"
+  end
+
+  def test_removes_festival_prefix
+    assert_sanitized 'Scum Of The Earth', 'Cine-Excess 2026: Scum Of The Earth'
+  end
+
+  def test_removes_anniversary
+    assert_sanitized 'SCREAM', 'SCREAM (30th Anniversary)'
+  end
+
+  def test_world_tour_is_not_capitalised
+    assert_sanitized "ENHYPEN World Tour 'BLOOD SAGA'", "ENHYPEN WORLD TOUR 'BLOOD SAGA'"
+  end
+
+  def test_keeps_titles_with_their_own_subtitles
+    [
+      'Harry Potter and the Deathly Hallows: Part 1',
+      'Spider-Man: Brand New Day',
+      'Hadestown: The Musical',
+      'Rammstein - Live in Mexico City',
+      'Ozzy & Black Sabbath: Back to the Beginning',
+      "BTS 'ARIRANG' IN BUENOS AIRES: LIVE VIEWING"
+    ].each { |title| assert_sanitized title, title }
+  end
+
+  private
+
+  def assert_sanitized(expected, title)
+    assert_equal expected, OdeonUk::Internal::TitleSanitizer.new(title).sanitized
+  end
+end