picturehouse_uk 1.0.0

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in picturehouse_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,64 @@
+# PicturehouseUk
+
+A simple gem to parse the [Picturehouse Cinemas UK website](http://picturehouses.co.uk) and spit out useful formatted info.
+
+[![Code Climate](https://codeclimate.com/github/andycroll/picturehouse_uk.png)](https://codeclimate.com/github/andycroll/picturehouse_uk)
+[![Build Status](https://travis-ci.org/andycroll/picturehouse_uk.png?branch=master)](https://travis-ci.org/andycroll/picturehouse_uk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'picturehouse_uk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install picturehouse_uk
+
+## Usage
+
+### Cinema
+
+``` ruby
+PicturehouseUK::Cinema.all
+#=> [<PicturehouseUK::Cinema brand="Picturehouse" name="Duke's At Komedia" slug="dukes-at-komedia" chain_id="Dukes_At_Komedia" url="...">, #=> <PicturehouseUK::Cinema brand="Picturehouse" name="Duke o York's" slug="duke-of-yorks" chain_id="Duke_Of_Yorks" url="...">, ...]
+
+PicturehouseUK::Cinema.find_by_id('Duke_Of_Yorks')
+#=> <PicturehouseUK::Cinema brand="Picturehouse" name="Duke_Of_Yorks" slug="duke-of-yorks" address="..." chain_id="Duke_Of_Yorks" url="...">
+
+cinema = PicturehouseUK::Cinema.find_by_slug('duke-of-yorks')
+#=> <PicturehouseUK::Cinema brand="Picturehouse" name="Duke_Of_Yorks" slug="duke-of-yorks" address="..." chain_id="Duke_Of_Yorks" url="...">
+
+cinema.brand
+#=> 'Picturehouse'
+
+cinema.chain_id
+#=> 'Duke_Of_Yorks'
+
+cinema.url
+#=> "http://www.picturehouses.co.uk/cinema/Duke_Of_Yorks/"
+
+cinema.films
+#=> [<PicturehouseUK::Film name="Iron Man 3">, <PicturehouseUK::Film name="Star Trek: Into Darkness">]
+
+cinema.screenings
+#=> [<PicturehouseUK::Screening film="About Time" when="2013-09-09 11:00 UTC" varient="3d">, <PicturehouseUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" varient="kids">, <PicturehouseUK::Screening ..>, <PicturehouseUK::Screening ...>]
+
+cinema.screenings_of 'Iron Man 3'
+#=> [<PicturehouseUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" varient="3d">, <PicturehouseUK::Screening film="Iron Man 3" when="2013-09-09 13:50 UTC" varient="kids">]
+
+cinema.screenings_of <PicturehouseUK::Film name="Iron Man 3">
+#=> [<PicturehouseUK::Screening film="Iron Man 3" when="2013-09-09 11:00 UTC" varient="3d">, <PicturehouseUK::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,20 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/picturehouse_uk'
+  t.test_files = FileList['test/lib/picturehouse_uk/*_test.rb', 'test/lib/picturehouse_uk/internal/*_test.rb']
+  t.verbose = true
+end
+
+task :build do
+  system "gem build picturehouse_uk.gemspec"
+end
+
+task :release => :build do
+  system "gem push picturehouse_uk-#{PicturehouseUk::VERSION}"
+end
+
+task :default => :test

data/lib/picturehouse_uk.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+require 'nokogiri'
+require 'tzinfo'
+require 'tzinfo/data'
+
+require_relative './picturehouse_uk/version'
+
+require_relative './picturehouse_uk/internal/film_with_screenings_parser'
+
+require_relative './picturehouse_uk/cinema'
+require_relative './picturehouse_uk/film'
+require_relative './picturehouse_uk/screening'
+
+module PicturehouseUk
+  # Your code goes here...
+end

data/lib/picturehouse_uk/cinema.rb

@@ -0,0 +1,129 @@
+module PicturehouseUk
+
+  # Public: The object representing a cinema on the Picturehouse UK website
+  class Cinema
+
+    # Public: Returns the String brand of the cinema #=> 'Picturehouse'
+    attr_reader :brand
+    # Public: Returns the String id of the cinema on the Picturehouse website
+    attr_reader :id
+    # Public: Returns the String name of the cinema
+    attr_reader :name
+    # Public: Returns the String slug of the cinema
+    attr_reader :slug
+    # Public: Returns the String url of the cinema's page on picturehouses.co.uk
+    attr_reader :url
+
+    # Public: Initialize a cinema
+    #
+    # id   - String of the cinema on the picturehouse website
+    # name - String of cinema name
+    # url  - String of cinema url on the picturehouse website
+    def initialize(id, name, url)
+      @brand = 'Picturehouse'
+      @id    = id
+      @name  = name
+      @slug  = name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
+      @url   = (url[0] == '/') ? "http://www.picturehouses.co.uk#{url}" : url
+    end
+
+    # Public: Return basic cinema information for all Picturehouse cinemas
+    #
+    # Examples
+    #
+    #   PicturehouseUk::Cinema.all
+    #   # => [<PicturehouseUK::Cinema brand="Picturehouse" name="Duke's At Komedia" slug="dukes-at-komedia" id="Dukes_At_Komedia" url="...">, #=> <PicturehouseUK::Cinema brand="Picturehouse" name="Duke o York's" slug="duke-of-yorks" id="Duke_Of_Yorks" url="...">, ...]
+    #
+    # Returns an array of hashes of cinema information.
+    def self.all
+      cinema_links.map do |link|
+        new_from_link link
+      end
+    end
+
+    # Public: Return single cinema information for an Odeon cinema
+    #
+    # string - a string representing the cinema id
+    #
+    # Examples
+    #
+    #   PicturehouseUk::Cinema.find('Dukes_At_Komedia')
+    #   # => <PicturehouseUK::Cinema brand="Picturehouse" name="Duke's At Komedia" slug="dukes-at-komedia" id="Dukes_At_Komedia" url="...">
+    #
+    # Returns an PicturehouseUk::Cinema or nil if none was found
+    def self.find(id)
+      all.select { |cinema| cinema.id == id }[0]
+    end
+
+    # Public: Returns films for an Picturehouse cinema
+    #
+    # Examples
+    #
+    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
+    #   cinema.films
+    #   # => [<PicturehouseUk::Film name="Iron Man 3">, <PicturehouseUk::Film name="Star Trek Into Darkness">]
+    #
+    # Returns an array of PicturehouseUk::Film objects
+    def films
+      film_nodes.map do |node|
+        parser = PicturehouseUk::Internal::FilmWithScreeningsParser.new node.to_s
+        PicturehouseUk::Film.new parser.film_name
+      end.uniq
+    end
+
+    # Public: Returns screenings for a Picturehouse cinema
+    #
+    # Examples
+    #
+    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
+    #   cinema.screenings
+    #   # => [<PicturehouseUk::Screening film_name="Iron Man 3" cinema_name="Duke's At Komedia" when="..." varient="...">, <PicturehouseUk::Screening ...>]
+    #
+    # Returns an array of Odeon::Screening objects
+    def screenings
+      film_nodes.map do |node|
+        parser = PicturehouseUk::Internal::FilmWithScreeningsParser.new node.to_s
+        parser.showings.map do |screening_type, times|
+          times.map do |time|
+            varient = screening_type == '2d' ? nil : screening_type
+            PicturehouseUk::Screening.new parser.film_name, self.name, time, varient
+          end
+        end
+      end.flatten
+    end
+
+    private
+
+    def self.cinema_links
+      parsed_homepage.css('#cinemalisthome .cinemas a')
+    end
+
+    def self.homepage_response
+      @homepage_response ||= HTTParty.get('http://www.picturehouses.co.uk/')
+    end
+
+    def self.new_from_link(link)
+      url  = link.get_attribute('href')
+      id   = url.match(/\/cinema\/(.+)\/$/)[1]
+      name = link.css('span:nth-child(2)').text
+      new id, name, url
+    end
+
+    def self.parsed_homepage
+      Nokogiri::HTML(homepage_response)
+    end
+
+    def cinema_response
+      @cinema_response ||= HTTParty.get(@url)
+    end
+
+    def film_nodes
+      parsed_cinema.css('.box8_content .largelist .item')
+    end
+
+    def parsed_cinema
+      Nokogiri::HTML(cinema_response)
+    end
+
+  end
+end

data/lib/picturehouse_uk/film.rb

@@ -0,0 +1,52 @@
+module PicturehouseUk
+
+  # Public: The object representing a film on the Odeon UK website
+  class Film
+    include Comparable
+
+    # Public: Returns the String name of the film
+    attr_reader :name
+    # Public: Returns the String slug of the film
+    attr_reader :slug
+
+    # Public: Allows sort on objects
+    def <=> other
+      self.slug <=> other.slug
+    end
+
+    # Public: Check an object is the same as another object.
+    #
+    # True if both objects are the same exact object, or if they are of the same
+    # type and share an equal slug
+    #
+    # Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
+    #
+    # object - object to be compared
+    #
+    # Returns Boolean
+    def eql? other
+      self.class == other.class && self == other
+    end
+
+    # Public: 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') ]
+    #
+    # Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
+    #
+    # Returns an Integer hash of the slug
+    def hash
+      self.slug.hash
+    end
+
+    # Public: Initialize a screening
+    #
+    # name - String of the film name
+    def initialize(name)
+      @name = name
+      @slug = name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
+    end
+  end
+end

data/lib/picturehouse_uk/internal/film_with_screenings_parser.rb

@@ -0,0 +1,48 @@
+module PicturehouseUk
+  module Internal
+    # Private: An object to parse a film HTML snippet
+    class FilmWithScreeningsParser
+
+      def initialize(film_html)
+        @nokogiri_html = Nokogiri::HTML(film_html)
+      end
+
+      def film_name
+        name = @nokogiri_html.css('.movielink').children.first.to_s
+
+        # screening types
+        name = name.gsub /\s\[(AS LIVE: )?[ACPGU1258]+\]/, '' # remove certificate
+        name = name.gsub /\s\[NO CERT\]/, '' # remove no certificate
+        name = name.gsub /\s\[\]/, '' # remove no certificate
+        name = name.gsub /\s+[23][dD]/, '' # remove 2d or 3d from title
+
+        # special screenings
+        name = name.gsub 'ROH. Live:', 'Royal Opera House:' # fill out Royal Opera House
+        name = name.gsub 'Met. Encore:', 'Met Opera:' # fill out Met Opera
+        name = name.gsub 'NT Encore:', 'National Theatre:' # National theatre
+        name = name.gsub 'RSC Live:', 'Royal Shakespeare Company:' # RSC
+        name = name.gsub 'RSC Encore:', 'Royal Shakespeare Company:' # RSC
+
+        name = name.squeeze(' ') # spaces compressed
+        name = name.gsub /\A\s+/, '' # remove leading spaces
+        name = name.gsub /\s+\z/, '' # remove trailing spaces
+      end
+
+      def showings
+        @nokogiri_html.css('a[epoch]').inject({}) do |result, link|
+          key = case link['class']
+            when /big_scream/ then 'baby'
+            when /kids_club|toddler_time/ then 'kids'
+            when /silver_screen/ then 'silver'
+            when /subtitled_cinema/ then 'subtitled'
+            else '2d'
+          end
+          # this is a hack because Time.at() only uses local time
+          time = Time.utc(1970)+link['epoch'].to_i
+
+          result.merge(key => (result[key] || []) << time)
+        end
+      end
+    end
+  end
+end

data/lib/picturehouse_uk/screening.rb

@@ -0,0 +1,33 @@
+module PicturehouseUk
+
+  # Public: The object representing a screening of a film on the Picturehouse UK website
+  class Screening
+
+    # Public: Returns the String name of the cinema
+    attr_reader :cinema_name
+    # Public: Returns the String name of the film
+    attr_reader :film_name
+    # Public: Returns the Time of the screening
+    attr_reader :when
+    # Public: Returns the Type of screening (3d, baby, kids, live)
+    attr_reader :varient
+
+    # Public: Initialize a screening
+    #
+    # film_name   - String of the film name
+    # cinema_name - String of the cinema name on the Picturehouse website
+    # time        - DateTime representing the time of the screening, UTC preferred
+    # varient     - String representing the type of showing (e.g. 3d/baby/live)
+    def initialize(film_name, cinema_name, time, varient=nil)
+      @cinema_name, @film_name, @varient = cinema_name, film_name, varient
+      @when = time.utc? ? time : TZInfo::Timezone.get('Europe/London').local_to_utc(time)
+    end
+
+    # Public: The Date of the screening
+    #
+    # Returns a Date
+    def date
+      @when.to_date
+    end
+  end
+end

data/lib/picturehouse_uk/version.rb

@@ -0,0 +1,3 @@
+module PicturehouseUk
+  VERSION = "1.0.0"
+end

data/picturehouse_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 'picturehouse_uk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "picturehouse_uk"
+  spec.version       = PicturehouseUk::VERSION
+  spec.authors       = ["Andy Croll"]
+  spec.email         = ["andy@goodscary.com"]
+  spec.description   = %q{An API to pull movie information from the picturehouse.co.uk website}
+  spec.summary       = %q{It's a scraper, but a nice one}
+  spec.homepage      = ""
+  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