filmaffinity 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d41ff7c40e9bc2096224bb1190112dfde63a058a
-  data.tar.gz: eb7cd3f4a55a70900da27e395ad6ed6a184912ea
+  metadata.gz: 8902c8713ff5695c57f80e2e44ba3b770b9041cd
+  data.tar.gz: f366e254a0e4ba6ac495af6bd25adc6b7f9906d8
 SHA512:
-  metadata.gz: 61801175302414d4b8384214875dfd926809b5193fc77f347536e46acc380d2d268836db537abb3483391f93f92e09f29406108e99573d95a737fbf63436ce54
-  data.tar.gz: ef2a7c6f372dc2230103c86fa964df042dc3c76b79e037da4fcb13ca724fffd23151847bc9dddefbc82c9466e5dd2314c6f7e07070018392fc48889e1d44e521
+  metadata.gz: 5337977d4d3a5bd3f7a666d8f9334cb6f9ae5cd587f4ac02837e68267c14ff32f797100d73f7bffa2be99d322f31fc68e7cdaf11df4830cdf60eb6da2d82fcef
+  data.tar.gz: 0c258a0e379f73c8e7dd135b61bb2da5215f38773e3d76cf2a78beee9c1c552087c1442b2117c6a1b48a35c93445a3fd60969a3a315c9b75a7275bc1c7297e06

data/README.md

@@ -4,8 +4,89 @@
 
 The filmaffinity gem allows you to easy access publicly available data from Filmaffinity.com in spanish.
 
+## Features
+
+- ```FilmAffinity::Search.new title``` Search movies for a title
+- ```FilmAffinity::Movie.new id, title``` Retrieve complete movie info
+- ```FilmAffinity::Top.new``` Retrieve the Top 30
+- ```FilmAffinity::Top.new options``` Retrieve the Top with the given options
+
+## Documentation
+
+##### FilmAffinity::Top options
+The options hash could include:
+```
+{
+  :genre => "AC",
+  :country => "DE",
+  :from_year => 2014,
+  :to_year => 2016,
+  :no_doc => true,
+  :no_tv => true
+}
+  ```
+##### :genre
+- "AC"    Action
+- "AV"    Adventure
+- "AN"    Animation
+- "CO"    Comedy
+- "DO"    Documentary
+- "DR"    Drama
+- "FAN"   Fantasy
+- "F-N"   Film-Noir
+- "TE"    Horror
+- "INF"   Kids
+- "MU"    Musical
+- "INT"   Mystery
+- "RO"    Romance
+- "C-F"   Sci-Fi
+- "TH"    Thriller
+- "TV_SE" TV Series
+- "DESC"  Unknown
+- "BE"    War
+- "WE"    Western
+
+##### :country
+2-letter code supplied by the ISO
+
+##### :no_doc
+```true``` to avoid documentaries
+
+##### :no_tv
+```true``` to avoid TV series
+
+
 ## Examples
 
+### Top:
+    #Top FilmAffinity ever
+    top = FilmAffinity::Top.new
+
+    top.movies
+    #=> [<FilmAffinity::Movie>
+         <FilmAffinity::Movie>
+         <FilmAffinity::Movie>
+         ...]
+
+    search.movies.first
+    #=> #<FilmAffinity::Movie>
+
+    #Top FilmAffinity with options
+    options = {
+      :genre => "AN",
+      :no_tv => true
+    }
+    top = FilmAffinity::Top.new options
+
+    top.movies
+    #=> [<FilmAffinity::Movie>
+         <FilmAffinity::Movie>
+         <FilmAffinity::Movie>
+         ...]
+
+    search.movies.first
+    #=> #<FilmAffinity::Movie>
+
 ### Search:
 
     search = FilmAffinity::Search.new("Padrino")

data/filmaffinity.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'filmaffinity'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.date        = '2016-04-05'
   s.summary     = "filmaffinity"
   s.description = "Easily use Ruby or the command line to find information on Filmaffinity.com"

data/lib/constants/constants.rb

@@ -0,0 +1,19 @@
+module Constants
+  def self.query_params
+    {
+      :genre => "genre=%s&",
+      :country => "country=%s&",
+      :from_year => "fromyear=%i&",
+      :to_year => "toyear=%i&",
+      :no_doc => "nodoc&",
+      :no_tv => "notvse&",
+    }
+  end
+  def self.urls
+    {
+      :top => "http://www.filmaffinity.com/es/topgen.php%s",
+      :search_by_title => "http://www.filmaffinity.com/es/search.php?stext=%s&stype=title",
+      :movie => "http://www.filmaffinity.com/es/film%i.html"
+    }
+  end
+end

data/lib/filmaffinity.rb

@@ -1,5 +1,7 @@
 require "open-uri"
 require "nokogiri"
 
+require_relative "constants/constants"
 require_relative "filmaffinity/movie"
 require_relative "filmaffinity/search"
+require_relative "filmaffinity/top"

data/lib/filmaffinity/movie.rb

@@ -11,7 +11,7 @@ module FilmAffinity
     end
 
     def generate_html
-      open("http://www.filmaffinity.com/es/film#{@id}.html")
+      open(Constants.urls[:movie] % id)
     end
 
     def year

data/lib/filmaffinity/search.rb

@@ -19,7 +19,7 @@ module FilmAffinity
     end
 
     def generate_html
-      open("http://www.filmaffinity.com/es/search.php?stext=#{CGI.escape(@query)}&stype=title")
+      open(Constants.urls[:search_by_title] % CGI.escape(@query))
     end
 
     def parse_movie

data/lib/filmaffinity/top.rb

@@ -0,0 +1,44 @@
+require "cgi"
+
+module FilmAffinity
+  class Top
+    def initialize options = nil
+      @options = options
+    end
+
+    def movies
+      @movies ||= parse_movies
+    end
+
+    def document_html
+      @document_html ||= Nokogiri::HTML(self.generate_html)
+    end
+
+    def generate_html
+      open(Constants.urls[:top] % query_options)
+    end
+
+    def query_options
+      query_options = String.new
+      if @options
+        query_options += "?"
+        @options.each do |key,value|
+          query_options += Constants.query_params[key] % value
+        end
+      end
+      query_options.gsub(/\&$/,"")
+    end
+
+    def parse_movies
+      movies = []
+      document_html.search(".movie-card.movie-card-1").each do |movie_card|
+        id = movie_card["data-movie-id"].to_i
+        title = movie_card.search(".mc-title a").first.content.strip
+        movie = FilmAffinity::Movie.new id, title
+        movies << movie
+      end
+      movies
+    end
+
+  end
+end

data/spec/filmaffinity/top_spec.rb

@@ -0,0 +1,54 @@
+require_relative "../spec_helper"
+
+describe "FilmAffinity::Top" do
+
+  describe "#create_document_html" do
+    subject(:top) { FilmAffinity::Search.new("truman") }
+
+    it "#create_document_html" do
+      document_html = top.document_html
+      expect(document_html).to be_an(Nokogiri::HTML::Document)
+    end
+
+  end
+
+  describe "#movies" do
+      context "no options" do
+        subject(:top) { FilmAffinity::Top.new }
+        it "should return an array" do
+          movies = top.movies
+          expect(movies).to be_an(Array)
+        end
+        it "should return just FilmAffinity::Movie objects only" do
+          movies = top.movies
+          movies.each { |movie| expect(movie).to be_an(FilmAffinity::Movie) }
+        end
+        it "should include 'El Padrino'" do
+          movies = top.movies
+          el_padrino_movie = FilmAffinity::Movie.new 809297, "El padrino"
+          expect(movies).to include_movie(el_padrino_movie)
+        end
+      end
+      context "with options" do
+        options = {
+          :genre => "BE",
+          :country => "DE"
+        }
+        subject(:top) { FilmAffinity::Top.new options }
+        it "should return an array" do
+          movies = top.movies
+          expect(movies).to be_an(Array)
+        end
+        it "should return just FilmAffinity::Movie objects only" do
+          movies = top.movies
+          movies.each { |movie| expect(movie).to be_an(FilmAffinity::Movie) }
+        end
+        it "should include 'Hijos del Tercer Reich (TV)'" do
+          movies = top.movies
+          hijos_del_tercer_reich_movie = FilmAffinity::Movie.new 831118, "Hijos del Tercer Reich (TV)"
+          expect(movies).to include_movie(hijos_del_tercer_reich_movie)
+        end
+      end
+    end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filmaffinity
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - David Santos, Oriol Bellido
@@ -64,6 +64,7 @@ files:
 - README.md
 - Rakefile
 - filmaffinity.gemspec
+- lib/constants/constants.rb
 - lib/filmaffinity.rb
 - lib/filmaffinity/movie.rb
 - lib/filmaffinity/search.rb
@@ -71,6 +72,7 @@ files:
 - spec/filmaffinity/matchers/include-movie.rb
 - spec/filmaffinity/movie_spec.rb
 - spec/filmaffinity/search_spec.rb
+- spec/filmaffinity/top_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/davidsantosmerino/filmaffinity-gem
 licenses:
@@ -100,5 +102,6 @@ test_files:
 - spec/filmaffinity/matchers/include-movie.rb
 - spec/filmaffinity/movie_spec.rb
 - spec/filmaffinity/search_spec.rb
+- spec/filmaffinity/top_spec.rb
 - spec/spec_helper.rb
 has_rdoc: