transmission-rss 1.0.0.beta1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06335ae55c5547575753c5e83595a32918b5acf583ee8a89e6ccbd4ba016dcac
-  data.tar.gz: b6132be027c0be9bfd3570a0d39f0230bbeade5d0aa9a34e5d6c2e157c0acce0
+  metadata.gz: e93a561f40bd628318cf507101b393624547251369fc6cc0557f280afaabf194
+  data.tar.gz: f743d335aac56c1130ae2fd6c85f6d6a2f8ee0cd91ad8128df0309d97b880de9
 SHA512:
-  metadata.gz: 83ab6f33442032dda0d7366291b91ab70cd866e8d2666bb49489ade302a3ca41010fef97a04af0e8fce2572a8be0c4a3f335b7ba52a34e9bb46b6e1e8ca553a9
-  data.tar.gz: 0deda4306c1937d5124344566c51f155f2b7befa1cff4a7dc67ac740ca854a033ff32d0da21ad2e4b3165a45afb350c3b41c792bd44a14198773d4a306ffad01
+  metadata.gz: af81937243076628a610f49f6f28dfccbfeba3377964705c976e870f1e9c496ae9c03c50d16fb834823ccb258ccbe78bafd33502670e49900935ab1f0971d81f
+  data.tar.gz: c0e00180d4c23177d92d004ca08a8b53a40cb22bd09e6e3231acc7f0b60865c1750e236f72bcbc58aa1935193dd6364e82ef8ff408c1edc7af41c99e12e299b1

data/README.md

@@ -23,26 +23,36 @@ code to the single most delightful human being: Ann.
 The minimum supported Ruby version is 2.1. (You will need `rbenv` if your
 os does not support Ruby >= 2.1, e.g. on Debian wheezy.)
 
+**Note, that this README is for the current development branch!** You can find
+a link to a suitable README for your version
+[on the releases page](https://github.com/nning/transmission-rss/releases).
+
 Installation
 ------------
 
 ### Latest stable version from rubygems.org
 
-    gem install transmission-rss
+```sh
+gem install transmission-rss
+```
 
 ### From source
 
-    git clone https://github.com/nning/transmission-rss
-    cd transmission-rss
-    bundle
-    gem build transmission-rss.gemspec
-    gem install transmission-rss-*.gem
+```sh
+git clone https://github.com/nning/transmission-rss
+cd transmission-rss
+bundle
+gem build transmission-rss.gemspec
+gem install transmission-rss-*.gem
+```
 
 ### Via Docker
 
-    docker run \
-      -v $(pwd)/transmission-rss.conf:/etc/transmission-rss.conf \
-      nning2/transmission-rss
+```sh
+docker run -t \
+  -v $(pwd)/transmission-rss.conf:/etc/transmission-rss.conf \
+  nning2/transmission-rss:v1.0.0
+```
 
 Configuration
 -------------
@@ -60,41 +70,54 @@ have to explicitly specify the others like `log.level`. (True for categories
 
 It should at least contain a list of feeds:
 
-    feeds:
-      - url: http://example.com/feed1
-      - url: http://example.com/feed2
+```yaml
+feeds:
+  - url: http://example.com/feed1
+  - url: http://example.com/feed2
+```
 
 Feed item titles can be filtered by a regular expression:
 
-    feeds:
-      - url: http://example.com/feed1
-        regexp: foo
-      - url: http://example.com/feed2
-        regexp: (foo|bar)
+```yaml
+feeds:
+  - url: http://example.com/feed1
+    regexp: foo
+  - url: http://example.com/feed2
+    regexp: (foo|bar)
+```
 
 Feeds can also be configured to download files to specific directory:
 
-    feeds:
-      - url: http://example.com/feed1
-        download_path: /home/user/Downloads
+
+```yaml
+feeds:
+  - url: http://example.com/feed1
+    download_path: /home/user/Downloads
+```
 
 Setting the seed ratio limit is supported per feed:
 
-    feeds:
-      - url: http://example.com/feed1
-        seed_ratio_limit: 0
+
+```yaml
+feeds:
+  - url: http://example.com/feed1
+    seed_ratio_limit: 0
+```
 
 Configurable certificate validation, good for self-signed certificates. Default
 is true:
 
-    feeds:
-      - url: http://example.com/feed1
-        validate_cert: false
+
+```yaml
+feeds:
+  - url: http://example.com/feed1
+    validate_cert: false
+```
 
 ### All available options
 
 The following configuration file example contains every existing option
-(although `update_interval`, `add_paused`, `server`, `log`, `fork`, and
+(although `update_interval`, `add_paused`, `server`, `log`, `fork`, `single`, 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
@@ -102,79 +125,95 @@ 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
-      - url: http://example.com/feed3
-        regexp: match1
-      - url: http://example.com/feed4
-        regexp: (match1|match2)
-      - url: http://example.com/feed5
-        download_path: /home/user/Downloads
-      - url: http://example.com/feed6
-        seed_ratio_limit: 1
-      - url: http://example.com/feed7
-        regexp:
-          - match1
-          - match2
-      - url: http://example.com/feed8
-        regexp:
-          - matcher: match1
-            download_path: /home/user/match1
-          - matcher: match2
-            download_path: /home/user/match2
-      - url: http://example.com/feed9
-        validate_cert: false
-
-    update_interval: 600
-
-    add_paused: false
-
-    server:
-      host: localhost
-      port: 9091
-      rpc_path: /transmission/rpc
-
-    login:
-      username: transmission
-      password: transmission
-
-    log:
-      target: /var/log/transmissiond-rss.log
-      level: debug
-
-    privileges:
-      user: nobody
-      group: nobody
-
-    client:
-      timeout: 5
-
-    fork: false
-
-    pid_file: false
-
-    seen_file: ~/.config/transmission/seen
+
+```yaml
+feeds:
+  - url: http://example.com/feed1
+  - url: http://example.com/feed2
+  - url: http://example.com/feed3
+    regexp: match1
+  - url: http://example.com/feed4
+    regexp: (match1|match2)
+  - url: http://example.com/feed5
+    download_path: /home/user/Downloads
+  - url: http://example.com/feed6
+    seed_ratio_limit: 1
+  - url: http://example.com/feed7
+    regexp:
+      - match1
+      - match2
+  - url: http://example.com/feed8
+    regexp:
+      - matcher: match1
+        download_path: /home/user/match1
+      - matcher: match2
+        download_path: /home/user/match2
+  - url: http://example.com/feed9
+    validate_cert: false
+
+update_interval: 600
+
+add_paused: false
+
+server:
+  host: localhost
+  port: 9091
+  tls: false
+  rpc_path: /transmission/rpc
+
+login:
+  username: transmission
+  password: transmission
+
+log:
+  target: /var/log/transmissiond-rss.log
+  level: debug
+
+privileges:
+  user: nobody
+  group: nobody
+
+client:
+  timeout: 5
+
+fork: false
+
+single: false
+
+pid_file: false
+
+seen_file: ~/.config/transmission/seen
+```
 
 Daemonized Startup
 ------------------
 
+### As a systemd service
+
 The following content can be saved into
 `/etc/systemd/system/transmission-rss.service` to create a systemd unit.
 Remember checking the path in `ExecStart`.
 
-    [Unit]
-    Description=Transmission RSS daemon.
-    After=network.target transmission-daemon.service
+```ini
+[Unit]
+Description=Transmission RSS daemon.
+After=network.target transmission-daemon.service
 
-    [Service]
-    Type=forking
-    ExecStart=/usr/local/bin/transmission-rss -f
-    ExecReload=/bin/kill -s HUP $MAINPID
+[Service]
+Type=forking
+ExecStart=/usr/local/bin/transmission-rss -f
+ExecReload=/bin/kill -s HUP $MAINPID
 
-    [Install]
-    WantedBy=multi-user.target
+[Install]
+WantedBy=multi-user.target
+```
 
 The unit files are reloaded by `systemctl daemon-reload`. You can then start
 transmission-rss by running `systemctl start transmission-rss`. Starting on
 boot, can be enabled `systemctl enable transmission-rss`.
+
+### As a cronjob
+
+`transmission-rss` can also be started in a single run mode, in which it runs a single loop and then exits. To do so, `transmission-rss` needs to be started with the `-s` flag. An example crontab line for running every 10 minutes can be:
+
+`*/10 * * * * /usr/local/bin/transmission-rss -s`

data/bin/transmission-rss

@@ -20,6 +20,9 @@ end
 # Do not fork by default.
 dofork = false
 
+# Do not run single time by default.
+dosingle = false
+
 # No PID file by default.
 pid_file = false
 
@@ -33,6 +36,7 @@ Adds torrents from rss feeds to transmission web frontend.
 
   -c <file>   Custom config file path. Default: #{config_file}
   -f          Fork into background after startup.
+  -s          Single run mode.
   -h          This help.
   -p <file>   Write PID to file.
   -r          Reset seenfile on startup.
@@ -46,6 +50,7 @@ end
 options = GetoptLong.new \
   ['-c', GetoptLong::REQUIRED_ARGUMENT],
   ['-f', GetoptLong::NO_ARGUMENT],
+  ['-s', GetoptLong::NO_ARGUMENT],
   ['-h', GetoptLong::NO_ARGUMENT],
   ['-p', GetoptLong::REQUIRED_ARGUMENT],
   ['-r', GetoptLong::NO_ARGUMENT],
@@ -59,6 +64,8 @@ options.each do |option, argument|
       custom_config = true
     when '-f'
       dofork = true
+    when '-s'
+      dosingle = true
     when '-h'
       usage_message(config_file)
     when '-p'
@@ -106,6 +113,9 @@ log.debug(config)
 # Fork value from command line.
 config.fork = dofork if dofork
 
+# Run a single time.
+config.single = dosingle if dosingle
+
 # PID file path from command line.
 config.pid_file = pid_file if pid_file
 
@@ -174,6 +184,8 @@ begin
       log.debug('wrote pid to ' + config.pid_file)
       File.write(config.pid_file, pid)
     end
+  elsif config.single
+    aggregator.run(-1)
   else
     log.debug('pid ' + Process.pid.to_s)
 

data/lib/transmission-rss/aggregator.rb

@@ -44,15 +44,8 @@ module TransmissionRSS
         @feeds.each do |feed|
           @log.debug('aggregate ' + feed.url)
 
-          options = {allow_redirections: :safe}
-
-          unless feed.validate_cert
-            @log.debug('aggregate certificate validation: false')
-            options[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE
-          end
-
           begin
-            content = open(feed.url, options).read
+            content = fetch(feed)
           rescue StandardError => e
             @log.debug("retrieval error (#{e.class}: #{e.message})")
             next
@@ -62,7 +55,7 @@ module TransmissionRSS
           # Ruby 1.9.3.
           content = decompress(content) if RUBY_VERSION == '1.9.3'
           begin
-            items = RSS::Parser.parse(content, false).items
+            items = parse(content)
           rescue StandardError => e
             @log.debug("parse error (#{e.class}: #{e.message})")
             next
@@ -74,12 +67,36 @@ module TransmissionRSS
           end
         end
 
+        if interval == -1
+          @log.debug('single run mode, exiting')
+          break
+        end
+
         sleep(interval)
       end
     end
 
     private
 
+    def fetch(feed)
+      options = {
+        allow_redirections: :safe,
+        'User-Agent' => 'transmission-rss'
+      }
+
+      unless feed.validate_cert
+        @log.debug('aggregate certificate validation: false')
+        options[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      # open for URIs is obsolete, URI.open does not work in 2.4
+      URI.send(:open, feed.url, options).read
+    end
+
+    def parse(content)
+      RSS::Parser.parse(content, false).items
+    end
+
     def decompress(string)
       Zlib::GzipReader.new(StringIO.new(string)).read
     rescue Zlib::GzipFile::Error, Zlib::Error

data/lib/transmission-rss/client.rb

@@ -17,6 +17,7 @@ module TransmissionRSS
 
       @host     = server.host || 'localhost'
       @port     = server.port || 9091
+      @tls      = !!server.tls
       @rpc_path = server.rpc_path || '/transmission/rpc'
       @login    = login
 
@@ -47,6 +48,7 @@ module TransmissionRSS
 
       case type
         when :url
+          file = URI.escape(file) if URI.unescape(file) == file
           arguments.filename = file
         when :file
           arguments.metainfo = Base64.encode64(File.read(file))
@@ -112,7 +114,7 @@ module TransmissionRSS
     end
 
     def http_request(data)
-      Net::HTTP.new(@host, @port).start do |http|
+      Net::HTTP.start(@host, @port, use_ssl: @tls) do |http|
         http.request(data)
       end
     end

data/lib/transmission-rss/config.rb

@@ -52,6 +52,7 @@ module TransmissionRSS
         'server' => {
           'host' => 'localhost',
           'port' => 9091,
+          'tls'  => false,
           'rpc_path' => '/transmission/rpc'
         },
         'login' => nil,
@@ -60,6 +61,7 @@ module TransmissionRSS
           'level' => :debug
         },
         'fork' => false,
+        'single' => false,
         'pid_file' => false,
         'privileges' => {},
         'seen_file' => nil

data/lib/transmission-rss/core_ext/URI.rb

@@ -0,0 +1,9 @@
+module URI
+  def self.escape(*arg)
+    URI::DEFAULT_PARSER.escape(*arg)
+  end
+
+  def self.unescape(*arg)
+    URI::DEFAULT_PARSER.unescape(*arg)
+  end
+end

data/lib/transmission-rss/feed.rb

@@ -9,7 +9,7 @@ module TransmissionRSS
       when Hash
         @config = config
 
-        @url = URI.encode(config['url'] || config.keys.first)
+        @url = URI.escape(config['url'] || config.keys.first)
 
         @download_path = config['download_path']
         @validate_cert = config['validate_cert'].nil? || config['validate_cert']

data/lib/transmission-rss/seen_file.rb

@@ -7,22 +7,19 @@ module TransmissionRSS
   # Persist seen torrent URLs
   class SeenFile
     extend ::Forwardable
-    
-    def_delegators :@seen, :size, :to_a
 
-    def initialize(path = nil, legacy_path = nil)
-      @legacy_path = legacy_path || default_legacy_path
-      @path        = path || default_path
+    def_delegators :@seen, :size, :to_a
 
-      initialize_path!
-      migrate!
+    def initialize(path = nil)
+      @path = path || default_path
+      initialize_path!(@path)
 
       @seen = Set.new(file_to_array(@path))
     end
 
     def add(url)
       hash = digest(url)
-      
+
       return if @seen.include?(hash)
 
       @seen << hash
@@ -43,10 +40,6 @@ 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
@@ -59,25 +52,11 @@ module TransmissionRSS
       open(path, 'r').readlines.map(&:chomp)
     end
 
-    def initialize_path!
-      return if File.exist?(@path)
-
-      FileUtils.mkdir_p(File.dirname(@path))
-      FileUtils.touch(@path)
-    end
-
-    def migrate!
-      return unless File.exist?(@legacy_path)
-
-      legacy_seen = file_to_array(@legacy_path)
-      hashes = legacy_seen.map { |url| digest(url) }
-
-      open(@path, 'w') do |f|
-        f.write(hashes.join("\n"))
-        f.write("\n")
-      end
+    def initialize_path!(path)
+      return if File.exist?(path)
 
-      FileUtils.rm_f(@legacy_path)
+      FileUtils.mkdir_p(File.dirname(path))
+      FileUtils.touch(path)
     end
   end
 end

data/lib/transmission-rss/version.rb

@@ -1,3 +1,3 @@
 module TransmissionRSS
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.2.1'
 end

data/lib/transmission-rss.rb

@@ -5,6 +5,7 @@ end
 
 require 'transmission-rss/core_ext/Array'
 require 'transmission-rss/core_ext/Object'
+require 'transmission-rss/core_ext/URI'
 
 Dir.glob($:.first + '/**/*.rb').each do |lib|
 	require lib

data/transmission-rss.conf.example

@@ -77,6 +77,10 @@ feeds:
 
 #fork: false
 
+# Single run mode?
+
+# single: false
+
 # Save PID.
 
 #pid_file: false

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.2.1
 platform: ruby
 authors:
 - henning mueller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-16 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +92,7 @@ files:
 - lib/transmission-rss/core_ext/Array.rb
 - lib/transmission-rss/core_ext/Hash.rb
 - lib/transmission-rss/core_ext/Object.rb
+- lib/transmission-rss/core_ext/URI.rb
 - lib/transmission-rss/feed.rb
 - lib/transmission-rss/log.rb
 - lib/transmission-rss/seen_file.rb
@@ -81,7 +102,7 @@ homepage: https://rubygems.org/gems/transmission-rss
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,13 +113,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Adds torrents from rss feeds to transmission web frontend.
 test_files: []