transmission-rpc-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4917b1b8a5ad7da8273c58280fac4f25996e6334
+  data.tar.gz: fb8415abcd21be4158c10195b2d2a2fa0ae9dc6e
+SHA512:
+  metadata.gz: 65366f6cafbce62cd391596bcec5c5455adf8e2edb6730e92031b74e11f9c10c1984c8f258906d9c592b04433c0fde71d34e28615d56ae932cdfa43426dd5d89
+  data.tar.gz: 70fd3fcfe593fa9c9ae34b07fe3be75a292fd596f64f957dc036b1306fbc6b94b1cd4091242a9b53be6e0a0a4927f6abb8b9ee2b2236dd3b29ffca6340a0dade

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'faraday', '~> 0.9'
+
+group :development, :test do
+
+  gem 'rspec', '~> 3.2'
+  gem 'webmock', '~> 1.20'
+  gem 'rake', '~> 10.4'
+
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 0.9)
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  webmock (~> 1.20)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Max Hoffmann
+
+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 @@
+# Transmission RPC Ruby
+
+First primitive version.
+
+There is a couple of these RPC wrappers around already, but I am looking for a nice object oriented solution.
+
+Main aim for this project => Object Oriented solution for Transmission RPC connection.
+
+This Project follows the RPC spec for transmission under `https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt` and is planning on supporting release version >= 2.40 and RPC version >= 14
+
+## Examples (Currently working)
+
+To use the `Model` classes you need to set up some configs first
+
+    Transmission::Config.set host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
+
+Now all models will use the globally set configs
+
+### Finding a torrent
+
+    torrent = Transmission::Model::Torrent.find 1
+
+### Getting all torrents
+
+    torrents = Transmission::Model::Torrent.all
+
+### Adding a torrent
+
+    torrent = Transmission::Model::Torrent.add filename: 'http://example.com/some_torrent.torrent'
+    # or
+    torrent = Transmission::Model::Torrent.add filename: 'magnet_link'
+
+### Deleting a torrent
+
+    torrent = Transmission::Model::Torrent.find 1
+    # Deletes torrents
+    torrent.delete!
+    # Deletes torrent and local data
+    torrent.delete! true
+
+### Dealing with fields
+
+To limit the amount of fields sent around you can limit the information by passing an array of desired fields
+
+    torrent = Transmission::Model::Torrent.all fields: ['id']
+
+### Using different connectors
+
+If you are planning on using this lib to connect to multiple transmission daemon instances you can pass your own `Transmission::RPC` instance
+
+    connector = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
+    torrents = Transmission::Model::Torrent.all connector: connector
+
+### Find out Transmission & RPC version
+
+    connector = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
+    session = connector.session
+    session.rpc_version          #=> 14
+    session.version              #=> "2.52"
+
+## Examples (Currently NOT working but desired)
+
+### Torrent instance methods
+
+    torrent = Transmission::Model::Torrent.find 1
+    torrent.move_up
+    torrent.move_down
+    torrent.move_top
+    torrent.move_bottom
+    torrent.start
+    torrent.start_now
+    torrent.stop
+    torrent.verify
+    torrent.re_announce
+    torrent.finished?
+    torrent.to_json
+
+### This project is still WIP!!

data/Rakefile

@@ -0,0 +1,3 @@
+task :spec do
+  system 'rspec'
+end

data/lib/transmission.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'transmission', 'rpc')
+require File.join(File.dirname(__FILE__), 'transmission', 'model')
+require File.join(File.dirname(__FILE__), 'transmission', 'config')
+require File.join(File.dirname(__FILE__), 'transmission', 'arguments')
+
+module Transmission
+  VERSION = '0.1.0'
+end

data/lib/transmission/arguments.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'arguments', 'torrent_add')
+require File.join(File.dirname(__FILE__), 'arguments', 'torrent_get')
+require File.join(File.dirname(__FILE__), 'arguments', 'torrent_set')
+require File.join(File.dirname(__FILE__), 'arguments', 'session_get')
+require File.join(File.dirname(__FILE__), 'arguments', 'session_set')
+require File.join(File.dirname(__FILE__), 'arguments', 'session_stats')
+
+module Transmission
+  class Arguments
+    class InvalidArgument < StandardError; end
+
+    attr_accessor :arguments
+
+    def initialize(arguments = nil)
+      @arguments = arguments.inject([]) do |attributes, attribute|
+        raise Transmission::Arguments::InvalidArgument unless self.class::ATTRIBUTES.include? attribute
+        attributes << attribute
+      end if arguments
+      @arguments = self.class::ATTRIBUTES if arguments.nil?
+    end
+
+    def to_arguments
+      @arguments
+    end
+
+  end
+end

data/lib/transmission/arguments/session_get.rb

@@ -0,0 +1,63 @@
+module Transmission
+  class Arguments
+    class SessionGet < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'alt-speed-down',
+          'alt-speed-enabled',
+          'alt-speed-time-begin',
+          'alt-speed-time-enabled',
+          'alt-speed-time-end',
+          'alt-speed-time-day',
+          'alt-speed-up',
+          'blocklist-url',
+          'blocklist-update',
+          'blocklist-enabled',
+          'blocklist-size',
+          'cache-size-mb',
+          'config-dir',
+          'download-dir',
+          'download-queue-size',
+          'download-queue-enabled',
+          'dht-enabled',
+          'encryption',
+          'required',
+          'preferred',
+          'tolerated',
+          'idle-seeding-limit',
+          'idle-seeding-limit-enabled',
+          'incomplete-dir',
+          'incomplete-dir-enabled',
+          'lpd-enabled',
+          'peer-limit-global',
+          'peer-limit-per-torrent',
+          'pex-enabled',
+          'peer-port',
+          'peer-port-random-on-start',
+          'port-forwarding-enabled',
+          'queue-stalled-enabled',
+          'queue-stalled-minutes',
+          'rename-partial-files',
+          'rpc-version',
+          'rpc-version-minimum',
+          'script-torrent-done-filename',
+          'script-torrent-done-enabled',
+          'done',
+          'seedRatioLimit',
+          'seedRatioLimited',
+          'seed-queue-size',
+          'seed-queue-enabled',
+          'speed-limit-down',
+          'speed-limit-down-enabled',
+          'speed-limit-up',
+          'speed-limit-up-enabled',
+          'start-added-torrents',
+          'trash-original-torrent-files',
+          'units',
+          'utp-enabled',
+          'version'
+      ]
+
+    end
+  end
+end

data/lib/transmission/arguments/session_set.rb

@@ -0,0 +1,58 @@
+module Transmission
+  class Arguments
+    class SessionSet < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'alt-speed-down',
+          'alt-speed-enabled',
+          'alt-speed-time-begin',
+          'alt-speed-time-enabled',
+          'alt-speed-time-end',
+          'alt-speed-time-day',
+          'alt-speed-up',
+          'blocklist-url',
+          'blocklist-update',
+          'blocklist-enabled',
+          'cache-size-mb',
+          'download-dir',
+          'download-queue-size',
+          'download-queue-enabled',
+          'dht-enabled',
+          'encryption',
+          'required',
+          'preferred',
+          'tolerated',
+          'idle-seeding-limit',
+          'idle-seeding-limit-enabled',
+          'incomplete-dir',
+          'incomplete-dir-enabled',
+          'lpd-enabled',
+          'peer-limit-global',
+          'peer-limit-per-torrent',
+          'pex-enabled',
+          'peer-port',
+          'peer-port-random-on-start',
+          'port-forwarding-enabled',
+          'queue-stalled-enabled',
+          'queue-stalled-minutes',
+          'rename-partial-files',
+          'script-torrent-done-filename',
+          'script-torrent-done-enabled',
+          'done',
+          'seedRatioLimit',
+          'seedRatioLimited',
+          'seed-queue-size',
+          'seed-queue-enabled',
+          'speed-limit-down',
+          'speed-limit-down-enabled',
+          'speed-limit-up',
+          'speed-limit-up-enabled',
+          'start-added-torrents',
+          'trash-original-torrent-files',
+          'units',
+          'utp-enabled'
+      ]
+
+    end
+  end
+end

data/lib/transmission/arguments/session_stats.rb

@@ -0,0 +1,17 @@
+module Transmission
+  class Arguments
+    class SessionStats < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'activeTorrentCount',
+          'downloadSpeed',
+          'pausedTorrentCount',
+          'torrentCount',
+          'uploadSpeed',
+          'cumulative-stats',
+          'current-stats'
+      ]
+
+    end
+  end
+end

data/lib/transmission/arguments/torrent_add.rb

@@ -0,0 +1,22 @@
+module Transmission
+  class Arguments
+    class TorrentAdd < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'cookies',
+          'download-dir',
+          'filename',
+          'metainfo',
+          'paused',
+          'peer-limit',
+          'bandwidthPriority',
+          'files-wanted',
+          'files-unwanted',
+          'priority-high',
+          'priority-low',
+          'priority-normal'
+      ]
+
+    end
+  end
+end

data/lib/transmission/arguments/torrent_get.rb

@@ -0,0 +1,78 @@
+module Transmission
+  class Arguments
+    class TorrentGet < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'id',
+          'activityDate',
+          'addedDate',
+          'bandwidthPriority',
+          'comment',
+          'corruptEver',
+          'creator',
+          'dateCreated',
+          'desiredAvailable',
+          'doneDate',
+          'downloadDir',
+          'downloadedEver',
+          'downloadLimit',
+          'downloadLimited',
+          'error',
+          'errorString',
+          'eta',
+          'etaIdle',
+          'files',
+          'fileStats',
+          'hashString',
+          'haveUnchecked',
+          'haveValid',
+          'honorsSessionLimits',
+          'isFinished',
+          'isPrivate',
+          'isStalled',
+          'leftUntilDone',
+          'magnetLink',
+          'manualAnnounceTime',
+          'maxConnectedPeers',
+          'metadataPercentComplete',
+          'name',
+          'peer-limit',
+          'peers',
+          'peersConnected',
+          'peersFrom',
+          'peersGettingFromUs',
+          'peersSendingToUs',
+          'percentDone',
+          'pieces',
+          'pieceCount',
+          'pieceSize',
+          'priorities',
+          'queuePosition',
+          'rateDownload',
+          'rateUpload',
+          'recheckProgress',
+          'secondsDownloading',
+          'secondsSeeding',
+          'seedIdleLimit',
+          'seedIdleMode',
+          'seedRatioLimit',
+          'seedRatioMode',
+          'sizeWhenDone',
+          'startDate',
+          'status',
+          'trackers',
+          'trackerStats',
+          'totalSize',
+          'torrentFile',
+          'uploadedEver',
+          'uploadLimit',
+          'uploadLimited',
+          'uploadRatio',
+          'wanted',
+          'webseeds',
+          'webseedsSendingToUs'
+      ]
+
+    end
+  end
+end