qbittorrent 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a3812a79a260400595e389a56c86f356173b41384e3326f3ad7b0f72777b432
+  data.tar.gz: 2123789d9dee0e7e62a842422a5a2c293e403a8fc396493a8d472d99c07aa8c8
+SHA512:
+  metadata.gz: 7615e38c3df23ad84596b6536e5dd5c67a918839436b969e73b7c097dbb82416f43c0c152482412c78b059b66c27a5e1186507c1c91355871fd4e2fff633a717
+  data.tar.gz: 017f2ee40149c1e06fa388137a75cebc56bb1b1c113e1c0214d2d5efa7ff874c612222e8870d95a520ef7e830a38480f4fb7b3f550c680eb379432e6c6eb2c39

data/.github/workflows/gem.yml

@@ -0,0 +1,22 @@
+name: "Build gem to rubygems.org"
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: "git"
+        uses: actions/checkout@v2
+      - name: "publishing gem"
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          cd $GITHUB_WORKSPACE
+          gem build *.gemspec
+          gem push *.gem

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - qbittorrent.gemspec
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 50
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qbittorrent.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rubocop', '~> 1.16'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    qbittorrent (1.3)
+      http (~> 4.4.1)
+      logger (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.4)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    logger (1.4.3)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.16.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  qbittorrent!
+  rake (~> 12.0)
+  rubocop (~> 1.16)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Roy Zheng
+
+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,100 @@
+# QbittorrentClient
+
+A Qbittorrent Web API Client, only support [WebUI API (qBittorrent 4.1+)](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)>).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qbittorrent'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install qbittorrent
+
+# Usage
+
+```
+client = QBittorrent::Api.new("http://localhost:8080", "admin", "password")
+```
+
+## Authentication
+
+### **[Login](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)>)**
+
+```
+client.login
+```
+
+### **[Logout](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#logout>)**
+
+```
+client.logout
+```
+
+## Application
+
+### **[Get application version](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-version>)**
+
+```
+client.application_version
+```
+
+### **[Get API version](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-api-version>)**
+
+```
+client.api_version
+```
+
+### **[Get build info](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info>)**
+
+```
+client.build_info
+```
+
+### **[Get application preferences](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences>)**
+
+```
+client.preferences
+```
+
+### **[Set application preferences](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-application-preferences)**
+```
+client.set_preferences(options)
+```
+
+### **[Shutdown application](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#shutdown-application>)**
+
+```
+client.shutdown
+```
+
+### **[Get default save path](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-default-save-path>)**
+
+```
+client.default_save_path
+```
+
+### **[Get torrent list](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-list)**
+```
+client.get_torrents(options)
+```
+### **[Delete torrents](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents)**
+```
+client.delete_torrents(hashes, delete_files)
+```
+### **[Add new torrents](<https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-new-torrent>)**
+
+```
+client.add_torrents(urls_of_file_path, options)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'qbittorrent'
+
+# 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/lib/qbittorrent/api.rb

@@ -0,0 +1,26 @@
+require 'http'
+require 'logger'
+require 'qbittorrent/web_api/response'
+require 'qbittorrent/web_api/core'
+require 'qbittorrent/web_api/authorize'
+require 'qbittorrent/web_api/app'
+require 'qbittorrent/web_api/torrent'
+
+module QBittorrent
+  class Api
+    include QBittorrent::WebApi::Core
+    include QBittorrent::WebApi::Authroize
+    include QBittorrent::WebApi::App
+    include QBittorrent::WebApi::Torrent
+
+    attr_accessor :host, :username, :password, :cookies, :logger, :global_options
+
+    def initialize(host, username, password, logger = nil, **global_options)
+      @host = host.delete_suffix('/')
+      @username = username
+      @password = password
+      @logger = logger ? Logger.new(logger) : nil
+      @global_options = global_options
+    end
+  end
+end

data/lib/qbittorrent/version.rb

@@ -0,0 +1,3 @@
+module QBittorrent
+  VERSION = '1.3'.freeze
+end

data/lib/qbittorrent/web_api/app.rb

@@ -0,0 +1,47 @@
+module QBittorrent
+  module WebApi
+    module App
+      def application_version
+        send_request('/app/version') do |api_url|
+          api_client.get(api_url)
+        end
+      end
+
+      def api_version
+        send_request('/app/webapiVersion') do |api_url|
+          api_client.get(api_url)
+        end
+      end
+
+      def build_info
+        send_request('/app/buildInfo') do |api_url|
+          api_client.get(api_url)
+        end
+      end
+
+      def preferences
+        send_request('/app/preferences') do |api_url|
+          api_client.get(api_url)
+        end
+      end
+
+      def set_preferences(**options)
+        send_request('/app/setPreferences') do |api_url|
+          api_client.post(api_url, form: { json: options.to_json })
+        end
+      end
+
+      def default_save_path
+        send_request('/app/defaultSavePath') do |api_url|
+          api_client.get(api_url)
+        end
+      end
+
+      def shutdown
+        send_request('/app/shutdown') do |api_url|
+          api_client.post(api_url)
+        end
+      end
+    end
+  end
+end

data/lib/qbittorrent/web_api/authorize.rb

@@ -0,0 +1,21 @@
+module QBittorrent
+  module WebApi
+    module Authroize
+      def login
+        response = api_client.post("#{host}/api/v2/auth/login", form: {
+                                     username: username,
+                                     password: password
+                                   })
+        raise QBittorrent::Error.new('Authroize faild', response) unless response.headers['set-cookie']
+
+        @cookies = response.headers['set-cookie'].split(';')[0]
+      end
+
+      def logout
+        response = api_client.post("#{host}/api/v2/auth/logout")
+        @cookies = nil
+        response
+      end
+    end
+  end
+end

data/lib/qbittorrent/web_api/core.rb

@@ -0,0 +1,31 @@
+module QBittorrent
+  module WebApi
+    module Core
+      private
+
+      def api_client
+        headers = {
+          'Referer' => host
+        }
+        headers.merge!('Cookie' => cookies) if cookies
+        http = HTTP.headers(headers)
+        http = http.use(logging: { logger: logger }) if logger
+        http = http.timeout(global_options[:timeout]) if global_options[:timeout]
+        http
+      end
+
+      def send_request(api_path)
+        api_url = "#{host}/api/v2#{api_path}"
+        login unless cookies
+        response = yield(api_url)
+        raise QBittorrent::Error, "Response faild #{response.status.code}" unless response.status.success?
+
+        QBittorrent::WebApi::Response.new(true, response)
+      rescue QBittorrent::Error => e
+        QBittorrent::WebApi::Response.new(false, e.response, e.message)
+      rescue StandardError => e
+        QBittorrent::WebApi::Response.new(false, response, e.message)
+      end
+    end
+  end
+end

data/lib/qbittorrent/web_api/response.rb

@@ -0,0 +1,22 @@
+module QBittorrent
+  module WebApi
+    class Response
+      attr_accessor :is_success, :response, :message, :data
+
+      def initialize(is_success, response, message = nil)
+        @is_success = is_success
+        @response = response
+        @message = message
+        @data = begin
+          JSON.parse(response.to_s)
+        rescue StandardError => _e
+          response.to_s
+        end
+      end
+
+      def success?
+        is_success
+      end
+    end
+  end
+end

data/lib/qbittorrent/web_api/torrent.rb

@@ -0,0 +1,33 @@
+module QBittorrent
+  module WebApi
+    module Torrent
+      def get_torrents(**options)
+        send_request('/torrents/info') do |api_url|
+          api_client.get(api_url, params: options)
+        end
+      end
+
+      def add_torrents(url_or_file_path, **options)
+        send_request('/torrents/add') do |api_url|
+          url_or_file_path.gsub!(/^\s+|\s+$/, '')
+          if %r{^http://|https://|magnet://}i =~ url_or_file_path
+            options.merge!(urls: url_or_file_path)
+          else
+            options.merge!(torrents: HTTP::FormData::File.new(url_or_file_path))
+          end
+          api_client.post(api_url, form: options)
+        end
+      end
+
+      def delete_torrents(hashes, delete_files = false)
+        send_request("/torrents/delete") do |api_url|
+          api_client.post(api_url, form: {
+            hashes: hashes,
+            deleteFiles: delete_files
+          })
+        end
+      end
+    end
+  end
+end
+  

data/lib/qbittorrent.rb

@@ -0,0 +1,12 @@
+require 'qbittorrent/version'
+require 'qbittorrent/api'
+module QBittorrent
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      super(message)
+      @response = response
+    end
+  end
+end

data/qbittorrent.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/qbittorrent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qbittorrent'
+  spec.version       = QBittorrent::VERSION
+  spec.authors       = ['Roy Zheng']
+  spec.email         = ['github@roy.cc']
+
+  spec.summary       = 'QBittorrent WEB API Client.'
+  spec.description   = 'QBittorrent WEB API Client.only support qBittorrent v4.1+.'
+  spec.homepage      = 'https://github.com/royzheng/qbittorrent'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/royzheng/qbittorrent'
+  spec.metadata['changelog_uri'] = 'https://github.com/royzheng/qbittorrent'
+
+  # 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 { |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.add_dependency 'http', '~> 4.4.1'
+  spec.add_dependency 'logger', '~> 1.4'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: qbittorrent
+version: !ruby/object:Gem::Version
+  version: '1.3'
+platform: ruby
+authors:
+- Roy Zheng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: QBittorrent WEB API Client.only support qBittorrent v4.1+.
+email:
+- github@roy.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qbittorrent.rb
+- lib/qbittorrent/api.rb
+- lib/qbittorrent/version.rb
+- lib/qbittorrent/web_api/app.rb
+- lib/qbittorrent/web_api/authorize.rb
+- lib/qbittorrent/web_api/core.rb
+- lib/qbittorrent/web_api/response.rb
+- lib/qbittorrent/web_api/torrent.rb
+- qbittorrent.gemspec
+homepage: https://github.com/royzheng/qbittorrent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/royzheng/qbittorrent
+  source_code_uri: https://github.com/royzheng/qbittorrent
+  changelog_uri: https://github.com/royzheng/qbittorrent
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: QBittorrent WEB API Client.
+test_files: []