rarbg 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d15b81ab8d45c3c01c9addc0bce085b59990b9124d80b32b44ad8948edfbb367
-  data.tar.gz: 46b000569403255560866144cf09af78e8b9b6a25bc93bdfa0c6b27117697cd9
+  metadata.gz: 5911f31dd50a010daed44606e68eb58763b55f9c5868c1caa6548b6ce9f48d1f
+  data.tar.gz: cd9d585d2e854852090bea1dfad593544b79cf381ba0f9e639e5fd9fae00d527
 SHA512:
-  metadata.gz: 95aa9133de0794c7b41c44ad000470a3a9d20eb6576ada2e4b850d907027c809979bf6b44fbcb8312e5fa8efb27ff93433df077b98a736b60727c69b2e035278
-  data.tar.gz: 28185dbdf3875c246b2b76bc9a07d3100fa016970bffaae1673d568f64052ac74354f289290b36895533503f2c12295732d533224c7896a9d1f6e5b813662b08
+  metadata.gz: ca6baeeb1a4d8f6d6f78494ea469bf411c212baee4e4614a287eeec20c54225e3eea50fbd6c40fa91cf90dcd14bd67bdba5e4a1faa33482fd1797967df368d52
+  data.tar.gz: e0c233cf49ac9afb85a59078d5c0453b741d172ddc1122025f41d5d5fbcd394c3e4f2844f0331dba448763e74ce517b3d9223afc6a12084c99e77486761d706d

data/CHANGELOG.md

@@ -4,6 +4,21 @@ 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/).
 
+## 2.0.0 - 2020-01-22
+[RubyGems](https://rubygems.org/gems/rarbg/versions/2.0.0) |
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v2.0.0) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v1.4.0...v2.0.0)
+
+#### Changed
+- Update Faraday to v1.0 and drop `faraday_middleware` dependency ([#17](https://github.com/epistrephein/rarbg/pull/17)).
+- Update Ruby minimum version to 2.3 ([#17](https://github.com/epistrephein/rarbg/pull/17)).
+- Rename attr_reader `conn` to `connection` ([#18](https://github.com/epistrephein/rarbg/pull/18)).
+- Remove unnecessary files and attributes from gemspec ([#21](https://github.com/epistrephein/rarbg/pull/21)).
+- Update version constraints for Rake, following v13.0 release ([#15](https://github.com/epistrephein/rarbg/pull/15)).
+- Update version constraints for RuboCop in order to avoid breaking changes ([#16](https://github.com/epistrephein/rarbg/pull/16)).
+- Tweak and reorder documentation ([#18](https://github.com/epistrephein/rarbg/pull/18)).
+
+
 ## 1.4.0 - 2019-06-05
 [RubyGems](https://rubygems.org/gems/rarbg/versions/1.4.0) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v1.4.0) |

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2019 Tommaso Barbato
+Copyright (c) 2016-2020 Tommaso Barbato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -20,14 +20,14 @@ $ gem install rarbg
 Or add it to your Gemfile and execute `bundle install`
 
 ```ruby
-gem 'rarbg', '~> 1.4'
+gem 'rarbg', '~> 2.0'
 ```
 
 ## Usage
 
-This gem wraps all API methods available from [RARBG TorrentAPI](https://torrentapi.org/apidocs_v2.txt).
+This gem wraps all API methods available from [RARBG TorrentAPI](https://torrentapi.org/apidocs_v2.txt?&app_id=rarbg-rubygem).
 
-An authentication token is automatically generated on first request, stored with timestamp and renewed every 800 seconds.
+An authentication token is automatically generated on the first request, stored with a timestamp and renewed every 800 seconds.
 
 Rate limit (1req/2s) is automatically enforced.
 
@@ -91,7 +91,6 @@ RARBG::CATEGORIES
 #      "Movies/XVID/720" => 48,
 #      "Movies/x264"     => 17,
 #      ...
-#    }
 ```
 
 #### Errors

data/lib/rarbg/api.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
+require 'json'
 
 # Main namespace for RARBG.
 module RARBG
-  # Default error class for the module.
+  # Default error class for the module. Wraps exceptions raised at API level.
   class APIError < StandardError; end
 
   # Base class for RARBG API.
@@ -22,26 +22,39 @@ module RARBG
     # Default API rate limit (seconds).
     RATE_LIMIT = 2.1
 
-    # @return [Faraday::Connection] the Faraday connection object.
-    attr_reader :conn
+    # The underlying `Faraday::Connection` object used to perform requests.
+    #
+    # @note For more info regarding this object refer to the
+    #   {https://www.rubydoc.info/gems/faraday/Faraday Faraday documentation}.
+    #
+    # @return [Faraday::Connection] The Faraday connection object.
+    attr_reader :connection
+
+    # The monotonic timestamp of the last request performed.
+    #   Used to comply with the endpoint rate limit based on {RATE_LIMIT}.
+    #
+    # @return [Float] The monotonic timestamp of the last request performed.
+    attr_reader :last_request
 
-    # @return [String] the token used for authentication.
+    # The token used for authentication.
+    #   This is generated and rate limited automatically when calling {#list}
+    #   or {#search}, but can also be generated forcefully using {#token!}.
+    #
+    # @return [String] The token used for authentication.
     attr_reader :token
 
-    # @return [Integer] the monotonic timestamp of the token request.
+    # The monotonic timestamp of the token request.
+    #   Used to compute the next required token request based on {TOKEN_EXPIRATION}.
+    #
+    # @return [Float] The monotonic timestamp of the token request.
     attr_reader :token_time
 
-    # @return [Integer] the monotonic timestamp of the last request performed.
-    attr_reader :last_request
-
     # Initialize a new instance of `RARBG::API`.
     #
     # @example
     #   rarbg = RARBG::API.new
     def initialize
-      @conn = Faraday.new(url: API_ENDPOINT) do |conn|
-        conn.request  :json
-        conn.response :json, content_type: /\bjson$/
+      @connection = Faraday.new(url: API_ENDPOINT) do |conn|
         conn.response :logger if $VERBOSE
         conn.adapter  Faraday.default_adapter
 
@@ -55,47 +68,54 @@ module RARBG
 
     # List torrents.
     #
+    # @example List last 100 ranked torrents in `Movies/x264/1080` category
+    #   rarbg = RARBG::API.new
+    #   rarbg.list(limit: 100, ranked: true, category: [44])
+    #
+    # @example List torrents with at least 50 seeders
+    #   rarbg = RARBG::API.new
+    #   rarbg.list(min_seeders: 50)
+    #
     # @param params [Hash] A customizable set of parameters.
     #
     # @option params [Array<Integer>] :category Filter results by category.
     # @option params [Symbol] :format Format results.
-    #   Accepted values: `:json`, `:json_extended`. Default: `:json`.
+    #   Accepted values: `:json`, `:json_extended`.
+    #   Default: `:json`.
     # @option params [Integer] :limit Limit results number.
-    #   Accepted 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.
-    #   Accepted values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
-    #
-    # @return [Array<Hash>] Return torrents that match the specified parameters.
+    #   Accepted values: `:last`, `:seeders`, `:leechers`.
+    #   Default: `:last`.
     #
-    # @raise [ArgumentError] Exception raised if `params` is not an `Hash`.
-    # @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).
+    # @return [Array<Hash>] Torrents that match the specified parameters.
     #
-    # @example List last 100 ranked torrents in `Movies/x264/1080`
-    #   rarbg = RARBG::API.new
-    #   rarbg.list(limit: 100, ranked: true, category: [44])
-    #
-    # @example List torrents with at least 50 seeders
-    #   rarbg = RARBG::API.new
-    #   rarbg.list(min_seeders: 50)
+    # @raise [ArgumentError] If `params` is not an `Hash`.
+    # @raise [RARBG::APIError] If the request fails or the endpoint responds
+    #   with an error.
+    # @raise [Faraday::Error] On low-level connection errors (e.g. timeouts).
     def list(params = {})
       raise ArgumentError, 'Expected params hash' unless params.is_a?(Hash)
 
-      params.update(
-        mode:  'list',
-        token: token?
-      )
+      params.update(mode: 'list', token: token?)
       call(params)
     end
 
     # Search torrents.
     #
+    # @example Search by IMDb ID, sorted by leechers and in extended format.
+    #   rarbg = RARBG::API.new
+    #   rarbg.search(imdb: 'tt2488496', sort: :leechers, format: :json_extended)
+    #
+    # @example Search unranked torrents by string, with at least 2 seeders.
+    #   rarbg = RARBG::API.new
+    #   rarbg.search(string: 'Star Wars', ranked: false, min_seeders: 2)
+    #
     # @param params [Hash] A customizable set of parameters.
     #
     # @option params [String] :string Search by string.
@@ -104,51 +124,41 @@ 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.
-    #   Accepted values: `:json`, `:json_extended`. Default: `:json`.
+    #   Accepted values: `:json`, `:json_extended`.
+    #   Default: `:json`.
     # @option params [Integer] :limit Limit results number.
-    #   Accepted 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.
-    #   Accepted values: `:last`, `:seeders`, `:leechers`. Default: `:last`.
+    #   Accepted values: `:last`, `:seeders`, `:leechers`.
+    #   Default: `:last`.
     #
-    # @return [Array<Hash>] Return torrents that match the specified parameters.
+    # @return [Array<Hash>] 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
+    # @raise [ArgumentError] If `params` is not an `Hash`.
+    # @raise [ArgumentError] If no search type param is passed
     #   (among `string`, `imdb`, `tvdb`, `themoviedb`).
-    # @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
-    #   rarbg.search(imdb: 'tt2488496', sort: :leechers, format: :json_extended)
-    #
-    # @example Search unranked torrents by string, with at least 2 seeders.
-    #   rarbg = RARBG::API.new
-    #   rarbg.search(string: 'Star Wars', ranked: false, min_seeders: 2)
+    # @raise [RARBG::APIError] If the request fails or the endpoint responds
+    #   with an error.
+    # @raise [Faraday::Error] On low-level connection errors (e.g. timeouts).
     def search(params = {})
       raise ArgumentError, 'Expected params hash' unless params.is_a?(Hash)
 
-      params.update(
-        mode:  'search',
-        token: token?
-      )
+      params.update(mode: 'search', token: token?)
       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!
-
+    #
+    # @return [String] The currently valid authentication token.
     def token!
       token?
     end
@@ -184,6 +194,7 @@ module RARBG
       normalize.each_pair do |key, proc|
         params[key] = proc.call(params[key]) if params.key?(key)
       end
+
       params
     end
 
@@ -202,6 +213,7 @@ module RARBG
       SEARCH_KEYS.each do |k|
         params["search_#{k}"] = params.delete(k) if params.key?(k)
       end
+
       params
     end
 
@@ -217,20 +229,22 @@ module RARBG
     # Return or renew auth token.
     def token?
       if token.nil? || time >= (token_time.to_f + TOKEN_EXPIRATION)
-        response = request(get_token: 'get_token')
-        @token = response.fetch('token')
+        response    = request(get_token: 'get_token')
+        @token      = response.fetch('token')
         @token_time = time
       end
+
       token
     end
 
     # Perform API request.
     def request(params)
       rate_limit!(RATE_LIMIT)
-      response = conn.get(nil, params)
+
+      response      = connection.get(nil, params)
       @last_request = time
 
-      return response.body if response.success?
+      return JSON.parse(response.body) if response.success?
 
       raise APIError, "#{response.reason_phrase} (#{response.status})"
     end

data/lib/rarbg/version.rb

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

data/rarbg.gemspec

@@ -15,12 +15,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/epistrephein/rarbg'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(spec|docs)/})
-  end
-  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.require_path  = 'lib'
-
   spec.metadata = {
     'bug_tracker_uri'   => 'https://github.com/epistrephein/rarbg/issues',
     'changelog_uri'     => 'https://github.com/epistrephein/rarbg/blob/master/CHANGELOG.md',
@@ -29,16 +23,19 @@ Gem::Specification.new do |spec|
     'source_code_uri'   => 'https://github.com/epistrephein/rarbg'
   }
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.files         = Dir['lib/**/*.rb', 'rarbg.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE']
+  spec.require_path  = 'lib'
+
+  spec.required_ruby_version = '>= 2.3'
 
-  spec.add_runtime_dependency 'faraday', '~> 0.12'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0.12'
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '>= 1.15', '< 3.0'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '>= 12.0', '< 14.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'rubocop', '~> 0.71'
+  spec.add_development_dependency 'rubocop', '~> 0.71', '< 0.77'
   spec.add_development_dependency 'simplecov', '~> 0.13'
   spec.add_development_dependency 'webmock', '~> 3.0'
   spec.add_development_dependency 'yard', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rarbg
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tommaso Barbato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +62,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +99,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.71'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.77'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -114,6 +109,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.71'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.77'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -162,37 +160,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/BUG_REPORT.md"
-- ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".gitignore"
-- ".hound.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/rarbg.rb
 - lib/rarbg/api.rb
 - lib/rarbg/categories.rb
 - lib/rarbg/version.rb
 - rarbg.gemspec
-- spec/rarbg/list_spec.rb
-- spec/rarbg/rarbg_spec.rb
-- spec/rarbg/search_spec.rb
-- spec/rarbg/token_spec.rb
-- spec/spec_helper.rb
-- spec/stubs.rb
 homepage: https://github.com/epistrephein/rarbg
 licenses:
 - MIT
@@ -210,21 +185,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: RARBG API Ruby client.
-test_files:
-- spec/rarbg/list_spec.rb
-- spec/rarbg/rarbg_spec.rb
-- spec/rarbg/search_spec.rb
-- spec/rarbg/token_spec.rb
-- spec/spec_helper.rb
-- spec/stubs.rb
+test_files: []