transmission-rss 1.0.0.alpha1 → 1.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 054764ff1a7340698a20d891b084e2a3763898be
-  data.tar.gz: cd4df944492cfb88e2602be7b02adac5ff3a93e9
+SHA256:
+  metadata.gz: 6549e5b8d06f19b6c8ff392677d66f0a5519ac73d39192522388eb0ed2b1bceb
+  data.tar.gz: 0fbd398d1a32c27b573a45228cdfd8b920010a627b3f3e46461a6ecd981750bb
 SHA512:
-  metadata.gz: 5ca44ab44a99dee02cb406a5a8e537136a95c64fc1193f74b34aa80a248288ad3cc5823367adaa4a2a6af605d3129a45eac14c97fe7178811c7a9b59af4f671b
-  data.tar.gz: a5031c612c6d8b5c8677ab338ed27c48c0095bae7829df1b908b591f4d34b5b8e8c20a70aa7c655d82e7985d4f2cc37e32b0f66b80cfe1a3954b131c1d8bff8b
+  metadata.gz: e14bfa9e9f86b4e52e1738d55752fa852bb4416eb0827be329db5688d5c13f1ca75a6f11df23388d5ed5242110b5704260fbf7ba460b28c06495062b742f3302
+  data.tar.gz: cfe725811a2ecbe457dfbda0451f59e99b6da4c5b48343db4753d7c4897976336b7c0d20eb45a6a6443284b7fea29bcda507990c62b6e40fe16dbce3b3d3b623

data/README.md

@@ -52,6 +52,10 @@ can override some options for their transmission-rss instances by providing a
 config at `~/.config/transmission-rss/config.yml` (or in `$XDG_CONFIG_HOME`
 instead of `~/.config`).
 
+**WARNING:** If you want to override a nested option like `log.target` you also
+have to explicitly specify the others like `log.level`. (True for categories
+`server`, `login`, `log`, `privileges`, and `client`.)
+
 ### Minimal example
 
 It should at least contain a list of feeds:
@@ -90,12 +94,14 @@ is true:
 ### All available options
 
 The following configuration file example contains every existing option
-(although `update_interval`, `add_paused`, `server`, `fork`, and `pid_file` are
-default values and could be omitted). The default `log_target` is STDERR.
-`privileges` is not defined by default, so the script runs as current
+(although `update_interval`, `add_paused`, `server`, `log`, `fork`, and
+`pid_file` are default values and could be omitted). The default `log.target` is
+STDERR. `privileges` is not defined by default, so the script runs as current
 user/group. `login` is also not defined by default. It has to be defined, if
 transmission is configured for HTTP basic authentication.
 
+See `./transmission-rss.conf.example` for more documentation.
+
     feeds:
       - url: http://example.com/feed1
       - url: http://example.com/feed2
@@ -133,7 +139,9 @@ transmission is configured for HTTP basic authentication.
       username: transmission
       password: transmission
 
-    log_target: /var/log/transmissiond-rss.log
+    log:
+      target: /var/log/transmissiond-rss.log
+      level: debug
 
     privileges:
       user: nobody

data/bin/transmission-add-file

@@ -46,12 +46,12 @@ config = TransmissionRSS::Config.instance
 
 # Initialize a log instance and configure it.
 log = Log.instance
-log.target = config.log_target
 
 # Load config file (default or given by argument).
 begin
   config.load(config_file)
-  log.target = config.log_target
+  log.target = config.log.target
+  log.level  = config.log.level
 rescue Errno::ENOENT
   log.error(config_file + ' not found')
 end

data/bin/transmission-rss

@@ -77,12 +77,12 @@ config = TransmissionRSS::Config.instance
 
 # Initialize a log instance and configure it.
 log = Log.instance
-log.target = config.log_target
 
 # Load config file (default or given by argument).
 begin
   config.load(config_file)
-  log.target = config.log_target
+  log.target = config.log.target
+  log.level  = config.log.level
 rescue Errno::ENOENT
   log.error(config_file + ' not found')
 end
@@ -100,7 +100,7 @@ if !(custom_config || ENV['HOME'].nil?)
 end
 
 # Print current config.
-log.debug('version ' + VERSION)
+log.info('transmission-rss ' + VERSION)
 log.debug(config)
 
 # Fork value from command line.
@@ -156,6 +156,11 @@ end
 # Callback for changes to the config.
 config.on_change do
   aggregator.reinitialize!(config.feeds, seen_file: config.seen_file)
+
+  if reset_seen_file
+    aggregator.seen.clear!
+    log.debug('seenfile reset after config change')
+  end
 end
 
 # Start the aggregation process.

data/lib/transmission-rss/config.rb

@@ -8,6 +8,10 @@ require File.join(libdir, 'log')
 require File.join(libdir, 'callback')
 
 module TransmissionRSS
+  DEPRECATED = {
+    log_target: 'log.target'
+  }
+
   # Class handles configuration parameters.
   class Config < Hash
     # This is a singleton class.
@@ -24,15 +28,17 @@ module TransmissionRSS
     end
 
     # Merges a Hash or YAML file (containing a Hash) with itself.
-    def load(config)
+    def load(config, watch: true)
       case config.class.to_s
       when 'Hash'
         self.merge!(config)
       when 'String'
-        self.merge_yaml!(config)
+        self.merge_yaml!(config, watch)
       else
         raise ArgumentError.new('Could not load config.')
       end
+
+      check_deprecated
     end
 
     def merge_defaults!
@@ -46,7 +52,10 @@ module TransmissionRSS
           'rpc_path' => '/transmission/rpc'
         },
         'login' => nil,
-        'log_target' => $stderr,
+        'log' => {
+          'target' => $stderr,
+          'level' => :debug
+        },
         'fork' => false,
         'pid_file' => false,
         'privileges' => {},
@@ -70,7 +79,6 @@ module TransmissionRSS
 
     def watch_file(path)
       path = Pathname.new(path).realpath.to_s
-      @log.debug('watch_file ' + path)
 
       @notifier ||= INotify::Notifier.new
       @notifier.watch(path, :close_write) do |e|
@@ -87,5 +95,15 @@ module TransmissionRSS
         @notifier.run
       end
     end
+
+    private
+
+    def check_deprecated
+      DEPRECATED.each do |key, value|
+        if self[key.to_s]
+          @log.warn('[DEPRECATED] option %s, use %s' % [key, value])
+        end
+      end
+    end
   end
 end

data/lib/transmission-rss/log.rb

@@ -6,30 +6,42 @@ module TransmissionRSS
   class Log
     include Singleton
 
-    def initialize(target = $stderr)
-      old_logger = @logger
-      @logger ||= Logger.new(target)
-
-      if old_logger
-        @logger.level = old_logger.level
-        @logger.formatter = old_logger.formatter
-      else
-        @logger.level = Logger::DEBUG
-        @logger.formatter = proc do |sev, time, _, msg|
-          time = time.strftime('%Y-%m-%d %H:%M:%S')
-          "#{time} (#{sev.downcase}) #{msg}\n"
-        end
+    def initialize(target = $stderr, level = :debug)
+      @target = target
+      @level = level
+
+      @logger = Logger.new(target)
+      @logger.level = to_level_const(level)
+      @logger.formatter = proc do |sev, time, _, msg|
+        time = time.strftime('%Y-%m-%d %H:%M:%S')
+        "#{time} (#{sev.downcase}) #{msg}\n"
       end
     end
 
-    # Change log target (IO or path to a file as String).
+    # Change log target (IO, path to a file as String, or Symbol for IO
+    # constant).
     def target=(target)
-      initialize(target)
+      if target.is_a? Symbol
+        target = Object.const_get(target.to_s.upcase)
+      end
+
+      initialize(target, @level)
+    end
+
+    # Change log level (String or Symbol)
+    def level=(level)
+      initialize(@target, level)
     end
 
     # If this class misses a method, call it on the encapsulated Logger class.
     def method_missing(sym, *args)
       @logger.send(sym, *args)
     end
+
+    private
+
+    def to_level_const(level)
+      Object.const_get('Logger::' + level.to_s.upcase)
+    end
   end
 end

data/lib/transmission-rss/seen_file.rb

@@ -7,18 +7,12 @@ module TransmissionRSS
   # Persist seen torrent URLs
   class SeenFile
     extend ::Forwardable
-
-    DEFAULT_LEGACY_PATH =
-      File.join(Etc.getpwuid.dir, '.config/transmission/seen-torrents.conf')
-
-    DEFAULT_PATH =
-      File.join(Etc.getpwuid.dir, '.config/transmission/seen')
     
     def_delegators :@seen, :size, :to_a
 
     def initialize(path = nil, legacy_path = nil)
-      @legacy_path = legacy_path || DEFAULT_LEGACY_PATH
-      @path        = path || DEFAULT_PATH
+      @legacy_path = legacy_path || default_legacy_path
+      @path        = path || default_path
 
       initialize_path!
       migrate!
@@ -49,6 +43,14 @@ module TransmissionRSS
 
     private
 
+    def default_legacy_path
+      File.join(Etc.getpwuid.dir, '.config/transmission/seen-torrents.conf')
+    end
+
+    def default_path
+      File.join(Etc.getpwuid.dir, '.config/transmission/seen')
+    end
+
     def digest(s)
       Digest::SHA256.hexdigest(s)
     end

data/lib/transmission-rss/version.rb

@@ -1,3 +1,3 @@
 module TransmissionRSS
-  VERSION = '1.0.0.alpha1'
+  VERSION = '1.0.0.alpha2'
 end

data/transmission-rss.conf.example

@@ -2,6 +2,11 @@
 # Indent consistently with spaces!
 # Format documentation on http://www.yaml.org/.
 #
+# WARNING:
+#   If you want to override a nested option like `log.target` you also have to
+#   explicitly specify the others like `log.level`. (True for categories
+#   `server`, `login`, `log`, `privileges`, and `client`.)
+#
 
 # List of feeds to watch.
 
@@ -48,9 +53,14 @@ feeds:
 #  username: transmission
 #  password: transmission
 
-# Where to log. Default is stderr.
+# Where to log. Default target is stderr, level debug. Target can be IO symbol
+# (e.g. ":stderr", ":stdout") or file path (e.g.
+# "/var/log/transmission-rss.log"). Level can be "error", "warn", "info",
+# "debug".
 
-#log_target: /var/log/transmissiond-rss.log
+#log:
+#  target: :stderr
+#  level: debug
 
 # Drop privileges. If omitted, privileges are not dropped.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - henning mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.7
+        version: 0.9.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.7
+        version: 0.9.10
 description: |-
   transmission-rss is basically a workaround for
       transmission's lack of the ability to monitor RSS feeds and
@@ -86,7 +86,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Adds torrents from rss feeds to transmission web frontend.