p3-transmission 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d1ab4abe67868f0b5b59fe4c61414efbba6fd51
+  data.tar.gz: 644aa09bdc06eaa35b067805aa66286a7e7019bb
+SHA512:
+  metadata.gz: cdb1e2f08417ce3892442bea49c9edf21a09501545d4e1c64976e6ada7bb670c49c51e18194c8efd3d4b1d16131d3501a04a9b2de07e13dd9459471d607dc43d
+  data.tar.gz: 7affdfac440b4691fe4a31ef248c6eb3f02dee8daf300d45a22cc1c544e37524fcaf1b58d36a2616e9775fbb1776e35a1215f12238c16c6967bb8939a31c06d7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use --create 1.9.3-p286@transmission_api

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fernando Guillen
+
+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,35 @@
+# p3-transmission
+
+Control Transmission with this API.
+
+## Installation
+
+    $ gem install p3-transmission
+
+## Usage
+
+    transmission =
+      P3::Transmission::Client.new(
+        :username => "username",
+        :password => "password",
+        :url      => "http://127.0.0.1:9091/transmission/rpc"
+      )
+
+    torrents = transmission.all
+    torrent = transmission.find(id)
+    torrent = transmission.create("http://torrent.com/nice_pic.torrent")
+    transmission.remove(id)
+
+## Transmission Api Doc
+
+* https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt
+
+Supported Transmission Api Version: 2.40
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Added some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/p3-transmission.rb

@@ -0,0 +1,11 @@
+require_relative "p3-transmission/version"
+require_relative "p3-transmission/client"
+require_relative "p3-transmission/exception"
+
+require "httparty"
+require "json"
+
+module P3
+    module Transmission
+    end
+end

data/lib/p3-transmission/client.rb

@@ -0,0 +1,233 @@
+module P3
+    module Transmission
+        class Client
+            attr_accessor :session_id
+            attr_accessor :url
+            attr_accessor :basic_auth
+            attr_accessor :fields
+            attr_accessor :debug_mode
+
+            TORRENT_FIELDS = [
+                "id",
+                "name",
+                "totalSize",
+                "addedDate",
+                "isFinished",
+                "rateDownload",
+                "rateUpload",
+                "percentDone",
+                "files",
+                "comment",
+                "description",
+                "downloadDir",
+                "doneDate",
+                "eta",
+                "hashString",
+                "leechers",
+                "leftUntilDone",
+                "name",
+                "rateDownload",
+                "seeders",
+                "seedRatioLimit",
+                "sizeWhenDone",
+                "status",
+                "torrentFile",
+                "trackers",
+                "uploadLimit",
+                "uploadLimited",
+                "uploadRatio"
+            ]
+
+            def initialize(opts)
+                @url = opts[:url] || "http://#{opts[:host]}:#{opts[:port]}/transmission/rpc"
+                @fields = opts[:fields] || TORRENT_FIELDS
+                @basic_auth = { :username => opts[:username], :password => opts[:password] } if opts[:username]
+                @session_id = "NOT-INITIALIZED"
+                @debug_mode = opts[:debug_mode] || false
+            end
+
+            def all
+                log "get_torrents"
+
+                response =
+                    post(
+                        :method => "torrent-get",
+                        :arguments => {
+                            :fields => fields
+                        }
+                    )
+
+                response["arguments"]["torrents"]
+            end
+
+            def find(id)
+                log "get_torrent: #{id}"
+
+                response =
+                    post(
+                        :method => "torrent-get",
+                        :arguments => {
+                            :fields => fields,
+                            :ids => [id]
+                        }
+                    )
+
+                response["arguments"]["torrents"].first
+            end
+
+            def resume(id)
+                log "resume_torrent: #{id}"
+
+                response =
+                    post(
+                        :method => "torrent-start",
+                        :arguments => {
+                            :ids => [id]
+                        }
+                    )
+            end
+
+            def resume_all()
+                log "resume_all_torrents"
+
+                response =
+                    post(
+                        :method => "torrent-start",
+                    )
+            end
+
+            def pause(id)
+                log "pause_torrent: #{id}"
+
+                response =
+                    post(
+                        :method => "torrent-stop",
+                        :arguments => {
+                            :ids => [id]
+                        }
+                    )
+            end
+
+            def pause_all()
+                log "pause_all_torrents"
+
+                response =
+                    post(
+                        :method => "torrent-stop",
+                    )
+            end
+
+            def create(filename)
+                log "add_torrent: #{filename}"
+
+                response =
+                    post(
+                        :method => "torrent-add",
+                        :arguments => {
+                            :filename => filename
+                        }
+                    )
+
+                response["arguments"]["torrent-added"]
+            end
+
+            #remove the torrent but **keep** the file
+            def remove(id)
+                log "remove_torrent: #{id}"
+
+                response =
+                    post(
+                        :method => "torrent-remove",
+                        :arguments => {
+                            :ids => [id],
+                                       :"delete-local-data" => false
+                        }
+                    )
+
+                response
+            end
+
+            #remove the torrent and **delete** the file
+            def destroy(id)
+                log "remove_torrent: #{id}"
+
+                response =
+                    post(
+                        :method => "torrent-remove",
+                        :arguments => {
+                            :ids => [id],
+                                       :"delete-local-data" => true
+                        }
+                    )
+
+                response
+            end
+
+            def post(opts)
+                response_parsed = JSON::parse( http_post(opts).body )
+
+                if response_parsed["result"] != "success"
+                    raise Transmission::Exception, response_parsed["result"]
+                end
+
+                response_parsed
+            end
+
+            def http_post(opts)
+                post_options = {
+                    :body => opts.to_json,
+                    :headers => { "x-transmission-session-id" => session_id }
+                }
+                post_options.merge!( :basic_auth => basic_auth ) if basic_auth
+
+                log "url: #{url}"
+                log "post_body:"
+                log JSON.parse(post_options[:body]).to_yaml
+                log "------------------"
+
+                response = HTTParty.post( url, post_options )
+
+                log_response response
+
+                # retry connection if session_id incorrect
+                if( response.code == 409 )
+                    log "changing session_id"
+                    @session_id = response.headers["x-transmission-session-id"]
+                    response = http_post(opts)
+                end
+
+                response
+            end
+
+            def log(message)
+                Kernel.puts "[P3::Transmission #{Time.now.strftime( "%F %T" )}] #{message}" if debug_mode
+            end
+
+            def log_response(response)
+                body = nil
+                begin
+                    body = JSON.parse(response.body).to_yaml
+                rescue
+                    body = response.body
+                end
+
+                headers = response.headers.to_yaml
+
+                log "response.code: #{response.code}"
+                log "response.message: #{response.message}"
+
+                log "response.body_raw:"
+                log response.body
+                log "-----------------"
+
+                log "response.body:"
+                log body
+                log "-----------------"
+
+                log "response.headers:"
+                log headers
+                log "------------------"
+            end
+        end
+    end
+end

data/lib/p3-transmission/exception.rb

@@ -0,0 +1,6 @@
+module P3
+    module Transmission
+        class Exception < Exception
+        end
+    end
+end

data/lib/p3-transmission/version.rb

@@ -0,0 +1,5 @@
+module P3
+    module Transmission
+        VERSION = "0.0.15"
+    end
+end

data/p3-transmission.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/p3-transmission/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fernando Guillen", "Poul Hornsleth"]
+  gem.email         = ["fguillen.mail@gmail.com"]
+  gem.description   = "Transmission RPC API"
+  gem.summary       = "Control Trasmission with this API"
+  gem.homepage      = "https://github.com/poulh/p3-transmission"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "p3-transmission"
+  gem.require_paths = ["lib"]
+  gem.licenses      = "MIT"
+  gem.version       = P3::Transmission::VERSION
+
+  gem.add_dependency "httparty", "~> 0.13.7"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: p3-transmission
+version: !ruby/object:Gem::Version
+  version: 0.0.15
+platform: ruby
+authors:
+- Fernando Guillen
+- Poul Hornsleth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Transmission RPC API
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .rvmrc.example
+- Gemfile
+- LICENSE
+- README.md
+- lib/p3-transmission.rb
+- lib/p3-transmission/client.rb
+- lib/p3-transmission/exception.rb
+- lib/p3-transmission/version.rb
+- p3-transmission.gemspec
+homepage: https://github.com/poulh/p3-transmission
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Control Trasmission with this API
+test_files: []