odeon_uk 5.1.1-x86_64-linux-gnu → 5.3.0-x86_64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3393135e93707f7e38672d0bd3d25287c822e84e8d5264b54e80f6f2041eef83
-  data.tar.gz: deaf4a386a483d7257845ad5052421d46e7ec91e23166bcb6cff43e13396032a
+  metadata.gz: dc7575256bde69b11ed9e334e248c60ebe5052505b1774826f5ef2a41af28855
+  data.tar.gz: '082b20d79f181f1c8fe4386cde1a8909b4538acaa9041f40f82d0246719abd41'
 SHA512:
-  metadata.gz: 644aa5c3a8db2a08cf60984e71eda83c64f038cd9ab05aa243fccd56f2c83f6385a67411c64295604a0bbf6f9db70c86ac044dcef7884773a80b5c642ff9066a
-  data.tar.gz: 1d6e9657baf9f7daf53e96c48ebe2c2ad38088660b562bae38b322002a6973d039d72b4b8b91bff2c54977c5cba83ff514f2a2b0d3fff8679c2854acdae3db35
+  metadata.gz: cd71a970f25463f8cfc1d8c8ec380efc46cf7332c19c685edf275a4f108190ce0bf76c1c84f67045c2eb837b63dea00556e1c985225785985fc178642a0ecb66
+  data.tar.gz: 5780c617ae27789af681ecb8032ef625431851f31822cbed5a8bf2bc95efa7d183c81f381e80ebe91d7bff8f60271f58cd573c6fee18d6348204ee556914d0b9

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [5.3.0] - 2026-11-03
+
+### Changed
+- Uses cinebase 5.9: performances take the raw `title:`, so audience labels become variants, and series prefixes such as `Met Opera:` become the performance's `event`.
+- National Theatre Live and Bolshoi screenings are named `National Theatre Live: ` and `Bolshoi Ballet: `, the prefixes cinebase moves to `event`. Titles listed in capitals, such as `SCREAM`, are title cased.
+
+### Fixed
+- `ODEON Pride Nights - A Wolf Among the Swans` is now `A Wolf Among the Swans`.
+- `Charity Screening -  Inside Out` is now `Inside Out`.
+
+## 5.2.0 - 2026-10-31
+
+### Added
+- `Cinema#latitude` and `Cinema#longitude` as Floats in decimal degrees, from the Vista sites response. They are `nil` when a site has no location or sits at 0, 0.
+- `OdeonUk.ensure_token!` fetches a guest token only when there is none or it expires within an hour, and `OdeonUk.token_expires_at` reads its expiry. Both come from cinebase's `Vista::TokenHolder`.
+
+### Changed
+- A token the API rejects is cleared from `OdeonUk.token`, so the next `ensure_token!` fetches a fresh one.
+- Requires cinebase 5.6.
+
 ## 5.1.1 - 2026-10-22
 
 ### Changed

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in odeon_uk.gemspec
 gemspec
+

data/README.md

@@ -57,9 +57,21 @@ 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.
+verify the signature. Normal API calls never acquire or renew a token
+automatically. `OdeonUk.ensure_token!` fetches one only when there is no token,
+or the token expires within an hour, and otherwise keeps the current one. Call
+it before each batch of requests:
+
+``` ruby
+OdeonUk.ensure_token!
+OdeonUk.token_expires_at
+#=> 2026-10-31 03:00:00 UTC
+OdeonUk::Cinema.all
+```
+
+Missing, expired or rejected tokens raise `OdeonUk::AuthenticationError`. A
+token the API rejects is cleared from `OdeonUk.token`, so the next
+`ensure_token!` fetches a fresh one.
 
 ### Cinema
 
@@ -93,6 +105,12 @@ cinema.full_name
 cinema.id
 #=> '824'
 
+cinema.latitude
+#=> 50.821 # Float, nil when the API has no location
+
+cinema.longitude
+#=> -0.1452
+
 cinema.url
 #=> 'https://www.odeon.co.uk/cinemas/brighton/'
 ```

data/lib/odeon_uk/cinema.rb

@@ -105,6 +105,26 @@ module OdeonUk
     #     cinema.locality
     #     #=> 'Brighton'
 
+    # Latitude of the cinema
+    # @return [Float, nil] decimal degrees, or nil when unknown
+    # @example
+    #   cinema = OdeonUk::Cinema.new(824)
+    #   cinema.latitude
+    #   #=> 50.821
+    def latitude
+      coordinates&.first
+    end
+
+    # Longitude of the cinema
+    # @return [Float, nil] decimal degrees, or nil when unknown
+    # @example
+    #   cinema = OdeonUk::Cinema.new(824)
+    #   cinema.longitude
+    #   #=> -0.1452
+    def longitude
+      coordinates&.last
+    end
+
     # The name of the cinema
     # @return [String]
     # @example
@@ -164,6 +184,13 @@ module OdeonUk
 
     private
 
+    # 0, 0 marks a site whose position was never set
+    def coordinates
+      location = site_hash['location'] || {}
+      pair = [location['latitude'], location['longitude']]
+      pair.map(&:to_f) if pair.all?(Numeric) && pair.any?(&:nonzero?)
+    end
+
     def site_hash
       @site_hash ||= self.class.send(:sites_hash).fetch(id, {})
     end

data/lib/odeon_uk/internal/api_response.rb

@@ -14,19 +14,26 @@ module OdeonUk
 
       # @return [Array<Hash>] UK cinemas
       def sites
-        client.get("sites").fetch("sites")
+        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}",
+        get("showtimes/by-business-date/#{date.iso8601}",
                    "siteIds" => cinema_id)
       end
 
       private
 
+      def get(path, query = {})
+        client.get(path, query)
+      rescue Cinebase::Vista::AuthenticationError
+        OdeonUk.reject_token!(@client_token)
+        raise
+      end
+
       # One client keeps one connection open, so reuse it until the token changes.
       def client
         token = OdeonUk.token

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

@@ -43,6 +43,7 @@ module OdeonUk
               film_year: Cinebase::TitleSanitizer.film_year(title),
               language: language,
               starting_at: starting_at,
+              title: title,
               variant: variant
             }
           end

data/lib/odeon_uk/internal/title_sanitizer.rb

@@ -21,7 +21,9 @@ module OdeonUk
           'Autism Friendly Screening -', # autism screening
           /\(encore.+\)/i,               # encore for NT Live
           /\(live\)/i,                   # live in brackets
-          'Autism Friendly - '           # autism friendly
+          'Autism Friendly - ',          # autism friendly
+          /\AODEON Pride Nights\s*-\s*/, # pride season
+          /\ACharity Screening\s*-\s*/   # charity screening
         ] + COMMON_REMOVE
       end
 

data/lib/odeon_uk/version.rb

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

data/lib/odeon_uk.rb

@@ -18,13 +18,10 @@ require_relative './odeon_uk/performance'
 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
+  extend Cinebase::Vista::TokenHolder
+
+  # @api private
+  def self.guest_token_class
+    Internal::GuestToken
   end
 end

data/odeon_uk.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '< 1'
   spec.add_development_dependency 'webmock'
 
-  spec.add_runtime_dependency 'cinebase', '~> 5.5'
+  spec.add_runtime_dependency 'cinebase', '~> 5.9'
 end

data/test/fixtures/api/sites.json

@@ -3,6 +3,7 @@
     {
       "id": "017",
       "name": { "text": "Birmingham New Street" },
+      "location": { "latitude": 0, "longitude": 0 },
       "contactDetails": {
         "address": { "line1": "1 Example Arcade", "line2": "New Street", "city": "Birmingham" }
       }
@@ -10,6 +11,7 @@
     {
       "id": "153",
       "name": { "text": "London Leicester Square" },
+      "location": null,
       "contactDetails": {
         "address": { "line1": "2 Example Square", "line2": "", "city": "London" }
       }
@@ -17,6 +19,7 @@
     {
       "id": "824",
       "name": { "text": "Brighton" },
+      "location": { "latitude": 50.8215, "longitude": -0.146 },
       "contactDetails": {
         "address": { "line1": "3 Example Parade", "line2": "Seafront", "city": "Brighton" }
       }

data/test/lib/odeon_uk/cinema_test.rb

@@ -66,6 +66,31 @@ class OdeonUk::CinemaTest < Minitest::Test
     end
   end
 
+  def test_latitude_and_longitude
+    with_fake_api do
+      cinema = OdeonUk::Cinema.new(824)
+
+      assert_in_delta 50.8215, cinema.latitude, 0.0001
+      assert_in_delta(-0.146, cinema.longitude, 0.0001)
+    end
+  end
+
+  def test_latitude_and_longitude_are_nil_without_a_location
+    with_fake_api do
+      [153, 955].each do |id|
+        assert_nil OdeonUk::Cinema.new(id).latitude
+        assert_nil OdeonUk::Cinema.new(id).longitude
+      end
+    end
+  end
+
+  def test_latitude_and_longitude_are_nil_at_zero_zero
+    with_fake_api do
+      assert_nil OdeonUk::Cinema.new(17).latitude
+      assert_nil OdeonUk::Cinema.new(17).longitude
+    end
+  end
+
   def test_name_removes_london_prefix
     with_fake_api do
       assert_equal 'Leicester Square', OdeonUk::Cinema.new(153).name

data/test/lib/odeon_uk/internal/api_response_test.rb

@@ -50,6 +50,14 @@ class OdeonUk::Internal::ApiResponseTest < Minitest::Test
     assert_raises(OdeonUk::AuthenticationError) { api.sites }
   end
 
+  def test_rejected_token_is_cleared
+    stub_request(:get, "#{BASE_URL}/sites").to_return(status: 401)
+
+    assert_raises(OdeonUk::AuthenticationError) { api.sites }
+
+    assert_nil OdeonUk.token
+  end
+
   def test_server_error_omits_body
     stub_request(:get, "#{BASE_URL}/sites").to_return(status: 500, body: 'secret')
 

data/test/lib/odeon_uk/internal/guest_token_test.rb

@@ -51,6 +51,13 @@ class OdeonUk::Internal::GuestTokenTest < Minitest::Test
     assert_match(/curl-impersonate/, error.message)
   end
 
+  def test_ensure_token_fetches_only_without_a_current_token
+    token = token_expiring_at(Time.now + 7200)
+
+    assert_equal token, OdeonUk.ensure_token!(curl: fake_curl("#{page_with(token)}\n200"))
+    assert_equal token, OdeonUk.ensure_token!(curl: File.join(@directory, 'missing'))
+  end
+
   def test_acquire_token_sets_token
     token = token_expiring_at(Time.now + 3600)
 

data/test/lib/odeon_uk/internal/parser/api/showtime_test.rb

@@ -24,6 +24,7 @@ class OdeonUk::Internal::Parser::Api::ShowtimeTest < Minitest::Test
       film_year: nil,
       language: nil,
       starting_at: Time.utc(2026, 10, 24, 17, 30),
+      title: 'Jailer 2 (Tamil)',
       variant: []
     }
 

data/test/lib/odeon_uk/internal/title_sanitizer_test.rb

@@ -14,7 +14,7 @@ class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
   end
 
   def test_bolshoi
-    assert_sanitized 'Bolshoi: Spartacus', 'Bolshoi - Spartacus (Live)'
+    assert_sanitized 'Bolshoi Ballet: Spartacus', 'Bolshoi - Spartacus (Live)'
   end
 
   def test_removes_cinemagic_prefix
@@ -35,11 +35,11 @@ class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
   end
 
   def test_nt_live
-    assert_sanitized 'National Theatre: War Horse', 'NT Live - War Horse'
+    assert_sanitized 'National Theatre Live: War Horse', 'NT Live - War Horse'
   end
 
   def test_national_theatre_encore
-    assert_sanitized 'National Theatre: Frankenstein',
+    assert_sanitized 'National Theatre Live: Frankenstein',
                      'National Theatre Live - Frankenstein (Encore Screening)'
   end
 
@@ -103,7 +103,7 @@ class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
   end
 
   def test_removes_q_and_a
-    assert_sanitized 'NAZA', 'NAZA + Q&A'
+    assert_sanitized 'Naza', 'NAZA + Q&A'
   end
 
   def test_removes_in_person_q_and_a
@@ -115,7 +115,15 @@ class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
   end
 
   def test_removes_anniversary
-    assert_sanitized 'SCREAM', 'SCREAM (30th Anniversary)'
+    assert_sanitized 'Scream', 'SCREAM (30th Anniversary)'
+  end
+
+  def test_removes_pride_nights_prefix
+    assert_sanitized 'A Wolf Among the Swans', 'ODEON Pride Nights - A Wolf Among the Swans'
+  end
+
+  def test_removes_charity_screening_prefix
+    assert_sanitized 'Inside Out', 'Charity Screening -  Inside Out'
   end
 
   def test_world_tour_is_not_capitalised
@@ -128,11 +136,15 @@ class OdeonUk::Internal::TitleSanitizerTest < Minitest::Test
       'Spider-Man: Brand New Day',
       'Hadestown: The Musical',
       'Rammstein - Live in Mexico City',
-      'Ozzy & Black Sabbath: Back to the Beginning',
-      "BTS 'ARIRANG' IN BUENOS AIRES: LIVE VIEWING"
+      'Ozzy & Black Sabbath: Back to the Beginning'
     ].each { |title| assert_sanitized title, title }
   end
 
+  def test_title_cases_capitals
+    assert_sanitized "BTS 'Arirang' in Buenos Aires: Live Viewing",
+                     "BTS 'ARIRANG' IN BUENOS AIRES: LIVE VIEWING"
+  end
+
   private
 
   def assert_sanitized(expected, title)

data/test/lib/odeon_uk/performance_test.rb

@@ -36,6 +36,20 @@ class OdeonUk::PerformanceTest < Minitest::Test
                  performance.booking_url
   end
 
+  def test_at_names_event_from_title
+    @api_response.define_singleton_method(:showtimes) do |cinema_id, date|
+      super(cinema_id, date).tap do |data|
+        data.dig('relatedData', 'films', 0, 'title')['text'] = 'Met Opera - Eugene Onegin'
+      end
+    end
+    performance = performances_at(824).first
+
+    assert_equal 'Met Opera - Eugene Onegin', performance.title
+    assert_equal 'Eugene Onegin', performance.film_name
+    assert_equal Cinebase::Event.new(name: 'Met Opera'), performance.event
+    assert_equal %w(arts audio_described), performance.variant
+  end
+
   def test_at_parses_3d_imax
     performance = performances_at(824)[1]
 

data/test/live/integration_test.rb

@@ -8,6 +8,16 @@ class LiveCinemaTest < Minitest::Test
     assert_operator cinemas.size, :>, 90
     assert_equal 'Brighton', cinemas.detect { |cinema| cinema.id == '824' }.name
   end
+
+  def test_cinemas_have_uk_coordinates
+    located = OdeonUk::Cinema.all.select(&:latitude)
+
+    refute_empty located
+    located.each do |cinema|
+      assert_includes 49.0..61.0, cinema.latitude, "#{cinema.id} #{cinema.name}"
+      assert_includes(-9.0..2.0, cinema.longitude, "#{cinema.id} #{cinema.name}")
+    end
+  end
 end
 
 class LivePerformanceTest < Minitest::Test

data/test/support/api_shapes.rb

@@ -15,6 +15,11 @@ module ApiShapes
       %w(line1 line2 city).each do |key|
         assert_kind_of String, address.fetch(key), "site #{site['id']} #{key}"
       end
+      location = site['location'] || {}
+      %w(latitude longitude).each do |key|
+        value = location[key]
+        assert_kind_of Numeric, value, "site #{site['id']} #{key}" unless value.nil?
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odeon_uk
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: x86_64-linux-gnu
 authors:
 - Andy Croll
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.9'
 description: Pull movie & cinema information from the ODEON Vista API
 email:
 - andy@goodscary.com