transmission-rpc-ruby 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efdf44a2260c3452e6cb831d4500909d58de5065
-  data.tar.gz: d13509c0535e64e4de343e417d393dcf31b4e799
+  metadata.gz: 15491a3e93e2a8a22302abb1d9921ad6a860a080
+  data.tar.gz: db5be0864ccb78101bf44138a992265260cbc5b2
 SHA512:
-  metadata.gz: 31ba84133758e97c74d5e25ab7c08ac0b1457ab7fe3e0272c7f440dba1eeab2ea91d6409649a904d9f8dcf60bbdcec665c6700ade82609c8b62577707aa79f00
-  data.tar.gz: d5482d480e85a4b47fd87486a8c8ac8bfb3e8a2c02a443f24bb4e6e20cba13d30c26e5fcb5d1e80980f92834c55c40489cef80f143dbef0f8fbb59c06d8cbd6c
+  metadata.gz: 76c299668f5f310ebd87c07f8d98f889e49091cc5b8469fbd3ed91f3e430c051f602a45497f2a11e097e04a3eb345b47f705b759606c3184cf2182bca0c13520
+  data.tar.gz: f31884514bc2afa898b2e190445dc900f242385dc74c45747b5d5df9369add7b9a16fcfe144644849155469c44339021328746aa8b8d0d2fc833fbcb4ea56d90

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## v0.3.0 (2015-04-02)
+
+Features:
+
+- ability to handle multiple torrents in one instance
+- `start_all!` & `stop_all!` static class methods for torrents
+- `reload!`, `to_json`, `is_multi?`, `is_finished` instance method for torrents
+- `to_json` instance method for session & session stats
+
+## v0.2.1 (2015-04-01)
+
+Bugfixes:
+
+- when adding torrents the returned torrent instance will use same options for finding added torrent
+
+## v0.2.0 (2015-03-31)
+
+Features:
+
+- all basic torrent actions (start, stop, move up queue, etc)
+- session model
+- session stats model
+- adding torrents
+
+## v0.1.0 (2015-03-12)
+
+- Initial project import

data/README.md

@@ -1,6 +1,6 @@
 # Transmission RPC Ruby
 
-[![Build Status](https://travis-ci.org/transmission-rails/transmission-rpc-ruby.svg?branch=master)](https://travis-ci.org/transmission-rails/transmission-rpc-ruby) [![Code Climate](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby/badges/gpa.svg)](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby) [![Dependency Status](https://gemnasium.com/transmission-rails/transmission-rpc-ruby.svg)](https://gemnasium.com/transmission-rails/transmission-rpc-ruby) [![Coverage Status](https://coveralls.io/repos/transmission-rails/transmission-rpc-ruby/badge.svg?branch=master)](https://coveralls.io/r/transmission-rails/transmission-rpc-ruby?branch=master)
+[![Build Status](https://travis-ci.org/transmission-rails/transmission-rpc-ruby.svg?branch=master)](https://travis-ci.org/transmission-rails/transmission-rpc-ruby) [![Code Climate](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby/badges/gpa.svg)](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby) [![Dependency Status](https://gemnasium.com/transmission-rails/transmission-rpc-ruby.svg)](https://gemnasium.com/transmission-rails/transmission-rpc-ruby) [![Coverage Status](https://coveralls.io/repos/transmission-rails/transmission-rpc-ruby/badge.svg?branch=master)](https://coveralls.io/r/transmission-rails/transmission-rpc-ruby?branch=master) [![Gem Version](https://badge.fury.io/rb/transmission-rpc-ruby.svg)](http://badge.fury.io/rb/transmission-rpc-ruby)
 
 Transmission RPC Ruby is a Ruby library to communicate with Transmission RPC (bittorrent client).
 This library is based on this [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt) and currently supports RPC versions >= 14
@@ -105,6 +105,12 @@ Or use an RPC connector instance
     torrent.move_top!
     torrent.move_bottom!
 
+    torrent.finished?
+    # => true
+
+    torrent.to_json
+    # => {"id"=>132, "name"=>"Torrent Name", ....}
+
 You can access the torrent accessors & mutators via instance methods too
 
     # uploadLimited
@@ -117,6 +123,43 @@ The `save!` method will update the torrent on your remote transmission daemon.
 
 To find all the torrent [accessors](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L127) & [mutators](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L90) visit [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt)
 
+#### Start & Stop all torrents
+
+You can also start and stop all torrents
+
+    Transmission::Model::Torrent.start_all!
+
+    Transmission::Model::Torrent.stop_all!
+
+#### Dealing with multiple torrents
+
+If you want to change multiple torrents at once:
+
+    ids = [1, 2, 3]
+    torrents = Transmission::Model::Torrent.find ids
+
+This will return a `Transmission::Model::Torrent` instance which takes the same methods as described before.
+
+    torrents.start!
+    torrents.stop!
+    # ...
+
+    torrents.to_json
+    # => [{"id"=>132, "name"=>"Torrent Name", ....}, {...}]
+
+    # uploadLimited
+    torrents.upload_limited = false
+    torrents.save!
+
+This will change `uploadLimited` for all torrents with ids 1, 2 & 3.
+
+__NOTE:__ If using `Transmission::Model::Torrent` you will only be able to modify their mutators.
+
+To find out if a torrent instance contains multiple torrents
+
+    torrents.is_multi?
+    # => true
+
 ### Session
 
 To find out more about the current session use the `Transmission::Model::Session` class.
@@ -178,6 +221,42 @@ If it is not desired to use any of the `Transmission::Model` classes you can use
 
 For more methods check out `lib/transmission/rpc.rb`
 
+## Changelog
+
+### v0.3.0 (2015-04-02)
+
+Features:
+
+- ability to handle multiple torrents in one instance
+- `start_all!` & `stop_all!` static class methods for torrents
+- `reload!`, `to_json`, `is_multi?`, `is_finished` instance method for torrents
+- `to_json` instance method for session & session stats
+
+### v0.2.1 (2015-04-01)
+
+Bugfixes:
+
+- when adding torrents the returned torrent instance will use same options for finding added torrent
+
+### v0.2.0 (2015-03-31)
+
+Features:
+
+- all basic torrent actions (start, stop, move up queue, etc)
+- session model
+- session stats model
+- adding torrents
+
+### v0.1.0 (2015-03-12)
+
+- Initial project import
+
+## Roadmap
+
+- Add support for all versions of RPC
+- More documentation
+- Add 'torrent-rename-path' & 'torrent-set-location' & 'port-test' & 'free-space' & 'session-close' RPC methods
+
 ## Contribute
 
 Please help make this gem awesome! If you have any suggestions or feedback either create an issue or PR.

data/lib/transmission.rb

@@ -6,5 +6,5 @@ require File.join(File.dirname(__FILE__), 'transmission', 'arguments')
 require File.join(File.dirname(__FILE__), 'transmission', 'utils')
 
 module Transmission
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/transmission/model/session.rb

@@ -15,6 +15,10 @@ module Transmission
         connector.set_session filtered
       end
 
+      def to_json
+        @attributes
+      end
+
       def method_missing(symbol, *args)
         string = symbol.to_s
         if string[-1] == '='

data/lib/transmission/model/session_stats.rb

@@ -9,6 +9,10 @@ module Transmission
         @connector = connector
       end
 
+      def to_json
+        @attributes
+      end
+
       class << self
         def get(options = {})
           rpc = options[:connector] || connector

data/lib/transmission/model/torrent.rb

@@ -6,65 +6,90 @@ module Transmission
       class MissingAttributesError < StandardError; end
       class DuplicateTorrentError < StandardError; end
 
-      attr_accessor :attributes, :deleted, :connector
+      attr_accessor :attributes, :deleted, :connector, :torrents, :ids
 
       def initialize(torrent_object, connector)
-        @attributes = torrent_object
+        if torrent_object.is_a? Array
+          is_single = torrent_object.size == 1
+          @attributes = is_single ? torrent_object.first : {}
+          @ids = is_single ? [@attributes['id'].to_i] : []
+          @torrents = torrent_object.inject([]) do |torrents, torrent|
+            @ids << torrent['id'].to_i
+            torrents << Torrent.new([torrent], connector)
+          end unless is_single
+        end
         @connector = connector
       end
 
       def delete!(remove_local_data = false)
-        connector.remove_torrent [self.id], remove_local_data
+        connector.remove_torrent @ids, remove_local_data
         @deleted = true
       end
 
       def save!
         filtered = Transmission::Arguments::TorrentSet.filter @attributes
-        connector.set_torrent [self.id], filtered
+        connector.set_torrent @ids, filtered
       end
 
       def move_up!
-        connector.move_up_torrent [self.id]
+        connector.move_up_torrent @ids
       end
 
       def move_down!
-        connector.move_down_torrent [self.id]
+        connector.move_down_torrent @ids
       end
 
       def move_top!
-        connector.move_top_torrent [self.id]
+        connector.move_top_torrent @ids
       end
 
       def move_bottom!
-        connector.move_bottom_torrent [self.id]
+        connector.move_bottom_torrent @ids
       end
 
       def start!
-        connector.start_torrent [self.id]
+        connector.start_torrent @ids
       end
 
       def start_now!
-        connector.start_torrent_now [self.id]
+        connector.start_torrent_now @ids
       end
 
       def stop!
-        connector.stop_torrent [self.id]
+        connector.stop_torrent @ids
       end
 
       def verify!
-        connector.verify_torrent [self.id]
+        connector.verify_torrent @ids
       end
 
       def re_announce!
-        connector.re_announce_torrent [self.id]
+        connector.re_announce_torrent @ids
+      end
+
+      def is_multi?
+        @ids.size > 1
       end
 
       def finished?
+        self.percent_done == 1
+      end
 
+      def reload!
+        torrents = Torrent.find @ids, connector: @connector
+        @ids = torrents.ids
+        @attributes = torrents.attributes
+        @torrents = torrents.torrents
       end
 
       def to_json
-
+        if is_multi?
+          @torrents.inject([]) do |torrents, torrent|
+            torrents << torrent.to_json
+          end
+        else
+          @attributes
+        end
       end
 
       def method_missing(symbol, *args)
@@ -84,16 +109,15 @@ module Transmission
         def all(options = {})
           rpc = options[:connector] || connector
           body = rpc.get_torrent nil, options[:fields]
-          body['torrents'].inject([]) do |torrents, torrent|
-            torrents << Torrent.new(torrent, rpc)
-          end
+          Torrent.new body['torrents'], rpc
         end
 
         def find(id, options = {})
           rpc = options[:connector] || connector
-          body = rpc.get_torrent [id], options[:fields]
+          ids = id.is_a?(Array) ? id : [id]
+          body = rpc.get_torrent ids, options[:fields]
           raise TorrentNotFoundError if body['torrents'].size == 0
-          Torrent.new body['torrents'].first, rpc
+          Torrent.new body['torrents'], rpc
         end
 
         def add(options = {})
@@ -103,6 +127,16 @@ module Transmission
           find body['torrent-added']['id'], options
         end
 
+        def start_all!(options = {})
+          rpc = options[:connector] || connector
+          rpc.start_torrent nil
+        end
+
+        def stop_all!(options = {})
+          rpc = options[:connector] || connector
+          rpc.stop_torrent nil
+        end
+
         def connector
           Transmission::Config.get_connector
         end

data/spec/transmission/model/session_spec.rb

@@ -45,6 +45,14 @@ describe Transmission::Model::Session do
     end
   end
 
+  describe '#to_json' do
+    let(:session) { Transmission::Model::Session.new({'id' => 1}, nil) }
+
+    it 'should return its attributes' do
+      expect(session.to_json).to eq({'id' => 1})
+    end
+  end
+
   describe '#method_missing' do
     let(:session) { Transmission::Model::Session.new({'id' => 1, 'name' => 'some name', 'some-key' => 'some-value'}, nil) }
 

data/spec/transmission/model/torrent_spec.rb

@@ -8,10 +8,9 @@ describe Transmission::Model::Torrent do
         stub_get_torrent({}, [{id: 1}])
       end
 
-      it 'should return an array of Torrent models' do
+      it 'should return a Torrent model instance' do
         torrents = Transmission::Model::Torrent.all
-        expect(torrents).to be_an(Array)
-        expect(torrents.first).to be_a(Transmission::Model::Torrent)
+        expect(torrents).to be_a(Transmission::Model::Torrent)
       end
     end
 
@@ -23,10 +22,9 @@ describe Transmission::Model::Torrent do
             .to_return(successful_response({arguments: {torrents: [{id: 1}]}}))
       end
 
-      it 'should return an array of Torrent models' do
+      it 'should return a Torrent model instance' do
         torrents = Transmission::Model::Torrent.all connector: @rpc
-        expect(torrents).to be_an(Array)
-        expect(torrents.first).to be_a(Transmission::Model::Torrent)
+        expect(torrents).to be_a(Transmission::Model::Torrent)
       end
     end
 
@@ -71,6 +69,23 @@ describe Transmission::Model::Torrent do
       end
     end
 
+    describe 'with multiple ids' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_torrent({ids: [1, 2]}, [{id: 1}, {id: 2}])
+      end
+
+      it 'should return a Torrent model instance' do
+        torrent = Transmission::Model::Torrent.find [1, 2], connector: @rpc
+        expect(torrent).to be_a(Transmission::Model::Torrent)
+      end
+
+      it 'should remember all ids' do
+        torrent = Transmission::Model::Torrent.find [1, 2], connector: @rpc
+        expect(torrent.ids).to eq([1, 2])
+      end
+    end
+
   end
 
   describe '.add' do
@@ -107,6 +122,32 @@ describe Transmission::Model::Torrent do
 
   end
 
+  describe '.start_all!' do
+    before :each do
+      Transmission::Config.set
+      stub_rpc_request
+          .with(body: torrent_method_body('torrent-start', {}))
+          .to_return(successful_response)
+    end
+
+    it 'should start all torrents' do
+      Transmission::Model::Torrent.start_all!
+    end
+  end
+
+  describe '.stop_all!' do
+    before :each do
+      Transmission::Config.set
+      stub_rpc_request
+          .with(body: torrent_method_body('torrent-stop', {}))
+          .to_return(successful_response)
+    end
+
+    it 'should start all torrents' do
+      Transmission::Model::Torrent.stop_all!
+    end
+  end
+
   describe '#delete!' do
 
     describe 'with configuration' do
@@ -141,10 +182,77 @@ describe Transmission::Model::Torrent do
       end
     end
 
+    describe 'with multiple ids' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_torrent({ids: [1, 2]}, [{id: 1}, {id: 2}])
+        stub_rpc_request
+            .with(body: torrent_remove_body({:ids => [1, 2], 'delete-local-data' => false}))
+            .to_return(successful_response({arguments: {torrents: [{id: 1}, {id: 2}]}}))
+      end
+
+      it 'should remove the torrent files' do
+        torrent = Transmission::Model::Torrent.find [1, 2], :connector => @rpc
+        torrent.delete!
+        expect(torrent.deleted).to eq(true)
+      end
+    end
+
+  end
+
+  describe '#is_multi?' do
+    let(:torrents) { Transmission::Model::Torrent.new([{'id' => 1}, {'id' => 2}], nil) }
+    let(:torrent) { Transmission::Model::Torrent.new([{'id' => 1}], nil) }
+
+    describe 'with multiple torrents' do
+      it 'should return true' do
+        expect(torrents.is_multi?).to eq(true)
+      end
+    end
+
+    describe 'with single torrent' do
+      it 'should return false' do
+        expect(torrent.is_multi?).to eq(false)
+      end
+    end
+  end
+
+  describe '#to_json' do
+    let(:torrents) { Transmission::Model::Torrent.new([{'id' => 1}, {'id' => 2}], nil) }
+    let(:torrent) { Transmission::Model::Torrent.new([{'id' => 1}], nil) }
+
+    describe 'with multiple torrents' do
+      it 'should return true' do
+        expect(torrents.to_json).to eq([{'id' => 1}, {'id' => 2}])
+      end
+    end
+
+    describe 'with single torrent' do
+      it 'should return false' do
+        expect(torrent.to_json).to eq({'id' => 1})
+      end
+    end
+  end
+
+  describe '#finished?' do
+    let(:unfinished_torrent) { Transmission::Model::Torrent.new([{'id' => 1, 'percentDone' => 0.5}], nil) }
+    let(:finished_torrent) { Transmission::Model::Torrent.new([{'id' => 1, 'percentDone' => 1}], nil) }
+
+    describe 'with finished torrent' do
+      it 'should return true' do
+        expect(finished_torrent.finished?).to eq(true)
+      end
+    end
+
+    describe 'with unfinished torrent' do
+      it 'should return false' do
+        expect(unfinished_torrent.finished?).to eq(false)
+      end
+    end
   end
 
   describe '#method_missing' do
-    let(:torrent) { Transmission::Model::Torrent.new({'id' => 1, 'name' => 'some name', 'some-key' => 'some-value'}, nil) }
+    let(:torrent) { Transmission::Model::Torrent.new([{'id' => 1, 'name' => 'some name', 'some-key' => 'some-value'}], nil) }
 
     before :each do
       stub_const("Transmission::Fields::TorrentGet::ATTRIBUTES", [{field: 'id'}, {field: 'name'}, {field: 'some-key'}])
@@ -211,16 +319,21 @@ describe Transmission::Model::Torrent do
     describe "##{object[:method]}" do
       let(:rpc) {Transmission::RPC.new}
 
-      before :each do
-        stub_get_torrent({ids: [1]}, [{id: 1}])
-        stub_rpc_request
-            .with(body: torrent_method_body(object[:rpc_method], {ids: [1]}))
-            .to_return(successful_response)
-      end
-
-      it "should #{object[:method]} torrent" do
-        torrent = Transmission::Model::Torrent.find 1, connector: rpc
-        torrent.send object[:method].to_sym
+      [
+          {ids: [1], response: [{id: 1}], text: ''},
+          {ids: [1, 2], response: [{id: 1}, {id: 2}], text: 'with multiple ids'}
+      ].each do |args|
+        before :each do
+          stub_get_torrent({ids: args[:ids]}, args[:response])
+          stub_rpc_request
+              .with(body: torrent_method_body(object[:rpc_method], {ids: args[:ids]}))
+              .to_return(successful_response)
+        end
+
+        it "should #{object[:method]} torrent #{args[:text]}" do
+          torrent = Transmission::Model::Torrent.find args[:ids], connector: rpc
+          torrent.send object[:method].to_sym
+        end
       end
     end
   end

data/transmission-rpc-ruby.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'transmission-rpc-ruby'
-  s.version     = '0.2.1'
-  s.date        = '2015-03-27'
+  s.version     = '0.3.0'
+  s.date        = '2015-04-02'
   s.summary     = "Transmission RPC wrapper in Ruby"
   s.description = "A new transmission RPC wrapper for Ruby. All object oriented for controlling remote transmission daemons."
   s.authors     = ["Max Hoffmann"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rpc-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Hoffmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE