transmission-rpc-ruby-ext 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66baaca80a270473f4376d93b17afe57752e4141
-  data.tar.gz: 44d49c586066b362dfd039c4172786f21741877b
+  metadata.gz: a17cf176257c2e0add6e0a68b10dcdb9b9453132
+  data.tar.gz: de082e8070b0d69044a764a5b628b6c2d67ef8cb
 SHA512:
-  metadata.gz: 0bc47e4df2187ef7fc082b3339559792a86f123812a406d091ae1b79ce813e143440a5f2628ea4000fa906a70c22723533340af2cc2f2dd3a7617d090aac682e
-  data.tar.gz: c2b07193fd83431021f1990887549d620532f5de469042198924f6ae5e07502d6fbb5cb22524304847e95838b14f08865604e4948278af8ff9514c0663430173
+  metadata.gz: 28503d810fa4bba2b6fd8ad44ed9094519cd81f34aa6063e4100525451aeeb6788e5dccdfe88c303beb529aeb59130756e248abab6b114f6b751f61cd3ea0133
+  data.tar.gz: e6b65db7064efe047dfe72d325d5e69f8ea1de2680c5c18b078e40828b6f1b49960ae14939e9f0d59087d78fcb7f537c0a27ecdd6fdfdd03bd63d4826c250f58

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 2.2
   - 2.1
   - 2.0
+  - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,24 @@
-## v0.1.0 (2016-12-28)
+# Change Log
 
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.1.1 - 2016-12-31
+### Added
+- Add `pretty_length`, `pretty_valid` and `pretty_eta` methods.
+- Add `peers`, `peers_seeding` and `peers_leeching` methods.
+- Add better documentation and comments.
+- Add some specs for extensions.
+
+### Changed
+- Minimum ruby version is now `2.0`.
+- Refactor `is_multi?` to `multi?` for best practice compliance.
+- Refactor `is_valid_key?` to  for best practice compliance
+
+### Removed
+- Remove `finished?` method (overridden in extensions)
+
+## 0.1.0 - 2016-12-28
 - Initial fork and basic additions.

data/LICENSE

@@ -1,4 +1,7 @@
-Copyright (c) 2015 Tommaso Barbato
+MIT License
+
+Copyright (c) 2016 Tommaso Barbato
+Portions copyright (c) 2015 Max Hoffmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,10 @@
 # Transmission RPC Ruby Extended
 
-[![Build Status](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext) [![Code Climate](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext/badges/gpa.svg)](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext) [![Coverage Status](https://coveralls.io/repos/github/epistrephein/transmission-rpc-ruby-ext/badge.svg?branch=master)](https://coveralls.io/github/epistrephein/transmission-rpc-ruby-ext?branch=master) [![Dependency Status](https://gemnasium.com/badges/github.com/epistrephein/transmission-rpc-ruby-ext.svg)](https://gemnasium.com/github.com/epistrephein/transmission-rpc-ruby-ext) [![Inline docs](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext)
+[![Gem Version](https://badge.fury.io/rb/transmission-rpc-ruby-ext.svg)](https://badge.fury.io/rb/transmission-rpc-ruby-ext) [![Build Status](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](https://travis-ci.org/epistrephein/transmission-rpc-ruby-ext) [![Code Climate](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext/badges/gpa.svg)](https://codeclimate.com/github/epistrephein/transmission-rpc-ruby-ext) [![Coverage Status](https://coveralls.io/repos/github/epistrephein/transmission-rpc-ruby-ext/badge.svg?branch=master)](https://coveralls.io/github/epistrephein/transmission-rpc-ruby-ext?branch=master) [![Dependency Status](https://gemnasium.com/badges/github.com/epistrephein/transmission-rpc-ruby-ext.svg)](https://gemnasium.com/github.com/epistrephein/transmission-rpc-ruby-ext) [![Inline docs](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext.svg?branch=master)](http://inch-ci.org/github/epistrephein/transmission-rpc-ruby-ext)
 
-This is a fork of [transmission-rails/transmission-rpc-ruby](https://github.com/transmission-rails/transmission-rpc-ruby) with some shortcut methods added and revised codebase.
+This is a fork of [transmission-rpc-ruby](https://github.com/transmission-rails/transmission-rpc-ruby) with some shortcut methods added and revised codebase.
+
+Documentation for the original gem can be found in the [upstream repository](https://github.com/transmission-rails/transmission-rpc-ruby).
 
 ## Installation
 
@@ -16,9 +18,18 @@ Then require it
 require 'transmission'
 ```
 
-## Additions
+If both `transmission-rpc-ruby` and `transmission-rpc-ruby-ext` gems are installed, specify the gem to require to avoid namespace conflict.
+
+```ruby
+gem 'transmission-rpc-ruby-ext'
+require 'transmission'
+```
+
+## Extensions
+
+### Transmission selectors
 
-Get an array of all torrents
+All torrents
 
 ```ruby
 Transmission.all
@@ -49,7 +60,7 @@ Transmission.seeding        # status 6
 All torrents with error
 
 ```ruby
-Transmission.error
+Transmission.errors
 ```
 
 All hashes of all torrents
@@ -61,34 +72,17 @@ Transmission.hashes
 Find torrents by name, hash, id or tracker
 
 ```ruby
-Transmission.find_by_name('Ubuntu')
-Transmission.find_by_hash('fe086f9b15e4956a671ab9b9c5da526e3d3b270c')
-Transmission.find_by_id(5)
-Transmission.find_by_tracker('open.demonii.com')
+Transmission.find_by_name('ubuntu')
+Transmission.find_by_hash('9f9165d9a281a9b8e782cd5176bbcc8256fd1871')
+Transmission.find_by_id(1)
+Transmission.find_by_tracker('torrent.ubuntu.com')
 ```
 
-### Single torrent methods
+### Torrent status
 
 ```ruby
 t = Transmission.all.first
-```
-
-Basic attributes
 
-```ruby
-t.name
-# => "ubuntu-16.04-desktop-amd64.iso"
-t.path
-# => "/Users/epistrephein/Downloads/ubuntu-16.04-desktop-amd64.iso"
-t.id
-# => 13
-t.hash
-# => "4344503b7e797ebf31582327a5baae35b11bda01"
-```
-
-Status
-
-```ruby
 t.paused?
 # => false
 t.queued?
@@ -107,67 +101,127 @@ t.error?
 # => false
 ```
 
+### Torrent attributes
+
+Basic attributes
+
+```ruby
+t = Transmission.all.first
+
+t.name
+# => "ubuntu-16.04.1-desktop-amd64.iso"
+t.path
+# => "/Users/epistrephein/Downloads/ubuntu-16.04-desktop-amd64.iso"
+t.id
+# => 1
+t.hash
+# => "9f9165d9a281a9b8e782cd5176bbcc8256fd1871"
+```
+
 Size
 
 ```ruby
 t.length
-# => 1485881344
+# => 1513308160
 t.valid
-# => 18232
+# => 582696960
 t.percent_downloaded
-# => 1.2
+# => 0.39
 t.percent_uploaded
-# => 0.1
+# => 0.0
 t.percent_ratio
-# => 0.1
-t.ratio
-# => -1.0
+# => nil
 ```
 
 Speed
 
 ```ruby
 t.speed_download
-# => 12
+# => 14477000
 t.speed_upload
-# => 9
+# => 0
 ```
 
 Ratio & ETA
 
 ```ruby
 t.ratio
-# => -1.0
+# => 0.0
 t.eta
+# => 85
 ```
 
 Files and folders
 
 ```ruby
 t.file?
+# => true
 t.folder?
+# => false
 t.files
+# => ["/Users/epistrephein/Downloads/ubuntu-16.04-desktop-amd64.iso"]
 t.content
+# => ["ubuntu-16.04.1-desktop-amd64.iso"]
 t.biggest
+# => ["ubuntu-16.04.1-desktop-amd64.iso", 1513308160]
 t.smallest
+# => ["ubuntu-16.04.1-desktop-amd64.iso", 1513308160]
+```
+
+Peers
+
+```ruby
+t.peers
+# => 11
+t.peers_seeding
+# => 9
+t.peers_leeching
+# => 0
+```
+
+Errors
+
+```ruby
+t.error
+# => nil
 ```
 
 Magnet link
 
 ```ruby
 t.magnet
+# => "magnet:?xt=urn:btih:9f9165d9a281a9b8e782cd5176bbcc8256fd1871&dn=ubuntu-16.04.1-desktop-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce"
 ```
 
 Trackers
 
 ```ruby
 t.trackers
+# => ["torrent.ubuntu.com", "ipv6.torrent.ubuntu.com"]
 ```
 
-Actions
+### Torrent prettified attributes
+
+```ruby
+t.pretty_length
+# => "1.51GB"
+t.pretty_valid
+# => "582.7MB"
+t.pretty_eta
+# => "1 minutes, 25 seconds"
+```
+
+### Torrent actions
 
 ```ruby
 t.reload!
 t.remove!
 t.remove_data!
 ```
+
+## Contributing
+
+Contributions are welcome and encouraged. Feel free to open an issue or submit a pull request.
+
+## License
+[MIT License](LICENSE)

data/lib/transmission.rb

@@ -7,5 +7,5 @@ require_relative 'transmission/utils'
 require_relative 'transmission/extensions'
 
 module Transmission
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/transmission/arguments.rb

@@ -31,7 +31,7 @@ module Transmission
       include Transmission::Utils
 
       def is_valid?(key)
-        is_valid_key? key, self::ATTRIBUTES
+        valid_key? key, self::ATTRIBUTES
       end
 
       def real_key(key)

data/lib/transmission/extensions.rb

@@ -1,4 +1,5 @@
 require_relative 'extensions/torrent_actions'
 require_relative 'extensions/torrent_attributes'
+require_relative 'extensions/torrent_prettify'
 require_relative 'extensions/torrent_status'
-require_relative 'extensions/transmission'
+require_relative 'extensions/transmission_selectors'

data/lib/transmission/extensions/torrent_actions.rb

@@ -1,11 +1,13 @@
 module Transmission
   module Model
     class Torrent
+      # Removes torrent.
       def remove!
         connector.remove_torrent @ids
         @deleted = true
       end
 
+      # Removes torrent and trashes data files.
       def remove_data!
         connector.remove_torrent @ids, true
         @deleted = true

data/lib/transmission/extensions/torrent_attributes.rb

@@ -1,95 +1,135 @@
 module Transmission
   module Model
     class Torrent
-      # torrent attributes methods
+      # Returns torrent name.
       def name
         attributes['name']
       end
 
+      # Returns torrent full download path.
       def path
         dir = File.expand_path(attributes['downloadDir'])
         File.join(dir, name)
       end
 
+      # Returns torrent id.
       def id
         attributes['id']
       end
 
+      # Returns torrent hash.
       def hash
         attributes['hashString']
       end
 
+      # Returns torrent size (in bytes).
       def length
         attributes['totalSize']
       end
 
+      # Returns torrent downloaded files size (in bytes).
       def valid
         attributes['haveValid']
       end
 
+      # Returns torrent downloaded files percent.
       def percent_downloaded
         (attributes['haveValid'] * 1.0 / attributes['totalSize']).round(2)
       end
 
+      # Returns torrent uploaded files percent.
       def percent_uploaded
         (attributes['uploadedEver'] * 1.0 / attributes['totalSize']).round(2)
       end
 
+      # Returns torrent ratio percent if session ratio is set.
       def percent_ratio
         session = Transmission::Model::Session.get
         return unless session.seed_ratio_limited
         (attributes['uploadRatio'] * 1.0 / session.seed_ratio_limit).round(2)
       end
 
+      # Returns torrent download speed (in bytes).
       def speed_download
         attributes['rateDownload']
       end
 
+      # Returns torrent upload speed (in bytes).
       def speed_upload
         attributes['rateUpload']
       end
 
+      # Returns torrent ratio.
       def ratio
         (attributes['uploadRatio'] * 1.0).round(2)
       end
 
+      # Returns torrent eta (in seconds).
       def eta
-        pretty_time(attributes['eta']) if attributes['eta'] > 0
+        attributes['eta']
       end
 
+      # Returns true if torrent is a single file.
       def file?
         name = attributes['name']
         files = attributes['files']
         files.size == 1 && files.first['name'] == name
       end
 
+      # Returns true if torrent is a folder.
       def folder?
         !file?
       end
 
+      # Returns all torrent files full path.
       def files
         dir = File.absolute_path(attributes['downloadDir'])
         attributes['files'].map { |f| File.join(dir, f['name']) }
       end
 
+      # Returns torrent files names.
       def content
         files.map { |f| File.basename(f) }
       end
 
+      # Returns torrent biggest file and size.
       def biggest
         b = attributes['files'].max_by { |f| f['length'] }
         [File.basename(b['name']), b['length']]
       end
 
+      # Returns torrent smallest file and size.
       def smallest
         b = attributes['files'].min_by { |f| f['length'] }
         [File.basename(b['name']), b['length']]
       end
 
+      # Returns torrent peers.
+      def peers
+        attributes['peersConnected'].size
+      end
+
+      # Returns torrent seeding peers.
+      def peers_seeding
+        attributes['peersSendingToUs']
+      end
+
+      # Returns torrent leeching peers.
+      def peers_leeching
+        attributes['peersGettingFromUs']
+      end
+
+      # Returns torrent error string.
+      def error
+        attributes['errorString'] if error?
+      end
+
+      # Returns torrent magnet link.
       def magnet
         attributes['magnetLink']
       end
 
+      # Returns torrent trackers.
       def trackers
         url_regex = /([-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b)(?:[-a-zA-Z0-9@:%_\+.~#?&\/=]*)/i
         attributes['trackers'].map do |r|

data/lib/transmission/extensions/torrent_prettify.rb

@@ -0,0 +1,57 @@
+module Transmission
+  module Model
+    class Torrent
+      # Returns prettified torrent size.
+      def pretty_length
+        pretty_size(length)
+      end
+
+      # Returns prettified downloaded files size.
+      def pretty_valid
+        pretty_size(valid)
+      end
+
+      # Returns prettified eta.
+      def pretty_eta
+        pretty_time(attributes['eta']) if attributes['eta'] > 0
+      end
+
+      private
+
+      # Converts filesize to proper units.
+      def pretty_size(size)
+        {
+          'B'  => 1000**1,
+          'KB' => 1000**2,
+          'MB' => 1000**3,
+          'GB' => 1000**4,
+          'TB' => 1000**5
+        }.each_pair do |e, s|
+          return "#{(size.to_f / (s / 1000)).round(2)}#{e}" if size < s
+        end
+      end
+
+      # Convert seconds in seconds/minutes/hours.
+      def pretty_time(seconds)
+        mm, ss = seconds.divmod(60)
+        hh, mm = mm.divmod(60)
+        dd, hh = hh.divmod(24)
+        eta = {
+          days: dd, hours: hh, minutes: mm, seconds: ss
+        }.delete_if { |_k, v| v.zero? }
+        eta.to_a.map { |e| e.reverse.join(' ') }.join(', ')
+      end
+
+      # Converts status code in status name.
+      def status_name
+        ['paused', 'check wait', 'check', 'download wait', 'download',
+         'seed wait', 'seed', 'isolated'].at(status)
+      end
+
+      # Converts status code in status symbol.
+      def status_symbol
+        ['❚❚', '~', '⟳', '⥥', '⬇', '⥣', '⬆', '✘'].at(status)
+      end
+    end
+  end
+end

data/lib/transmission/extensions/torrent_status.rb

@@ -1,39 +1,47 @@
 module Transmission
   module Model
     class Torrent
-      # torrent status methods
+      # Returns true if torrent is paused.
       def paused?
         attributes['status'] == 0
       end
 
+      # Returns true if torrent is queued.
       def queued?
         attributes['status'] == 3
       end
 
+      # Returns true if torrent is downloading.
       def downloading?
         attributes['status'] == 4
       end
 
+      # Returns true if torrent is seeding.
       def seeding?
         attributes['status'] == 6
       end
 
+      # Returns true if torrent is isolated.
       def isolated?
         attributes['status'] == 7
       end
 
+      # Returns true if torrent is finished.
       def finished?
         attributes['isFinished']
       end
 
+      # Returns true if torrent is completed.
       def completed?
         attributes['percentDone'] >= 1
       end
 
+      # Returns true if torrent is not completed.
       def incomplete?
         attributes['percentDone'] < 1
       end
 
+      # Returns true if torrent has errors.
       def error?
         attributes['error'] != 0
       end

data/lib/transmission/extensions/{transmission.rb → transmission_selectors.rb}

@@ -1,5 +1,5 @@
 module Transmission
-  # list torrents methods
+  # Returns all torrents.
   def self.all(connector = nil)
     t = Transmission::Model::Torrent.all connector: connector
     case t.ids.size
@@ -9,56 +9,69 @@ module Transmission
     end
   end
 
+  # Returns all finished torrents.
   def self.finished
     all.select { |t| t.attributes['isFinished'] }
   end
 
+  # Returns all completed torrents.
   def self.completed
     all.select { |t| t.attributes['percentDone'] >= 1 }
   end
 
+  # Returns all incomplete torrents.
   def self.incomplete
     all.select { |t| t.attributes['percentDone'] < 1 }
   end
 
+  # Returns all paused torrents.
   def self.paused
     all.select { |t| t.attributes['status'] == 0 }
   end
 
+  # Returns all queued torrents.
   def self.queued
     all.select { |t| t.attributes['status'] == 3 }
   end
 
+  # Returns all downloading torrents.
   def self.downloading
     all.select { |t| t.attributes['status'] == 4 }
   end
 
+  # Returns all seeding torrents.
   def self.seeding
     all.select { |t| t.attributes['status'] == 6 }
   end
 
-  def self.error
+  # Returns all torrents with errors.
+  def self.errors
     all.select { |t| t.attributes['error'] != 0 }
   end
 
+  # Returns the hash of every torrents.
   def self.hashes
     all.map { |t| t.attributes['hashString'] }
   end
 
-  # find torrents methods
+  # Returns all torrents whose name matches +name+.
   def self.find_by_name(name)
     re = name.split(' ').join('.*')
     all.select { |t| t.attributes['name'] =~ /#{re}/i }
   end
 
+  # Returns all torrents whose hash matches +hash+.
   def self.find_by_hash(hash)
-    all.select { |t| t.attributes['hashString'].casecmp(hash) == 0 }
+    all.select { |t| t.attributes['hashString'].casecmp(hash).zero? }
   end
 
+  # Returns all torrents whose id matches +id+.
   def self.find_by_id(id)
     all.select { |t| t.attributes['id'] == id }
   end
 
+  # Returns all torrents whose trackers match +tracker+.
+  # FIXME: regex matching is not very precise.
   def self.find_by_tracker(tracker)
     url_regex = /([-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b)(?:[-a-zA-Z0-9@:%_\+.~#?&\/=]*)/i
     re = tracker.split(' ').join('.*')
@@ -71,12 +84,4 @@ module Transmission
       trackers.any? { |r| r =~ /#{re}/i }
     end
   end
-
-  # add torrents methods
-  def self.add(file, connector = nil)
-    Transmission::Model::Torrent.add(
-      connector: connector,
-      arguments: { filename: file }
-    )
-  end
 end

data/lib/transmission/fields.rb

@@ -30,7 +30,7 @@ module Transmission
       include Transmission::Utils
 
       def is_valid?(key)
-        is_valid_key? key, self::ATTRIBUTES
+        valid_key? key, self::ATTRIBUTES
       end
 
       def real_key(key)

data/lib/transmission/model/torrent.rb

@@ -71,15 +71,10 @@ module Transmission
         connector.torrent_set_location @ids,  location: new_location, move: move
       end
 
-      def is_multi?
+      def multi?
         @ids.size > 1
       end
 
-      # Note: this is overidden by extensions.
-      # def finished?
-      #   percent_done == 1
-      # end
-
       def reload!
         torrents = Torrent.find @ids, connector: @connector
         @ids = torrents.ids
@@ -89,7 +84,7 @@ module Transmission
       end
 
       def to_json
-        if is_multi?
+        if multi?
           @torrents.inject([]) do |torrents, torrent|
             torrents << torrent.to_json
           end

data/lib/transmission/utils.rb

@@ -1,6 +1,6 @@
 module Transmission
   module Utils
-    def is_valid_key?(key, attributes)
+    def valid_key?(key, attributes)
       !attributes.select do |attribute|
         option_keys(key).include? attribute[:field]
       end.empty?

data/spec/transmission/extensions_spec.rb

@@ -0,0 +1,28 @@
+describe Transmission::Model::Torrent do
+  describe 'extensions' do
+    let(:torrent) { Transmission::Model::Torrent.new([{
+      'name' => 'ubuntu-16.04.1-desktop-amd64.iso',
+      'downloadDir' => '/home/user/downloads',
+      'id' => 1,
+      'hashString' => '9f9165d9a281a9b8e782cd5176bbcc8256fd1871'
+    }], nil) }
+
+    describe 'with any torrent' do
+      it 'should have a name' do
+        expect(torrent.name).not_to be_nil
+        expect(torrent.name).to be_a(String)
+      end
+
+      it 'should have a path' do
+        expect(torrent.path).not_to be_nil
+        expect(torrent.path).to eq(
+          '/home/user/downloads/ubuntu-16.04.1-desktop-amd64.iso'
+        )
+      end
+
+      it 'should have an hash' do
+        expect(torrent.hash).not_to be_nil
+      end
+    end
+  end
+end

data/spec/transmission/model/torrent_spec.rb

@@ -17,7 +17,7 @@ describe Transmission::Model::Torrent do
         @rpc = Transmission::RPC.new
         stub_rpc_request
           .with(body: torrent_get_body)
-          .to_return(successful_response( arguments: { torrents: [{ id: 1 }] }))
+          .to_return(successful_response(arguments: { torrents: [{ id: 1 }] }))
       end
 
       it 'should return a Torrent model instance' do
@@ -193,7 +193,7 @@ describe Transmission::Model::Torrent do
         stub_get_torrent({ ids: [1, 2] }, [{ id: 1 }, { id: 2 }])
         stub_rpc_request
           .with(body: torrent_remove_body(:ids => [1, 2], 'delete-local-data' => false))
-            .to_return(successful_response(arguments: { torrents: [{ id: 1 }, { id: 2 }]} ))
+          .to_return(successful_response(arguments: { torrents: [{ id: 1 }, { id: 2 }] }))
       end
 
       it 'should remove the torrent files' do
@@ -204,19 +204,19 @@ describe Transmission::Model::Torrent do
     end
   end
 
-  describe '#is_multi?' do
-    let(:torrents) { Transmission::Model::Torrent.new([{'id' => 1}, {'id' => 2}], nil) }
-    let(:torrent) { Transmission::Model::Torrent.new([{'id' => 1}], nil) }
+  describe '#multi?' do
+    let(:torrents) { Transmission::Model::Torrent.new([{ 'id' => 1 }, { 'id' => 2 }], nil) }
+    let(:torrent) { Transmission::Model::Torrent.new([{ 'id' => 1 }], nil) }
 
     describe 'with multiple torrents' do
       it 'should return true' do
-        expect(torrents.is_multi?).to eq(true)
+        expect(torrents.multi?).to eq(true)
       end
     end
 
     describe 'with single torrent' do
       it 'should return false' do
-        expect(torrent.is_multi?).to eq(false)
+        expect(torrent.multi?).to eq(false)
       end
     end
   end
@@ -233,7 +233,7 @@ describe Transmission::Model::Torrent do
 
     describe 'with single torrent' do
       it 'should return false' do
-        expect(torrent.to_json).to eq({ 'id' => 1 })
+        expect(torrent.to_json).to eq('id' => 1)
       end
     end
   end
@@ -256,11 +256,11 @@ describe Transmission::Model::Torrent do
   end
 
   describe '#method_missing' do
-    let(:torrent) { Transmission::Model::Torrent.new([{'id' => 1, 'name' => 'some name', 'some-key' => 'some-value'}], nil) }
+    let(:torrent) { Transmission::Model::Torrent.new([{ 'id' => 1, 'name' => 'some name', 'some-key' => 'some-value' }], nil) }
 
     before :each do
-      stub_const("Transmission::Fields::TorrentGet::ATTRIBUTES", [{field: 'id'}, {field: 'name'}, {field: 'some-key'}])
-      stub_const("Transmission::Arguments::TorrentSet::ATTRIBUTES", [{field: 'name'}])
+      stub_const('Transmission::Fields::TorrentGet::ATTRIBUTES', [{ field: 'id' }, { field: 'name' }, { field: 'some-key' }])
+      stub_const('Transmission::Arguments::TorrentSet::ATTRIBUTES', [{ field: 'name' }])
     end
 
     describe 'with existing attributes' do
@@ -292,14 +292,14 @@ describe Transmission::Model::Torrent do
   end
 
   describe '#save!' do
-    let(:rpc) {Transmission::RPC.new}
+    let(:rpc) { Transmission::RPC.new }
 
     before :each do
-      stub_const("Transmission::Arguments::TorrentSet::ATTRIBUTES", [{field: 'name'}, {field: 'ids'}])
-      stub_get_torrent({ids: [1]}, [{id: 1, name: 'test', comment: 'comment'}])
+      stub_const('Transmission::Arguments::TorrentSet::ATTRIBUTES', [{ field: 'name' }, { field: 'ids' }])
+      stub_get_torrent({ ids: [1] }, [{ id: 1, name: 'test', comment: 'comment' }])
       stub_rpc_request
-          .with(body: torrent_set_body({name: 'new value', ids: [1]}))
-          .to_return(successful_response)
+        .with(body: torrent_set_body(name: 'new value', ids: [1]))
+        .to_return(successful_response)
     end
 
     it 'should send the right parameters' do
@@ -310,28 +310,28 @@ describe Transmission::Model::Torrent do
   end
 
   [
-      {method: 'start!', rpc_method: 'torrent-start'},
-      {method: 'start_now!', rpc_method: 'torrent-start-now'},
-      {method: 'stop!', rpc_method: 'torrent-stop'},
-      {method: 'verify!', rpc_method: 'torrent-verify'},
-      {method: 're_announce!', rpc_method: 'torrent-reannounce'},
-      {method: 'move_up!', rpc_method: 'queue-move-up'},
-      {method: 'move_down!', rpc_method: 'queue-move-down'},
-      {method: 'move_top!', rpc_method: 'queue-move-top'},
-      {method: 'move_bottom!', rpc_method: 'queue-move-bottom'}
+    { method: 'start!', rpc_method: 'torrent-start' },
+    { method: 'start_now!', rpc_method: 'torrent-start-now' },
+    { method: 'stop!', rpc_method: 'torrent-stop' },
+    { method: 'verify!', rpc_method: 'torrent-verify' },
+    { method: 're_announce!', rpc_method: 'torrent-reannounce' },
+    { method: 'move_up!', rpc_method: 'queue-move-up' },
+    { method: 'move_down!', rpc_method: 'queue-move-down' },
+    { method: 'move_top!', rpc_method: 'queue-move-top' },
+    { method: 'move_bottom!', rpc_method: 'queue-move-bottom' }
   ].each do |object|
     describe "##{object[:method]}" do
-      let(:rpc) {Transmission::RPC.new}
+      let(:rpc) { Transmission::RPC.new }
 
       [
-          {ids: [1], response: [{id: 1}], text: ''},
-          {ids: [1, 2], response: [{id: 1}, {id: 2}], text: 'with multiple ids'}
+        { ids: [1], response: [{ id: 1 }], text: '' },
+        { ids: [1, 2], response: [{ id: 1 }, { id: 2 }], text: 'with multiple ids' }
       ].each do |args|
         before :each do
-          stub_get_torrent({ids: args[:ids]}, args[:response])
+          stub_get_torrent({ ids: args[:ids] }, args[:response])
           stub_rpc_request
-              .with(body: torrent_method_body(object[:rpc_method], {ids: args[:ids]}))
-              .to_return(successful_response)
+            .with(body: torrent_method_body(object[:rpc_method], ids: args[:ids]))
+            .to_return(successful_response)
         end
 
         it "should #{object[:method]} torrent #{args[:text]}" do
@@ -341,5 +341,4 @@ describe Transmission::Model::Torrent do
       end
     end
   end
-
 end

data/spec/transmission/rpc/connector_spec.rb

@@ -1,7 +1,5 @@
 describe Transmission::RPC::Connector do
-
   describe '#new' do
-
     describe 'without parameters' do
       before :each do
         @connector = Transmission::RPC::Connector.new
@@ -18,7 +16,16 @@ describe Transmission::RPC::Connector do
 
     describe 'with parameters' do
       before :each do
-        @connector = Transmission::RPC::Connector.new host: 'some.host', port: 8888, ssl: true, path: '/path', credentials: {username: 'a', password: 'b'}
+        @connector = Transmission::RPC::Connector.new(
+          host: 'some.host',
+          port: 8888,
+          ssl: true,
+          path: '/path',
+          credentials: {
+            username: 'a',
+            password: 'b'
+          }
+        )
       end
 
       it 'should create an RPC object with given parameters' do
@@ -26,22 +33,20 @@ describe Transmission::RPC::Connector do
         expect(@connector.port).to eq(8888)
         expect(@connector.ssl).to eq(true)
         expect(@connector.path).to eq('/path')
-        expect(@connector.credentials).to eq({username: 'a', password: 'b'})
+        expect(@connector.credentials).to eq(username: 'a', password: 'b')
       end
     end
-
   end
 
   describe '#post' do
-
     describe 'when session ID has not been acquired yet' do
       before :each do
         @connector = Transmission::RPC::Connector.new
         stub_rpc_request
-            .to_return(conflict_response({headers: {'x-transmission-session-id' => 'abc'}}))
+          .to_return(conflict_response(headers: { 'x-transmission-session-id' => 'abc' }))
         stub_rpc_request
-            .with(headers: {'x-transmission-session-id' => 'abc'})
-            .to_return(successful_response)
+          .with(headers: { 'x-transmission-session-id' => 'abc' })
+          .to_return(successful_response)
       end
 
       it 'should save the transmission session ID' do
@@ -54,7 +59,7 @@ describe Transmission::RPC::Connector do
       before :each do
         @connector = Transmission::RPC::Connector.new
         stub_rpc_request
-            .to_return(successful_response)
+          .to_return(successful_response)
       end
 
       it 'should respond successfully' do
@@ -67,7 +72,7 @@ describe Transmission::RPC::Connector do
       before :each do
         @connector = Transmission::RPC::Connector.new
         stub_rpc_request
-            .to_return(unauthorized_response)
+          .to_return(unauthorized_response)
       end
 
       it 'should raise auth error' do
@@ -76,7 +81,5 @@ describe Transmission::RPC::Connector do
         }.to raise_error(Transmission::RPC::Connector::AuthError)
       end
     end
-
   end
-
-end
+end

data/spec/transmission/utils_spec.rb

@@ -7,28 +7,28 @@ describe Transmission::Utils do
 
   subject { utils.new }
 
-  describe '.is_valid_key?' do
+  describe '.valid_key?' do
     describe 'with dashes' do
-      let(:arguments) {[{field: 'test-me'}]}
+      let(:arguments) { [{ field: 'test-me' }] }
 
       it 'should find valid key' do
-        expect(subject.is_valid_key?('test_me', arguments)).to eq(true)
+        expect(subject.valid_key?('test_me', arguments)).to eq(true)
       end
     end
 
     describe 'with camelcase' do
-      let(:arguments) {[{field: 'testMe'}]}
+      let(:arguments) { [{ field: 'testMe' }] }
 
       it 'should find valid key' do
-        expect(subject.is_valid_key?('test_me', arguments)).to eq(true)
+        expect(subject.valid_key?('test_me', arguments)).to eq(true)
       end
     end
 
     describe 'with invalid key' do
-      let(:arguments) {[{field: 'testMe'}]}
+      let(:arguments) { [{ field: 'testMe' }] }
 
       it 'should not find any key' do
-        expect(subject.is_valid_key?('i_dont_exit', arguments)).to eq(false)
+        expect(subject.valid_key?('i_dont_exit', arguments)).to eq(false)
       end
     end
   end
@@ -43,7 +43,7 @@ describe Transmission::Utils do
 
   describe '.option_key' do
     describe 'with dashes' do
-      let(:arguments) {[{field: 'test-me'}]}
+      let(:arguments) { [{ field: 'test-me' }] }
 
       it 'should return the correct key' do
         expect(subject.option_key('test_me', arguments)).to eq('test-me')
@@ -51,7 +51,7 @@ describe Transmission::Utils do
     end
 
     describe 'with camelcase' do
-      let(:arguments) {[{field: 'testMe'}]}
+      let(:arguments) { [{ field: 'testMe' }] }
 
       it 'should return the correct key' do
         expect(subject.option_key('test_me', arguments)).to eq('testMe')
@@ -59,7 +59,7 @@ describe Transmission::Utils do
     end
 
     describe 'with invalid key' do
-      let(:arguments) {[{field: 'testMe'}]}
+      let(:arguments) { [{ field: 'testMe' }] }
 
       it 'should return nil' do
         expect(subject.option_key('i_dont_exit', arguments)).to eq(nil)

data/transmission-rpc-ruby-ext.gemspec

@@ -1,17 +1,24 @@
-Gem::Specification.new do |s|
-  s.name        = 'transmission-rpc-ruby-ext'
-  s.version     = '0.1.0'
-  s.date        = '2016-12-28'
-  s.summary     = 'Extended version of transmission-rpc-ruby.'
-  s.description = 'A fork of transmission-rpc-ruby with some shortcut methods added.'
-  s.authors     = ['Tommaso Barbato']
-  s.email       = 'epistrephein@gmail.com'
-  s.files       = `git ls-files`.split($/)
-  s.homepage    = 'https://github.com/epistrephein/transmission-rpc-ruby-ext'
-  s.license     = 'MIT'
-  s.require_paths = ['lib']
-  s.add_dependency 'faraday', '~> 0.10'
-  s.add_development_dependency 'rspec', '~> 3.5'
-  s.add_development_dependency 'webmock', '~> 2.3'
-  s.add_development_dependency 'rake', '~> 12.0'
+Gem::Specification.new do |spec|
+  spec.name          = 'transmission-rpc-ruby-ext'
+  spec.version       = '0.1.1'
+  spec.date          = '2016-12-31'
+
+  spec.authors       = ['Tommaso Barbato']
+  spec.email         = 'epistrephein@gmail.com'
+
+  spec.summary       = 'Extended fork of transmission-rpc-ruby.'
+  spec.description   = 'A fork of transmission-rpc-ruby with shortcut methods and revised codebase.'
+  spec.homepage      = 'https://github.com/epistrephein/transmission-rpc-ruby-ext'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency 'faraday', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'rake', '~> 12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transmission-rpc-ruby-ext
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tommaso Barbato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
-description: A fork of transmission-rpc-ruby with some shortcut methods added.
+description: A fork of transmission-rpc-ruby with shortcut methods and revised codebase.
 email: epistrephein@gmail.com
 executables: []
 extensions: []
@@ -91,8 +91,9 @@ files:
 - lib/transmission/extensions.rb
 - lib/transmission/extensions/torrent_actions.rb
 - lib/transmission/extensions/torrent_attributes.rb
+- lib/transmission/extensions/torrent_prettify.rb
 - lib/transmission/extensions/torrent_status.rb
-- lib/transmission/extensions/transmission.rb
+- lib/transmission/extensions/transmission_selectors.rb
 - lib/transmission/fields.rb
 - lib/transmission/fields/session_get.rb
 - lib/transmission/fields/session_stats.rb
@@ -107,6 +108,7 @@ files:
 - spec/helpers/stubs.rb
 - spec/spec_helper.rb
 - spec/transmission/arguments_spec.rb
+- spec/transmission/extensions_spec.rb
 - spec/transmission/fields_spec.rb
 - spec/transmission/model/session_spec.rb
 - spec/transmission/model/torrent_spec.rb
@@ -126,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -137,5 +139,15 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Extended version of transmission-rpc-ruby.
-test_files: []
+summary: Extended fork of transmission-rpc-ruby.
+test_files:
+- spec/helpers/stubs.rb
+- spec/spec_helper.rb
+- spec/transmission/arguments_spec.rb
+- spec/transmission/extensions_spec.rb
+- spec/transmission/fields_spec.rb
+- spec/transmission/model/session_spec.rb
+- spec/transmission/model/torrent_spec.rb
+- spec/transmission/rpc/connector_spec.rb
+- spec/transmission/rpc_spec.rb
+- spec/transmission/utils_spec.rb