filmaffinity 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29ef0361d9518662bb80c94ec7935ec0706b3874
-  data.tar.gz: 17684ee3bf5f24ed46766a0e8539cbfde0812316
+  metadata.gz: c232bbeb3fd4824e04e3c9388dc54a02c40dc075
+  data.tar.gz: 301a948520b891e16758f277c785c793b80a4c08
 SHA512:
-  metadata.gz: 61606a76a4d418ffe81b087504df61332423de8759ca12fbf5b580bc1f70fdb98a1b952e1d98b687e5d7f92072cd1414152cc0587032c693eb9621307be5a86b
-  data.tar.gz: d4a64c23d3c57b8982ed609931ed9f939c063dfdfac6c388fa9441317ee45c7cd37272b4858560e83855c6f73aa23375cfcb072a1122032e9caa65c4a4315f58
+  metadata.gz: 8403c435c1b3426ad6f088b25a550dfbe46cb18f1c42a3c9ea4f18cd90d00cc31f855dc39ca1d0ead0e66a9790629e0854492b336f3cba98b388eb222548e3b9
+  data.tar.gz: 55ffa273246c0a3f6b7c19ba0bffb9bf2313f821693da0c93b46f28e976721639dbe7eb986758832f880910781f5f52573cbdb25242527ea40d88e6a440e5950

data/.rubocop.yml

@@ -1,4 +1,4 @@
-# inherit_from: .rubocop_todo.yml 
+inherit_from: .rubocop_todo.yml 
 
 # Style/FileName:
 #   Enabled: false

data/.rubocop_todo.yml

@@ -1,27 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-04-19 12:48:01 +0200 using RuboCop version 0.39.0.
+# on 2016-04-20 13:45:56 +0200 using RuboCop version 0.39.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AlignWith, SupportedStyles.
-# SupportedStyles: either, start_of_block, start_of_line
-Lint/BlockAlignment:
-  Exclude:
-  
-
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks.
-Lint/UnusedBlockArgument:
-  Exclude:
-    # - 'lib/filmaffinity/top.rb'
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 107
 
-# Offense count: 35
+# Offense count: 34
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
@@ -32,196 +22,27 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 50
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Performance/StringReplacement:
-  Exclude:
-    # - 'lib/filmaffinity/movie.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Style/AlignHash:
-  Exclude:
-
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-
-
 # Offense count: 9
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/constants/constants.rb'
-    - 'lib/filmaffinity.rb'
-    - 'lib/filmaffinity/configuration.rb'
-    - 'lib/filmaffinity/json-movie-parser.rb'
-    - 'lib/filmaffinity/json-movies-parser.rb'
-    - 'lib/filmaffinity/movie.rb'
-    - 'lib/filmaffinity/poster-manager.rb'
-    - 'lib/filmaffinity/search.rb'
-    - 'lib/filmaffinity/top.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAdjacentOneLineDefs.
-Style/EmptyLineBetweenDefs:
-  Exclude:
+    # - 'lib/constants/constants.rb'
+    # - 'lib/filmaffinity.rb'
+    # - 'lib/filmaffinity/configuration.rb'
     # - 'lib/filmaffinity/json-movie-parser.rb'
     # - 'lib/filmaffinity/json-movies-parser.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/EmptyLines:
-  Exclude:
-
-
-# Offense count: 13
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
-Style/EmptyLinesAroundBlockBody:
-  Exclude:
-
-
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
-Style/EmptyLinesAroundClassBody:
-  Exclude:
-
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/EmptyLinesAroundMethodBody:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
-Style/EmptyLinesAroundModuleBody:
-  Exclude:
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/EmptyLiteral:
-  Exclude:
-  
+    # - 'lib/filmaffinity/movie.rb'
+    # - 'lib/filmaffinity/poster-manager.rb'
+    # - 'lib/filmaffinity/search.rb'
 
 # Offense count: 6
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
 Style/FileName:
   Exclude:
-    #CAREFUL FileName Bug!
     - 'lib/filmaffinity/json-movie-parser.rb'
     - 'lib/filmaffinity/json-movies-parser.rb'
     - 'lib/filmaffinity/poster-manager.rb'
     - 'spec/filmaffinity/json-movie-parser_spec.rb'
     - 'spec/filmaffinity/json-movies-parser_spec.rb'
     - 'spec/filmaffinity/matchers/include-movie.rb'
-
-# Offense count: 59
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
-# SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
-Style/HashSyntax:
-  Enabled: enable
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: normal, rails
-Style/IndentationConsistency:
-  Exclude:
-    # - 'lib/filmaffinity/top.rb'
-    # - 'spec/filmaffinity/movie_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/LeadingCommentSpace:
-  Exclude:
-    # - 'spec/filmaffinity/search_spec.rb'
-
-# Offense count: 11
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: require_parentheses, require_no_parentheses, require_no_parentheses_except_multiline
-Style/MethodDefParentheses:
-  Enabled: true
-
-# Offense count: 29
-# Cop supports --auto-correct.
-Style/NumericLiterals:
-  Enabled: true
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/RedundantParentheses:
-  Exclude:
- 
-
-# Offense count: 6
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/SpaceAfterColon:
-  Exclude:
-
-
-# Offense count: 9
-# Cop supports --auto-correct.
-Style/SpaceAfterComma:
-  Exclude:
-
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Style/SpaceAroundOperators:
-  Exclude:
- 
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
-# SupportedStyles: space, no_space
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-# Offense count: 209
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-# SupportedStyles: comma, consistent_comma, no_comma
-Style/TrailingCommaInLiteral:
-  Exclude:
-    - 'lib/constants/constants.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, MinSize, WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: brackets

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org/"
+source 'https://rubygems.org/'
 gem 'pry-nav', group: [:development, :test]
 gemspec

data/README.md

@@ -3,13 +3,13 @@
 
 ## Description
 
-The filmaffinity gem allows you to easy access publicly available data from **Filmaffinity.com in english and spanish**.
+The filmaffinity gem allows you to easily access publicly available data from **Filmaffinity.com in english and spanish**.
 
-Also available as **REST API** at [heroku](https://filmaffinity-unofficial.herokuapp.com/).
+It is also available as **RESTful API** at [heroku](https://filmaffinity-unofficial.herokuapp.com/).
 
 ## Features
 
-- Search movies for a title
+- Search movies by title
 - Retrieve complete movie info
 - Retrieve the Top N of filmaffinity.com
 - Retrieve the Top N with the given options
@@ -22,7 +22,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -31,26 +31,26 @@ Or install it yourself as:
 ## Documentation
 
 ##### FilmAffinity configuration
-FilmAffinity has some configuration options, which you can configure globally before your requests. Could include an ```imgur_id``` to upload the posters on Imgur and avoid forbidden hotlinking from filmaffinity. Also you can change the ```language```, english by default. 
+FilmAffinity offers some configuration options, which you can configure globally before your requests. You could include an ```imgur_id``` to upload the posters on Imgur and avoid forbidden hotlinking from filmaffinity. You can also change the ```language```,which is english by default.
 ```
 FilmAffinity.configure do |config|
-  config.imgur_id = "Your-imgur-client-id"
-  config.language = "ES"
+  config.imgur_id = 'Your-imgur-client-id'
+  config.language = 'ES'
 end
 ```
 
 ##### FilmAffinity::Search
-Return an array of FilmAffinity::Movie, just containing preload ID and title.
+Returns an array of FilmAffinity::Movie, containing preload ID and title.
 
 ##### FilmAffinity::Movie
-Include some methods to retrieve the complete movie info.
+Includes some methods to retrieve the complete movie info.
 
 ##### FilmAffinity::Top options
-The options hash could include:
+The options hash accepts several parameters:
 ```
 {
-  :genre => "AC",
-  :country => "DE",
+  :genre => 'AC',
+  :country => 'DE',
   :from_year => 2014,
   :to_year => 2016,
   :no_doc => true,
@@ -58,25 +58,25 @@ The options hash could include:
 }
   ```
 ##### :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
+- '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
@@ -103,12 +103,12 @@ The options hash could include:
     top.movies.first
     #=> #<FilmAffinity::Movie>
 
-    #Top FilmAffinity with options
+    #Top FilmAffinity with options and number of results
     options = {
-      :genre => "AN",
+      :genre => 'AN',
       :no_tv => true
     }
-    top = FilmAffinity::Top.new options
+    top = FilmAffinity::Top.new options, 20
 
     top.movies
     #=> [<FilmAffinity::Movie>
@@ -121,7 +121,7 @@ The options hash could include:
 
 ### Search:
 
-    search = FilmAffinity::Search.new("Padrino")
+    search = FilmAffinity::Search.new('Padrino')
 
     search.movies
     #=> [<FilmAffinity::Movie>
@@ -134,10 +134,10 @@ The options hash could include:
 
 ### Movie:
 
-    movie = FilmAffinity::Movie.new(809297, "El Padrino")
+    movie = FilmAffinity::Movie.new(809297, 'El Padrino')
 
     movie.director
-    #=> "Francis Ford Coppola"
+    #=> 'Francis Ford Coppola'
 
     movie.year
     #=> 1972
@@ -146,15 +146,13 @@ The options hash could include:
     #=> 9.1
 
     movie.cast
-    #=> ["Marlon Brando",
-         "Al Pacino",
-         "James Caan",
-         "Robert Duvall",
-         "Diane Keaton",
+    #=> ['Marlon Brando',
+         'Al Pacino',
+         'James Caan',
+         'Robert Duvall',
+         'Diane Keaton',
          ...]
 
-   movie.genres, movie.country, movie.sinopsis...
-
 ## Contributors
 
 This gem is created and maintained by [Oriol Bellido](https://github.com/oricodes89) and [David Santos](https://github.com/davidsantosmerino)

data/filmaffinity.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'filmaffinity'
-  s.version     = '0.3.1'
-  s.date        = '2016-04-19'
-  s.summary     = "filmaffinity"
-  s.description = "Easily use Ruby or the command line to find information on Filmaffinity.com"
-  s.authors     = ["David Santos", "Oriol Bellido"]
+  s.version     = '1.0.0'
+  s.date        = '2016-04-26'
+  s.summary     = 'filmaffinity'
+  s.description = 'Easily use Ruby or the command line to find information on Filmaffinity.com'
+  s.authors     = ['David Santos', 'Oriol Bellido']
   s.email       = 'dsantosmerino92@gmail.com'
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/constants/constants.rb

@@ -6,7 +6,7 @@ module Constants
       from_year: 'fromyear=%i&',
       to_year: 'toyear=%i&',
       no_doc: 'nodoc&',
-      no_tv: 'notvse&',
+      no_tv: 'notvse&'
     }
   end
 
@@ -42,7 +42,7 @@ module Constants
       },
 
       music: { EN: 'dt:contains("Music")',
-               ES: 'dt:contains("Música")'
+               ES: 'dt:contains("Music")'
       },
 
       company: { EN: 'dt:contains("Producer")',