newznab-api 0.1.0

data/lib/newznab/api/item.rb

@@ -0,0 +1,91 @@
+module Newznab
+  module Api
+    ##
+    # Class representing a single Newznab item
+    class Item
+
+      attr_reader :title, :guid, :link, :pub_date, :description, :metadata
+
+      ##
+      # @param args [Hash<String, Object>] Item hash from response
+      # @return [Newznab::Item]
+      # @since 0.1.0
+      def initialize(args)
+
+        @raw_resp = args
+        @metadata = {}
+
+        args.each_pair do |k, v|
+          case k
+            when 'title'
+              @title = v
+            when 'guid'
+              @guid = v
+            when 'link'
+              @link = v
+            when 'pubDate'
+              @pub_date = Date.parse(v)
+            when 'description'
+              @description = v
+            when 'enclosure'
+              @_attributes = v['@attributes']
+            when 'attr'
+              @metadata = _parse_attr(v)
+            else
+              # Do nothing
+          end
+        end
+      end
+
+      private
+
+      ##
+      # @param attrs [Array<Hash<Hash<String, String>>>] Newznab attr array response
+      # @return [Hash<String, Array<String>>]
+      # @since 0.1.0
+      def _parse_attr(attrs)
+
+        metadata = {}
+        attrs.each do |attr|
+          name = attr['@attributes']['name']
+          value = attr['@attributes']['value']
+
+          if metadata.has_key? name
+            metadata[name].push value
+          else
+            metadata[name] = [value]
+          end
+        end
+        new_meta = {}
+        metadata.each { |k, v| new_meta[k] = v.count.eql?(1) ? v.first : v }
+        new_meta
+      end
+
+      # @since 0.1.0
+      def method_missing(id, *args)
+        begin
+          if @_attributes.has_key? id.to_s
+            @_attributes[id.to_s]
+          elsif @metadata.has_key? id.to_s
+            @metadata[id.to_s]
+          else
+            super
+          end
+        end
+      end
+
+      # @since 0.1.0
+      def respond_to_missing?(id, *args)
+        begin
+          if @_attributes.has_key? id.to_s
+            true
+          elsif @metadata.has_key? id.to_s
+            true
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/newznab/api/list.rb

@@ -0,0 +1,139 @@
+require 'newznab/api'
+
+module Newznab
+  module Api
+    ##
+    # Enumerable list for multiple results
+    class List
+      include Enumerable
+
+      attr_reader :total_count
+      attr_reader :offset
+      attr_reader :limit
+      attr_reader :cvos
+
+      # @since 0.1.0
+      def initialize(resp, options)
+        update_ivals(resp)
+
+        if options.has_key? :limit
+          @limit = options[:limit]
+        end
+      end
+
+      # @since 0.1.0
+      def each
+        @cvos.each { |c| yield c }
+      end
+
+      # Returns the current page the object is on
+      # @return [Integer]
+      # @since 0.1.0
+      def page
+        (self.offset / self.limit) + 1
+      end
+
+      # Returns the total number of pages available
+      # @return [Integer] Total number of pages
+      # @since 0.1.0
+      def total_pages
+        (self.total_count / self.limit) + 1
+      end
+
+      # Returns if there are more pages to load
+      # @return [true, false]
+      # @since 0.1.0
+      def has_more?
+        self.total_pages > self.page ? true : false
+      end
+
+      protected
+
+      ##
+      # Updates array list to new values
+      # @param new_cvol [Hash] Response hash from {Newznab::Api}
+      # @since 0.1.0
+      def update_ivals(new_cvol)
+        @_attributes = new_cvol['@attributes']
+
+        if new_cvol.has_key?('channel') && new_cvol['channel'].has_key?('response')
+          @total_count = new_cvol['channel']['response']['@attributes']['total'].to_i
+          @offset = new_cvol['channel']['response']['@attributes']['offset'].to_i
+
+          @cvos = new_cvol['channel']['item']
+        end
+      end
+
+      # @since 0.1.0
+      def method_missing(id, *args)
+        begin
+          if @_attributes.has_key? id.to_s
+            @_attributes[id.to_s]
+          elsif @cvos.respond_to? id
+            @cvos.method(id).call(*args)
+          else
+            super
+          end
+        end
+      end
+
+      # @since 0.1.0
+      def respond_to_missing?(id, *args)
+        begin
+          if @_attributes.has_key? id.to_s
+            true
+          elsif @cvos.respond_to? id
+            true
+          else
+            super
+          end
+        end
+      end
+    end
+
+    ##
+    # Enumerable list for multiple {Newznab::Api::Item} results. Including pagination, and methods to navigate them
+    class SearchResults < List
+
+      attr_reader :raw_resp, :query, :function
+
+      # @param resp [Hash] Response hash from {Newznab::Api}
+      # @param function [Symbol] Function from {Newznab::Api::API_FUNCTIONS}
+      # @param query [Hash] Query parameters from search
+      # @since 0.1.0
+      def initialize(resp, function, query)
+        super(resp, query)
+
+        @function = function
+        @raw_resp = resp
+        @query = query
+
+        # Check for multiple/single results
+        if resp['channel']['item'].kind_of? Array
+          @cvos = resp['channel']['item'].collect { |o| Newznab::Api::Item.new(o) }
+        elsif resp['channel']['item'].kind_of? Hash
+          @cvos = [Newznab::Api::Item.new(resp['channel']['item'])]
+        end
+
+      end
+
+      # ##
+      # Moves search to the next offset results
+      # @since 0.1.0
+      def next_page!
+        return nil if (self.offset + self.total_pages) >= self.total_count
+        @query[:offset] = self.offset + self.limit
+        self.update_ivals(Newznab::Api.get(api_function: self.function, **self.query))
+      end
+
+      ##
+      # Moves search to the previous offset results
+      # @since 0.1.0
+      def prev_page!
+        return nil if @offset == 0
+        @query[:offset] = self.offset - self.limit
+        self.update_ivals(Newznab::Api.get(api_function: self.function, **self.query))
+      end
+    end
+  end
+end

data/lib/newznab/api/search.rb

@@ -0,0 +1,193 @@
+## Yard Doc generation stuff
+# @!macro [new] raise.FunctionNotSupportedError
+#   @raise [FunctionNotSupportedError] indicating the resource requested is not supported
+# @!macro [new] raise.NewznabAPIError
+#   @raise [NewznabAPIError] indicating the api request code received
+# @!macro [new] search.params
+#   @param query [String] Search input (URL/UTF-8 encoded). Case insensitive.
+#   @param group [Array] List of usenet groups to search delimited by ”,”
+#   @param limit [Integer] Upper limit for the number of items to be returned.
+#   @param cat [Array] List of categories to search delimited by ”,”
+#   @param attrs [Array] List of requested extended attributes delimeted by ”,”
+#   @param extended [true, false] List all extended attributes (attrs ignored)
+#   @param delete [true, false] Delete the item from a users cart on download.
+#   @param maxage [Integer] Only return results which were posted to usenet in the last x days.
+#   @param offset [Integer] The 0 based query offset defining which part of the response we want.
+
+module Newznab
+  module Api
+    ##
+    # Module to hold search specific functions
+    module Search
+
+      ##
+      # Perform a search with the provided optional params
+      # @macro search.params
+      # @return [Newznab::SearchResults]
+      # @since 0.1.0
+      # @macro raise.NewznabAPIError
+      def search(**params)
+        args = _parse_search_args(**params)
+        Newznab::Api::SearchResults.new(_make_request(:search, **args), :search, args)
+      end
+
+      ##
+      # Perform a tv-search with the provided optional params
+      # @param rid [Integer] TVRage id of the item being queried.
+      # @param season [String] Season string, e.g S13 or 13 for the item being queried.
+      # @param ep [String] Episode string, e.g E13 or 13 for the item being queried.
+      # @macro search.params
+      # @macro raise.NewznabAPIError
+      # @return [Newznab::SearchResults]
+      # @since 0.1.0
+      def tv_search(rid: nil, season: nil, ep: nil, **params)
+        args = _parse_search_args(**params)
+
+        unless rid.nil?
+          args[:rid] = rid.to_s.encode('utf-8')
+        end
+
+        unless season.nil?
+          args[:season] = season.to_s.encode('utf-8')
+        end
+
+        unless ep.nil?
+          args[:ep] = ep.to_s.encode('utf-8')
+        end
+
+        Newznab::Api::SearchResults.new(_make_request(:tvsearch, **args), :tvsearch, args)
+      end
+
+      ##
+      # Perform a movie-search with the provided optional params
+      # @param imdbid [String] IMDB id of the item being queried e.g. 0058935.
+      # @param genre [String] A genre string i.e. ‘Romance’ would match ‘(Comedy, Drama, Indie, Romance)’
+      # @macro search.params
+      # @macro raise.NewznabAPIError
+      # @return [Newznab::SearchResults]
+      # @since 0.1.0
+      def movie_search(imdbid: nil, genre: nil, **params)
+        args = _parse_search_args(**params)
+
+        unless imdbid.nil?
+          args[:imdbid] = imdbid.to_s.encode('utf-8')
+        end
+
+        unless genre.nil?
+          args[:genre] = genre.to_s.encode('utf-8')
+        end
+
+        Newznab::Api::SearchResults.new(_make_request(:movie, **args), :movie, args)
+      end
+
+      ##
+      # Perform a music-search with the provided optional params
+      # @param album [String]	Album title (URL/UTF-8 encoded). Case insensitive.
+      # @param artist [String] Artist name (URL/UTF-8 encoded). Case insensitive.
+      # @param label [String] Publisher/Label name (URL/UTF-8 encoded). Case insensitive.
+      # @param track [String] Track name (URL/UTF-8 encoded). Case insensitive.
+      # @param year [String] Four digit year of release.
+      # @param genre [String] A genre string i.e. ‘Romance’ would match ‘(Comedy, Drama, Indie, Romance)’
+      # @macro search.params
+      # @macro raise.NewznabAPIError
+      # @return [Newznab::SearchResults]
+      # @since 0.1.0
+      def music_search(album: nil, artist: nil, label: nil, track: nil, year: nil, genre: nil, **params)
+        args = _parse_search_args(**params)
+
+        unless album.nil?
+          args[:album] = album.to_s.encode('utf-8')
+        end
+
+        unless artist.nil?
+          args[:artist] = artist.to_s.encode('utf-8')
+        end
+
+        unless label.nil?
+          args[:label] = label.to_s.encode('utf-8')
+        end
+
+        unless track.nil?
+          args[:track] = track.to_s.encode('utf-8')
+        end
+
+        unless year.nil?
+          args[:year] = year.to_s.encode('utf-8')
+        end
+
+        unless genre.nil?
+          args[:genre] = genre.to_s.encode('utf-8')
+        end
+
+        Newznab::Api::SearchResults.new(_make_request(:music, **args), :music, args)
+      end
+
+      ##
+      # Perform a book-search with the provided optional params
+      # @param title [String]	Book title (URL/UTF-8 encoded). Case insensitive.
+      # @param author [String] Author name (URL/UTF-8 encoded). Case insensitive.
+      # @macro search.params
+      # @macro raise.NewznabAPIError
+      # @return [Newznab::SearchResults]
+      # @since 0.1.0
+      def book_search(title: nil, author: nil, **params)
+        args = _parse_search_args(**params)
+
+        unless title.nil?
+          args[:title] = title.to_s.encode('utf-8')
+        end
+
+        unless author.nil?
+          args[:author] = author.to_s.encode('utf-8')
+        end
+
+        Newznab::Api::SearchResults.new(_make_request(:book, **args), :book, args)
+      end
+
+
+      private
+
+      ##
+      # @macro search.params
+      # @return [Hash]
+      # @since 0.1.0
+      def _parse_search_args(query: nil, group: [], limit: nil, cat: [], attrs: [], extended: false, delete: false, maxage: nil, offset: nil)
+        params = {
+            extended: extended ? '1' : '0',
+            del: delete ? '1' : '0',
+        }
+
+        unless query.nil?
+          params[:q] = query.to_s.encode('utf-8')
+        end
+
+        unless maxage.nil?
+          params[:maxage] = maxage.to_i
+        end
+
+        unless offset.nil?
+          params[:offset] = offset.to_i
+        end
+
+        unless limit.nil?
+          params[:limit] = limit.to_i
+        end
+
+        unless group.empty?
+          params[:group] = group.collect { |o| o.to_s.encode('utf-8') }.join(',')
+        end
+
+        unless cat.empty?
+          params[:cat] = cat.collect { |o| o.to_s.encode('utf-8') }.join(',')
+        end
+
+        unless attrs.empty?
+          params[:group] = attrs.collect { |o| o.to_s.encode('utf-8') }.join(',')
+        end
+
+        params
+      end
+
+    end
+  end
+end

data/lib/newznab/api/version.rb

@@ -0,0 +1,6 @@
+module Newznab
+  module Api
+    # Newznab::Api gem version
+    VERSION = '0.1.0'
+  end
+end

data/newznab-api.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newznab/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'newznab-api'
+  spec.version       = Newznab::Api::VERSION
+  spec.authors       = ['Holden Omans']
+  spec.email         = ['holden.omans@gmail.com']
+
+  spec.summary       = %q{Api interface to Newznab servers.}
+  spec.description   = %q{Api interface to Newznab servers. Allows for searches and returning specific information on resources.}
+  spec.homepage      = 'https://github.com/kalinon/ruby-newznab-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.cert_chain  = ['certs/homans.pem']
+  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.9', '>= 5.9.1'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1', '>= 1.1.12'
+  spec.add_development_dependency 'rdoc', '~> 4.2', '>= 4.2.1'
+  spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.5'
+  spec.add_development_dependency 'dotenv-rails', '~> 2.2'
+  spec.add_development_dependency 'faker', '~> 1.7', '>= 1.7.3'
+  spec.add_development_dependency 'minitest-vcr', '~> 1.4'
+  spec.add_development_dependency 'nokogiri', '~> 1.7', '>= 1.7.1'
+
+  # Dependencies
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'mono_logger', '~> 1.1'
+end