cineworld_uk 2.1.6 → 3.0.0

data/lib/cineworld_uk/film.rb

@@ -1,65 +0,0 @@
-module CineworldUk
-  # The object representing a film on the Cineworld UK website
-  class Film
-    include Comparable
-
-    # @return [String] the name of the film
-    attr_reader :name
-    # @return [String] the normalized slug derived from the film name
-    attr_reader :slug
-
-    # @param [String] name the film name
-    # @return [CineworldUk::Film]
-    def initialize(name)
-      @name = name
-      @slug = name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
-    end
-
-    # All currently listed films showing at a cinema
-    # @param [Integer] cinema_id id of the cinema on the website
-    # @return [Array<CineworldUk::Film>]
-    def self.at(cinema_id)
-      whatson_parser(cinema_id).films_with_screenings.map do |html|
-        new(screenings_parser(html).film_name)
-      end.uniq
-    end
-
-    # Allows sort on objects
-    # @param [CineworldUk::Film] other another film object
-    # @return [Integer] -1, 0 or 1
-    def <=>(other)
-      slug <=> other.slug
-    end
-
-    # Check an object is the same as another object.
-    # @param [CineworldUk::Film] other another film
-    # @return [Boolean] True if both objects are the same exact object, or if
-    #   they are of the same type and share an equal slug
-    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
-    def eql?(other)
-      self.class == other.class && self == other
-    end
-
-    # Generates hash of slug in order to allow two records of the same type and
-    # id to work with something like:
-    #
-    #   [Film.new('ABC'), Film.new('DEF')] & [Film.new('DEF'), Film.new('GHI')]
-    #   #=> [ Film.new('DEF') ]
-    #
-    # @return [Integer] hash of slug
-    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
-    def hash
-      slug.hash
-    end
-
-    private
-
-    def self.screenings_parser(html)
-      CineworldUk::Internal::FilmWithScreeningsParser.new(html)
-    end
-
-    def self.whatson_parser(id)
-      CineworldUk::Internal::WhatsonParser.new(id)
-    end
-  end
-end

data/lib/cineworld_uk/internal/film_with_screenings_parser.rb

@@ -1,69 +0,0 @@
-module CineworldUk
-  # Internal utility classes: Do not use
-  # @api private
-  module Internal
-    # Parses a chunk of HTML to derive movie showing data
-    class FilmWithScreeningsParser
-      # css selector for film name link
-      FILM_NAME_CSS    = 'h3.h1'
-      # css selector for performances
-      PERFORMANCES_CSS = '.schedule .performances > li'
-
-      # @param [String] film_html a chunk of html
-      def initialize(film_html)
-        @film_html = film_html.to_s
-      end
-
-      # The film name
-      # @return [String]
-      def film_name
-        title_sanitizer(film_name_text.children[0].to_s)
-      end
-
-      # attributes of all the screenings
-      # @return [Array<Hash>]
-      def to_a
-        return [] unless performances_doc
-
-        performances_doc.map do |node|
-          next unless screening_parser_hash(node)
-          screening_parser_hash(node).merge(film_hash)
-        end.compact
-      end
-
-      private
-
-      def doc
-        @doc ||= Nokogiri::HTML(@film_html)
-      end
-
-      def film_hash
-        @film_hash ||= { film_name: film_name }
-      end
-
-      def film_link
-        @film_link ||= film_name_doc.css('a[href*=whatson]')
-      end
-
-      def film_name_text
-        film_link.empty? ? film_name_doc : film_link
-      end
-
-      def film_name_doc
-        @film_name_doc ||= doc.css(FILM_NAME_CSS)
-      end
-
-      def performances_doc
-        @performances_doc ||= doc.css(PERFORMANCES_CSS)
-      end
-
-      def screening_parser_hash(node)
-        ScreeningParser.new(node).to_hash
-      end
-
-      def title_sanitizer(title)
-        TitleSanitizer.new(title).sanitized
-      end
-    end
-  end
-end

data/lib/cineworld_uk/internal/screening_parser.rb

@@ -1,132 +0,0 @@
-module CineworldUk
-  # Internal utility classes: Do not use
-  # @api private
-  module Internal
-    # parse a single performance
-    class ScreeningParser
-      # regex for date in url
-      DATE_REGEX = /date\=(\d{4})(\d{2})(\d{2})/
-      # regex for time in url
-      TIME_REGEX = /time\=(\d{2})\:(\d{2})/
-
-      # css selector for dimension
-      DIMENSION_CSS = '.icon-service-2d, .icon-service-3d'
-      # css selector for baby screening
-      BABY_CSS      = '.icon-service-cb'
-      # css selector for d-box screening
-      DBOX_CSS      = '.icon-service-dx'
-      # css selector for hfr screening
-      HFR_CSS       = '.icon-service-hfr'
-      # css selector for imax screening
-      IMAX_CSS      = '.icon-service-ix'
-      # css selector for kids screening
-      KIDS_CSS      = '.icon-service-m4j'
-
-      # @param [String] html a chunk of html representing one screening
-      def initialize(html)
-        @html = html.to_s
-      end
-
-      # url to book this screening
-      # @return [String]
-      def booking_url
-        return unless bookable?
-        'http://www.cineworld.co.uk' + doc.css('a').attribute('href')
-      end
-
-      # the dimension of the screening
-      # @return [String]
-      def dimension
-        return unless bookable?
-        doc.css(DIMENSION_CSS).text.downcase
-      end
-
-      # utc time of the screening
-      # @return [Time]
-      def time
-        return unless bookable?
-        timezone.local_to_utc(Time.utc(*date_array + time_array))
-      end
-
-      # anything special about the screening
-      # @return [Array<String>]
-      # @example
-      #   Cineworld::Internal::ScreeningParser.new(html).tags
-      #   => ["imax"]
-      def variant
-        return unless bookable?
-        [baby, dbox, hfr, imax, kids].compact
-      end
-
-      # a attributes of a single screening
-      # @return [Hash]
-      # @example
-      #   Cineworld::Internal::ScreeningParser.new(html).to_hash
-      #   => {
-      #        booking_url: 'http://...',
-      #        dimension:   '2d',
-      #        time:        <Time>,
-      #        variant:     ['imax']
-      #      }
-      def to_hash
-        return unless bookable?
-        {
-          booking_url: booking_url,
-          dimension:   dimension,
-          time:        time,
-          variant:     variant
-        }
-      end
-
-      private
-
-      def baby
-        'baby' if doc.css(BABY_CSS).length > 0
-      end
-
-      def bookable?
-        @bookable ||= doc.css('a.performance').size > 0
-      end
-
-      def date_array
-        @date_array ||= performance_link_html.match(DATE_REGEX) do |match|
-          [match[1], match[2], match[3]]
-        end
-      end
-
-      def dbox
-        'dbox' if doc.css(DBOX_CSS).length > 0
-      end
-
-      def doc
-        @doc ||= Nokogiri::HTML(@html)
-      end
-
-      def hfr
-        'hfr' if doc.css(HFR_CSS).length > 0
-      end
-
-      def imax
-        'imax' if doc.css(IMAX_CSS).length > 0
-      end
-
-      def kids
-        'kids' if doc.css(KIDS_CSS).length > 0
-      end
-
-      def performance_link_html
-        @performance_link_html ||= doc.css('a.performance').to_s
-      end
-
-      def time_array
-        @time_array ||= performance_link_html.match(TIME_REGEX) do |match|
-          [match[1], match[2]]
-        end
-      end
-
-      def timezone
-        @timezone ||= TZInfo::Timezone.get('Europe/London')
-      end
-    end
-  end
-end

data/lib/cineworld_uk/internal/website.rb

@@ -1,35 +0,0 @@
-# encoding: UTF-8
-require 'open-uri'
-
-module CineworldUk
-  # Internal utility classes: Do not use
-  # @api private
-  module Internal
-    # fetches pages from the cineworld.co.uk website
-    class Website
-      # get the cinema information page for passed id
-      # @return [String]
-      def cinema_information(id)
-        get("cinemas/#{id}/information")
-      end
-
-      # get the cinemas page
-      # @return [String]
-      def cinemas
-        get('cinemas')
-      end
-
-      # get the cinema page containing all upcoming films and screenings
-      # @return [String]
-      def whatson(id)
-        get("whatson?cinema=#{id}")
-      end
-
-      private
-
-      def get(path)
-        open("http://www.cineworld.co.uk/#{path}").read
-      end
-    end
-  end
-end

data/lib/cineworld_uk/internal/whatson_parser.rb

@@ -1,36 +0,0 @@
-module CineworldUk
-  # Internal utility classes: Do not use
-  # @api private
-  module Internal
-    # Parses a chunk of HTML to derive movie showing data
-    class WhatsonParser
-      # css selector for film html chunks
-      FILM_CSS       = '#filter-reload > .span9 > .film'
-
-      # @param [Integer] cinema_id cineworld cinema id
-      def initialize(cinema_id)
-        @cinema_id = cinema_id
-      end
-
-      # break up the whats on page into individual chunks for each film
-      # @return [Array<String>] html chunks for a film and it's screenings
-      def films_with_screenings
-        films_html
-      end
-
-      private
-
-      def films_html
-        whatson_doc.css(FILM_CSS).map { |n| n.to_s.gsub(/^\s+/, '') }
-      end
-
-      def whatson
-        @whatson ||= CineworldUk::Internal::Website.new.whatson(@cinema_id)
-      end
-
-      def whatson_doc
-        @whatson_doc ||= Nokogiri::HTML(whatson)
-      end
-    end
-  end
-end

data/lib/cineworld_uk/screening.rb

@@ -1,87 +0,0 @@
-module CineworldUk
-  # The object representing a single screening on the Cineworld UK website
-  class Screening
-    # @return [String] the booking URL on the cinema website
-    attr_reader :booking_url
-    # @return [String] 2d or 3d
-    attr_reader :dimension
-    # @return [String] the cinema name
-    attr_reader :cinema_name
-    # @return [String] the film name
-    attr_reader :film_name
-
-    # @param [Hash] options options hash
-    # @option options [String] :booking_url (nil) booking 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] :time utc time of the screening
-    # @option options [Array<String>] :variant ([]) type of screening
-    def initialize(options)
-      @booking_url = options.fetch(:booking_url, nil)
-      @cinema_name = options.fetch(:cinema_name)
-      @cinema_id   = options.fetch(:cinema_id)
-      @dimension   = options.fetch(:dimension, '2d')
-      @film_name   = options.fetch(:film_name)
-      @time        = options.fetch(:time)
-      @variant     = options.fetch(:variant, [])
-    end
-
-    # All currently listed films showing at a cinema
-    # @param [Integer] cinema_id id of the cinema on the website
-    # @return [Array<CineworldUk::Screening>]
-    def self.at(cinema_id)
-      whatson_parser(cinema_id).films_with_screenings.flat_map do |html|
-        create_for_single_film(html, cinema_id)
-      end
-    end
-
-    # The date of the screening
-    # @return [Date]
-    def showing_on
-      showing_at.to_date
-    end
-
-    # The UTC time of the screening
-    # @return [Time]
-    def showing_at
-      @when ||= begin
-        if @time.utc?
-          @time
-        else
-          TZInfo::Timezone.get('Europe/London').local_to_utc(@time)
-        end
-      end
-    end
-
-    # The kinds of screening
-    # @return <Array[String]>
-    def variant
-      @variant.map(&:downcase).sort
-    end
-
-    private
-
-    def self.cinema_hash(cinema_id)
-      {
-        cinema_id: cinema_id,
-        cinema_name: CineworldUk::Cinema.find(cinema_id).name
-      }
-    end
-
-    def self.create_for_single_film(html, cinema_id)
-      screenings_parser(html).to_a.map do |attributes|
-        new cinema_hash(cinema_id).merge(attributes)
-      end
-    end
-
-    def self.screenings_parser(html)
-      CineworldUk::Internal::FilmWithScreeningsParser.new(html)
-    end
-
-    def self.whatson_parser(id)
-      CineworldUk::Internal::WhatsonParser.new(id)
-    end
-  end
-end

data/test/fixture_updater.rb

@@ -1,64 +0,0 @@
-require File.expand_path('../../lib/cineworld_uk.rb', __FILE__)
-
-def fixture(name)
-  File.expand_path("../fixtures/#{name}.html", __FILE__)
-end
-
-File.open(fixture('cinemas'), 'w') do |file|
-  puts '* Cinemas'
-  file.write CineworldUk::Internal::Website.new.cinemas
-end
-
-# BRIGHTON
-
-File.open(fixture('information/brighton'), 'w') do |file|
-  puts '* Brighton Information'
-  file.write CineworldUk::Internal::Website.new.cinema_information(3)
-end
-
-File.open(fixture('whatson/brighton'), 'w') do |file|
-  puts '* Brighton Whats On'
-  file.write CineworldUk::Internal::Website.new.whatson(3)
-end
-
-parser = CineworldUk::Internal::WhatsonParser.new(3)
-
-File.open(fixture('whatson/brighton/film_first'), 'w') do |file|
-  puts '* Brighton Main Film'
-  file.write parser.films_with_screenings[0]
-end
-
-File.open(fixture('whatson/brighton/film_second'), 'w') do |file|
-  puts '* Brighton Second Film'
-  file.write parser.films_with_screenings[1]
-end
-
-File.open(fixture('whatson/brighton/film_last'), 'w') do |file|
-  puts '* Brighton Last Film'
-  file.write parser.films_with_screenings[-1]
-end
-
-# BRISTOL
-
-File.open(fixture('information/bristol'), 'w') do |file|
-  puts '* Bristol Information'
-  file.write CineworldUk::Internal::Website.new.cinema_information(4)
-end
-
-# O2
-
-parser = CineworldUk::Internal::WhatsonParser.new(79)
-
-File.open(fixture('whatson/the-o2-greenwich/film_first'), 'w') do |file|
-  puts '* The O2 Greenwich Main Film'
-  file.write parser.films_with_screenings[0]
-end
-
-# GLASGOW IMAX
-
-parser = CineworldUk::Internal::WhatsonParser.new(88)
-
-File.open(fixture('whatson/glasgow-imax-at-gsc/film_first'), 'w') do |file|
-  puts '* Glasgow IMAX Main Film'
-  file.write parser.films_with_screenings[0]
-end