qbt_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02480b67133ef8c463c04c2b734414497e1f98a5
+  data.tar.gz: 9e6287af4b5e9ff231454974ff8ba017ec7d3ea7
+SHA512:
+  metadata.gz: 8c52453b44a058de5436aaff5da9fb1592ac2663e49752742751247086bd6b35e6c321d8fafed478c193255413a0b0a92c632b8197842b09c82b5a5fe1639d17
+  data.tar.gz: 64a53add284788198d77aec93a73c4039dc5152f3d616e9912e336fe62d4581147ea8b0b0d8c38d4fac25cf729afdaaafc4be1c9eb8e6d270658f060c71a6197

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qbt_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff McAffee
+
+MIT License
+
+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,78 @@
+# QbtClient
+
+A Ruby gem to access qBittorrent's [WebUI](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-Documentation)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qbt_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qbt_client
+
+## Usage
+
+Instantiate the client
+
+```ruby
+require 'qtb_client'
+
+ip   = 'http://127.0.0.1' # Protocol is required.
+port = 8083
+user = 'admin'
+pass = 'abc'
+
+client = QtbClient::WebUI.new(ip, port, user, pass)
+```
+
+Call methods on the client
+
+```ruby
+# Get list of torrents:
+torrents = client.torrent_list
+
+
+torrent_properties = {}
+
+# Using each torrent's hash, get the torrents properties:
+torrents.each do |t|
+  hash = t['hash']
+
+  torrent_properties[hash] = client.properties hash
+
+  # Get the torrent's trackers too
+  torrent_properties[hash]['trackers'] = client.trackers hash
+end
+```
+
+## Testing
+
+To run the tests, you'll need to have qBittorrent installed locally, WebUI
+turned on, and the credentials set to:
+
+- user: admin
+- pass: abc
+
+The tests assume that qBittorrent is running at 127.0.0.1, port 8083.
+
+From the root project dir, run:
+
+    $ rspec spec/
+
+## Contributing
+
+1. Fork it ( https://github.com/jmcaffee/qbt_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/qbt_client/version.rb

@@ -0,0 +1,3 @@
+module QbtClient
+  VERSION = "0.1.0"
+end