transmission-rpc-ruby-ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66baaca80a270473f4376d93b17afe57752e4141
+  data.tar.gz: 44d49c586066b362dfd039c4172786f21741877b
+SHA512:
+  metadata.gz: 0bc47e4df2187ef7fc082b3339559792a86f123812a406d091ae1b79ce813e143440a5f2628ea4000fa906a70c22723533340af2cc2f2dd3a7617d090aac682e
+  data.tar.gz: c2b07193fd83431021f1990887549d620532f5de469042198924f6ae5e07502d6fbb5cb22524304847e95838b14f08865604e4948278af8ff9514c0663430173

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 (2016-12-28)
+
+- Initial fork and basic additions.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'faraday', '~> 0.10'
+
+group :development, :test do
+  gem 'rspec', '~> 3.5'
+  gem 'webmock', '~> 2.3'
+  gem 'rake', '~> 12.0'
+  gem 'coveralls', '~> 0.8', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    coveralls (0.8.17)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.10.0)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.2)
+    json (2.0.2)
+    multipart-post (2.0.0)
+    public_suffix (2.0.4)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.13.0)
+    webmock (2.3.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.8)
+  faraday (~> 0.10)
+  rake (~> 12.0)
+  rspec (~> 3.5)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Tommaso Barbato
+
+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,173 @@
+# Transmission RPC Ruby Extended
+
+[![Build Status](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext) [![Code Climate](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext/badges/gpa.svg)](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext) [![Coverage Status](https://coveralls.io/repos/github/epistrephein/transmission-rpc-ruby-ext/badge.svg?branch=master)](https://coveralls.io/github/epistrephein/transmission-rpc-ruby-ext?branch=master) [![Dependency Status](https://gemnasium.com/badges/github.com/epistrephein/transmission-rpc-ruby-ext.svg)](https://gemnasium.com/github.com/epistrephein/transmission-rpc-ruby-ext) [![Inline docs](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext)
+
+This is a fork of [transmission-rails/transmission-rpc-ruby](https://github.com/transmission-rails/transmission-rpc-ruby) with some shortcut methods added and revised codebase.
+
+## Installation
+
+```
+gem install transmission-rpc-ruby-ext
+```
+
+Then require it
+
+```ruby
+require 'transmission'
+```
+
+## Additions
+
+Get an array of all torrents
+
+```ruby
+Transmission.all
+```
+
+All finished torrents
+
+```ruby
+Transmission.finished
+```
+
+All completed or incomplete torrents
+
+```ruby
+Transmission.completed
+Transmission.incomplete
+```
+
+All torrents based on status
+
+```ruby
+Transmission.paused         # status 0
+Transmission.queued         # status 3
+Transmission.downloading    # status 4    
+Transmission.seeding        # status 6
+```
+
+All torrents with error
+
+```ruby
+Transmission.error
+```
+
+All hashes of all torrents
+
+```ruby
+Transmission.hashes
+```
+
+Find torrents by name, hash, id or tracker
+
+```ruby
+Transmission.find_by_name('Ubuntu')
+Transmission.find_by_hash('fe086f9b15e4956a671ab9b9c5da526e3d3b270c')
+Transmission.find_by_id(5)
+Transmission.find_by_tracker('open.demonii.com')
+```
+
+### Single torrent methods
+
+```ruby
+t = Transmission.all.first
+```
+
+Basic attributes
+
+```ruby
+t.name
+# => "ubuntu-16.04-desktop-amd64.iso"
+t.path
+# => "/Users/epistrephein/Downloads/ubuntu-16.04-desktop-amd64.iso"
+t.id
+# => 13
+t.hash
+# => "4344503b7e797ebf31582327a5baae35b11bda01"
+```
+
+Status
+
+```ruby
+t.paused?
+# => false
+t.queued?
+# => false
+t.downloading?
+# => true
+t.seeding?
+# => false
+t.finished?
+# => false
+t.completed?
+# => false
+t.incomplete?
+# => false
+t.error?
+# => false
+```
+
+Size
+
+```ruby
+t.length
+# => 1485881344
+t.valid
+# => 18232
+t.percent_downloaded
+# => 1.2
+t.percent_uploaded
+# => 0.1
+t.percent_ratio
+# => 0.1
+t.ratio
+# => -1.0
+```
+
+Speed
+
+```ruby
+t.speed_download
+# => 12
+t.speed_upload
+# => 9
+```
+
+Ratio & ETA
+
+```ruby
+t.ratio
+# => -1.0
+t.eta
+```
+
+Files and folders
+
+```ruby
+t.file?
+t.folder?
+t.files
+t.content
+t.biggest
+t.smallest
+```
+
+Magnet link
+
+```ruby
+t.magnet
+```
+
+Trackers
+
+```ruby
+t.trackers
+```
+
+Actions
+
+```ruby
+t.reload!
+t.remove!
+t.remove_data!
+```

data/Rakefile

@@ -0,0 +1,5 @@
+task default: [:spec]
+
+task :spec do
+  system 'rspec'
+end

data/lib/transmission.rb

@@ -0,0 +1,11 @@
+require_relative 'transmission/rpc'
+require_relative 'transmission/model'
+require_relative 'transmission/config'
+require_relative 'transmission/fields'
+require_relative 'transmission/arguments'
+require_relative 'transmission/utils'
+require_relative 'transmission/extensions'
+
+module Transmission
+  VERSION = '0.1.0'.freeze
+end

data/lib/transmission/arguments.rb

@@ -0,0 +1,50 @@
+require_relative 'arguments/torrent_add'
+require_relative 'arguments/torrent_set'
+require_relative 'arguments/session_set'
+require_relative 'arguments/location_set'
+require_relative 'utils'
+
+module Transmission
+  class Arguments
+    class InvalidArgument < StandardError; end
+
+    attr_accessor :arguments
+
+    ATTRIBUTES = []
+
+    def initialize(arguments = nil)
+      @arguments = arguments.inject({}) do |attributes, (key, value)|
+        key = key.to_s
+        found = self.class::ATTRIBUTES.select { |attr| attr[:field] == key }
+        raise Transmission::Arguments::InvalidArgument, key if found.empty?
+        attributes[key] = value
+        attributes
+      end if arguments
+      @arguments = self.class::ATTRIBUTES if arguments.nil?
+    end
+
+    def to_arguments
+      @arguments
+    end
+
+    class << self
+      include Transmission::Utils
+
+      def is_valid?(key)
+        is_valid_key? key, self::ATTRIBUTES
+      end
+
+      def real_key(key)
+        option_key key, self::ATTRIBUTES
+      end
+
+      def filter(arguments)
+        arguments.inject({}) do |hash, (key, value)|
+          found = self::ATTRIBUTES.select { |attr| attr[:field] == key.to_s }
+          hash[key] = value unless found.empty?
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/transmission/arguments/location_set.rb

@@ -0,0 +1,11 @@
+module Transmission
+  class Arguments
+    class LocationSet < Transmission::Arguments
+      ATTRIBUTES = [
+        { field: 'ids' },
+        { field: 'location' },
+        { field: 'move' }
+      ].freeze
+    end
+  end
+end

data/lib/transmission/arguments/session_set.rb

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