utorrent-webapi-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1ce4177d5fd69367b27da37146883c24496d6e7
+  data.tar.gz: bb1d3c5272406c3e77c10e4b1402578fe21dafb8
+SHA512:
+  metadata.gz: 5d6b38c39b3f9c10af85bcc1c2b51bb35175bc826999f67a42b1ed35387344589eefa814e9c99a685794939f03eaa6db976f3eb63726cfcb091010a30f25f097
+  data.tar.gz: bf068bdd3ee15df7cc36c8e220fb97c56137eef887b1b99aebd33599381d2f498e752274210e5b2ff43a3fd75938d1fe2929fa822d38b5393f505e5547520aac

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Wu
+
+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/README.md

@@ -0,0 +1,54 @@
+# utorrent-webapi-ruby
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'utorrent-webapi-ruby', git: 'git@github.com:PeterWuMC/utorrent-webapi-ruby.git'
+
+## Configuration
+
+```ruby
+configuration = UTorrent::Configuration.new
+configuration.url = '192.168.2.100'
+configuration.port = '8085'
+configuration.username = 'admin'
+configuration.password = 'password'
+UTorrent.configuration = configuration
+```
+
+## Limitation
+
+The current version only support the following actions
+
+* Only support HTTP
+* Querying torrents [attributes](https://github.com/PeterWuMC/utorrent-webapi-ruby/blob/master/lib/u_torrent/torrent.rb#L20-L26)
+* Perform the following actions to torrent: `start, stop, force_start, pause, unpause, recheck, remove, remove_data`
+* Querying files within a specific torrent [attributes](https://github.com/PeterWuMC/utorrent-webapi-ruby/blob/master/lib/u_torrent/file.rb#L10-L13)
+* Add new torrent using with url
+* Updating a file [priority](https://github.com/PeterWuMC/utorrent-webapi-ruby/blob/master/lib/u_torrent/file.rb#L3-L8)
+
+## Usage
+
+### Query all torrents
+
+    UTorrent::Torrent.all
+
+### Find one torrent using HASH
+
+    UTorrent::Torrent.find(HASH)
+
+### Perform actions on torrent
+
+e.g.
+
+    UTorrent::Torrent.all.first.stop
+
+### Query all file of a torrent
+
+    UTorrent::Torrent.all.first.files
+
+### Update priority of a file
+
+    UTorrent::Torrent.all.first.files.priority = 0 # Do not download

data/lib/u_torrent.rb

@@ -0,0 +1,27 @@
+require 'cgi'
+require 'uri'
+require 'net/http'
+require 'nokogiri'
+require 'json'
+require_relative 'u_torrent/configuration'
+require_relative 'u_torrent/http'
+require_relative 'u_torrent/base'
+require_relative 'u_torrent/torrent'
+require_relative 'u_torrent/file'
+
+
+module UTorrent
+  module_function
+
+  def configuration=(configuration)
+    @configuration = configuration
+  end
+
+  def configuration
+    @configuration
+  end
+
+  def base_uri
+    URI.parse("#{@configuration.protocol}://#{@configuration.url}:#{@configuration.port}/gui/")
+  end
+end

data/lib/u_torrent/base.rb

@@ -0,0 +1,22 @@
+module UTorrent
+  module Base
+    attr_reader :raw_array
+
+    def initialize(array)
+      @raw_array = array
+    end
+
+    def self.included(base)
+      base.class_eval do
+        base::ATTRIBUTES.each_with_index do |attr_name, i|
+          unless attr_name.nil?
+            define_method attr_name do
+              @raw_array[i]
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/u_torrent/configuration.rb

@@ -0,0 +1,10 @@
+module UTorrent
+  class Configuration
+    attr_accessor :url, :username, :password, :port
+    attr_writer :protocol
+
+    def protocol
+      @protocol ||= 'http'
+    end
+  end
+end

data/lib/u_torrent/file.rb

@@ -0,0 +1,52 @@
+module UTorrent
+  class File
+    PRIORITIES = {
+      0 => "Don't Download",
+      1 => 'Low Priority',
+      2 => 'Normal Priority',
+      3 => 'High Priority',
+    }
+
+    ATTRIBUTES = [
+      :name, :size, :downloaded, nil,
+      nil, nil, nil, nil, nil, nil, nil, nil, nil
+    ]
+
+    include UTorrent::Base
+
+    attr_reader :index, :torrent_id
+
+    def self.find_by_torrent_id_and_index(torrent_id, index)
+      UTorrent::Torrent.find(torrent_id).files[index]
+    end
+
+    def initialize(array, index, torrent_id)
+      super(array)
+      @index      = index
+      @torrent_id = torrent_id
+    end
+
+    def priority_display_value
+      PRIORITIES[priority]
+    end
+
+    def priority
+      @raw_array[3]
+    end
+
+    def priority=(priority)
+      UTorrent::Http.get_with_authentication(
+        action: 'setprio',
+        hash:    torrent_id,
+        f:       index,
+        p:       priority
+      )
+      refresh!
+    end
+
+    def refresh!
+      file = self.class.find_by_torrent_id_and_index(torrent_id, index)
+      @raw_array = file.raw_array
+    end
+  end
+end

data/lib/u_torrent/http.rb

@@ -0,0 +1,55 @@
+module UTorrent
+  module Http
+    module_function
+
+    def get_with_authentication(query={})
+      query.merge!(token: token)
+      get(UTorrent.base_uri, query) do |request|
+        request['Cookie'] = cookie
+      end
+    end
+
+    def get(uri, query={})
+      uri.query = urify_query(query)
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(
+        UTorrent.configuration.username,
+        UTorrent.configuration.password
+      )
+
+      yield request if block_given?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.request(request)
+    end
+
+    def token
+      @token ||= begin
+        generate!
+        @token
+      end
+    end
+
+    def cookie
+      @cookie ||= begin
+        generate!
+        @cookie
+      end
+    end
+
+    def generate!
+      uri = UTorrent.base_uri
+      uri.path = '/gui/token.html'
+
+      response = get(uri)
+
+      @token = Nokogiri::HTML(response.body).at_xpath('//div').content
+      @cookie = response['set-cookie']
+    end
+
+    def urify_query(query_hash)
+      URI.encode_www_form(query_hash.to_a)
+    end
+
+  end
+end

data/lib/u_torrent/torrent.rb

@@ -0,0 +1,86 @@
+module UTorrent
+  class Torrent
+    STATUSES = {
+      'Started'           => 1,
+      'Checking'          => 2,
+      'Start after check' => 4,
+      'Checked'           => 8,
+      'Error'             => 16,
+      'Paused'            => 32,
+      'Queued'            => 64,
+      'Loaded'            => 128,
+    }
+
+    ACTIONS = [
+      :start, :stop, :force_start,
+      :pause, :unpause, :recheck,
+      :remove, :remove_data
+    ]
+
+    ATTRIBUTES = [
+      :id, nil, :name, :size, nil, :downloaded, :uploaded, :ratio,
+      :upload_speed, :download_speed, :eta, :label, :peers_connected,
+      :peers_in_swarm, :seeds_connected, :seeds_in_swarm, :availability,
+      :queue_order, :remaining, nil, nil, :status, nil, nil, nil, nil,
+      :current_directory, nil, nil, nil
+    ]
+
+    include UTorrent::Base
+
+    def self.all
+      response = UTorrent::Http.get_with_authentication(list: 1)
+      torrents_array = JSON.parse(response.body)['torrents']
+      torrents_array.map { |torrent| self.new(torrent) }
+    end
+
+    def self.find(id)
+      all.detect { |torrent| torrent.id == id }
+    end
+
+    def self.add(url)
+      UTorrent::Http.get_with_authentication(
+        action: 'add-url',
+        s:      url
+      )
+      UTorrent::Torrent.all.detect {|torrent| torrent.queue_order == UTorrent::Torrent.all.map(&:queue_order).max}
+    end
+
+    def statuses
+      status_code = @raw_array[1]
+      status = STATUSES.select { |_, value| status_code & value == value }
+      status.keys.reverse
+    end
+
+    def percentage
+      @raw_array[4].to_f / 10
+    end
+
+    def files
+      response = UTorrent::Http.get_with_authentication(action: 'getfiles', hash: id)
+      files_array = JSON.parse(response.body)['files'].last
+      files_array.each_with_index.map { |file, i| UTorrent::File.new(file, i, id) }
+    end
+
+    ACTIONS.each do |action|
+      define_method action do
+        execute(action.to_s.delete('_'))
+        true
+      end
+    end
+
+    def refresh!
+      torrent = self.class.find(id)
+      @raw_array = torrent.raw_array
+    end
+
+    private
+
+    def execute(action)
+      UTorrent::Http.get_with_authentication(
+        action: action,
+        hash:    id
+      )
+      refresh!
+    end
+  end
+end

data/lib/u_torrent/version.rb

@@ -0,0 +1,3 @@
+module UTorrent
+  VERSION = '0.0.1'.freeze
+end

data/utorrent-webapi-ruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'u_torrent/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = 'utorrent-webapi-ruby'
+  spec.version       = UTorrent::VERSION
+  spec.authors       = ['Peter Wu']
+  spec.email         = ['petergenius@gmail.com']
+  spec.description   = %q{UTorrent webapi ruby library}
+  spec.summary       = %q{Communicate to utorrent via webapi in ruby}
+  spec.homepage      = 'https://github.com/PeterWuMC/utorrent-webapi-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: utorrent-webapi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+description: UTorrent webapi ruby library
+email:
+- petergenius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/u_torrent.rb
+- lib/u_torrent/base.rb
+- lib/u_torrent/configuration.rb
+- lib/u_torrent/file.rb
+- lib/u_torrent/http.rb
+- lib/u_torrent/torrent.rb
+- lib/u_torrent/version.rb
+- utorrent-webapi-ruby.gemspec
+homepage: https://github.com/PeterWuMC/utorrent-webapi-ruby
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Communicate to utorrent via webapi in ruby
+test_files: []
+has_rdoc: