rarbg 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f275ed1e2baccaf9cfc2863790ad634f5dec9f7
-  data.tar.gz: 415204f9fae36b2429022dc2d5017f9ec68b6a79
+  metadata.gz: df7a25793709ac040727f5773f929996be08dd84
+  data.tar.gz: a769ebf5a4236dce346a9322585361626a3ae3b4
 SHA512:
-  metadata.gz: c51a5b95dc0404065851ac8106326badb4c907f3188b0b2af11cd6d59db016f53fec2939b1853a71ae1a9864c5c80a848699ca9384d8ac86c25f3ba2bfb35b69
-  data.tar.gz: 13361c8ee8b2fa1b60d6c3c1d735e8acdc20986cdbf76c6ead9eff390d37a7a8863dd146132b8e4f5c918fdd23e5ed942fcedb24e8dd19f4a815461cae602d0e
+  metadata.gz: '07729fdfb40503aa686ff406efcc2805db57f9b91a3265a24b0021c6a504196f3d5cbba231cd3425657dcb8acc7df7519dd74efb657e9961cde392a9f5d0a7ae'
+  data.tar.gz: 620904fedf16ebd5c33d0c05e81db1463f9d7355af7407acaab08b7b954e2a4ab5e057cae1f3da00889178e42598d97e34403f75f5634401f2cdccdfe4b696d7

data/lib/rarbg.rb

@@ -3,19 +3,27 @@ require 'faraday_middleware'
 require 'json'
 require 'time'
 
+# A ruby wrapper for RARBG torrentapi.
 module RARBG
-  VERSION = '0.1.3'.freeze
+  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,
@@ -24,35 +32,49 @@ module RARBG
       }.merge!(params)
     end
 
-    # list torrents
+    # Lists all torrents.
+    # Accepts query parameters from +params+.
+    # Returns an array of hashes.
     def list(params = {})
       call({ 'mode' => 'list' }, params)
     end
 
-    # search torrents
+    # 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
 
-    # search by imdb
+    # 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
 
-    # search by tvdb
+    # 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
 
-    # search by themoviedb
+    # 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
 
-    # perform API call
+    # Performs API call.
     def call(method_params, custom_params)
       raise ArgumentError, 'not an Hash' unless custom_params.is_a?(Hash)
       check_token
@@ -71,12 +93,12 @@ module RARBG
       res.body['torrent_results']
     end
 
-    # check if token is empty or expired
+    # Checks if +token+ is empty or expired.
     def check_token
       get_token if @token.nil? || (Time.now - @token_time) >= TOKEN_EXPIRATION
     end
 
-    # get api token
+    # Requests or renews API token.
     def get_token
       res = request.get do |req|
         req.params['get_token'] = 'get_token'
@@ -89,12 +111,12 @@ module RARBG
       @token = res.body['token']
     end
 
-    # setup faraday request
+    # Setups Faraday request.
     def request
       Faraday.new(url: API_ENDPOINT) do |faraday|
-        faraday.adapter  Faraday.default_adapter
-        faraday.request  :url_encoded
         faraday.response :json
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rarbg
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Tommaso Barbato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for RARBG torrentapi