cineworld_uk 2.1.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86b00dc1901b19df84e8e682816d98ab5e9767bb
-  data.tar.gz: 8429f8b142b9e928e4b2527e732a6bb15a280446
+  metadata.gz: e16ae76d133daa488243828c8b093a3517d54baa
+  data.tar.gz: 580b82b0d6317205b34d506230dd9239fbdef9b5
 SHA512:
-  metadata.gz: 73b0bccf10a7ad6ff30cc89e99bc226dcf4f5b5d774945c1aa3578af5f4f7cec38e27b95e298274c42a97fba1fdab49ff7f8bf8d51dfb1de4d4199309bfeaebe
-  data.tar.gz: d4c2fef4ac56b1eb12e8a062029bccc94709891c6a3cac842bd3a422b77b5c2820e2fc0552809419d9fd39cf7d82a1c470363769898231b921d64d38ca4f17b9
+  metadata.gz: 65c6441ae400782f81c776edbf856d3c39392419d66186faf1ed183fc0692bb01509735a1e0499e38a281af84757c0cc81e22e7bf262b52233bbf8cd2d052544
+  data.tar.gz: 785e66d627135d40e0665fb685e6890680c17e96a1de60b0f30058c894550fb1de305f06f347c6b8d2e1b80b4015b6113c423624cc363b2ac78f9c8da08a06d9

data/CHANGELOG.md

@@ -1,14 +1,33 @@
 # Change Log
-
 All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 3.0.0 - 2016-02-03
+
+The cinebase standardisation release.
+
+### Removed
+- Remove website as data source
+- Remove film concept
+
+### Added
+- Use iOS api as a data source
+
+### Changed
+- Parse cinema address from iOS api
+- Screening becomes Performance in cinebase 2.0.0
+- Parse performances & films iOS API
+- Use the `cinebase` gem to fix an common API across all gems
 
 ## 2.1.6 - 2015-05-06
 
-- [FIXED] whats on pge is the cinema url
+# Fixed
+- whats on page is the cinema url
 
 ## 2.1.5 - 2015-02-18
 
-- [FIXED] more defensive against closing cinemas
+# Fixed
+- more defensive against closing cinemas
 
 ## 2.1.4 - 2015-01-03
 

data/README.md

@@ -1,6 +1,6 @@
 # CineworldUk
 
-A simple gem to parse the [Cineworld UK website](http://cineworld.co.uk) and spit out useful formatted info.
+A simple gem to parse the [Cineworld UK](http://cineworld.co.uk) cinema times (using their iOS API) and spit out useful formatted info.
 
 [![Gem Version](https://badge.fury.io/rb/cineworld_uk.svg)](http://badge.fury.io/rb/cineworld_uk)
 [![Code Climate](https://codeclimate.com/github/andycroll/cineworld_uk.png)](https://codeclimate.com/github/andycroll/cineworld_uk)
@@ -23,32 +23,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
-CineworldUK::Cinema.all
-#=> [<CineworldUK::Cinema brand="Cineworld" name="Duke's At Komedia" slug="dukes-at-komedia" chain_id="Dukes_At_Komedia" url="...">, #=> <CineworldUK::Cinema brand="Cineworld" name="Duke o York's" slug="duke-of-yorks" chain_id="Brighton" url="...">, ...]
-
-CineworldUK::Cinema.find('3')
-#=> <CineworldUK::Cinema brand="Cineworld" name="Brighton" slug="duke-of-yorks" address="..." chain_id="Brighton" url="...">
+CineworldUk::Cinema.all
+#=> [<CineworldUK::Cinema ...>, <CineworldUK::Cinema ...>, ...]
+
+cinema = CineworldUk::Cinema.new(3)
+#=> <CineworldUK::Cinema ...>
+
+cinema.adr
+#=> {
+  street_address:   'Brighton Marina Village',
+  extended_address: nil,
+  locality:         'Brighton',
+  region:           nil,
+  postal_code:      'BN2 5UF',
+  country:          'United Kingdom'
+}
 
 cinema.brand
 #=> 'Cineworld'
 
+cinema.full_name
+#=> 'Cineworld Brighton'
+
 cinema.id
 #=> '3'
 
-cinema.films
-#=> [<CineworldUK::Film name="Iron Man 3">, <CineworldUK::Film name="Star Trek: Into Darkness">]
+cinema.postal_code
+#=> 'BN2 5UF'
+```
+
+### Performances
+
+``` ruby
+CineworldUk::Performance.at(3)
+#=> [<CineworldUK::Performance ...>, <CineworldUK::Performance ...>, ...]
+
+performance = CineworldUk::Performance.at(3).first
+#=> <CineworldUK::Performance ...>
+
+performance.film_name
+#=> 'Star Wars: The Force Awakens'
+
+performance.dimension
+#=> '2d'
+
+performance.variant
+#=> ['imax', 'kids']
+
+performance.starting_at
+#=> 2016-02-04 13:00:20 UTC
+
+performance.showing_on
+#=> #<Date: 2016-02-04 ((2457423j,0s,0n),+0s,2299161j)>
 
-cinema.screenings
-#=> [<CineworldUK::Screening film="About Time" when="2013-09-09 11:00 UTC" variant="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">, <CineworldUK::Screening ..>, <CineworldUK::Screening ...>]
+performance.booking_url
+#=> "http://www.cineworld.co.uk/booking?performance=..."
 
-cinema.screenings_of 'Iron Man 3'
-#=> [<CineworldUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" variant="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">]
+performance.cinema_name
+#=> 'Brighton'
 
-cinema.screenings_of <CineworldUK::Film name="Iron Man 3">
-#=> [<CineworldUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" variant="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" variant="kids">]
+performance.cinema_id
+#=> 3
 ```
 
 ## Contributing

data/Rakefile

@@ -7,7 +7,8 @@ Rake::TestTask.new do |t|
   t.libs << 'lib/cineworld_uk'
   t.test_files = FileList[
     'test/lib/cineworld_uk/*_test.rb',
-    'test/lib/cineworld_uk/internal/*_test.rb'
+    'test/lib/cineworld_uk/internal/*_test.rb',
+    'test/lib/cineworld_uk/internal/parser/api/*_test.rb'
   ]
   t.verbose = true
 end
@@ -21,4 +22,59 @@ task :console do
   IRB.start
 end
 
+task :fixtures do
+  require 'cineworld_uk'
+
+  def js_fixture(name)
+    File.expand_path("../test/fixtures/#{name}.json", __FILE__)
+  end
+
+  api = CineworldUk::Internal::ApiResponse.new
+
+  File.open(js_fixture('api/cinema-list'), 'w') do |file|
+    puts '* API Cinema List'
+    file.write api.cinema_list
+  end
+
+  File.open(js_fixture('api/cinema-detail-3'), 'w') do |file|
+    puts '* API Cinema Detail Brighton'
+    file.write api.cinema_detail(3)
+  end
+
+  File.open(js_fixture('api/cinema-detail-96'), 'w') do |file|
+    puts '* API Cinema Detail Birmingham NEC'
+    file.write api.cinema_detail(96)
+  end
+
+  File.open(js_fixture('api/cinema-detail-21'), 'w') do |file|
+    puts '* API Cinema Detail Edinburgh'
+    file.write api.cinema_detail(21)
+  end
+
+  File.open(js_fixture('api/cinema-detail-10'), 'w') do |file|
+    puts '* API Cinema Detail Chelsea'
+    file.write api.cinema_detail(10)
+  end
+
+  File.open(js_fixture('api/film-list'), 'w') do |file|
+    puts '* API Film List'
+    file.write api.film_list
+  end
+
+  File.open(js_fixture('api/film-list-comingsoon'), 'w') do |file|
+    puts '* API Film List Coming Soon'
+    file.write api.film_list_comingsoon
+  end
+
+  File.open(js_fixture('api/performances-tomorrow-3'), 'w') do |file|
+    puts '* API Performances in Brighton Tomorrow'
+    file.write api.performances(3, Date.today + 1)
+  end
+
+  File.open(js_fixture('api/dates-3'), 'w') do |file|
+    puts '* API Dates Brighton Tomorrow'
+    file.write api.dates(3)
+  end
+end
+
 task :default => :test

data/cineworld_uk.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'webmock'
 
+  spec.add_runtime_dependency 'cinebase', '~> 3.0.0'
   spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'tzinfo'
-  spec.add_runtime_dependency 'tzinfo-data'
 end

data/lib/cineworld_uk/cinema.rb

@@ -1,27 +1,12 @@
 module CineworldUk
   # The object representing a cinema on the Cineworld UK website
-  class Cinema
-    # @return [String] the brand of the cinema
-    attr_reader :brand
-    # @return [Integer] the numeric id of the cinema on the Cineworld 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 Cineworld website
-    attr_reader :url
-
-    # @param [Integer, String] id cinema id
-    # @param [String] name cinema name
-    # @return [CineworldUk::Cinema]
-    def initialize(id, name)
-      @brand = 'Cineworld'
-      @id    = id.to_i
-      @name  = name.gsub('London - ', '').gsub(' - ', ': ')
-      @slug  = @name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
-      @url   = "http://www.cineworld.co.uk/whatson?cinema=#{@id}"
-    end
+  class Cinema < Cinebase::Cinema
+    # @!attribute [r] id
+    #   @return [Integer] the numeric id of the cinema on the Cineworld website
+
+    # @!method initialize(id)
+    #   @param [Integer, String] id cinema id
+    #   @return [CineworldUk::Cinema]
 
     # Return basic cinema information for all cinemas
     # @return [Array<CineworldUk::Cinema>]
@@ -29,29 +14,18 @@ module CineworldUk
     #   CineworldUk::Cinema.all
     #   #=> [<CineworldUk::Cinema>, <CineworldUk::Cinema>, ...]
     def self.all
-      cinemas_doc.css('#cinemaId option[value]').map do |option|
-        new option['value'], option.text
-      end[1..-1]
+      id_names_hash.map { |id, _| new id }
     end
 
-    # Find a single cinema
-    # @param [Integer, String] id the cinema id as used on the website
-    # @return [CineworldUk::Cinema, nil]
-    # @example
-    #   CineworldUk::Cinema.find('3')
-    #   #=> <CineworldUk::Cinema brand="Cineworld"
-    #                            name="Brighton"
-    #                            slug="brighton"
-    #                            id=3
-    #                            url="...">
-    def self.find(id)
-      all.select { |cinema| cinema.id == id.to_i }[0]
-    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
     # @example
-    #   cinema = CineworldUk::Cinema.find(3)
+    #   cinema = CineworldUk::Cinema.new(3)
     #   cinema.adr
     #   #=> {
     #         street_address: '44-47 Gardner Street',
@@ -62,165 +36,122 @@ module CineworldUk
     #       }
     # @note Uses the standard method naming as at http://microformats.org/wiki/adr
     def adr
-      {
-        street_address: street_address,
-        extended_address: extended_address,
-        locality: locality,
-        region: region,
-        postal_code: postal_code,
-        country: 'United Kingdom'
-      }
+      CineworldUk::Internal::Parser::Api::CinemaAddress.new(@id).to_hash
     end
-    alias_method :address, :adr
 
-    # The second address line of the cinema
-    # @return [String, nil]
+    # Brand of the cinema
+    # @return [String] which will always be 'Cineworld'
     # @example
-    #   cinema = CineworldUk::Cinema.find(10)
-    #   cinema.extended_address
-    #   #=> 'Chelsea'
+    #   cinema = CineworldUk::Cinema.new(3)
+    #   cinema.brand
+    #   #=> 'Cineworld'
+    def brand
+      'Cineworld'.freeze
+    end
+
+    # @!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.find(3)
-    #   cinema.extended_address
-    #   #=> nil
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def extended_address
-      remaining_address * ', ' unless remaining_address.empty?
-    end
-
-    # Films with showings scheduled at this cinema
-    # @return [Array<CineworldUk::Film>]
-    # @example
-    #   cinema = CineworldUk::Cinema.find('71')
-    #   cinema.films
-    #   #=> [<CineworldUk::Film>, <CineworldUk::Film>, ...]
-    def films
-      Film.at(id)
-    end
-
-    # The name of the cinema including the brand
+    #     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 = CineworldUk::Cinema.find(88)
-    #   cinema.full_name
-    #   #=> 'Cineworld Glasgow: IMAX at GSC'
-    def full_name
-      "#{brand} #{name}"
-    end
-
-    # The locality (town) of the cinema
-    # @return [String]
-    # @example
-    #   cinema = CineworldUk::Cinema.find(3)
-    #   cinema.locality
+    #   cinema = CineworldUk::Cinema.new(3)
+    #   cinema.name
     #   #=> 'Brighton'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def locality
-      if adr_has_region? && !adr_in_london?
-        adr_array[-2]
-      else
-        adr_array[-1]
-      end
-    end
-
-    # Post code of the cinema
+    def name
+      @name ||= self.class.id_names_hash[id]
+    end
+
+    # @!method postal_code
+    #   Post code of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = CineworldUk::Cinema.new(3)
+    #     cinema.postal_code
+    #     #=> 'BN2 5UF'
+
+    # @!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]
-    # @example
-    #   cinema = CineworldUk::Cinema.find(3)
-    #   cinema.postal_code
-    #   #=> 'BN2 5UF'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def postal_code
-      return unless last_adr_line_array[-2..-1]
-      last_adr_line_array[-2..-1] * ' '
-    end
-
-    # The region (county) of the cinema if provided
-    # @return [String, nil]
-    # @example
-    #   cinema = CineworldUk::Cinema.find(3)
-    #   cinema.region
-    #   #=> 'East Sussex'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def region
-      last_adr_line_non_postal_code if adr_has_region? && !adr_in_london?
-    end
-
-    # All planned screenings
-    # @return [Array<CineworldUk::Screening>]
-    # @example
-    #   cinema = CineworldUk::Cinema.find(3)
-    #   cinema.screenings
-    #   # => [<CineworldUk::Screening>, <CineworldUk::Screening>, ...]
-    def screenings
-      Screening.at(id)
-    end
-
-    # The street adress of the cinema
-    # @return a String
-    # @example
-    #   cinema = CineworldUk::Cinema.find(3)
-    #   cinema.street_address
-    #   #=> 'Brighton Marina'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def street_address
-      adr_parts[0]
+    def url
+      "http://www.cineworld.co.uk/cinemas/#{@id}/information"
     end
 
     private
 
-    def self.cinemas_doc
-      @cinemas_doc ||= Nokogiri::HTML(website.cinemas)
-    end
-
-    def self.website
-      @website ||= CineworldUk::Internal::Website.new
-    end
-
-    def adr_array
-      adr_parts[0..-2] << last_adr_line_non_postal_code
-    end
-
-    def adr_content
-      information_doc.css('address.marker').to_s
+    # @api private
+    def self.api
+      @api ||= CineworldUk::Internal::ApiResponse.new
     end
 
-    def adr_parts
-      @parts ||= begin
-        return [] unless adr_content
-        out = adr_content.split('<br>')[-2]
-        return [] unless out
-        out.split(',').map(&:strip)
-      end
-    end
-
-    def adr_in_london?
-      last_adr_line_non_postal_code == 'London'
-    end
-
-    def adr_has_region?
-      last_adr_line_non_postal_code != name
-    end
-
-    def last_adr_line_array
-      return [] unless adr_parts[-1]
-      adr_parts[-1].split(' ')
-    end
-
-    def last_adr_line_non_postal_code
-      last_adr_line_array[0..-3] * ' '
-    end
-
-    def information_doc
-      @information_doc ||= begin
-        info = CineworldUk::Internal::Website.new.cinema_information(@id)
-        Nokogiri::HTML(info)
-      end
+    # @api private
+    def self.cinema_list_json
+      @cinema_list_json ||=
+        JSON.parse(api.cinema_list)['cinemas']
     end
 
-    def remaining_address
-      adr_array.delete_if do |e|
-        e == street_address || e == locality || e == region
+    # @api private
+    def self.id_names_hash
+      @id_names_hash ||= cinema_list_json.each_with_object({}) do |hash, result|
+        result[hash['id']] =
+          hash['name'].gsub('London - ', '').gsub(' - ', ': ')
       end
     end
   end

data/lib/cineworld_uk/internal/api_response.rb

@@ -0,0 +1,74 @@
+require 'uri'
+require 'net/http'
+
+module CineworldUk
+  # @api private
+  module Internal
+    # @api private
+    class ApiResponse
+      # Basic cinema list of ids/names
+      # @return [String] JSON encoded
+      def cinema_list
+        response('cinema/list', full: true)
+      end
+
+      # List of dates on which there are screening for this cinema id
+      # @param [Fixnum] id the id of the cinema
+      # @return [String] JSON encoded
+      def dates(id)
+        response('dates', cinema: id)
+      end
+
+      # Detail about a specific cinema
+      # @param [Fixnum] id the id of the cinema
+      # @return [String] JSON encoded
+      def cinema_detail(id)
+        response('cinema/detail', cinema: id)
+      end
+
+      # List of all currently showing films
+      # @return [String] JSON encoded
+      def film_list
+        response('film/list', full: true)
+      end
+
+      # List of all upcoming films
+      # @return [String] JSON encoded
+      def film_list_comingsoon
+        response('film/list/comingsoon', full: true)
+      end
+
+      # All screenings from a specific cinema on a specific date
+      # @param [Fixnum] cinema_id the id of the cinema
+      # @param [Date] date a single date in the future
+      # @return [String] JSON encoded
+      def performances(cinema_id, date)
+        response('performances', cinema: cinema_id,
+                                 date: date.strftime('%Y%m%d'))
+      end
+
+      private
+
+      # @api private
+      # mixin the default hash
+      DEFAULTS = { key: 'ios', territory: 'GB' }
+
+      def fetch(uri, limit = 10)
+        fail ArgumentError, 'too many HTTP redirects' if limit == 0
+
+        case response = Net::HTTP.get_response(URI(uri))
+        when Net::HTTPSuccess then response.body
+        when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+        else response.code
+        end
+      end
+
+      def response(path, hash)
+        uri = URI::HTTP.build(host:  'www2.cineworld.co.uk',
+                              path:  "/api/#{path}",
+                              query: URI.encode_www_form(hash.merge(DEFAULTS)))
+        fetch(uri)
+      end
+    end
+  end
+end