atheme-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in atheme-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Noxx
+
+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,105 @@
+# atheme-ruby
+The gem was inspired by the one of [jameswritescode/atheme-ruby](https://github.com/jameswritescode/atheme-ruby/).
+However, his gem use module-methods and thus does not allow concurrent connections within the same script.
+
+## Install
+
+Currently, no official gem yet exists, so you need to clone the repository and build it yourself:
+
+    git clone git@github.com:Flauschbaellchen/atheme-ruby.git
+    cd atheme-ruby
+    gem build atheme-ruby.gemspec
+    gem install atheme-ruby-x.x.x.gem
+
+Standalone script:
+
+    require 'atheme'
+
+Bundler/Rails:
+
+    gem 'atheme-ruby', require: 'atheme'
+
+And you're ready to rumble!
+
+## Usage
+
+To instantiate, you can either pass the required arguments as options in a
+hash, like so:
+
+    Atheme::Session.new(
+      protocol: "http",
+      hostname: "localhost",
+      port: 8080
+    )
+
+and/or use the builder idiom:
+
+    Atheme::Session.new do |c| 
+      c.protocol = "http"
+      c.hostname = "localhost"
+      c.port = 8080
+    end
+
+If an option is missing, the default ones as stated above are used.
+
+### Login
+
+The initial session uses an anonymous login which can be re-choosen by calling @session.anonymous! or by logging out.
+
+To login with an account registered with NickServ use the following:
+
+    @session.login(username, password, ip="127.0.0.1") #=> you'll get a cookie on success
+    @session.logged_in? #=> true or false
+
+The cookie is a random generated string from Atheme for your current login session and will be valid for one(1) hour or until the server is shut down or restarted.
+
+You can relogin using the cookie by calling:
+
+    @session.relogin(cookie, user, ip="127.0.0.1")
+
+which saves you from asking users everytime again for their passwords.
+
+You may logout after you finished your work:
+
+    @session.logout
+
+### Service-Calls
+
+This gem supports all service-bots of atheme, like chanserv, nickserv etc.
+You can call any commands you want to perform like you do on IRC:
+
+    @session.chanserv.info('#opers') # like /msg chanserv info #opers
+    @session.chanserv.list           # like /msg chanserv list
+
+I think you're getting the point...
+However, you can perform additional questions on these return values:
+
+    @session.chanserv.info('#opers').founder      #=> #<Atheme::User ...>
+    @session.chanserv.info('#opers').founder.name #=> "Nick_Of_Founder"
+    @session.chanserv.info('#opers').registered   #=> #<Date: 2013-05-13 ((2456426j,0s,0n),+0s,2299161j)>
+
+Take a look into _lib/atheme/services/*_ to find available subcommands.
+
+TODO
+----
+* Tests!
+* Docs!
+* Add more parsers/subcommands to all kinds of services (pull requests welcome)
+* Brainstorming: Catch API-Errors and handle them gracefully. Provide a #success? method to decide if the command was successfully executed or not. Need to handle chains like the ones above.
+
+Contributing to atheme-ruby
+---------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2013 Noxx/Flauschbaellchen. See LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/atheme-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 'atheme/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "atheme-ruby"
+  spec.homepage = "http://github.com/Flauschbaellchen/atheme-ruby"
+  spec.license = "MIT"
+  spec.summary = %Q{Atheme-XMLRPC interface for Ruby}
+  spec.description = %Q{Provides a ruby interface for Atheme's XMLRPC API}
+  spec.email = ["noxx@penya.de"]
+  spec.authors = ["Noxx"]
+  spec.version = Atheme::VERSION
+
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/atheme.rb

@@ -0,0 +1,11 @@
+module Atheme
+end
+
+require "xmlrpc/client"
+
+require "atheme/helpers"
+require "atheme/version"
+require "atheme/session"
+require "atheme/entity"
+require "atheme/service"
+

data/lib/atheme/entities/channel.rb

@@ -0,0 +1,7 @@
+module Atheme
+  class Channel < Entity
+    def fetch!
+      @session.chanserv.info(@token)
+    end
+  end
+end

data/lib/atheme/entities/user.rb

@@ -0,0 +1,7 @@
+module Atheme
+  class User < EntityBase
+    def fetch!
+      @session.nickserv.info(@token)
+    end
+  end
+end

data/lib/atheme/entity.rb

@@ -0,0 +1,56 @@
+module Atheme
+  class EntityBase
+
+    attr_reader :token
+    def initialize(session, hash_or_token)
+      @session = session
+      if hash_or_token.kind_of?(Hash)
+        @updated = true
+        hash_or_token.each do |k, v|
+          self.instance_variable_set("@#{k}".to_sym, v)
+          define_singleton_method(k) { v }
+        end
+      else
+        @updated = false
+        @token = hash_or_token
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      super if @updated || !fetchable?
+      do_fetch!
+      self.send(meth, *args, &block)
+    end
+
+    def fetch!
+      raise "#{self} does not know how to update itself. Slap the developer!"
+    end
+
+    def do_fetch!
+      @updated = true
+      result = fetch!
+      result.instance_variables.each do |key|
+        next if [:@session, :@updated, :@token].include? key
+        v = result.instance_variable_get(key)
+        self.instance_variable_set(key, v)
+        define_singleton_method(key.to_s[1..-1].to_sym) { v }
+      end
+    end
+    
+    def fetchable?
+      true
+    end
+
+    private :do_fetch!, :fetchable?
+  end
+
+  class Entity < EntityBase
+    def fetchable?
+      false
+    end
+  end
+end
+
+Dir[File.expand_path('../entities/*.rb', __FILE__)].each { |file|
+  require file
+}

data/lib/atheme/helpers.rb

@@ -0,0 +1,14 @@
+module Atheme::Helpers
+  def self.constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+
+    names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+
+    constant
+  end
+end

data/lib/atheme/service.rb

@@ -0,0 +1,101 @@
+module Atheme
+  class Service
+    @@parsers = Hash.new
+    @@tmp_commands = []
+    @@tmp_class = nil
+
+    class Parser
+      attr_accessor :responder
+      attr_reader :commands
+
+      def initialize
+        @commands = []
+      end
+
+      def register_command(command)
+        @commands << command
+      end
+    end
+
+    class Command
+      attr_reader :name, :block
+
+      def initialize(name, opts, &block)
+        @name = name
+        @block = block
+        @opts = opts
+      end
+
+      def call(session, raw_output)
+        @raw_output = raw_output
+        value = self.instance_eval(&@block)
+        return value unless @opts[:as] || value.nil?
+        @opts[:as].new(session, value)
+      end
+
+      private
+      def raw_output
+        @raw_output
+      end
+
+      def match(expression)
+        ematch = expression.match(raw_output)
+        ematch && ematch[1]
+      end
+    end
+
+
+    def self.inherited(klass)
+      class_name = klass.name.gsub('Atheme::', '')
+      Atheme::Session.class_eval <<-RUBY
+        def #{class_name.downcase}
+          @#{class_name.downcase} ||= #{klass.name}.new(self)
+        end
+      RUBY
+
+      @@parsers[class_name.downcase] ||= Hash.new
+    end
+
+    def self.parse(cmd, &block)
+      service = self.name.sub('Atheme::', '').downcase
+      @@parsers[service][cmd] = Atheme::Service::Parser.new
+      @@staged_parser = @@parsers[service][cmd]
+      yield if block_given?
+    end
+
+    def self.command(name, opts={}, &block)
+      @@staged_parser.register_command(Atheme::Service::Command.new(name, opts, &block))
+    end
+
+    def self.responds_with(atheme_class)
+      @@staged_parser.responder = atheme_class
+    end
+
+    def initialize(session)
+      @session = session
+    end
+
+    def method_missing(method, *args, &block)
+      raw_output = @session.service_call(service_name, method, *args)
+
+      response = {raw_output: raw_output}
+      parser = @@parsers.has_key?(service_name) && @@parsers[service_name][method]
+
+      return Atheme::Entity.new(@session, response) unless parser
+      
+      parser.commands.each do |command|
+        response[command.name] = command.call(@session, raw_output)
+      end
+      parser.responder.new(@session, response) if parser.responder
+    end
+
+    private
+    def service_name
+      self.class.name.gsub('Atheme::', '').downcase
+    end
+  end
+end
+
+Dir[File.expand_path('../services/*.rb', __FILE__)].each { |file|
+  require file
+}

data/lib/atheme/services/chanserv.rb

@@ -0,0 +1,61 @@
+module Atheme
+  class ChanServ < Service
+
+    parse :info do
+      responds_with Atheme::Channel
+
+      command :name do
+        match(/^Information\son\s([&#+][^:]+):$/)
+      end
+
+      command :founder, as: Atheme::User do
+        match(/Founder\s+:\s+(\w+)/)
+      end
+
+      command :successor, as: Atheme::User do
+        match(/Successor\s+:\s+\(none\)/) ? nil : match(/Successor\s+:\s+(\w+)/)
+      end
+
+      command :registered do
+        Date.parse(match(/Registered\s+:\s+(\w+ [0-9]{2} [0-9(:?)]+ [0-9]{4})/))
+      end
+
+      command :last_used do
+        Date.parse(match(/Last\sused\s+:\s+(\w+ [0-9]{2} [0-9(:?)]+ [0-9]{4})/))
+      end
+
+      command :mode_lock do
+        match(/Mode\slock\s+:\s+([-+A-Za-z0-9]*)/)
+      end
+
+      command :entry_msg do
+        match(/Entrymsg\s+:\s+(.+)/)
+      end
+
+      command :flags do
+        flags = match(/Flags\s+:\s+(\w+(?:\s\w+)*)$/)
+        flags && flags.split || []
+      end
+
+      command :prefix do
+        match(/Prefix\s+:\s+([^\s])/)
+      end
+    end
+
+    parse :list do
+      command :to_a do
+        output = raw_output.split("\n")
+        output.delete_at(0)
+        output.delete_at(output.length - 1)
+
+        output.map do |info|
+          out = info.sub('- ', '').split('(')
+          channel = out[0].sub(' ', '')
+          owner = out[1].sub(')', '').sub(' ', '')
+
+          { channel: channel, owner: owner }
+        end
+      end
+    end
+  end
+end

data/lib/atheme/services/gameserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class GameServ < Service
+  end
+end

data/lib/atheme/services/global.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class Global < Service
+  end
+end

data/lib/atheme/services/groupserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class GroupServ < Service
+  end
+end

data/lib/atheme/services/helpserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class HelpServ < Service
+  end
+end

data/lib/atheme/services/hostserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class HostServ < Service
+  end
+end

data/lib/atheme/services/infoserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class InfoServ < Service
+  end
+end

data/lib/atheme/services/memoserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class MemoServ < Service
+  end
+end

data/lib/atheme/services/nickserv.rb

@@ -0,0 +1,68 @@
+module Atheme
+  class NickServ < Service
+
+    parse :info do
+      responds_with Atheme::User
+
+      command :name do
+        match(/^Information\son\s([^\s]+)/)
+      end
+
+      command :account, as: Atheme::User do
+        match(/\(account\s([^\(]+)\):/)
+      end
+
+      command :registered do
+        Date.parse(match(/Registered\s+:\s+(\w+ [0-9]{2} [0-9(:?)]+ [0-9]{4})/))
+      end
+
+      command :entity_id do
+        match(/Entity\sID\s+:\s+([A-F0-9]+)$/)
+      end
+
+      command :vhost do
+        match(/vHost\s+:\s+([^\s]+)$/)
+      end
+
+      command :real_address do
+        match(/Real\saddr\s+:\s+([^\s]+)$/)
+      end
+
+      command :last_seen do
+        Date.parse(match(/Last\sseen\s+:\s+(\w+ [0-9]{2} [0-9(:?)]+ [0-9]{4})/))
+      end
+
+      command :user_seen do
+        time = match(/User\sseen\s+:\s+(\w+ [0-9]{2} [0-9(:?)]+ [0-9]{4})/)
+        time && Date.parse(time)
+      end
+
+      command :nicks do
+        nicks = match(/Nicks\s+:\s+([^\s]+(?:\s[^\s]+)*)$/)
+        nicks && nicks.split || []
+      end
+
+      command :email do
+        match(/Email\s+:\s+([^\s]+)/)
+      end
+
+      command :language do
+        match(/Language\s+:\s+([\w]+)$/)
+      end
+
+      command :flags do
+        flags = match(/Flags\s+:\s+(\w+(?:\s\w+)*)$/)
+        flags && flags.split || []
+      end
+
+      command :protected do
+        match(/has\s(enabled)\snick\sprotection/) ? true : false
+      end
+
+      command :groups do
+        flags = match(/Groups\s+:\s+(.+)$/)
+        flags && flags.split || []
+      end
+    end
+  end
+end

data/lib/atheme/services/operserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class OperServ < Service
+  end
+end

data/lib/atheme/services/rpgserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class RPGServ < Service
+  end
+end

data/lib/atheme/services/statserv.rb

@@ -0,0 +1,4 @@
+module Atheme
+  class StatServ < Service
+  end
+end

data/lib/atheme/session.rb

@@ -0,0 +1,87 @@
+module Atheme
+  class Session
+
+    DEFAULT_CONNECTION_SETTINGS = {
+      protocol: 'http',
+      hostname: 'localhost',
+      port: '8080'
+    }
+    DEFAULT_IP = '127.0.0.1'
+
+    def initialize(opts={})
+      opts.each_key do |k|
+        if self.respond_to?("#{k}=")
+          self.send("#{k}=", opts[k])
+        else
+          raise ArgumentError, "Argument '#{k}' is not allowed"
+        end
+      end
+
+      yield self if block_given?
+
+      self.anonymous!
+    end
+
+    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
+    end
+
+    def relogin(cookie, user, ip=DEFAULT_IP)
+      @cookie, @user, @ip = cookie, user, ip
+    end
+
+    def logout
+      return true unless logged_in?
+      self.call("atheme.logout", @cookie, @user, @ip)
+      @cookie, @user, @ip = '.', '.', DEFAULT_IP
+      true
+    end
+    alias_method :anonymous!, :logout
+
+    def logged_in?
+      @cookie && @cookie!='.' ? true : false
+    end
+
+    def call(*args)
+      @server ||= connect_client
+      @server.call(*args)
+    end
+
+    def service_call(service, method, *args)
+      self.call("atheme.command", @cookie, @user, @ip, service, method, *args)
+    end
+
+    def protocol=(p)
+      @protocol = p
+    end
+
+    def hostname=(h)
+      @hostname = h
+    end
+
+    def port=(p)
+      @port = p.to_i
+    end
+
+    def protocol
+      @protocol || DEFAULT_CONNECTION_SETTINGS[:protocol]
+    end
+
+    def hostname
+      @hostname || DEFAULT_CONNECTION_SETTINGS[:hostname]
+    end
+
+    def port
+      @port || DEFAULT_CONNECTION_SETTINGS[:port]
+    end
+
+    private
+
+    def connect_client
+      @server = XMLRPC::Client.new2("#{self.protocol}://#{self.hostname}:#{self.port}/xmlrpc")
+    end
+  end
+end

data/lib/atheme/version.rb

@@ -0,0 +1,3 @@
+module Atheme
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: atheme-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Noxx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- atheme-ruby.gemspec
+- lib/atheme.rb
+- lib/atheme/entities/channel.rb
+- lib/atheme/entities/user.rb
+- lib/atheme/entity.rb
+- lib/atheme/helpers.rb
+- lib/atheme/service.rb
+- lib/atheme/services/chanserv.rb
+- lib/atheme/services/gameserv.rb
+- lib/atheme/services/global.rb
+- lib/atheme/services/groupserv.rb
+- lib/atheme/services/helpserv.rb
+- lib/atheme/services/hostserv.rb
+- lib/atheme/services/infoserv.rb
+- lib/atheme/services/memoserv.rb
+- lib/atheme/services/nickserv.rb
+- lib/atheme/services/operserv.rb
+- lib/atheme/services/rpgserv.rb
+- lib/atheme/services/statserv.rb
+- lib/atheme/session.rb
+- lib/atheme/version.rb
+homepage: http://github.com/Flauschbaellchen/atheme-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Atheme-XMLRPC interface for Ruby
+test_files: []
+has_rdoc: