transmission-rss 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea88824f2d84f31c4d99115476ee41d4518792d3
-  data.tar.gz: e57d1fea7be21f88314d844cffc6a0e0badb43eb
+  metadata.gz: a8eb08d11496d24bd539bd17237ea5aa523b362a
+  data.tar.gz: 26f4c37a9e38353be0cf07dd3e58aa4f8e64a9be
 SHA512:
-  metadata.gz: c5c22c8a56c39209b1e2f5297f77f656c50264267f087e72e40dd90350f0937ee697f9e4f06fd12a0f21af4a2fd0cc62dd3e7dca20fc951d0a44e0c9d218c32e
-  data.tar.gz: 4e120ff3149b59873f8b5d51113e3a284ab6351ab9b23c2ef5c49e9c563434fc94fbf051d77c157a297c379b1652a4881291bd8f1f85d0ed7f8e36e45487bece
+  metadata.gz: 6b26fdbcee2bf111a750a1aab971414e9c9ea28caea33a759c1e31b7bd7055a8048d5d710ed80d45f432a59ddf905f1647392cb6999c28f48994f8a89947da65
+  data.tar.gz: 93196eb479cbcedd731f2db63aae7e5c1da222f31b9dcd28ee8ffee5b330acd501bb7304b101236b1885cbbcafc1768035fd3a6cab9c6bbd447111ee76acc73a

data/README.rdoc

@@ -28,7 +28,7 @@ code to the single most delightful human being: Ann.
  git clone git://git.orgizm.net/transmission-rss.git
  cd transmission-rss
  gem build transmission-rss.gemspec
- sudo gem install transmission-rss-*.gem
+ gem install transmission-rss-*.gem
 
 == Configuration
 
@@ -67,6 +67,10 @@ not defined by default, so the script runs as current user/group.
    user: nobody
    group: nobody
 
+ fork: false
+
+ pid_file: false
+
 == TODO
 
 * Better library abilities.

data/bin/transmission-rss

@@ -14,13 +14,17 @@ config_file = '/etc/transmission-rss.conf'
 # Do not fork by default.
 dofork = false
 
+# No PID file by default.
+pid_file = false
+
 # Shows a summary of the command line options.
-def usage_message( config_file )
-  $stderr << "#{File.basename($0)} [option]..
+def usage_message(config_file)
+  $stderr << "#{File.basename $0} [option]..
 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.
 
 "
@@ -28,21 +32,23 @@ Adds torrents from rss feeds to transmission web frontend.
 end
 
 # Define command-line options.
-options = GetoptLong.new(
+options = GetoptLong.new \
   [ '-c', GetoptLong::REQUIRED_ARGUMENT ],
   [ '-f', GetoptLong::NO_ARGUMENT ],
+  [ '-p', GetoptLong::REQUIRED_ARGUMENT ],
   [ '-h', GetoptLong::NO_ARGUMENT ]
-)
 
 # Parse given options.
 options.each do |option, argument|
-  case(option)
+  case option
     when '-c'
       config_file = argument
     when '-f'
       dofork = true
+    when '-p'
+      pid_file = argument
     when '-h'
-      usage_message(config_file)
+      usage_message config_file
   end
 end
 
@@ -51,7 +57,7 @@ end
 config = TransmissionRSS::Config.instance
 
 # Default configuration.
-config.load({
+defaults = {
   'feeds' => [],
   'update_interval' => 600,
   'add_paused' => false,
@@ -60,8 +66,11 @@ config.load({
     'port' => 9091
   },
   'log_target' => $stderr,
+  'fork' => false,
+  'pid_file' => false,
   'privileges' => {}
-})
+}
+config.load defaults
 
 # Initialize a log instance and configure it.
 log = Log.instance
@@ -73,73 +82,75 @@ end
 
 # Load config file (default or given by argument).
 begin
-  config.load(config_file)
+  config.load config_file
   log.target = config.log_target
 rescue Errno::ENOENT
-  log.error(config_file + ' not found')
+  log.error config_file + ' not found'
 end
-log.debug(config)
+log.debug config
+
+# Fork value from command line.
+config.fork = dofork if dofork
+
+# PID file path from command line.
+config.pid_file = pid_file if pid_file
 
 # Drop privileges, if section is given in config file.
-if(not config.privileges.empty?)
-  Process::Sys.setgid(
+unless config.privileges.empty?
+  Process::Sys.setgid \
     Etc.getgrnam(config.privileges.group).gid
-  )
 
-  Process::Sys.setuid(
+  Process::Sys.setuid \
     Etc.getpwnam(config.privileges.user).uid
-  )
 
-  log.debug(
+  log.debug \
     'dropped privileges ' +
     config.privileges.user +
     ':' +
     config.privileges.group
-  )
 else
-  log.debug('no privilege dropping')
+  log.debug 'no privilege dropping'
 end
 
 # Warn if no feeds are given.
-if(config.feeds.empty?)
-  log.warn('no feeds given')
-end
+log.warn 'no feeds given' if config.feeds.empty?
 
 # Connect reload of config file to SIGHUP.
-trap('HUP') do
-  config.load(config_file)
-  log.info('got hup', config)
+trap 'HUP' do
+  config.load config_file rescue nil
 end
 
 # Initialize feed aggregator.
 aggregator = Aggregator.new
 
 # Initialize communication to transmission.
-client = Client.new(config.server.host, config.server.port)
+client = Client.new config.server.host, config.server.port
 
 # Add feeds from config file to +Aggregator+ class.
-aggregator.feeds.concat(config.feeds)
+aggregator.feeds.concat config.feeds
 
 # Callback for a new item on one of the feeds.
 aggregator.on_new_item do |torrent_file|
-  Thread.start do
-    client.add_torrent(torrent_file, :url, config.add_paused)
-  end
+  Thread.start { client.add_torrent torrent_file, :url, config.add_paused }
+end
+
+# Save PID.
+if config.pid_file
+  log.debug 'wrote pid to ' + config.pid_file
+  File.write config.pid_file, Process.pid
 end
 
 # Start the aggregation process.
 begin
-  if(dofork)
-    pid = fork do
-      aggregator.run(config.update_interval)
-    end
-
-    puts('forked ' + pid.to_s)
+  if config.fork
+    pid = fork { aggregator.run config.update_interval }
+    log.debug 'forked ' + pid.to_s
   else
-    aggregator.run(config.update_interval)
+    log.debug 'pid ' + Process.pid.to_s
+    aggregator.run config.update_interval
   end
 rescue Interrupt
-  log.info('interrupt caught')
+  log.info 'interrupt caught'
 end
 
 log.close

data/lib/transmission-rss.rb

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

data/lib/transmission-rss/aggregator.rb

@@ -15,45 +15,44 @@ class TransmissionRSS::Aggregator
     @log = Log.instance
 
     # Declare callback for new items.
-    callback(:on_new_item)
+    callback :on_new_item
 
     # Generate path for seen torrents store file.
-    @seenfile = File.join(
+    @seenfile = File.join \
       Etc.getpwuid.dir,
       '/.config/transmission/seen-torrents.conf'
-    )
 
     # Make directories in path if they are not existing.
-    FileUtils.mkdir_p(File.dirname(@seenfile))
+    FileUtils.mkdir_p File.dirname(@seenfile)
 
     # Touch seen torrents store file.
-    if(not File.exists?(@seenfile))
-      FileUtils.touch(@seenfile)
+    unless File.exists? @seenfile
+      FileUtils.touch @seenfile
     end
 
     # Open file, read torrent URLs and add to +@seen+.
     open(@seenfile).readlines.each do |line|
-      @seen.push(line.chomp)
+      @seen.push line.chomp
     end
 
     # Log number of +@seen+ URIs.
-    @log.debug(@seen.size.to_s + ' uris from seenfile')
+    @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')
+    @log.debug 'aggregator start'
 
-    while(true)
+    while true
       feeds.each do |url|
-        @log.debug('aggregate ' + url)
+        @log.debug 'aggregate ' + url
 
         begin
           content = open(url).readlines.join("\n")
           items = RSS::Parser.parse(content, false).items
         rescue
-          @log.debug('retrieval error')
+          @log.debug 'retrieval error'
           next
         end
 
@@ -61,41 +60,37 @@ class TransmissionRSS::Aggregator
           link = item.enclosure.url rescue item.link
  
           # Item contains no link.
-          if(link.nil?)
-            next
-          end
+          next if link.nil?
 
           # Link is not a String directly.
-          if(link.class != String)
-            link = link.href
-          end
+          link = link.href if link.class != String
 
           # The link is not in +@seen+ Array.
-          if(not seen?(link))
-            on_new_item(link)
-            @log.debug('on_new_item event ' + link)
+          unless seen? link
+            on_new_item link
+            @log.debug 'on_new_item event ' + link
 
-            add_seen(link)
+            add_seen link
           end
         end
       end
 
-      sleep(interval)
+      sleep interval
     end
   end
 
   # To add a link into the list of seen links.
   def add_seen(link)
-    @seen.push(link)
+    @seen.push link
 
     File.open(@seenfile, 'w') do |file|
-      file.write(@seen.join("\n"))
+      file.write @seen.join("\n")
     end
   end
 
   # To test if a link is in the list of seen links.
   def seen?(link)
-    @seen.include?(link)
+    @seen.include? link
   end
 
   # Method to define callback methods.
@@ -104,10 +99,10 @@ class TransmissionRSS::Aggregator
       eval <<-EOF
         @#{name} = false
         def #{name}(*args, &block)
-          if(block)
+          if block
             @#{name} = block
-          elsif(@#{name})
-            @#{name}.call(*args)
+          elsif @#{name}
+            @#{name}.call *args
           end
         end
       EOF

data/lib/transmission-rss/client.rb

@@ -17,15 +17,13 @@ class TransmissionRSS::Client
 
   # Get transmission session id by simple GET.
   def get_session_id
-    get = Net::HTTP::Get.new(
-      '/transmission/rpc'
-    )
+    get = Net::HTTP::Get.new '/transmission/rpc'
 
 #   retries = 3
 #   begin
 #     Timeout::timeout(5) do
         response = Net::HTTP.new(@host, @port).start do |http|
-          http.request(get)
+          http.request get
         end
 #     end
 #   rescue Timeout::Error
@@ -41,7 +39,7 @@ class TransmissionRSS::Client
 
     id = response.header['x-transmission-session-id']
 
-    @log.debug('got session id ' + id)
+    @log.debug 'got session id ' + id
 
     id
   end
@@ -49,9 +47,9 @@ class TransmissionRSS::Client
   # POST json packed torrent add command.
   def add_torrent(file, type, paused = false)
     hash = {
-      "method" => "torrent-add",
-      "arguments" => {
-        "paused" => paused
+      'method' => 'torrent-add',
+      'arguments' => {
+        'paused' => paused
       }
     }
 
@@ -59,20 +57,17 @@ class TransmissionRSS::Client
       when :url
         hash.arguments.filename = file
       when :file
-        hash.arguments.metainfo = Base64.encode64(
-          File.readlines(file).join
-        )
+        hash.arguments.metainfo = Base64.encode64 File.readlines(file).join
       else
-        raise ArgumentError.new('type has to be :url or :file.')
+        raise ArgumentError.new 'type has to be :url or :file.'
     end
 
-    post = Net::HTTP::Post.new(
+    post = Net::HTTP::Post.new \
       '/transmission/rpc',
       initheader = {
         'Content-Type' => 'application/json',
         'X-Transmission-Session-Id' => get_session_id
       }
-    )
 
     post.body = hash.to_json
 
@@ -80,7 +75,7 @@ class TransmissionRSS::Client
 #   begin
 #     Timeout::timeout(5) do
         response = Net::HTTP.new(@host, @port).start do |http|
-          http.request(post)
+          http.request post
         end
 #     end
 #   rescue Timeout::Error
@@ -96,6 +91,6 @@ class TransmissionRSS::Client
 
     result = JSON.parse(response.body).result
 
-    @log.debug('add_torrent result: ' + result)
+    @log.debug 'add_torrent result: ' + result
   end
 end

data/lib/transmission-rss/config.rb

@@ -8,18 +8,18 @@ class TransmissionRSS::Config < Hash
 
   # Merges a Hash or YAML file (containing a Hash) with itself.
   def load(config)
-    if(config.class == Hash)
-      self.merge!(config)
+    if config.class == Hash
+      self.merge! config
       return
     end
 
-    if(not config.nil?)
-      self.merge_yaml!(config)
+    unless config.nil?
+      self.merge_yaml! config
     end
   end
 
   # Merge Config Hash with Hash from YAML file.
   def merge_yaml!(path)
-    self.merge!(YAML.load_file(path))
+    self.merge! YAML.load_file(path)
   end
 end

data/lib/transmission-rss/hash.rb

@@ -3,10 +3,10 @@ class Hash
   # method has an argument (for example by "method="), the key called "method"
   # is set to the respective argument.
   def method_missing(symbol, *args)
-    if(args.size == 0)
+    if args.size == 0
       self[symbol.to_s]
     else
-      self[symbol.to_s.slice(0..-2)] = args.first
+      self[symbol.to_s.slice 0..-2] = args.first
     end
   end
 end

data/lib/transmission-rss/log.rb

@@ -8,9 +8,9 @@ class TransmissionRSS::Log
   # Change log target (IO or path to a file as String).
   def target=(target)
     old_logger = @logger
-    @logger = Logger.new(target)
+    @logger = Logger.new target
 
-    if(old_logger)
+    if old_logger
       @logger.level = old_logger.level
       @logger.formatter = old_logger.formatter
     end
@@ -18,7 +18,7 @@ class TransmissionRSS::Log
 
   # 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)
+    @logger ||= Logger.new $stderr
+    @logger.send sym, *args
   end
 end

data/transmission-rss.conf.example

@@ -32,3 +32,11 @@ feeds:
 #privileges:
 #  user: nobody
 #  group: nobody
+
+# Fork?
+
+#fork: false
+
+# Save PID.
+
+#pid_file: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - henning mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2014-01-19 00:00:00.000000000 Z
 dependencies: []
 description: |-
   transmission-rss is basically a workaround for
@@ -21,18 +21,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.rdoc
 - bin/transmission-add-file
 - bin/transmission-rss
 - lib/transmission-rss.rb
-- lib/transmission-rss/config.rb
-- lib/transmission-rss/log.rb
+- lib/transmission-rss/aggregator.rb
 - lib/transmission-rss/client.rb
+- lib/transmission-rss/config.rb
 - lib/transmission-rss/hash.rb
-- lib/transmission-rss/aggregator.rb
-- README.rdoc
+- lib/transmission-rss/log.rb
 - transmission-rss.conf.example
 homepage: https://rubygems.org/gems/transmission-rss
-licenses: []
+licenses:
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -40,17 +41,17 @@ 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.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Adds torrents from rss feeds to transmission web frontend.