cineworld_uk 4.1.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edfbb0e8f7d6238e878f4018a643befca62b662fffc47cad72367c2e404e9ee7
-  data.tar.gz: a0d59a9aa4d3227794fda2f78c00de9e59c62321b3cba3a50dbbd8611856cc82
+  metadata.gz: b966798e50231ceceb95b749b8c3e9e962db5cc12edc7fb31e98ee40e110078d
+  data.tar.gz: f26069f75b3de854af94f90758b0d479faa8ef7f2923dfb3c6ed66d16a681432
 SHA512:
-  metadata.gz: aefe630b3ad344c2fbced398fc49c5fb9686387331f2cdea072f6dc96ef0893db42af90a6d277117cc7cd1b6ab4505b2fff3e64e859f79896503a71462934a89
-  data.tar.gz: cd3ad38fb9b9404504e5379ae03943424d56370b6ce2b0bcda069c9f64fa33a2802ce54dcb567740689408e882bda8e86cba3127193fb510f46fc73b2610c030
+  metadata.gz: 2d38f7b625fe0625160948172925120d2763ba1f9235acc683f58bf5c4b1fdeca4a6176734884e400dadfa34ed53c5d1a745af7b11ecbf52468884c1bc92d378
+  data.tar.gz: 71d23a661ac05b7eb340877e6c371ceae53cc4b757048a75d3ebfa4d713258ca7faae8cb74d7c360ecdf5da8655351c7c1167b920c10125a1dc43d6f434b2405

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.3.0 - 2026-10-22
+
+### Added
+- `Performance#film_year`, read from a trailing `(1996)` in the title, so a re-release gives the original year.
+- `4dx` and `screenx` variants from Vista's `4DX`, `4DX 3D` and `ScreenX` attributes.
+
+### Changed
+- Require cinebase 5.4. Titles also lose `+ ... Q&A` and `+ Discussion` add-ons, `(35mm)`, `(70mm)` and `4K` markers, and `CFF:` festival prefixes.
+- Film titles lose their year suffix and the `(4DX)`, `(ScreenX)`, `M4J:`, `£2 Family Films :`, `Horror Season 2026` and `(Re-release)` markers, and Lithuanian versions. For example `Horror Season 2026 From Dusk Till Dawn (1996)` is now `From Dusk Till Dawn` with `film_year` 1996 and the Horror Season 2026 festival. Consumers matching films by name will see these names change.
+
+## 4.2.0 - 2026-10-22
+
+### Added
+- `Performance#language` from Vista language attributes such as `Tamil`, `Performance#subtitled?`, and `Performance#festival`, a `Cinebase::Festival` with `name` and `year`.
+- Live API shape tests that check real responses without storing them.
+
+### Changed
+- Require cinebase 5.2. The Vista client, guest token retrieval and platform packaging task now come from `cinebase/vista`; behaviour, errors and pinned curl-impersonate digests are unchanged.
+- `CineworldUk::AuthenticationError` is now `Cinebase::Vista::AuthenticationError`, so existing `rescue` clauses keep working.
+- Film titles also use cinebase's common rules: dub and subtitle versions, more language versions, anniversaries, Q&A add-ons and festival prefixes are removed.
+- Tests use plain `Minitest::Test` classes, with hand-written fixtures in place of recorded API responses.
+
+### Fixed
+- `Sing-Along` inside a real title, such as `Bebefinn Sing-Along Movie`, is no longer removed.
+
+### Removed
+- The `fixtures` rake task, which saved API responses into the repository.
+
 ## 4.1.0 - 2026-10-15
 
 ### Added

data/README.md

@@ -177,6 +177,18 @@ performance.dimension
 performance.variant
 #=> ['audio_described']
 
+performance.film_year
+#=> 1996 # from the title, nil when it has no year
+
+performance.language
+#=> 'Tamil' # audio language, nil when the cinema does not tag one
+
+performance.subtitled?
+#=> true
+
+performance.festival
+#=> #<data Cinebase::Festival name="Cine-Excess", year=2026> # nil outside festivals
+
 performance.starting_at
 #=> 2026-10-14 14:40:00 UTC
 
@@ -193,6 +205,19 @@ performance.cinema_id
 #=> 14
 ```
 
+## Tests
+
+```sh
+bundle exec rake          # unit tests against fixtures
+bundle exec rake live     # live API, needs curl-impersonate or CINEWORLD_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.
+
 ## Building release packages
 
 ```sh
@@ -204,7 +229,7 @@ To build and check just one platform on a matching host:
 
 ```sh
 bundle exec rake 'package:native[x86_64-linux-gnu]'
-CINEWORLD_PACKAGE=pkg/cineworld_uk-4.1.0-x86_64-linux-gnu.gem bundle exec ruby test/package_test.rb
+CINEWORLD_PACKAGE=pkg/cineworld_uk-4.3.0-x86_64-linux-gnu.gem bundle exec ruby test/package_test.rb
 ```
 
 Native packaging downloads pinned upstream archives at **build time**, verifies

data/Rakefile

@@ -2,7 +2,9 @@
 require "bundler/gem_tasks"
 
 require 'rake/testtask'
-load File.expand_path('tasks/package.rake', __dir__)
+require 'cinebase/vista/package_task'
+
+Cinebase::Vista::PackageTask.new('cineworld_uk.gemspec', root: __dir__)
 
 Rake::TestTask.new do |t|
   t.libs << 'lib/cineworld_uk'
@@ -33,27 +35,4 @@ task :console do
   IRB.start
 end
 
-desc 'Recreate test fixtures'
-task :fixtures do
-  require 'cineworld_uk'
-  CineworldUk.token = ENV.fetch("CINEWORLD_TOKEN")
-
-  def js_fixture(name)
-    File.expand_path("../test/fixtures/#{name}.json", __FILE__)
-  end
-
-  api = CineworldUk::Internal::ApiResponse.new
-
-  File.open(js_fixture('api/cinema-list'), 'w') do |file|
-    puts '* API Cinema List'
-    file.write api.cinema_list
-  end
-
-  File.open(js_fixture('api/performances-tomorrow-14'), 'w') do |file|
-    puts '* API Performances in Brighton Tomorrow'
-    file.write api.performances(14, Date.today + 1)
-  end
-
-end
-
 task :default => :test

data/cineworld_uk.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   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'
@@ -24,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '< 1'
   spec.add_development_dependency 'webmock'
 
-  spec.add_runtime_dependency 'base64', '~> 0.3'
-  spec.add_runtime_dependency 'cinebase', '~> 5.0'
+  spec.add_runtime_dependency 'cinebase', '~> 5.4'
   spec.add_runtime_dependency 'nokogiri', '>= 1.11'
 end

data/lib/cineworld_uk/internal/api_response.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "net/http"
 require "json"
 require "date"
 require "time"
@@ -15,8 +14,10 @@ module CineworldUk
         "Subtitled" => "subbed", "Subtitles" => "subbed",
         "Autism Friendly" => "autism-friendly",
         "Movies for Juniors" => "junior",
-        "Unlimited Screening" => "unlimited-screening", "Q&A" => "qa"
+        "Unlimited Screening" => "unlimited-screening", "Q&A" => "qa",
+        "4DX" => "4dx", "4DX 3D" => "4dx", "ScreenX" => "screenx"
       }.freeze
+      LANGUAGES = Cinebase::TitleSanitizer::LANGUAGES
 
       def cinema_list
         cinemas = fetch("sites").fetch("sites").map do |site|
@@ -53,6 +54,9 @@ module CineworldUk
               ATTRIBUTES[attribute.dig("name", "text")]
           end
           attrs << "3d" if showtime["requires3dGlasses"]
+          language = showtime.fetch("attributeIds", []).filter_map do |id|
+            attributes.fetch(id).dig("shortName", "text")
+          end.find { |name| LANGUAGES.include?(name) }
           # Formats belong to a session, not to the film as a whole.
           id = showtime.fetch("id")
           normalized_films << {
@@ -62,7 +66,7 @@ module CineworldUk
           }
           starts_at = showtime.fetch("schedule").fetch("startsAt")
           {
-            "filmId" => id, "attributeIds" => attrs,
+            "filmId" => id, "attributeIds" => attrs, "language" => language,
             "eventDateTime" => Time.iso8601(starts_at).utc.iso8601,
             "bookingLink" =>
               "https://web.cineworld.co.uk/order/showtimes/#{id}/seats"
@@ -82,34 +86,8 @@ module CineworldUk
       private
 
       def fetch(path, query = {})
-        token = CineworldUk.token
-        if !token.is_a?(String) || token.strip.empty?
-          raise AuthenticationError,
-                "Set CineworldUk.token to a current guest JWT " \
-                "before fetching data"
-        end
-        uri = URI(BASE_URL + path)
-        uri.query = URI.encode_www_form(query) unless query.empty?
-        request = Net::HTTP::Get.new(uri)
-        request["Authorization"] = "Bearer #{token}"
-        request["Connect-Region-Code"] = "GB"
-        request["Accept"] = "application/json"
-        response = Net::HTTP.start(
-          uri.host, uri.port, use_ssl: true, open_timeout: 10, read_timeout: 30
-        ) do |http|
-          http.request(request)
-        end
-        case response
-        when Net::HTTPSuccess
-          JSON.parse(response.body)
-        when Net::HTTPUnauthorized
-          raise AuthenticationError,
-                "Vista rejected the guest token; " \
-                "supply a fresh token with CineworldUk.token="
-        else
-          # Omit response bodies and never redirect credentials to another host.
-          raise "Vista HTTP error #{response.code}"
-        end
+        Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: "GB",
+                                    token: CineworldUk.token).get(path, query)
       end
     end
   end

data/lib/cineworld_uk/internal/guest_token.rb

@@ -1,72 +1,29 @@
 # frozen_string_literal: true
 
-require "base64"
 require "json"
 require "nokogiri"
-require "open3"
 
 module CineworldUk
   module Internal
-    # Retrieves the public guest token without running a browser.
-    class GuestToken
-      def initialize(curl:)
-        @curl = curl || default_curl
-      end
-
-      def fetch
-        token = extract_token(request_page)
-        validate_expiry!(token)
-        token
-      rescue JSON::ParserError, ArgumentError, IndexError, TypeError, NoMethodError
-        raise AuthenticationError, "Guest token page data is missing or invalid", cause: nil
-      end
+    # Reads the public guest token from the ticketing site's page data
+    class GuestToken < Cinebase::Vista::GuestToken
+      PAGE_URL = "https://web.cineworld.co.uk/"
 
       private
 
-      def default_curl
-        bundled = File.expand_path("../../../vendor/curl-impersonate/bin/curl-impersonate", __dir__)
-        File.executable?(bundled) ? bundled : "curl-impersonate"
-      end
-
-      def curl_command
-        [@curl, "--disable", "--impersonate", "chrome150",
-         "--compressed", "--silent", "--show-error",
-         "--connect-timeout", "10", "--max-time", "30",
-         "--write-out", "\n%{http_code}", "https://web.cineworld.co.uk/"]
+      # The root page carries the token even when it displays a 404.
+      def accepted_statuses
+        %w[200 404]
       end
 
-      def request_page
-        output, _stderr, result = Open3.capture3(*curl_command)
-        unless result.success?
-          raise AuthenticationError,
-                "Guest token request failed (curl exit #{result.exitstatus})"
-        end
-
-        html, _, status = output.rpartition("\n")
-        unless %w[200 404].include?(status)
-          raise AuthenticationError, "Guest token page returned HTTP #{status}"
-        end
-        html
-      rescue Errno::ENOENT
-        raise AuthenticationError,
-              "Install curl-impersonate or pass its executable path with curl:"
+      def bundled_curl
+        File.expand_path("../../../vendor/curl-impersonate/bin/curl-impersonate", __dir__)
       end
 
       def extract_token(html)
         script = Nokogiri::HTML(html).at_css("script#__NEXT_DATA__")
         data = JSON.parse(script ? script.content : "")
-        token = data.dig("props", "pageProps", "environment", "gasToken")
-        unless token.is_a?(String) && !token.empty?
-          raise AuthenticationError, "Guest token is missing from the page"
-        end
-        token
-      end
-
-      def validate_expiry!(token)
-        claims = JSON.parse(Base64.urlsafe_decode64(token.split(".").fetch(1)))
-        if Integer(claims.fetch("exp")) <= Time.now.to_i
-          raise AuthenticationError, "Guest token supplied by the page has expired"
-        end
+        data.dig("props", "pageProps", "environment", "gasToken")
       end
     end
   end

data/lib/cineworld_uk/internal/parser/api/film.rb

@@ -21,6 +21,17 @@ module CineworldUk
             @data['attributeIds']&.include?('3d') ? '3d' : '2d'
           end
 
+          # @param [Integer] year edition when the title gives none
+          # @return [Cinebase::Festival, nil]
+          def festival(year)
+            Cinebase::Festival.from_title(@data['name'] || '', year: year)
+          end
+
+          # @return [Integer, nil] the year at the end of the title
+          def film_year
+            Cinebase::TitleSanitizer.film_year(@data['name'] || '')
+          end
+
           # Sanitized film name
           # @return [String]
           def name
@@ -34,11 +45,13 @@ module CineworldUk
           def variant
             attrs = @data['attributeIds'] || []
             [
+              attrs.include?('4dx') ? '4dx' : nil,
               attrs.include?('autism-friendly') ? 'autism_friendly' : nil,
               attrs.include?('imax') ? 'imax' : nil,
               attrs.include?('junior') ? 'kids' : nil,
               attrs.include?('unlimited-screening') ? 'members' : nil,
-              attrs.include?('qa') ? 'q&a' : nil
+              attrs.include?('qa') ? 'q&a' : nil,
+              attrs.include?('screenx') ? 'screenx' : nil
             ].compact
           end
         end

data/lib/cineworld_uk/internal/parser/api/performance.rb

@@ -21,6 +21,11 @@ module CineworldUk
             @data['filmId']
           end
 
+          # @return [String, nil] audio language, e.g. 'Tamil'
+          def language
+            @data['language']
+          end
+
           # @return [DateTime] in local time
           def starting_at
             Time.parse(@data['eventDateTime'])

data/lib/cineworld_uk/internal/title_sanitizer.rb

@@ -18,13 +18,6 @@ module CineworldUk
       # Strings and regex to be removed
       def remove
         [
-          /\s+[23]d/i,                          # dimension
-          /\(Hindi\)/i,                         # Indian Language
-          /\(Malayalam\)/i,                     # Indian Language
-          /\(Punjabi\)/i,                       # Indian Language
-          /\(Tamil\)/i,                         # Indian Language
-          /\(Cantonese\)/i,                     # Chinese
-          /\(Turkish\)/i,                       # Foreign Language
           %r(-? \d{1,2}/\d{1,2}/\d{2,4}),       # date
           /\n/,                                 # newlines
           /\- Encore/,                          # encore
@@ -35,12 +28,14 @@ module CineworldUk
           /\ATake 2 -/,                         # take 2
           / - (Subtitled) Movies for Juniors/i, # movies for juniors
           '(IMAX)',                             # IMAX
+          /\A\((4DX|ScreenX)\)\s*/,             # format, kept as a variant
+          /\AM4J: /,                            # movies for juniors
+          /\A£2 Family Films : /,               # family pricing
           'SciScreen: ',                        # SciScreen
           /\s(-\s)*(With)*\sLive Q And A/i,     # Live Q&A
           /(\s+\-\s+)?MOVIES FOR JUNIORS/i,     # movies for juniors
-          /\bsing\-?a\-?long\b/i,               # singalong
           %r{\s20\d{2}[\/-]20\d{2} Season\b}
-        ]
+        ] + COMMON_REMOVE
       end
 
       # Regexes and their replacements
@@ -61,7 +56,7 @@ module CineworldUk
           /ROH The Royal Ballet\s*[:-] (.*)/ => 'The Royal Ballet: ',
           /Royal Ballet Live\s*[:-] (.*)/    => 'The Royal Ballet: ',
           /San Francisco Ballets (.*)/       => 'San Francisco Ballet: '
-        }
+        }.merge(COMMON_REPLACE)
       end
     end
   end

data/lib/cineworld_uk/performance.rb

@@ -71,14 +71,18 @@ module CineworldUk
       events.map do |event_data|
         performance = Internal::Parser::Api::Performance.new(event_data)
         film = films_hash[performance.film_id]
+        starting_at = utc(performance.starting_at)
 
         {
           cinema_name: response["body"]["cinemaName"] ||
             CineworldUk::Cinema.new(cinema_id).name,
           booking_url: performance.booking_url,
           dimension: film.dimension,
+          festival: film.festival(starting_at.year),
           film_name: film.name,
-          starting_at: utc(performance.starting_at),
+          film_year: film.film_year,
+          language: performance.language,
+          starting_at: starting_at,
           variant: (performance.variant + film.variant).sort
         }
       end

data/lib/cineworld_uk/version.rb

@@ -1,6 +1,6 @@
 # Ruby interface for http://www.cineworld.co.uk
-# @version 4.1.0
+# @version 4.3.0
 module CineworldUk
   # Gem version
-  VERSION = "4.1.0".freeze
+  VERSION = "4.3.0".freeze
 end

data/lib/cineworld_uk.rb

@@ -1,6 +1,7 @@
 require 'json'
 
 require 'cinebase'
+require 'cinebase/vista'
 
 require_relative './cineworld_uk/version'
 
@@ -17,7 +18,7 @@ require_relative './cineworld_uk/performance'
 
 # cineworld_uk gem
 module CineworldUk
-  class AuthenticationError < StandardError; end
+  AuthenticationError = Cinebase::Vista::AuthenticationError
 
   # A raw guest JWT, without the "Bearer " prefix. Never persisted by the gem.
   class << self

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

@@ -0,0 +1,76 @@
+{
+  "businessDate": "2026-10-24",
+  "showtimes": [
+    {
+      "id": "014-1001",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T09:00:00+01:00" },
+      "attributeIds": ["A-2D", "A-AD"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "014-1002",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T14:30:00+01:00" },
+      "attributeIds": ["A-IMAX"],
+      "requires3dGlasses": true
+    },
+    {
+      "id": "014-1003",
+      "filmId": "FILM-2",
+      "schedule": { "startsAt": "2026-10-24T18:00:00+01:00" },
+      "attributeIds": ["A-TAMIL", "A-ST"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "014-1004",
+      "filmId": "FILM-3",
+      "schedule": { "startsAt": "2026-10-24T10:00:00+01:00" },
+      "attributeIds": ["A-M4J"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "014-1005",
+      "filmId": "FILM-4",
+      "schedule": { "startsAt": "2026-10-24T20:15:00+01:00" },
+      "attributeIds": ["A-AC"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "014-1007",
+      "filmId": "FILM-5",
+      "schedule": { "startsAt": "2026-10-24T21:00:00+01:00" },
+      "attributeIds": ["A-4DX"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "014-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" } },
+      { "id": "FILM-2", "title": { "text": "Imaginary Picture (Tamil)" } },
+      { "id": "FILM-3", "title": { "text": "Pretend Pups - Movies For Juniors" } },
+      { "id": "FILM-4", "title": { "text": "Cine-Excess 2026: Scum Of The Earth" } },
+      { "id": "FILM-5", "title": { "text": "(4DX) Wildwood (2026)" } }
+    ],
+    "attributes": [
+      { "id": "A-2D", "shortName": { "text": "2D" }, "name": { "text": "2D Film" } },
+      { "id": "A-AD", "shortName": { "text": "AD" }, "name": { "text": "Audio Described" } },
+      { "id": "A-IMAX", "shortName": { "text": "IMAX" }, "name": { "text": "IMAX Film" } },
+      { "id": "A-TAMIL", "shortName": { "text": "Tamil" }, "name": { "text": "Tamil" } },
+      { "id": "A-ST", "shortName": { "text": "ST" }, "name": { "text": "Subtitled" } },
+      { "id": "A-M4J", "shortName": { "text": "M4J" }, "name": { "text": "Movies for Juniors" } },
+      { "id": "A-AC", "shortName": { "text": "AC" }, "name": { "text": "Event Cinema" } },
+      { "id": "A-4DX", "shortName": { "text": "4DX" }, "name": { "text": "4DX" } }
+    ],
+    "sites": [
+      { "id": "014", "name": { "text": "Brighton" } }
+    ]
+  }
+}

data/test/fixtures/api/sites.json

@@ -0,0 +1,52 @@
+{
+  "sites": [
+    {
+      "id": "014",
+      "name": { "text": "Brighton" },
+      "contactDetails": {
+        "addressV2": {
+          "line1": { "text": "1 Example Marina" },
+          "line2": { "text": "Brighton" },
+          "line3": { "text": "East Sussex" },
+          "line4": { "text": "BN2 0ZZ" }
+        }
+      }
+    },
+    {
+      "id": "088",
+      "name": { "text": "Glasgow Silverburn" },
+      "contactDetails": {
+        "addressV2": {
+          "line1": { "text": "2 Example Centre" },
+          "line2": { "text": "Glasgow" },
+          "line3": { "text": "Lanarkshire" },
+          "line4": { "text": "G53 0ZZ" }
+        }
+      }
+    },
+    {
+      "id": "103",
+      "name": { "text": "Leicester Square" },
+      "contactDetails": {
+        "addressV2": {
+          "line1": { "text": "3 Example Square" },
+          "line2": { "text": "London" },
+          "line3": null,
+          "line4": { "text": "WC2H 0ZZ" }
+        }
+      }
+    },
+    {
+      "id": "999",
+      "name": { "text": "Example - Riverside" },
+      "contactDetails": {
+        "addressV2": {
+          "line1": { "text": "4 Example Quay" },
+          "line2": { "text": "Exampleton" },
+          "line3": null,
+          "line4": { "text": "EX1 0ZZ" }
+        }
+      }
+    }
+  ]
+}