odeon_uk 5.1.0-x86_64-linux-gnu → 5.2.0-x86_64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7e70ac9101d3179d3cdab3eeab09901467e4aa1b533bf89b58ffb53d8ba68e
-  data.tar.gz: 37227f7d72bfe612ba547c9e9f25161eafe3c67a5ca17233f34d02f2cf67c95a
+  metadata.gz: 789fcaeb757389c60c612896ada9f71c3c3bb9e70db96bccb0f570ea50ebad9f
+  data.tar.gz: 5eac1581b656a59102d5ff98e80495a46cdd069e4a3616c2bf268acd4eb63d66
 SHA512:
-  metadata.gz: 07045e1494f453f53c7921810000a298c4b111092e9b0057f8fd030af798d4d692d82117f8182464db58c6752ec9c510243ac939284a041f9155f6e0e7fe9e30
-  data.tar.gz: 4da28a4096ea2213d61b9e69f84a8427c6472e1365fe4b4ab4b28b6ba1d326f0865eb015aa39e8d149f423e760e9c7f19fb73b22cf7a9df07af8e695106cbf52
+  metadata.gz: 9aacaacabd125b7586e1397f64809ddc13c4b9bde4d863bf4837f469535d663db62d9bdd551762eb5e99e668d09a3c35333a0601052edd41233f950ca5c8c222
+  data.tar.gz: 7fdbf726625c78532f00959ba49dbe4c34c29aead88058396508cef02cf7f52725d30052d787070de674e4709817dbbee973ff426108804e60e237b439a994ad

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 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-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
+- Reuse one Vista client, and so one kept-alive connection, for all requests until the token changes, instead of opening a TLS connection for every request. Requires cinebase 5.5.
+
 ## 5.1.0 - 2026-10-22
 
 ### Added

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,22 +14,35 @@ 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
-        Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: REGION_CODE,
-                                    token: OdeonUk.token)
+        token = OdeonUk.token
+        if @client.nil? || @client_token != token
+          @client_token = token
+          @client = Cinebase::Vista::Client.new(base_url: BASE_URL, region_code: REGION_CODE,
+                                                token: token)
+        end
+        @client
       end
     end
   end

data/lib/odeon_uk/version.rb

@@ -1,6 +1,6 @@
 # Ruby interface for https://www.odeon.co.uk
-# @version 5.1.0
+# @version 5.2.0
 module OdeonUk
   # Gem version
-  VERSION = '5.1.0'.freeze
+  VERSION = '5.2.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.4'
+  spec.add_runtime_dependency 'cinebase', '~> 5.6'
 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')
 
@@ -58,8 +66,36 @@ class OdeonUk::Internal::ApiResponseTest < Minitest::Test
     assert_equal 'Vista HTTP error 500', error.message
   end
 
+  def test_reuses_one_client_while_the_token_holds
+    stub_request(:get, "#{BASE_URL}/sites").to_return(status: 200, body: sites_json)
+    shared = api
+
+    assert_equal 1, count_clients { 3.times { shared.sites } }
+  end
+
+  def test_builds_a_new_client_for_a_new_token
+    stub_request(:get, "#{BASE_URL}/sites").to_return(status: 200, body: sites_json)
+    shared = api
+
+    clients = count_clients do
+      shared.sites
+      OdeonUk.token = 'renewed-jwt'
+      shared.sites
+    end
+
+    assert_equal 2, clients
+  end
+
   private
 
+  def count_clients
+    clients = 0
+    original = Cinebase::Vista::Client.method(:new)
+    counting = ->(**options) { clients += 1; original.call(**options) }
+    Cinebase::Vista::Client.stub(:new, counting) { yield }
+    clients
+  end
+
   def api
     OdeonUk::Internal::ApiResponse.new
   end

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/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.0
+  version: 5.2.0
 platform: x86_64-linux-gnu
 authors:
 - Andy Croll
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.6'
 description: Pull movie & cinema information from the ODEON Vista API
 email:
 - andy@goodscary.com