transmission_api 0.0.1

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/.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 transmission_api.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,55 @@
+# TransmissionApi
+
+Very simple Ruby Gem to comunicate with the Transmission API.
+
+There are other alternatives, this one just works better for me but I recommend you to check out the others.:
+
+* [Transmission Client](https://github.com/dsander/transmission-client)
+* [Transmission Connector](https://github.com/mattissf/transmission-connector)
+
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+    gem "transmission_api"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transmission_api
+
+## Usage
+
+    transmission_api =
+      TransmissionApi.new(
+        :username => "username",
+        :password => "password",
+        :url      => "http://127.0.0.1:9091/transmission/rpc"
+      )
+
+    torrents = transmission_api.all
+    torrent = transmission_api.find(id)
+    torrent = transmission_api.create("http://torrent.com/nice_pic.torrent")
+    transmission_api.destroy(id)
+
+## State
+
+Version experimental, not use in production.
+
+## 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/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "."
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/transmission_api.rb

@@ -0,0 +1,124 @@
+require_relative "transmission_api/version"
+require "httparty"
+require "json"
+
+class TransmissionApi
+  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"
+  ]
+
+  def initialize(opts)
+    @url = opts[:url]
+    @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 create(filename)
+    log "add_torrent: #{filename}"
+
+    response =
+      post(
+        :method => "torrent-add",
+        :arguments => {
+          :filename => filename
+        }
+      )
+
+    response["arguments"]["torrent-added"]
+  end
+
+  def destroy(id)
+    log "remove_torrent: #{id}"
+
+    response =
+      post(
+        :method => "torrent-remove",
+        :arguments => {
+          :ids => [id],
+          :"delete-local-data" => true
+        }
+      )
+
+    response
+  end
+
+  def post(opts)
+    JSON::parse( http_post(opts).body )
+  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_options: #{post_options}"
+
+    response = HTTParty.post( url, post_options )
+
+    log "response.body: #{response.body}"
+    log "response.code: #{response.code}"
+    log "response.message: #{response.message}"
+    log "response.headers: #{response.headers.inspect}"
+
+    # 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 "[TransmissionApi #{Time.now.strftime( "%F %T" )}] #{message}" if debug_mode
+  end
+end

data/lib/transmission_api/version.rb

@@ -0,0 +1,3 @@
+class TransmissionApi
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "test/unit"
+require "mocha"
+require_relative "../lib/transmission_api"
+
+class Test::Unit::TestCase
+  FIXTURES = File.expand_path( "#{File.dirname(__FILE__)}/fixtures" )
+
+  def read_fixture( fixture_name )
+    File.read( "#{FIXTURES}/#{fixture_name}" )
+  end
+end
+

data/test/transmission_api_test.rb

@@ -0,0 +1,146 @@
+require_relative "test_helper"
+
+class TransmissionApiTest < Test::Unit::TestCase
+  def setup
+    @transmission_api = TransmissionApi.new( :url => "http://api.url" )
+  end
+
+  def test_post
+    @transmission_api.stubs(:session_id).returns("SESSION-ID")
+    @transmission_api.stubs(:url).returns("http://api.url")
+
+    opts = { :key1 => "value1", :key2 => "value2" }
+
+    opts_expected = {
+      :body => { :key1 => "value1", :key2 => "value2" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" }
+    }
+
+    response_mock =
+      stub(
+        :code => "",
+        :message => "",
+        :headers => "",
+        :body => {"key" => "value"}.to_json
+      )
+
+    HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
+
+    assert_equal "value", @transmission_api.post(opts)["key"]
+  end
+
+  def test_post_with_basic_auth
+    @transmission_api.stubs(:session_id).returns("SESSION-ID")
+    @transmission_api.stubs(:url).returns("http://api.url")
+    @transmission_api.stubs(:basic_auth).returns("user_pass")
+
+    opts = { :key1 => "value1" }
+
+    opts_expected = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" },
+      :basic_auth => "user_pass"
+    }
+
+    response_mock =
+      stub(
+        :code => "",
+        :message => "",
+        :headers => "",
+        :body => {}.to_json
+      )
+
+    HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
+
+    @transmission_api.post(opts)
+  end
+
+  def test_post_with_409
+    @transmission_api.stubs(:url).returns("http://api.url")
+    @transmission_api.instance_variable_set(:@session_id, "SESSION-ID")
+
+    opts = { :key1 => "value1" }
+
+    opts_expected_1 = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" }
+    }
+
+    opts_expected_2 = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "NEW-SESSION-ID" }
+    }
+
+    response_mock_1 =
+      stub(
+        :code => 409,
+        :message => "",
+        :headers => { "x-transmission-session-id" => "NEW-SESSION-ID" },
+        :body => ""
+      )
+
+    response_mock_2 =
+      stub(
+        :code => 200,
+        :message => "",
+        :headers => "",
+        :body => {"key" => "value"}.to_json
+      )
+
+    post_sequence = sequence("post_sequence")
+    HTTParty.expects(:post).with( "http://api.url", opts_expected_1 ).returns( response_mock_1 ).in_sequence( post_sequence )
+    HTTParty.expects(:post).with( "http://api.url", opts_expected_2 ).returns( response_mock_2 ).in_sequence( post_sequence )
+
+    assert_equal "value", @transmission_api.post(opts)["key"]
+    assert_equal "NEW-SESSION-ID", @transmission_api.instance_variable_get(:@session_id)
+  end
+
+  def test_all
+    opts_expected = {
+      :method => "torrent-get",
+      :arguments => { :fields => "fields" }
+    }
+    result = { "arguments" => { "torrents" => "torrents" } }
+
+    @transmission_api.stubs(:fields).returns("fields")
+    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrents", @transmission_api.all )
+  end
+
+  def test_find
+    opts_expected = {
+      :method => "torrent-get",
+      :arguments => { :fields => "fields", :ids => [1] }
+    }
+    result = { "arguments" => { "torrents" => ["torrent1"] } }
+
+    @transmission_api.stubs(:fields).returns("fields")
+    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrent1", @transmission_api.find(1) )
+  end
+
+  def test_create
+    opts_expected = {
+      :method => "torrent-add",
+      :arguments => { :filename => "filename" }
+    }
+    result = { "arguments" => { "torrent-added" => "torrent-added" } }
+
+    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrent-added", @transmission_api.create( "filename" ) )
+  end
+
+  def test_destroy
+    opts_expected = {
+      :method => "torrent-remove",
+      :arguments => { :ids => [1], :"delete-local-data" => true }
+    }
+
+    @transmission_api.expects(:post).with( opts_expected )
+    @transmission_api.destroy(1)
+  end
+
+end

data/transmission_api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/transmission_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fernando Guillen"]
+  gem.email         = ["fguillen.mail@gmail.com"]
+  gem.description   = "small ruby wrapper for the Transmission RPC API"
+  gem.summary       = "small ruby wrapper for the Transmission RPC API"
+  gem.homepage      = "https://github.com/fguillen/TransmissionApi"
+
+  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          = "transmission_api"
+  gem.require_paths = ["lib"]
+  gem.version       = TransmissionApi::VERSION
+
+  gem.add_dependency "httparty", "0.9.0"
+
+  gem.add_development_dependency "mocha", "0.13.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: transmission_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70137566796900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70137566796900
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70137566796360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: *70137566796360
+description: small ruby wrapper for the Transmission RPC API
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.example
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/transmission_api.rb
+- lib/transmission_api/version.rb
+- test/test_helper.rb
+- test/transmission_api_test.rb
+- transmission_api.gemspec
+homepage: https://github.com/fguillen/TransmissionApi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: small ruby wrapper for the Transmission RPC API
+test_files:
+- test/test_helper.rb
+- test/transmission_api_test.rb