transmissionr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a773a770f20da65adea95c7e77eaa21f230d98b
+  data.tar.gz: 41fc6ec9b4b1b5f9311148f0c4c6187630023548
+SHA512:
+  metadata.gz: 4f2d0c84b7d867807a9f3a511bf9675c33ca7608e7ce70ca71328d2b2242be3e9691126d8022768bc7caaf087bd6fac4419bddb6fdf20bef0dac63b5985cb24b
+  data.tar.gz: b58ef30bbba8520a23ac7e12b14842ad733af209ff478f265c4465879dc7b0f27344c96e862c51ce8742982996750b371e5158abdd07b04e02cbb9efe591b696

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Lanford
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Transmissionr
+
+Ruby client for Transmission RPC
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transmissionr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transmissionr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/transmissionr.rb

@@ -0,0 +1,20 @@
+require "httparty"
+require "json"
+require "mash"
+
+require "transmissionr/version"
+require "transmissionr/client"
+
+require "transmissionr/base_method"
+require "transmissionr/torrent_get"
+require "transmissionr/torrent_set"
+require "transmissionr/torrent_add"
+require "transmissionr/torrent_remove"
+require "transmissionr/torrent_stop"
+require "transmissionr/torrent_start"
+require "transmissionr/torrent_start_now"
+require "transmissionr/torrent_verify"
+require "transmissionr/torrent_reannounce"
+
+module Transmissionr
+end

data/lib/transmissionr/base_method.rb

@@ -0,0 +1,21 @@
+module Transmission
+  class BaseMethod
+    def initialize( client )
+      @client = client
+    end
+
+    def request
+      request = {
+          method: @method,
+          arguments: @arguments
+      }
+      response = @client.class.post(@client.base_uri, basic_auth: @client.auth, headers: @client.headers, body: request.to_json )
+      if response.code == 409
+        @client.headers["x-transmission-session-id"] = response.headers["x-transmission-session-id"]
+        response = @client.class.post(@client.base_uri, basic_auth: @client.auth, headers: @client.headers, body: request.to_json )
+      end
+      raise ResponseError.new(response) if response.code != 200
+      Mash.new(response)
+    end
+  end
+end

data/lib/transmissionr/client.rb

@@ -0,0 +1,53 @@
+module Transmission
+  class Client
+    include HTTParty
+
+    attr_reader :base_uri, :auth, :headers
+
+    def initialize( host = "localhost", port = 9091, username = nil, password = nil )
+      @base_uri = "http://#{host}:#{port}/transmission/rpc"
+      @auth = { username: username, password: password }
+      @headers = { "x-transmission-session-id" => "" }
+    end
+
+    def session_id
+      @headers["x-transmission-session-id"]
+    end
+
+    def torrent_start( ids = nil )
+      TorrentStart.new( self, ids ).request
+    end
+
+    def torrent_start_now( ids = nil )
+      TorrentStartNow.new( self, ids ).request
+    end
+
+    def torrent_stop( ids = nil )
+      TorrentStop.new( self, ids ).request
+    end
+
+    def torrent_verify( ids = nil )
+      TorrentVerify.new( self, ids ).request
+    end
+
+    def torrent_reannounce( ids = nil )
+      TorrentReannounce.new( self, ids ).request
+    end
+
+    def torrent_set( arguments = {}, ids = nil )
+      TorrentSet.new( self, arguments, ids  ).request
+    end
+
+    def torrent_get( fields = nil, ids = nil )
+      TorrentGet.new( self, fields, ids ).request
+    end
+
+    def torrent_add( arguments = {} )
+      TorrentAdd.new( self, arguments ).request
+    end
+
+    def torrent_remove( delete = false, ids = nil )
+      TorrentRemove.new( self, delete, ids ).request
+    end
+  end
+end

data/lib/transmissionr/torrent_add.rb

@@ -0,0 +1,9 @@
+module Transmission
+  class TorrentAdd < BaseMethod
+    def initialize( client, arguments )
+      super(client)
+      @method = 'torrent-add'
+      @arguments = arguments
+    end
+  end
+end

data/lib/transmissionr/torrent_get.rb

@@ -0,0 +1,83 @@
+module Transmission
+  class TorrentGet < BaseMethod
+    def initialize( client, fields = nil, ids = nil )
+      super(client)
+      @method = 'torrent-get'
+      @arguments = {}
+
+      @arguments["fields"] = fields ? fields : @@fields
+      @arguments["ids"] = ids if ids != nil
+    end
+
+    @@fields = %w(
+      activityDate
+      addedDate
+      bandwidthPriority
+      comment
+      corruptEver
+      creator
+      dateCreated
+      desiredAvailable
+      doneDate
+      downloadDir
+      downloadedEver
+      downloadLimit
+      downloadLimited
+      error
+      errorString
+      eta
+      etaIdle
+      files
+      fileStats
+      hashString
+      haveUnchecked
+      haveValid
+      honorsSessionLimits
+      id
+      isFinished
+      isPrivate
+      isStalled
+      leftUntilDone
+      magnetLink
+      manualAnnounceTime
+      maxConnectedPeers
+      metadataPercentComplete
+      name
+      peer-limit
+      peers
+      peersConnected
+      peersFrom
+      peersGettingFromUs
+      peersSendingToUs
+      percentDone
+      pieces
+      pieceCount
+      pieceSize
+      priorities
+      queuePosition
+      rateDownload
+      rateUpload
+      recheckProgress
+      secondsDownloading
+      secondsSeeding
+      seedIdleLimit
+      seedIdleMode
+      seedRatioLimit
+      seedRatioMode
+      sizeWhenDone
+      startDate
+      status
+      trackers
+      trackerStats
+      totalSize
+      torrentFile
+      uploadedEver
+      uploadLimit
+      uploadLimited
+      uploadRatio
+      wanted
+      webseeds
+      webseedsSendingToUs
+    )
+  end
+end

data/lib/transmissionr/torrent_reannounce.rb

@@ -0,0 +1,10 @@
+module Transmission
+  class TorrentReannounce < BaseMethod
+    def initialize( client, ids = nil )
+      super(client)
+      @method = 'torrent-reannounce'
+      @arguments = {}
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_remove.rb

@@ -0,0 +1,12 @@
+module Transmission
+  class TorrentRemove < BaseMethod
+    def initialize( client, delete = false, ids = nil )
+      super(client)
+      @method = 'torrent-remove'
+      @arguments = {
+        "delete-local-data" => delete
+      }
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_set.rb

@@ -0,0 +1,11 @@
+module Transmission
+  class TorrentSet < BaseMethod
+    def initialize( client, arguments = {}, ids = nil )
+      super(client)
+      @method = 'torrent-set'
+      @arguments = arguments
+
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_start.rb

@@ -0,0 +1,10 @@
+module Transmission
+  class TorrentStart < BaseMethod
+    def initialize( client, ids = nil )
+      super(client)
+      @method = 'torrent-start'
+      @arguments = {}
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_start_now.rb

@@ -0,0 +1,10 @@
+module Transmission
+  class TorrentStartNow < BaseMethod
+    def initialize( client, ids = nil )
+      super(client)
+      @method = 'torrent-start-now'
+      @arguments = {}
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_stop.rb

@@ -0,0 +1,10 @@
+module Transmission
+  class TorrentStop < BaseMethod
+    def initialize( client, ids = nil )
+      super(client)
+      @method = 'torrent-stop'
+      @arguments = {}
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/torrent_verify.rb

@@ -0,0 +1,10 @@
+module Transmission
+  class TorrentVerify < BaseMethod
+    def initialize( client, ids = nil )
+      super(client)
+      @method = 'torrent-verify'
+      @arguments = {}
+      @arguments["ids"] = ids if ids != nil
+    end
+  end
+end

data/lib/transmissionr/version.rb

@@ -0,0 +1,3 @@
+module Transmissionr
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start do
+  root File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  add_filter "/spec/"
+end
+
+require 'transmissionr'
+
+HOST = 'torrent'
+PORT = 9091
+USERNAME = 'torrent'
+PASSWORD = 'torrent100'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'default'
+end

data/spec/transmission_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Transmission::Client do
+
+  before :all do
+    @t = Transmission::Client.new(HOST, PORT, USERNAME, PASSWORD)
+    @magnet_link = "magnet:?xt=urn:btih:F36C92A8F78A1AFF70A61A5F5BFE5E6757176133&dn=ubuntu+12+10+desktop+amd64&tr=udp%3A%2F%2Ffr33domtracker.h33t.com%3A3310%2Fannounce&tr=udp%3A%2F%2Fopen.demonii.com%3A1337"
+    @hashString = "F36C92A8F78A1AFF70A61A5F5BFE5E6757176133"
+  end
+
+  it 'should add torrent' do
+    response = @t.torrent_add( :filename => @magnet_link )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should get torrents' do
+    response = @t.torrent_get( nil, @hashString )
+    expect(response.result).to eql("success")
+    expect(response.arguments.length).to eql(1)
+  end
+
+  it 'should stop torrent' do
+    response = @t.torrent_stop( @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should start torrent not now' do
+    response = @t.torrent_start( @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should start torrent now' do
+    response = @t.torrent_start_now( @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should verify torrent' do
+    response = @t.torrent_verify( @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should reannounce torrent' do
+    response = @t.torrent_reannounce( @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should set torrent attributes' do
+    response = @t.torrent_set( { :downloadLimit => 10 }, @hashString )
+    expect(response.result).to eql("success")
+  end
+
+  it 'should remove torrent' do
+    response = @t.torrent_remove( true, @hashString )
+    expect(response.result).to eql("success")
+  end
+end

data/transmissionr.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transmissionr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transmissionr"
+  spec.version       = Transmissionr::VERSION
+  spec.authors       = ["Joe Lanford"]
+  spec.email         = ["joe.lanford@gmail.com"]
+  spec.description   = %q{Ruby client for Transmission RPC}
+  spec.summary       = %q{Ruby client for Transmission RPC}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: transmissionr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Lanford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for Transmission RPC
+email:
+- joe.lanford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transmissionr.rb
+- lib/transmissionr/base_method.rb
+- lib/transmissionr/client.rb
+- lib/transmissionr/torrent_add.rb
+- lib/transmissionr/torrent_get.rb
+- lib/transmissionr/torrent_reannounce.rb
+- lib/transmissionr/torrent_remove.rb
+- lib/transmissionr/torrent_set.rb
+- lib/transmissionr/torrent_start.rb
+- lib/transmissionr/torrent_start_now.rb
+- lib/transmissionr/torrent_stop.rb
+- lib/transmissionr/torrent_verify.rb
+- lib/transmissionr/version.rb
+- spec/spec_helper.rb
+- spec/transmission_spec.rb
+- transmissionr.gemspec
+homepage: ''
+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.1.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for Transmission RPC
+test_files:
+- spec/spec_helper.rb
+- spec/transmission_spec.rb