cineworld_uk 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjc5NWQ4NDdkYzUwN2NmMzRkMzBhZGZhNjM4NWRiNDQ1ZmQ0N2JmZQ==
+  data.tar.gz: !binary |-
+    ZjkxNGU0ODcwNTQyYTcxOWQxZjQ1OGE4MGUxYTc2YTQ2NzNjYzc1NQ==
+SHA512:
+  metadata.gz: !binary |-
+    MDQyNDYwMTcxYWNiZGU2ZjEzYzZkMzU1YjJkYjQzZDEzNmYyZmIxNjE0ZTFj
+    MGRhMzRmZjVkNDY4ZTVlODczMjQ3MWE0NjczZGZlZTgzOWFjOGE4M2FiZjEz
+    Y2YzOWNlMzJhMDY5NmM4YzZlMzlkYmZjNmJjNTUzMWI5MGY5Y2U=
+  data.tar.gz: !binary |-
+    YTU3ZjQ1YjM2N2RkZTI3YTRkYzlhY2UxMDYwOWE1Njg3MjBkNWEyYjU0ZjRj
+    ZGY0MWMxZDViOTUyY2NkN2NiYTBhNTVlYWM5MjE1YjcxYjkyOTlhMTQ2OWM3
+    NzljMzkyZDVjMDUyZmQ5MmUyZDNiN2MzODc3NDI5ODFhN2YwY2M=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.0.0, _6th Dec 2013_
+
+First ready-for-public release
+
+- Added changelog
+- added booking url to screenings
+- screenings created with UTC Time objects not strings
+- added cinema addresses
+- Get films and screenings out of a cinema

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cineworld_uk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andy Croll
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# CineworldUk
+
+A simple gem to parse the [Cineworld UK website](http://cineworld.co.uk) and spit out useful formatted info.
+
+[![Gem Version](https://badge.fury.io/rb/cineword_uk.png)](http://badge.fury.io/rb/cineworld_uk)
+[![Code Climate](https://codeclimate.com/github/andycroll/cineworld_uk.png)](https://codeclimate.com/github/andycroll/cineworld_uk)
+[![Build Status](https://travis-ci.org/andycroll/cineworld_uk.png?branch=master)](https://travis-ci.org/andycroll/cineworld_uk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cineworld_uk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cineworld_uk
+
+## Usage
+
+### 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="...">
+
+cinema.brand
+#=> 'Cineworld'
+
+cinema.id
+#=> '3'
+
+cinema.films
+#=> [<CineworldUK::Film name="Iron Man 3">, <CineworldUK::Film name="Star Trek: Into Darkness">]
+
+cinema.screenings
+#=> [<CineworldUK::Screening film="About Time" when="2013-09-09 11:00 UTC" varient="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" varient="kids">, <CineworldUK::Screening ..>, <CineworldUK::Screening ...>]
+
+cinema.screenings_of 'Iron Man 3'
+#=> [<CineworldUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" varient="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" varient="kids">]
+
+cinema.screenings_of <CineworldUK::Film name="Iron Man 3">
+#=> [<CineworldUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" varient="3d">, <CineworldUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" varient="kids">]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+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'
+  ]
+  t.verbose = true
+end
+
+task :default => :test

data/cineworld_uk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cineworld_uk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cineworld_uk"
+  spec.version       = CineworldUk::VERSION
+  spec.authors       = ["Andy Croll"]
+  spec.email         = ["andy@goodscary.com"]
+  spec.description   = %q{Cineworld cinema data}
+  spec.summary       = %q{Parses cinema and showing data from the cineworld.co.uk website}
+  spec.homepage      = "https://github.com/andycroll/cineworld_uk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rake"
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'tzinfo'
+  spec.add_runtime_dependency 'tzinfo-data'
+end

data/lib/cineworld_uk.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+require 'nokogiri'
+require 'tzinfo'
+require 'tzinfo/data'
+
+require_relative './cineworld_uk/version'
+
+require_relative './cineworld_uk/internal/film_with_screenings_parser'
+
+require_relative './cineworld_uk/cinema'
+require_relative './cineworld_uk/film'
+require_relative './cineworld_uk/screening'
+
+module CineworldUk
+end

data/lib/cineworld_uk/cinema.rb

@@ -0,0 +1,218 @@
+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 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 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 - ','')
+      @slug  = @name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
+      @url   = "http://www.cineworld.co.uk/cinemas/#{@id}/information"
+    end
+
+    # Return basic cinema information for all cinemas
+    # @return [Array<CineworldUk::Cinema>]
+    # @example
+    #   CineworldUk::Cinema.all
+    #   #=> [<CineworldUk::Cinema brand="Cineworld" name="Brighton" slug="brighton" id=3 url="...">, <CineworldUk::Cinema brand="Cineworld" name="The O2, Greenwich" slug="the-o2-greenwich" url="...">, ...]
+    def self.all
+      parsed_cinemas.css('#cinemaId option[value]').map do |option|
+        new option['value'], option.text
+      end[1..-1]
+    end
+
+    # Find a single cinema
+    # @param [Integer, String] id the cinema id of the format 3/'3' as used on the cineworld.co.uk 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)
+      id = id.to_i
+      return nil unless id > 0
+
+      all.select { |cinema| cinema.id == id }[0]
+    end
+
+    # Address of the cinema
+    # @return [Hash] of different address parts
+    # @example
+    #   cinema = CineworldUk::Cinema.find('Dukes_At_Komedia')
+    #   cinema.adr
+    #   #=> { street_address: '44-47 Gardner Street', extended_address: 'North Laine', locality: 'Brighton', 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,
+        extended_address: extended_address,
+        locality: locality,
+        region: region,
+        postal_code: postal_code,
+        country: 'United Kingdom'
+      }
+    end
+    alias_method :address, :adr
+
+    # The second address line of the cinema
+    # @return [String, nil]
+    # @example
+    #   cinema = CineworldUk::Cinema.find(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<OdeonUk::Film>]
+    # @example
+    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema.films
+    #   #=> [<OdeonUk::Film name="Iron Man 3">, <OdeonUk::Film name="Star Trek Into Darkness">]
+    def films
+      film_nodes.map do |node|
+        parser = CineworldUk::Internal::FilmWithScreeningsParser.new node.to_s
+        parser.film_name.length > 0 ? CineworldUk::Film.new(parser.film_name) : nil
+      end.compact.uniq
+    end
+
+    # The locality (town) of the cinema
+    # @return [String]
+    # @example
+    #   cinema = CineworldUk::Cinema.find(3)
+    #   cinema.locality
+    #   #=> 'Brighton'
+    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
+    def locality
+      adr_has_region? && !adr_in_london? ? final_address_array[-2] : final_address_array[-1]
+    end
+
+    # Post code of the cinema
+    # @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
+      final_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
+      final_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 film_name="Iron Man 3" cinema_name="Brighton" when="..." varient="...">, <CineworldUk::Screening ...>]
+    def screenings
+      film_nodes.map do |node|
+        parser = CineworldUk::Internal::FilmWithScreeningsParser.new node.to_s
+        parser.showings.map do |screening_type, times|
+          times.map do |array|
+            CineworldUk::Screening.new parser.film_name, self.name, array[0], array[1], screening_type
+          end
+        end
+      end.flatten
+    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
+      address_parts[0]
+    end
+
+    private
+
+    def self.parsed_cinemas
+      @parsed_cinemas ||= Nokogiri::HTML(cinemas_response)
+    end
+
+    def self.cinemas_response
+      @cinemas_response ||= HTTParty.get('http://www.cineworld.co.uk/cinemas')
+    end
+
+    def address_parts
+      @address_parts ||= parsed_information.css('address.marker').to_s.split('<br>')[-2].split(',').map(&:strip)
+    end
+
+    def adr_in_london?
+      final_line_non_postal_code == 'London'
+    end
+
+    def adr_has_region?
+      final_line_non_postal_code != name
+    end
+
+    def film_nodes
+      @film_nodes ||= parsed_whatson.css('.section.light #filter-reload > .span9').to_s.split('<hr>')
+    end
+
+    def final_address_array
+      address_parts[0..-2] << final_line_non_postal_code
+    end
+
+    def final_line_array
+      address_parts[-1].split(' ')
+    end
+
+    def final_line_non_postal_code
+      final_line_array[0..-3]*' '
+    end
+
+    def information_response
+      @information_response ||= HTTParty.get("http://www.cineworld.co.uk/cinemas/#{@id}/information")
+    end
+
+    def parsed_information
+      @parsed_information ||= Nokogiri::HTML(information_response)
+    end
+
+    def parsed_whatson
+      @parsed_whatson ||= Nokogiri::HTML(whatson_response)
+    end
+
+    def remaining_address
+      final_address_array.delete_if { |e| e == street_address || e == locality || e == region }
+    end
+
+    def whatson_response
+      @whatson_response ||= HTTParty.get("http://www.cineworld.co.uk/whatson?cinema=#{@id}")
+    end
+  end
+end

data/lib/cineworld_uk/film.rb

@@ -0,0 +1,47 @@
+module CineworldUk
+
+  # The object representing a film on the Cineworld UK website
+  class Film
+    include Comparable
+
+    # @return [String] the name of the film
+    attr_reader :name
+    # @return [String] the normalized slug derived from the film name
+    attr_reader :slug
+
+    # @param [String] name the film name
+    # @return [CineworldUk::Film]
+    def initialize(name)
+      @name = name
+      @slug = name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
+    end
+
+    # Allows sort on objects
+    # @param [CineworldUk::Film] other another film object
+    # @return [Integer] -1, 0 or 1
+    def <=> other
+      self.slug <=> other.slug
+    end
+
+    # Check an object is the same as another object.
+    # @param [CineworldUk::Film] other another film
+    # @return [Boolean] True if both objects are the same exact object, or if
+    #   they are of the same type and share an equal slug
+    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
+    def eql? other
+      self.class == other.class && self == other
+    end
+
+    # Generates hash of slug in order to allow two records of the same type and
+    # id to work with something like:
+    #
+    #   [ Film.new('ABC'), Film.new('DEF') ] & [ Film.new('DEF'), Film.new('GHI') ]
+    #   #=> [ Film.new('DEF') ]
+    #
+    # @return [Integer] hash of slug
+    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
+    def hash
+      self.slug.hash
+    end
+  end
+end