transmission-rpc-ruby-ext 0.1.0

data/spec/transmission/rpc/connector_spec.rb

@@ -0,0 +1,82 @@
+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'}}))
+        stub_rpc_request
+            .with(headers: {'x-transmission-session-id' => 'abc'})
+            .to_return(successful_response)
+      end
+
+      it 'should save the transmission session ID' do
+        @connector.post
+        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,33 @@
+describe Transmission::RPC do
+  describe '#get_session' do
+    describe 'with fields' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        fields = Transmission::Fields::SessionGet.new(['version']).to_fields
+        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 ['version']
+        expect(@rpc.connector.response.status).to eq(200)
+      end
+    end
+
+    describe 'without fields' do
+      before :each do
+        @rpc = Transmission::RPC.new
+        fields = Transmission::Fields::SessionGet.new.to_fields
+        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/spec/transmission/utils_spec.rb

@@ -0,0 +1,69 @@
+describe Transmission::Utils do
+  let(:utils) {
+    Class.new do
+      include Transmission::Utils
+    end
+  }
+
+  subject { utils.new }
+
+  describe '.is_valid_key?' do
+    describe 'with dashes' do
+      let(:arguments) {[{field: 'test-me'}]}
+
+      it 'should find valid key' do
+        expect(subject.is_valid_key?('test_me', arguments)).to eq(true)
+      end
+    end
+
+    describe 'with camelcase' do
+      let(:arguments) {[{field: 'testMe'}]}
+
+      it 'should find valid key' do
+        expect(subject.is_valid_key?('test_me', arguments)).to eq(true)
+      end
+    end
+
+    describe 'with invalid key' do
+      let(:arguments) {[{field: 'testMe'}]}
+
+      it 'should not find any key' do
+        expect(subject.is_valid_key?('i_dont_exit', arguments)).to eq(false)
+      end
+    end
+  end
+
+  describe '.option_keys' do
+    it 'should return the right option keys' do
+      options = subject.option_keys('test_me')
+      expect(options.include?('testMe')).to eq(true)
+      expect(options.include?('test-me')).to eq(true)
+    end
+  end
+
+  describe '.option_key' do
+    describe 'with dashes' do
+      let(:arguments) {[{field: 'test-me'}]}
+
+      it 'should return the correct key' do
+        expect(subject.option_key('test_me', arguments)).to eq('test-me')
+      end
+    end
+
+    describe 'with camelcase' do
+      let(:arguments) {[{field: 'testMe'}]}
+
+      it 'should return the correct key' do
+        expect(subject.option_key('test_me', arguments)).to eq('testMe')
+      end
+    end
+
+    describe 'with invalid key' do
+      let(:arguments) {[{field: 'testMe'}]}
+
+      it 'should return nil' do
+        expect(subject.option_key('i_dont_exit', arguments)).to eq(nil)
+      end
+    end
+  end
+end

data/transmission-rpc-ruby-ext.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'transmission-rpc-ruby-ext'
+  s.version     = '0.1.0'
+  s.date        = '2016-12-28'
+  s.summary     = 'Extended version of transmission-rpc-ruby.'
+  s.description = 'A fork of transmission-rpc-ruby with some shortcut methods added.'
+  s.authors     = ['Tommaso Barbato']
+  s.email       = 'epistrephein@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/epistrephein/transmission-rpc-ruby-ext'
+  s.license     = 'MIT'
+  s.require_paths = ['lib']
+  s.add_dependency 'faraday', '~> 0.10'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'webmock', '~> 2.3'
+  s.add_development_dependency 'rake', '~> 12.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: transmission-rpc-ruby-ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tommaso Barbato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: A fork of transmission-rpc-ruby with some shortcut methods added.
+email: epistrephein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/transmission.rb
+- lib/transmission/arguments.rb
+- lib/transmission/arguments/location_set.rb
+- lib/transmission/arguments/session_set.rb
+- lib/transmission/arguments/torrent_add.rb
+- lib/transmission/arguments/torrent_set.rb
+- lib/transmission/config.rb
+- lib/transmission/extensions.rb
+- lib/transmission/extensions/torrent_actions.rb
+- lib/transmission/extensions/torrent_attributes.rb
+- lib/transmission/extensions/torrent_status.rb
+- lib/transmission/extensions/transmission.rb
+- lib/transmission/fields.rb
+- lib/transmission/fields/session_get.rb
+- lib/transmission/fields/session_stats.rb
+- lib/transmission/fields/torrent_get.rb
+- lib/transmission/model.rb
+- lib/transmission/model/session.rb
+- lib/transmission/model/session_stats.rb
+- lib/transmission/model/torrent.rb
+- lib/transmission/rpc.rb
+- lib/transmission/rpc/connector.rb
+- lib/transmission/utils.rb
+- spec/helpers/stubs.rb
+- spec/spec_helper.rb
+- spec/transmission/arguments_spec.rb
+- spec/transmission/fields_spec.rb
+- spec/transmission/model/session_spec.rb
+- spec/transmission/model/torrent_spec.rb
+- spec/transmission/rpc/connector_spec.rb
+- spec/transmission/rpc_spec.rb
+- spec/transmission/utils_spec.rb
+- transmission-rpc-ruby-ext.gemspec
+homepage: https://github.com/epistrephein/transmission-rpc-ruby-ext
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Extended version of transmission-rpc-ruby.
+test_files: []