transmission-rss 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac9f76bca685a810ed32c80d1e43b7252d10a0088d33d4826d5b4e6c1496d753
-  data.tar.gz: b400a88f22877be316284d9edc0a3f13b73c014f16557adacaf2dc7fd9bc4004
+  metadata.gz: bb9c56c39e910b2887fc0125df3ccec3870ec9b42bc36ec40440f72dce9cf4d4
+  data.tar.gz: cfe742ea19cf4ff7f22bace81c5f24d14f70e6c25bb123e5b0d4d6f8693c261b
 SHA512:
-  metadata.gz: 5c34f47be84831505bfdeacf16ec7ea07b38b520e86b0c25222583a667edc956a4846394355949780151cd26f180bfeac26583f437c5f2f4c7a641c7a2e748b3
-  data.tar.gz: 27952ef90a8ca35e7fc1897a36610dc93c735d50be9a3f926821af141f2a241a85f6dbc5d19e45d0e42960f9579a1c1f7b0f6a2e434a81a0025edd04b5231d4a
+  metadata.gz: 7234a61c9cf5fb97b53484007d0e475f6349161cf022b95784cc7fc3a85b5f304060d3a9ac34470da6d85d5ed6325001b4f653eb0144020d8056994c62d5871d
+  data.tar.gz: d2ff27c562b7db9f2e161337065e8e69301df5a624608704adf0f8296abbd68ff24575abfc3a7ecaa5166b43b878833185bd8e3ab6d0248fe52c4153197149ea

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 -t \
-      -v $(pwd)/transmission-rss.conf:/etc/transmission-rss.conf \
-      nning2/transmission-rss:v1.0.0
+```sh
+docker run -t \
+  -v $(pwd)/transmission-rss.conf:/etc/transmission-rss.conf \
+  nning2/transmission-rss:v1.2.1
+```
 
 Configuration
 -------------
@@ -60,36 +70,49 @@ 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
 
@@ -102,62 +125,65 @@ 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
-      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
+
+```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
 ------------------
@@ -168,17 +194,19 @@ 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

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
@@ -85,6 +78,25 @@ module TransmissionRSS
 
     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

@@ -48,7 +48,7 @@ module TransmissionRSS
 
       case type
         when :url
-          file = URI.encode(file) if URI.decode(file) == file
+          file = URI.escape(file) if URI.unescape(file) == file
           arguments.filename = file
         when :file
           arguments.metainfo = Base64.encode64(File.read(file))

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(URI.unescape(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.1.0'
+  VERSION = '1.2.2'
 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

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - henning mueller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2022-06-19 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
@@ -96,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Adds torrents from rss feeds to transmission web frontend.
 test_files: []