reel_uk 1.0.0

data/lib/reel_uk/internal/website.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ReelUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Internal
+    # Reads pages from Reel's WordPress website, built on Jacro's cinema
+    # plugin. No token is needed.
+    class Website
+      include Http
+
+      HOME = 'https://reel-cinemas.co.uk/'
+      AJAX = 'https://reel-cinemas.co.uk/wp-admin/admin-ajax.php'
+      # The quick booking menu's request for every showtime of a film
+      SHOWTIMES_ACTION = 'display_showtime_byfilmid'
+
+      # @return [String] the home page, whose cinema menu lists every venue
+      def home
+        get(HOME)
+      end
+
+      # @param [String] venue_url e.g. 'https://reel-cinemas.co.uk/chorley'
+      # @return [String] the venue's page, whose quick booking menu names
+      #   the venue's Jacro location id
+      def venue(venue_url)
+        get("#{venue_url}/")
+      end
+
+      # @param [String] venue_url e.g. 'https://reel-cinemas.co.uk/chorley'
+      # @return [String] the next three weeks of showtimes, with labels
+      def whats_on(venue_url)
+        get("#{venue_url}/whatson/")
+      end
+
+      # @param [String] venue_url e.g. 'https://reel-cinemas.co.uk/chorley'
+      # @return [String] films not yet showing, with up to three showtimes each
+      def coming_soon(venue_url)
+        get("#{venue_url}/comingsoon/")
+      end
+
+      # @param [String] film_id Jacro's film id, the same at every venue
+      # @param [String] location Jacro's location id for the venue
+      # @return [String] options naming every showtime of the film at the
+      #   venue, however far ahead
+      def showtimes(film_id, location)
+        response = post(AJAX, 'action' => SHOWTIMES_ACTION, 'select_movie' => film_id, 'movie_loc' => location)
+        JSON.parse(response).fetch('html', '').to_s
+      end
+    end
+  end
+end

data/lib/reel_uk/performance.rb

@@ -0,0 +1,129 @@
+module ReelUk
+  # A single screening of a film on the Reel Cinemas website
+  class Performance < Cinebase::Performance
+    # @!attribute [r] booking_url
+    #   @return [String] the booking URL for the screening
+    # @!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 [Cinebase::Festival] :festival (nil) festival edition
+    #   @option options [String] :film_name name of the film
+    #   @option options [Integer] :film_year (nil) year from the film's title
+    #   @option options [String] :language (nil) audio language, e.g. 'Hindi'
+    #   @option options [Time] :starting_at listed start time of the performance
+
+    # Showtime labels and A1Web group headings, and the variants they mean.
+    # 'Movie Madness' marks cheap tickets, not a kind of screening.
+    VARIANTS = Cinebase::A1web::Performance::VARIANTS.merge(
+      'ParentBaby' => 'baby',
+      'Senior' => 'senior'
+    ).freeze
+
+    # Event screenings on the WordPress website have no label
+    EVENT = /\A(?:RBO|NT Live|National Theatre Live|Met Opera|Exhibition on Screen)\b|\bLive On Stage\z|\s-\sThe Play\z/i
+    SUBTITLED = /\bSubtitled\b/i
+    THREE_D = Cinebase::A1web::Performance::THREE_D
+    IMAX = Cinebase::A1web::Performance::IMAX
+    LANGUAGE = Cinebase::A1web::Performance::LANGUAGE
+    TIME_ZONE = 'Europe/London'.freeze
+
+    # The old website's own booking links only work in a browser that has
+    # just visited the venue's pages, so link to the venue's Admit One
+    # ticketing site, which redirects to seat selection.
+    A1WEB_PERF_CODE = %r{/booking/(\d+)/}
+
+    # Performances within an inclusive range of showing dates, from all of
+    # the cinema's advertised dates. A venue on the WordPress website takes
+    # three requests and one more for each film; a venue on the old A1Web
+    # website takes one.
+    # @param [String] cinema_id the venue's path on the website, e.g. 'chorley'
+    # @param [Date] from first date (defaults to today in London)
+    # @param [Date] to last date (defaults to 13 days after from)
+    # @return [Array<ReelUk::Performance>]
+    def self.at(
+      cinema_id,
+      from: TZInfo::Timezone.get(TIME_ZONE).now.to_date,
+      to: from + 13
+    )
+      raise ArgumentError, 'to must not precede from' if to < from
+
+      cinema = Cinema.new(cinema_id)
+      performances = showings(cinema).select { |showing| (from..to).cover?(showing.date) }.map do |showing|
+        new(attributes(showing, cinema).merge(cinema_id: cinema.id, cinema_name: cinema.name))
+      end
+      performances.sort_by(&:starting_at)
+    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 (arts, baby, senior, subtitled ...)
+    #   @return <Array[String]>
+
+    def self.showings(cinema)
+      if cinema.url.empty?
+        []
+      elsif cinema.a1web?
+        today = TZInfo::Timezone.get(TIME_ZONE).now.to_date
+        html = Cinema.a1web_client.whats_on(cinema.url)
+        Cinebase::A1web::Listings.new(html, venue_url: cinema.url, today: today).showings
+      else
+        ReelUk::Internal::Listings.new(cinema.url).showings
+      end
+    end
+    private_class_method :showings
+
+    def self.attributes(showing, cinema)
+      title = showing.title
+      {
+        booking_url: booking_url(showing.booking_url, cinema),
+        dimension: [title, *showing.tags].any? { |text| text.match?(THREE_D) } ? '3d' : '2d',
+        festival: Cinebase::Festival.from_title(title, year: showing.date.year),
+        film_name: ReelUk::Internal::TitleSanitizer.new(title).sanitized,
+        film_year: Cinebase::TitleSanitizer.film_year(title),
+        language: title[LANGUAGE, 1],
+        starting_at: showing.starting_at,
+        variant: variant(showing)
+      }
+    end
+    private_class_method :attributes
+
+    def self.booking_url(url, cinema)
+      code = url[A1WEB_PERF_CODE, 1]
+      if cinema.a1web? && code
+        "https://reel#{cinema.id.delete('-')}.admit-one.co.uk/tickets/?perfCode=#{code}"
+      else
+        url
+      end
+    end
+    private_class_method :booking_url
+
+    def self.variant(showing)
+      title = showing.title
+      variant = showing.tags.filter_map { |tag| VARIANTS[tag] }
+      variant << 'subtitled' if title.match?(SUBTITLED)
+      variant << 'arts' if title.match?(EVENT)
+      variant << 'imax' if title.match?(IMAX)
+      variant.uniq
+    end
+    private_class_method :variant
+  end
+end

data/lib/reel_uk/version.rb

@@ -0,0 +1,6 @@
+# Ruby interface for https://reel-cinemas.co.uk
+# @version 1.0.0
+module ReelUk
+  # Gem version
+  VERSION = '1.0.0'.freeze
+end

data/lib/reel_uk.rb

@@ -0,0 +1,23 @@
+require 'cgi/escape'
+require 'json'
+
+require 'cinebase'
+require 'cinebase/a1web'
+
+require_relative './reel_uk/version'
+
+require_relative './reel_uk/internal/http'
+require_relative './reel_uk/internal/website'
+require_relative './reel_uk/internal/title_sanitizer'
+
+require_relative './reel_uk/internal/parser/coming_soon'
+require_relative './reel_uk/internal/parser/showtimes'
+require_relative './reel_uk/internal/parser/whats_on'
+require_relative './reel_uk/internal/listings'
+
+require_relative './reel_uk/cinema'
+require_relative './reel_uk/performance'
+
+# reel_uk gem
+module ReelUk
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: reel_uk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Croll
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  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: minitest-reporters
+  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: rake
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: cinebase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+description: Pull movie & cinema information from the Reel Cinemas website
+email:
+- andy@goodscary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- COMM-LICENSE
+- LICENSE
+- README.md
+- lib/reel_uk.rb
+- lib/reel_uk/cinema.rb
+- lib/reel_uk/internal/http.rb
+- lib/reel_uk/internal/listings.rb
+- lib/reel_uk/internal/parser/coming_soon.rb
+- lib/reel_uk/internal/parser/showtimes.rb
+- lib/reel_uk/internal/parser/whats_on.rb
+- lib/reel_uk/internal/title_sanitizer.rb
+- lib/reel_uk/internal/website.rb
+- lib/reel_uk/performance.rb
+- lib/reel_uk/version.rb
+homepage: https://github.com/andycroll/reel_uk
+licenses:
+- AGPL
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: It's a scraper, but a nice one
+test_files: []