atheme-ruby 0.0.4 → 0.0.5

data/Rakefile

@@ -1 +1,21 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test
+
+desc 'Generate documentation for Atheme-Ruby.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Atheme-Ruby'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/atheme-ruby.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda-context"
 end

data/lib/atheme/entity.rb

@@ -28,6 +28,14 @@ module Atheme
       raise "#{self} does not know how to update itself. Slap the developer!"
     end
 
+    def error?
+      false
+    end
+
+    def success?
+      true
+    end
+
     def do_fetch!
       @updated = true
       result = fetch!

data/lib/atheme/service.rb

@@ -75,10 +75,9 @@ module Atheme
     end
 
     def method_missing(method, *args, &block)
-      begin
-        raw_output = @session.service_call(service_name, method, *args)
-      rescue
-        return Atheme::Error.new
+      raw_output = @session.service_call(service_name, method, *args)
+      if raw_output.kind_of?(Atheme::Error)
+        return raw_output
       end
       response = {raw_output: raw_output}
       parser = @@parsers.has_key?(service_name) && @@parsers[service_name][method]
@@ -88,7 +87,8 @@ module Atheme
       parser.commands.each do |command|
         response[command.name] = command.call(@session, raw_output)
       end
-      parser.responder.new(@session, response, &block) if parser.responder
+      return parser.responder.new(@session, response, &block) if parser.responder
+      return response
     end
 
     private

data/lib/atheme/session.rb

@@ -1,11 +1,13 @@
 module Atheme
   class Session
 
+    # Connection settings which are used on default
     DEFAULT_CONNECTION_SETTINGS = {
       protocol: 'http',
       hostname: 'localhost',
       port: '8080'
     }
+    # Default IP for connections if noone is specified on login
     DEFAULT_IP = '127.0.0.1'
 
     def initialize(opts={})
@@ -21,17 +23,29 @@ module Atheme
       @cookie, @user, @ip = '.', '.', DEFAULT_IP
     end
 
+    # Login with an username and passwortd into atheme.
+    # The creditials are the same as in IRC.
+    # IP is optional and only for logging purposes, defaults to 127.0.0.1.
+    # Returns a cookie on success, an Atheme::Error otherwise
     def login(user, password, ip=DEFAULT_IP)
-      return true if logged_in?
-      @cookie = self.call("atheme.login", user, password, ip)
-      @user, @ip = user, ip
-      @cookie
+      cookie_or_error = self.call("atheme.login", user, password, ip)
+      if cookie_or_error.kind_of?(String)
+        @cookie, @user, @ip = cookie_or_error, user, ip
+      else # should be Atheme::Error
+        @cookie, @user, @ip = '.', '.', DEFAULT_IP
+      end
+      return cookie_or_error
     end
 
+    # Relogin into the services using a previously created cookie
+    # and the associated username.
     def relogin(cookie, user, ip=DEFAULT_IP)
       @cookie, @user, @ip = cookie, user, ip
+      logged_in?
     end
 
+    # Logs out from the current session if previously logged in.
+    # Always returns true
     def logout
       return true unless logged_in?
       self.call("atheme.logout", @cookie, @user, @ip)
@@ -39,15 +53,30 @@ module Atheme
       true
     end
 
+    # Returns true if we are currently logged in and the cookie is a valid one; false otherwise.
     def logged_in?
-      @cookie && @cookie!='.' ? true : false
+      return false if @cookie.nil? || @cookie=='.'
+      #need to call a dummy command to decide if the cookie is still valid
+      #as we think that we are a valid user, /ns info 'self' should succeed
+      self.nickserv.info(@user).success?
+    end
+
+    # Returns an Atheme::User object of the current user who is logged in
+    # Returns false, if noone is currently logged in
+    def myself
+      return false unless logged_in?
+      self.nickserv.info(@user)
     end
 
+    # Send raw XMLRPC calls to the Atheme API
     def call(*args)
       @server ||= connect_client
-      @server.call(*args)
+      return @server.call(*args)
+    rescue
+      return Atheme::Error.new
     end
 
+    # Shorthand method for service-calls through the Atheme API
     def service_call(service, method, *args)
       self.call("atheme.command", @cookie, @user, @ip, service, method, *args)
     end

data/lib/atheme/version.rb

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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'shoulda-context'
+require 'atheme'

data/test/user_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class UserTest < Test::Unit::TestCase
+  context "an user" do
+    setup do
+      @session = Atheme::Session.new
+      @cookie = @session.login("oper", "oper123")
+      raise "Cannot login into oper (pw: oper123)" unless @cookie.kind_of?(String)
+    end
+
+    should "call #myself, returning own Atheme::User" do
+      assert_equal true, @session.myself.respond_to?(:name) && @session.myself.name == "oper"
+    end
+
+    should "logout successfully" do
+      assert_equal true, @session.logout
+      assert_equal false, @session.logged_in?
+    end
+
+    should "relogin successfully" do
+      assert_equal true, @session.relogin(@cookie, "oper")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atheme-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a ruby interface for Atheme's XMLRPC API
 email:
 - noxx@penya.de
@@ -77,6 +93,8 @@ files:
 - lib/atheme/services/statserv.rb
 - lib/atheme/session.rb
 - lib/atheme/version.rb
+- test/test_helper.rb
+- test/user_test.rb
 homepage: http://github.com/Flauschbaellchen/atheme-ruby
 licenses:
 - MIT
@@ -102,5 +120,7 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Atheme-XMLRPC interface for Ruby
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/user_test.rb
 has_rdoc: