odeon_uk 1.0.0 → 1.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmYxYzliYzA4OTE4ODMzNWRkYjU2ZGM1ZGJhOGYzOGNhZWMwMGM5Mw==
+  data.tar.gz: !binary |-
+    ODMwZWU5MThmYmI4ZTA0MzI3ZGUzMmNkNDVjZWY0YTAyOWVhM2YyZQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODY3NmEyM2U3OTY3ZjM1OWFlYmYwYWYzYjEzMjg4MWI4NjFiNDRhNjMzYTY3
+    ODBhYmI5NDY0ODRhNzk2MjE2NzkwOGE3YTE4MjA4M2Y3YzBjMTJmMTczNDAy
+    MmVmNmEyNDEwNDNkNTRmNmVkZWQwYWQyY2IyYzYxNWFmZDIxM2U=
+  data.tar.gz: !binary |-
+    YjhmNmMxYjRlZTBiZmEyY2FiNzdlYjEwMDllYmUzZmFmOWQwNGMzMDIwMzVm
+    ZGY5MzJlNzkzNDUyYzc5NGM0NDJiMzQ1NzRiYzFiNWYwN2UyZTMzZTI0ZTRk
+    ZGNjM2RhOGFjNGQ0MzdmZTM1MDBmZmNlZGNhMWM4Yjk4YmQ2Mzc=

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: 
+markup: tomdoc
+show_hash: false
+tab_width: 8
+title: 
+visibility: :protected
+webcvs: 

data/.travis.yml

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

data/README.md

@@ -1,8 +1,9 @@
 # OdeonUk
 
-A simple gem to parse the (Odeon UK website)[http://odeon.co.uk] and spit out useful formatted info.
+A simple gem to parse the [Odeon UK website](http://odeon.co.uk) and spit out useful formatted info.
 
 [![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)
 
 ## Installation
 

data/lib/odeon_uk/cinema.rb

@@ -22,8 +22,8 @@ module OdeonUk
     def initialize(id, name, url)
       @brand = 'Odeon'
       @id    = id.to_i
-      @name  = name
-      @slug  = name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
+      @name  = name.gsub('London - ','')
+      @slug  = @name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
       @url   = (url[0] == '/') ? "http://www.odeon.co.uk#{url}" : url
     end
 
@@ -59,6 +59,27 @@ module OdeonUk
       all.select { |cinema| cinema.id == id }[0]
     end
 
+    # Public: Returns adress hash of an Odeon cinema
+    #
+    # Examples
+    #
+    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema.adr
+    #   # => { street_address: 'Kingswest',
+    #          locality: 'Brighton',
+    #          postal_code: 'BN1 2RE',
+    #          country_name: 'United Kingdom' }
+    #
+    # Returns an array of strings or nil
+    def adr
+      {
+        street_address: street_address,
+        locality: locality,
+        postal_code: postal_code,
+        country: 'United Kingdom'
+      }
+    end
+
     # Public: Returns films for an Odeon cinema
     #
     # Examples
@@ -72,7 +93,34 @@ module OdeonUk
       film_nodes.map do |node|
         parser = OdeonUk::Internal::FilmWithScreeningsParser.new node.to_s
         OdeonUk::Film.new parser.film_name
-      end
+      end.uniq
+    end
+
+    # Public: Returns the locality (town) of an Odeon cinema
+    #
+    # Examples
+    #
+    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema.locality
+    #   # => 'Brighton'
+    #
+    # Returns a String
+    def locality
+      address_node.text.match(/\w+(\s\w+){0,}\s+(\w+(\s\w+){0,})/)[2]
+    end
+
+
+    # Public: Returns the postal code of an Odeon cinema
+    #
+    # Examples
+    #
+    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema.postal_code
+    #   # => 'BN1 2RE'
+    #
+    # Returns a String
+    def postal_code
+      address_node.text.match(/[A-Z]{1,2}\d{1,2}[A-Z]?\s\d{1,2}[A-Z]{1,2}/)[0]
     end
 
     # Public: Returns screenings for an Odeon cinema
@@ -87,9 +135,9 @@ module OdeonUk
     def screenings
       film_nodes.map do |node|
         parser = OdeonUk::Internal::FilmWithScreeningsParser.new node.to_s
-        parser.showings.map do |screening_type, times|
-          times.map do |time|
-            OdeonUk::Screening.new parser.film_name, self.name, time.strftime('%d/%m/%Y'), time.strftime('%H:%M:%S'), nil
+        parser.showings.map do |screening_type, times_urls|
+          times_urls.map do |array|
+            OdeonUk::Screening.new parser.film_name, self.name, array[0], array[1], screening_type
           end
         end
       end.flatten
@@ -111,6 +159,19 @@ module OdeonUk
       screenings.select { |s| s.film_name == film_name }
     end
 
+    # Public: Returns the street adress of an Odeon cinema
+    #
+    # Examples
+    #
+    #   cinema = OdeonUk::Cinema.find('71')
+    #   cinema.street_address
+    #   # => 'Kingswest'
+    #
+    # Returns a String
+    def street_address
+      address_node.text.match(/\A\s+(\w+(\s\w+){0,})/)[1]
+    end
+
     private
 
     def self.cinema_links
@@ -133,10 +194,18 @@ module OdeonUk
       @sitemap_response ||= HTTParty.get('http://www.odeon.co.uk/sitemap/')
     end
 
+    def address_node
+      parsed_cinema.css('.gethere .span4 .description')[0]
+    end
+
     def cinema_response
       @cinema_response ||= HTTParty.get(@url)
     end
 
+    def parsed_cinema
+      Nokogiri::HTML(cinema_response)
+    end
+
     def film_nodes
       parsed_showtimes.css('.film-detail')
     end

data/lib/odeon_uk/film.rb

@@ -2,17 +2,51 @@ module OdeonUk
 
   # 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: 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
+    # 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
+  end
 end

data/lib/odeon_uk/internal/film_with_screenings_parser.rb

@@ -39,11 +39,14 @@ module OdeonUk
         @nokogiri_html.css('.times-all.accordion-group').inject({}) do |result, varient_node|
           varient = varient_node.css('.tech a').text.gsub('in ', '').upcase
 
-          times = varient_node.css('.performance-detail').map do |screening_node|
-            tz.local_to_utc(Time.parse(screening_node['title'].match(/\d+\/\d+\/\d+ \d{2}\:\d{2}/).to_s))
+          times_url = varient_node.css('.performance-detail').map do |screening_node|
+            [
+              tz.local_to_utc(Time.parse(screening_node['title'].match(/\d+\/\d+\/\d+ \d{2}\:\d{2}/).to_s)),
+              "http://www.odeon.co.uk#{screening_node['href']}"
+            ]
           end
 
-          result.merge(varient => times)
+          result.merge(varient => times_url)
         end
       end
     end

data/lib/odeon_uk/screening.rb

@@ -3,6 +3,8 @@ module OdeonUk
   # Public: The object representing a screening of a film on the Odeon UK website
   class Screening
 
+    # Public: Returns the booking URL on the cinema website
+    attr_reader :booking_url
     # Public: Returns the String name of the cinema
     attr_reader :cinema_name
     # Public: Returns the String name of the film
@@ -16,12 +18,12 @@ module OdeonUk
     #
     # film_name   - String of the film name
     # cinema_name - String of the cinema name on the Odeon website
-    # date        - String/Date representing the date of the screening
-    # time        - String representing the time of the screening (24 hour clock)
+    # time        - Time representing the time of the screening (24 hour clock)
     # varient     - String representing the type of showing (e.g. 3d/baby/live)
-    def initialize(film_name, cinema_name, date, time, varient=nil)
+    def initialize(film_name, cinema_name, time, booking_url=nil, varient=nil)
       @cinema_name, @film_name, @varient = cinema_name, film_name, varient
-      @when = Time.parse("#{date} #{time} UTC")
+      @booking_url = booking_url
+      @when = time.utc? ? time : TZInfo::Timezone.get('Europe/London').local_to_utc(time)
     end
 
     # Public: The Date of the screening

data/lib/odeon_uk/version.rb

@@ -1,3 +1,3 @@
 module OdeonUk
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/odeon_uk.rb

@@ -1,10 +1,12 @@
 require 'httparty'
 require 'nokogiri'
 require 'tzinfo'
-require 'pp'
+require 'tzinfo/data'
 
-require_relative './odeon_uk/internal/film_with_screenings_parser'
 require_relative './odeon_uk/version'
+
+require_relative './odeon_uk/internal/film_with_screenings_parser'
+
 require_relative './odeon_uk/cinema'
 require_relative './odeon_uk/film'
 require_relative './odeon_uk/screening'

data/odeon_uk.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.name          = "odeon_uk"
   gem.version       = OdeonUk::VERSION
   gem.authors       = ["Andy Croll"]
-  gem.email         = ["andycroll@deepcalm.com"]
+  gem.email         = ["andy@goodscary.com"]
   gem.description   = %q{An API to pull movie information from the ODEON.co.uk website}
   gem.summary       = %q{It's a scraper, but a nice one}
   gem.homepage      = "http://github.com/andycroll/odeon_uk"