rarbg 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a91ed44e5ad44e77bc5bd06fe75f9ef2d746cef0
-  data.tar.gz: 5b20b46f1dd9c91f13d1a5446fda6c0d7644832f
+  metadata.gz: 9c363697d12aee6fc8092c9c9ffd9a9cf9e15590
+  data.tar.gz: 6ea7ffedae9962a448abe88ef7d5cfe28f758a6f
 SHA512:
-  metadata.gz: 56b316e40fc95f82e58965cbdc0e647da001d7b64b94d474884bb9f47cf8f7a06ef3f8623c00c2464d43e4a3d028b617d55ad99ff75d7802b8fdd2f49541368e
-  data.tar.gz: 10dbe3daef729954e12e7d56321af8029ac1b5b64a68d5e4f9244f32bd868da8d5c135839b8c54494a7a0d065753fb195be7bc4e9fd7b55d651990620136f4ef
+  metadata.gz: cba0cfb521eaa9f43b4a6e93e0223832922323b37f02ddd3301624bfda0e059e0a76b619a4cff267aa12b29589f46127dd8b7c9a69564e8e49374458105eae04
+  data.tar.gz: 76527bbe48867db464f5f598e5ee03904db8e0e5f8d9e519231283b5c594c4d938ee7fa12e76d2e0d14c7cfdf70ac1f9c95146d6c82767a3537c370f9403e711

data/.gitignore

@@ -8,31 +8,32 @@
 /test/version_tmp/
 /tmp/
 
-## Version specifiers:
+# Version specifiers
 Gemfile.lock
 .ruby-version
 .ruby-gemset
 
-## Environment normalization:
+# Environment normalization
 /.bundle/
 /lib/bundler/man/
 
-## RSpec:
+# RSpec
 /spec/reports/
 /spec/examples.txt
 .rspec_status
 
-## Documentation cache:
+# Documentation cache
 /.yardoc/
 /_yardoc/
 /doc/
 /rdoc/
 
-## Logs:
+# Logs
 *.log
+*.log.[0-9]*
 
-## RVM:
+# RVM
 .rvmrc
 
-## Project specific:
+# Project specific
 apidocs_v2.txt

data/.travis.yml

@@ -1,12 +1,11 @@
 sudo: false
 language: ruby
-before_install: gem install bundler -v 1.16.1
+cache: bundler
 script: bundle exec rspec
 rvm:
   - 2.5.1
   - 2.4.4
   - 2.3.7
-  - 2.2.10
 branches:
   only: master
 notifications:

data/CHANGELOG.md

@@ -1,10 +1,26 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.  
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## Unreleased
+[Diff](https://github.com/epistrephein/rarbg/compare/v1.1.0...master)
+
+
+## 1.1.0 - 2018-10-05
+[RubyGems](https://rubygems.org/gems/rarbg/versions/1.1.0) |
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v1.1.0) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v1.0.1...v1.1.0)
+
+#### Added
+- `list` and `search` methods are now available from top level namespace.
+- `RARBG::CATEGORIES` now returns name/id pairs of all RARBG categories.
+- Faraday now uses the `APP_ID` as User agent.
+
 
 ## 1.0.1 - 2018-05-04
+[RubyGems](https://rubygems.org/gems/rarbg/versions/1.0.1) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v1.0.1) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v1.0.0...v1.0.1)
 
@@ -17,6 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
 ## 1.0.0 – 2018-04-02
+[RubyGems](https://rubygems.org/gems/rarbg/versions/1.0.0) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v1.0.0) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v0.1.4...v1.0.0)
 
@@ -37,6 +54,7 @@ search type must be specified as a keyword argument upon `search`.
 
 
 ## 0.1.4 – 2017-12-22
+[RubyGems](https://rubygems.org/gems/rarbg/versions/0.1.4) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.4) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v0.1.3...v0.1.4)
 
@@ -45,6 +63,7 @@ search type must be specified as a keyword argument upon `search`.
 
 
 ## 0.1.3 – 2016-12-23
+[RubyGems](https://rubygems.org/gems/rarbg/versions/0.1.3) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.3) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v0.1.2...v0.1.3)
 
@@ -53,6 +72,7 @@ search type must be specified as a keyword argument upon `search`.
 
 
 ## 0.1.2 – 2016-12-21
+[RubyGems](https://rubygems.org/gems/rarbg/versions/0.1.2) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.2) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v0.1.1...v0.1.2)
 
@@ -61,6 +81,7 @@ search type must be specified as a keyword argument upon `search`.
 
 
 ## 0.1.1 – 2016-12-21
+[RubyGems](https://rubygems.org/gems/rarbg/versions/0.1.1) |
 [Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.1) |
 [Diff](https://github.com/epistrephein/rarbg/compare/v0.1.0...v0.1.1)
 
@@ -70,4 +91,4 @@ search type must be specified as a keyword argument upon `search`.
 
 ## 0.1.0 – 2016-12-21
 
-Initial release. Yanked from [rubygems](https://rubygems.org).
+Initial release. Yanked from [RubyGems](https://rubygems.org).

data/CODE_OF_CONDUCT.md

@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,13 +1,13 @@
 # RARBG
 [![Gem Version](https://img.shields.io/gem/v/rarbg.svg?colorB=brightgreen)](https://rubygems.org/gems/rarbg)
 [![Build status](https://travis-ci.org/epistrephein/rarbg.svg?branch=master)](https://travis-ci.org/epistrephein/rarbg)
+[![Dependencies](https://badges.depfu.com/badges/32877a5a58ad7eb3f5db321d85a23c1b/overview.svg)](https://depfu.com/github/epistrephein/rarbg?project_id=5845)
 [![Maintainability](https://api.codeclimate.com/v1/badges/adf6a91b754bb4aaacf2/maintainability)](https://codeclimate.com/github/epistrephein/rarbg/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/adf6a91b754bb4aaacf2/test_coverage)](https://codeclimate.com/github/epistrephein/rarbg/test_coverage)
-[![Dependency Status](https://gemnasium.com/badges/github.com/epistrephein/rarbg.svg)](https://gemnasium.com/epistrephein/rarbg)
-[![Security](https://hakiri.io/github/epistrephein/rarbg/master.svg)](https://hakiri.io/github/epistrephein/rarbg/master)
-[![Inline docs](http://inch-ci.org/github/epistrephein/rarbg.svg?branch=master)](http://inch-ci.org/github/epistrephein/rarbg)
+[![Inline docs](https://inch-ci.org/github/epistrephein/rarbg.svg?branch=master)](https://inch-ci.org/github/epistrephein/rarbg)
+[![Documentation](https://img.shields.io/badge/docs-yard-blue.svg)](https://www.rubydoc.info/github/epistrephein/rarbg/master)
 
-Ruby wrapper for RARBG Torrent API.
+Ruby wrapper for the RARBG Torrent API.
 
 ## Installation
 
@@ -23,7 +23,7 @@ Or add it to your Gemfile and execute `bundle install`
 gem 'rarbg', '~> 1.0'
 ```
 
-## Usage [![Documentation](https://img.shields.io/badge/docs-yard-blue.svg)](http://www.rubydoc.info/github/epistrephein/rarbg)
+## Usage
 
 This gem wraps all API methods available from [RARBG TorrentAPI](https://torrentapi.org/apidocs_v2.txt).
 
@@ -72,6 +72,25 @@ rarbg.search(imdb: 'tt2488496', category: [44, 45])
 rarbg.search(themoviedb: 140607, ranked: false, sort: :last)
 ```
 
+These methods are also available from the top module namespace for convenience.
+
+```ruby
+RARBG.list(sort: :leechers, min_leechers: 10)
+
+RARBG.search(string: 'Star Wars', category: [48])
+```
+
+A list of name/id pairs for each category is also available for quick lookup.
+
+```ruby
+RARBG::CATEGORIES
+# => { "Movies/XVID"     => 14,
+#      "Movies/XVID/720" => 48,
+#      "Movies/x264"     => 17,
+#      ...
+#    }
+```
+
 #### Errors
 
 API endpoint errors will raise a `RARBG::APIError` exception with the API error message.
@@ -97,11 +116,11 @@ rarbg.search(limit: 50)
 # => ArgumentError: At least one parameter required among string, imdb, tvdb, themoviedb for search mode.
 ```
 
-## Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](http://makeapullrequest.com)
+## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/epistrephein/rarbg).
 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code of Conduct](https://github.com/epistrephein/rarbg/blob/master/CODE_OF_CONDUCT.md).
 
 You can contribute changes by forking the project and submitting a pull request. To get started:
 
@@ -113,5 +132,6 @@ You can contribute changes by forking the project and submitting a pull request.
 6. Push to the branch (`git push origin my-new-feature`)
 7. Create a new pull request
 
-## License [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
-This gem is released as open source under the terms of the [MIT License](LICENSE).
+## License
+
+This gem is released as open source under the terms of the [MIT License](https://github.com/epistrephein/rarbg/blob/master/LICENSE).

data/lib/rarbg.rb

@@ -1,4 +1,17 @@
 # frozen_string_literal: true
 
 require 'rarbg/version'
+require 'rarbg/categories'
 require 'rarbg/api'
+
+# Module shortcut methods
+module RARBG
+  class << self
+    %i[list search].each do |m|
+      define_method(m) do |*arg|
+        @rarbg ||= RARBG::API.new
+        @rarbg.send(m, *arg)
+      end
+    end
+  end
+end

data/lib/rarbg/api.rb

@@ -19,6 +19,9 @@ module RARBG
     # Default token expiration time.
     TOKEN_EXPIRATION = 800
 
+    # Default API rate limit.
+    RATE_LIMIT = 2.1
+
     # @return [Faraday::Connection] the Faraday connection object.
     attr_reader :conn
 
@@ -45,7 +48,8 @@ module RARBG
         conn.options.timeout = 90
         conn.options.open_timeout = 10
 
-        conn.params[:app_id] = APP_ID
+        conn.headers[:user_agent] = APP_ID
+        conn.params[:app_id]      = APP_ID
       end
     end
 
@@ -198,7 +202,7 @@ module RARBG
 
     # Perform API request.
     def request(params)
-      rate_limit!(2.1)
+      rate_limit!(RATE_LIMIT)
 
       response = @conn.get(nil, params)
       @last_request = time

data/lib/rarbg/categories.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RARBG
+  # RARBG categories
+  CATEGORIES = {
+    'Movies/XVID'        => 14,
+    'Movies/XVID/720'    => 48,
+    'Movies/x264'        => 17,
+    'Movies/x264/1080'   => 44,
+    'Movies/x264/720'    => 45,
+    'Movies/x264/3D'     => 47,
+    'Movies/x264/4k'     => 50,
+    'Movies/x265/4k'     => 51,
+    'Movies/x265/4k/HDR' => 52,
+    'Movies/Full BD'     => 42,
+    'Movies/BD Remux'    => 46,
+    'TV Episodes'        => 18,
+    'TV HD Episodes'     => 41,
+    'TV UHD Episodes'    => 49,
+    'Music/MP3'          => 23,
+    'Music/FLAC'         => 25,
+    'Games/PC ISO'       => 27,
+    'Games/PC RIP'       => 28,
+    'Games/PS3'          => 40,
+    'Games/PS4'          => 53,
+    'Games/XBOX-360'     => 32,
+    'Software/PC ISO'    => 33,
+    'XXX'                =>  4
+  }.freeze
+end

data/lib/rarbg/version.rb

@@ -2,5 +2,5 @@
 
 module RARBG
   # Gem version
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/rarbg.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = 'epistrephein@gmail.com'
 
   spec.summary       = 'RARBG Ruby client.'
-  spec.description   = 'Ruby wrapper for RARBG Torrent API.'
+  spec.description   = 'Ruby wrapper for the RARBG Torrent API.'
   spec.homepage      = 'https://github.com/epistrephein/rarbg'
   spec.license       = 'MIT'
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'bug_tracker_uri'   => 'https://github.com/epistrephein/rarbg/issues',
     'changelog_uri'     => 'https://github.com/epistrephein/rarbg/blob/master/CHANGELOG.md',
-    'documentation_uri' => "http://www.rubydoc.info/gems/rarbg/#{RARBG::VERSION}",
+    'documentation_uri' => "https://www.rubydoc.info/gems/rarbg/#{RARBG::VERSION}",
     'homepage_uri'      => 'https://github.com/epistrephein/rarbg',
     'source_code_uri'   => 'https://github.com/epistrephein/rarbg'
   }
@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0'
-  spec.add_development_dependency 'webmock', '~> 3.3'
+  spec.add_development_dependency 'webmock', '~> 3.4'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/spec/rarbg/list_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe RARBG::API do
+RSpec.describe 'RARBG::API#list' do
   before(:all) do
     @rarbg = RARBG::API.new
     @token = SecureRandom.hex(5)
@@ -92,4 +92,20 @@ RSpec.describe RARBG::API do
       )
     end
   end
+
+  context 'when called from top level namespace' do
+    let(:rarbg_module) { RARBG.clone }
+
+    before(:example) do
+      stub_list(
+        @token
+      )
+    end
+
+    it 'instantiates an API object' do
+      expect { rarbg_module.list }
+        .to change { rarbg_module.instance_variable_get(:@rarbg).class }
+        .to(RARBG::API)
+    end
+  end
 end

data/spec/rarbg/rarbg_spec.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-RSpec.describe RARBG::API do
+RSpec.describe RARBG do
   it 'has a version number' do
     expect(RARBG::VERSION).not_to be nil
+    expect(RARBG::VERSION).to match(/(\d+\.)(\d+\.)(\d+)(-?[\S]+)?/)
+  end
+
+  it 'has a category list' do
+    expect(RARBG::CATEGORIES).to be_kind_of(Hash)
+    expect(RARBG::CATEGORIES).to include(/Movies/, /TV/, /Music/)
   end
 
   it 'has an app id' do
     expect(RARBG::API::APP_ID).not_to be nil
+    expect(RARBG::API::APP_ID).to be_kind_of(String)
   end
 
   it 'has the correct API endpoint' do
@@ -16,4 +23,8 @@ RSpec.describe RARBG::API do
   it 'has a token expiration' do
     expect(RARBG::API::TOKEN_EXPIRATION).to be_kind_of(Numeric)
   end
+
+  it 'has a rate limit' do
+    expect(RARBG::API::RATE_LIMIT).to be_kind_of(Numeric)
+  end
 end

data/spec/rarbg/search_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe RARBG::API do
+RSpec.describe 'RARBG::API#search' do
   before(:all) do
     @rarbg = RARBG::API.new
     @token = SecureRandom.hex(5)
@@ -29,7 +29,7 @@ RSpec.describe RARBG::API do
       )
     end
 
-    it 'returns and array of hashes' do
+    it 'returns an array of hashes' do
       expect(@rarbg.search(string: 'a search string')).to all(be_an(Hash))
     end
 
@@ -104,4 +104,20 @@ RSpec.describe RARBG::API do
       )
     end
   end
+
+  context 'when called from top level namespace' do
+    let(:rarbg_module) { RARBG.clone }
+
+    before(:example) do
+      stub_search(
+        @token
+      )
+    end
+
+    it 'instantiates an API object' do
+      expect { rarbg_module.search(string: 'string') }
+        .to change { rarbg_module.instance_variable_get(:@rarbg).class }
+        .to(RARBG::API)
+    end
+  end
 end

data/spec/rarbg/token_spec.rb

@@ -25,8 +25,8 @@ RSpec.describe RARBG::API do
       expect(@rarbg.token_time).to be_a(Numeric)
     end
 
-    it 'has last request > token_time' do
-      expect(@rarbg.last_request - @rarbg.token_time).to be > 2
+    it 'respects rate limit' do
+      expect(@rarbg.last_request - @rarbg.token_time).to be >= RARBG::API::RATE_LIMIT
     end
   end
 

data/spec/spec_helper.rb

@@ -20,6 +20,9 @@ RSpec.configure do |config|
   # Disable RSpec exposing methods globally on `Module` and `main`
   config.disable_monkey_patching!
 
+  # Enable temporarily focused examples and groups
+  config.filter_run_when_matching :focus
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

data/spec/stubs.rb

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
 module Stubs
-  BASE_URL = 'https://torrentapi.org/pubapi_v2.php'
-  APP_ID   = 'rarbg-rubygem'
+  API_ENDPOINT = RARBG::API::API_ENDPOINT
 
   def stub_token(token)
-    stub_request(:get, BASE_URL)
+    stub_request(:get, API_ENDPOINT)
       .with(query: hash_including('get_token' => 'get_token'))
       .to_return(status: 200, body: { token: token }.to_json)
   end
 
   def stub_list(token, params = {}, result = {})
-    stub_request(:get, BASE_URL)
+    stub_request(:get, API_ENDPOINT)
       .with(query: hash_including(params.update(
         mode:  'list',
         token: token
@@ -20,7 +19,7 @@ module Stubs
   end
 
   def stub_search(token, params = {}, result = {})
-    stub_request(:get, BASE_URL)
+    stub_request(:get, API_ENDPOINT)
       .with(query: hash_including(params.update(
         mode:  'search',
         token: token
@@ -29,13 +28,13 @@ module Stubs
   end
 
   def stub_error(status, error)
-    stub_request(:get, BASE_URL)
+    stub_request(:get, API_ENDPOINT)
       .with(query: hash_including({}))
       .to_return(status: [status, error])
   end
 
   def stub_timeout
-    stub_request(:get, BASE_URL)
+    stub_request(:get, API_ENDPOINT)
       .with(query: hash_including({}))
       .to_timeout
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rarbg
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tommaso Barbato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Ruby wrapper for RARBG Torrent API.
+description: Ruby wrapper for the RARBG Torrent API.
 email: epistrephein@gmail.com
 executables: []
 extensions: []
@@ -157,6 +157,7 @@ files:
 - bin/setup
 - lib/rarbg.rb
 - lib/rarbg/api.rb
+- lib/rarbg/categories.rb
 - lib/rarbg/version.rb
 - rarbg.gemspec
 - spec/rarbg/list_spec.rb
@@ -171,7 +172,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/epistrephein/rarbg/issues
   changelog_uri: https://github.com/epistrephein/rarbg/blob/master/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/rarbg/1.0.1
+  documentation_uri: https://www.rubydoc.info/gems/rarbg/1.1.0
   homepage_uri: https://github.com/epistrephein/rarbg
   source_code_uri: https://github.com/epistrephein/rarbg
 post_install_message: