letteropend 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6cdb0d4f3c01c57f54e2ec50cf5e6a4db37ac1e
-  data.tar.gz: 9ebe34eea4c67947da344db67b8dea136c3ef0e6
+  metadata.gz: d5e35304268f8c5572b2229b6e9f1b652fc85558
+  data.tar.gz: 5ca98b6f08d5095cabe6c4f13a42baabdc01d024
 SHA512:
-  metadata.gz: ccd759632bc898725b6293eb53e3f3145e4a492d3894a8e20d8fb581e0cc6ddcc82613e065246284609a911b5752100cfdadad244ddb3001baa64efada72e8cf
-  data.tar.gz: 896f9ba1a0f915169d1ed6d4621cad9060208296cf93375178fc9942b628b9d8b2cb3ffc0577a61ad65431eb6657e3a5e557fe43013d669cd0f7d255fb29fa59
+  metadata.gz: f80309d6f2665d12fa045e36fb9fb212685468d8574f45b63dd9d47d2bd8e52f602f4b3079645de13c9d53b595f29ec2f235c1eea2e24514f174a3039043f09d
+  data.tar.gz: b9737ce23e168e491c00d6f579939378a4b51a7debb096b7d9abd224990ecfe7653c456533e7dc02b434fcfea828db2215083c295adb3b3b685069657eb5e9e0

data/README.md

@@ -1,12 +1,19 @@
 LetterOpend
 ===========
 
+[![Gem Version](https://badge.fury.io/rb/letteropend.svg)](http://badge.fury.io/rb/letteropend)
+[![Dependency Status](https://gemnasium.com/JRJurman/Letteropend.svg)](https://gemnasium.com/JRJurman/Letteropend)
+[![Code Climate](https://codeclimate.com/github/JRJurman/Letteropend/badges/gpa.svg)](https://codeclimate.com/github/JRJurman/Letteropend)
+
 Scripts and Functions that let you peek at letterboxd films.
 
 Sadly, with no API publicly available, this is a quick-hack way of exposing the films that you and your friends have seen, listed, or watchlisted on letterboxd.com
 
 This is not associated with letterboxd, nor is it guaranteed to work once an official API is released
 
+Installation
+------------
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,7 +28,8 @@ Or install it yourself as:
 
     $ gem install letteropend
 
-## Contributing
+Contributing
+------------
 
 1. Fork it ( https://github.com/jrjurman/letteropend/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/examples/compareWatchlist.rb

@@ -1,16 +1,19 @@
 require_relative "../lib/letteropend"
 
-callbacks = {
-  :new_page => lambda{ |list| puts "Getting page {#{list.pages.length}} from #{list.username}'s #{list.list}" }
-}
+Letteropend::List.config do
+  on :new_page do
+    puts "Getting page {#{pages.length}} from #{username}'s #{list}"
+  end
+end
+
 print "First username: "
 user1 = gets.chomp
 
 print "Second username: "
 user2 = gets.chomp
 
-user1_wl = Letteropend::List.new(user1, "watchlist", callbacks)
-user2_wl = Letteropend::List.new(user2, "watchlist", callbacks)
+user1_wl = Letteropend::List.new(user1, "watchlist")
+user2_wl = Letteropend::List.new(user2, "watchlist")
 
 user2_wl.films.delete_if { |film| !user1_wl.films.include? film }
 user2_wl.films.each do |film|

data/examples/getAllTime.rb

@@ -19,13 +19,24 @@ def pulled_film(film)
   end
 end
 
-callbacks = {
-  :new_page => lambda{ |l| puts "pulling data from {#{l.pages.last}}" },
-  :pulling_film => lambda{ |f| puts "pulling data from {#{f.url}}" },
-  :pulled_film => lambda{ |f| Object.send(:pulled_film, f) }
-}
+Letteropend::Film.config do
+  on :model_updating do
+    puts "pulling data from {#{url}}"
+  end
+  on :model_updated do
+    Object.send(:pulled_film, self)
+  end
+end
 
-l = Letteropend::List.new(un, ul, callbacks)
-total = l.get_total_time
+l = Letteropend::List.new(un, ul) do 
+  on :new_page do
+    puts "pulling data from {#{pages.last}}"
+  end
+end
+
+total = 0
+l.films.each do |film|
+  total += film.runtime
+end
 
 puts "Total Runtime: #{total} minutes"

data/examples/getDirectedFilms.rb

@@ -0,0 +1,13 @@
+require_relative "../lib/letteropend"
+
+puts "Looking at films directed by Alfred Hitchcock"
+
+username = "director"
+list = "alfred-hitchcock"
+l = Letteropend::List.new(username, list) do
+  on :new_page do
+    puts "pulling data from " + pages.last
+  end
+end
+
+puts "There are #{l.films.length} number of films on #{username} #{list}'s list"

data/examples/getFilmDetails.rb

@@ -1,14 +1,46 @@
 require_relative "../lib/letteropend"
 
-title = "Chopping Mall"
-url = "/film/chopping-mall/"
-f = Letteropend::Film.new(title, url)
+Letteropend::Film.config do
+  on :model_updated do
+    puts "Model was updated"
+  end
+end
 
-runtime = f.runtime
-puts "#{title}'s runtime is: #{runtime} minutes"
+url = "chopping-mall"
+a = Letteropend::Film.new url do 
+  on :model_updating do
+    puts "Runtime: #{runtime}"
+  end
+end
 
-tagline = f.tagline
-puts "#{title}'s tagline is: #{tagline}"
+url = "ghostbusters"
+b = Letteropend::Film.new url, title: "The Real Ghostbusters", runtime: 107 do
+  on :model_updating do
+    puts "Runtime: #{runtime}"
+  end
+end
 
-overview = f.overview
-puts "#{title}'s overview is: #{overview}"
+url = "duck-soup-1933"
+c = Letteropend::Film.new url do
+  on :model_updated do
+    puts "We have Duck Soup"
+  end
+end
+
+def we_got_movie_sign(movie)
+  puts "The title is : #{movie.title}"
+  
+  runtime = movie.runtime
+  puts "#{movie.title}'s runtime is: #{movie.runtime} minutes"
+  
+  tagline = movie.tagline
+  puts "#{movie.title}'s tagline is: #{movie.tagline}"
+  
+  overview = movie.overview
+  puts "#{movie.title}'s overview is: #{movie.overview}"
+  puts "\n\n"
+end
+
+we_got_movie_sign(a)
+we_got_movie_sign(b)
+we_got_movie_sign(c)

data/examples/getNumberOfFilms.rb

@@ -5,10 +5,15 @@ un = gets().chomp
 print "Enter list: "
 ul = gets().chomp
 
-callbacks = {
-  :new_page => lambda{ |l| puts "pulling data from " + l.pages.last},
-}
+Letteropend::List.config do
+  on :new_page do
+    puts "Loading "+ pages.last
+  end
+  on :new_film do
+    puts "Got "+films.last.url
+  end
+end
 
-l = Letteropend::List.new(un, ul, callbacks)
+l = Letteropend::List.new(un, ul)
 
 puts "There are #{l.films.length} number of films on #{un}'s #{ul} list"

data/lib/letteropend/film.rb

@@ -2,66 +2,139 @@ require "nokogiri"
 require "open-uri"
 
 module Letteropend
+  # The Film class
   class Film
-    attr_reader :title, :url, :runtime, :tagline, :overview
-    def initialize(title, url, callbacks={})
-      @title = title
+    attr_reader :url
+    @@valid_attributes = [:title, :tagline, :overview, :runtime]
+    @@valid_events = [:model_updated, :model_updating]
+
+    # Creates a new film instance
+    #
+    # @param url - the url letterboxd assigns the film
+    # @param details - the attributes the user assigns the film (instead of pulling from letterboxd)
+    # @param events - block of user defined events
+    def initialize(url, *details, &events)
       @url = url
       @pulled = false
-      @callbacks = callbacks
+      @pulling = false
+      @events = {}
+
+      # assign each detail to a method
+      details.each do |detail|
+        detail.each do |key, value|
+
+          # only assign valid attributes to a film
+          if @@valid_attributes.include? key
+            define_singleton_method(key, lambda{value})
+          else
+            puts "Error: trying to assign invalid film data | film: #{@url}, attribute: #{key}"
+          end
+
+        end
+      end
+
+      # assign events to film object
+      if block_given?
+        instance_eval(&events)
+      end
     end
-  
-    def runtime
-      if !@pulled
-        pull_data
+
+    # Assign events to instance
+    #
+    # @param event - symbol of event to be triggered
+    # @param block - user defined function to be triggered on event
+    def on(event, &block)
+      if block_given?
+        if (@@valid_events.include? event)
+          define_singleton_method(event, block)
+        else
+          puts "Error: trying to assign invalid event | Letteropend::Film, event: #{event}"
+        end
       end
-      @runtime
     end
 
-    def tagline
-      if !@pulled
-        pull_data
+    # Method to declare class events
+    #
+    # @param events - block of user defined events
+    def self.config(&events)
+      if block_given?
+        class_eval(&events)
       end
-      @tagline
     end
-  
-    def overview
-      if !@pulled
-        pull_data
+
+    # Assign events to class
+    #
+    # @param event - symbol of event to be triggered
+    # @param block - user defined function to be triggered on event
+    def self.on(event, &block)
+      if block_given?
+        if (@@valid_events.include? event)
+          define_method(event, block)
+        else
+          puts "Error: trying to assign invalid class event | Letteropend::Film, event: #{event}"
+        end
       end
-      @overview
     end
 
+    # Goes to Letterboxd and pulls html page with nokogiri
     def pull_data
-      if @callbacks[:pulling_film]
-        @callbacks[:pulling_film].call(self)
-      end
-  
+      @pulling = true
+
+      model_updating
+
       # pull the page from the url
-      page = Nokogiri::HTML(open("http://www.letterboxd.com#{@url}"))
-      @pulled = true
+      page = Nokogiri::HTML(open("http://www.letterboxd.com/film/#{@url}/"))
   
+      # get the title for the film
+      title = page.css("h1.film-title").text
+      define_singleton_method(:title, lambda{title})
+
       # get the runtime for the film
       runtime_cap = page.css(".text-link").text.match(/(\d+) mins/)
       if runtime_cap
-        @runtime = runtime_cap.captures[0].to_i
+        runtime = runtime_cap.captures[0].to_i
       else
-        @runtime = 0
+        runtime = 0
       end
+      define_singleton_method(:runtime, lambda{runtime})
 
       # get the tagline for the film
-      @tagline = page.css(".tagline").text
+      tagline = page.css(".tagline").text
+      define_singleton_method(:tagline, lambda{tagline})
 
       # get the overview for the film
-      @overview = page.css("div.truncate").text.strip
+      overview = page.css("div.truncate").text.strip
+      define_singleton_method(:overview, lambda{overview})
   
-      if @callbacks[:pulled_film]
-        @callbacks[:pulled_film].call(self)
-      end
+      @pulled = true
+      @pulling = false
+
+      model_updated
     end
   
+    # Equivalence operator
     def ==(film)
-      @title == film.title and @url == film.url
+      @url == film.url
+    end
+
+    # Method Missing implementation
+    #
+    # @param sym - method trying to be called
+    # @param args - arguments passed into the method call
+    def method_missing(sym, *args)
+      if (@@valid_attributes.include? sym)
+        if !@pulled and !@pulling
+          pull_data
+          self.send(sym)
+        elsif !@pulled and @pulling
+          puts "Error: trying to get film data prematurely | film: #{@url}, method: #{sym}"
+        end
+      elsif (@@valid_events.include? sym)
+        # no method was defined for this event
+      else
+        super
+      end
     end
+
   end
 end

data/lib/letteropend/list.rb

@@ -3,30 +3,41 @@ require 'open-uri'
 require_relative './film'
 
 module Letteropend
+  # The List class
   class List
     attr_reader :username, :list, :films, :pages
+    @@valid_events = [:new_page, :new_film]
   
-    def initialize(username, list="films", callbacks={})
+    # Created a new list instance
+    #
+    # @param username - the username for the list
+    # @param list - name of list, defaults to "films" (watched movies)
+    # @param events - block of user defined events
+    def initialize(username, list="films", &events) 
       @username = username
       @list = list
   
       @films = []
       @pages = ["/#{username}/#{list}/page/1/"]
+
+      # assign events to list object
+      if block_given?
+        instance_eval(&events)
+      end
+
       begin
         # get page using Nokogiri
-        if callbacks[:new_page]
-          callbacks[:new_page].call(self)
-        end
+        new_page
+
         page = Nokogiri::HTML(open("http://www.letterboxd.com#{@pages.last}"))
   
         # append visible films to @films
         page.css(".poster").each do |film|
           title = film.css(".frame-title").text
-          url = film.css("a")[0].attr("href")
-          @films.push( Film.new(title, url, callbacks) )
-          if callbacks[:new_film]
-            callbacks[:new_film].call(self)
-          end
+          url_full = film.css("a")[0].attr("href")
+          url = /\/film\/(\S+)\//.match(url_full).captures[0]
+          @films.push( Film.new(url, title: title) )
+          new_film
         end
   
         # see if there is a next page
@@ -36,13 +47,50 @@ module Letteropend
         end
       end while ( next_page )
     end
-    
-    def get_total_time
-      total_runtime = 0
-      @films.each do |film|
-        total_runtime += film.runtime
+
+    # Assign events to instance
+    #
+    # @param event - symbol of event to be triggered
+    # @param block - user defined function to be triggered on event
+    def on(event, &block)
+      if block_given?
+        if (@@valid_events.include? event)
+          define_singleton_method(event, block)
+        else
+          puts "Error: trying to assign invalid event | Letteropend::List, event: #{event}"
+        end
+      end
+    end
+
+    # Method to declare class events
+    #
+    # @param events - block of user defined events
+    def self.config(&events)
+      if block_given?
+        class_eval(&events)
+      end
+    end
+
+    # Assign events to class
+    #
+    # @param event - symbol of event to be triggered
+    # @param block - user defined function to be triggered on event
+    def self.on(event, &block)
+      if block_given?
+        if (@@valid_events.include? event)
+          define_method(event, block)
+        else
+          puts "Error: trying to assign invalid class event | Letteropend::List, event: #{event}"
+        end
+      end
+    end
+
+    def method_missing(sym, *args)
+      if (@@valid_events.include? sym)
+        # no method was defined for this event
+      else
+        super
       end
-      return total_runtime
     end
   
   end

data/lib/letteropend/version.rb

@@ -1,3 +1,3 @@
 module Letteropend
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: letteropend
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jesse Jurman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,6 +66,7 @@ files:
 - Rakefile
 - examples/compareWatchlist.rb
 - examples/getAllTime.rb
+- examples/getDirectedFilms.rb
 - examples/getFilmDetails.rb
 - examples/getNumberOfFilms.rb
 - letteropend.gemspec