picturehouse_uk 3.0.14 → 5.0.0

data/lib/picturehouse_uk/internal/title_sanitizer.rb

@@ -2,75 +2,71 @@ module PicturehouseUk
   # @api private
   module Internal
     # Sanitize and standardize film titles
-    class TitleSanitizer
-      # strings and regex to be removed
-      REMOVE = [
-        /\s\[(AS LIVE:\s*)?[ACPGU1258]+\]/, # regular certificate
-        /\s\[R18\]/,                        # R18
-        /\s+\(?[23][dD]\)?/,                # 2d or 3d from title
-        /\bIMAX\b/i,                        # imax from title
-        /\s\[NO CERT\]/,                    # no certificate
-        /\s\[TBC\]/,                        # tbc
-        /\s\[N\/A\]/i,                      # n/a
-        /\s\(Theatre\)/i,                   # (theatre)
-        /\s\[\]/,                           # blank certificate
-        /ourscreen\: /,                     # ourscreen
-        /\s\(Re(\: \d{0,4})?\)/i,           # Re-release
-        /\s\[CERT TBC\]/,                   # certificate TBC
-        /\s?\-\s?autism.*ing\s?/i,          # austim screening
-        /\s?\+\s?Q\&A\.?/i,                 # +Q&A
-        /KIDS CLUB\s*/i,                    # kids club
-        /DISCOVER TUE(sday\:)*\s*/i,        # discover tue
-        /FREE Screening\s*-\s*/i,           # free screening
-        /\s*-?\s*Big Scream\s*-?\s*/i,      # big scream
-        /\*?HOH Subtitled\*?/i,             # subtitled
-        /\s*\-?\s*Reminiscence/i,           # reminiscence
-        /\s*\-?\s*\(?Re\-issue\)?/i,        # reissue
-        /\s*-?\s*Kids\'? Club\s*-?\s*/,     # kids club
-        /\s*plus Q\&A.*/i,                  # extended Q&A
-        /Cinemania\s*[\:\-]/i,              # cinemania
-        /\@\s*komedia/i,                    # @ komedia
-        /\s*\+ panel.*/i,                   # panel
-        /toddler time\s*\:*\-*/i,           # toddler time
-        /\(.*\d{4}\)/,                      # year or captured year
-        /\bsingalong\b/i,                   # singalong
-        /\s+\-?\s*Parents \& Babies/i,      # parents and babies
-        /Subtitled\:*\s*/i,                 # subtitled
-        /\(?live\)?\z/i,                    # live
-      ]
+    class TitleSanitizer < Cinebase::TitleSanitizer
+      # @!method initialize(title)
+      #   Constructor
+      #   @param [String] title a film title
+      #   @return [CineworldUk::Internal::TitleSanitizer]
 
-      # regexes and their replacements
-      REPLACE = {
-        /Met\.? Encore:\s*(.*)/    => 'Met Opera: ',
-        /Met\.? Opera:\s*(.*)/     => 'Met Opera: ',
-        /National Theatre:\s*(.*)/ => 'NT Live: ',
-        /NT Encore:\s*(.*)/        => 'NT Live: ',
-        /NT Live:\s*(.*)/          => 'NT Live: ',
-        /ROH\.? Live:\s*(.*)/      => 'Royal Opera House: ',
-        /ROH\.? Encore:\s*(.*)/    => 'Royal Opera House: ',
-        /RSC\.? Live:\s*(.*)/      => 'Royal Shakespeare Company: ',
-        /RSC\.? Encore:\s*(.*)/    => 'Royal Shakespeare Company: ',
-        /(.*) \(Bolshoi Ballet\)/  => 'Bolshoi Ballet: '
-      }
+      # @!method sanitized
+      #   sanitized and standardized title
+      #   @return [String] sanitised title
+
+      private
 
-      # @param [String] title a film title
-      def initialize(title)
-        @title = title
+      # strings and regex to be removed
+      def remove
+        [
+          /\s\[(AS LIVE:\s*)?[ACPGU1258]+\]/, # regular certificate
+          /\s\[R18\]/,                        # R18
+          /\s+\(?[23][dD]\)?/,                # 2d or 3d from title
+          /\bIMAX\b/i,                        # imax from title
+          /\s\[NO CERT\]/,                    # no certificate
+          /\s\[TBC\]/,                        # tbc
+          /\s\[N\/A\]/i,                      # n/a
+          /\s\(Theatre\)/i,                   # (theatre)
+          /\s\[\]/,                           # blank certificate
+          /ourscreen\: /,                     # ourscreen
+          /\s\(Re(\: \d{0,4})?\)/i,           # Re-release
+          /\s\[CERT TBC\]/,                   # certificate TBC
+          /\s?\-\s?autism.*ing\s?/i,          # austim screening
+          /\s?\+\s?Q\&(amp;)*A\.?/i,          # +Q&A
+          /KIDS CLUB\s*/i,                    # kids club
+          /DISCOVER TUE(sday\:)*\s*/i,        # discover tue
+          /FREE Screening\s*-\s*/i,           # free screening
+          /\s*-?\s*Big Scream\s*-?\s*/i,      # big scream
+          /\*?HOH Subtitled\*?/i,             # subtitled
+          /\s*\-?\s*Reminiscence/i,           # reminiscence
+          /\s*\-?\s*\(?Re\-issue\)?/i,        # reissue
+          /\s*-?\s*Kids\'? Club\s*-?\s*/,     # kids club
+          /\s*plus Q\&A.*/i,                  # extended Q&A
+          /Cinemania\s*[\:\-]/i,              # cinemania
+          /\@\s*komedia/i,                    # @ komedia
+          /\s*\+ panel.*/i,                   # panel
+          /toddler time\s*\:*\-*/i,           # toddler time
+          /\(.*\d{4}\)/,                      # year or captured year
+          /\bsingalong\b/i,                   # singalong
+          /\s+\-?\s*Parents \& Babies/i,      # parents and babies
+          /Subtitled\:*\s*/i,                 # subtitled
+          /\(?live\)?\z/i,                    # live
+          /amp\;/i
+        ]
       end
 
-      # sanitized and standardized title
-      # @return [String] title
-      def sanitized
-        @sanitzed ||= begin
-          sanitized = @title.gsub('&amp;', '&')
-          REMOVE.each do |pattern|
-            sanitized.gsub! pattern, ''
-          end
-          REPLACE.each do |pattern, prefix|
-            sanitized.gsub!(pattern) { |_| prefix + $1 }
-          end
-          sanitized.squeeze(' ').strip
-        end
+      # regexes and their replacements
+      def replace
+        {
+          /Met\.? Encore:\s*(.*)/    => 'Met Opera: ',
+          /Met\.? Opera:\s*(.*)/     => 'Met Opera: ',
+          /National Theatre:\s*(.*)/ => 'NT Live: ',
+          /NT Encore:\s*(.*)/        => 'NT Live: ',
+          /NT Live:\s*(.*)/          => 'NT Live: ',
+          /ROH\.? Live:\s*(.*)/      => 'Royal Opera House: ',
+          /ROH\.? Encore:\s*(.*)/    => 'Royal Opera House: ',
+          /RSC\.? Live:\s*(.*)/      => 'Royal Shakespeare Company: ',
+          /RSC\.? Encore:\s*(.*)/    => 'Royal Shakespeare Company: ',
+          /(.*) \(Bolshoi Ballet\)/  => 'Bolshoi Ballet: '
+        }
       end
     end
   end

data/lib/picturehouse_uk/internal/website.rb

@@ -12,18 +12,10 @@ module PicturehouseUk
         get("cinema/#{id}")
       end
 
-      # get the cinema screenings page for passed id
-      # @return [String]
-      def whats_on(id)
-        get("cinema/#{id}/Whats_On")
-      rescue OpenURI::HTTPError
-        ''
-      end
-
       # get the cinema contact information page for passed id
       # @return [String]
-      def info(id)
-        get("cinema/info/#{id}")
+      def information(id)
+        get("cinema/#{id}/information")
       rescue OpenURI::HTTPError
         ''
       end
@@ -34,12 +26,18 @@ module PicturehouseUk
         get(nil)
       end
 
+      # get the cinemas listing page
+      # @return [String]
+      def cinemas
+        get("cinema")
+      end
+
       private
 
       def get(path)
         # SSL verification doesn't work on picturehouses.com
-        open("https://www.picturehouses.com/#{path}",
-             ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE).read
+        URI.open("https://www.picturehouses.com/#{path}",
+                 ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE).read
       end
     end
   end

data/lib/picturehouse_uk/performance.rb

@@ -0,0 +1,60 @@
+module PicturehouseUk
+  # A single screening of a film on the Picturehouse UK website
+  class Performance < Cinebase::Performance
+    # @!attribute [r] booking_url
+    #   @return [String] the booking URL on the cinema website
+    # @!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 [String] :film_name name of the film
+    #   @option options [Time] :starting_at listed start time of the performance
+
+    # Screenings at a single cinema
+    # @param [String] cinema_id the id of the cinema
+    # @return [Array<PicturehouseUk::Screening>]
+    def self.at(cinema_id)
+      screenings(cinema_id).map do |attributes|
+        new cinema_hash(cinema_id).merge(attributes)
+      end.uniq
+    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 (IMAX, kids, baby, senior)
+    #   @return <Array[String]>
+
+    # private
+
+    def self.cinema_hash(cinema_id)
+      {
+        cinema_id: cinema_id,
+        cinema_name: PicturehouseUk::Cinema.new(cinema_id).name
+      }
+    end
+    private_class_method :cinema_hash
+
+    def self.screenings(cinema_id)
+      PicturehouseUk::Internal::Parser::Screenings.new(cinema_id).to_a
+    end
+    private_class_method :screenings
+  end
+end

data/lib/picturehouse_uk/version.rb

@@ -1,6 +1,6 @@
 # Ruby interface for http://www.picturehouses.co.uk
-# @version 3.0.14
+# @version 5.0.0
 module PicturehouseUk
   # Gem version
-  VERSION = '3.0.14'
+  VERSION = '5.0.0'.freeze
 end

data/lib/picturehouse_uk.rb

@@ -1,17 +1,16 @@
+require 'cinebase'
 require 'nokogiri'
-require 'tzinfo'
-require 'tzinfo/data'
 
 require_relative './picturehouse_uk/version'
 
+require_relative './picturehouse_uk/internal/api'
 require_relative './picturehouse_uk/internal/parser/address'
 require_relative './picturehouse_uk/internal/parser/screenings'
 require_relative './picturehouse_uk/internal/title_sanitizer'
 require_relative './picturehouse_uk/internal/website'
 
 require_relative './picturehouse_uk/cinema'
-require_relative './picturehouse_uk/film'
-require_relative './picturehouse_uk/screening'
+require_relative './picturehouse_uk/performance'
 
 module PicturehouseUk
 end

data/picturehouse_uk.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'picturehouse_uk/version'
@@ -8,22 +7,21 @@ Gem::Specification.new do |spec|
   spec.version       = PicturehouseUk::VERSION
   spec.authors       = ['Andy Croll']
   spec.email         = ['andy@goodscary.com']
-  spec.description   = 'An API to pull movie information from the picturehouse.co.uk website'
+  spec.description   = 'API pulling information from picturehouse.com'
   spec.summary       = "It's a scraper, but a nice one"
   spec.homepage      = ''
-  spec.license       = 'MIT'
+  spec.licenses      = %w(AGPL MIT)
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 
+  spec.add_runtime_dependency 'cinebase', '~> 3.0'
   spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'tzinfo'
-  spec.add_runtime_dependency 'tzinfo-data'
 end

data/rake/fixture_creator.rb

@@ -0,0 +1,62 @@
+# Create fitures from the live website
+class FixtureCreator
+  def cinema(cinema_id)
+    %i(cinema information).each do |action|
+      write_fixture_for_cinema(cinema_id, action)
+    end
+    write_api_fixture_for_cinema(cinema_id)
+  end
+
+  def home
+    write_fixture(:home)
+  end
+
+  def cinemas
+    write_fixture(:cinemas)
+  end
+
+  private
+
+  def fixture(name)
+    File.expand_path("#{fixture_path}/#{name}.html", __FILE__)
+  end
+
+  def json_fixture(name)
+    File.expand_path("#{fixture_path}/#{name}.json", __FILE__)
+  end
+
+  def fixture_path
+    '../../test/fixtures'
+  end
+
+  def log(message)
+    puts "Create API fixture: #{message}"
+  end
+
+  def write_fixture_for_cinema(cinema_id, kind)
+    FileUtils.mkdir_p File.expand_path("#{fixture_path}/#{cinema_id}", __FILE__)
+    text = "#{cinema_id}/#{kind}"
+    File.open(fixture(text), 'w+') do |file|
+      log(text)
+      file.write PicturehouseUk::Internal::Website.new.send(kind, cinema_id)
+    end
+  end
+
+  def write_api_fixture_for_cinema(cinema_id)
+    require 'json'
+    FileUtils.mkdir_p File.expand_path("#{fixture_path}/#{cinema_id}", __FILE__)
+    text = "#{cinema_id}/get_movies"
+    File.open(json_fixture(text), 'w+') do |file|
+      log(text)
+      data = PicturehouseUk::Internal::Api.new.get_movies(cinema_id)
+      file.write JSON.pretty_generate(data)
+    end
+  end
+
+  def write_fixture(kind)
+    File.open(fixture(kind), 'w+') do |file|
+      log(kind)
+      file.write PicturehouseUk::Internal::Website.new.send(kind.to_sym)
+    end
+  end
+end