odeon_uk 4.0.1 → 5.1.0

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "time"
+
+module OdeonUk
+  # @api private
+  module Internal
+    module Parser
+      module Api
+        # Parses a single Vista showtime into performance attributes
+        class Showtime
+          BOOKING_URL = "https://www.odeon.co.uk/ticketing/seat-picker/?showtimeId="
+
+          # Vista attribute short names
+          VARIANTS = {
+            "AudioDes" => "audio_described",
+            "AutFriend" => "autism_friendly",
+            "EnglishSub" => "subtitled",
+            "EventCinem" => "arts",
+            "IMAX" => "imax",
+            "Newbies" => "baby",
+            "ODEON Kids" => "kids",
+            "OpenCapt" => "subtitled",
+            "SilverCine" => "senior"
+          }.freeze
+
+          # @param [Hash] data one showtime
+          # @param [Hash{String => Hash}] films related films keyed by id
+          # @param [Hash{String => Hash}] attributes related attributes keyed by id
+          def initialize(data, films:, attributes:)
+            @data = data
+            @films = films
+            @attributes = attributes
+          end
+
+          # @return [Hash] options for OdeonUk::Performance.new
+          def to_hash
+            {
+              booking_url: BOOKING_URL + @data.fetch("id"),
+              dimension: @data["requires3dGlasses"] ? "3d" : "2d",
+              festival: Cinebase::Festival.from_title(title, year: starting_at.year),
+              film_name: film_name,
+              film_year: Cinebase::TitleSanitizer.film_year(title),
+              language: language,
+              starting_at: starting_at,
+              variant: variant
+            }
+          end
+
+          private
+
+          def attribute_names(key)
+            @data.fetch("attributeIds", []).filter_map do |id|
+              @attributes.dig(id, key, "text")
+            end
+          end
+
+          def starting_at
+            Time.iso8601(@data.dig("schedule", "startsAt")).utc
+          end
+
+          def film_name
+            TitleSanitizer.new(title).sanitized
+          end
+
+          def title
+            @films.fetch(@data.fetch("filmId")).dig("title", "text")
+          end
+
+          def language
+            attribute_names("name").filter_map { |name| name[/\A(.+) \(Audio\)\z/, 1] }.first
+          end
+
+          def variant
+            attribute_names("shortName").filter_map { |name| VARIANTS[name] }.uniq
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odeon_uk/internal/title_sanitizer.rb

@@ -18,16 +18,11 @@ module OdeonUk
       # strings and regex to be removed
       def remove
         [
-          /\s+[23][dD]/,                 # dimension
           'Autism Friendly Screening -', # autism screening
-          /\ACinemagic \d{1,4} \-/,      # cinemagic
           /\(encore.+\)/i,               # encore for NT Live
           /\(live\)/i,                   # live in brackets
-          'UKJFF -',                     # UK Jewish festival prefix
-          /\bsing\-?a\-?long\b/i,        # singalong
-          'Autism Friendly - ',          # autism friendly
-          'amp;',                        # html ampersands
-        ]
+          'Autism Friendly - '           # autism friendly
+        ] + COMMON_REMOVE
       end
 
       # regexes and their replacements
@@ -40,7 +35,7 @@ module OdeonUk
           /NT Live - (.*)/               => 'National Theatre: ',
           /ROH - (.*)/                   => 'Royal Opera House: ',
           /(.*)\- RSC Live \d{1,4}/      => 'Royal Shakespeare Company: '
-        }
+        }.merge(COMMON_REPLACE)
       end
     end
   end

data/lib/odeon_uk/performance.rb

@@ -20,19 +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)
-      cinema_id = cinema_id.to_i
-      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
 
@@ -48,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.1
+# Ruby interface for https://www.odeon.co.uk
+# @version 5.1.0
 module OdeonUk
   # Gem version
-  VERSION = '4.0.1'.freeze
+  VERSION = '5.1.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.4'
 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 (2025) (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" }
+      }
+    }
+  ]
+}