transmission_api 0.0.3 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63e739f0537e8f760ee9c79eec35a1f694b7d3b8
+  data.tar.gz: 04aebd70e7c6dc22cab947620cbdff22268520b0
+SHA512:
+  metadata.gz: 3bd9c7de2663c9f0060187ade806556b1e1d90d35582e5bd17a825c8b67328f0f368c794fc72021a185087fa3cfd4fd770032d71b67aa1aeca93c39f05d0f6f3
+  data.tar.gz: 6c0d49866c5f2d890bb55f67f9d38441d0314b0b1474fe735447f36b3c42c698c8e254db93397b4beb88d859fe2df5ea93e0818a683477084136539dd3f42dbf

data/Gemfile

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

data/lib/torrents_fake.json

@@ -0,0 +1,104 @@
+[ { "files" : [ { "bytesCompleted" : 27062831,
+          "length" : 52146735,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/Content/TRAILER_3_Cinetic.mov"
+        },
+        { "bytesCompleted" : 718,
+          "length" : 718,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/Description.txt"
+        },
+        { "bytesCompleted" : 51,
+          "length" : 51,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/License.txt"
+        }
+      ],
+    "hashString" : "77831ec368308f1031434c5581a76fd0c3e06cfd",
+    "name" : "No Media Kings - Ghosts With Shit Jobs trailer",
+    "percentDone" : 0.51890000000000003,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 52147504
+  },
+  { "files" : [ { "bytesCompleted" : 24892844,
+          "length" : 24892844,
+          "name" : "Michael Mandiberg - Old News/Content/mandiberg_oldnews.mov"
+        },
+        { "bytesCompleted" : 237,
+          "length" : 237,
+          "name" : "Michael Mandiberg - Old News/Description.txt"
+        },
+        { "bytesCompleted" : 669,
+          "length" : 669,
+          "name" : "Michael Mandiberg - Old News/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 101,
+          "length" : 101,
+          "name" : "Michael Mandiberg - Old News/License.txt"
+        }
+      ],
+    "hashString" : "5f888e119ecb0cf8c25e68925164f533b1007038",
+    "name" : "Michael Mandiberg - Old News",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 24893851
+  },
+  { "files" : [ { "bytesCompleted" : 31103230,
+          "length" : 31103230,
+          "name" : "pearl-jam-life-wasted-video/PearlJamLifeWasted.avi"
+        } ],
+    "hashString" : "1b2162c33001cb3c51d917441e74e313996dff96",
+    "name" : "pearl-jam-life-wasted-video",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 31103230
+  },
+  { "files" : [ { "bytesCompleted" : 31772861,
+          "length" : 31772861,
+          "name" : "thewoolleyman - cinabox-screencast/Content/Cinabox_Screencast.mov"
+        },
+        { "bytesCompleted" : 309,
+          "length" : 309,
+          "name" : "thewoolleyman - cinabox-screencast/Description.txt"
+        },
+        { "bytesCompleted" : 669,
+          "length" : 669,
+          "name" : "thewoolleyman - cinabox-screencast/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 52,
+          "length" : 52,
+          "name" : "thewoolleyman - cinabox-screencast/License.txt"
+        }
+      ],
+    "hashString" : "0032886cdb4b0dcd6e75b5ac6901afda64367e0c",
+    "name" : "thewoolleyman - cinabox-screencast",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 31773891
+  },
+  { "files" : [ { "bytesCompleted" : 0,
+          "length" : 13894821,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/Content/the road to god knows... graphic novel trailer.wmv"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 1114,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/Description.txt"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 669,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 127,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/License.txt"
+        }
+      ],
+    "hashString" : "6d97bb6424d048fe605d3fe558c5c5333cdd6227",
+    "name" : "Von Allan Studio - the road to god knows___ trailer",
+    "percentDone" : 0,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 13896731
+  }
+]

data/lib/transmission_api.rb

@@ -1,124 +1,10 @@
 require_relative "transmission_api/version"
+require_relative "transmission_api/client"
+require_relative "transmission_api/client_fake"
+require_relative "transmission_api/exception"
+
 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
+module TransmissionApi
 end

data/lib/transmission_api/client.rb

@@ -0,0 +1,151 @@
+class TransmissionApi::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"
+  ]
+
+  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)
+    response_parsed = JSON::parse( http_post(opts).body )
+
+    if response_parsed["result"] != "success"
+      raise TransmissionApi::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 "[TransmissionApi #{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

data/lib/transmission_api/client_fake.rb

@@ -0,0 +1,39 @@
+class TransmissionApi::ClientFake < TransmissionApi::Client
+
+  attr_reader :torrents
+
+  def initialize(opts)
+    super
+    torrents_path = opts[:torrents_path] || "#{File.dirname(__FILE__)}/../torrents_fake.json"
+    @torrents = JSON.parse(File.read(torrents_path))
+  end
+
+  def all
+    torrents
+  end
+
+  def find(id)
+    torrents.select { |e| e["hashString"] == id }.first
+  end
+
+  def create(filename)
+    torrent = {
+      "files" => [],
+      "hashString" => "77831ec368308f1031434c5581a76fd0c3e06cfd",
+      "name" => "No Media Kings - Ghosts With Shit Jobs trailer",
+      "percentDone" => 0,
+      "rateUpload" => 0,
+      "rateDownload" => 0,
+      "totalSize" => 100
+    }
+
+    torrents << torrent
+
+    torrent
+  end
+
+  def destroy(id)
+    torrents.delete_if { |e| e["hashString"] == id }
+  end
+
+end

data/lib/transmission_api/exception.rb

@@ -0,0 +1,2 @@
+class TransmissionApi::Exception < Exception
+end

data/lib/transmission_api/version.rb

@@ -1,3 +1,3 @@
-class TransmissionApi
-  VERSION = "0.0.3"
+module TransmissionApi
+  VERSION = "0.0.7"
 end

data/test/client_fake_test.rb

@@ -0,0 +1,34 @@
+require_relative "test_helper"
+
+class ClientFakeTest < Test::Unit::TestCase
+  def setup
+    @client = TransmissionApi::ClientFake.new({})
+  end
+
+  def test_all
+    assert_equal( "77831ec368308f1031434c5581a76fd0c3e06cfd", @client.all.first["hashString"] )
+  end
+
+  def test_find
+    assert_equal( "77831ec368308f1031434c5581a76fd0c3e06cfd", @client.find("77831ec368308f1031434c5581a76fd0c3e06cfd")["hashString"] )
+  end
+
+  def test_create
+    assert_equal( "77831ec368308f1031434c5581a76fd0c3e06cfd", @client.create("filename")["hashString"] )
+  end
+
+  def test_destroy
+    torrents = [
+      { "hashString" => "A" },
+      { "hashString" => "B" },
+      { "hashString" => "C" },
+    ]
+
+    @client.expects(:torrents).returns(torrents)
+
+    @client.destroy("B")
+
+    assert_equal(["A", "C"], torrents.map{ |e| e["hashString"] })
+  end
+
+end

data/test/{transmission_api_test.rb → client_test.rb}

@@ -1,13 +1,13 @@
 require_relative "test_helper"
 
-class TransmissionApiTest < Test::Unit::TestCase
+class ClientTest < Test::Unit::TestCase
   def setup
-    @transmission_api = TransmissionApi.new( :url => "http://api.url" )
+    @client = TransmissionApi::Client.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")
+    @client.stubs(:session_id).returns("SESSION-ID")
+    @client.stubs(:url).returns("http://api.url")
 
     opts = { :key1 => "value1", :key2 => "value2" }
 
@@ -21,18 +21,18 @@ class TransmissionApiTest < Test::Unit::TestCase
         :code => "",
         :message => "",
         :headers => "",
-        :body => {"key" => "value"}.to_json
+        :body => {"key" => "value", "result" => "success"}.to_json
       )
 
     HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
 
-    assert_equal "value", @transmission_api.post(opts)["key"]
+    assert_equal "value", @client.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")
+    @client.stubs(:session_id).returns("SESSION-ID")
+    @client.stubs(:url).returns("http://api.url")
+    @client.stubs(:basic_auth).returns("user_pass")
 
     opts = { :key1 => "value1" }
 
@@ -47,17 +47,17 @@ class TransmissionApiTest < Test::Unit::TestCase
         :code => "",
         :message => "",
         :headers => "",
-        :body => {}.to_json
+        :body => {"result" => "success"}.to_json
       )
 
     HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
 
-    @transmission_api.post(opts)
+    @client.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")
+    @client.stubs(:url).returns("http://api.url")
+    @client.instance_variable_set(:@session_id, "SESSION-ID")
 
     opts = { :key1 => "value1" }
 
@@ -84,15 +84,15 @@ class TransmissionApiTest < Test::Unit::TestCase
         :code => 200,
         :message => "",
         :headers => "",
-        :body => {"key" => "value"}.to_json
+        :body => {"key" => "value", "result" => "success"}.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)
+    assert_equal "value", @client.post(opts)["key"]
+    assert_equal "NEW-SESSION-ID", @client.instance_variable_get(:@session_id)
   end
 
   def test_all
@@ -102,10 +102,10 @@ class TransmissionApiTest < Test::Unit::TestCase
     }
     result = { "arguments" => { "torrents" => "torrents" } }
 
-    @transmission_api.stubs(:fields).returns("fields")
-    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+    @client.stubs(:fields).returns("fields")
+    @client.expects(:post).with( opts_expected ).returns( result )
 
-    assert_equal( "torrents", @transmission_api.all )
+    assert_equal( "torrents", @client.all )
   end
 
   def test_find
@@ -115,10 +115,10 @@ class TransmissionApiTest < Test::Unit::TestCase
     }
     result = { "arguments" => { "torrents" => ["torrent1"] } }
 
-    @transmission_api.stubs(:fields).returns("fields")
-    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+    @client.stubs(:fields).returns("fields")
+    @client.expects(:post).with( opts_expected ).returns( result )
 
-    assert_equal( "torrent1", @transmission_api.find(1) )
+    assert_equal( "torrent1", @client.find(1) )
   end
 
   def test_create
@@ -128,9 +128,9 @@ class TransmissionApiTest < Test::Unit::TestCase
     }
     result = { "arguments" => { "torrent-added" => "torrent-added" } }
 
-    @transmission_api.expects(:post).with( opts_expected ).returns( result )
+    @client.expects(:post).with( opts_expected ).returns( result )
 
-    assert_equal( "torrent-added", @transmission_api.create( "filename" ) )
+    assert_equal( "torrent-added", @client.create( "filename" ) )
   end
 
   def test_destroy
@@ -139,8 +139,20 @@ class TransmissionApiTest < Test::Unit::TestCase
       :arguments => { :ids => [1], :"delete-local-data" => true }
     }
 
-    @transmission_api.expects(:post).with( opts_expected )
-    @transmission_api.destroy(1)
+    @client.expects(:post).with( opts_expected )
+    @client.destroy(1)
+  end
+
+  def test_if_not_success_raise_exception
+    result_mock = mock(:body => { "arguments" => {}, "result" => "Wadus error" }.to_json)
+    @client.expects(:http_post).returns(result_mock)
+
+    exception =
+      assert_raise(TransmissionApi::Exception) do
+        @client.create("filename")
+      end
+
+    assert_equal("Wadus error", exception.message)
   end
 
 end

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: transmission_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Fernando Guillen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70202125524120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70202125524120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70202125523580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.13.0
   type: :development
   prerelease: false
-  version_requirements: *70202125523580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 description: small ruby wrapper for the Transmission RPC API
 email:
 - fguillen.mail@gmail.com
@@ -46,35 +51,40 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/torrents_fake.json
 - lib/transmission_api.rb
+- lib/transmission_api/client.rb
+- lib/transmission_api/client_fake.rb
+- lib/transmission_api/exception.rb
 - lib/transmission_api/version.rb
+- test/client_fake_test.rb
+- test/client_test.rb
 - test/test_helper.rb
-- test/transmission_api_test.rb
 - transmission_api.gemspec
 homepage: https://github.com/fguillen/TransmissionApi
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: small ruby wrapper for the Transmission RPC API
 test_files:
+- test/client_fake_test.rb
+- test/client_test.rb
 - test/test_helper.rb
-- test/transmission_api_test.rb