atheme-ruby 0.0.5 → 0.0.6

data/lib/atheme.rb

@@ -3,6 +3,8 @@ end
 
 require "xmlrpc/client"
 
+require 'active_support/inflector'
+
 require "atheme/error"
 require "atheme/helpers"
 require "atheme/version"

data/lib/atheme/entities/channel.rb

@@ -1,5 +1,5 @@
 module Atheme
-  class Channel < Entity
+  class Channel < EntityBase
 
     def fetch! #:nodoc:
       @session.chanserv.info(@token)

data/lib/atheme/entity.rb

@@ -24,6 +24,8 @@ module Atheme
       self.send(meth, *args, &block)
     end
 
+    def to_ary; end
+
     def fetch!
       raise "#{self} does not know how to update itself. Slap the developer!"
     end

data/lib/atheme/helpers.rb

@@ -11,4 +11,14 @@ module Atheme::Helpers
 
     constant
   end
+
+  class List < Array
+
+    def method_missing(method, *args, &block)
+      method = method.to_s.singularize.to_sym
+      return self.map {|v| v[method] }.flatten if self.first.has_key? method
+      super
+    end
+
+  end
 end

data/lib/atheme/service.rb

@@ -28,9 +28,10 @@ module Atheme
 
       def call(session, raw_output)
         @raw_output = raw_output
+        @session = session
         value = self.instance_eval(&@block)
         return value if !@opts[:as] || value.nil?
-        @opts[:as].new(session, value)
+        @opts[:as].new(@session, value)
       end
 
       private
@@ -38,6 +39,10 @@ module Atheme
         @raw_output
       end
 
+      def session
+        @session
+      end
+
       def match(expression)
         raw_output[expression, 1]
       end
@@ -66,8 +71,8 @@ module Atheme
       @@staged_parser.register_command(Atheme::Service::Command.new(name, opts, &block))
     end
 
-    def self.responds_with(atheme_class)
-      @@staged_parser.responder = atheme_class
+    def self.responds_with(atheme_class=nil, &block)
+      @@staged_parser.responder = atheme_class || block
     end
 
     def initialize(session)
@@ -76,19 +81,34 @@ module Atheme
 
     def method_missing(method, *args, &block)
       raw_output = @session.service_call(service_name, method, *args)
-      if raw_output.kind_of?(Atheme::Error)
-        return raw_output
-      end
+      
+      #if an error occurred, just return it to the user
+      return raw_output if raw_output.kind_of?(Atheme::Error)
+
+      #building up the response hash...
       response = {raw_output: raw_output}
+
+      #get the parser of the method registered with 'parse :key'
       parser = @@parsers.has_key?(service_name) && @@parsers[service_name][method]
 
+      #no parser is available, return generic Entity which holds only the raw_output
       return Atheme::Entity.new(@session, response, &block) unless parser
-      
+
+      #a responds_with is defined and associates a block
+      #we do not need any further command-handling
+      #as we only serve the raw_output if the request
+      return parser.responder.call(@session, response[:raw_output]) if parser.responder && parser.responder.kind_of?(Proc)
+
+      #add further commands/key-values to the hash registered with 'command :key'
       parser.commands.each do |command|
         response[command.name] = command.call(@session, raw_output)
       end
+      
+      #create a special Entity registered with resonds_with if available
       return parser.responder.new(@session, response, &block) if parser.responder
-      return response
+
+      #last but not least, return a generic Entity but with extended commands/values
+      return Atheme::Entity.new(@session, response, &block)
     end
 
     private

data/lib/atheme/services/chanserv.rb

@@ -1,23 +1,31 @@
 module Atheme
   class ChanServ < Service
 
+    # Returns an Atheme::Channel entity which holds all information about the requested channel
     parse :info do
       responds_with Atheme::Channel
     end
 
+    # Returns an Atheme::Helpers::List
+    # with {channel: Atheme::Channel, founder: Atheme::User}
     parse :list do
-      command :to_a do
+      responds_with do |session, raw_output|
         output = raw_output.split("\n")
         output.delete_at(0)
         output.delete_at(output.length - 1)
 
-        output.map do |info|
+        output.map! do |info|
           out = info.sub('- ', '').split('(')
           channel = out[0].sub(' ', '')
           owner = out[1].sub(')', '').sub(' ', '')
 
-          { channel: channel, owner: owner }
+          {
+            channel: Atheme::Channel.new(session, channel),
+            founder: Atheme::User.new(session, owner)
+          }
         end
+
+        Atheme::Helpers::List.new(output)
       end
     end
   end

data/lib/atheme/services/hostserv.rb

@@ -1,4 +1,22 @@
 module Atheme
   class HostServ < Service
+
+    # Returns an Atheme::Helpers::List
+    # with {user: Atheme::User, vhost: String}
+    parse :listvhost do
+      responds_with do |session, raw_output|
+        output = raw_output.split("\n")[0..-2]
+
+        output.map! do |info|
+          out = info.split(" ")
+          {
+            user: Atheme::User.new(session, out[1]),
+            vhost: out[2]
+          }
+        end
+
+        Atheme::Helpers::List.new(output)
+      end
+    end
   end
 end

data/lib/atheme/version.rb

@@ -1,3 +1,3 @@
 module Atheme
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atheme-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler