transmission-rss 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86674854af597f08a987f01786a9adb516f43581532170e293c27876169696f6
-  data.tar.gz: 055c6b2604df5c1ef936b38c6e5d8922b38aca4381744e93d14f29b914e8bab0
+  metadata.gz: ac9f76bca685a810ed32c80d1e43b7252d10a0088d33d4826d5b4e6c1496d753
+  data.tar.gz: b400a88f22877be316284d9edc0a3f13b73c014f16557adacaf2dc7fd9bc4004
 SHA512:
-  metadata.gz: ee0b8baab5caa033668694b782c70c52e76df166f35add66faa0b934a2d62da9dc9958c1dc35ff45ef5925958325f294b89d618cb17c2ff76b44049b6cc0e383
-  data.tar.gz: 2f4e5719d2d4aa2346c93b53d78bfc162645cfecfee478963f04c78b88f24a93f9a9e0ec5afd5c72ffd2a634ec1b8443b57d6ca3d3ce392bb040421a638cafa1
+  metadata.gz: 5c34f47be84831505bfdeacf16ec7ea07b38b520e86b0c25222583a667edc956a4846394355949780151cd26f180bfeac26583f437c5f2f4c7a641c7a2e748b3
+  data.tar.gz: 27952ef90a8ca35e7fc1897a36610dc93c735d50be9a3f926821af141f2a241a85f6dbc5d19e45d0e42960f9579a1c1f7b0f6a2e434a81a0025edd04b5231d4a

data/README.md

@@ -40,9 +40,9 @@ Installation
 
 ### Via Docker
 
-    docker run \
+    docker run -t \
       -v $(pwd)/transmission-rss.conf:/etc/transmission-rss.conf \
-      nning2/transmission-rss
+      nning2/transmission-rss:v1.0.0
 
 Configuration
 -------------
@@ -94,7 +94,7 @@ is true:
 ### 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
@@ -133,6 +133,7 @@ See `./transmission-rss.conf.example` for more documentation.
     server:
       host: localhost
       port: 9091
+      tls: false
       rpc_path: /transmission/rpc
 
     login:
@@ -152,6 +153,8 @@ See `./transmission-rss.conf.example` for more documentation.
 
     fork: false
 
+    single: false
+
     pid_file: false
 
     seen_file: ~/.config/transmission/seen
@@ -159,6 +162,8 @@ See `./transmission-rss.conf.example` for more documentation.
 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`.
@@ -178,3 +183,9 @@ Remember checking the path in `ExecStart`.
 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

@@ -74,6 +74,11 @@ module TransmissionRSS
           end
         end
 
+        if interval == -1
+          @log.debug('single run mode, exiting')
+          break
+        end
+
         sleep(interval)
       end
     end

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.encode(file) if URI.decode(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/version.rb

@@ -1,3 +1,3 @@
 module TransmissionRSS
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/transmission-rss.conf.example

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rss
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - henning mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
@@ -96,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adds torrents from rss feeds to transmission web frontend.