astrobot 0.0.5

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
+.rvmrc

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use --create 1.9.3-p286@transmission_api

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fernando Guillen
+
+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,53 @@
+# Astrobot
+
+More complex version from the * [Very simple Ruby Gem](https://github.com/dsander/transmission-client) to comunicate with the Transmission API.
+
+There are other alternatives, this one just works better for me but I recommend you to check out the others.:
+
+* [Transmission Client](https://github.com/dsander/transmission-client)
+* [Transmission Connector](https://github.com/mattissf/transmission-connector)
+
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+    gem "astrobot"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install astrobot
+
+## Usage
+
+      Astrobot.configure(
+        :username => "username",
+        :password => "password",
+        :url      => "http://127.0.0.1:9091/transmission/rpc"
+
+    torrents = Astrobot::Torrent.all
+    torrent = Astrobot::Torrent.find(id)
+    torrent = Astrobot::Torrent.create("http://torrent.com/nice_pic.torrent")
+    Astrobot::Torrent.destroy(id)
+
+## State
+
+Version experimental, currently tesing in production. <:D
+
+## Transmission Api Doc
+
+* https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt
+
+Supported Transmission Api Version: 2.40
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Added some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "."
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/astrobot.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/astrobot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jeremy Mortelette"]
+  gem.email         = ["mortelette.jeremy@gmail.com"]
+  gem.description   = "Large ruby wrapper for the Transmission RPC API base on Fernando Guillen's gem transmission_api"
+  gem.summary       = "Large ruby wrapper for the Transmission RPC API"
+  gem.homepage      = "https://github.com/fguillen/TransmissionApi"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "astrobot"
+  gem.require_paths = ["lib"]
+  gem.version       = Astrobot::Version::VERSION
+
+  gem.add_dependency "httparty", "0.9.0"
+
+  gem.add_development_dependency "mocha", "0.13.0"
+end

data/lib/astrobot.rb

@@ -0,0 +1,133 @@
+require "astrobot/version"
+require 'yaml'
+
+module Astrobot
+  # Loading classes to easier access
+  # NOTE: I like this way to handle my classes,
+  #   sexiest than using require 'my_class_file' everywhere
+  autoload :Torrent, 'astrobot/torrent'
+  autoload :Controls, 'astrobot/controls'
+  autoload :Client, 'astrobot/client'
+  autoload :Logger, 'astrobot/logger'
+
+  TORRENT_FIELDS = [
+    "id",
+    "name",
+    'status',
+    "totalSize",
+    "addedDate",
+    "isFinished",
+    "rateDownload",
+    "rateUpload",
+    "percentDone",
+    "files"
+  ]
+  
+  TORRENT_ALL_FIELDS = [
+    '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(B/s)',
+    'rateUpload(B/s)',
+    'recheckProgress',
+    'secondsDownloading',
+    'secondsSeeding',
+    'seedIdleLimit',
+    'seedIdleMode',
+    'seedRatioLimit',
+    'seedRatioMode',
+    'sizeWhenDone',
+    'startDate',
+    'status',
+    'trackers',
+    'trackerStats',
+    'totalSize',
+    'torrentFile',
+    'uploadedEver',
+    'uploadLimit',
+    'uploadLimited',
+    'uploadRatio',
+    'wanted',
+    'webseeds',
+    'webseedsSendingToUs'
+  ]
+
+  # Configuration defaults
+  @@config = {
+    url: 'http://127.0.0.1:9091/transmission/rpc',
+    fields: TORRENT_ALL_FIELDS,
+    basic_auth: { :username => '', :password => '' },
+    session_id: "NOT-INITIALIZED",
+    debug_mode: false
+  }
+
+  YAML_INITIALIZER_PATH = File.dirname(__FILE__)
+  @valid_config_keys = @@config.keys
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each {|k,v| @@config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure through yaml file
+  # for ruby scripting usage
+  def self.configure_with(yaml_file_path = nil)
+    yaml_file_path = YAML_INITIALIZER_PATH  unless yaml_file_path
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      Logger.add(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      Logger.add(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  # Access to config variables
+  def self.config
+    @@config = configure unless @@config
+    @@config
+  end
+end

data/lib/astrobot/client.rb

@@ -0,0 +1,45 @@
+require "httparty"
+require "json"
+
+module Astrobot
+  class Client
+
+    def self.build(method, opts = {})
+      Astrobot::Client.post(
+        :method => method,
+        :arguments => opts
+      )
+    end
+
+    def self.post(opts)
+      JSON::parse( http_post(opts).body )
+    end
+
+    def self.http_post(opts, try_counter = 0)
+      post_options = {
+        :body => opts.to_json,
+        :headers => { "x-transmission-session-id" => Astrobot.config[:session_id] }
+      }
+      post_options.merge!( :basic_auth => Astrobot.config[:basic_auth]) unless 
+        TransmissionApi.config[:basic_auth].nil?
+
+      Astrobot::Logger.add "url: #{Astrobot.config[:url]}"
+      Astrobot::Logger.add "post_body:"
+      Astrobot::Logger.add JSON.parse(post_options[:body]).to_yaml
+      Astrobot::Logger.add "------------------"
+
+      response = HTTParty.post(Astrobot.config[:url], post_options)
+
+      Astrobot::Logger.debug response
+
+      # retry connection 3 times if session_id incorrect
+      if( response.code == 409 and try_counter <= 3)
+        Astrobot::Logger.add "changing session_id"
+        Astrobot.configure(:session_id => response.headers["x-transmission-session-id"])
+        try_counter.next
+        response = http_post(opts, try_counter)
+      end
+      response
+    end
+  end
+end

data/lib/astrobot/controls.rb

@@ -0,0 +1,31 @@
+module Astrobot
+  class Controls
+    
+    # 3.1.  Torrent Action Requests
+    # 
+    #    Method name          | libtransmission function
+    #    ---------------------+-------------------------------------------------
+    #    "torrent-start"      | tr_torrentStart
+    #    "torrent-start-now"  | tr_torrentStartNow
+    #    "torrent-stop"       | tr_torrentStop
+    #    "torrent-verify"     | tr_torrentVerify
+    #    "torrent-reannounce" | tr_torrentManualUpdate ("ask tracker for more peers")
+    # 
+    #    Request arguments: "ids", which specifies which torrents to use.
+    #                   All torrents are used if the "ids" argument is omitted.
+    #                   "ids" should be one of the following:
+    #                   (1) an integer referring to a torrent id
+    #                   (2) a list of torrent id numbers, sha1 hash strings, or both
+    #                   (3) a string, "recently-active", for recently-active torrents
+    # 
+    #    Response arguments: none
+    def self.do(ids, action)
+      Logger.add "torrent-#{action.to_s} on #{ids}"
+      ids = [ids] unless ids.class == Array
+      ids = ids.map { |id| id.to_i }
+      opts = { :ids => ids }
+      
+      response = Astrobot::Client.build("torrent-#{action.to_s}", opts)
+    end
+  end
+end

data/lib/astrobot/logger.rb

@@ -0,0 +1,29 @@
+module Astrobot
+  class Logger
+    def self.add(message)
+      Kernel.puts "[TransmissionApi #{Time.now.strftime( "%F %T" )}] #{message}" if Astrobot.config[:debug_mode]
+    end
+
+    def self.debug(response)
+      body = nil
+      begin
+        body = JSON.parse(response.body).to_yaml
+      rescue
+        body = response.body
+      end
+
+      headers = response.headers.to_yaml
+
+      add "response.code: #{response.code}"
+      add "response.message: #{response.message}"
+
+      add "response.body:"
+      add body
+      add "-----------------"
+
+      add "response.headers:"
+      add headers
+      add "------------------"
+    end
+  end
+end

data/lib/astrobot/torrent.rb

@@ -0,0 +1,68 @@
+module Astrobot
+  class Torrent
+
+    def self.all(fields = Astrobot::TORRENT_FIELDS)
+      Logger.add "get_torrents"
+      opts = { :fields => fields }
+      response = Astrobot::Client.build("torrent-get", opts)
+
+      convert_hash_keys(response["arguments"]["torrents"])
+    end
+
+    def self.find(id, fields = Astrobot::TORRENT_FIELDS)
+      raise StandardError, "missing :id in params" unless id
+      Logger.add "get_torrent: #{id}"
+      id = [id] unless id.class == Array
+      opts = { :fields => fields, :ids => id }
+
+      response = Astrobot::Client.build("torrent-get", opts)
+      convert_hash_keys(response["arguments"]["torrents"]).first
+    end
+
+    def self.create(filename)
+      raise StandardError, "missing :filename in params" unless filename
+      Logger.add "add_torrent: #{filename}"
+      opts = {:filename => filename}
+
+      response = Astrobot::Client.build("torrent-add", opts)
+      response["arguments"]["torrent-added"]
+    end
+
+    def self.destroy(id)
+      raise StandardError, "missing :id in params" unless id
+
+      Logger.add "remove_torrent: #{id}"
+      opts = { :ids => [id], :"delete-local-data" => true }
+
+      Astrobot::Client.build("torrent-remove", opts)
+    end
+
+    private
+    def self.underscore_key(k)
+      k.to_s.underscore.to_sym
+      # Or, if you're not in Rails:
+      # to_snake_case(k.to_s).to_sym
+    end
+    def self.convert_hash_keys(value)
+      case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+          # or `value.map(&method(:convert_hash_keys))`
+        when Hash
+          Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+        else
+          value
+       end
+    end
+
+    def self.serialize_response(response)
+      result = {}
+      response.map do |key, value|
+        result[key.underscore.to_sym] = value
+      end
+      puts "Result serialized = #{result.to_yaml}"
+      result
+    end
+    
+  end
+end

data/lib/astrobot/version.rb

@@ -0,0 +1,5 @@
+module Astrobot
+  class Version
+    VERSION = "0.0.5"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "test/unit"
+require "mocha"
+require_relative "../lib/astrobot"
+
+class Test::Unit::TestCase
+  FIXTURES = File.expand_path( "#{File.dirname(__FILE__)}/fixtures" )
+
+  def read_fixture( fixture_name )
+    File.read( "#{FIXTURES}/#{fixture_name}" )
+  end
+end
+

data/test/transmission_api_test.rb

@@ -0,0 +1,146 @@
+require_relative "test_helper"
+
+class TransmissionApiTest < Test::Unit::TestCase
+  def setup
+    @astrobot = Astrobot.new( :url => "http://api.url" )
+  end
+
+  def test_post
+    @astrobot.stubs(:session_id).returns("SESSION-ID")
+    @astrobot.stubs(:url).returns("http://api.url")
+
+    opts = { :key1 => "value1", :key2 => "value2" }
+
+    opts_expected = {
+      :body => { :key1 => "value1", :key2 => "value2" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" }
+    }
+
+    response_mock =
+      stub(
+        :code => "",
+        :message => "",
+        :headers => "",
+        :body => {"key" => "value"}.to_json
+      )
+
+    HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
+
+    assert_equal "value", @astrobot.post(opts)["key"]
+  end
+
+  def test_post_with_basic_auth
+    @astrobot.stubs(:session_id).returns("SESSION-ID")
+    @astrobot.stubs(:url).returns("http://api.url")
+    @astrobot.stubs(:basic_auth).returns("user_pass")
+
+    opts = { :key1 => "value1" }
+
+    opts_expected = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" },
+      :basic_auth => "user_pass"
+    }
+
+    response_mock =
+      stub(
+        :code => "",
+        :message => "",
+        :headers => "",
+        :body => {}.to_json
+      )
+
+    HTTParty.expects(:post).with( "http://api.url", opts_expected ).returns( response_mock )
+
+    @astrobot.post(opts)
+  end
+
+  def test_post_with_409
+    @astrobot.stubs(:url).returns("http://api.url")
+    @astrobot.instance_variable_set(:@session_id, "SESSION-ID")
+
+    opts = { :key1 => "value1" }
+
+    opts_expected_1 = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "SESSION-ID" }
+    }
+
+    opts_expected_2 = {
+      :body => { :key1 => "value1" }.to_json,
+      :headers => { "x-transmission-session-id" => "NEW-SESSION-ID" }
+    }
+
+    response_mock_1 =
+      stub(
+        :code => 409,
+        :message => "",
+        :headers => { "x-transmission-session-id" => "NEW-SESSION-ID" },
+        :body => ""
+      )
+
+    response_mock_2 =
+      stub(
+        :code => 200,
+        :message => "",
+        :headers => "",
+        :body => {"key" => "value"}.to_json
+      )
+
+    post_sequence = sequence("post_sequence")
+    HTTParty.expects(:post).with( "http://api.url", opts_expected_1 ).returns( response_mock_1 ).in_sequence( post_sequence )
+    HTTParty.expects(:post).with( "http://api.url", opts_expected_2 ).returns( response_mock_2 ).in_sequence( post_sequence )
+
+    assert_equal "value", @astrobot.post(opts)["key"]
+    assert_equal "NEW-SESSION-ID", @astrobot.instance_variable_get(:@session_id)
+  end
+
+  def test_all
+    opts_expected = {
+      :method => "torrent-get",
+      :arguments => { :fields => "fields" }
+    }
+    result = { "arguments" => { "torrents" => "torrents" } }
+
+    @astrobot.stubs(:fields).returns("fields")
+    @astrobot.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrents", @astrobot.all )
+  end
+
+  def test_find
+    opts_expected = {
+      :method => "torrent-get",
+      :arguments => { :fields => "fields", :ids => [1] }
+    }
+    result = { "arguments" => { "torrents" => ["torrent1"] } }
+
+    @astrobot.stubs(:fields).returns("fields")
+    @astrobot.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrent1", @astrobot.find(1) )
+  end
+
+  def test_create
+    opts_expected = {
+      :method => "torrent-add",
+      :arguments => { :filename => "filename" }
+    }
+    result = { "arguments" => { "torrent-added" => "torrent-added" } }
+
+    @astrobot.expects(:post).with( opts_expected ).returns( result )
+
+    assert_equal( "torrent-added", @astrobot.create( "filename" ) )
+  end
+
+  def test_destroy
+    opts_expected = {
+      :method => "torrent-remove",
+      :arguments => { :ids => [1], :"delete-local-data" => true }
+    }
+
+    @astrobot.expects(:post).with( opts_expected )
+    @astrobot.destroy(1)
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: astrobot
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Mortelette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Large ruby wrapper for the Transmission RPC API base on Fernando Guillen's
+  gem transmission_api
+email:
+- mortelette.jeremy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rvmrc.example
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- astrobot.gemspec
+- lib/astrobot.rb
+- lib/astrobot/client.rb
+- lib/astrobot/controls.rb
+- lib/astrobot/logger.rb
+- lib/astrobot/torrent.rb
+- lib/astrobot/version.rb
+- test/test_helper.rb
+- test/transmission_api_test.rb
+homepage: https://github.com/fguillen/TransmissionApi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Large ruby wrapper for the Transmission RPC API
+test_files:
+- test/test_helper.rb
+- test/transmission_api_test.rb