transmission-rpc-ruby 0.1.0

data/spec/transmission/arguments_spec.rb

@@ -0,0 +1,34 @@
+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']}
+  ].each do |klass|
+
+    describe "#{klass[:className]}" do
+      describe '#new' do
+        it 'should create an instance with correct arguments' do
+          instance = klass[:className].new
+          expect(instance.arguments.size).to eq(klass[:className]::ATTRIBUTES.size)
+        end
+
+        it 'should create an instance with given arguments' do
+          instance = klass[:className].new klass[:arguments]
+          expect(instance.arguments.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::Arguments::InvalidArgument)
+        end
+      end
+    end
+
+  end
+
+end

data/spec/transmission/model/torrent_spec.rb

@@ -0,0 +1,146 @@
+describe Transmission::Model::Torrent do
+
+  describe '.all' do
+
+    describe 'with configuration' do
+      before :each do
+        Transmission::Config.set
+        stub_get_torrent({}, [{id: 1}])
+      end
+
+      it 'should return an array of Torrent models' do
+        torrents = Transmission::Model::Torrent.all
+        expect(torrents).to be_an(Array)
+        expect(torrents.first).to be_a(Transmission::Model::Torrent)
+      end
+    end
+
+    describe 'with connector' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_rpc_request
+            .with(body: torrent_get_body)
+            .to_return(successful_response({arguments: {torrents: [{id: 1}]}}))
+      end
+
+      it 'should return an array of Torrent models' do
+        torrents = Transmission::Model::Torrent.all connector: @rpc
+        expect(torrents).to be_an(Array)
+        expect(torrents.first).to be_a(Transmission::Model::Torrent)
+      end
+    end
+
+  end
+
+  describe '.find' do
+
+    describe 'with configuration' do
+      before :each do
+        Transmission::Config.set
+        stub_get_torrent({ids: [1]}, [{id: 1}])
+      end
+
+      it 'should return a Torrent instance' do
+        torrent = Transmission::Model::Torrent.find 1
+        expect(torrent).to be_a(Transmission::Model::Torrent)
+      end
+    end
+
+    describe 'with connector' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_torrent({ids: [1]}, [{id: 1}])
+      end
+
+      it 'should return a Torrent instance' do
+        torrent = Transmission::Model::Torrent.find 1, connector: @rpc
+        expect(torrent).to be_a(Transmission::Model::Torrent)
+      end
+    end
+
+    describe 'with invalid id' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_torrent({ids: [1]}, [])
+      end
+
+      it 'should raise error' do
+        expect {
+          Transmission::Model::Torrent.find 1, connector: @rpc
+        }.to raise_error(Transmission::Model::Torrent::TorrentNotFoundError)
+      end
+    end
+
+  end
+
+  describe '.add' do
+
+    describe 'with configuration' do
+      before :each do
+        Transmission::Config.set
+        stub_rpc_request
+            .with(body: torrent_add_body({filename: 'torrent_file'}))
+            .to_return(successful_response({arguments: {'torrent-added' => {id: 1}}}))
+        stub_get_torrent({ids: [1]}, [{id: 1}])
+      end
+
+      it 'should return a Torrent instance' do
+        torrent = Transmission::Model::Torrent.add arguments: {filename: 'torrent_file'}
+        expect(torrent).to be_a(Transmission::Model::Torrent)
+      end
+    end
+
+    describe 'when torrent is a duplicate' do
+      before :each do
+        Transmission::Config.set
+        stub_rpc_request
+            .with(body: torrent_add_body({filename: 'torrent_file'}))
+            .to_return(unsuccessful_response({result: 'duplicate torrent'}))
+      end
+
+      it 'should raise error' do
+        expect {
+          Transmission::Model::Torrent.add arguments: {filename: 'torrent_file'}
+        }.to raise_error(Transmission::RPC::Connector::ConnectionError)
+      end
+    end
+
+  end
+
+  describe '#delete!' do
+
+    describe 'with configuration' do
+      before :each do
+        Transmission::Config.set
+        stub_get_torrent({ids: [1]}, [{id: 1}])
+        stub_rpc_request
+            .with(body: torrent_remove_body({:ids => [1], 'delete-local-data' => false}))
+            .to_return(successful_response({arguments: {torrents: [{id: 1}]}}))
+      end
+
+      it 'should remove the torrent file' do
+        torrent = Transmission::Model::Torrent.find 1
+        torrent.delete!
+        expect(torrent.deleted).to eq(true)
+      end
+    end
+
+    describe 'with connector' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        stub_get_torrent({ids: [1]}, [{id: 1}])
+        stub_rpc_request
+            .with(body: torrent_remove_body({:ids => [1], 'delete-local-data' => false}))
+            .to_return(successful_response({arguments: {torrents: [{id: 1}]}}))
+      end
+
+      it 'should remove the torrent file' do
+        torrent = Transmission::Model::Torrent.find 1, :connector => @rpc
+        torrent.delete!
+        expect(torrent.deleted).to eq(true)
+      end
+    end
+
+  end
+
+end

data/spec/transmission/rpc/connector_spec.rb

@@ -0,0 +1,81 @@
+describe Transmission::RPC::Connector do
+
+  describe '#new' do
+
+    describe 'without parameters' do
+      before :each do
+        @connector = Transmission::RPC::Connector.new
+      end
+
+      it 'should create an RPC object with default values' do
+        expect(@connector.host).to eq('localhost')
+        expect(@connector.port).to eq(9091)
+        expect(@connector.ssl).to eq(false)
+        expect(@connector.path).to eq('/transmission/rpc')
+        expect(@connector.credentials).to eq(nil)
+      end
+    end
+
+    describe 'with parameters' do
+      before :each do
+        @connector = Transmission::RPC::Connector.new host: 'some.host', port: 8888, ssl: true, path: '/path', credentials: {username: 'a', password: 'b'}
+      end
+
+      it 'should create an RPC object with given parameters' do
+        expect(@connector.host).to eq('some.host')
+        expect(@connector.port).to eq(8888)
+        expect(@connector.ssl).to eq(true)
+        expect(@connector.path).to eq('/path')
+        expect(@connector.credentials).to eq({username: 'a', password: 'b'})
+      end
+    end
+
+  end
+
+  describe '#post' do
+
+    describe 'when session ID has not been acquired yet' do
+      before :each do
+        @connector = Transmission::RPC::Connector.new
+        stub_rpc_request
+            .to_return(conflict_response({headers: {'x-transmission-session-id' => 'abc'}}))
+      end
+
+      it 'should save the transmission session ID' do
+        expect {
+          @connector.post
+        }.to raise_error(Transmission::RPC::Connector::InvalidSessionError)
+        expect(@connector.session_id).to eq('abc')
+      end
+    end
+
+    describe 'when session ID has been acquired' do
+      before :each do
+        @connector = Transmission::RPC::Connector.new
+        stub_rpc_request
+            .to_return(successful_response)
+      end
+
+      it 'should respond successfully' do
+        @connector.post
+        expect(@connector.response.status).to eq(200)
+      end
+    end
+
+    describe 'when basic auth is required but no credentials provided' do
+      before :each do
+        @connector = Transmission::RPC::Connector.new
+        stub_rpc_request
+            .to_return(unauthorized_response)
+      end
+
+      it 'should raise auth error' do
+        expect {
+          @connector.post
+        }.to raise_error(Transmission::RPC::Connector::AuthError)
+      end
+    end
+
+  end
+
+end

data/spec/transmission/rpc_spec.rb

@@ -0,0 +1,41 @@
+describe Transmission::RPC do
+
+  describe '#get_session' do
+
+    describe 'with fields' do
+
+      before :each do
+        @rpc = Transmission::RPC.new
+        fields = Transmission::Arguments::SessionGet.new(['version']).to_arguments
+        stub_rpc_request
+            .with({body: session_get_body({fields: fields})})
+            .to_return(successful_response)
+      end
+
+      it 'should send the proper arguments' do
+        @rpc.get_session fields: ['version']
+        expect(@rpc.connector.response.status).to eq(200)
+      end
+
+    end
+
+    describe 'without fields' do
+
+      before :each do
+        @rpc = Transmission::RPC.new
+        fields = Transmission::Arguments::SessionGet.new.to_arguments
+        stub_rpc_request
+            .with({body: session_get_body({fields: fields})})
+            .to_return(successful_response)
+      end
+
+      it 'should send the proper arguments' do
+        @rpc.get_session
+        expect(@rpc.connector.response.status).to eq(200)
+      end
+
+    end
+
+  end
+
+end

data/transmission-rpc-ruby.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'transmission-rpc-ruby'
+  s.version     = '0.1.0'
+  s.date        = '2015-03-27'
+  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"]
+  s.email       = 'tsov@me.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/transmission-rails/transmission-rpc-ruby'
+  s.license     = 'MIT'
+  s.require_paths = ["lib"]
+  s.add_dependency "faraday", "~> 0.9"
+  s.add_development_dependency "rake", "~> 10.4"
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_development_dependency "webmock", "~> 1.20"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: transmission-rpc-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Hoffmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: A new transmission RPC wrapper for Ruby. All object oriented for controlling
+  remote transmission daemons.
+email: tsov@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/transmission.rb
+- lib/transmission/arguments.rb
+- lib/transmission/arguments/session_get.rb
+- lib/transmission/arguments/session_set.rb
+- lib/transmission/arguments/session_stats.rb
+- lib/transmission/arguments/torrent_add.rb
+- lib/transmission/arguments/torrent_get.rb
+- lib/transmission/arguments/torrent_set.rb
+- lib/transmission/config.rb
+- lib/transmission/model.rb
+- lib/transmission/model/session.rb
+- lib/transmission/model/torrent.rb
+- lib/transmission/rpc.rb
+- lib/transmission/rpc/connector.rb
+- spec/helpers/stubs.rb
+- spec/spec_helper.rb
+- spec/transmission/arguments_spec.rb
+- spec/transmission/model/torrent_spec.rb
+- spec/transmission/rpc/connector_spec.rb
+- spec/transmission/rpc_spec.rb
+- transmission-rpc-ruby.gemspec
+homepage: https://github.com/transmission-rails/transmission-rpc-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Transmission RPC wrapper in Ruby
+test_files: []