odeon_uk 3.0.6 → 4.0.0

data/README.md

@@ -2,10 +2,11 @@
 
 A simple gem to parse the [Odeon UK website](http://odeon.co.uk) and spit out useful formatted info.
 
-[![Gem Version](https://badge.fury.io/rb/odeon_uk.png)](http://badge.fury.io/rb/odeon_uk)
-[![Code Climate](https://codeclimate.com/github/andycroll/odeon_uk.png)](https://codeclimate.com/github/andycroll/odeon_uk)
-[![Build Status](https://travis-ci.org/andycroll/odeon_uk.png?branch=master)](https://travis-ci.org/andycroll/odeon_uk)
-[![Inline docs](http://inch-ci.org/github/andycroll/odeon_uk.png)](http://inch-ci.org/github/andycroll/odeon_uk)
+[![Gem Version](https://badge.fury.io/rb/odeon_uk.svg)](https://badge.fury.io/rb/odeon_uk)
+[![Code Climate](https://codeclimate.com/github/andycroll/odeon_uk/badges/gpa.svg)](https://codeclimate.com/github/andycroll/odeon_uk)
+[![Test Coverage](https://codeclimate.com/github/andycroll/odeon_uk/badges/coverage.svg)](https://codeclimate.com/github/andycroll/odeon_uk/coverage)
+[![Build Status](https://travis-ci.org/andycroll/odeon_uk.svg?branch=master)](https://travis-ci.org/andycroll/odeon_uk)
+[![Inline docs](http://inch-ci.org/github/andycroll/odeon_uk.svg?branch=master)](http://inch-ci.org/github/andycroll/odeon_uk)
 
 ## Installation
 
@@ -23,48 +24,74 @@ Or install it yourself as:
 
 ## Usage
 
+The gem conforms to the API set down in the `cinebase` gem, [andycroll/cinebase](https://github.com/andycroll/cinebase), which provides a lot of useful base vocabulary and repetitive code for this series of cinema focussed gems.
+
+Performance titles are sanitized as much as possible, removing 'screening type' information and 'dimension' as well as standardising all the theatre/cultural event naming (NT Live, Royal Opera House etc).
+
 ### Cinema
 
 ``` ruby
 OdeonUk::Cinema.all
-#=> [<OdeonUk::Cinema brand="Odeon" name="Odeon Tunbridge Wells" slug="odeon-tunbridge-wells" chain_id="23" url="...">, #=> <OdeonUk::Cinema brand="Odeon" name="Odeon Brighton" slug="odeon-brighton" chain_id="71" url="...">, ...]
+#=> [<OdeonUk::Cinema ...>, <OdeonUk::Cinema ...>, ...]
 
-OdeonUk::Cinema.find_by_id('71')
-#=> <OdeonUk::Cinema brand="Odeon" name="Odeon Brighton" slug="odeon-brighton" address="..." chain_id="71" url="...">
+cinema = OdeonUk::Cinema.new(71)
+#=> <OdeonUk::Cinema ...>
 
-OdeonUk::Cinema.find_by_id(71)
-#=> <OdeonUk::Cinema brand="Odeon" name="Odeon Brighton" slug="odeon-brighton" address="..." chain_id="71" url="...">
-
-cinema = OdeonUk::Cinema.find_by_slug('odeon-brighton')
-#=> <OdeonUk::Cinema brand="Odeon" name="Odeon Brighton" slug="odeon-brighton" chain_id="71" url="...">
+cinema.adr
+#=> {
+  street_address:   'Kingswest',
+  extended_address: nil,
+  locality:         'Brighton',
+  region:           nil,
+  postal_code:      'BN1 2RE',
+  country:          'United Kingdom'
+}
 
 cinema.brand
 #=> 'Odeon'
 
-cinema.chain_id
-#=> '71'
+cinema.full_name
+#=> 'Odeon Brighton'
 
-cinema.url
-#=> "http://www.odeon.co.uk/cinemas/brighton/71/"
+cinema.id
+#=> 71
 
-cinema.films
-#=> [<OdeonUk::Film name="Iron Man 3">, <OdeonUk::Film name="Star Trek: Into Darkness">]
+cinema.postal_code
+#=> 'BN1 2RE'
+```
 
-cinema.screenings
-#=> [<OdeonUk::Screening film="About Time" when="2013-09-09 11:00 UTC" variant="3d">, <OdeonUk::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">, <OdeonUk::Screening ..>, <OdeonUk::Screening ...>]
+### Performances
 
-cinema.screenings_of 'Iron Man 3'
-#=> [<OdeonUk::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" variant="3d">, <OdeonUk::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">]
+``` ruby
+OdeonUk::Performance.at(17)
+#=> [<OdeonUk::Performance ...>, <OdeonUk::Performance ...>, ...]
 
-cinema.screenings_of <OdeonUk::Film name="Iron Man 3">
-#=> [<OdeonUk::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" variant="3d">, <OdeonUk::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">]
-```
+performance = OdeonUk::Performance.at(17).first
+#=> <OdeonUk::Performance ...>
 
-### Film
+performance.film_name
+#=> 'Star Wars: The Force Awakens'
 
-``` ruby
-OdeonUk::Film.all
-#=> [<OdeonUk::Film name="Iron Man 3" slug="iron-man-3">, <OdeonUk::Film name="Star Trek Into Darkness" slug="star-trek-into-darkness">, <OdeonUk::Film name="Captain America: The First Avenger" slug="captain-america-the-first-avenger">, <OdeonUk::Film name="Thor: The Dark World" slug="thor-the-dark-world">]
+performance.dimension
+#=> '2d'
+
+performance.variant
+#=> ['imax', 'kids']
+
+performance.starting_at
+#=> 2016-02-04 13:00:00 UTC
+
+performance.showing_on
+#=> #<Date: 2016-02-04 ((2457423j,0s,0n),+0s,2299161j)>
+
+performance.booking_url # for now
+#=> nil
+
+performance.cinema_name
+#=> 'Brighton'
+
+performance.cinema_id
+#=> 71
 ```
 
 ## Contributing
@@ -74,3 +101,5 @@ OdeonUk::Film.all
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Note that contributors assign all rights to the owner, Andy Croll ([github](http://github.com/andycroll)), of this gem.

data/Rakefile

@@ -8,8 +8,6 @@ Rake::TestTask.new do |t|
   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
@@ -26,28 +24,16 @@ task :console do
 end
 
 desc 'recreate test fixtures'
-namespace :fixtures do
+task :fixtures do
   require 'odeon_uk'
   require_relative 'rake/fixture_creator'
+  require 'fileutils'
 
-  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
+  FixtureCreator::Api.new.app_init!
+  FixtureCreator::Api.new.all_cinemas!
+  puts 'Clean folder'
+  FileUtils.rm FileList['test/fixtures/api/film_times/*.plist']
+  FixtureCreator::Api.new.film_times!(71)
 end
 
 task default: :test

data/lib/odeon_uk.rb

@@ -1,24 +1,15 @@
-require 'forwardable'
-require 'nokogiri'
-require 'tzinfo'
-require 'tzinfo/data'
+require 'cinebase'
 
 require_relative './odeon_uk/version'
-require_relative './odeon_uk/configuration'
 
+require_relative './odeon_uk/internal/api_response'
 require_relative './odeon_uk/internal/title_sanitizer'
 
-require_relative './odeon_uk/api/response'
-require_relative './odeon_uk/api/cinema'
-require_relative './odeon_uk/api/screenings'
-
-require_relative './odeon_uk/html/parser/film_with_screenings'
-require_relative './odeon_uk/html/website'
-require_relative './odeon_uk/html/cinema'
-require_relative './odeon_uk/html/screenings'
+require_relative './odeon_uk/internal/parser/api/film_lookup'
+require_relative './odeon_uk/internal/parser/api/performance_day'
 
 require_relative './odeon_uk/cinema'
-require_relative './odeon_uk/screening'
+require_relative './odeon_uk/performance'
 
 # odeon_uk gem
 module OdeonUk

data/lib/odeon_uk/cinema.rb

@@ -1,115 +1,163 @@
 module OdeonUk
   # The object representing a cinema on the Odeon UK website
-  class Cinema
-    extend Forwardable
-
-    # @return [Integer] the numeric id of the cinema on the Odeon website
-    attr_reader :id
-
-    # @!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
+  class Cinema < Cinebase::Cinema
+    # @!attribute [r] id
+    #   @return [Integer] the numeric id of the cinema on the Cineworld website
 
+    # Constructor
     # @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)
-      @id = id
+      @id = id.to_s
     end
 
     # Return basic cinema information for all cinemas
     # @return [Array<OdeonUk::Cinema>]
+    # @example
+    #   OdeonUk::Cinema.all
+    #   #=> [<OdeonUk::Cinema>, <OdeonUk::Cinema>, ...]
     def self.all
-      cinema_parser_class.ids.map { |cinema_id| new(cinema_id) }
+      cinemas_hash.keys.map { |cinema_id| new(cinema_id) }
     end
 
+    # @!method address
+    #   Address of the cinema
+    #   @return [Hash] of different address parts
+    #   @see #adr
+
     # Address of the cinema
-    # @return [Hash] of different address parts
+    # @return [Hash] contains :street_address, :extended_address,
+    # :locality, :postal_code, :country
     # @example
-    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema = OdeonUk::Cinema.new(3)
     #   cinema.adr
-    #   #=> { street_address: 'Kingswest',
+    #   #=> {
+    #         street_address: '44-47 Gardner Street',
+    #         extended_address: 'North Laine',
     #         locality: 'Brighton',
-    #         postal_code: 'BN1 2RE',
-    #         country_name: 'United Kingdom' }
+    #         postal_code: 'BN1 1UN',
+    #         country_name: 'United Kingdom'
+    #       }
+    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
     def adr
       {
-        street_address: street_address,
-        locality:       locality,
-        postal_code:    postal_code,
-        country_name:   'United Kingdom'
+        street_address:   cinema_hash['siteAddress1'],
+        extended_address: nil,
+        locality:         cinema_hash['siteAddress2'],
+        region:           nil,
+        postal_code:      cinema_hash['sitePostcode'],
+        country_name:     'United Kingdom'.freeze
       }
     end
-    alias_method :address, :adr
 
-    # @return [String] 'Odeon'
+    # Brand of the cinema
+    # @return [String] which will always be 'Odeon'
+    # @example
+    #   cinema = OdeonUk::Cinema.new(3)
+    #   cinema.brand
+    #   #=> 'Cineworld'
     def brand
-      'Odeon'
+      'Odeon'.freeze
     end
 
-    # The name of the cinema including the brand
+    # @!method country_name
+    #   Country of the cinema
+    #   @return [String] which will always be 'United Kingdom'
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.country_name
+    #     #=> 'United Kingdom'
+
+    # @!method extended_address
+    #   The second address line of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(10)
+    #     cinema.extended_address
+    #     #=> 'Chelsea'
+    #
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.extended_address
+    #     #=> ''
+
+    # @!method full_name
+    #   The name of the cinema including the brand
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(88)
+    #     cinema.full_name
+    #     #=> 'Cineworld Glasgow: IMAX at GSC'
+
+    # @!method locality
+    #   The locality (town) of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.locality
+    #     #=> 'Brighton'
+
+    # The name of the cinema
     # @return [String]
     # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.full_name
-    #   #=> 'Odeon Brighton'
-    def full_name
-      @full_name ||= "#{brand} #{name}"
-    end
-
-    # Cinema name, slightly sanitized
-    # @return [String] the name of the cinema
+    #   cinema = CineworldUk::Cinema.new(3)
+    #   cinema.name
+    #   #=> 'Brighton'
     def name
-      @name ||= cinema_parser.name.gsub('London - ', '').gsub(' - ', ': ')
+      @name ||= cinema_hash['siteName'].gsub(/\ALondon /, '').gsub(' - ', ': ')
     end
 
-    # All planned screenings
-    # @return [Array<OdeonUk::Screening>]
-    # @example
-    #   cinema = OdeonUk::Cinema.find('71')
-    #   cinema.screenings
-    #   #=> [<OdeonUk::Screening film_name="Iron Man 3" cinema_name="Brighton" when="..." variant="...">, <OdeonUk::Screening ...>]
-    def screenings
-      Screening.at(id)
-    end
+    # @!method postal_code
+    #   Post code of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.postal_code
+    #     #=> 'BN2 5UF'
 
-    # slug from the hotel name
-    # @return [String] the slug of the cinema
-    def slug
-      @slug ||= full_name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
+    # @!method region
+    #   The region (county) of the cinema if provided
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.region
+    #     #=> 'East Sussex'
+
+    # @!method slug
+    #   The URL-able slug of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.slug
+    #     #=> 'odeon-brighton'
+
+    # @!method street_address
+    #   The street address of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.street_address
+    #     #=> 'Brighton Marina'
+    #   @note Uses the standard method naming as at http://microformats.org/wiki/adr
+
+    # The url of the cinema on the Cineworld website
+    # @return [String]
+    def url
+      "http://www.odeon.co.uk/cinemas/#{urlized_name}/#{id}/"
     end
 
     private
 
-    def self.cinema_parser_class
-      OdeonUk.configuration.method == :api ? Api::Cinema : Html::Cinema
+    def self.cinemas_hash
+      @cinemas_hash ||=
+        OdeonUk::Internal::ApiResponse.new.all_cinemas.fetch('sites', {})
+    end
+
+    def cinema_hash
+      @cinema_hash ||= self.class.cinemas_hash.fetch(id, {})
     end
 
-    def cinema_parser
-      @cinema_parser ||= self.class.cinema_parser_class.new(id)
+    def urlized_name
+      name.downcase.gsub(/[^a-z0-9]/, '_')
     end
   end
 end

data/lib/odeon_uk/{api/response.rb → internal/api_response.rb}

@@ -4,11 +4,11 @@ require 'net/http'
 module OdeonUk
   # Internal utility classes: Do not use
   # @api private
-  module Api
+  module Internal
     # Utility class to make calls to the odeon website
-    class Response
+    class ApiResponse
       # iOS app API version
-      VERSION = '2.1'
+      VERSION = '2.1'.freeze
 
       # cinemas information
       # @return [Hash] decoded response of api containing cinema details