newznab-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 604369344c3d1cda367e67905cadc85a82068c10
+  data.tar.gz: 35ee7aea3ce8261d4c42b59ffe001166e4acc719
+SHA512:
+  metadata.gz: c01556b2eb6f41e1e6cdaccf8e76731d536832b0357322dfbc2220e14a52bd8cdcd944bbd8902bbc8043706083f4023cba4907a75de8440eeac4ad1d161bd56e
+  data.tar.gz: 4dd02ab5407e28bf36a8325d019d650442c4df70dbe59be868e2ac4bdf800cef2dd552beed219bb7df616dedd2a395f6a02310e83a5602938acc63dfc944c416

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+������0)�KN6X\�_� �Ԓ_I0yΑv�?��c�^HRV��{�j�]�Ү>#o�u9�z?�I�Ņ/
+X�@`�3�^�D@���җ-�������(<�MV&��4m��ۻ>�-�҉��Ў�3�M
+NgAQ*:u��L���
��o�cB\ߋ�C�P���1�X�r$�

data/.env.example

@@ -0,0 +1,9 @@
+# Add account credentials and API keys here.
+# This file should be listed in .gitignore to keep your settings secret!
+# Each entry sets a local environment variable.
+# For example, setting:
+# GMAIL_USERNAME=Your_Gmail_Username
+# makes 'Your_Gmail_Username' available as ENV["GMAIL_USERNAME"]
+
+NEWZNAB_URI=Your_Newznab_URI
+NEWZNAB_API_KEY=Your_Newznab_API_Key

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.env

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

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,
+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 holden.omans@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newznab-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Holden Omans
+
+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,61 @@
+# Newznab::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/newznab/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newznab-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newznab-api
+
+Then set a environmental variables named `NEWZNAB_API_KEY` and `NEWZNAB_URI` to auto connect **(optional)**
+
+    $ export NEWZNAB_URI=https://api.newznab.com
+    $ export NEWZNAB_API_KEY=7e8896464895c1cde33759b8307f5cf8
+
+
+## Usage
+
+If you did not set the env variables `NEWZNAB_API_KEY` or `NEWZNAB_URI` then you need to set the class `api_key` and `uri` before using. If you did set the env variable you do not need to set this.
+
+```ruby
+Newznab::Api.new(uri: 'https://api.newznab.com', key: '7e8896464895c1cde33759b8307f5cf8')
+```
+
+
+Perform a search:
+
+```ruby
+resp = newznab.search(query: 'This Old House', limit: 50)
+```
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kalinon/newznab-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+require 'dotenv/load'
+
+# Test tasks
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb'] # optional
+  t.options = %w{--private} # optional
+  t.stats_options = ['--list-undoc'] # optional
+end
+
+# Default task
+task :default => :test
+
+Rake::Task['build'].enhance do
+  require 'digest/sha2'
+  built_gem_path = 'pkg/newznab-api-'+Newznab::Api::VERSION+'.gem'
+  checksum = Digest::SHA256.new.hexdigest(File.read(built_gem_path))
+  checksum_path = 'checksum/newznab-api-'+Newznab::Api::VERSION+'.gem.sha256'
+  File.open(checksum_path, 'w') { |f| f.write(checksum) }
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'newznab/api'
+
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'newznab/api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/certs/homans.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAxob2xk
+ZW4ub21hbnMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+A2NvbTAeFw0xNzA0MDkyMTAwMTJaFw0xODA0MDkyMTAwMTJaMEMxFTATBgNVBAMM
+DGhvbGRlbi5vbWFuczEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyNPYv6sC
+h/gLJ4XG0QdPJUEtvg8AwPLHz/BHLHKJPvq6Nyh2UDiWy+ZyP+uioBAxieHrMA4m
+2v60BLIYWQyl2jPK2Rc2kchrciskFNy7wQMvi59a6+FFBMwdrl55stgJQOGorKSA
+B/w/WYOnTWLzA6NuoRoA0JU1mWzKPCYn8HZLX88y5LzKZ6011K2zeh19MJDngaGU
+EjOavcgNsNVGdlTToyz4P0v8kyXbRdKsBM4On7bN59ujHSOVdUr//Ze1IJj3dtew
+bcefgVhmX+TtxjtKo1+V5Nt1YzQ3omiEbVt6I8yIuY87CDk8KJiXjzCR1iiNu8YF
+zBm0vYm6tuRCKQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+HQ4EFgQUKuIxpvKKtDKrTwoV2OTimRBnu1YwIQYDVR0RBBowGIEWaG9sZGVuLm9t
+YW5zQGdtYWlsLmNvbTAhBgNVHRIEGjAYgRZob2xkZW4ub21hbnNAZ21haWwuY29t
+MA0GCSqGSIb3DQEBBQUAA4IBAQADMSGgLnyWg3FkyFsf0p5Y/yeN3giPIMjc4pK8
+im1nsfZRotJvkWgobP17tkSK4YPYSlIqf9O5hCZlHHG8aGfy+L4ax9w23QOa9oJm
+90OnzyR7G7CCXBOhjYXX5YsQbxBSbNwQQxLjjuOXe1HvgAKNCwMEI2Gj+5ByMMn3
+uq/WPwQKccVm0Ado75I+1IiIpdJjWfOMt5KBxS/JCpE8hRxc3viXdTvN3vSUZ7q7
+yFGnn1/BkVPEZOvDj9bIANBVtWP0hebPDM/v7B7Lz+SSfqSaWGAwi+XoDe2kN0Ii
+LHXORkT9cmA6WykguTkGcDw9YiV/I7VMHzYyurD2x+nOXmla
+-----END CERTIFICATE-----

data/lib/newznab/api.rb

@@ -0,0 +1,311 @@
+require 'newznab/api/version'
+require 'newznab/api/list'
+require 'newznab/api/item'
+require 'newznab/api/search'
+require 'rest-client'
+require 'cgi'
+require 'json'
+require 'mono_logger'
+require 'open-uri'
+require 'nokogiri'
+
+## Yard Doc generation stuff
+# @!macro [new] raise.FunctionNotSupportedError
+#   @raise [FunctionNotSupportedError] indicating the resource requested is not supported
+# @!macro [new] raise.FunctionDisabledError
+#   @raise [FunctionDisabledError] indicating the server api function is disabled
+# @!macro [new] raise.NewznabAPIError
+#   @raise [NewznabAPIError] indicating the api request code received
+
+##
+# Base Newznab module
+module Newznab
+
+  ##
+  # Class to interact and query the Newznab API
+  module Api
+
+    # Response format from Newznab api
+    # @since 0.1.0
+    API_FORMAT = 'json'
+
+    # Supported Newznab api functions
+    # @since 0.1.0
+    API_FUNCTIONS = [:caps, :search, :tvsearch, :movie, :music, :book, :details, :getnfo]
+
+
+    ##
+    # Raised when a Newznab API error is encountered
+    #
+    # @since 0.1.0
+    class NewznabAPIError < ScriptError
+    end
+
+    ##
+    # Raised when a function is not implemented on the current API
+    #
+    # Must be included in {Newznab::Api::API_FUNCTIONS}
+    #
+    # @since 0.1.0
+    class FunctionNotSupportedError < NewznabAPIError
+    end
+
+    ##
+    # Raised when a Newznab API function is disabled
+    #
+    # @since 0.1.0
+    class FunctionDisabledError < FunctionNotSupportedError
+    end
+
+    class << self
+      include Newznab::Api::Search
+
+      attr_accessor :api_uri, :api_key, :api_timeout, :api_rate_limit, :logger
+
+      ##
+      # @example
+      #   Newznab::Api.new(uri: 'https://api.newznab.com', key: '7e8896464895c1cde33759b8307f5cf8')
+      # @return [Newznab::API]
+      # @param uri [String] Newznab API Uri
+      # @param key [String] Newznab API Key
+      # @since 0.1.0
+      def new(uri: nil, key: nil)
+
+        @api_rate_limit = 0
+
+        @logger = MonoLogger.new(STDOUT)
+        @logger.level = MonoLogger::WARN
+
+        # Newznab API Key. Set to the environmental variable NEWZNAB_API_KEY by default if present
+        @api_key = ENV['NEWZNAB_API_KEY'] || nil
+        # Newznab API Uri. Set to the environmental variable NEWZNAB_URI by default if present
+        @api_uri = ENV['NEWZNAB_URI'] || nil
+        # Api response timeout in seconds
+        @api_timeout = 10
+
+
+        # Set passed uri
+        unless uri.nil?
+          @api_uri=uri
+        end
+
+        # Set passed key
+        unless key.nil?
+          @api_key=key
+        end
+
+        self
+      end
+
+      ##
+      # Return the server's supported features and the protocol version and other metadata
+      # Will perform a request to server if not set
+      # @return [Hash]
+      # @since 0.1.0
+      # @macro raise.NewznabAPIError
+      def caps
+        @caps ||= _make_request(:caps)
+      end
+
+      ##
+      # @param api_function [Symbol] Newznab function
+      # @param params [Hash] The named key value pairs of query parameters
+      # @macro raise.NewznabAPIError
+      # @macro raise.FunctionNotSupportedError
+      # @since 0.1.0
+      def get(api_function:, **params)
+        _make_request(api_function, **params)
+      end
+
+      ##
+      # Get item based on guid
+      # @param guid [String] The GUID of the item being queried.
+      # @since 0.1.0
+      def get_details(guid)
+        resp = _make_request(:details, id: guid)
+        if resp['channel']['item']
+          Newznab::Api::Item.new(resp['channel']['item'])
+        else
+          nil
+        end
+      end
+
+      ##
+      # Get item's NFO based on guid
+      # @param guid [String] The GUID of the item being queried.
+      # @since 0.1.0
+      def get_nfo(guid)
+        resp = _make_request(:getnfo, id: guid)
+        if resp['channel']['item']['description']
+          resp['channel']['item']['description']
+        else
+          nil
+        end
+      end
+
+      private
+
+      ##
+      # Will attempt to parse the {api_uri} and append '/api' to the end if needed
+      # @return [String]
+      # @since 0.1.0
+      def _build_base_url
+        if self.api_uri.to_s.match(/\/api$/)
+          self.api_uri
+        else
+          self.api_uri + '/api'
+        end
+      end
+
+      ##
+      # Executes api request based on provided +function+ and +params+
+      #
+      # @example Return 5 results from the +:characters+ resource
+      #   _make_request(:search, limit: 5)
+      #
+      # @param function [Symbol] Newznab function
+      # @param params [Hash] The named key value pairs of query parameters
+      # @return [Hash]
+      # @since 0.1.0
+      # @macro raise.NewznabAPIError
+      # @macro raise.FunctionNotSupportedError
+      def _make_request(function, **params)
+
+        unless API_FUNCTIONS.include?(function)
+          logger.error("Function #{function.to_s} not supported")
+          raise FunctionNotSupportedError, "Function #{function.to_s} not supported"
+        end
+
+        _make_url_request(_build_base_url, function, params)
+      end
+
+      ##
+      # Executes api request based on provided +resource+ and +params+
+      #
+      # @example Make a simple request with +limit: 1+
+      #   _make_url_request('http://newznabserver.com/api', t: :caps)
+      #
+      # @param url [String] Request url
+      # @param function [Symbol] Newznab function
+      # @param params [Hash] optional request parameters
+      # @return [Hash]
+      # @since 0.1.0
+      # @macro raise.NewznabAPIError
+      def _make_url_request(url, function, **params)
+
+        # If we have a rate_limit set, wait that long before sending a request
+        if api_rate_limit > 0
+          sleep api_rate_limit
+        end
+
+        # Default options hash
+        options = {
+            accept: :json,
+            content_type: :json,
+            params: {
+                apikey: self.api_key,
+                o: Newznab::Api::API_FORMAT,
+                t: function.to_s,
+            }
+        }
+
+        options[:params].merge! params
+
+        begin
+          logger.debug("Request URL: #{url}")
+          logger.debug("Request headers: #{options.to_json}")
+
+          # Perform request
+          request = RestClient::Request.execute(
+              method: :get,
+              url: url,
+              timeout: self.api_timeout,
+              headers: options,
+          )
+
+        rescue RestClient::NotFound, RestClient::Exceptions::ReadTimeout => e
+          logger.error(e.message)
+          raise NewznabAPIError, e.message
+        end
+
+        case request.code
+          when 200
+            if request.headers[:content_type].eql? 'text/xml'
+              doc = Nokogiri.XML(request.body, nil)
+              if doc.xpath('//error')
+                code = doc.xpath('//error')[0]['code']
+                msg = doc.xpath('//error')[0]['description']
+                _newznab_error(code: code, msg: msg)
+              else
+                logger.error('XML responses are not supported')
+                raise NewznabAPIError, 'XML responses are not supported'
+              end
+            elsif request.headers[:content_type].eql? 'application/json'
+              req = JSON.parse(request.body)
+              if req
+                req
+              else
+                logger.error(req['error'])
+                raise NewznabAPIError, req['error']
+              end
+            end
+
+          else
+            logger.error('Recived a '+request.code+' http response')
+            raise NewznabAPIError, 'Recived a '+request.code+' http response'
+        end
+      end
+
+      ##
+      # @param code [Integer] Error code from the Newznab server
+      # @param msg [String] Error message from the Newznab server
+      # @macro raise.NewznabAPIError
+      # @macro raise.FunctionNotSupportedError
+      # @since 0.1.0
+      def _newznab_error(code:, msg: nil)
+        if msg.nil?
+          msg = case code.to_i
+                  when 100
+                    'Incorrect user credentials'
+                  when 101
+                    'Account suspended'
+                  when 102
+                    'Insufficient privileges/not authorized'
+                  when 103
+                    'Registration denied'
+                  when 104
+                    'Registrations are closed'
+                  when 105
+                    'Invalid registration (Email Address Taken)'
+                  when 106
+                    'Invalid registration (Email Address Bad Format)'
+                  when 107
+                    'Registration Failed (Data error)'
+                  when 200
+                    'Missing parameter'
+                  when 201
+                    'Incorrect parameter'
+                  when 202
+                    'No such function. (Function not defined in this specification).'
+                  when 203
+                    'Function not available. (Optional function is not implemented).'
+                  when 300
+                    'No such item.'
+                  when 300
+                    'Item already exists.'
+                  when 900
+                    'Unknown error'
+                  when 910
+                    'API Disabled'
+                end
+        end
+        logger.error("NewznabAPIError - Code: #{code} Message: #{msg}")
+        if msg.eql? 'API Disabled'
+          raise FunctionDisabledError, "Code: #{code} Message: #{msg}"
+        else
+          raise NewznabAPIError, "Code: #{code} Message: #{msg}"
+        end
+      end
+    end
+  end
+end