cineworld_uk 1.0.5 → 2.0.0

data/lib/cineworld_uk/internal/screening_parser.rb

@@ -0,0 +1,132 @@
+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/titleize.rb

@@ -1,15 +1,13 @@
+# encoding: UTF-8
 module CineworldUk
-
   # Internal utility classes: Do not use
   # @api private
   module Internal
-
     # @note Modified from titleize gem
     #   https://github.com/granth/titleize
     module Titleize
-
       # List of words not to capitalize unless they lead a phrase
-      SMALL_WORDS = %w{a an and as at but by en for if in of on or the to via vs vs.}
+      WORDS = %w(a an and as at but by en for if in of on or the to via vs vs.)
 
       extend self
 
@@ -27,24 +25,24 @@ module CineworldUk
       # @return [String]
       def titleize(title)
         title = title.dup
-        title.downcase! unless title[/[[:lower:]]/]  # assume all-caps need fixing
+        title.downcase! unless title[/[[:lower:]]/]  # assume all-caps fixing
 
         phrases(title).map do |phrase|
           words = phrase.split
           words.map do |word|
             def word.capitalize
               # like String#capitalize, but it starts with the first letter
-              self.sub(/[[:alpha:]].*/) {|subword| subword.capitalize}
+              sub(/[[:alpha:]].*/) { |subword| subword.capitalize }
             end
 
             case word
-            when /[[:alpha:]]\.[[:alpha:]]/  # words with dots in, like "example.com"
+            when /[[:alpha:]]\.[[:alpha:]]/  # words with dots in
               word
             when /[-‑]/  # hyphenated word (regular and non-breaking)
               word.split(/([-‑])/).map do |part|
-                SMALL_WORDS.include?(part) ? part : part.capitalize
+                WORDS.include?(part) ? part : part.capitalize
               end.join
-            when /^[[:alpha:]].*[[:upper:]]/ # non-first letter capitalized already
+            when /^[[:alpha:]].*[[:upper:]]/ # non-first letter capitalized
               word
             when /^[[:digit:]]/  # first character is a number
               word
@@ -52,31 +50,33 @@ module CineworldUk
               word.upcase
             when words.first, words.last
               word.capitalize
-            when *(SMALL_WORDS + SMALL_WORDS.map {|small| small.capitalize })
+            when *(WORDS + WORDS.map { |small| small.capitalize })
               word.downcase
             else
               word.capitalize
             end
-          end.join(" ")
-        end.join(" ")
+          end.join(' ')
+        end.join(' ')
       end
 
       # Splits a title into an array based on punctuation.
       # @param [String] title Film title
       # @return [Array<String>]
       #
-      #   "simple title"                     # => ["simple title"]
-      #   "more complicated: titling"        # => ["more complicated:", "titling"]
-      #   "even more: complicated - titling" # => ["even more:", "complicated -", "titling"]
+      #   Titleize.phrases("simple title")
+      #     #=> ["simple title"]
+      #   Titleize.phrases("more complicated: titling")
+      #     #=> ["more complicated:", "titling"]
+      #   Titleize.phrases("even more: complicated - titling")
+      #     #=> ["even more:", "complicated -", "titling"]
       def phrases(title)
-        phrases = title.scan(/.+?(?:[-:.;?!] |$)/).map {|phrase| phrase.strip }
+        phrases = title.scan(/.+?(?:[-:.;?!] |$)/).map { |phrase| phrase.strip }
 
         # rejoin phrases that were split on the '.' from a small word
         if phrases.size > 1
           phrases[0..-2].each_with_index do |phrase, index|
-            if SMALL_WORDS.include?(phrase.split.last.downcase)
-              phrases[index] << " " + phrases.slice!(index + 1)
-            end
+            next unless WORDS.include?(phrase.split.last.downcase)
+            phrases[index] << ' ' + phrases.slice!(index + 1)
           end
         end
 

data/lib/cineworld_uk/internal/website.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+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)
+        Net::HTTP.get(URI("http://www.cineworld.co.uk/#{path}"))
+      end
+    end
+  end
+end

data/lib/cineworld_uk/internal/whatson_parser.rb

@@ -0,0 +1,44 @@
+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 > .row:not(.schedule)'
+      # css selector for screenings html chunks
+      SCREENINGS_CSS = '#filter-reload > .span9 > .schedule'
+
+      # @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.each_with_index.map do |html, i|
+          html + screenings_html[i]
+        end
+      end
+
+      private
+
+      def films_html
+        whatson_doc.css(FILM_CSS).map { |n| n.to_s.gsub(/^\s+/, '') }
+      end
+
+      def screenings_html
+        whatson_doc.css(SCREENINGS_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,39 +1,84 @@
 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
-    # @return [Time] the UTC time of the screening
-    attr_reader :when
-    # @return [String] the type of screening (2D, 3D, IMAX...)
-    attr_reader :variant
 
-    # @param [String] film_name the film name
-    # @param [String] cinema_name the cinema name
-    # @param [Time] time datetime of the screening (UTC preferred)
-    # @param [String] booking_url direct link to the booking page for this screening
-    # @param [String] variant the type of showing (e.g. 3d/baby/live)
-    def initialize(film_name, cinema_name, time, booking_url=nil, variant=nil)
-      @booking_url, @cinema_name, @film_name, @variant = booking_url, cinema_name, film_name, variant
-      @when = time.utc? ? time : TZInfo::Timezone.get('Europe/London').local_to_utc(time)
+    # @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.map do |html|
+        create_for_single_film(html, cinema_id)
+      end.flatten
     end
 
     # The date of the screening
     # @return [Date]
-    def date
-      @when.to_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.split(' ').map(&:downcase).sort
+    end
+
+    private
+
+    def self.cinema_name_hash(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_name_hash(cinema_id).merge(attributes)
+      end
+    end
+
+    def self.screenings_parser(html)
+      CineworldUk::Internal::FilmWithScreeningsParser.new(html)
     end
 
-    # @deprecated Please use {#variant} instead, I can't spell
-    def varient
-      warn "Please use #variant instead, I can't spell"
-      variant
+    def self.whatson_parser(id)
+      CineworldUk::Internal::WhatsonParser.new(id)
     end
   end
 end

data/lib/cineworld_uk/version.rb

@@ -1,6 +1,6 @@
 # Ruby interface for http://www.cineworld.co.uk
-# @version 1.0.5
+# @version 2.0.0
 module CineworldUk
   # Gem version
-  VERSION = "1.0.5"
+  VERSION = '2.0.0'
 end

data/lib/cineworld_uk.rb

@@ -8,10 +8,14 @@ require_relative './cineworld_uk/version'
 require_relative './cineworld_uk/internal/film_with_screenings_parser'
 require_relative './cineworld_uk/internal/name_parser'
 require_relative './cineworld_uk/internal/titleize'
+require_relative './cineworld_uk/internal/screening_parser'
+require_relative './cineworld_uk/internal/whatson_parser'
+require_relative './cineworld_uk/internal/website'
 
 require_relative './cineworld_uk/cinema'
 require_relative './cineworld_uk/film'
 require_relative './cineworld_uk/screening'
 
+# cineworld uk gem
 module CineworldUk
 end

data/test/fixture_updater.rb

@@ -0,0 +1,64 @@
+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