odeon_uk 4.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1b827e99f44e531f573ee56fc4139cfa7224a6f6
-  data.tar.gz: 97351d6e122f0b61602d344ca85ba8a4998b5bfe
+SHA256:
+  metadata.gz: 5e46bf230ffd62f78eb2e8f59afa812a90e70ee54fda448688d0b7bc5f6ce662
+  data.tar.gz: 4bbd4f71437a569e87020ad2c0e949e4f09d5a0f2f02190b8d321a92edeb802b
 SHA512:
-  metadata.gz: bc897b79cea4d4a75bbba73d122243f0dd162c7f0449c5aee13dc0c834a6c57cf092ceaf9479bd672ffbac3ec1708d2a4288542e45d7f766dedd9882bc8e5854
-  data.tar.gz: 55fb07a9599281fd335da71a188827b8c1b98335fefd8fc0184722a3c2a35d6bd8c5db434439d372b3c1dc1327254e21ef516b4603807d373076c0862a530110
+  metadata.gz: 3d4341282698458b67ab5525a22cb332d96213f087a78e3e2f1637175a50d9c5b09f36e4d9f80b74d21f8fdb652ecc6613779085a3ccf0f869c65b803d65564a
+  data.tar.gz: 5815d8608c962b9815a50b80439c95040e9dff8aeee16eeb45c8e6dd9137c12c3f790b344163eb8d5674e9a0414f0dc519675e38a1080ec9e4df4be78bf78036

data/.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: Release Gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  package:
+    strategy:
+      matrix:
+        include:
+          - runner: ubuntu-latest
+            platform: x86_64-linux-gnu
+          - runner: ubuntu-24.04-arm
+            platform: aarch64-linux-gnu
+          - runner: macos-15
+            platform: arm64-darwin
+          - runner: macos-15-intel
+            platform: x86_64-darwin
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - run: bundle exec rake 'package:native[${{ matrix.platform }}]'
+      - run: ODEON_PACKAGE="$(echo pkg/*.gem)" bundle exec ruby test/package_test.rb
+      - uses: actions/upload-artifact@v4
+        with:
+          name: gem-${{ matrix.platform }}
+          path: pkg/*.gem
+
+  release:
+    needs: package
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - run: bundle exec rake test
+      - run: bundle exec rake build
+      - uses: actions/download-artifact@v4
+        with:
+          path: pkg
+          pattern: gem-*
+          merge-multiple: true
+      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - name: Push the source and platform gems
+        run: |
+          for gem in pkg/*.gem; do
+            if output=$(gem push "$gem" 2>&1); then
+              echo "$output"
+            elif echo "$output" | grep -q "Repushing of gem versions is not allowed"; then
+              echo "Already published: $gem"
+            else
+              echo "$output"
+              exit 1
+            fi
+          done
+      - name: Tag the release
+        run: |
+          tag="v$(ruby -e 'print Gem::Specification.load(Dir["*.gemspec"].first).version')"
+          if git ls-remote --exit-code --tags origin "$tag" >/dev/null; then
+            echo "$tag already exists"
+          else
+            git tag "$tag"
+            git push origin "$tag"
+          fi

data/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake test
+
+  package:
+    strategy:
+      matrix:
+        include:
+          - runner: ubuntu-latest
+            platform: x86_64-linux-gnu
+          - runner: ubuntu-24.04-arm
+            platform: aarch64-linux-gnu
+          - runner: macos-15
+            platform: arm64-darwin
+          - runner: macos-15-intel
+            platform: x86_64-darwin
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - run: bundle exec rake 'package:native[${{ matrix.platform }}]'
+      - run: ODEON_PACKAGE="$(echo pkg/*.gem)" bundle exec ruby test/package_test.rb
+      - uses: actions/upload-artifact@v4
+        with:
+          name: gem-${{ matrix.platform }}
+          path: pkg/*.gem

data/.gitignore

@@ -15,4 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.DS_Store
+.DS_Storevendor/curl-impersonate

data/.ruby-version

@@ -0,0 +1 @@
+4.0.7

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 5.1.0 - 2026-10-22
+
+### Added
+- `Performance#film_year`, read from a trailing `(1996)` in the title.
+
+### Changed
+- Require cinebase 5.4. Film titles lose their year suffix, `(Re-release)` and Lithuanian markers, `+ ... Q&A` and `+ Discussion` add-ons, `(35mm)`, `(70mm)` and `4K` markers; `Horror Season` and `CFF:` prefixes become festivals.
+
+## 5.0.0 - 2026-10-22
+
+### Changed
+- Retrieve cinemas and performances from the Vista API behind odeon.co.uk instead of the retired iOS plist API.
+- Cinema ids are Vista site ids, zero-padded strings such as `'017'` and `'824'` (Brighton was `71`).
+- `Cinema.all` returns UK cinemas only.
+- `Cinema#adr` includes the second address line. Postcodes are no longer available.
+- `Cinema#url` points at the current cinema pages.
+- `Performance.at` accepts inclusive `from:` and `to:` business dates, defaulting to today in London and the following 13 days. One request per day.
+- Performance times come from Vista's explicit UTC offsets.
+- Title sanitizer handles Met Opera and RBO season prefixes, language and encore suffixes.
+- Require Ruby 3.4 or newer and cinebase 5.2, which now holds the shared Vista client, guest token retrieval, packaging task and common title rules.
+- Film titles drop dub, subtitle, language, anniversary and Q&A markers, and festival prefixes.
+- Convert tests from minitest spec syntax to plain `Minitest::Test` classes.
+
+### Added
+- `OdeonUk.token` for a caller-supplied guest JWT, and `OdeonUk.acquire_token!` to fetch one with `curl-impersonate`.
+- Platform gems that bundle curl-impersonate 2.2.3.
+- `OdeonUk::AuthenticationError` for missing, expired and rejected tokens.
+- `Performance#booking_url`, `Performance#language`, `Performance#subtitled?` and `Performance#festival` (a `Cinebase::Festival` with `name` and `year`).
+- `audio_described`, `autism_friendly` and `subtitled` variants.
+- Live integration tests and GitHub Actions CI on Ruby 3.4 and 4.0.
+- Live API shape tests that check real responses without storing them.
+
+### Removed
+- CFPropertyList dependency, Travis CI and Code Climate.
+- Recorded API fixtures and the `fixtures` rake task. Fixtures are hand-written.
+
 ## 4.0.1 - 2016-02-11
 
 ### Fixed

data/README.md

@@ -1,11 +1,8 @@
 # OdeonUk
 
-A simple gem to parse the [Odeon UK website](http://odeon.co.uk) and spit out useful formatted info.
+A simple gem to pull cinemas and performances from the Vista API behind the [ODEON UK website](https://www.odeon.co.uk) and spit out useful formatted info.
 
 [![Gem Version](https://badge.fury.io/rb/odeon_uk.svg)](https://badge.fury.io/rb/odeon_uk)
-[![Code Climate](https://codeclimate.com/github/andycroll/odeon_uk/badges/gpa.svg)](https://codeclimate.com/github/andycroll/odeon_uk)
-[![Test Coverage](https://codeclimate.com/github/andycroll/odeon_uk/badges/coverage.svg)](https://codeclimate.com/github/andycroll/odeon_uk/coverage)
-[![Build Status](https://travis-ci.org/andycroll/odeon_uk.svg?branch=master)](https://travis-ci.org/andycroll/odeon_uk)
 [![Inline docs](http://inch-ci.org/github/andycroll/odeon_uk.svg?branch=master)](http://inch-ci.org/github/andycroll/odeon_uk)
 
 ## Installation
@@ -26,25 +23,65 @@ Or install it yourself as:
 
 The gem conforms to the API set down in the `cinebase` gem, [andycroll/cinebase](https://github.com/andycroll/cinebase), which provides a lot of useful base vocabulary and repetitive code for this series of cinema focussed gems.
 
-Performance titles are sanitized as much as possible, removing 'screening type' information and 'dimension' as well as standardising all the theatre/cultural event naming (NT Live, Royal Opera House etc).
+Performance titles are sanitized as much as possible, removing 'screening type' information and 'dimension' as well as standardising all the theatre/cultural event naming (NT Live, Royal Ballet and Opera etc).
+
+### Guest token
+
+Every API call needs the public guest token the ODEON website gives each
+visitor. Fetch one before anything else:
+
+``` ruby
+OdeonUk.acquire_token!
+OdeonUk::Cinema.all
+```
+
+This shells out to **`curl-impersonate`**, not ordinary system `curl`, using its
+Chrome 150 TLS/HTTP profile, and reads `window.initialData.api.authToken` from
+`https://www.odeon.co.uk/my-account/`. That page skips the queue-it waiting room
+every other page redirects to. No browser or JavaScript execution is needed.
+
+Platform-specific gem packages include the pinned `curl-impersonate` 2.2.3
+executable for glibc Linux (x86-64, ARM64) and macOS (Intel, Apple Silicon).
+On other platforms, or when installing from Git, install a
+[curl-impersonate release](https://github.com/lexiforest/curl-impersonate/releases/tag/v2.2.3)
+yourself and put it on your `PATH` or pass its path:
+
+``` ruby
+OdeonUk.acquire_token!(curl: '/opt/curl-impersonate/curl-impersonate')
+```
+
+Or supply your own current guest JWT, without the `Bearer ` prefix:
+
+``` ruby
+OdeonUk.token = ENV.fetch('ODEON_TOKEN')
+```
+
+Tokens currently last 12 hours. The gem checks the declared expiry but does not
+verify the signature. Missing, expired or rejected tokens raise
+`OdeonUk::AuthenticationError`; call `OdeonUk.acquire_token!` again. Normal API
+calls never acquire or renew a token automatically.
 
 ### Cinema
 
+Only UK cinemas are returned; ODEON's Irish cinemas are left out. Cinema ids
+changed with the move to the Vista API (Brighton was 71 and is now 824). The API
+does not supply postcodes, so `postal_code` is empty.
+
 ``` ruby
 OdeonUk::Cinema.all
 #=> [<OdeonUk::Cinema ...>, <OdeonUk::Cinema ...>, ...]
 
-cinema = OdeonUk::Cinema.new(71)
+cinema = OdeonUk::Cinema.new(824)
 #=> <OdeonUk::Cinema ...>
 
 cinema.adr
 #=> {
   street_address:   'Kingswest',
-  extended_address: nil,
+  extended_address: 'West Street',
   locality:         'Brighton',
   region:           nil,
-  postal_code:      'BN1 2RE',
-  country:          'United Kingdom'
+  postal_code:      nil,
+  country_name:     'United Kingdom'
 }
 
 cinema.brand
@@ -54,46 +91,88 @@ cinema.full_name
 #=> 'Odeon Brighton'
 
 cinema.id
-#=> 71
+#=> '824'
 
-cinema.postal_code
-#=> 'BN1 2RE'
+cinema.url
+#=> 'https://www.odeon.co.uk/cinemas/brighton/'
 ```
 
 ### Performances
 
+`Performance.at` returns performances for an inclusive range of business dates,
+defaulting to today in London and the following 13 days. It makes one request per
+day.
+
 ``` ruby
-OdeonUk::Performance.at(17)
+OdeonUk::Performance.at(824)
+#=> [<OdeonUk::Performance ...>, <OdeonUk::Performance ...>, ...]
+
+OdeonUk::Performance.at(824, from: Date.today, to: Date.today + 2)
 #=> [<OdeonUk::Performance ...>, <OdeonUk::Performance ...>, ...]
 
-performance = OdeonUk::Performance.at(17).first
+performance = OdeonUk::Performance.at(824).first
 #=> <OdeonUk::Performance ...>
 
 performance.film_name
-#=> 'Star Wars: The Force Awakens'
+#=> 'Street Fighter'
 
 performance.dimension
 #=> '2d'
 
 performance.variant
-#=> ['imax', 'kids']
+#=> ['audio_described', 'imax']
+
+performance.film_year
+#=> 1996 # from the title, nil when it has no year
+
+performance.language
+#=> 'Korean' # audio language, nil when the cinema does not tag one
+
+performance.subtitled?
+#=> true # English subtitles or open captions
+
+performance.festival
+#=> #<data Cinebase::Festival name="Cine-Excess", year=2026> # nil outside festivals
 
 performance.starting_at
-#=> 2016-02-04 13:00:00 UTC
+#=> 2026-10-24 08:00:00 UTC
 
 performance.showing_on
-#=> #<Date: 2016-02-04 ((2457423j,0s,0n),+0s,2299161j)>
+#=> #<Date: 2026-10-24 ((2461338j,0s,0n),+0s,2299161j)>
 
-performance.booking_url # for now
-#=> nil
+performance.booking_url
+#=> 'https://www.odeon.co.uk/ticketing/seat-picker/?showtimeId=824-69206'
 
 performance.cinema_name
 #=> 'Brighton'
 
 performance.cinema_id
-#=> 71
+#=> '824'
 ```
 
+Variants are `arts`, `audio_described`, `autism_friendly`, `baby`, `imax`,
+`kids`, `senior` and `subtitled`.
+
+## Tests
+
+``` sh
+bundle exec rake          # unit tests against fixtures
+bundle exec rake live     # live API, needs curl-impersonate or ODEON_TOKEN
+```
+
+Fixtures in `test/fixtures/api` are hand-written: invented films and
+addresses in the shape of Vista responses, never recorded API output.
+`test/support/api_shapes.rb` describes the fields the gem reads. The unit suite
+checks the fixtures against it and the live suite checks real responses, held
+only in memory. When the API changes, update the shape first, then the fixtures.
+
+## Releasing
+
+To release, bump the version, merge, then run the **Release Gem** workflow in
+GitHub Actions. It builds the source and four platform gems, publishes them
+through RubyGems trusted publishing (no MFA code needed) and tags the release.
+Versions already on RubyGems are skipped, so a failed run can be rerun.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -2,13 +2,25 @@
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
+require 'cinebase/vista/package_task'
+
+Cinebase::Vista::PackageTask.new('odeon_uk.gemspec', root: __dir__)
 
 Rake::TestTask.new do |t|
   t.libs << 'lib/odeon_uk'
   t.test_files = FileList[
     'test/lib/odeon_uk/*_test.rb',
-    'test/lib/odeon_uk/api/*_test.rb',
-    'test/lib/odeon_uk/internal/*_test.rb'
+    'test/lib/odeon_uk/internal/*_test.rb',
+    'test/lib/odeon_uk/internal/parser/api/*_test.rb'
+  ]
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/odeon_uk'
+  t.name = :live
+  t.test_files = FileList[
+    'test/live/*_test.rb'
   ]
   t.verbose = true
 end
@@ -23,17 +35,4 @@ task :console do
   IRB.start
 end
 
-desc 'recreate test fixtures'
-task :fixtures do
-  require 'odeon_uk'
-  require_relative 'rake/fixture_creator'
-  require 'fileutils'
-
-  FixtureCreator::Api.new.app_init!
-  FixtureCreator::Api.new.all_cinemas!
-  puts 'Clean folder'
-  FileUtils.rm FileList['test/fixtures/api/film_times/*.plist']
-  FixtureCreator::Api.new.film_times!(71)
-end
-
 task default: :test

data/lib/odeon_uk/cinema.rb

@@ -2,22 +2,28 @@ module OdeonUk
   # The object representing a cinema on the Odeon UK website
   class Cinema < Cinebase::Cinema
     # @!attribute [r] id
-    #   @return [Integer] the numeric id of the cinema on the Cineworld website
+    #   @return [String] the zero-padded id of the cinema, e.g. '017'
+
+    # Vista site ids whose page slug differs from the cinema name
+    URL_SLUGS = {
+      '915' => 'dudley-merry-hill',
+      '955' => 'manchester-trafford-centre'
+    }.freeze
 
     # Constructor
-    # @param [Integer, String] id the cinema id of the format 71/'71' as used on
+    # @param [Integer, String] id the cinema id of the format 17/'017'
     # @return [OdeonUk::Cinema]
     def initialize(id)
-      @id = id.to_s
+      @id = id.to_s.rjust(3, '0')
     end
 
-    # Return basic cinema information for all cinemas
+    # Return basic cinema information for all UK cinemas
     # @return [Array<OdeonUk::Cinema>]
     # @example
     #   OdeonUk::Cinema.all
     #   #=> [<OdeonUk::Cinema>, <OdeonUk::Cinema>, ...]
     def self.all
-      cinemas_hash.keys.map { |cinema_id| new(cinema_id) }
+      sites_hash.keys.map { |cinema_id| new(cinema_id) }
     end
 
     # @!method address
@@ -29,23 +35,26 @@ module OdeonUk
     # @return [Hash] contains :street_address, :extended_address,
     # :locality, :postal_code, :country
     # @example
-    #   cinema = OdeonUk::Cinema.new(3)
+    #   cinema = OdeonUk::Cinema.new(824)
     #   cinema.adr
     #   #=> {
-    #         street_address: '44-47 Gardner Street',
-    #         extended_address: 'North Laine',
+    #         street_address: 'Kingswest',
+    #         extended_address: 'West Street',
     #         locality: 'Brighton',
-    #         postal_code: 'BN1 1UN',
+    #         region: nil,
+    #         postal_code: nil,
     #         country_name: 'United Kingdom'
     #       }
     # @note Uses the standard method naming as at http://microformats.org/wiki/adr
+    # @note The API does not supply postcodes
     def adr
+      address = site_hash.dig('contactDetails', 'address') || {}
       {
-        street_address:   cinema_hash['siteAddress1'],
-        extended_address: nil,
-        locality:         cinema_hash['siteAddress2'],
+        street_address:   address['line1'],
+        extended_address: address['line2'],
+        locality:         address['city'],
         region:           nil,
-        postal_code:      cinema_hash['sitePostcode'],
+        postal_code:      nil,
         country_name:     'United Kingdom'.freeze
       }
     end
@@ -103,7 +112,7 @@ module OdeonUk
     #   cinema.name
     #   #=> 'Brighton'
     def name
-      @name ||= cinema_hash['siteName'].gsub(/\ALondon /, '').gsub(' - ', ': ')
+      @name ||= site_name.gsub(/\ALondon /, '').gsub(' - ', ': ')
     end
 
     # @!method postal_code
@@ -142,22 +151,31 @@ module OdeonUk
     # The url of the cinema on the Cineworld website
     # @return [String]
     def url
-      "http://www.odeon.co.uk/cinemas/#{urlized_name}/#{id}/"
+      "https://www.odeon.co.uk/cinemas/#{url_slug}/"
+    end
+
+    # @api private
+    def self.sites_hash
+      @sites_hash ||= OdeonUk::Internal::ApiResponse.new.sites.to_h do |site|
+        [site.fetch('id'), site]
+      end
     end
+    private_class_method :sites_hash
 
     private
 
-    def self.cinemas_hash
-      @cinemas_hash ||=
-        OdeonUk::Internal::ApiResponse.new.all_cinemas.fetch('sites', {})
+    def site_hash
+      @site_hash ||= self.class.send(:sites_hash).fetch(id, {})
     end
 
-    def cinema_hash
-      @cinema_hash ||= self.class.cinemas_hash.fetch(id, {})
+    def site_name
+      site_hash.dig('name', 'text').to_s
     end
 
-    def urlized_name
-      name.downcase.gsub(/[^a-z0-9]/, '_')
+    def url_slug
+      URL_SLUGS.fetch(id) do
+        site_name.downcase.gsub(/[^a-z0-9]+/, '-').gsub(/\A-|-\z/, '')
+      end
     end
   end
 end

data/lib/odeon_uk/internal/api_response.rb

@@ -1,55 +1,35 @@
-require 'cfpropertylist'
-require 'net/http'
+# frozen_string_literal: true
+
+require "date"
 
 module OdeonUk
   # Internal utility classes: Do not use
   # @api private
   module Internal
-    # Utility class to make calls to the odeon website
+    # Fetches cinema and showtime data from the Vista API behind odeon.co.uk
     class ApiResponse
-      # iOS app API version
-      VERSION = '2.1'.freeze
-
-      # cinemas information
-      # @return [Hash] decoded response of api containing cinema details
-      def all_cinemas
-        parse(all_cinemas_raw)
-      end
+      BASE_URL = "https://vwc.odeon.co.uk/WSVistaWebClient/ocapi/v1/"
+      # Limits sites to the UK, leaving out ODEON's Irish cinemas.
+      REGION_CODE = "UK"
 
-      # application initialize
-      # @return [Hash] decoded response of api, mostly films
-      def app_init
-        parse(app_init_raw)
+      # @return [Array<Hash>] UK cinemas
+      def sites
+        client.get("sites").fetch("sites")
       end
 
-      # showings for a film at a cinema
-      # @return [Hash] decoded response of api, day split times
-      def film_times(cinema_id, film_id)
-        parse(film_times_raw(cinema_id, film_id))
+      # @param [String] cinema_id zero-padded site id, e.g. '017'
+      # @param [Date] date business date
+      # @return [Hash] showtimes plus their related films and attributes
+      def showtimes(cinema_id, date)
+        client.get("showtimes/by-business-date/#{date.iso8601}",
+                   "siteIds" => cinema_id)
       end
 
       private
 
-      def all_cinemas_raw
-        post('all-cinemas').body
-      end
-
-      def app_init_raw
-        post('app-init').body
-      end
-
-      def film_times_raw(cinema_id, film_id)
-        post('film-times', { s: cinema_id, m: film_id }).body
-      end
-
-      def post(path, request_body={})
-        uri = URI("https://api.odeon.co.uk/#{VERSION}/api/#{path}")
-        Net::HTTP.post_form(uri, request_body)
-      end
-
-      def parse(content)
-        plist = CFPropertyList::List.new(data: content)
-        CFPropertyList.native_types(plist.value).fetch('data', {})
+      def client
+        Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: REGION_CODE,
+                                    token: OdeonUk.token)
       end
     end
   end

data/lib/odeon_uk/internal/guest_token.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "json"
+
+module OdeonUk
+  module Internal
+    # Reads the public guest token from the ODEON website's page data
+    class GuestToken < Cinebase::Vista::GuestToken
+      # Every other page redirects to the queue-it waiting room first.
+      PAGE_URL = "https://www.odeon.co.uk/my-account/"
+
+      private
+
+      def bundled_curl
+        File.expand_path("../../../vendor/curl-impersonate/bin/curl-impersonate", __dir__)
+      end
+
+      def extract_token(html)
+        JSON.parse(html[/window\.initialData\s*=\s*(.+?);\s*$/, 1].to_s).dig("api", "authToken")
+      end
+    end
+  end
+end