huginn_transmission_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd56e509b4db548ddcca46c50d74c7f9abbb738
+  data.tar.gz: c2035a7dabe6dd21f13cb163ce4a4863eaa36ee4
+SHA512:
+  metadata.gz: a8c0a401299b9235b9bf97e29a4fe5af58e542046d829d5848ddecb39fe39087cfe7e54d9130cfb6277c4bf372320a22470bf81ab168743b6473a596a267c003
+  data.tar.gz: b827c2f47ffea404852ea3bcce77da8d1f4ff1b419d8e1b145206f0aa493eb3c04a8fdcb80149a959455e0eb13c2b882db4d4862bbe164c51642ad08e98ed317

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Luiz Felipe G. Pereira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/huginn_transmission_agent.rb

@@ -0,0 +1,5 @@
+require 'huginn_agent'
+require 'transmission_api'
+
+HuginnAgent.register 'huginn_transmission_agent/transmission_agent'
+

data/lib/huginn_transmission_agent/transmission_agent.rb

@@ -0,0 +1,58 @@
+module Agents
+  class TransmissionAgent < Agent
+
+    default_schedule 'never'
+
+    can_dry_run!
+
+    description <<-MD
+      Add a Agent description here
+    MD
+
+    include FormConfigurable
+
+    form_configurable :username
+    form_configurable :password
+    form_configurable :url
+
+    def default_options
+      {
+        username: "username",
+        password: "password",
+        url: "http://127.0.0.1:9091/transmission/rpc"
+      }
+    end
+
+    def validate_options
+      %i(username password url).all? { |key| options[:key].present? }
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def check
+      begin
+        client.all
+      rescue => e
+        error("Error connecting to transmission: #{e.class} - #{e.message}")
+        raise e
+      end
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        log "Adding torrent: #{event.payload['description']}"
+        client.create(event.payload['url'])
+      end
+    end
+
+    def client
+      @client ||= TransmissionApi::Client.new(
+        username: options[:username],
+        password: options[:password],
+        url: options[:url]
+      )
+    end
+  end
+end

data/lib/torrents_fake.json

@@ -0,0 +1,104 @@
+[ { "files" : [ { "bytesCompleted" : 27062831,
+          "length" : 52146735,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/Content/TRAILER_3_Cinetic.mov"
+        },
+        { "bytesCompleted" : 718,
+          "length" : 718,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/Description.txt"
+        },
+        { "bytesCompleted" : 51,
+          "length" : 51,
+          "name" : "No Media Kings - Ghosts With Shit Jobs trailer/License.txt"
+        }
+      ],
+    "hashString" : "77831ec368308f1031434c5581a76fd0c3e06cfd",
+    "name" : "No Media Kings - Ghosts With Shit Jobs trailer",
+    "percentDone" : 0.51890000000000003,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 52147504
+  },
+  { "files" : [ { "bytesCompleted" : 24892844,
+          "length" : 24892844,
+          "name" : "Michael Mandiberg - Old News/Content/mandiberg_oldnews.mov"
+        },
+        { "bytesCompleted" : 237,
+          "length" : 237,
+          "name" : "Michael Mandiberg - Old News/Description.txt"
+        },
+        { "bytesCompleted" : 669,
+          "length" : 669,
+          "name" : "Michael Mandiberg - Old News/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 101,
+          "length" : 101,
+          "name" : "Michael Mandiberg - Old News/License.txt"
+        }
+      ],
+    "hashString" : "5f888e119ecb0cf8c25e68925164f533b1007038",
+    "name" : "Michael Mandiberg - Old News",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 24893851
+  },
+  { "files" : [ { "bytesCompleted" : 31103230,
+          "length" : 31103230,
+          "name" : "pearl-jam-life-wasted-video/PearlJamLifeWasted.avi"
+        } ],
+    "hashString" : "1b2162c33001cb3c51d917441e74e313996dff96",
+    "name" : "pearl-jam-life-wasted-video",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 31103230
+  },
+  { "files" : [ { "bytesCompleted" : 31772861,
+          "length" : 31772861,
+          "name" : "thewoolleyman - cinabox-screencast/Content/Cinabox_Screencast.mov"
+        },
+        { "bytesCompleted" : 309,
+          "length" : 309,
+          "name" : "thewoolleyman - cinabox-screencast/Description.txt"
+        },
+        { "bytesCompleted" : 669,
+          "length" : 669,
+          "name" : "thewoolleyman - cinabox-screencast/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 52,
+          "length" : 52,
+          "name" : "thewoolleyman - cinabox-screencast/License.txt"
+        }
+      ],
+    "hashString" : "0032886cdb4b0dcd6e75b5ac6901afda64367e0c",
+    "name" : "thewoolleyman - cinabox-screencast",
+    "percentDone" : 1,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 31773891
+  },
+  { "files" : [ { "bytesCompleted" : 0,
+          "length" : 13894821,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/Content/the road to god knows... graphic novel trailer.wmv"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 1114,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/Description.txt"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 669,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/LegalTorrents.txt"
+        },
+        { "bytesCompleted" : 0,
+          "length" : 127,
+          "name" : "Von Allan Studio - the road to god knows___ trailer/License.txt"
+        }
+      ],
+    "hashString" : "6d97bb6424d048fe605d3fe558c5c5333cdd6227",
+    "name" : "Von Allan Studio - the road to god knows___ trailer",
+    "percentDone" : 0,
+    "rateDownload" : 0,
+    "rateUpload" : 0,
+    "totalSize" : 13896731
+  }
+]

data/lib/transmission_api.rb

@@ -0,0 +1,10 @@
+require_relative "transmission_api/version"
+require_relative "transmission_api/client"
+require_relative "transmission_api/client_fake"
+require_relative "transmission_api/exception"
+
+require "httparty"
+require "json"
+
+module TransmissionApi
+end

data/lib/transmission_api/client.rb

@@ -0,0 +1,151 @@
+class TransmissionApi::Client
+  attr_accessor :session_id
+  attr_accessor :url
+  attr_accessor :basic_auth
+  attr_accessor :fields
+  attr_accessor :debug_mode
+
+  TORRENT_FIELDS = [
+    "id",
+    "name",
+    "totalSize",
+    "addedDate",
+    "isFinished",
+    "rateDownload",
+    "rateUpload",
+    "percentDone",
+    "files"
+  ]
+
+  def initialize(opts)
+    @url = opts[:url]
+    @fields = opts[:fields] || TORRENT_FIELDS
+    @basic_auth = { :username => opts[:username], :password => opts[:password] } if opts[:username]
+    @session_id = "NOT-INITIALIZED"
+    @debug_mode = opts[:debug_mode] || false
+  end
+
+  def all
+    log "get_torrents"
+
+    response =
+      post(
+        :method => "torrent-get",
+        :arguments => {
+          :fields => fields
+        }
+      )
+
+    response["arguments"]["torrents"]
+  end
+
+  def find(id)
+    log "get_torrent: #{id}"
+
+    response =
+      post(
+        :method => "torrent-get",
+        :arguments => {
+          :fields => fields,
+          :ids => [id]
+        }
+      )
+
+    response["arguments"]["torrents"].first
+  end
+
+  def create(filename)
+    log "add_torrent: #{filename}"
+
+    response =
+      post(
+        :method => "torrent-add",
+        :arguments => {
+          :filename => filename
+        }
+      )
+
+    response["arguments"]["torrent-added"]
+  end
+
+  def destroy(id)
+    log "remove_torrent: #{id}"
+
+    response =
+      post(
+        :method => "torrent-remove",
+        :arguments => {
+          :ids => [id],
+          :"delete-local-data" => true
+        }
+      )
+
+    response
+  end
+
+  def post(opts)
+    response_parsed = JSON::parse( http_post(opts).body )
+
+    if response_parsed["result"] != "success"
+      raise TransmissionApi::Exception, response_parsed["result"]
+    end
+
+    response_parsed
+  end
+
+  def http_post(opts)
+    post_options = {
+      :body => opts.to_json,
+      :headers => { "x-transmission-session-id" => session_id }
+    }
+    post_options.merge!( :basic_auth => basic_auth ) if basic_auth
+
+    log "url: #{url}"
+    log "post_body:"
+    log JSON.parse(post_options[:body]).to_yaml
+    log "------------------"
+
+    response = HTTParty.post( url, post_options )
+
+    log_response response
+
+    # retry connection if session_id incorrect
+    if( response.code == 409 )
+      log "changing session_id"
+      @session_id = response.headers["x-transmission-session-id"]
+      response = http_post(opts)
+    end
+
+    response
+  end
+
+  def log(message)
+    Kernel.puts "[TransmissionApi #{Time.now.strftime( "%F %T" )}] #{message}" if debug_mode
+  end
+
+  def log_response(response)
+    body = nil
+    begin
+      body = JSON.parse(response.body).to_yaml
+    rescue
+      body = response.body
+    end
+
+    headers = response.headers.to_yaml
+
+    log "response.code: #{response.code}"
+    log "response.message: #{response.message}"
+
+    log "response.body_raw:"
+    log response.body
+    log "-----------------"
+
+    log "response.body:"
+    log body
+    log "-----------------"
+
+    log "response.headers:"
+    log headers
+    log "------------------"
+  end
+end

data/lib/transmission_api/client_fake.rb

@@ -0,0 +1,39 @@
+class TransmissionApi::ClientFake < TransmissionApi::Client
+
+  attr_reader :torrents
+
+  def initialize(opts)
+    super
+    torrents_path = opts[:torrents_path] || "#{File.dirname(__FILE__)}/../torrents_fake.json"
+    @torrents = JSON.parse(File.read(torrents_path))
+  end
+
+  def all
+    torrents
+  end
+
+  def find(id)
+    torrents.select { |e| e["hashString"] == id }.first
+  end
+
+  def create(filename)
+    torrent = {
+      "files" => [],
+      "hashString" => "77831ec368308f1031434c5581a76fd0c3e06cfd",
+      "name" => "No Media Kings - Ghosts With Shit Jobs trailer",
+      "percentDone" => 0,
+      "rateUpload" => 0,
+      "rateDownload" => 0,
+      "totalSize" => 100
+    }
+
+    torrents << torrent
+
+    torrent
+  end
+
+  def destroy(id)
+    torrents.delete_if { |e| e["hashString"] == id }
+  end
+
+end

data/lib/transmission_api/exception.rb

@@ -0,0 +1,2 @@
+class TransmissionApi::Exception < Exception
+end

data/lib/transmission_api/version.rb

@@ -0,0 +1,3 @@
+module TransmissionApi
+  VERSION = "0.0.7"
+end

data/spec/transmission_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::TransmissionAgent do
+  before(:each) do
+    @valid_options = Agents::TransmissionAgent.new.default_options
+    @checker = Agents::TransmissionAgent.new(:name => "TransmissionAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: huginn_transmission_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Luiz Felipe G. Pereira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: This agent provides an interface between Huginn and the Transmission
+  torrent client
+email:
+- luiz.felipe.gp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_transmission_agent.rb
+- lib/huginn_transmission_agent/transmission_agent.rb
+- lib/torrents_fake.json
+- lib/transmission_api.rb
+- lib/transmission_api/client.rb
+- lib/transmission_api/client_fake.rb
+- lib/transmission_api/exception.rb
+- lib/transmission_api/version.rb
+- spec/transmission_agent_spec.rb
+homepage: https://github.com/Draiken/huginn_transmission_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Huginn Agent for integration with Transmission
+test_files:
+- spec/transmission_agent_spec.rb