transmission-rpc-ruby 0.1.0 → 0.2.0

data/lib/transmission/rpc.rb

@@ -9,19 +9,15 @@ module Transmission
       @connector = Connector.new options
     end
 
-    def get_session(options = {})
-      fields = Transmission::Arguments::SessionGet.new(options[:fields])
-      arguments = {fields: fields.to_arguments}
+    def get_session(fields = nil)
+      fields = Transmission::Fields::SessionGet.new(fields)
+      arguments = {fields: fields.to_fields}
       @connector.post method: 'session-get', arguments: arguments
     end
 
-    def set_session(arguments)
-      @connector.post method: 'session-set', arguments: arguments
-    end
-
-    def get_session_stats(options = {})
-      fields = Transmission::Arguments::SessionStats.new(options[:fields])
-      arguments = {fields: fields.to_arguments}
+    def get_session_stats(fields = nil)
+      fields = Transmission::Fields::SessionStats.new(fields)
+      arguments = {fields: fields.to_fields}
       @connector.post method: 'session-stats', arguments: arguments
     end
 
@@ -37,71 +33,79 @@ module Transmission
       @connector.post method: 'blocklist-update'
     end
 
-    def get_torrent(ids = nil, options = {})
-      fields = Transmission::Arguments::TorrentGet.new(options[:fields])
-      arguments = {fields: fields.to_arguments}
-      arguments[:ids] = ids if ids.is_a?(Array)
-      @connector.post method: 'torrent-get', arguments: arguments
+    def free_space
+      @connector.post method: 'free-space'
     end
 
-    def set_torrent
-      @connector.post method: 'torrent-set'
+    def get_torrent(ids, fields = nil)
+      fields = Transmission::Fields::TorrentGet.new(fields)
+      arguments = {fields: fields.to_fields}
+      arguments[:ids] = ids if ids.is_a? Array
+      @connector.post method: 'torrent-get', arguments: arguments
     end
 
-    def add_torrent(arguments = {})
-      @connector.post method: 'torrent-add', arguments: arguments
+    def set_torrent(ids, arguments)
+      arguments[:ids] = ids
+      arguments = Transmission::Arguments::TorrentSet.new(arguments)
+      @connector.post method: 'torrent-set', arguments: arguments.to_arguments
     end
 
-    def remove_torrent(ids, delete_local_data = false)
-      @connector.post method: 'torrent-remove', arguments: {ids: ids, 'delete-local-data' => delete_local_data}
+    def set_session(arguments)
+      arguments = Transmission::Arguments::SessionSet.new(arguments)
+      @connector.post method: 'session-set', arguments: arguments.to_arguments
     end
 
-    def free_space
-      @connector.post method: 'free-space'
+    def add_torrent(arguments)
+      arguments = Transmission::Arguments::TorrentAdd.new(arguments)
+      @connector.post method: 'torrent-add', arguments: arguments.to_arguments
     end
 
-    def start_torrent
-
+    def remove_torrent(ids, delete_local_data = false)
+      @connector.post method: 'torrent-remove', arguments: {ids: ids, 'delete-local-data' => delete_local_data}
     end
 
-    def start_torrent_now
-
+    def start_torrent(ids)
+      @connector.post method: 'torrent-start', arguments: id_arguments(ids)
     end
 
-    def stop_torrent
-
+    def start_torrent_now(ids)
+      @connector.post method: 'torrent-start-now', arguments: id_arguments(ids)
     end
 
-    def verify_torrent
-
+    def stop_torrent(ids)
+      @connector.post method: 'torrent-stop', arguments: id_arguments(ids)
     end
 
-    def re_announce
-
+    def verify_torrent(ids)
+      @connector.post method: 'torrent-verify', arguments: id_arguments(ids)
     end
 
-    def set_torrent_location
-
+    def re_announce_torrent(ids)
+      @connector.post method: 'torrent-reannounce', arguments: id_arguments(ids)
     end
 
-    def rename_torrent_path
-
+    def move_up_torrent(ids)
+      @connector.post method: 'queue-move-up', arguments: id_arguments(ids)
     end
 
-    def move_up_torrent
-
+    def move_down_torrent(ids)
+      @connector.post method: 'queue-move-down', arguments: id_arguments(ids)
     end
 
-    def move_down_torrent
-
+    def move_top_torrent(ids)
+      @connector.post method: 'queue-move-top', arguments: id_arguments(ids)
     end
 
-    def move_top_torrent
-
+    def move_bottom_torrent(ids)
+      @connector.post method: 'queue-move-bottom', arguments: id_arguments(ids)
     end
 
-    def move_bottom_torrent
+    private
 
+    def id_arguments(ids)
+      arguments = {}
+      arguments[:ids] = ids if ids.is_a? Array
+      arguments
     end
 
   end

data/lib/transmission/rpc/connector.rb

@@ -6,7 +6,6 @@ module Transmission
     class Connector
       class AuthError < StandardError; end
       class ConnectionError < StandardError; end
-      class InvalidSessionError < StandardError; end
 
       attr_accessor :host, :port, :ssl, :credentials, :path, :session_id, :response
 
@@ -26,7 +25,7 @@ module Transmission
           req.headers['Content-Type'] = 'application/json'
           req.body = JSON.generate(params)
         end
-        handle_response response
+        handle_response response, params
       end
 
       private
@@ -37,11 +36,11 @@ module Transmission
         {}
       end
 
-      def handle_response(response)
+      def handle_response(response, params)
         @response = response
         if response.status == 409
           @session_id = response.headers['x-transmission-session-id']
-          raise InvalidSessionError
+          return self.post(params)
         end
         body = json_body response
         raise AuthError if response.status == 401

data/lib/transmission/utils.rb

@@ -0,0 +1,28 @@
+module Transmission
+  module Utils
+    def is_valid_key?(key, attributes)
+      !attributes.select do |attribute|
+        option_keys(key).include? attribute[:field]
+      end.empty?
+    end
+
+    def option_keys(key)
+      split = key.to_s.split '_'
+      dashed = split.join '-'
+      camelcase = split.collect{|p| p.capitalize}.join
+      camelcase = camelcase[0].downcase + camelcase[1..-1]
+      [dashed, camelcase]
+    end
+
+    def option_key(key, attributes)
+      selected = attributes.select do |attribute|
+        option_keys(key).include? attribute[:field]
+      end
+      if selected.size > 0
+        selected.first[:field]
+      else
+        nil
+      end
+    end
+  end
+end

data/spec/helpers/stubs.rb

@@ -14,8 +14,14 @@ module Stubs
         .to_return(successful_response({arguments: {torrents: torrents}}))
   end
 
+  def stub_get_session(fields)
+    stub_rpc_request
+        .with(body: session_get_body({fields: fields}))
+        .to_return(successful_response)
+  end
+
   def torrent_get_body(arguments = {})
-    args = {fields: Transmission::Arguments::TorrentGet.new.to_arguments}.merge(arguments)
+    args = {fields: Transmission::Fields::TorrentGet.new.to_fields}.merge(arguments)
     {method: 'torrent-get', arguments: args}.to_json
   end
 
@@ -27,6 +33,14 @@ module Stubs
     {method: 'torrent-remove', arguments: arguments}.to_json
   end
 
+  def torrent_set_body(arguments = {})
+    {method: 'torrent-set', arguments: arguments}.to_json
+  end
+
+  def torrent_method_body(method, arguments)
+    {method: method, arguments: arguments}.to_json
+  end
+
   def session_get_body(arguments = {})
     {method: 'session-get', arguments: arguments}.to_json
   end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'webmock/rspec'
+require 'coveralls'
+Coveralls.wear!
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'transmission')
 require File.join(File.dirname(__FILE__), 'helpers', 'stubs')

data/spec/transmission/arguments_spec.rb

@@ -1,12 +1,9 @@
 describe Transmission::Arguments do
 
   [
-      {className: Transmission::Arguments::SessionGet, arguments: ['alt-speed-down']},
-      {className: Transmission::Arguments::SessionSet, arguments: ['alt-speed-down']},
-      {className: Transmission::Arguments::SessionStats, arguments: ['activeTorrentCount']},
-      {className: Transmission::Arguments::TorrentAdd, arguments: ['cookies']},
-      {className: Transmission::Arguments::TorrentGet, arguments: ['id']},
-      {className: Transmission::Arguments::TorrentSet, arguments: ['bandwidthPriority']}
+      {className: Transmission::Arguments::SessionSet, arguments: {'alt-speed-down' => 5}},
+      {className: Transmission::Arguments::TorrentAdd, arguments: {'paused' => true}},
+      {className: Transmission::Arguments::TorrentSet, arguments: {'location' => '/location'}}
   ].each do |klass|
 
     describe "#{klass[:className]}" do
@@ -23,7 +20,7 @@ describe Transmission::Arguments do
 
         it 'should raise an error if invalid arguments is given' do
           expect {
-            klass[:className].new ['i-dont-exist']
+            klass[:className].new 'i-dont-exist' => ''
           }.to raise_error(Transmission::Arguments::InvalidArgument)
         end
       end
@@ -31,4 +28,54 @@ describe Transmission::Arguments do
 
   end
 
+  describe '.is_valid?' do
+    describe 'with valid key' do
+      it 'should return true' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Arguments.is_valid?('test_me')).to eq(true)
+      end
+    end
+
+    describe 'with invalid key' do
+      it 'should return true' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Arguments.is_valid?('testMee')).to eq(false)
+      end
+    end
+  end
+
+  describe '.real_key' do
+    describe 'with valid key' do
+      it 'should return real key' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Arguments.real_key('test_me')).to eq('test-me')
+      end
+    end
+
+    describe 'with invalid key' do
+      it 'should return nil' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Arguments.real_key('testMee')).to eq(nil)
+      end
+    end
+  end
+
+  describe '.filter' do
+    describe 'with valid keys' do
+      it 'should filter the correct keys' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        hash = {'test-me' => 'some-value'}
+        expect(Transmission::Arguments.filter(hash)).to eq(hash)
+      end
+    end
+
+    describe 'with invalid keys' do
+      it 'should filter out the incorrect keys' do
+        stub_const("Transmission::Arguments::ATTRIBUTES", [{field: 'test-me'}])
+        hash = {'test-me' => 'some-value', 'incorrect-key' => 'some-value'}
+        expect(Transmission::Arguments.filter(hash)).to eq({'test-me' => 'some-value'})
+      end
+    end
+  end
+
 end

data/spec/transmission/fields_spec.rb

@@ -0,0 +1,63 @@
+describe Transmission::Fields do
+
+  [
+      {className: Transmission::Fields::SessionGet, fields: ['alt-speed-down']},
+      {className: Transmission::Fields::TorrentGet, fields: ['doneDate']},
+      {className: Transmission::Fields::SessionStats, fields: ['activeTorrentCount']}
+  ].each do |klass|
+
+    describe "#{klass[:className]}" do
+      describe '#new' do
+        it 'should create an instance with correct fields' do
+          instance = klass[:className].new
+          expect(instance.fields.size).to eq(klass[:className]::ATTRIBUTES.size)
+        end
+
+        it 'should create an instance with given fields' do
+          instance = klass[:className].new klass[:fields]
+          expect(instance.fields.size).to eq(1)
+        end
+
+        it 'should raise an error if invalid arguments is given' do
+          expect {
+            klass[:className].new 'i-dont-exist' => ''
+          }.to raise_error(Transmission::Fields::InvalidField)
+        end
+      end
+    end
+
+  end
+
+  describe '.is_valid?' do
+    describe 'with valid key' do
+      it 'should return true' do
+        stub_const("Transmission::Fields::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Fields.is_valid?('test_me')).to eq(true)
+      end
+    end
+
+    describe 'with invalid key' do
+      it 'should return true' do
+        stub_const("Transmission::Fields::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Fields.is_valid?('testMee')).to eq(false)
+      end
+    end
+  end
+
+  describe '.real_key' do
+    describe 'with valid key' do
+      it 'should return real key' do
+        stub_const("Transmission::Fields::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Fields.real_key('test_me')).to eq('test-me')
+      end
+    end
+
+    describe 'with invalid key' do
+      it 'should return nil' do
+        stub_const("Transmission::Fields::ATTRIBUTES", [{field: 'test-me'}])
+        expect(Transmission::Fields.real_key('testMee')).to eq(nil)
+      end
+    end
+  end
+
+end

data/spec/transmission/model/session_spec.rb

@@ -0,0 +1,84 @@
+describe Transmission::Model::Session do
+
+  describe '.get' do
+
+    describe 'with configuration' do
+      before :each do
+        Transmission::Config.set
+        stub_get_session(Transmission::Fields::SessionGet.new.to_fields)
+      end
+
+      it 'should return a session model' do
+        session = Transmission::Model::Session.get
+        expect(session).to be_a(Transmission::Model::Session)
+      end
+    end
+
+    describe 'with connector' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_session(Transmission::Fields::SessionGet.new.to_fields)
+      end
+
+      it 'should return an array of Torrent models' do
+        session = Transmission::Model::Session.get connector: @rpc
+        expect(session).to be_a(Transmission::Model::Session)
+      end
+    end
+  end
+
+  describe '#save!' do
+    let(:rpc) {Transmission::RPC.new}
+
+    before :each do
+      stub_const("Transmission::Arguments::SessionSet::ATTRIBUTES", [{field: 'name'}])
+      stub_get_session(Transmission::Fields::SessionGet.new.to_fields)
+      stub_rpc_request
+          .with(body: session_set_body({name: 'new value'}))
+          .to_return(successful_response)
+    end
+
+    it 'should send the right parameters' do
+      session = Transmission::Model::Session.get connector: rpc
+      session.name = 'new value'
+      session.save!
+    end
+  end
+
+  describe '#method_missing' do
+    let(:session) { Transmission::Model::Session.new({'id' => 1, 'name' => 'some name', 'some-key' => 'some-value'}, nil) }
+
+    before :each do
+      stub_const("Transmission::Fields::SessionGet::ATTRIBUTES", [{field: 'id'}, {field: 'name'}, {field: 'some-key'}])
+      stub_const("Transmission::Arguments::SessionSet::ATTRIBUTES", [{field: 'name'}])
+    end
+
+    describe 'with existing attributes' do
+      it 'should return the correct values' do
+        expect(session.id).to eq(1)
+        expect(session.name).to eq('some name')
+        expect(session.some_key).to eq('some-value')
+      end
+
+      it 'should set the correct values' do
+        session.name = 'ok'
+        expect(session.name).to eq('ok')
+      end
+    end
+
+    describe 'with none existing attributes' do
+      it 'should raise error' do
+        expect {
+          session.i_dont_exist
+        }.to raise_error(NoMethodError)
+      end
+
+      it 'should raise error' do
+        expect {
+          session.i_dont_exist = 'some value'
+        }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+end