cinebase 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8eeea7aa51f9e7044878fb0d225f9512f18aa2d261375da3bc411a380c7287c
-  data.tar.gz: 053420412dbdf2206b92f877712e2eb2e75831af50c65fcdf0a2a6a4ddfbf79b
+  metadata.gz: 6e2e7e8c5976a431db0d55f18a831e89e2dda1590dcac508f959e17d06cbdeb3
+  data.tar.gz: 20a8dd91bca32d0b31ccd45e1c6d7f2940c0caaa0e0ab184a44a64f3eecaaaea
 SHA512:
-  metadata.gz: d44ee69d99e2ebe12581a709b8b7b82d68eb6d8e948d891d28fc901b770f8690e2c646c15cb52dc794641e5ba68c519cf2ab75f0745ea9e9e6b9fd5aa73a8523
-  data.tar.gz: bbdedfd238c991cf8520d1fa7830ebf663e7ddf2a142a6effef71886b6f9dad886023e1f971d8ff8844d819c8b66366dde7c038d5be846ab5732a15a13712131
+  metadata.gz: 400b26c276c60dfc217148f80d85a216a641731f56cacdce68f2b940454b850fc1d142f2055371f1ad54108e228b85d324c0458247dd66e4404f750622c03ab8
+  data.tar.gz: 978a46e47f5a6e004b0f0d1b79dbdb01d8d6c99db800c499db596bb9cf64b336b189c54614241ae93112a7a902fd5e7fe21b757bbbafdef102b35426a871fbad

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.3', '3.4']
+        ruby-version: ['3.3', '3.4', '4.0']
 
     steps:
     - uses: actions/checkout@v4

data/.ruby-version

@@ -1 +1 @@
-ruby 3.4.7
+3.4.7

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [5.2.0] - 2026-10-22
+### Added
+- `Performance#festival`, `#language` and `#subtitled?`, with optional `festival:` and `language:` options
+- `Cinebase::Festival` value object (`name`, `year`) and `Festival.from_title`
+- `TitleSanitizer::COMMON_REMOVE` and `COMMON_REPLACE`: opt-in rules for dub and subtitle versions, language versions, anniversaries, Q&A add-ons, encores, sing-alongs, festival prefixes, opera and ballet seasons, and `WORLD TOUR` capitals
+- `cinebase/vista`, loaded only on request, for chains on Vista OCAPI: `Vista::Client`, a `Vista::GuestToken` template and `Vista::PackageTask` for platform gems bundling curl-impersonate
+- CI on Ruby 4.0
+
 ## [5.1.0] - 2025-10-31
 ### Changed
 - Converted all test files from minitest spec syntax to vanilla minitest syntax

data/README.md

@@ -1,9 +1,6 @@
 # Cinebase
 
 [![](https://img.shields.io/gem/v/cinebase.svg)](http://rubygems.org/gems/cinebase)
-[![](https://img.shields.io/travis/andycroll/cinebase.svg)](https://travis-ci.org/andycroll/cinebase)
-[![](https://img.shields.io/codeclimate/github/andycroll/cinebase.svg)](https://codeclimate.com/github/andycroll/cinebase)
-[![](https://img.shields.io/codeclimate/coverage/github/andycroll/cinebase.svg)](https://codeclimate.com/github/andycroll/cinebase/coverage)
 ![](https://img.shields.io/github/license/andycroll/cinebase.svg)
 
 A basic interface for a series of cinema gems.
@@ -44,9 +41,11 @@ module CinemaChainName
 end
 
 module CinemaChainName
-  class Screening < Cinebase::Screening
+  class Performance < Cinebase::Performance
     def self.at(cinema_id)
-      # parse webpages or apis to get screenings for a cinema
+      # parse webpages or apis to get performances for a cinema, built with
+      # booking_url:, cinema_id:, cinema_name:, dimension:, festival:,
+      # film_name:, language:, starting_at: and variant:
     end
   end
 end
@@ -56,18 +55,79 @@ module CinemaChainName
     class TitleSanitizer < Cinebase::TitleSanitizer
       private
 
+      # Chain patterns first, so markers like trailing sing-alongs are at the
+      # end of the title by the time the common rules run
       def remove
-        # []
+        [] + COMMON_REMOVE # chain-specific patterns, then the common ones
       end
 
       def replace
-        # { core title regex => replacement text }
+        {}.merge(COMMON_REPLACE) # { core title regex => replacement text }
       end
     end
   end
 end
 ```
 
+### Festivals
+
+A festival is an annual event, so `Cinebase::Festival` holds the name and the
+edition year. Pass it to a performance as `festival:`.
+
+```ruby
+Cinebase::Festival.from_title('Cine-Excess 2026: Scum Of The Earth', year: 2026)
+#=> #<data Cinebase::Festival name="Cine-Excess", year=2026>
+
+# No year in the title, so the screening's year is the edition
+Cinebase::Festival.from_title('UKJFF - From Cable Street To Brick Lane', year: 2026)
+#=> #<data Cinebase::Festival name="UKJFF", year=2026>
+```
+
+`COMMON_REMOVE` strips the same prefixes from titles.
+
+### Vista OCAPI chains
+
+Chains whose websites run on Vista share a client, guest token retrieval and
+packaging. These are not loaded by `require 'cinebase'`:
+
+```ruby
+require 'cinebase/vista'
+
+client = Cinebase::Vista::Client.new(
+  base_url: 'https://vwc.odeon.co.uk/WSVistaWebClient/ocapi/v1/',
+  region_code: 'UK',
+  token: guest_jwt
+)
+client.get('sites')
+
+module CinemaChainName
+  class GuestToken < Cinebase::Vista::GuestToken
+    PAGE_URL = 'https://www.example.co.uk/page-with-the-token/'.freeze
+
+    private
+
+    def bundled_curl
+      File.expand_path('../../vendor/curl-impersonate/bin/curl-impersonate', __dir__)
+    end
+
+    def extract_token(html)
+      # return the guest JWT from the page
+    end
+  end
+end
+```
+
+`GuestToken#fetch` runs `curl-impersonate` with a Chrome profile, checks the
+token's declared expiry and raises `Cinebase::Vista::AuthenticationError` when
+it cannot get a current token. To ship curl-impersonate inside platform gems,
+add this to the chain gem's Rakefile:
+
+```ruby
+require 'cinebase/vista/package_task'
+Cinebase::Vista::PackageTask.new('chain_name.gemspec')
+# rake 'package:native[arm64-darwin]' or rake package:all
+```
+
 ## Contributing
 
 1. [Fork it](https://github.com/andycroll/cinebase/fork)

data/cinebase.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'base64'
   spec.add_development_dependency 'bundler', '>= 2.0'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake', '>= 13.0'
   spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'webmock'
 
   spec.add_runtime_dependency 'tzinfo'
   spec.add_runtime_dependency 'tzinfo-data'

data/lib/cinebase/festival.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cinebase
+  Festival = Data.define(:name, :year)
+
+  # An annual festival edition a film is screened in
+  class Festival
+    # Title prefixes naming a festival: the name, then the year when given
+    PREFIXES = [
+      /\A(Cine-Excess) (20\d{2}): /,
+      /\A(Cinemagic) (\d{4}) -/,
+      /\A(UKJFF) -/
+    ].freeze
+
+    # @param [String] title raw film title
+    # @param [Integer] year the edition when the title gives none, usually the
+    #   screening's year
+    # @return [Cinebase::Festival, nil]
+    def self.from_title(title, year:)
+      PREFIXES.each do |prefix|
+        match = title.match(prefix)
+        return new(name: match[1], year: Integer(match[2] || year)) if match
+      end
+      nil
+    end
+  end
+end

data/lib/cinebase/performance.rb

@@ -7,14 +7,18 @@ module Cinebase
     attr_reader :dimension
     attr_reader :cinema_id
     attr_reader :cinema_name
+    attr_reader :festival
     attr_reader :film_name
+    attr_reader :language
 
     def initialize(options)
       @booking_url = options.fetch(:booking_url, nil)
       @cinema_name = options.fetch(:cinema_name)
       @cinema_id   = options.fetch(:cinema_id)
       @dimension   = options.fetch(:dimension, '2d')
+      @festival    = options.fetch(:festival, nil)
       @film_name   = options.fetch(:film_name)
+      @language    = options.fetch(:language, nil)
       @time        = options.fetch(:starting_at)
       @variant     = options.fetch(:variant, [])
     end
@@ -41,5 +45,10 @@ module Cinebase
       @variant = @variant.split(' ') if @variant.is_a?(String)
       @variant.map(&:downcase).sort.uniq
     end
+
+    # English subtitles or open captions
+    def subtitled?
+      variant.include?('subtitled')
+    end
   end
 end

data/lib/cinebase/title_sanitizer.rb

@@ -27,3 +27,30 @@ module Cinebase
     end
   end
 end
+
+module Cinebase
+  # Rules every chain can share; subclasses opt in after their own patterns,
+  # e.g. `[...] + COMMON_REMOVE` in #remove
+  class TitleSanitizer
+    LANGUAGES = %w(Arabic Cantonese French Hindi Kannada Korean Malayalam
+                   Mandarin Marathi Polish Punjabi Tamil Telugu Turkish).freeze
+
+    COMMON_REMOVE = [
+      *Festival::PREFIXES,                              # festival prefix
+      /\s+[23]d\b/i,                                    # dimension
+      /\((#{LANGUAGES.join('|')})\)/i,                  # language version
+      /\((Dubbed|Subbed|English Dub|[^)]*subtitles)\)/i, # dub or subtitle version
+      /\(\d+(st|nd|rd|th) Anniversary\)/i,              # anniversary re-release
+      /\s*\+\s*(In-Person )?Q&A\z/i,                    # Q&A add-on
+      /:\s*Encore\z/i,                                  # encore
+      /\bsing-?a-?long\z/i,                             # singalong
+      'amp;'                                            # html ampersands
+    ].freeze
+
+    COMMON_REPLACE = {
+      /Met Opera 20\d{2}-\d{2}: (.*)/              => 'Met Opera: ',
+      /RBO (?:Cinema Season )?20\d{2}-\d{2}: (.*)/ => 'Royal Ballet and Opera: ',
+      /WORLD TOUR(.*)/                             => 'World Tour'
+    }.freeze
+  end
+end

data/lib/cinebase/version.rb

@@ -2,5 +2,5 @@
 
 # Cinebase version
 module Cinebase
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/lib/cinebase/vista/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module Cinebase
+  module Vista
+    # Makes guest-token GET requests to a chain's OCAPI
+    class Client
+      # @param [String] base_url e.g. 'https://vwc.odeon.co.uk/WSVistaWebClient/ocapi/v1/'
+      # @param [String] region_code Connect-Region-Code header, e.g. 'UK' or 'GB'
+      # @param [String, nil] token raw guest JWT, without the "Bearer " prefix
+      def initialize(base_url:, region_code:, token:)
+        @base_url = base_url
+        @region_code = region_code
+        @token = token
+      end
+
+      # @param [String] path relative to the base URL
+      # @param [Hash] query parameters; Array values repeat the key
+      # @return [Hash] parsed JSON
+      # @raise [Cinebase::Vista::AuthenticationError] missing or rejected token
+      def get(path, query = {})
+        if !@token.is_a?(String) || @token.strip.empty?
+          raise AuthenticationError, 'Set a current guest token before fetching data'
+        end
+
+        response = request(path, query)
+        case response
+        when Net::HTTPSuccess
+          JSON.parse(response.body)
+        when Net::HTTPUnauthorized
+          raise AuthenticationError, 'Vista rejected the guest token; supply a fresh one'
+        else
+          # Omit response bodies and never redirect credentials to another host.
+          raise "Vista HTTP error #{response.code}"
+        end
+      end
+
+      private
+
+      def request(path, query)
+        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'] = @region_code
+        request['Accept'] = 'application/json'
+        Net::HTTP.start(uri.host, uri.port, use_ssl: true, open_timeout: 10, read_timeout: 30) do |http|
+          http.request(request)
+        end
+      end
+    end
+  end
+end

data/lib/cinebase/vista/guest_token.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+module Cinebase
+  module Vista
+    # Retrieves a chain website's public guest token with curl-impersonate,
+    # without running a browser. Subclasses set PAGE_URL and implement
+    # #extract_token(html) and #bundled_curl.
+    class GuestToken
+      # @param [String, nil] curl curl-impersonate executable; defaults to the
+      #   one bundled in the chain gem, then the one on PATH
+      def initialize(curl: nil)
+        @curl = curl || default_curl
+      end
+
+      # @return [String] the guest JWT
+      # @raise [Cinebase::Vista::AuthenticationError]
+      def fetch
+        token = extract_token(request_page)
+        unless token.is_a?(String) && !token.empty?
+          raise AuthenticationError, 'Guest token is missing from the page'
+        end
+        validate_expiry!(token)
+        token
+      rescue JSON::ParserError, ArgumentError, IndexError, TypeError, NoMethodError
+        raise AuthenticationError, 'Guest token page data is missing or invalid', cause: nil
+      end
+
+      private
+
+      # HTTP statuses whose page still carries the token
+      def accepted_statuses
+        %w[200]
+      end
+
+      def bundled_curl
+        nil
+      end
+
+      def default_curl
+        bundled_curl && File.executable?(bundled_curl) ? bundled_curl : '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}", self.class::PAGE_URL]
+      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 accepted_statuses.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:'
+      end
+
+      def validate_expiry!(token)
+        payload = token.split('.').fetch(1).tr('-_', '+/').unpack1('m')
+        claims = JSON.parse(payload)
+        if Integer(claims.fetch('exp')) <= Time.now.to_i
+          raise AuthenticationError, 'Guest token supplied by the page has expired'
+        end
+      end
+    end
+  end
+end

data/lib/cinebase/vista/package_task.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'fileutils'
+require 'rake'
+require 'rubygems/package'
+require 'tmpdir'
+require 'zlib'
+
+module Cinebase
+  module Vista
+    # Defines package:native[platform] and package:all, which build platform
+    # gems that bundle curl-impersonate for GuestToken. In a chain gem's
+    # Rakefile: `Cinebase::Vista::PackageTask.new('odeon_uk.gemspec')`
+    class PackageTask
+      include Rake::DSL
+
+      VERSION = '2.2.3'
+
+      # Platform => [upstream asset target, SHA-256 of the v2.2.3 release asset]
+      RELEASES = {
+        'x86_64-linux-gnu' => ['x86_64-linux-gnu', 'ca7c8aae49e33260d3a2400db16c7737aaf04692d606a843502056b42990f989'],
+        'aarch64-linux-gnu' => ['aarch64-linux-gnu', '5e71795b971f32be8f3d7785895f4dceb232f04414f5a067db266432a5b08657'],
+        'arm64-darwin' => ['arm64-macos', '2569f4139460fcb301484d37938de91b1c220efd15487ee22a9db554262062fe'],
+        'x86_64-darwin' => ['x86_64-macos', '4686806d59abea93866a917c3025a049ef3d7a3240de742ad66bd1a4d9890dc7']
+      }.freeze
+
+      # @param [String] gemspec path to the chain gem's gemspec
+      # @param [String] root the chain gem's root directory
+      def initialize(gemspec, root: Dir.pwd)
+        @gemspec = gemspec
+        @root = root
+        define
+      end
+
+      private
+
+      def define
+        namespace :package do
+          desc "Build a gem with bundled curl-impersonate #{VERSION} for the given platform"
+          task :native, [:platform] do |_task, args|
+            build(args.fetch(:platform))
+          end
+
+          desc 'Build all supported platform gems with bundled curl-impersonate'
+          task :all do
+            RELEASES.each_key { |platform| build(platform) }
+          end
+        end
+      end
+
+      def build(platform)
+        target, digest = RELEASES.fetch(platform)
+        asset = "curl-impersonate-v#{VERSION}.#{target}.tar.gz"
+        url = "https://github.com/lexiforest/curl-impersonate/releases/download/v#{VERSION}/#{asset}"
+        archive = File.join(@root, 'pkg', 'downloads', asset)
+        download(url, archive)
+        abort "SHA-256 mismatch for #{archive}; delete it and retry" unless Digest::SHA256.file(archive).hexdigest == digest
+
+        spec = Gem::Specification.load(File.join(@root, @gemspec)).dup
+        Dir.mktmpdir('vista-package') do |stage|
+          spec.files.each do |file|
+            destination = File.join(stage, file)
+            FileUtils.mkdir_p(File.dirname(destination))
+            FileUtils.cp(File.join(@root, file), destination)
+          end
+          vendor(archive, File.join(stage, 'vendor', 'curl-impersonate'), url, digest)
+
+          Dir.chdir(stage) do
+            spec.platform = Gem::Platform.new(platform)
+            spec.files += Dir.glob('vendor/**/*').select { |file| File.file?(file) }
+            Gem::Package.build(spec, false, false, File.join(@root, 'pkg', spec.file_name))
+          end
+        end
+      end
+
+      def download(url, archive)
+        FileUtils.mkdir_p(File.dirname(archive))
+        sh 'curl', '--fail', '--location', '--retry', '3', '--output', archive, url unless File.exist?(archive)
+      end
+
+      def vendor(archive, vendor, url, digest)
+        Zlib::GzipReader.open(archive) do |gzip|
+          Gem::Package::TarReader.new(gzip) do |tar|
+            tar.each do |entry|
+              next unless entry.file?
+
+              relative = vendor_path(entry.full_name)
+              next unless relative
+
+              destination = File.join(vendor, relative)
+              FileUtils.mkdir_p(File.dirname(destination))
+              File.binwrite(destination, entry.read)
+            end
+          end
+        end
+        File.chmod(0o755, File.join(vendor, 'bin', 'curl-impersonate'))
+        File.write(File.join(vendor, 'SOURCE'), <<~SOURCE)
+          curl-impersonate #{VERSION}
+          Binary: #{url}
+          SHA-256: #{digest}
+          Source and build instructions: https://github.com/lexiforest/curl-impersonate/tree/v#{VERSION}
+          Redistribution notices: licenses/
+        SOURCE
+      end
+
+      def vendor_path(name)
+        if name == 'curl-impersonate'
+          'bin/curl-impersonate'
+        elsif name.start_with?('LICENSE') && File.basename(name) == name
+          "licenses/#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/cinebase/vista.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'cinebase'
+
+module Cinebase
+  # Shared support for chains whose sites run on Vista's OCAPI. Not loaded by
+  # `require 'cinebase'`; Vista-based gems `require 'cinebase/vista'`.
+  module Vista
+    class AuthenticationError < StandardError; end
+  end
+end
+
+require 'cinebase/vista/client'
+require 'cinebase/vista/guest_token'

data/lib/cinebase.rb

@@ -6,5 +6,6 @@ require 'tzinfo/data'
 require 'cinebase/version'
 
 require 'cinebase/cinema'
+require 'cinebase/festival'
 require 'cinebase/performance'
 require 'cinebase/title_sanitizer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinebase
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Andy Croll
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -116,9 +144,14 @@ files:
 - cinebase.gemspec
 - lib/cinebase.rb
 - lib/cinebase/cinema.rb
+- lib/cinebase/festival.rb
 - lib/cinebase/performance.rb
 - lib/cinebase/title_sanitizer.rb
 - lib/cinebase/version.rb
+- lib/cinebase/vista.rb
+- lib/cinebase/vista/client.rb
+- lib/cinebase/vista/guest_token.rb
+- lib/cinebase/vista/package_task.rb
 homepage: http://github.com/andycroll/cinebase
 licenses:
 - MIT