odeon_uk 5.0.0-aarch64-linux-gnu

data/README.md

@@ -0,0 +1,174 @@
+# OdeonUk
+
+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)
+[![Inline docs](http://inch-ci.org/github/andycroll/odeon_uk.svg?branch=master)](http://inch-ci.org/github/andycroll/odeon_uk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'odeon_uk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odeon_uk
+
+## Usage
+
+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 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(824)
+#=> <OdeonUk::Cinema ...>
+
+cinema.adr
+#=> {
+  street_address:   'Kingswest',
+  extended_address: 'West Street',
+  locality:         'Brighton',
+  region:           nil,
+  postal_code:      nil,
+  country_name:     'United Kingdom'
+}
+
+cinema.brand
+#=> 'Odeon'
+
+cinema.full_name
+#=> 'Odeon Brighton'
+
+cinema.id
+#=> '824'
+
+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(824)
+#=> [<OdeonUk::Performance ...>, <OdeonUk::Performance ...>, ...]
+
+OdeonUk::Performance.at(824, from: Date.today, to: Date.today + 2)
+#=> [<OdeonUk::Performance ...>, <OdeonUk::Performance ...>, ...]
+
+performance = OdeonUk::Performance.at(824).first
+#=> <OdeonUk::Performance ...>
+
+performance.film_name
+#=> 'Street Fighter'
+
+performance.dimension
+#=> '2d'
+
+performance.variant
+#=> ['audio_described', 'imax']
+
+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
+#=> 2026-10-24 08:00:00 UTC
+
+performance.showing_on
+#=> #<Date: 2026-10-24 ((2461338j,0s,0n),+0s,2299161j)>
+
+performance.booking_url
+#=> 'https://www.odeon.co.uk/ticketing/seat-picker/?showtimeId=824-69206'
+
+performance.cinema_name
+#=> 'Brighton'
+
+performance.cinema_id
+#=> '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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Note that contributors assign all rights to the owner, Andy Croll ([github](http://github.com/andycroll)), of this gem.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+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/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
+
+# http://erniemiller.org/2014/02/05/7-lines-every-gems-rakefile-should-have/
+desc 'run gem console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'odeon_uk'
+  ARGV.clear
+  IRB.start
+end
+
+task default: :test

data/lib/odeon_uk/cinema.rb

@@ -0,0 +1,181 @@
+module OdeonUk
+  # The object representing a cinema on the Odeon UK website
+  class Cinema < Cinebase::Cinema
+    # @!attribute [r] id
+    #   @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 17/'017'
+    # @return [OdeonUk::Cinema]
+    def initialize(id)
+      @id = id.to_s.rjust(3, '0')
+    end
+
+    # Return basic cinema information for all UK cinemas
+    # @return [Array<OdeonUk::Cinema>]
+    # @example
+    #   OdeonUk::Cinema.all
+    #   #=> [<OdeonUk::Cinema>, <OdeonUk::Cinema>, ...]
+    def self.all
+      sites_hash.keys.map { |cinema_id| new(cinema_id) }
+    end
+
+    # @!method address
+    #   Address of the cinema
+    #   @return [Hash] of different address parts
+    #   @see #adr
+
+    # Address of the cinema
+    # @return [Hash] contains :street_address, :extended_address,
+    # :locality, :postal_code, :country
+    # @example
+    #   cinema = OdeonUk::Cinema.new(824)
+    #   cinema.adr
+    #   #=> {
+    #         street_address: 'Kingswest',
+    #         extended_address: 'West Street',
+    #         locality: 'Brighton',
+    #         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:   address['line1'],
+        extended_address: address['line2'],
+        locality:         address['city'],
+        region:           nil,
+        postal_code:      nil,
+        country_name:     'United Kingdom'.freeze
+      }
+    end
+
+    # Brand of the cinema
+    # @return [String] which will always be 'Odeon'
+    # @example
+    #   cinema = OdeonUk::Cinema.new(3)
+    #   cinema.brand
+    #   #=> 'Odeon'
+    def brand
+      'Odeon'.freeze
+    end
+
+    # @!method country_name
+    #   Country of the cinema
+    #   @return [String] which will always be 'United Kingdom'
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.country_name
+    #     #=> 'United Kingdom'
+
+    # @!method extended_address
+    #   The second address line of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(10)
+    #     cinema.extended_address
+    #     #=> 'Chelsea'
+    #
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.extended_address
+    #     #=> ''
+
+    # @!method full_name
+    #   The name of the cinema including the brand
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(88)
+    #     cinema.full_name
+    #     #=> 'Cineworld Glasgow: IMAX at GSC'
+
+    # @!method locality
+    #   The locality (town) of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.locality
+    #     #=> 'Brighton'
+
+    # The name of the cinema
+    # @return [String]
+    # @example
+    #   cinema = CineworldUk::Cinema.new(3)
+    #   cinema.name
+    #   #=> 'Brighton'
+    def name
+      @name ||= site_name.gsub(/\ALondon /, '').gsub(' - ', ': ')
+    end
+
+    # @!method postal_code
+    #   Post code of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.postal_code
+    #     #=> 'BN2 5UF'
+
+    # @!method region
+    #   The region (county) of the cinema if provided
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.region
+    #     #=> 'East Sussex'
+
+    # @!method slug
+    #   The URL-able slug of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.slug
+    #     #=> 'odeon-brighton'
+
+    # @!method street_address
+    #   The street address of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.street_address
+    #     #=> 'Brighton Marina'
+    #   @note Uses the standard method naming as at http://microformats.org/wiki/adr
+
+    # The url of the cinema on the Cineworld website
+    # @return [String]
+    def url
+      "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 site_hash
+      @site_hash ||= self.class.send(:sites_hash).fetch(id, {})
+    end
+
+    def site_name
+      site_hash.dig('name', 'text').to_s
+    end
+
+    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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "date"
+
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Internal
+    # Fetches cinema and showtime data from the Vista API behind odeon.co.uk
+    class ApiResponse
+      BASE_URL = "https://vwc.odeon.co.uk/WSVistaWebClient/ocapi/v1/"
+      # Limits sites to the UK, leaving out ODEON's Irish cinemas.
+      REGION_CODE = "UK"
+
+      # @return [Array<Hash>] UK cinemas
+      def sites
+        client.get("sites").fetch("sites")
+      end
+
+      # @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 client
+        Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: REGION_CODE,
+                                    token: OdeonUk.token)
+      end
+    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

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

@@ -0,0 +1,80 @@
+# 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,
+              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

@@ -0,0 +1,42 @@
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Internal
+    # Sanitize and standardize film titles
+    class TitleSanitizer < Cinebase::TitleSanitizer
+      # @!method initialize(title)
+      #   Constructor
+      #   @param [String] title a film title
+      #   @return [CineworldUk::Internal::TitleSanitizer]
+
+      # @!method sanitized
+      #   sanitized and standardized title
+      #   @return [String] sanitised title
+
+      private
+
+      # strings and regex to be removed
+      def remove
+        [
+          'Autism Friendly Screening -', # autism screening
+          /\(encore.+\)/i,               # encore for NT Live
+          /\(live\)/i,                   # live in brackets
+          'Autism Friendly - '           # autism friendly
+        ] + COMMON_REMOVE
+      end
+
+      # regexes and their replacements
+      def replace
+        {
+          /Bolshoi - (.*)/               => 'Bolshoi: ',
+          /Globe On Screen: (.*)/        => 'Globe: ',
+          /Met Opera - (.*)/             => 'Met Opera: ',
+          /National Theatre Live - (.*)/ => 'National Theatre: ',
+          /NT Live - (.*)/               => 'National Theatre: ',
+          /ROH - (.*)/                   => 'Royal Opera House: ',
+          /(.*)\- RSC Live \d{1,4}/      => 'Royal Shakespeare Company: '
+        }.merge(COMMON_REPLACE)
+      end
+    end
+  end
+end

data/lib/odeon_uk/performance.rb

@@ -0,0 +1,81 @@
+module OdeonUk
+  # The object representing a single screening of a film on the Odeon UK website
+  class Performance < Cinebase::Performance
+    # @!attribute [r] booking_url
+    #   @return [String] the booking URL on the cinema website
+    # @!attribute [r] cinema_name
+    #   @return [String] the cinema name
+    # @!attribute [r] cinema_id
+    #   @return [String] the cinema id
+    # @!attribute [r] dimension
+    #   @return [String] 2d or 3d
+    # @!attribute [r] film_name
+    #   @return [String] the film name
+
+    # @!method initialize(options)
+    #   @param [Hash] options options hash
+    #   @option options [String] :booking_url (nil) buying url for the screening
+    #   @option options [String] :cinema_name name of the cinema
+    #   @option options [String] :cinema_id website id of the cinema
+    #   @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
+
+    # 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,
+      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
+
+    # @!method showing_on
+    #   The date of the screening
+    #   @return [Date]
+
+    # @!method starting_at
+    #   UTC time of the screening
+    #   @return [Time]
+
+    # @!method variant
+    #   The kinds of screening (IMAX, kids, baby, senior)
+    #   @return <Array[String]>
+
+
+    # private
+
+    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'))
+
+      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 :performances_on
+
+    def self.by_id(items)
+      items.to_h { |item| [item.fetch('id'), item] }
+    end
+    private_class_method :by_id
+  end
+end

data/lib/odeon_uk/version.rb

@@ -0,0 +1,6 @@
+# Ruby interface for https://www.odeon.co.uk
+# @version 5.0.0
+module OdeonUk
+  # Gem version
+  VERSION = '5.0.0'.freeze
+end

data/lib/odeon_uk.rb

@@ -0,0 +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/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