atheme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f15c506bebeb4f29c62aaf132ff7e65ae447aac7
+  data.tar.gz: edbbf9f64e68e79c9009988e160ab607ce7d525a
+SHA512:
+  metadata.gz: a1726985fc6177a45ea570b1b31e2a3fd718fcaf13036b254485ee18826c8830babb021e561b36ff0a5293d2b1b11d641ed53aa8f9f24c32128c049afde016b8
+  data.tar.gz: de2c423a8baf8891b738da732bcbba266b76302ef87a7077d91c06bc8c4ea8fafafcf6c78e4184c63cf643afa69ea4abd5872ad25ec5f1794f26ef495ad134af

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 James Newton and Robert Babcock
+
+MIT License
+
+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,61 @@
+# Atheme Ruby
+
+A ruby way to access the [Atheme IRC Services](http://www.atheme.net) XMLRPC interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atheme'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atheme
+
+## Usage
+
+### Requirements
+
+You need to be using [Atheme IRC Services](http://www.atheme.net) with httpd and XMLRPC enabled.
+
+### Configuration
+
+```ruby
+Atheme.configure do |config|
+  config.url = 'http://example.com'
+  config.port = 9876
+end
+```
+
+### Authentication
+
+```ruby
+cookie = Atheme.login('nickname', 'password') # Returns an authcookie
+
+Atheme.set_user(cookie, 'nickname', 'ip.add.re.ss') # Sets the users info for commands
+```
+
+### Services commands
+
+```ruby
+Atheme::ChanServ.info '#channel'
+Atheme::NickServ.set 'email', 'james@example.com'
+```
+
+Any command can be used that the user has access to use.
+
+Command format: `Atheme::ServiceName.command 'param', 'param', ...`
+
+To see services supported [go here](https://github.com/zaphyous/atheme-ruby/tree/develop/lib/atheme/services).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/atheme.gemspec

@@ -0,0 +1,27 @@
+# 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'
+  spec.version       = Atheme::VERSION
+  spec.authors       = ['James Newton', 'Robert Babcock']
+  spec.email         = ['james@Zaphyous.com', 'robert@Zaphyous.com']
+  spec.description   = %q{A ruby wrapper around the Atheme IRC Services XMLRPC interface}
+  spec.summary       = %q{atheme-ruby is an easy way to integrate your ruby application with the Atheme IRC Services XMLRPC interface}
+  spec.homepage      = 'https://github.com/zaphyous/atheme'
+  spec.license       = 'MIT'
+
+  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'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rb-fsevent'
+end

data/lib/atheme/authenticate.rb

@@ -0,0 +1,11 @@
+module Atheme::Authenticate
+  attr_accessor :user
+
+  def login(username, password)
+    call('atheme.login', username, password)
+  end
+
+  def logout(token, username)
+    call('atheme.logout', token, username)
+  end
+end

data/lib/atheme/configuration.rb

@@ -0,0 +1,15 @@
+module Atheme::Configuration
+  VALID_CONFIG_OPTIONS = [:url, :port].freeze
+
+  attr_accessor *VALID_CONFIG_OPTIONS
+
+  def configure
+    yield self
+  end
+
+  def options
+    VALID_CONFIG_OPTIONS.inject({}) do |option, key|
+      option.merge!(key => send(key))
+    end
+  end
+end

data/lib/atheme/objectified_hash.rb

@@ -0,0 +1,14 @@
+class Atheme::ObjectifiedHash
+  def initialize(hash)
+    @data = hash.inject({}) do |data, (key, value)|
+      value = Atheme::ObjectifiedHash.new(value) if value.is_a? Hash
+
+      data[key.to_s] = value
+      data
+    end
+  end
+
+  def method_missing(key)
+    @data.key?(key.to_s) ? @data[key.to_s] : nil
+  end
+end

data/lib/atheme/service.rb

@@ -0,0 +1,9 @@
+class Atheme::Service
+  def self.inherited(base)
+    Atheme::SERVICES << base.name.gsub('Atheme::', '')
+  end
+
+  def self.method_missing(method, *args, &block)
+    Atheme.call('atheme.command', Atheme.user.cookie, Atheme.user.username, Atheme.user.ip, self.name.gsub('Atheme::', ''), method, *args)
+  end
+end

data/lib/atheme/services/alis.rb

@@ -0,0 +1,2 @@
+class Atheme::ALIS < Atheme::Service
+end

data/lib/atheme/services/chanserv.rb

@@ -0,0 +1,2 @@
+class Atheme::ChanServ < Atheme::Service
+end

data/lib/atheme/services/gameserv.rb

@@ -0,0 +1,2 @@
+class Atheme::GameServ < Atheme::Service
+end

data/lib/atheme/services/global.rb

@@ -0,0 +1,2 @@
+class Atheme::Global < Atheme::Service
+end

data/lib/atheme/services/groupserv.rb

@@ -0,0 +1,2 @@
+class Atheme::GroupServ < Atheme::Service
+end

data/lib/atheme/services/helpserv.rb

@@ -0,0 +1,2 @@
+class Atheme::HelpServ < Atheme::Service
+end

data/lib/atheme/services/hostserv.rb

@@ -0,0 +1,2 @@
+class Atheme::HostServ < Atheme::Service
+end

data/lib/atheme/services/infoserv.rb

@@ -0,0 +1,2 @@
+class Atheme::InfoServ < Atheme::Service
+end

data/lib/atheme/services/memoserv.rb

@@ -0,0 +1,2 @@
+class Atheme::MemoServ < Atheme::Service
+end

data/lib/atheme/services/nickserv.rb

@@ -0,0 +1,2 @@
+class Atheme::NickServ < Atheme::Service
+end

data/lib/atheme/services/operserv.rb

@@ -0,0 +1,2 @@
+class Atheme::OperServ < Atheme::Service
+end

data/lib/atheme/services/rpgserv.rb

@@ -0,0 +1,2 @@
+class Atheme::RPGServ < Atheme::Service
+end

data/lib/atheme/services/statserv.rb

@@ -0,0 +1,2 @@
+class Atheme::StatServ < Atheme::Service
+end

data/lib/atheme/version.rb

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

data/lib/atheme.rb

@@ -0,0 +1,29 @@
+module Atheme
+  SERVICES = []
+end
+
+require 'xmlrpc/client'
+require 'atheme/version'
+require 'atheme/configuration'
+require 'atheme/authenticate'
+require 'atheme/service'
+require 'atheme/objectified_hash'
+
+Dir[File.expand_path('../atheme/services/*.rb', __FILE__)].each { |file| require file }
+
+module Atheme
+  extend Configuration
+  extend Authenticate
+
+  def self.server
+    XMLRPC::Client.new2("#{Atheme.url}:#{Atheme.port}/xmlrpc")
+  end
+
+  def self.call(*args)
+    server.call(*args)
+  end
+
+  def self.set_user(cookie, username, ip)
+    self.user = Atheme::ObjectifiedHash.new({ cookie: cookie, username: username, ip: ip })
+  end
+end

data/spec/config.yml.example

@@ -0,0 +1,9 @@
+# Change this to your testing services xmlrpc information
+
+url: http://example.com
+port: 1234
+
+nick: a_nick_that_exists
+password: the_nicks_password
+ip: 127.0.0.1
+

data/spec/lib/authenticate_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Atheme::Authenticate do
+  it 'should get a cookie when logging in' do
+    expect(Atheme.login(atheme_config['nick'], atheme_config['password'])).to match(/([a-z]){20}/)
+  end
+
+  it 'should get a XMLRPC::FaultException when incorrect login information is provided' do
+    expect { Atheme.login(atheme_config['nick'], 'bad-password') }.to raise_error XMLRPC::FaultException
+  end
+
+  it 'should remember a user when set' do
+    cookie = Atheme.login(atheme_config['nick'], atheme_config['password'])
+
+    Atheme.set_user(cookie, atheme_config['nick'], atheme_config['ip'])
+
+    expect(Atheme.user.cookie).to eql cookie
+    expect(Atheme.user.username).to eql atheme_config['nick']
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Atheme::Configuration do
+  it 'should have a port' do
+    expect(Atheme.port).to eql atheme_config['port']
+    expect(Atheme.options[:port]).to eql atheme_config['port']
+  end
+
+  it 'should have a url' do
+    expect(Atheme.url).to eql atheme_config['url']
+    expect(Atheme.options[:url]).to eql atheme_config['url']
+  end
+end

data/spec/lib/service_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Atheme::Service' do
+  it 'should have services' do
+    expect(Atheme::SERVICES.count).to be > 0
+  end
+
+  it 'should be able to query services' do
+    authenticate
+
+    expect(Atheme::ChanServ.help).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'pry'
+require 'atheme'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }
+
+def atheme_config
+  YAML.load_file(File.expand_path('../config.yml', __FILE__))
+end
+
+def configure_atheme
+  Atheme.configure do |config|
+    config.port = atheme_config['port']
+    config.url = atheme_config['url']
+  end
+end
+
+def authenticate
+  cookie = Atheme.login(atheme_config['nick'], atheme_config['password'])
+
+  Atheme.set_user(cookie, atheme_config['nick'], atheme_config['ip'])
+end
+
+RSpec.configure do |config|
+  config.before(:each) { configure_atheme }
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: atheme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Newton
+- Robert Babcock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby wrapper around the Atheme IRC Services XMLRPC interface
+email:
+- james@Zaphyous.com
+- robert@Zaphyous.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atheme.gemspec
+- lib/atheme.rb
+- lib/atheme/authenticate.rb
+- lib/atheme/configuration.rb
+- lib/atheme/objectified_hash.rb
+- lib/atheme/service.rb
+- lib/atheme/services/alis.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/version.rb
+- spec/config.yml.example
+- spec/lib/authenticate_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/service_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zaphyous/atheme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: atheme-ruby is an easy way to integrate your ruby application with the Atheme
+  IRC Services XMLRPC interface
+test_files:
+- spec/config.yml.example
+- spec/lib/authenticate_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/service_spec.rb
+- spec/spec_helper.rb