trans-api 0.0.1

data/lib/trans-api/torrent.rb

@@ -0,0 +1,292 @@
+module Trans
+  module Api
+
+    #
+    # Torrent class
+    #
+
+    class Torrent
+
+      # torrent status value
+      STATUS = [ :stopped, :checkQueue, :checkFiles, :downloadQueue, :downloading, :seedQueue, :seeding, :isolated ]
+
+      # torrent get fields
+      ACCESSOR_FIELDS = [
+        :activityDate, :addedDate, :bandwidthPriority, :comment, :corruptEver, :creator, :dateCreated, :desiredAvailable,
+        :doneDate, :downloadDir, :downloadedEver, :downloadLimit, :downloadLimited, :error, :errorString, :eta, :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 ]
+
+      # torrent set fields
+      MUTATOR_FIELDS = [ :bandwidthPriority, :downloadLimit, :downloadLimited, :files_wanted, :files_unwanted, :honorsSessionLimits,
+        :ids, :location, :peer_limit, :priority_high, :priority_low, :priority_normal, :queuePosition, :seedIdleLimit,
+        :seedIdleMode, :seedRatioLimit, :seedRatioMode, :trackerAdd, :trackerRemove, :trackerReplace, :uploadLimit, :uploadLimited ]
+
+      # torrent add fields
+      ADD = [ :cookies, :download_dir, :filename, :metainfo, :paused, :peer_limit, :bandwidthPriority, :files_wanted,
+        :files_unwanted, :priority_high, :priority_low, :priority_normal ]
+
+      DELETE = [ :ids, :delete_local_data ]
+
+      LOCATION = [ :ids, :move, :location ]
+
+
+      @@default_fields = [ :id, :name, :status ]
+
+
+      # constructor
+      def initialize(options={})
+        @client = Client.new
+        @fields = options[:torrent] if options.include? :torrent
+        @old_fields = @fields.clone
+        @last_error = {error: "", message: ""}
+        self.attach_methods!
+      end
+
+      # placeholder for fields
+      def metaclass
+        class << self; self; end
+      end
+
+      def status_name
+        STATUS[self.status]
+      end
+
+      # store changed field
+      def save!
+        # reject unchanged fields
+        changed = @fields.reject{|k,v| @old_fields[k] == v}
+        # reject inmutable fields
+        changed.reject!{|k,v| !MUTATOR_FIELDS.include?(k) }
+        # reject empty arrays
+        changed.reject!{|k,v| v.class == Array && v.empty? }
+        if changed.size > 0
+          # call api, and store changed fields
+          @client.connect.torrent_set changed, [self.id]
+          @old_fields = @fields.clone
+        end
+      end
+
+      # get registered fields
+      def fields
+        @fields
+      end
+
+      # files wrapped by an File object
+      def files_objects
+        ret = []
+#        i = -1
+        torrent = @client.connect.torrent_get([:files, :fileStats], [self.id]).first
+        @fields[:files] = torrent[:files]
+        @fields[:fileStatus] = torrent[:fileStats]
+        self.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])) }
+        ret
+      end
+
+      # reload current object
+      def reset!
+        @fields = @client.connect.torrent_get( @fields.map{|k,v| k}, [self.id]).first
+        @old_fields = @fields.clone
+        @last_error = {error: "", message: ""}
+      end
+
+      def start!
+        @client.connect.torrent_start [self.id]
+      end
+
+      def start_now!
+        @client.connect.torrent_start_now [self.id]
+      end
+
+      def stop!
+        @client.connect.torrent_stop [self.id]
+      end
+
+      def verify!
+        @client.connect.torrent_verify [self.id]
+      end
+
+      def reannounce!
+        @client.connect.torrent_reannounce [self.id]
+      end
+
+      def set_location!(file, move = false)
+        @client.connect.torrent_set_location({location: file, move: move}, [self.id])
+      end
+
+      def delete!(options={})
+        options[:delete_local_data] = false unless options.include? :delete_local_data # optional
+        @client.connect.torrent_remove options, [self.id]
+      end
+
+      def queue_top!
+        @client.connect.queue_move_top [self.id]
+      end
+
+      def queue_bottom!
+        @client.connect.queue_move_bottom [self.id]
+      end
+
+      def queue_up!
+        @client.connect.queue_move_up [self.id]
+      end
+
+      def queue_down!
+        @client.connect.queue_move_down [self.id]
+      end
+
+      # wait for a specific torrent lambda after call
+      # Ex: lamb = instance.waitfor_after(lambda{|torrent| torrent.status_name != :stopped}, :after).start!
+      def waitfor(lamb, place = :after)
+        TorrentDummy.new lamb, self, place
+      end
+
+      # static methods
+      class << self
+        def all
+          torrents = Client.new.connect.torrent_get( @@default_fields )
+          torrents.map{|t| Torrent.new torrent: t}
+        end
+
+        def find(id)
+          torrents = Client.new.connect.torrent_get( @@default_fields , [id])
+          remap = torrents.map{|t| Torrent.new torrent: t }
+          return remap.first if torrents.size == 1
+          return nil if torrents.empty?
+          remap
+        end
+
+        def find_by_field_value(field, value)
+          # set a reduced search field (with some default values)
+          fields = [field, :id, :name, :status]
+          torrents = Client.new.connect.torrent_get( fields )
+          torrents.reject!{|t| t[field] != value}
+          # TODO: perhaps add original default values??
+          remap = torrents.map{|t| Torrent.new torrent: t }
+          return remap.first if torrents.size == 1
+          return nil if torrents.empty?
+          remap
+        end
+
+        def start_all
+          torrents = Client.new.connect.torrent_get [:id, :status]
+          remap = torrents.map{ |t| Torrent.new torrent: t }
+          Client.new.connect.torrent_start remap.map{|t| t.id}
+        end
+
+        def stop_all
+          torrents = Client.new.connect.torrent_get [:id, :status]
+          remap = torrents.map{ |t| Torrent.new torrent: t }
+          Client.new.connect.torrent_stop remap.map{|t| t.id}
+        end
+
+        def delete_all(torrents, options={})
+          raise "no ids assigned" if torrents.empty? || !torrents.kind_of?(Array)
+          raise "expected type: Torrent" if torrents.size > 0 && !torrents.first.kind_of?(Torrent)
+          ids = torrents.map{|torrent| torrent.id}
+          client = Client.new
+          options[:delete_local_data] = false unless options.include? :delete_local_data # optional
+          client.connect.torrent_remove options
+        end
+
+        def add_file(filename, options={})
+          raise "file not found: #{filename}" unless ::File.exists? filename
+          client = Client.new
+          options[:filename] = filename
+          torrent = client.connect.torrent_add options
+          torrent = client.connect.torrent_get( @@default_fields, [torrent[:id]]).first
+          Torrent.new torrent: torrent
+        end
+
+        def default_fields=(list=[])
+          @@default_fields << :id unless list.include? :id
+          @@default_fields |= list
+        end
+      end
+
+
+      protected
+
+      # define helper methods for setting and getting field information
+      def attach_methods!
+
+        # NOTE: not all accessor fields are mutators as well!!
+
+        MUTATOR_FIELDS.each do |k|
+          # setter
+          self.metaclass.send(:define_method, "#{k}=") do |value|
+            unless @fields.include? k
+              fields = @client.connect.torrent_get([k], [self.id]).first
+              @fields.merge! fields
+              @old_fields.merge! fields
+            end
+            @fields[k] = value
+          end
+        end
+
+
+        ACCESSOR_FIELDS.each do |k|
+          # getter
+          self.metaclass.send(:define_method, "#{k}") do
+            # request handler to get new field
+            unless @fields.include? k
+              fields = @client.connect.torrent_get([k], [self.id]).first
+              @fields.merge! fields
+              @old_fields.merge! fields
+            end
+            @fields[k]
+          end
+        end
+      end
+
+    end
+
+    protected
+
+    # Dummy class to handle chained calling
+    # Inspired by delayed_job (message_sending.rb)
+    # https://github.com/collectiveidea/delayed_job/blob/master/lib/delayed/message_sending.rb
+    class TorrentDummy
+
+      def initialize(task, target_object, place)
+        @task = task # lambda
+        @target_object = target_object
+        @place = place
+
+        self.wait if @place == :before
+      end
+
+      # handling Torrent method calls
+      def method_missing(method, *args)
+
+        unless args.empty?
+          @target_object.send method, args
+        else
+          @target_object.send method
+        end
+
+        self.wait if @place == :after
+
+      end
+
+      def wait
+        # keep trying task (and refreshing the torrent file)
+        while true do
+          @target_object.reset!
+          t = @task.call @target_object
+          break if t # task achieved!
+        end
+      end
+
+    end
+
+
+
+  end
+end

data/lib/trans-api/version.rb

@@ -0,0 +1,5 @@
+module Trans
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/trans-api.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + "/trans-api/version")
+require File.expand_path(File.dirname(__FILE__) + "/trans-api/client")
+require File.expand_path(File.dirname(__FILE__) + "/trans-api/connect")
+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")
+
+module Trans
+  module Api
+    # placeholder
+  end
+end

data/test/test_helper.rb

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