odeon_uk 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb0f0e0ede5e635b08ea320250268c0788e200cf
-  data.tar.gz: 997af2dfe1fb2d36ac715f807ae996d105c868d3
+  metadata.gz: 012176725c0f9d576455a7bbefd6da08dd415f43
+  data.tar.gz: 482cbfad8d2372243a791074fa356293098a3e90
 SHA512:
-  metadata.gz: 38beb6721c4ec3c38ea9764177cd08836d18ab6cb8f9325f3fdb1a0c17206a219933cd4c27db44cb2b688c6224c27e2de6dd644ba82f73218be7469f1a6df660
-  data.tar.gz: e70416c3e33a8e0600fcdf62bce224fd3cbc7a4f3c9a8241f7dc7fc27b53a61a6197dbb9809ee1fb87ef2d425fd84d7a30336a51ba0951e2c62cb101ba920e7b
+  metadata.gz: 36489dec0d6411c706399f4e64afdac6c12497ff86e2afc91865a6211b117985fddd52f68329a2786f88f11b574f3bf254bfdf928b146ad4bf140e004a591eee
+  data.tar.gz: 9c6e62a13a0201e4d83314a4818debfea7b08ee423f74970cb0f436eb62c40b13b0a3d148faa9a6e62f4cdf7bd8c052111354f9bb60fed5fdd1c63218cf5e53d

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.2
+  - 2.1.5
+  - 2.2.1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.0.0 - 2015-03-15
+
+- complete internal re-architecture ready for use of API
+- include API source
+- remove Film model (not used)
+
 ## 2.0.4 - 2015-02-18
 
 - protect against unopened cinemas

data/Rakefile

@@ -7,12 +7,16 @@ Rake::TestTask.new do |t|
   t.libs << 'lib/odeon_uk'
   t.test_files = FileList[
     'test/lib/odeon_uk/*_test.rb',
+    'test/lib/odeon_uk/api/*_test.rb',
+    'test/lib/odeon_uk/html/*_test.rb',
+    'test/lib/odeon_uk/html/parser/*_test.rb',
     'test/lib/odeon_uk/internal/*_test.rb'
   ]
   t.verbose = true
 end
 
 # http://erniemiller.org/2014/02/05/7-lines-every-gems-rakefile-should-have/
+desc 'run gem console'
 task :console do
   require 'irb'
   require 'irb/completion'
@@ -21,4 +25,29 @@ task :console do
   IRB.start
 end
 
+desc 'recreate test fixtures'
+namespace :fixtures do
+  require 'odeon_uk'
+  require_relative 'rake/fixture_creator'
+
+  desc 'html'
+  task :html do
+    FixtureCreator::Html.new(nil).sitemap!
+    FixtureCreator::Html.new(71).cinema!        # brighton
+    FixtureCreator::Html.new(211).cinema!       # bfi imax
+    FixtureCreator::Html.new(105).cinema!       # leceister square
+    FixtureCreator::Html.new(71).showtimes!
+    FixtureCreator::Html.new(71).film_node!(0)
+    FixtureCreator::Html.new(11).film_node!('imax')   # manchester imax
+    FixtureCreator::Html.new(171).film_node!('d-box') # liverpool dbox
+  end
+
+  desc 'api'
+  task :api do
+    FixtureCreator::Api.new.app_init!
+    FixtureCreator::Api.new.all_cinemas!
+    FixtureCreator::Api.new.film_times!(71)
+  end
+end
+
 task default: :test

data/lib/odeon_uk/api/cinema.rb

@@ -0,0 +1,62 @@
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Api
+    # The object representing a cinema on the Odeon UK website
+    class Cinema
+      # @return [Integer] the numeric id of the cinema via the API
+      attr_reader :id
+
+      # @param [Integer, String] id cinema id
+      # @return [OdeonUk::Cinema]
+      def initialize(id)
+        @id = id.to_i
+      end
+
+      # Return basic cinema information for all cinemas
+      # @return [Array<OdeonUk::Cinema>]
+      def self.ids
+        cinemas_hash.keys.map(&:to_i)
+      end
+
+      # The locality (town) of the cinema
+      # @return [String]
+      def locality
+        cinema_hash['siteAddress2']
+      end
+
+      # The name of the cinema
+      # @return [String]
+      def name
+        cinema_hash['siteName']
+      end
+
+      # The url of the cinema
+      # @return [Nil]
+      def url
+      end
+
+      # Post code of the cinema
+      # @return [String]
+      def postal_code
+        cinema_hash['sitePostcode']
+      end
+
+      # The street adress of the cinema
+      # @return [String]
+      def street_address
+        cinema_hash['siteAddress1']
+      end
+
+      private
+
+      def self.cinemas_hash
+        @@cinemas_hash ||= Api::Response.new.all_cinemas['data']['sites']
+      end
+
+      def cinema_hash
+        @cinema_hash ||= self.class.cinemas_hash[id.to_s]
+      end
+    end
+  end
+end

data/lib/odeon_uk/api/response.rb

@@ -0,0 +1,55 @@
+require 'cfpropertylist'
+require 'net/http'
+
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Api
+    # Utility class to make calls to the odeon website
+    class Response
+      VERSION = '2.1'
+
+      # cinemas information
+      # @return [Hash] decoded response of api containing cinema details
+      def all_cinemas
+        parse(all_cinemas_raw)
+      end
+
+      # application initialize
+      # @return [Hash] decoded response of api, mostly films
+      def app_init
+        parse(app_init_raw)
+      end
+
+      # showings for a film at a cinema
+      # @return [Hash] decoded response of api, day split times
+      def film_times(cinema_id, film_id)
+        parse(film_times_raw(cinema_id, film_id))
+      end
+
+      private
+
+      def all_cinemas_raw
+        post('all-cinemas').body
+      end
+
+      def app_init_raw
+        post('app-init').body
+      end
+
+      def film_times_raw(cinema_id, film_id)
+        post('film-times', { s: cinema_id, m: film_id }).body
+      end
+
+      def post(path, request_body={})
+        uri = URI("https://api.odeon.co.uk/#{VERSION}/api/#{path}")
+        Net::HTTP.post_form(uri, request_body)
+      end
+
+      def parse(content)
+        plist = CFPropertyList::List.new(data: content)
+        CFPropertyList.native_types(plist.value).fetch('data', {})
+      end
+    end
+  end
+end

data/lib/odeon_uk/api/screenings.rb

@@ -0,0 +1,89 @@
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Api
+    # The object representing a single screening of a film via the Odeon UK api
+    class Screenings
+      # All currently listed screenings at a cinema
+      # @param [Integer] cinema_id id of the cinema
+      # @return [Array<Hash>]
+      def self.at(cinema_id)
+        film_ids(cinema_id).flat_map do |film_id|
+          times_response = response.film_times(cinema_id, film_id)
+
+          times_response.flat_map do |day|
+            date =         day['date']
+            screenings =   day['attributes']
+
+            screenings.flat_map do |screening|
+              performances = screening['showtimes']
+
+              performances.flat_map do |p|
+                {
+                  dimension: screening['attribute'].include?('3D') ? '3d' : '2d',
+                  film_name: films_map(cinema_id)[film_id],
+                  time:      TimeParser.new(date, p[0]['performanceTime']).to_utc,
+                  variant:   '',
+                }
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def self.app_init
+        @@app_init ||= Response.new.app_init
+      end
+
+      def self.film_ids(cinema_id)
+        films_map(cinema_id).keys
+      end
+
+      def self.films_map(cinema_id)
+        films_at(cinema_id).each_with_object({}) do |f, result|
+          result[f['filmMasterId']] = f['title']
+        end
+      end
+
+      def self.films_at(cinema_id)
+        app_init['films'].select { |f| f['sites'].include?(cinema_id) }
+      end
+
+      def self.response
+        @@response ||= Response.new
+      end
+    end
+
+    TimeParser = Struct.new(:date, :time) do
+      def to_utc
+        tz.local_to_utc(parsed_time)
+      end
+
+      private
+
+      def early_morning_screening?
+        !!time.match(/\A0/)
+      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

data/lib/odeon_uk/cinema.rb

@@ -1,49 +1,49 @@
 module OdeonUk
   # The object representing a cinema on the Odeon UK website
   class Cinema
-    # @return [String] the brand of the cinema
-    attr_reader :brand
+    extend Forwardable
+
     # @return [Integer] the numeric id of the cinema on the Odeon website
     attr_reader :id
-    # @return [String] the name of the cinema
-    attr_reader :name
-    # @return [String] the slug of the cinema
-    attr_reader :slug
-    # @return [String] the url of the cinema on the Odeon website
-    attr_reader :url
 
-    # @param [Integer, String] id cinema id
-    # @param [String] name cinema name
-    # @param [String] url url on Odeon website
+    # @!method locality
+    #   The locality (town) of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = OdeonUk::Cinema.find('71')
+    #     cinema.locality
+    #     #=> 'Brighton'
+    # @!method postal_code
+    #   Post code of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = OdeonUk::Cinema.find('71')
+    #     cinema.postal_code
+    #     #=> 'BN1 2RE'
+    # @!method street_address
+    #   The street adress of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = OdeonUk::Cinema.find('71')
+    #     cinema.street_address
+    #     #=> 'Kingswest'
+    # @!method url
+    #   Website URI for the cinema
+    #   @return [String] the url of the cinema on the Odeon website
+    def_delegators :cinema_parser, :locality, :postal_code, :street_address,
+                                   :url
+
+    # @param [Integer, String] id the cinema id of the format 71/'71' as used on
+    # the odeon.co.uk website
     # @return [OdeonUk::Cinema]
-    def initialize(id, name, url)
-      @brand = 'Odeon'
-      @id    = id.to_i
-      @name  = name.gsub('London - ', '').gsub(' - ', ': ')
-      @slug  = @name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
-      @url   = (url[0] == '/') ? "http://www.odeon.co.uk#{url}" : url
+    def initialize(id)
+      @id = id
     end
 
     # Return basic cinema information for all cinemas
     # @return [Array<OdeonUk::Cinema>]
     def self.all
-      cinema_links.map do |link|
-        new_from_link link
-      end
-    end
-
-    # Find a single cinema
-    # @param [Integer, String] id the cinema id of the format 71/'71' as used on
-    # the odeon.co.uk website
-    # @return [OdeonUk::Cinema, nil]
-    # @example
-    #   OdeonUk::Cinema.find('71')
-    #   #=> <OdeonUk::Cinema brand="Odeon" name="Brighton" slug="brighton" ...>
-    def self.find(id)
-      id = id.to_i
-      return nil unless id > 0
-
-      all.select { |cinema| cinema.id == id }[0]
+      cinema_parser_class.ids.map { |cinema_id| new(cinema_id) }
     end
 
     # Address of the cinema
@@ -58,17 +58,16 @@ module OdeonUk
     def adr
       {
         street_address: street_address,
-        locality: locality,
-        postal_code: postal_code,
-        country: 'United Kingdom'
+        locality:       locality,
+        postal_code:    postal_code,
+        country_name:   'United Kingdom'
       }
     end
     alias_method :address, :adr
 
-    # Films with showings scheduled at this cinema
-    # @return [Array<OdeonUk::Film>]
-    def films
-      Film.at(id)
+    # @return [String] 'Odeon'
+    def brand
+      'Odeon'
     end
 
     # The name of the cinema including the brand
@@ -78,29 +77,13 @@ module OdeonUk
     #   cinema.full_name
     #   #=> 'Odeon Brighton'
     def full_name
-      "#{brand} #{name}"
-    end
-
-    # The locality (town) of the cinema
-    # @return [String]
-    # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.locality
-    #   #=> 'Brighton'
-    def locality
-      return unless address_node
-      address_node.text.match(/\w+(\s\w+){0,}\s+(\w+(\s\w+){0,})/)[2]
+      @full_name ||= "#{brand} #{name}"
     end
 
-    # Post code of the cinema
-    # @return [String]
-    # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.postal_code
-    #   #=> 'BN1 2RE'
-    def postal_code
-      return unless address_node
-      address_node.text.match(/[A-Z]{1,2}\d{1,2}[A-Z]?\s\d{1,2}[A-Z]{1,2}/)[0]
+    # Cinema name, slightly sanitized
+    # @return [String] the name of the cinema
+    def name
+      @name ||= cinema_parser.name.gsub('London - ', '').gsub(' - ', ': ')
     end
 
     # All planned screenings
@@ -113,64 +96,20 @@ module OdeonUk
       Screening.at(id)
     end
 
-    # Screenings for particular film
-    # @param [OdeonUk::Film, String] film a film object or title of the film
-    # @return [Array<Odeon::Screening>]
-    # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.screenings_of('Iron Man 3')
-    #   #=> [<OdeonUk::Screening film_name="Iron Man 3" cinema_name="Brighton" when="..." variant="...">, <OdeonUk::Screening ...>]
-    #   iron_man_3 = OdeonUk::Film.new "Iron Man 3"
-    #   cinema.screenings_of(iron_man_3)
-    #   #=> [<OdeonUk::Screening film_name="Iron Man 3" cinema_name="Brighton" when="..." variant="...">, <OdeonUk::Screening ...>]
-    def screenings_of film
-      film_name = (film.is_a?(OdeonUk::Film) ? film.name : film)
-      screenings.select { |s| s.film_name == film_name }
-    end
-
-    # The street adress of the cinema
-    # @return a String
-    # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.street_address
-    #   #=> 'Kingswest'
-    def street_address
-      return unless address_node
-      address_node.text.match(/\A\s+(\w+(\s\w+){0,})/)[1]
+    # slug from the hotel name
+    # @return [String] the slug of the cinema
+    def slug
+      @slug ||= full_name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
     end
 
     private
 
-    def self.cinema_links
-      links = parsed_sitemap.css('.sitemap a[href*=cinemas]')
-      links.select { |link| link.get_attribute('href').match(/\/\d+\/$/) }
-    end
-
-    def self.new_from_link(link)
-      url  = link.get_attribute('href')
-      id   = url.match(/\/(\d+)\/$/)[1]
-      name = link.children.first.to_s
-      new id, name, url
-    end
-
-    def self.parsed_sitemap
-      Nokogiri::HTML(sitemap_response)
-    end
-
-    def self.sitemap_response
-      @sitemap_response ||= OdeonUk::Internal::Website.new.sitemap
-    end
-
-    def address_node
-      parsed_cinema.css('.gethere .span4 .description')[0]
-    end
-
-    def cinema_response
-      @cinema_response ||= OdeonUk::Internal::Website.new.cinema(@id)
+    def self.cinema_parser_class
+      OdeonUk.configuration.method == :api ? Api::Cinema : Html::Cinema
     end
 
-    def parsed_cinema
-      Nokogiri::HTML(cinema_response)
+    def cinema_parser
+      @cinema_parser ||= self.class.cinema_parser_class.new(id)
     end
   end
 end

data/lib/odeon_uk/configuration.rb

@@ -0,0 +1,21 @@
+module OdeonUk
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :method
+
+    def initialize
+      @method = :html
+    end
+  end
+end

data/lib/odeon_uk/html/cinema.rb

@@ -0,0 +1,101 @@
+module OdeonUk
+  # Internal utility classes: Do not use
+  # @api private
+  module Html
+    # The object representing a cinema on the Odeon UK website
+    class Cinema
+      ADDRESS_REGEX = '.gethere .span4 .description'
+      ALL_LINKS =     '.sitemap a[href*=cinemas]'
+
+      # @return [Integer] the numeric id of the cinema on the Odeon website
+      attr_reader :id
+
+      # @param [Integer, String] id cinema id
+      # @return [OdeonUk::Cinema]
+      def initialize(id)
+        @id = id.to_i
+      end
+
+      # Return basic cinema information for all cinemas
+      # @return [Array<OdeonUk::Cinema>]
+      def self.ids
+        cinema_links.map { |link| id_from(link) }
+      end
+
+      # The locality (town) of the cinema
+      # @return [String]
+      def locality
+        return unless address_node
+        address_node.text.match(/\w+(\s\w+){0,}\s+(\w+(\s\w+){0,})/)[2]
+      end
+
+      # The name of the cinema
+      # @return [String]
+      def name
+        cinema_link_doc.children.first.to_s
+      end
+
+      # The web url of the cinema
+      # @return [String]
+      def url
+        @url ||= begin
+          link = cinema_link_doc.get_attribute('href')
+          (link[0] == '/') ? "http://www.odeon.co.uk#{link}" : link
+        end
+      end
+
+      # Post code of the cinema
+      # @return [String]
+      def postal_code
+        return unless address_node
+        address_node.text.match(/[A-Z]{1,2}\d{1,2}[A-Z]?\s\d{1,2}[A-Z]{1,2}/)[0]
+      end
+
+      # The street adress of the cinema
+      # @return [String]
+      def street_address
+        return unless address_node
+        address_node.text.match(/\A\s+(\w+(\s\w+){0,})/)[1]
+      end
+
+      private
+
+      def self.id_from(link)
+        link.get_attribute('href').match(/\/(\d+)\/$/)[1].to_i
+      end
+
+      def self.cinema_links
+        @@cinema_links ||= begin
+          links = sitemap_doc.css(ALL_LINKS)
+          links.select { |link| link.get_attribute('href').match(/\/\d+\/$/) }
+        end
+      end
+
+      def self.sitemap_doc
+        @@sitemap_doc ||= Nokogiri::HTML(sitemap_response)
+      end
+
+      def self.sitemap_response
+        @@sitemap_response ||= Html::Website.new.sitemap
+      end
+
+      def address_node
+        cinema_doc.css(ADDRESS_REGEX)[0]
+      end
+
+      def cinema_response
+        @cinema_response ||= Html::Website.new.cinema(id)
+      end
+
+      def cinema_doc
+        @cinema_doc ||= Nokogiri::HTML(cinema_response)
+      end
+
+      def cinema_link_doc
+        self.class.cinema_links.select do |link|
+          link.get_attribute('href').include?("/#{id}/")
+        end.first
+      end
+    end
+  end
+end