transmission-rss 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 920904c2e1205bfbfa74c6baacc111aa545c55d9
-  data.tar.gz: 1c3c0d44afa9284d4720b7226f9efefa91387427
+  metadata.gz: 4799fb595553fef0cf552adf93216b4ce6c7d265
+  data.tar.gz: 64c6d7ffb5dca02e58195b27bd0185ef321773e7
 SHA512:
-  metadata.gz: efa71a1a7bca7c4a303380311d9611818cc63ea1b366f5489fb2bca248e4d2503141cae312645e268ae51d36674cdf7fcd000349cc27bef5721f4f617edb44fd
-  data.tar.gz: 6ea5f5a54e3120b4cd5ca03fa821c73cefc6f645fe51964783c036acdb86940b9235fb1ad29b16dee69f5ff393e513c15be4ca92e739d9cc60ead79ce1120267
+  metadata.gz: 452d464189a7d4df88827296741410572f5550aa96c8ed684e8cda79f37296dddc01c01757e074a6c31fb85fbba2d04e5783f2a06e9aa66a9c7f5e4f157e40ce
+  data.tar.gz: e3ed1575e0b955b4be00ecd0f724b351036d06ea6026af5b390781598f4c17e09e59f42073ea05079559edd713ab9d32c6c7ca790d468265933a0c25c31e97f2

data/README.md

@@ -73,6 +73,5 @@ not defined by default, so the script runs as current user/group.
 TODO
 ----
 
-* Better library abilities.
 * Option to stop seeding after full download.
 * Configurable log level.

data/bin/transmission-rss

@@ -19,13 +19,14 @@ pid_file = false
 
 # Shows a summary of the command line options.
 def usage_message(config_file)
-  $stderr << "#{File.basename $0} [option]..
+  $stderr << "#{File.basename $0} [options]
 Adds torrents from rss feeds to transmission web frontend.
 
   -c <file>   Custom config file path. Default: #{config_file}
   -f          Fork into background after startup.
-  -p <file>   Write PID to file.
   -h          This help.
+  -p <file>   Write PID to file.
+  -v          Show program version and exit.
 
 "
   exit(1)
@@ -33,10 +34,11 @@ end
 
 # Define command-line options.
 options = GetoptLong.new \
-  [ '-c', GetoptLong::REQUIRED_ARGUMENT ],
-  [ '-f', GetoptLong::NO_ARGUMENT ],
-  [ '-p', GetoptLong::REQUIRED_ARGUMENT ],
-  [ '-h', GetoptLong::NO_ARGUMENT ]
+  ['-c', GetoptLong::REQUIRED_ARGUMENT],
+  ['-f', GetoptLong::NO_ARGUMENT],
+  ['-h', GetoptLong::NO_ARGUMENT],
+  ['-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['-v', GetoptLong::NO_ARGUMENT]
 
 # Parse given options.
 options.each do |option, argument|
@@ -45,10 +47,13 @@ options.each do |option, argument|
       config_file = argument
     when '-f'
       dofork = true
-    when '-p'
-      pid_file = argument
     when '-h'
       usage_message config_file
+    when '-p'
+      pid_file = argument
+    when '-v'
+      puts TransmissionRSS::VERSION
+      exit
   end
 end
 

data/lib/transmission-rss.rb

@@ -1,7 +1,7 @@
 $:.unshift(File.dirname(__FILE__))
 
 module TransmissionRSS
-	VERSION = '0.1.14'
+	VERSION = '0.1.16'
 end
 
 Dir.glob($:.first + '/**/*.rb').each do |lib|

data/lib/transmission-rss/aggregator.rb

@@ -1,115 +1,107 @@
 require 'etc'
 require 'fileutils'
 require 'open-uri'
+require 'open_uri_redirections'
 require 'rss'
 
-# Class for aggregating torrent files through RSS feeds.
-class TransmissionRSS::Aggregator
-  attr_accessor :feeds
+libdir = File.dirname(__FILE__)
+require File.join(libdir, 'log')
+require File.join(libdir, 'callback')
 
-  def initialize(feeds = [])
-    @feeds = feeds
-    @seen = []
+module TransmissionRSS
+  # Class for aggregating torrent files through RSS feeds.
+  class Aggregator
+    extend Callback
+    callback :on_new_item # Declare callback for new items.
 
-    # Initialize log instance.
-    @log = Log.instance
+    attr_accessor :feeds
 
-    # Declare callback for new items.
-    callback :on_new_item
+    def initialize(feeds = [])
+      @feeds = feeds
+      @seen = []
 
-    # Generate path for seen torrents store file.
-    @seenfile = File.join \
-      Etc.getpwuid.dir,
-      '/.config/transmission/seen-torrents.conf'
+      # Initialize log instance.
+      @log = Log.instance
 
-    # Make directories in path if they are not existing.
-    FileUtils.mkdir_p File.dirname(@seenfile)
+      # Generate path for seen torrents store file.
+      @seenfile = File.join \
+        Etc.getpwuid.dir,
+        '/.config/transmission/seen-torrents.conf'
 
-    # Touch seen torrents store file.
-    unless File.exists? @seenfile
-      FileUtils.touch @seenfile
-    end
+      # Make directories in path if they are not existing.
+      FileUtils.mkdir_p File.dirname(@seenfile)
 
-    # Open file, read torrent URLs and add to +@seen+.
-    open(@seenfile).readlines.each do |line|
-      @seen.push line.chomp
-    end
+      # Touch seen torrents store file.
+      unless File.exists? @seenfile
+        FileUtils.touch @seenfile
+      end
 
-    # Log number of +@seen+ URIs.
-    @log.debug @seen.size.to_s + ' uris from seenfile'
-  end
+      # Open file, read torrent URLs and add to +@seen+.
+      open(@seenfile).readlines.each do |line|
+        @seen.push line.chomp
+      end
 
-  # Get file enclosures from all feeds items and call on_new_item callback
-  # with torrent file URL as argument.
-  def run(interval = 600)
-    @log.debug 'aggregator start'
-
-    while true
-      feeds.each do |url|
-        @log.debug 'aggregate ' + url
-
-        begin
-          content = open(url).readlines.join("\n")
-          items = RSS::Parser.parse(content, false).items
-        rescue
-          @log.debug 'retrieval error'
-          next
-        end
+      # Log number of +@seen+ URIs.
+      @log.debug @seen.size.to_s + ' uris from seenfile'
+    end
+
+    # Get file enclosures from all feeds items and call on_new_item callback
+    # with torrent file URL as argument.
+    def run(interval = 600)
+      @log.debug 'aggregator start'
+
+      while true
+        feeds.each do |url|
+          url = URI.encode(url)
+          @log.debug 'aggregate ' + url
+
+          begin
+            content = open(url, allow_redirections: :safe).read
+            items = RSS::Parser.parse(content, false).items
+          rescue Exception => e
+            @log.debug "retrieval error (#{e.message})"
+            next
+          end
 
-        items.each do |item|
-          link = item.enclosure.url rescue item.link
- 
-          # Item contains no link.
-          next if link.nil?
-
-          # Link is not a String directly.
-          link = link.href if link.class != String
-
-          # The link is not in +@seen+ Array.
-          unless seen? link
-            @log.debug 'on_new_item event ' + link
-            begin
-              on_new_item link
-            rescue Errno::ECONNREFUSED
-#             @log.debug 'not added to seenfile'
-            else
-              add_seen link
+          items.each do |item|
+            link = item.enclosure.url rescue item.link
+   
+            # Item contains no link.
+            next if link.nil?
+
+            # Link is not a String directly.
+            link = link.href if link.class != String
+
+            # The link is not in +@seen+ Array.
+            unless seen? link
+              @log.debug 'on_new_item event ' + link
+              begin
+                on_new_item link
+              rescue Errno::ECONNREFUSED
+#               @log.debug 'not added to seenfile'
+              else
+                add_seen link
+              end
             end
           end
         end
-      end
 
-      sleep interval
+        sleep interval
+      end
     end
-  end
 
-  # To add a link into the list of seen links.
-  def add_seen(link)
-    @seen.push link
+    # To add a link into the list of seen links.
+    def add_seen(link)
+      @seen.push link
 
-    File.open(@seenfile, 'w') do |file|
-      file.write @seen.join("\n")
+      File.open(@seenfile, 'w') do |file|
+        file.write @seen.join("\n")
+      end
     end
-  end
 
-  # To test if a link is in the list of seen links.
-  def seen?(link)
-    @seen.include? link
-  end
-
-  # Method to define callback methods.
-  def callback(*names)
-    names.each do |name|
-      eval <<-EOF
-        @#{name} = false
-        def #{name}(*args, &block)
-          if block
-            @#{name} = block
-          elsif @#{name}
-            @#{name}.call *args
-          end
-        end
-      EOF
+    # To test if a link is in the list of seen links.
+    def seen?(link)
+      @seen.include? link
     end
   end
 end

data/lib/transmission-rss/callback.rb

@@ -0,0 +1,19 @@
+module TransmissionRSS
+  module Callback
+    # Define callback method.
+    def callback(*names)
+      names.each do |name|
+        self.class_eval do
+          define_method name, ->(*args, &block) do
+            @callbacks ||= {}
+            if block
+              @callbacks[name] = block
+            elsif @callbacks[name]
+              @callbacks[name].call *args
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/transmission-rss/client.rb

@@ -2,72 +2,76 @@ require 'net/http'
 require 'json'
 require 'base64'
 
-# Class for communication with transmission utilizing the RPC web interface.
-class TransmissionRSS::Client
-  def initialize(host = 'localhost', port = 9091, timeout: 5)
-    @host, @port, @timeout = host, port, timeout
-    @log = Log.instance
-  end
-
-  # POST json packed torrent add command.
-  def add_torrent(file, type, paused = false)
-    hash = {
-      'method' => 'torrent-add',
-      'arguments' => {
-        'paused' => paused
-      }
-    }
+require File.join(File.dirname(__FILE__), 'log')
 
-    case type
-      when :url
-        hash.arguments.filename = file
-      when :file
-        hash.arguments.metainfo = Base64.encode64(File.read(file))
-      else
-        raise ArgumentError.new 'type has to be :url or :file.'
+module TransmissionRSS
+  # Class for communication with transmission utilizing the RPC web interface.
+  class Client
+    def initialize(host = 'localhost', port = 9091, timeout: 5)
+      @host, @port, @timeout = host, port, timeout
+      @log = TransmissionRSS::Log.instance
     end
 
-    post = Net::HTTP::Post.new \
-      '/transmission/rpc',
-      initheader = {
-        'Content-Type' => 'application/json',
-        'X-Transmission-Session-Id' => get_session_id
+    # POST json packed torrent add command.
+    def add_torrent(file, type, paused = false)
+      hash = {
+        'method' => 'torrent-add',
+        'arguments' => {
+          'paused' => paused
+        }
       }
 
-    post.body = hash.to_json
+      case type
+        when :url
+          hash.arguments.filename = file
+        when :file
+          hash.arguments.metainfo = Base64.encode64(File.read(file))
+        else
+          raise ArgumentError.new 'type has to be :url or :file.'
+      end
 
-    response = request post
+      post = Net::HTTP::Post.new \
+        '/transmission/rpc',
+        initheader = {
+          'Content-Type' => 'application/json',
+          'X-Transmission-Session-Id' => get_session_id
+        }
 
-    result = JSON.parse(response.body).result
+      post.body = hash.to_json
 
-    @log.debug 'add_torrent result: ' + result
-  end
+      response = request post
 
-  # Get transmission session id.
-  def get_session_id
-    get = Net::HTTP::Get.new '/transmission/rpc'
-    response = request get
+      result = JSON.parse(response.body).result
 
-    id = response.header['x-transmission-session-id']
+      @log.debug 'add_torrent result: ' + result
+    end
 
-    @log.debug 'got session id ' + id
+    # Get transmission session id.
+    def get_session_id
+      get = Net::HTTP::Get.new '/transmission/rpc'
+      response = request get
 
-    id
-  end
+      id = response.header['x-transmission-session-id']
+
+      @log.debug 'got session id ' + id
+
+      id
+    end
 
-  private
+    private
 
-  def request(data)
-    Timeout::timeout(@timeout) do
-      Net::HTTP.new(@host, @port).start do |http|
-        http.request data
+    def request(data)
+      Timeout::timeout(@timeout) do
+        Net::HTTP.new(@host, @port).start do |http|
+          http.request data
+        end
       end
+    rescue Errno::ECONNREFUSED
+      @log.debug 'connection refused'
+      raise
+    rescue Timeout::Error
+      @log.debug 'connection timeout'
+      raise
     end
-  rescue Errno::ECONNREFUSED
-    @log.debug 'connection refused'
-    raise
-  rescue Timeout::Error
-    @log.debug 'connection timeout'
-    raise
   end
 end

data/lib/transmission-rss/config.rb

@@ -1,25 +1,27 @@
 require 'singleton'
 require 'yaml'
 
-# Class handles configuration parameters.
-class TransmissionRSS::Config < Hash
-  # This is a singleton class.
-  include Singleton
+module TransmissionRSS
+  # Class handles configuration parameters.
+  class Config < Hash
+    # This is a singleton class.
+    include Singleton
 
-  # Merges a Hash or YAML file (containing a Hash) with itself.
-  def load(config)
-    if config.class == Hash
-      self.merge! config
-      return
+    # Merges a Hash or YAML file (containing a Hash) with itself.
+    def load(config)
+      case config.class.to_s
+      when 'Hash'
+        self.merge! config
+      when 'String'
+        self.merge_yaml! config
+      else
+        raise ArgumentError.new 'Could not load config.'
+      end
     end
 
-    unless config.nil?
-      self.merge_yaml! config
+    # Merge Config Hash with Hash from YAML file.
+    def merge_yaml!(path)
+      self.merge! YAML.load_file(path)
     end
   end
-
-  # Merge Config Hash with Hash from YAML file.
-  def merge_yaml!(path)
-    self.merge! YAML.load_file(path)
-  end
 end

data/lib/transmission-rss/log.rb

@@ -1,24 +1,26 @@
 require 'logger'
 require 'singleton'
 
-# Encapsulates Logger as a singleton class.
-class TransmissionRSS::Log
-  include Singleton
+module TransmissionRSS
+  # Encapsulates Logger as a singleton class.
+  class Log
+    include Singleton
 
-  # Change log target (IO or path to a file as String).
-  def target=(target)
-    old_logger = @logger
-    @logger = Logger.new target
+    # Change log target (IO or path to a file as String).
+    def target=(target)
+      old_logger = @logger
+      @logger = Logger.new target
 
-    if old_logger
-      @logger.level = old_logger.level
-      @logger.formatter = old_logger.formatter
+      if old_logger
+        @logger.level = old_logger.level
+        @logger.formatter = old_logger.formatter
+      end
     end
-  end
 
-  # If this class misses a method, call it on the encapsulated Logger class.
-  def method_missing(sym, *args)
-    @logger ||= Logger.new $stderr
-    @logger.send sym, *args
+    # If this class misses a method, call it on the encapsulated Logger class.
+    def method_missing(sym, *args)
+      @logger ||= Logger.new $stderr
+      @logger.send sym, *args
+    end
   end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - henning mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
-dependencies: []
+date: 2014-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 description: |-
   transmission-rss is basically a workaround for
       transmission's lack of the ability to monitor RSS feeds and
@@ -26,6 +46,7 @@ files:
 - bin/transmission-rss
 - lib/transmission-rss.rb
 - lib/transmission-rss/aggregator.rb
+- lib/transmission-rss/callback.rb
 - lib/transmission-rss/client.rb
 - lib/transmission-rss/config.rb
 - lib/transmission-rss/hash.rb