odeon_uk 3.0.6 → 4.0.0

data/lib/odeon_uk/internal/parser/api/film_lookup.rb

@@ -0,0 +1,34 @@
+module OdeonUk
+  # @api private
+  module Internal
+    module Parser
+      module Api
+        # Parses a string to derive address
+        class FilmLookup
+          # @param [Integer] cinema_id id of the cinema
+          # @return [Hash{Integer => OdeonUk::Internal::Parser::Api::Film}]
+          # contains all films keyed by id for a cinema
+          def at(cinema_id)
+            to_hash.select do |_, film_hash|
+              film_hash['sites'].include?(cinema_id)
+            end
+          end
+
+          # @return [Hash{Integer => OdeonUk::Internal::Parser::Api::Film}]
+          # contains all films & upcoming films keyed by id
+          def to_hash
+            @to_hash ||= api.each_with_object({}) do |film_hash, result|
+              result[film_hash['filmMasterId'].to_i] = film_hash
+            end
+          end
+
+          private
+
+          def api
+            @api ||= OdeonUk::Internal::ApiResponse.new.app_init['films']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odeon_uk/internal/parser/api/performance_day.rb

@@ -0,0 +1,92 @@
+module OdeonUk
+  # @api private
+  module Internal
+    module Parser
+      module Api
+        # A single day of performances for a particular film
+        class PerformanceDay
+          def initialize(data)
+            @data = data
+          end
+
+          def to_a
+            performance_kinds.each_with_index.flat_map do |_, index|
+              starting_times(index).map do |time|
+                {
+                  dimension: dimension(index),
+                  starting_at: TimeParser.new(date, time).to_utc,
+                  variant: variant(index)
+                }
+              end
+            end
+          end
+
+          private
+
+          def date
+            @data['date']
+          end
+
+          def dimension(index)
+            performance_kind(index).include?('3D') ? '3d' : '2d'
+          end
+
+          def performance_kinds
+            @data['attributes']
+          end
+
+          def performance_kind(index)
+            performance_kinds[index]['attribute']
+          end
+
+          def starting_times(index)
+            performance_kinds[index]['showtimes'][0].map do |h|
+              h['performanceTime']
+            end
+          end
+
+          def variant(index)
+            {
+              'Culture'       => 'arts',
+              'Kids'          => 'kids',
+              'IMAX'          => 'imax',
+              'Newbies'       => 'baby',
+              'Silver Cinema' => 'senior'
+            }.select { |k, _| performance_kind(index).include?(k) }.values.uniq
+          end
+
+          # parse a time to utc time
+          TimeParser = Struct.new(:date, :time) do
+            def to_utc
+              tz.local_to_utc(parsed_time)
+            end
+
+            private
+
+            def early_morning_screening?
+              time.match(/\A00/)
+            end
+
+            def parsed_date
+              case date
+              when 'Today'    then Time.now.strftime '%Y-%m-%d'
+              when 'Tomorrow' then (Time.now + 60 * 60 * 24).strftime '%Y-%m-%d'
+              else date.gsub('.', '').match(/\d+\s\w+\z/)[0]
+              end
+            end
+
+            def parsed_time
+              parsed_time = Time.parse("#{parsed_date} #{time} UTC")
+              # Odeon deliberately mislabel their 00:01 screenings as the day before
+              early_morning_screening? ? parsed_time + 60 * 60 * 24 : parsed_time
+            end
+
+            def tz
+              @tz ||= TZInfo::Timezone.get('Europe/London')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odeon_uk/internal/title_sanitizer.rb

@@ -3,49 +3,44 @@ module OdeonUk
   # @api private
   module Internal
     # Sanitize and standardize film titles
-    class TitleSanitizer
-      # strings and regex to be removed
-      REMOVE = [
-        /\s+[23][dD]/,                 # dimension
-        'Autism Friendly Screening -', # autism screening
-        /\ACinemagic \d{1,4} \-/,      # cinemagic
-        /\(encore.+\)/i,               # encore for NT Live
-        /\(live\)/i,                   # live in brackets
-        'UKJFF -',                     # UK Jewish festival prefix
-        /\bsing\-?a\-?long\b/i,        # singalong
-        'Autism Friendly - ',          # autism friendly
-        'amp;',                        # html ampersands
-      ]
+    class TitleSanitizer < Cinebase::TitleSanitizer
+      # @!method initialize(title)
+      #   Constructor
+      #   @param [String] title a film title
+      #   @return [CineworldUk::Internal::TitleSanitizer]
 
-      # regexes and their replacements
-      REPLACE = {
-        /Bolshoi - (.*)/               => 'Bolshoi: ',
-        /Globe On Screen: (.*)/        => 'Globe: ',
-        /Met Opera - (.*)/             => 'Met Opera: ',
-        /National Theatre Live - (.*)/ => 'National Theatre: ',
-        /NT Live - (.*)/               => 'National Theatre: ',
-        /ROH - (.*)/                   => 'Royal Opera House: ',
-        /(.*)\- RSC Live \d{1,4}/      => 'Royal Shakespeare Company: '
-      }
+      # @!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+[23][dD]/,                 # dimension
+          'Autism Friendly Screening -', # autism screening
+          /\ACinemagic \d{1,4} \-/,      # cinemagic
+          /\(encore.+\)/i,               # encore for NT Live
+          /\(live\)/i,                   # live in brackets
+          'UKJFF -',                     # UK Jewish festival prefix
+          /\bsing\-?a\-?long\b/i,        # singalong
+          'Autism Friendly - ',          # autism friendly
+          'amp;',                        # html ampersands
+        ]
       end
 
-      # sanitized and standardized title
-      # @return [String] title
-      def sanitized
-        @sanitzed ||= begin
-          sanitized = @title
-          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
+        {
+          /Bolshoi - (.*)/               => 'Bolshoi: ',
+          /Globe On Screen: (.*)/        => 'Globe: ',
+          /Met Opera - (.*)/             => 'Met Opera: ',
+          /National Theatre Live - (.*)/ => 'National Theatre: ',
+          /NT Live - (.*)/               => 'National Theatre: ',
+          /ROH - (.*)/                   => 'Royal Opera House: ',
+          /(.*)\- RSC Live \d{1,4}/      => 'Royal Shakespeare Company: '
+        }
       end
     end
   end

data/lib/odeon_uk/performance.rb

@@ -0,0 +1,87 @@
+module OdeonUk
+  # The object representing a single screening of a film on the Odeon 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
+
+    # All currently listed films showing at a cinema
+    # @param [Integer] cinema_id id of the cinema on the website
+    # @return [Array<OdeonUk::Performance>]
+    def self.at(cinema_id)
+      film_ids_at(cinema_id).flat_map do |film_id|
+        api_response.film_times(cinema_id, film_id).flat_map do |day|
+          performance_days(day).map do |hash|
+            new(hash.merge(cinema_hash(cinema_id))
+                    .merge(film_name: film_name(film_id)))
+          end
+        end
+      end
+    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.api_response
+      @api_response ||= OdeonUk::Internal::ApiResponse.new
+    end
+    private_class_method :api_response
+
+    def self.cinema_hash(cinema_id)
+      { cinema_id: cinema_id, cinema_name: Cinema.new(cinema_id).name }
+    end
+    private_class_method :cinema_hash
+
+    def self.films_at(cinema_id)
+      film_lookup.at(cinema_id)
+    end
+    private_class_method :films_at
+
+    def self.film_lookup
+      @film_lookup ||= OdeonUk::Internal::Parser::Api::FilmLookup.new
+    end
+    private_class_method :film_lookup
+
+    def self.film_ids_at(cinema_id)
+      films_at(cinema_id).keys
+    end
+    private_class_method :film_ids_at
+
+    def self.film_name(film_id)
+      film_lookup.to_hash[film_id]['title']
+    end
+    private_class_method :film_name
+
+    def self.performance_days(data)
+      OdeonUk::Internal::Parser::Api::PerformanceDay.new(data).to_a
+    end
+    private_class_method :performance_days
+  end
+end

data/lib/odeon_uk/version.rb

@@ -1,6 +1,6 @@
 # Ruby interface for http://www.odeon.co.uk
-# @version 3.0.6
+# @version 4.0.0
 module OdeonUk
   # Gem version
-  VERSION = '3.0.6'
+  VERSION = '4.0.0'.freeze
 end

data/odeon_uk.gemspec

@@ -1,29 +1,27 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'odeon_uk/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "odeon_uk"
-  gem.version       = OdeonUk::VERSION
-  gem.authors       = ["Andy Croll"]
-  gem.email         = ["andy@goodscary.com"]
-  gem.description   = %q{An API to pull movie information from the ODEON.co.uk website}
-  gem.summary       = %q{It's a scraper, but a nice one}
-  gem.homepage      = "http://github.com/andycroll/odeon_uk"
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = 'odeon_uk'
+  spec.version       = OdeonUk::VERSION
+  spec.authors       = ['Andy Croll']
+  spec.email         = ['andy@goodscary.com']
+  spec.description   = 'Pull movie & cinema information from the Odeon iOS API'
+  spec.summary       = "It's a scraper, but a nice one"
+  spec.homepage      = 'http://github.com/andycroll/odeon_uk'
+  spec.licenses      = %w(AGPL MIT)
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'minitest-reporters'
-  gem.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock'
 
-  gem.add_runtime_dependency 'CFPropertyList'
-  gem.add_runtime_dependency 'nokogiri'
-  gem.add_runtime_dependency 'tzinfo'
-  gem.add_runtime_dependency 'tzinfo-data'
+  spec.add_runtime_dependency 'CFPropertyList'
+  spec.add_runtime_dependency 'cinebase', '~> 3.0'
 end

data/rake/fixture_creator.rb

@@ -9,7 +9,7 @@ module FixtureCreator
     end
 
     def film_times!(cinema_id)
-      OdeonUk::Api::Screenings.send(:film_ids, cinema_id).each do |i|
+      OdeonUk::Performance.send(:film_ids_at, cinema_id).each do |i|
         write_film_times_fixture(cinema_id, i)
       end
     end
@@ -29,9 +29,9 @@ module FixtureCreator
       text = "film_times/#{cinema_id}-#{film_id}"
       File.open(fixture(text), 'w+') do |file|
         log(text)
-        file.write OdeonUk::Api::Response.new.send(:film_times_raw,
-                                                   cinema_id,
-                                                   film_id)
+        file.write OdeonUk::Internal::ApiResponse.new.send(:film_times_raw,
+                                                           cinema_id,
+                                                           film_id)
       end
     end
 
@@ -39,59 +39,7 @@ module FixtureCreator
       FileUtils.mkdir_p kind.to_s
       File.open(fixture(kind), 'w+') do |file|
         log(kind)
-        file.write OdeonUk::Api::Response.new.send("#{kind}_raw".to_sym)
-      end
-    end
-  end
-
-  class Html < Struct.new(:cinema_id)
-    def cinema!
-      write_page_fixture(:cinema)
-    end
-
-    def film_node!(index)
-      write_node_fixture(index)
-    end
-
-    def showtimes!
-      write_page_fixture(:showtimes)
-    end
-
-    def sitemap!
-      write_page_fixture(:sitemap)
-    end
-
-    private
-
-    def fixture(name)
-      File.expand_path("../../test/fixtures/html/#{name}.html", __FILE__)
-    end
-
-    def log(message)
-      puts "Create HTML fixture: #{message}"
-    end
-
-    def write_node_fixture(index)
-      FileUtils.mkdir_p 'showtimes'
-      text = "showtimes/#{cinema_id}-#{index}"
-      File.open(fixture(text), 'w+') do |file|
-        log(text)
-        nodes = OdeonUk::Html::Screenings.send(:film_nodes, cinema_id)
-        node = if index.is_a?(Fixnum)
-          nodes[index]
-        else
-          nodes.select { |n| !!n.to_s.match(/#{index}/i) }[0]
-        end
-        file.write(node.to_s)
-      end
-    end
-
-    def write_page_fixture(kind)
-      FileUtils.mkdir_p kind.to_s
-      text = kind.to_s + (cinema_id ? "/#{cinema_id}" : '')
-      File.open(fixture(text), 'w+') do |file|
-        log(text)
-        file.write OdeonUk::Html::Website.new.send(*[kind, cinema_id].compact)
+        file.write OdeonUk::Internal::ApiResponse.new.send("#{kind}_raw".to_sym)
       end
     end
   end