curzon_uk 1.0.0

data/README.md

@@ -0,0 +1,164 @@
+# CurzonUk
+
+A simple gem to pull cinemas and performances from the Vista API behind the [Curzon website](https://www.curzon.com) and spit out useful formatted info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'curzon_uk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install curzon_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 years, Curzon's DocHouse and Film Club strand prefixes, festival prefixes and other markers.
+
+### Guest token
+
+Every API call needs the public guest token the Curzon website gives each
+visitor. Fetch one before anything else:
+
+``` ruby
+CurzonUk.acquire_token!
+CurzonUk::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.curzon.com/`. 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
+CurzonUk.acquire_token!(curl: '/opt/curl-impersonate/curl-impersonate')
+```
+
+Or supply your own current guest JWT, without the `Bearer ` prefix:
+
+``` ruby
+CurzonUk.token = ENV.fetch('CURZON_TOKEN')
+```
+
+Tokens currently last 12 hours. The gem checks the declared expiry but does not
+verify the signature. Missing, expired or rejected tokens raise
+`CurzonUk::AuthenticationError`; call `CurzonUk.acquire_token!` again. Normal
+API calls never acquire or renew a token automatically.
+
+### Cinema
+
+Cinema ids are Vista site ids, such as `'SOH1'` for Soho.
+
+``` ruby
+CurzonUk::Cinema.all
+#=> [<CurzonUk::Cinema ...>, <CurzonUk::Cinema ...>, ...]
+
+cinema = CurzonUk::Cinema.new('SOH1')
+#=> <CurzonUk::Cinema ...>
+
+cinema.adr
+#=> {
+  street_address:   '99 Shaftesbury Avenue',
+  extended_address: nil,
+  locality:         'London',
+  region:           nil,
+  postal_code:      'W1D 5DY',
+  country_name:     'United Kingdom'
+}
+
+cinema.brand
+#=> 'Curzon'
+
+cinema.full_name
+#=> 'Curzon Soho'
+
+cinema.url
+#=> 'https://www.curzon.com/venues/soho/'
+```
+
+### 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
+CurzonUk::Performance.at('SOH1', from: Date.today, to: Date.today + 2)
+#=> [<CurzonUk::Performance ...>, <CurzonUk::Performance ...>, ...]
+
+performance = CurzonUk::Performance.at('SOH1').first
+#=> <CurzonUk::Performance ...>
+
+performance.film_name
+#=> 'Fatherland'
+
+performance.film_year
+#=> nil # from the title, e.g. 2026 for 'Street Fighter (2026)'
+
+performance.dimension
+#=> '2d'
+
+performance.variant
+#=> ['q&a']
+
+performance.subtitled?
+#=> false # true for open captioned screenings
+
+performance.festival
+#=> nil # e.g. #<data Cinebase::Festival name="UKJFF", year=2026>
+
+performance.starting_at
+#=> 2026-10-23 10:00:00 UTC
+
+performance.booking_url
+#=> 'https://www.curzon.com/ticketing/seats/?showtimeId=SOH1-57865'
+
+performance.cinema_name
+#=> 'Soho'
+
+performance.cinema_id
+#=> 'SOH1'
+```
+
+Variants are `baby`, `q&a` and `subtitled`. Curzon doesn't tag audio
+languages, so `language` is always `nil`.
+
+## Tests
+
+```sh
+bundle exec rake          # unit tests against fixtures
+bundle exec rake live     # live API, needs curl-impersonate or CURZON_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
+
+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
+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

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('curzon_uk.gemspec', root: __dir__)
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/curzon_uk'
+  t.test_files = FileList[
+    'test/lib/curzon_uk/*_test.rb',
+    'test/lib/curzon_uk/internal/*_test.rb',
+    'test/lib/curzon_uk/internal/parser/api/*_test.rb'
+  ]
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/curzon_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 'curzon_uk'
+  ARGV.clear
+  IRB.start
+end
+
+task default: :test

data/curzon_uk.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curzon_uk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'curzon_uk'
+  spec.version       = CurzonUk::VERSION
+  spec.authors       = ['Andy Croll']
+  spec.email         = ['andy@goodscary.com']
+  spec.description   = 'Pull movie & cinema information from the Curzon Vista API'
+  spec.summary       = "It's a scraper, but a nice one"
+  spec.homepage      = 'https://github.com/andycroll/curzon_uk'
+  spec.licenses      = %w(AGPL MIT)
+
+  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 '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 'cinebase', '~> 5.4'
+end

data/lib/curzon_uk/cinema.rb

@@ -0,0 +1,109 @@
+module CurzonUk
+  # The object representing a cinema on the Curzon website
+  class Cinema < Cinebase::Cinema
+    # @!attribute [r] id
+    #   @return [String] the Vista site id of the cinema, e.g. 'ALD1'
+
+    # UK postcode
+    POSTCODE = /[A-Z]{1,2}\d[A-Z\d]? ?\d[A-Z]{2}/i.freeze
+
+    # Constructor
+    # @param [String] id the cinema id, e.g. 'ALD1' or 'ald1'
+    # @return [CurzonUk::Cinema]
+    def initialize(id)
+      @id = id.to_s.upcase
+    end
+
+    # Return basic cinema information for all cinemas
+    # @return [Array<CurzonUk::Cinema>]
+    # @example
+    #   CurzonUk::Cinema.all
+    #   #=> [<CurzonUk::Cinema>, <CurzonUk::Cinema>, ...]
+    def self.all
+      sites_hash.keys.map { |id| new(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, :region, :postal_code, :country_name
+    # @example
+    #   cinema = CurzonUk::Cinema.new('SOH1')
+    #   cinema.adr
+    #   #=> {
+    #         street_address:   '99 Shaftesbury Avenue',
+    #         extended_address: nil,
+    #         locality:         'London',
+    #         region:           nil,
+    #         postal_code:      'W1D 5DY',
+    #         country_name:     'United Kingdom'
+    #       }
+    # @note Uses method naming as at http://microformats.org/wiki/adr
+    def adr
+      lines = address_lines
+      if (match = lines.last&.match(/\A(.*?),?\s*(#{POSTCODE.source})\z/i))
+        lines.pop
+        lines << match[1] unless match[1].empty?
+        postal_code = match[2]
+      end
+      street_address = lines.shift
+      locality = lines.pop
+      {
+        street_address:   street_address,
+        extended_address: lines.empty? ? nil : lines.join(', '),
+        locality:         locality,
+        region:           nil,
+        postal_code:      postal_code,
+        country_name:     'United Kingdom'.freeze
+      }
+    end
+
+    # Brand of the cinema
+    # @return [String] which will always be 'Curzon'
+    def brand
+      'Curzon'.freeze
+    end
+
+    # The name of the cinema
+    # @return [String]
+    # @example
+    #   CurzonUk::Cinema.new('SOH1').name
+    #   #=> 'Soho'
+    def name
+      site_hash.dig('name', 'text').to_s
+    end
+
+    # The url of the cinema on the Curzon website
+    # @return [String]
+    def url
+      "https://www.curzon.com/venues/#{name.downcase.gsub(/[^a-z0-9]+/, '-').gsub(/\A-|-\z/, '')}/"
+    end
+
+    # @api private
+    def self.sites_hash
+      @sites_hash ||= CurzonUk::Internal::ApiResponse.new.sites.to_h do |site|
+        [site.fetch('id'), site]
+      end
+    end
+    private_class_method :sites_hash
+
+    private
+
+    # Curzon ends each line with a comma
+    def address_lines
+      address = site_hash.dig('contactDetails', 'addressV2') || {}
+      %w(line1 line2 line3 line4).filter_map do |key|
+        text = address.dig(key, 'text').to_s.strip.delete_suffix(',').strip
+        text unless text.empty?
+      end
+    end
+
+    def site_hash
+      @site_hash ||= self.class.send(:sites_hash).fetch(id, {})
+    end
+  end
+end

data/lib/curzon_uk/internal/api_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "date"
+
+module CurzonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Internal
+    # Fetches cinema and showtime data from the Vista API behind curzon.com
+    class ApiResponse
+      BASE_URL = "https://digital-api.curzon.com/ocapi/v1/"
+
+      # @return [Array<Hash>] cinemas
+      def sites
+        client.get("sites").fetch("sites")
+      end
+
+      # @param [String] cinema_id site id, e.g. 'ALD1'
+      # @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
+
+      # Curzon's API needs no Connect-Region-Code.
+      def client
+        Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: nil,
+                                    token: CurzonUk.token)
+      end
+    end
+  end
+end

data/lib/curzon_uk/internal/guest_token.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "json"
+
+module CurzonUk
+  module Internal
+    # Reads the public guest token from the Curzon website's page data
+    class GuestToken < Cinebase::Vista::GuestToken
+      PAGE_URL = "https://www.curzon.com/"
+
+      private
+
+      # Missing pages carry the same page data.
+      def accepted_statuses
+        %w[200 404]
+      end
+
+      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/curzon_uk/internal/parser/api/showtime.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "time"
+
+module CurzonUk
+  # @api private
+  module Internal
+    module Parser
+      module Api
+        # Parses a single Vista showtime into performance attributes
+        class Showtime
+          BOOKING_URL = "https://www.curzon.com/ticketing/seats/?showtimeId="
+
+          # Vista attribute names
+          VARIANTS = {
+            "Baby Club" => "baby",
+            "Open Captioned" => "subtitled",
+            "Screening followed by a Q&A" => "q&a"
+          }.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 CurzonUk::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: TitleSanitizer.new(title).sanitized,
+              film_year: Cinebase::TitleSanitizer.film_year(title),
+              starting_at: starting_at,
+              variant: variant
+            }
+          end
+
+          private
+
+          def starting_at
+            Time.iso8601(@data.dig("schedule", "startsAt")).utc
+          end
+
+          def title
+            @films.fetch(@data.fetch("filmId")).dig("title", "text")
+          end
+
+          def variant
+            @data.fetch("attributeIds", []).filter_map do |id|
+              VARIANTS[@attributes.dig(id, "name", "text").to_s.strip]
+            end.uniq
+          end
+        end
+      end
+    end
+  end
+end

data/lib/curzon_uk/internal/title_sanitizer.rb

@@ -0,0 +1,32 @@
+module CurzonUk
+  # 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 [CurzonUk::Internal::TitleSanitizer]
+
+      # @!method sanitized
+      #   sanitized and standardized title
+      #   @return [String] sanitised title
+
+      private
+
+      # strings and regex to be removed
+      def remove
+        [
+          /\ADocHouse: /i, # DocHouse strand
+          /\AFilm Club: /i # Film Club strand
+        ] + COMMON_REMOVE
+      end
+
+      # regexes and their replacements
+      def replace
+        COMMON_REPLACE
+      end
+    end
+  end
+end

data/lib/curzon_uk/performance.rb

@@ -0,0 +1,82 @@
+module CurzonUk
+  # The object representing a single screening of a film on the Curzon 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 [Integer] :film_year (nil) year from the film's title
+    #   @option options [String] :language (nil) audio language of the screening
+
+    # Performances within an inclusive range of cinema business dates.
+    # @param [String] cinema_id id of the cinema, e.g. 'ALD1'
+    # @param [Date] from first date (defaults to today in London)
+    # @param [Date] to last date (defaults to 13 days after from)
+    # @return [Array<CurzonUk::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 = CurzonUk::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 = CurzonUk::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/curzon_uk/version.rb

@@ -0,0 +1,6 @@
+# Ruby interface for https://www.curzon.com
+# @version 1.0.0
+module CurzonUk
+  # Gem version
+  VERSION = '1.0.0'.freeze
+end

data/lib/curzon_uk.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+require 'cinebase'
+require 'cinebase/vista'
+
+require_relative './curzon_uk/version'
+
+require_relative './curzon_uk/internal/api_response'
+require_relative './curzon_uk/internal/guest_token'
+require_relative './curzon_uk/internal/title_sanitizer'
+
+require_relative './curzon_uk/internal/parser/api/showtime'
+
+require_relative './curzon_uk/cinema'
+require_relative './curzon_uk/performance'
+
+# curzon_uk gem
+module CurzonUk
+  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/test/fixtures/api/showtimes-SOH1.json

@@ -0,0 +1,58 @@
+{
+  "businessDate": "2026-10-24",
+  "showtimes": [
+    {
+      "id": "SOH1-1001",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T13:00:00+01:00" },
+      "attributeIds": [],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "SOH1-1002",
+      "filmId": "FILM-1",
+      "schedule": { "startsAt": "2026-10-24T16:00:00+01:00" },
+      "attributeIds": ["A-CAPT"],
+      "requires3dGlasses": true
+    },
+    {
+      "id": "SOH1-1003",
+      "filmId": "FILM-2",
+      "schedule": { "startsAt": "2026-10-24T18:30:00+01:00" },
+      "attributeIds": ["A-DOC", "A-QA"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "SOH1-1004",
+      "filmId": "FILM-3",
+      "schedule": { "startsAt": "2026-10-24T10:30:00+01:00" },
+      "attributeIds": ["A-BABY", "A-CLUB"],
+      "requires3dGlasses": false
+    },
+    {
+      "id": "SOH1-1005",
+      "filmId": "FILM-4",
+      "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": "DocHouse: A Made Up Documentary (2025)" } },
+      { "id": "FILM-3", "title": { "text": "Film Club: Pretend Classic" } },
+      { "id": "FILM-4", "title": { "text": "UKJFF - Imaginary Picture" } }
+    ],
+    "attributes": [
+      { "id": "A-CAPT", "shortName": { "text": "Captioned" }, "name": { "text": "Open Captioned" } },
+      { "id": "A-DOC", "shortName": { "text": "Dochouse" }, "name": { "text": "Programmed by Example Dochouse" } },
+      { "id": "A-QA", "shortName": { "text": "Q&A" }, "name": { "text": "Screening followed by a Q&A" } },
+      { "id": "A-BABY", "shortName": { "text": "Baby Club" }, "name": { "text": "Baby Club" } },
+      { "id": "A-CLUB", "shortName": { "text": "Film Club" }, "name": { "text": "Film Club" } }
+    ],
+    "sites": [
+      { "id": "SOH1", "name": { "text": "Soho" } }
+    ]
+  }
+}