trans-api 0.0.2 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
 SHA1:
-  metadata.gz: !binary |-
-    YTE4YzBlYmRjN2Q1ZDQwZWYwNWM0MjA4ZDE2YmE0ZjNmNmYzMGI5MQ==
-  data.tar.gz: !binary |-
-    NDZhNjBkNTZjYmYyMjM4NDU5NzJmMDBmZWQzMzMwMjYwNTNmYjExYg==
+  metadata.gz: 4750d6488dcb9805c0bbd635509b4cc2b82f664e
+  data.tar.gz: 112eebe82c5696c795c38d311047cb6bc154d396
 SHA512:
-  metadata.gz: !binary |-
-    YWJkNjJiZTdlNzE4NjgxZDc2YjE0MWQzZGI1NzY5N2EzZjY3MDhiYWNjZjlh
-    YTdjYTEwMTg5NGU2NjZkZDJjNTE4NjdkN2EzZmRiMTAzODljZTM3ZjZlNDlm
-    YjY3ZTRlMTgzNjlhOWNkOThmMTViMzdhZGU2ZTY3ZmQ5YjMyZDc=
-  data.tar.gz: !binary |-
-    NDY5MjgyOGZmODQ1N2ZiYWNhMmMyMjUwMzg3MTMxYWU3OTRjNTJlMzYzMTUy
-    ZWZiYjI0NmZjYjZjMDljNDgzNDVkZmZlYWQ1N2FlZmEzMmY3NzNkMWNmNGJm
-    YjNiYTFiMjQ0N2UyNzhkYTVhNDNlM2VjNWYzODM1Nzc0YTU3Zjk=
+  metadata.gz: 2d6928aee4bdebfe1272677a7b88dbe56df591922aeaf38d175d5c109fbd8b149a7519259d8322e202223319601a61a0d82d73084becf8126019b45af12acea5
+  data.tar.gz: 6baef1393173ee402a8487bf7656702c399d39f0b490047ad306a4807546c28561ef23810ab49bd90316ffbe6bafb3132cd12eac69b787d6766ec3ade5b00a21

data/.gitignore

@@ -17,3 +17,4 @@ capybara-*.html
 rerun.txt
 pickle-email-*.html
 /pkg/*
+

data/Gemfile.lock

@@ -1,17 +1,20 @@
 PATH
   remote: .
   specs:
-    trans-api (0.0.1)
-      json
-      nokogiri
+    trans-api (0.0.3)
+      json (> 1.6.1)
+      nokogiri (> 1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    json (1.7.5)
-    json (1.7.5-java)
-    nokogiri (1.5.5)
-    nokogiri (1.5.5-java)
+    json (1.8.1)
+    json (1.8.1-java)
+    mini_portile (0.5.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    nokogiri (1.6.1-java)
+      mini_portile (~> 0.5.0)
     test-unit (2.5.2)
 
 PLATFORMS
@@ -19,5 +22,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  test-unit
+  test-unit (> 2.0.0)
   trans-api!

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Dennis Blommesteijn
+Copyright (c) 2012-2014 Dennis Blommesteijn
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Trans::Api
 
-Trans::Api is an ruby implementation for Transmission RPC. Based on RPC spec 13328
+Trans::Api is an ruby implementation for Transmission RPC (bittorrent client). Based on RPC spec 13328
 https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt
 
 It required for the Transmission RPC to run the 'remote access':
@@ -10,22 +10,22 @@ OSX:
   Transmission > Preferences > Remote (tab) > Enable remote access
 
 
-### Platforms
+### Platforms (tested)
 
 This gem is (build and) tested with:
 
-  OSX Lion, Mountain Lion
+  OSX Lion, Mountain Lion, Mavericks
 
-  Ruby 1.9.3
+  Ruby 1.9.3, 2.1.0
 
-  Rails: 3.2.8, 3.2.9
+  Rails: 3.2.8, 3.2.9, 4.0.3
 
-  Transmission 2.73 (13589)
+  Transmission 2.73 (13589) - 2.82 (14160)
 
 
 ### Roadmap
 
-* Version (0.0.1) (current)
+* Version (0.0.1)
 
   Initial project import.
 
@@ -39,26 +39,48 @@ This gem is (build and) tested with:
 
   Torrent object 'waitfor' helper to check for lambda after/before calling it's chained cousin
 
+* Version (0.0.3)
+
+  Querying name before add (duplicate detect), not hammering torrent-add (due to a transmission BUG)
+
+  Added some File internal fields (total and completed transfer)
+
+* Version (0.0.4)
+
+  Added Session.alt_speed_time_day_options, returns a list of values to set `alt_speed_time_day`
+
+  Added Session.reload!, that reconnects to the client (for example using alternate configs)
+
+  Added Session.update_blocklist!, updating the current set blocklist
+
+
+### Changelog
+
+* Version (0.0.3)
+  
+  Torrent.add_metainfo(base64, filename, options={}) -> requires a filename parameter
+
+* Version (0.0.4)
+
+  TBA
 
 ### Known Issues
 
 The Transmission RPC call 'torrent-remove' (implemented as torrent.delete! and Torrent::delete_all!) will crash the daemon! This is NOT a known Transmission issue.
 
+Due to a Transmission bug (https://trac.transmissionbt.com/ticket/5614) duplicate torrents are accepted by the RPC call. The GUI will eventually crash the daemon, when interacting with these duplicate files (or instances). Torrent.add_file/ add_metainfo queries for duplicates to omit this bug.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'trans-api', git: "git://github.com/dblommesteijn/trans-api.git"
+    gem 'trans-api', github: "dblommesteijn/trans-api"
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install trans-api
-
 
 ## Setup
 
@@ -157,8 +179,19 @@ Trans::Api::Torrent.delete_all torrents
 Add torrent file
 
 ```ruby
+file = File.open('some file here')
 options = {paused: true}
-Trans::Api::Torrent.add_file filename, options
+Trans::Api::Torrent.add_file file, options
+```
+
+Add torrent file (via base64)
+
+```ruby
+file = File.open('some file here')
+file_name = File.basename(file, ".*") # required >= 0.0.3/ master
+options = {paused: true}
+base64_file_contents = Base64.encode64 file.read
+Trans::Api::Torrent.add_metainfo base64_file_contents, file_name, options
 ```
 
 Get all fields
@@ -284,6 +317,29 @@ Reset (reload object, request information and not saving changes)
 session.reset!
 ```
 
+Reload (reload the client connection, and configuration)
+
+```ruby
+session.reload!
+```
+
+Enable set and update blocklist
+
+```ruby
+# set an url
+session.blocklist_url = "http://list.iblocklist.com/?list=bt_level3&fileformat=p2p&archiveformat=gz"
+# enable blocklist
+session.blocklist_enable = true
+# save changes
+session.save!
+# force update 
+begin
+  session.update_blocklist!
+rescue Exception => e
+  # handle http exceptions here!
+end
+```
+
 NOTE: defined session fields are defined as instance methods to the Session object
 
 
@@ -332,3 +388,6 @@ file.stat
 
 NOTE: changed preferences (want, unwant) set options on the linked Torrent object, after saving torrent (torrent.save!) file mutations are stored.
 
+
+
+

data/lib/trans-api.rb

@@ -5,8 +5,15 @@ require File.expand_path(File.dirname(__FILE__) + "/trans-api/session")
 require File.expand_path(File.dirname(__FILE__) + "/trans-api/torrent")
 require File.expand_path(File.dirname(__FILE__) + "/trans-api/file")
 
+# boolean helper
+if Boolean.nil?
+  module Boolean; end
+  class TrueClass; include Boolean; end
+  class FalseClass; include Boolean; end
+end
+
+# trans api placeholder
 module Trans
   module Api
-    # placeholder
   end
 end

data/lib/trans-api/connect.rb

@@ -152,8 +152,11 @@ module Trans
         data = METHODS[:torrent_add]
         data[:arguments] = argument_name_to_api arguments
         ret = self.do(:post, data)
+        # puts JSON.parse(ret[:response].body).inspect
         torrents = JSON.parse ret[:response].body.gsub("-","_"), {symbolize_names: true}
         raise torrents[:result] unless valid? torrents, data[:tag]
+        # omiting BUG: https://trac.transmissionbt.com/ticket/5614
+        return torrents[:arguments][:torrent_duplicate] if torrents[:arguments].include?(:torrent_duplicate)
         torrents[:arguments][:torrent_added]
       end
 

data/lib/trans-api/file.rb

@@ -1,56 +1,68 @@
 
 
 module Trans
-	module Api
-
-		class File
-
-			def initialize(options={})
-				@torrent = options.delete :torrent
-				@torrent_fields = options.delete :fields
-				@fields = options[:file]
-
-				# set default stats
-				@torrent_fields[:files_unwanted] ||= []
-				@torrent_fields[:files_wanted] ||= []
-#				if @fields[:fileStat][:wanted] == false
-#					@torrent_fields[:files_unwanted] << self.id
-#				else
-#					@torrent_fields[:files_wanted] << self.id
-#				end
-
-				@client = Client.new
-			end
-
-			def id
-				@fields[:id]
-			end
-
-			def name
-				@fields[:name]
-			end
-
-			def stat
-				@fields[:fileStat]
-			end
-
-			def unwant
-				@torrent_fields[:files_wanted].delete self.id if @torrent_fields[:files_wanted].include? self.id
-				@torrent_fields[:files_unwanted] << self.id unless @torrent_fields[:files_unwanted].include? self.id
-				@fields[:fileStat][:wanted] = false
-			end
-
-			def want
-				@torrent_fields[:files_wanted] << self.id unless @torrent_fields[:files_wanted].include? self.id
-				@torrent_fields[:files_unwanted].delete self.id if @torrent_fields[:files_unwanted].include? self.id
-				@fields[:fileStat][:wanted] = true
-			end
-
-			def wanted?
-				@fields[:fileStat][:wanted]
-			end
-
-		end
-
-	end
+  module Api
+
+    class File
+
+      def initialize(options={})
+        @torrent = options.delete :torrent
+        @torrent_fields = options.delete :fields
+        @fields = options[:file]
+
+        # set default stats
+        @torrent_fields[:files_unwanted] ||= []
+        @torrent_fields[:files_wanted] ||= []
+#       if @fields[:fileStat][:wanted] == false
+#         @torrent_fields[:files_unwanted] << self.id
+#       else
+#         @torrent_fields[:files_wanted] << self.id
+#       end
+
+        @client = Client.new
+      end
+
+      def id
+        @fields[:id]
+      end
+
+      def name
+        @fields[:name]
+      end
+
+      def stat
+        @fields[:fileStat]
+      end
+
+      def bytes_completed
+        @fields[:bytesCompleted]
+      end
+
+      def bytes_total
+        @fields[:length]
+      end
+
+      def priority
+        @fields[:fileStat][:priority]
+      end
+
+      def unwant
+        @torrent_fields[:files_wanted].delete self.id if @torrent_fields[:files_wanted].include? self.id
+        @torrent_fields[:files_unwanted] << self.id unless @torrent_fields[:files_unwanted].include? self.id
+        @fields[:fileStat][:wanted] = false
+      end
+
+      def want
+        @torrent_fields[:files_wanted] << self.id unless @torrent_fields[:files_wanted].include? self.id
+        @torrent_fields[:files_unwanted].delete self.id if @torrent_fields[:files_unwanted].include? self.id
+        @fields[:fileStat][:wanted] = true
+      end
+
+      def wanted?
+        @fields[:fileStat][:wanted]
+      end
+
+    end
+
+  end
 end

data/lib/trans-api/session.rb

@@ -16,27 +16,7 @@ module Trans
 
 
       def initialize
-        @client = Client.new
-        self.reset!
-
-        # map fields to accessors
-        @fields.each do |k, v|
-          # setter
-          self.metaclass.send(:define_method, "#{k}=") do |value|
-            if v.class == value.class
-              @fields[k] = value
-            else
-              msg = "invalid type: #{value.class}, expected: #{v.class}"
-              @last_error[:message] = msg
-              raise msg
-            end
-          end
-          # getter
-          self.metaclass.send(:define_method, "#{k}") do
-            @fields[k]
-          end
-        end
-
+        self.reload!
       end
 
       def fields
@@ -71,12 +51,64 @@ module Trans
         @fields = @client.connect.session_get
         @old_fields = @fields.clone
         @last_error = {error: "", message: ""}
+        nil
+      end
+
+      def reload!
+        @client = Client.new
+        self.reset!
+
+        # map fields to accessors
+        @fields.each do |k, v|
+          # setter
+          self.metaclass.send(:define_method, "#{k}=") do |value|
+            if v.class == value.class || value.is_a?(::Boolean)
+              @fields[k] = value
+            else
+              msg = "invalid type: #{value.class}, expected: #{v.class}"
+              @last_error[:message] = msg
+              raise msg
+            end
+          end
+          # getter
+          self.metaclass.send(:define_method, "#{k}") do
+            @fields[k]
+          end
+        end
       end
 
+      def update_blocklist!
+        @client.connect.blocklist_update
+      end
+
+
+      # blocklist-update
+
 
       def metaclass
         class << self; self; end
       end
+
+      class << self
+        def alt_speed_time_day_options
+          ret = []
+          ret << ["Sunday", 1]
+          ret << ["Monday", 2]
+          ret << ["Tuesday", 4]
+          ret << ["Wednesday", 8]
+          ret << ["Thursday", 16]
+          ret << ["Friday", 32]
+          ret << ["Weekdays", 62]
+          ret << ["Saturday", 64]
+          ret << ["Weekends", 65]
+          ret << ["Every Day", 127]
+          ret.sort{|a,b| a.last <=> b.last}
+        end
+
+        def encryption_levels
+          ["required", "preferred", "tolerated"].map{|t| [t.humanize, t]}
+        end
+      end
     end
 
   end

data/lib/trans-api/torrent.rb

@@ -1,6 +1,8 @@
 module Trans
   module Api
 
+    require 'pathname'
+
     #
     # Torrent class
     #
@@ -86,8 +88,10 @@ module Trans
         torrent = @client.connect.torrent_get([:files, :fileStats], [self.id]).first
         @fields[:files] = torrent[:files]
         @fields[:fileStatus] = torrent[:fileStats]
-        @fields[:files].each_with_index{ |f,i| ret << Trans::Api::File.new( torrent: self, fields: @fields,
-          file: f.merge(id: i).merge(fileStat: torrent[:fileStats][i])) }
+        @fields[:files].each_with_index do |f,i| 
+          ret << Trans::Api::File.new( torrent: self, fields: @fields,
+            file: f.merge(id: i).merge(fileStat: torrent[:fileStats][i]))
+        end
         ret
       end
 
@@ -199,6 +203,9 @@ module Trans
 
         def add_file(filename, options={})
           raise "file not found: #{filename}" unless ::File.exists? filename
+          # filter duplicates
+          find = Trans::Api::Torrent.find_by_field_value(:name, ::File.basename(filename, ".*"))
+          return find unless find.nil?
           client = Client.new
           options[:filename] = filename
           torrent = client.connect.torrent_add options
@@ -206,8 +213,12 @@ module Trans
           Torrent.new torrent: torrent
         end
 
-        def add_metainfo(metainfo, options={})
+        def add_metainfo(metainfo, name, options={})
+          raise "name empty" if name.nil? || name == ""
           options[:metainfo] = metainfo
+          # filter duplicates
+          find = Trans::Api::Torrent.find_by_field_value(:name, name)
+          return find unless find.nil?
           client = Client.new
           torrent = client.connect.torrent_add options
           torrent = client.connect.torrent_get( @@default_fields, [torrent[:id]]).first

data/lib/trans-api/version.rb

@@ -1,5 +1,5 @@
 module Trans
   module Api
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/test/unit/trans_connect.rb

@@ -2,7 +2,8 @@ require 'rubygems'
 require 'test/unit'
 require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
-
+# run with config options
+#CONFIG="{\"host\":\"localhost\",\"port\":9091,\"user\":\"admin\",\"pass\":\"admin\",\"path\":\"/transmission/rpc\"}" ruby -I test test/unit/trans_connect.rb
 
 #
 # Unit test for Transmission RPC+json
@@ -12,10 +13,11 @@ require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
 class TransConnect < Test::Unit::TestCase
 
-  CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
-
   def setup
-    Trans::Api::Client.config = CONFIG
+    @CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
+    @CONFIG = JSON.parse(ENV["CONFIG"], symbolize_names: true) if ENV.include? "CONFIG"
+
+    Trans::Api::Client.config = @CONFIG
 
     # add a testing torrent
     file = File.expand_path(File.dirname(__FILE__) + "/torrents/debian-6.0.6-amd64-CD-1.iso.torrent")
@@ -24,7 +26,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def teardown
-    Trans::Api::Client.config = CONFIG
+    Trans::Api::Client.config = @CONFIG
 
     # remove the testing torrent
     id = @torrent.id
@@ -39,19 +41,19 @@ class TransConnect < Test::Unit::TestCase
   # SESSIONS
 
   def test_session_get
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     session = tc.session_get
     assert session.size > 0, "no arguments found"
   end
 
   def test_session_stats
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     session = tc.session_stats
     assert session.size > 0, "no arguments found"
   end
 
   def test_session_set
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     # get session
     session_get = tc.session_get
@@ -91,7 +93,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_session_close
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     session_get = tc.session_get
     #NOTE: will shut the daemon down!!
     #    session_close = tc.session_close
@@ -101,7 +103,7 @@ class TransConnect < Test::Unit::TestCase
   # TORRENTS
 
   def test_torrent_get
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     # receive torrent list
     torrents = tc.torrent_get([:id, :name, :status])
@@ -126,7 +128,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_torrent_set
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     # get torrent list
     torrents = tc.torrent_get([:id, :name, :bandwidthPriority])
@@ -156,7 +158,7 @@ class TransConnect < Test::Unit::TestCase
 
 
   def test_torrent_start_stop_single
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     torrents = tc.torrent_get([:id, :name, :status])
 
@@ -202,7 +204,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_torrent_start_stop_multi
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     torrents = tc.torrent_get([:id, :name, :status])
 
 
@@ -241,7 +243,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_torrent_add_remove_single
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     # add test file
     file = File.expand_path(File.dirname(__FILE__) + "/torrents/debian-6.0.6-amd64-CD-2.iso.torrent")
@@ -266,7 +268,7 @@ class TransConnect < Test::Unit::TestCase
 
 
   def test_torrent_files_unwatched
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     torrents = tc.torrent_get([:id, :name, :status, :files, :fileStats])
 
     torrents.each do |torrent|
@@ -278,7 +280,7 @@ class TransConnect < Test::Unit::TestCase
 
 
   def test_torrent_start_now
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     # get first torrent
     torrent = tc.torrent_get([:id, :name, :status]).first
     # start now
@@ -290,7 +292,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_torrent_verify
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     torrents = tc.torrent_get([:id, :name, :status])
 
     torrents.each do |torrent|
@@ -302,7 +304,7 @@ class TransConnect < Test::Unit::TestCase
   end
 
   def test_torrent_reannounce
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     torrents = tc.torrent_get([:id, :name, :status])
 
     torrents.each do |torrent|
@@ -314,7 +316,7 @@ class TransConnect < Test::Unit::TestCase
 
 
   def test_torrent_set_location
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     # new target
     file = File.expand_path(File.dirname(__FILE__) + "/torrents/download_tmp/")
@@ -341,14 +343,14 @@ class TransConnect < Test::Unit::TestCase
   # MISC
 
   def test_blocklist_update
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     response = tc.blocklist_update
     assert response.include? :blocklist_size
     assert response[:blocklist_size].class == Fixnum
   end
 
   def test_port_test
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
     response = tc.port_test
     assert response.include? :port_is_open
     assert response[:port_is_open].class == FalseClass || response[:port_is_open].class == TrueClass
@@ -358,7 +360,7 @@ class TransConnect < Test::Unit::TestCase
   # QUEUE
 
   def test_queue_movement
-    tc = Trans::Api::Connect.new CONFIG
+    tc = Trans::Api::Connect.new @CONFIG
 
     torrents = []
 

data/test/unit/trans_session_object.rb

@@ -4,6 +4,8 @@ require 'test/unit'
 require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
 
+# run with config options
+#CONFIG="{\"host\":\"localhost\",\"port\":9091,\"user\":\"admin\",\"pass\":\"admin\",\"path\":\"/transmission/rpc\"}" ruby -I test test/unit/trans_session_object.rb
 
 #
 # Unit test for Transmission RPC+json
@@ -13,10 +15,14 @@ require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
 class TransSessionObject < Test::Unit::TestCase
 
-  CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
+  BLOCKLIST = "http://list.iblocklist.com/?list=bt_level3&fileformat=p2p&archiveformat=gz"
+
 
   def setup
-    Trans::Api::Client.config = CONFIG
+    @CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
+    @CONFIG = JSON.parse(ENV["CONFIG"], symbolize_names: true) if ENV.include? "CONFIG"
+
+    Trans::Api::Client.config = @CONFIG
   end
 
 
@@ -79,4 +85,55 @@ class TransSessionObject < Test::Unit::TestCase
   end
 
 
+  def test_swap_configs
+    # test default operation
+    session = Trans::Api::Session.instance
+    assert session.fields_and_values.size > 0, "no fields and values loaded"
+
+    # insert a broken config
+    broken_config = { host: "localhost", port: 9091, user: "akdljflkasjdlfk", pass: "alskdfjlkajsdfl", path: "/transmission/rpc" }
+    Trans::Api::Client.config = broken_config
+    session.reload!
+    assert session.stats!.nil?, "stat should be broken!"
+  end
+
+
+  def test_set_blocklist
+    session = Trans::Api::Session.instance
+    session.blocklist_enabled = false
+    session.blocklist_url = ""
+    session.save!
+    # verify
+    session.reload!
+    assert session.blocklist_url == "", "url not updated"
+    assert session.blocklist_enabled == false, "boolean not toggled"
+    # save blocklist to session
+    session = Trans::Api::Session.instance
+    session.blocklist_url = BLOCKLIST
+    session.blocklist_enabled = true
+    session.save!
+    # verify
+    session.reload!
+    assert session.blocklist_url == BLOCKLIST, "blocklist not saved!"
+    # force blocklist update
+    response = session.update_blocklist!
+    session.reload!
+    assert session.blocklist_size == response[:blocklist_size], "blocklist not updated"
+  end
+
+  def test_set_wrong_blocklist
+    session = Trans::Api::Session.instance
+    session.blocklist_enabled = false
+    session.blocklist_url = ""
+    session.save!
+    session.reload!
+    begin
+      session.update_blocklist!
+      assert false, "should not be possible without an url"
+    rescue Exception => e
+      assert true
+    end
+  end
+
+
 end

data/test/unit/trans_torrent_object.rb

@@ -3,6 +3,8 @@ require 'rubygems'
 require 'test/unit'
 require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
+# run with config options
+#CONFIG="{\"host\":\"localhost\",\"port\":9091,\"user\":\"admin\",\"pass\":\"admin\",\"path\":\"/transmission/rpc\"}" ruby -I test test/unit/trans_torrent_object.rb
 
 
 #
@@ -13,10 +15,11 @@ require File.expand_path(File.dirname(__FILE__) + "/../../lib/trans-api")
 
 class TransTorrentObject < Test::Unit::TestCase
 
-  CONFIG = { host: "localhost", port: 8078, user: "pinguin", pass: "100110", path: "/transmission/rpc" }
-
   def setup
-    Trans::Api::Client.config = CONFIG
+    @CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
+    @CONFIG = JSON.parse(ENV["CONFIG"], symbolize_names: true) if ENV.include? "CONFIG"
+
+    Trans::Api::Client.config = @CONFIG
     Trans::Api::Torrent.default_fields = [ :id, :status, :name ]
 
     # add a testing torrent
@@ -250,6 +253,15 @@ class TransTorrentObject < Test::Unit::TestCase
     assert torrent.downloadDir == file
   end
 
+  def test_duplicate_file_upload
+    # add test torrents
+    file = File.expand_path(File.dirname(__FILE__) + "/torrents/debian-6.0.6-amd64-CD-2.iso.torrent")
+    # hammer duplicate torrent
+    torrent = nil
+    10.times { |t| torrent = Trans::Api::Torrent.add_file(file, paused: true) }
+    assert Trans::Api::Torrent.all.size == 2
+    torrent.delete!
+  end
 
   def test_queue_movement
     # get queueposition as well
@@ -350,7 +362,12 @@ class TransTorrentObject < Test::Unit::TestCase
     torrent = Trans::Api::Torrent.add_metainfo(metainfo, paused: true)
     assert torrent.name == "debian-6.0.6-amd64-CD-5.iso"
     torrent.delete!
+  end
 
+  def test_find_torrent_by_value_name
+    torrent = Trans::Api::Torrent.find_by_field_value(:name, "debian-6.0.6-amd64-CD-1.iso")
+    assert !torrent.nil?
+    assert torrent.name == "debian-6.0.6-amd64-CD-1.iso"
   end
 
 

data/trans-api.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = Trans::Api::VERSION
   gem.authors       = ["Dennis Blommesteijn"]
   gem.email         = ["dennis@blommesteijn.com"]
-  gem.description   = %q{Transmission RPC API for Ruby on Rails (gem).}
-  gem.summary       = %q{Transmission RPC API for Ruby on Rails (gem)}
-  gem.homepage      = ""
+  gem.description   = %q{Transmission (bittorrent client) RPC API for Ruby on Rails (gem)}
+  gem.summary       = %q{Transmission (bittorrent client) RPC API for Ruby on Rails (gem)}
+  gem.homepage      = "https://github.com/dblommesteijn/trans-api"
 
   # dependencies
-  gem.add_dependency 'nokogiri'
-  gem.add_dependency 'json'
-  gem.add_development_dependency "test-unit"
+  gem.add_dependency 'nokogiri', "> 1.5.0"
+  gem.add_dependency 'json', "> 1.6.1"
+  gem.add_development_dependency "test-unit", "> 2.0.0"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,58 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: trans-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Dennis Blommesteijn
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
+        version: 1.5.0
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: json
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
+        version: 1.6.1
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: test-unit
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
+        version: 2.0.0
   type: :development
-description: Transmission RPC API for Ruby on Rails (gem).
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Transmission (bittorrent client) RPC API for Ruby on Rails (gem)
 email:
 - dennis@blommesteijn.com
 executables: []
@@ -65,8 +65,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/basic_setup.rb
-- examples/torrents/debian-6.0.6-amd64-CD-10.iso.torrent
 - lib/trans-api.rb
 - lib/trans-api/client.rb
 - lib/trans-api/connect.rb
@@ -74,7 +72,6 @@ files:
 - lib/trans-api/session.rb
 - lib/trans-api/torrent.rb
 - lib/trans-api/version.rb
-- test/test_helper.rb
 - test/unit/torrents/debian-6.0.6-amd64-CD-1.iso.torrent
 - test/unit/torrents/debian-6.0.6-amd64-CD-2.iso.torrent
 - test/unit/torrents/debian-6.0.6-amd64-CD-3.iso.torrent
@@ -86,10 +83,10 @@ files:
 - test/unit/trans_session_object.rb
 - test/unit/trans_torrent_object.rb
 - trans-api.gemspec
-homepage: ''
+homepage: https://github.com/dblommesteijn/trans-api
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,13 +101,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.0.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
-summary: Transmission RPC API for Ruby on Rails (gem)
+summary: Transmission (bittorrent client) RPC API for Ruby on Rails (gem)
 test_files:
-- test/test_helper.rb
 - test/unit/torrents/debian-6.0.6-amd64-CD-1.iso.torrent
 - test/unit/torrents/debian-6.0.6-amd64-CD-2.iso.torrent
 - test/unit/torrents/debian-6.0.6-amd64-CD-3.iso.torrent

data/examples/basic_setup.rb

@@ -1,78 +0,0 @@
-#!/usr/bin/env ruby
-
-# setup
-require 'rubygems'
-require "bundler/setup"
-require 'trans-api'
-
-
-class BasicSetup
-
-  include Trans::Api
-
-  CONFIG = { host: "localhost", port: 9091, user: "admin", pass: "admin", path: "/transmission/rpc" }
-  FIELDS = [ :id, :status, :name ]
-
-  def initialize
-
-    # connection information (rpc location)
-    Client.config = CONFIG
-
-    # default loading torrent fields
-    Torrent.default_fields = FIELDS
-
-    #TODO: add a section for session here!!
-
-  end
-
-
-  def add_torrent
-
-    # selecting a file to add (debian demo file)
-    file = ::File.expand_path(::File.dirname(__FILE__) + "/torrents/debian-6.0.6-amd64-CD-10.iso.torrent")
-
-    # adding a torrent using static call on Torrent object (paused transfer)
-    @torrent = Torrent.add_file file, paused: true
-    # return variable is an instance of the torrent file
-    # an exception can be raised on invalid request
-
-    # NOTE: we will store it for later use (removing this torrent, not the whole list)
-
-  end
-
-  def remove_torrent
-
-    #TODO: remove torrent here!
-
-  end
-
-  def iterating_torrents
-
-    torrents = Torrent.all
-
-    torrents.each do |torrent|
-
-      puts "#{torrent.name} -> #{torrent.status_name}"
-
-    end
-
-  end
-
-end
-
-
-
-# initiate BasicSetup object, and run its methods
-begin
-
-  bs = BasicSetup.new
-  bs.add_torrent
-  bs.iterating_torrents
-
-rescue Exception => e
-  puts e
-end
-
-
-
-

data/test/test_helper.rb

@@ -1,8 +0,0 @@
-
-class ActiveSupport::TestCase
-  setup :global_setup
-
-  def global_setup
-  end
-end
-