rarbg 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df7a25793709ac040727f5773f929996be08dd84
-  data.tar.gz: a769ebf5a4236dce346a9322585361626a3ae3b4
+  metadata.gz: 97d8036d6683ad8f531bfbdce8a3b84ae80cc48d
+  data.tar.gz: 9934b0ac6016d6b8cb9d8b4f62ad674f611603d8
 SHA512:
-  metadata.gz: '07729fdfb40503aa686ff406efcc2805db57f9b91a3265a24b0021c6a504196f3d5cbba231cd3425657dcb8acc7df7519dd74efb657e9961cde392a9f5d0a7ae'
-  data.tar.gz: 620904fedf16ebd5c33d0c05e81db1463f9d7355af7407acaab08b7b954e2a4ab5e057cae1f3da00889178e42598d97e34403f75f5634401f2cdccdfe4b696d7
+  metadata.gz: b8659a8ac02af06b417eabed6e871eea5c2e16dac2c9fdf71f2ea653a17832845c16f722f479f4eb4d8551e6da397dbd83bdedbc22ba3024feefc1b7e69335dd
+  data.tar.gz: b19db1e895fd7cc59ff7ba5104062b63aef09bb89f6ad9d62d492495ea8023f8a10bdecb747e7f0b793715dd25df3c4276e3ef2d72c063531cc22cdc777e8373

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Version specifiers:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+## Environment normalization:
+/.bundle/
+/lib/bundler/man/
+
+## RSpec:
+/spec/reports/
+/spec/examples.txt
+.rspec_status
+
+## Documentation cache:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Logs:
+*.log
+
+## RVM:
+.rvmrc
+
+## Project specific:
+apidocs_v2.txt

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--order random
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,22 @@
+sudo: false
+language: ruby
+before_install: gem install bundler -v 1.16.1
+script: bundle exec rspec
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.10
+branches:
+  only: master
+notifications:
+  email: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ca61b641c417ff48e8cff3c0d10e5503539bf81348b0df8daca6c74e2401d4e4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--markup markdown
+-
+CHANGELOG.md
+LICENSE
+README.md

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# 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/).
+
+## 1.0.0 – 2018-04-02
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v1.0.0) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v0.1.4...v1.0.0)
+
+#### Changed
+- Codebase has been completely refactored to be more resilient and error-free.
+- This release is NOT backward compatible with 0.1 versions.
+- Query parameters now use standard ruby syntax as expected and accept both
+symbol and string keys.
+- Compliance with API rate limiting (1req/2s) is now enforced automatically.
+- Empty results now return an empty array instead of raising an exception.
+
+#### Removed
+- Removed `default_params`: query parameters are now passed per request.
+- Removed `search_string`, `search_imdb`, `search_themoviedb`, `search_tvdb`:
+search type must be specified as a keyword argument upon `search`.
+- Removed `RequestError` exception: all API-related errors now raise an
+`APIError` exception.
+
+
+## 0.1.4 – 2017-12-22
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.4) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v0.1.3...v0.1.4)
+
+#### Fixed
+- Set Faraday middleware before adapter to suppress warning
+
+
+## 0.1.3 – 2016-12-23
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.3) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v0.1.2...v0.1.3)
+
+#### Changed
+- Move `app_id` and `token` params to `call` method to prevent override
+
+
+## 0.1.2 – 2016-12-21
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.2) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v0.1.1...v0.1.2)
+
+#### Changed
+- Sleep for 2 seconds after `get_token` to avoid request limit error
+
+
+## 0.1.1 – 2016-12-21
+[Release](https://github.com/epistrephein/rarbg/releases/tag/v0.1.1) |
+[Diff](https://github.com/epistrephein/rarbg/compare/v0.1.0...v0.1.1)
+
+#### Fixed
+- Fix invalid gemspec
+
+
+## 0.1.0 – 2016-12-21
+
+Yanked

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at epistrephein@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+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]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-2018 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# RARBG
+[![Gem Version](https://img.shields.io/gem/v/rarbg.svg?colorB=brightgreen&style=flat-square)](https://rubygems.org/gems/rarbg)
+[![Build status](https://img.shields.io/travis/epistrephein/rarbg/master.svg?style=flat-square)](https://travis-ci.org/epistrephein/rarbg)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/epistrephein/rarbg.svg?style=flat-square)](https://codeclimate.com/github/epistrephein/rarbg)
+[![Coverage](https://img.shields.io/codeclimate/c/epistrephein/rarbg.svg?style=flat-square)](https://codeclimate.com/github/epistrephein/rarbg)
+[![Dependency Status](https://img.shields.io/gemnasium/epistrephein/rarbg.svg?style=flat-square)](https://gemnasium.com/epistrephein/rarbg)
+[![Inline docs](http://inch-ci.org/github/epistrephein/rarbg.svg?branch=master&style=flat-square)](http://inch-ci.org/github/epistrephein/rarbg)
+
+Ruby wrapper for RARBG Torrent API.
+
+## Installation
+
+Install as a gem
+
+```shell
+$ gem install rarbg
+```
+
+Or add it to your Gemfile and execute `bundle install`
+
+```ruby
+gem 'rarbg', '~> 1.0'
+```
+
+## Usage [![Documentation](https://img.shields.io/badge/docs-yard-blue.svg?style=flat-square)](http://www.rubydoc.info/gems/rarbg)
+
+This gem wraps all API methods available from [RARBG TorrentAPI](https://torrentapi.org/apidocs_v2.txt).
+
+An authentication token is automatically generated on first request, stored with timestamp and renewed every 800 seconds.
+
+#### Getting started
+
+Require the gem and initialize a new `RARBG::API` object.
+
+```ruby
+require 'rarbg'
+
+rarbg = RARBG::API.new
+```
+
+#### Methods
+
+Use `list` to list torrents.
+Additional parameters are passed as keyword arguments and can be mixed together.
+
+All successful method calls return an array of hashes.
+
+```ruby
+# List last 100 torrents.
+rarbg.list(limit: 100)
+
+# List all torrents with at least 20 seeders, sorted by seeders.
+rarbg.list(min_seeders: 100, sort: :seeders)
+
+# List torrents with extended json infos.
+rarbg.list(format: :json_extended)
+```
+
+Use `search` to search torrents.
+One search type parameter among `string`, `imdb`, `themoviedb` and `tvdb` is required.
+
+```ruby
+# Search torrents using literal string query.
+rarbg.search(string: 'Force Awakens')
+
+# Search by IMDB id, in `Movies/x264/1080` and `Movies/x264/720`.
+# Note that 'tt' can be omitted when passing an IMDB id.
+rarbg.search(imdb: 'tt2488496', category: [44, 45])
+
+# Search unranked torrents by TheMovieDB id, sorted by last.
+rarbg.search(themoviedb: 140607, ranked: false, sort: :last)
+```
+
+#### Errors
+
+API endpoint errors will raise a `RARBG::APIError` exception with the API error message.
+
+```ruby
+rarbg.list(sort: :name)
+# => RARBG::APIError: Invalid sort
+
+rarbg.search(string: 'Star Wars', min_seeders: 'notanumber')
+# => RARBG::APIError: Invalid value for min_seeders
+
+rarbg.search(imdb: 'tt0121765')
+# => RARBG::APIError: Service unavailable (503)
+```
+
+Parameter validation errors on client side will raise an `ArgumentError`.
+
+```ruby
+rarbg.list('a string instead of an hash')
+# => ArgumentError: Expected params hash
+
+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?style=flat-square)](http://makeapullrequest.com)
+
+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).
+
+You can contribute changes by forking the project and submitting a pull request. To get started:
+
+1. Fork the repo
+2. Install the dependencies (`bin/setup`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Pass the test suite (`rake spec`)
+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?style=flat-square)](LICENSE)
+This gem is released as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rarbg'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/rarbg.rb

@@ -1,123 +1,4 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'json'
-require 'time'
+# frozen_string_literal: true
 
-# A ruby wrapper for RARBG torrentapi.
-module RARBG
-  VERSION = '0.1.4'.freeze
-  APP_ID = 'rarbg-rubygem'.freeze
-  API_ENDPOINT = 'https://torrentapi.org/pubapi_v2.php'.freeze
-  TOKEN_EXPIRATION = 800
-
-  # Exception for low level request errors.
-  class RequestError < StandardError; end
-  # Exception for high level API errors.
-  class APIError < StandardError; end
-
-  # API class for performing requests.
-  class API
-    # API +token+ is stored with timestamped +token_time+.
-    attr_reader   :token, :token_time
-
-    # Any API call passes +default_params+ unless overidden.
-    attr_accessor :default_params
-
-    # Returns a new API object with +@default_params+ defined in +params+.
-    def initialize(params = {})
-      @default_params = {
-        'limit'  => 25,
-        'sort'   => 'last',
-        'format' => 'json_extended'
-      }.merge!(params)
-    end
-
-    # Lists all torrents.
-    # Accepts query parameters from +params+.
-    # Returns an array of hashes.
-    def list(params = {})
-      call({ 'mode' => 'list' }, params)
-    end
-
-    # Searches torrents by literal name from +string+.
-    # Accepts query parameters from +params+.
-    # Returns an array of hashes of matching elements.
-    # Raises APIError if no results are found.
-    def search_string(string, params = {})
-      call({ 'mode' => 'search', 'search_string' => string }, params)
-    end
-
-    # Searches by IMDb ID from +imdbid+.
-    # Accepts query parameters from +params+.
-    # Returns an array of hashes of matching elements.
-    # Raises APIError if no results are found.
-    def search_imdb(imdbid, params = {})
-      imdbid = "tt#{imdbid}" unless imdbid =~ /^tt\d+$/
-      call({ 'mode' => 'search', 'search_imdb' => imdbid }, params)
-    end
-
-    # Searches by TVDB ID from +tvdbid+.
-    # Accepts query parameters from +params+.
-    # Returns an array of hashes of matching elements.
-    # Raises APIError if no results are found.
-    def search_tvdb(tvdbid, params = {})
-      call({ 'mode' => 'search', 'search_tvdb' => tvdbid }, params)
-    end
-
-    # Searches by The Movie Database ID from +themoviedbid+
-    # Accepts query parameters from +params+.
-    # Returns an array of hashes of matching elements.
-    # Raises APIError if no results are found.
-    def search_themoviedb(themoviedbid, params = {})
-      call({ 'mode' => 'search', 'search_themoviedb' => themoviedbid }, params)
-    end
-
-    private
-
-    # Performs API call.
-    def call(method_params, custom_params)
-      raise ArgumentError, 'not an Hash' unless custom_params.is_a?(Hash)
-      check_token
-
-      res = request.get do |req|
-        req.params.merge!(@default_params)
-        req.params.merge!(custom_params)
-        req.params.merge!(method_params)
-
-        req.params['app_id'] = APP_ID
-        req.params['token'] = @token
-      end
-      raise RequestError, res.reason_phrase unless res.success?
-      raise APIError, res.body['error'] if res.body['error']
-
-      res.body['torrent_results']
-    end
-
-    # Checks if +token+ is empty or expired.
-    def check_token
-      get_token if @token.nil? || (Time.now - @token_time) >= TOKEN_EXPIRATION
-    end
-
-    # Requests or renews API token.
-    def get_token
-      res = request.get do |req|
-        req.params['get_token'] = 'get_token'
-      end
-      raise RequestError, res.reason_phrase unless res.success?
-      raise APIError, res.body['error'] if res.body['error']
-      sleep 2
-
-      @token_time = Time.now
-      @token = res.body['token']
-    end
-
-    # Setups Faraday request.
-    def request
-      Faraday.new(url: API_ENDPOINT) do |faraday|
-        faraday.response :json
-        faraday.request  :url_encoded
-        faraday.adapter  Faraday.default_adapter
-      end
-    end
-  end
-end
+require 'rarbg/version'
+require 'rarbg/api'