jackettrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dd371bf99d8af164a340e434ee9a91a45e629fccc76d754b6932be2ffa14fd3
+  data.tar.gz: 24cb7f2397ef1294b63f2bfcc134182c9d2ba4fb702af2818d0c857d02edb46f
+SHA512:
+  metadata.gz: baeee6690dcfa15a8a2c29814e5a72abd4975eae2491954d4970df9c839d9000fc9ed9163634ae3ec3d04d52a66ce299aa2ec613dac29bb9502cc1ef46cfe01a
+  data.tar.gz: 1dcd804c7f99a5ad54e14d54b9731ac3cab3f8424f649c4b8fb8b6fbd6633fab73f2d5617578b5ae7bfe17ba34435e0131ac009f2190591aa0ba96b1323e45bc

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Security/Open:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jackettrb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    jackettrb (0.1.0)
+      rss (~> 0.2.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rss (0.2.9)
+      rexml
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  jackettrb!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Josh Burns
+
+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,44 @@
+# Jackettrb
+
+Lightweight interaction layer for Jackett API servers.
+
+## Installation
+
+Add this line to your `Gemfile`.
+``` ruby
+gem "jackettrb"
+```
+
+Or install it manually via the `gem` cli.
+
+``` ruby
+$ gem install jackettrb
+```
+
+
+## Usage
+
+First you need to make an instance of `Jackettrb::Request`, the constructor will take
+2 to 3 arguments. The URL to your Target Jackett instance, The API key, and you can optionally
+pass in `true` as the third argument to turn on _strict RSS parsing_ this will generate more errors
+and is off by default as a result.
+
+``` ruby
+require 'jackettrb'
+
+req = Jackettrb::Request.new("https://127.0.0.1:9117", "MyApiKey123123")
+
+```
+
+From here we can ask Jackett to query the indexers for a given search term like so
+
+``` ruby
+req.query("Spiderman")
+```
+
+You can also get a feed of all results with the aptly named `firehose`.
+
+``` ruby
+req.firehose
+```
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jackettrb"
+
+# 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/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

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/jackettrb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/jackettrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jackettrb"
+  spec.version = Jackettrb::VERSION
+  spec.authors = ["Josh Burns"]
+  spec.email = ["joshyburnss@gmail.com"]
+
+  spec.summary = "Ruby library to provide an interface to Jackett API servers"
+  spec.description = "Ruby library to provide an interface to Jackett API servers"
+  spec.homepage = "https://github.com/joshburnsxyz/jackettrb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rss", "~> 0.2.9"
+end

data/lib/jackettrb/request.rb

@@ -0,0 +1,41 @@
+require "net/http"
+require "open-uri"
+require "rss"
+
+module Jackettrb
+  class Request
+    attr_accessor :strict, :host, :key
+
+    # rubocop:disable Style/OptionalBooleanParameter
+    def initialize(host, key, strict = false)
+      @key = key
+      @host = host
+      @strict = strict
+    end
+    # rubocop:enable Style/OptionalBooleanParameter
+
+    def firehose
+      url = parse_url(@host, nil)
+      parse_rss(url, @strict)
+    end
+
+    def query(q)
+      url = parse_url(@host, "&q=#{q}")
+      parse_rss(url, @strict)
+    end
+
+    private
+
+    def parse_url(host, params)
+      URI.parse("#{host}/api/v2.0/indexers/all/results/torznab/api?apikey=#{@key}#{params}")
+    end
+
+    def parse_rss(url, strict)
+      feed = nil
+      URI.open(url) do |rss|
+        feed = RSS::Parser.parse(rss, strict)
+      end
+      feed
+    end
+  end
+end

data/lib/jackettrb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Jackettrb
+  VERSION = "0.1.0"
+end

data/lib/jackettrb.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "jackettrb/version"
+require_relative "jackettrb/request"
+
+module Jackettrb
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: jackettrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Burns
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+description: Ruby library to provide an interface to Jackett API servers
+email:
+- joshyburnss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- jackettrb.gemspec
+- lib/jackettrb.rb
+- lib/jackettrb/request.rb
+- lib/jackettrb/version.rb
+homepage: https://github.com/joshburnsxyz/jackettrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joshburnsxyz/jackettrb
+  source_code_uri: https://github.com/joshburnsxyz/jackettrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Ruby library to provide an interface to Jackett API servers
+test_files: []