rarbg 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae0fc9cbd49bc0297737148b66e9c08164e1ebb4e0e1e7237d0e0c3385d4165
-  data.tar.gz: 76ae543821aa6204da813588d4020bfaf8d9f0462f88cea1c7e8299ee9b84fac
+  metadata.gz: 5bdc20e4ab04f39d219c9144799d7ffddba69c0dd316c1ed41d239e286967714
+  data.tar.gz: ebe32eb45fcd60fb2d21f78c7d3ea1c3115875e36039f82c7f6b29643f4cc4f4
 SHA512:
-  metadata.gz: c486d18f7621cfa1aa6305145dda201e60c5a05a4c53637efe68908efcb296adb7094af575ab77253c6286098269a1daaa5561ad140d9274a40786de9ebe2c50
-  data.tar.gz: f1974c700b3f66ec529e123a92ae8619fca9c9f014f9a7b7d6d3381b0aa95890e05f70706f3e20a62bacaa677a0b758cab3885a634e300a24fdc634310640f95
+  metadata.gz: 2ad332920510625f62afb67c6f81eb016f8c2f2654ee34ac5669b5c282925fb098b6b31bdcf6bcfcebc10aa6067883814c8b863b479ea22d252e818ad2dc0eb7
+  data.tar.gz: e1e2e06a31ad858b5ab4c4fa7f92e326d69add29e5e88fae6c28e707132b472e89bd6c2bc4d040351bb93a32c46beb174f0749a5973aae18a89b267969fb61bb

data/.hound.yml

@@ -0,0 +1,5 @@
+fail_on_violations: true
+
+rubocop:
+  config_file: .rubocop.yml
+  version: 0.59.2

data/.rubocop.yml

@@ -13,6 +13,12 @@ Layout/AlignHash:
 Layout/FirstParameterIndentation:
   EnforcedStyle: consistent
 
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
 Metrics/BlockLength:
   Exclude:
     - '*.gemspec'
@@ -20,6 +26,9 @@ Metrics/BlockLength:
     - 'describe'
     - 'context'
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 90
 

data/.travis.yml

@@ -3,7 +3,7 @@ language: ruby
 cache: bundler
 script: bundle exec rspec
 rvm:
-  - 2.6.0
+  - 2.6.1
   - 2.5.3
   - 2.4.5
   - 2.3.8

data/CHANGELOG.md

@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## 1.3.0 - 2019-02-07
+[RubyGems](https://rubygems.org/gems/rarbg/versions/1.3.0) |
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v1.3.0) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v1.2.0...v1.3.0)
+
+#### Fixed
+- Return an empty array when endpoint responds with a `Can't find` error on
+`imdb`/`themoviedb`/`tvdb` search ([#6](https://github.com/epistrephein/rarbg/pull/6)).
+- Parse JSON only for responses with `application/json` Content-Type, preventing
+error responses to raise a `ParsingError` ([#4](https://github.com/epistrephein/rarbg/pull/4)).
+
+#### Added
+- Add `token!` public method for standalone token generation
+([#3](https://github.com/epistrephein/rarbg/pull/3)).
+
+#### Changed
+- Reduce Faraday connection timeout to 30 seconds.
+
+
 ## 1.2.0 - 2019-01-02
 [RubyGems](https://rubygems.org/gems/rarbg/versions/1.2.0) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v1.2.0) |

data/CONTRIBUTING.md

@@ -48,7 +48,8 @@ changes with `rake spec`.
 
 We also use [RuboCop](https://docs.rubocop.org/en/latest/) to enforce code style.  
 The configuration file used for this project lives in `.rubocop.yml`. You can check
-the code style of your changes with `rake rubocop`.
+the code style of your changes with `rake rubocop`.  
+Pull Requests on GitHub are automatically linted with RuboCop via [Hound](https://houndci.com/).
 
 The default Rake task, runnable using `rake`, performs code linting via Rubocop
 and then runs the RSpec tests.

data/README.md

@@ -20,7 +20,7 @@ $ gem install rarbg
 Or add it to your Gemfile and execute `bundle install`
 
 ```ruby
-gem 'rarbg', '~> 1.2'
+gem 'rarbg', '~> 1.3'
 ```
 
 ## Usage
@@ -31,6 +31,8 @@ An authentication token is automatically generated on first request, stored with
 
 Rate limit (1req/2s) is automatically enforced.
 
+Check out the [full documentation](https://epistrephein.github.io/rarbg) for details on all methods and parameters.
+
 #### Getting started
 
 Require the gem and initialize a new `RARBG::API` object.

data/lib/rarbg.rb

@@ -7,10 +7,10 @@ require 'rarbg/api'
 # Module namespace shortcut methods.
 module RARBG
   class << self
-    %i[list search].each do |m|
-      define_method(m) do |*args|
+    %i[list search token!].each do |method|
+      define_method(method) do |*args|
         @rarbg ||= RARBG::API.new
-        @rarbg.send(m, *args)
+        @rarbg.send(method, *args)
       end
     end
   end

data/lib/rarbg/api.rb

@@ -38,6 +38,13 @@ module RARBG
     SEARCH_KEYS = %w[string imdb tvdb themoviedb].freeze
     private_constant :SEARCH_KEYS
 
+    # Endpoint error strings to return as no results.
+    NO_RESULTS_ERRORS_REGEXPS = Regexp.union([
+      /no results found/i,
+      /can'?t find .+? in database/i
+    ])
+    private_constant :NO_RESULTS_ERRORS_REGEXPS
+
     # Initialize a new instance of `RARBG::API`.
     #
     # @example
@@ -45,11 +52,11 @@ module RARBG
     def initialize
       @conn = Faraday.new(url: API_ENDPOINT) do |conn|
         conn.request  :json
-        conn.response :json
+        conn.response :json, content_type: /\bjson$/
         conn.response :logger if $VERBOSE
         conn.adapter  Faraday.default_adapter
 
-        conn.options.timeout = 90
+        conn.options.timeout      = 30
         conn.options.open_timeout = 10
 
         conn.headers[:user_agent] = APP_ID
@@ -63,22 +70,23 @@ module RARBG
     #
     # @option params [Array<Integer>] :category Filter results by category.
     # @option params [Symbol] :format Format results.
-    #   Valid values: `:json`, `:json_extended`. Default: `:json`.
+    #   Accepted values: `:json`, `:json_extended`. Default: `:json`.
     # @option params [Integer] :limit Limit results number.
-    #   Valid values: `25`, `50`, `100`. Default: `25`.
+    #   Accepted values: `25`, `50`, `100`. Default: `25`.
     # @option params [Integer] :min_seeders Filter results by minimum seeders.
     # @option params [Integer] :min_leechers Filter results by minimum leechers.
     # @option params [Boolean] :ranked Include/exclude unranked torrents.
     #   Default: `true`.
     # @option params [Symbol] :sort Sort results.
-    #   Valid values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
+    #   Accepted values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
     #
     # @return [Array<Hash>] Return torrents that match the specified parameters.
     #
     # @raise [ArgumentError] Exception raised if `params` is not an `Hash`.
-    # @raise [RARBG::APIError] Exception raised when request fails or endpoint
-    #   responds with an error.
-    # @raise [Faraday::Error] Exception raised on low-level connection errors.
+    # @raise [RARBG::APIError] Exception raised when the request fails or the
+    #   endpoint responds with an error.
+    # @raise [Faraday::Error] Exception raised on low-level connection errors
+    #   (e.g. timeouts).
     #
     # @example List last 100 ranked torrents in `Movies/x264/1080`
     #   rarbg = RARBG::API.new
@@ -107,24 +115,25 @@ module RARBG
     # @option params [String] :themoviedb Search by The Movie DB id.
     # @option params [Array<Integer>] :category Filter results by category.
     # @option params [Symbol] :format Format results.
-    #   Valid values: `:json`, `:json_extended`. Default: `:json`.
+    #   Accepted values: `:json`, `:json_extended`. Default: `:json`.
     # @option params [Integer] :limit Limit results number.
-    #   Valid values: `25`, `50`, `100`. Default: `25`.
+    #   Accepted values: `25`, `50`, `100`. Default: `25`.
     # @option params [Integer] :min_seeders Filter results by minimum seeders.
     # @option params [Integer] :min_leechers Filter results by minimum leechers.
     # @option params [Boolean] :ranked Include/exclude unranked torrents.
     #   Default: `true`.
     # @option params [Symbol] :sort Sort results.
-    #   Valid values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
+    #   Accepted values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
     #
     # @return [Array<Hash>] Return torrents that match the specified parameters.
     #
     # @raise [ArgumentError] Exception raised if `params` is not an `Hash`.
     # @raise [ArgumentError] Exception raised if no search type param is passed
     #   (among `string`, `imdb`, `tvdb`, `themoviedb`).
-    # @raise [RARBG::APIError] Exception raised when request fails or endpoint
-    #   responds with an error.
-    # @raise [Faraday::Error] Exception raised on low-level connection errors.
+    # @raise [RARBG::APIError] Exception raised when the request fails or the
+    #   endpoint responds with an error.
+    # @raise [Faraday::Error] Exception raised on low-level connection errors
+    #   (e.g. timeouts).
     #
     # @example Search by IMDb ID, sorted by leechers and in extended format.
     #   rarbg = RARBG::API.new
@@ -143,13 +152,25 @@ module RARBG
       call(params)
     end
 
+    # Generate the authentication token.
+    #
+    # @return [String] Return the currently valid token.
+    #
+    # @example Generate the token immediately after object instantiation.
+    #   rarbg = RARBG::API.new
+    #   rarbg.token!
+
+    def token!
+      token?
+    end
+
     private
 
     # Wrap requests for error handling.
     def call(params)
       response = request(validate(params))
 
-      return [] if response['error'] == 'No results found'
+      return [] if response['error'] =~ NO_RESULTS_ERRORS_REGEXPS
       raise APIError, response['error'] if response.key?('error')
 
       response.fetch('torrent_results', [])

data/lib/rarbg/version.rb

@@ -2,5 +2,5 @@
 
 module RARBG
   # Gem version.
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/rarbg/search_spec.rb

@@ -52,6 +52,21 @@ RSpec.describe 'RARBG::API#search' do
     end
   end
 
+  context 'when search request returns an id error' do
+    let(:type) { %i[imdb themoviedb tvdb].sample }
+
+    before(:example) do
+      stub_search(
+        @token, {},
+        { error: "Cant find #{type} in database. Are you sure this #{type} exists?" }
+      )
+    end
+
+    it 'returns an empty array' do
+      expect(@rarbg.search(type => '9999999')).to eq([])
+    end
+  end
+
   context 'when search request parameters is not an hash' do
     before(:example) do
       stub_search(

data/spec/rarbg/token_spec.rb

@@ -51,4 +51,26 @@ RSpec.describe RARBG::API do
       expect { @rarbg.list }.to raise_error(Faraday::ConnectionFailed)
     end
   end
+
+  context 'when forcing the token generation' do
+    before(:example) do
+      stub_token(
+        @token
+      )
+    end
+
+    it 'returns the currently valid token' do
+      expect(@rarbg.token!).to eq(@token)
+    end
+
+    context 'when called from top level namespace' do
+      let(:rarbg_module) { RARBG.clone }
+
+      it 'instantiates an API object' do
+        expect { rarbg_module.token! }
+          .to change { rarbg_module.instance_variable_get(:@rarbg).class }
+          .to(RARBG::API)
+      end
+    end
+  end
 end

data/spec/stubs.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+# WebMock stubs for RSpec.
 module Stubs
   API_ENDPOINT = RARBG::API::API_ENDPOINT
 
   def stub_token(token)
     stub_request(:get, API_ENDPOINT)
       .with(query: hash_including('get_token' => 'get_token'))
-      .to_return(status: 200, body: { token: token }.to_json)
+      .to_return(status: 200, body: { token: token }.to_json,
+                 headers: { 'Content-Type' => 'application/json' })
   end
 
   def stub_list(token, params = {}, result = {})
@@ -15,7 +17,8 @@ module Stubs
         mode:  'list',
         token: token
       )))
-      .to_return(status: 200, body: result.to_json)
+      .to_return(status: 200, body: result.to_json,
+                 headers: { 'Content-Type' => 'application/json' })
   end
 
   def stub_search(token, params = {}, result = {})
@@ -24,7 +27,8 @@ module Stubs
         mode:  'search',
         token: token
       )))
-      .to_return(status: 200, body: result.to_json)
+      .to_return(status: 200, body: result.to_json,
+                 headers: { 'Content-Type' => 'application/json' })
   end
 
   def stub_error(status, error)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rarbg
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Tommaso Barbato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,6 +162,7 @@ files:
 - ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"