retort 0.0.4 → 0.0.5

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Marcel C. Morgan
+
+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.rdoc

@@ -1,5 +1,35 @@
 = Retort
 
-rtorrent xmlrpc wrapper written in ruby (1.9). Designed to decouple the 
+rtorrent xmlrpc wrapper written in ruby (1.9). Designed to decouple the
 xmlrpc interface from the underlying ruby objects.
 
+== Basic usage
+
+Update your Gemfile with this and do a bundle install:
+
+  gem 'retort'
+
+To get a list of all torrents:
+
+  require 'retort'
+  Retort::Torrent.all
+
+== Contributions
+
+To fetch & test the library for development, do:
+
+  $ git clone https://github.com/mcmorgan/retort
+  $ cd retort
+  $ bundle
+  $ bundle exec rspec spec
+
+If you want to contribute, please:
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Send me a pull request on Github.
+
+== Copyright
+
+Copyright (c) 2010-2011 Marcel Morgan. See LICENSE for details.

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/retort/conversion.rb

@@ -1,22 +1,24 @@
-module Retort::Conversion
+class Retort::Rtorrent
 
+    TYPES = {
+      time: 'to_time',
+      date: 'to_date',
+      size: 'to_xb'
+    }
 
-  class Call
-    TYPES = { time: 'to_time', date: 'to_date', size: 'to_xb' }
-    attr_accessor :attributes
+    attr_accessor :attributes, :attributes_raw
 
     def initialize(prefix)
       @attributes = {}
+      @attributes_raw = {}
       @prefix = prefix
     end
 
-    def method_missing(*args, &block)
-      property = args.shift
-      options = args.shift || {}
-
+    def attribute(property, options = {}, &block)
       type = options[:type]
       method_name = options[:name] || property
       method_name = "#{@prefix}.#{method_name}" unless @prefix.empty?
+      @attributes_raw[property] = method_name
 
       if TYPES.member? type
         #Syntax is 'to_*=$.....'. Example : 'to_date=$d.get_creation_date'.
@@ -25,13 +27,14 @@ module Retort::Conversion
       end
       @attributes[property] = method_name
     end
-  end
 
-  def build(prefix="")
-    c = Call.new prefix
-    yield c
-    c.attributes
-  end
+    alias method_missing attribute
+
+    def self.build(prefix="", &block)
+      c = new(prefix)
+      c.instance_eval(&block)
+      c.attributes
+    end
 
 end
 

data/lib/retort/service.rb

@@ -14,8 +14,14 @@ module Retort
         @@service = XMLRPC::Client.new2(config.url)
       end
 
+      # by default, if configure hasn't been call the url will be defaulted
+      # to http://localhost/RPC2
+      def service
+        @@service ||= XMLRPC::Client.new2("http://elijah/RPC2")
+      end
+
       def call(*args)
-        @@service.call_async *args
+        service.call_async *args
       end
 
     end

data/lib/retort/torrent.rb

@@ -2,34 +2,31 @@ module Retort
 
   class Exception; end
 
-  class Torrent
-    extend Retort::Conversion
+  class Torrent < Rtorrent
 
     class << self
       def attr_mappings
-
-        build(:d) do |t|
-          t.info_hash           name: 'hash'
-          t.name
-          t.connection_current
-          t.size                name: 'size_bytes',       type: :size
-          t.completed           name: 'completed_bytes',  type: :size
-          t.creation_date       name: 'creation_date',    type: :date
-          t.downloaded          name: 'bytes_done',       type: :size
-          t.up_rate             name: 'up.rate',          type: :size
-          t.down_rate           name: 'down.rate',        type: :size
-          t.message             name: 'get_message'
-          t.seeders             name: 'peers_complete'
-          t.leechers            name: 'peers_connected'
-          t.state
-          t.complete
-          t.is_active
-          t.is_hash_checked
-          t.is_hash_checking
-          t.is_multi_file
-          t.is_open
+        @@mappings ||= build(:d) do
+          info_hash           name: 'hash'
+          name
+          connection_current
+          size                name: 'size_bytes',       type: :size
+          completed           name: 'completed_bytes',  type: :size
+          creation_date       name: 'creation_date',    type: :date
+          downloaded          name: 'bytes_done',       type: :size
+          up_rate             name: 'up.rate',          type: :size
+          down_rate           name: 'down.rate',        type: :size
+          message             name: 'get_message'
+          seeders             name: 'peers_complete'
+          leechers            name: 'peers_connected'
+          state
+          complete
+          is_active
+          is_hash_checked
+          is_hash_checking
+          is_multi_file
+          is_open
         end
-
       end
 
       def all(view="main")

data/lib/retort/version.rb

@@ -1,3 +1,3 @@
 module Retort
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/retort.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
 end

data/spec/rtorrent/methods_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Retort::Torrent do
+  it "has all methods listed" do
+    all_methods = Retort::Service.call "system.listMethods"
+    torrent_methods = Retort::Torrent.attr_mappings.values.reject {|x| x =~ /\$/}
+    x = torrent_methods.reject {|m| all_methods.include?(m)}
+    x.size.should == 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'retort' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retort
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-04 00:00:00.000000000Z
-dependencies: []
+date: 2011-09-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11591600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11591600
 description: An rTorrent xmlrpc wrapper written in ruby
 email:
 - marcel.morgan@gmail.com
@@ -19,10 +30,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
+- LICENSE
 - README.rdoc
 - Rakefile
+- autotest/discover.rb
 - lib/retort.rb
 - lib/retort/conversion.rb
 - lib/retort/core_ext.rb
@@ -31,6 +45,8 @@ files:
 - lib/retort/version.rb
 - lib/retort/xmlrpc_client.rb
 - retort.gemspec
+- spec/rtorrent/methods_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mcmorgan/retort
 licenses: []
 post_install_message: 
@@ -55,4 +71,6 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An rTorrent xmlrpc wrapper written in ruby
-test_files: []
+test_files:
+- spec/rtorrent/methods_spec.rb
+- spec/spec_helper.rb