openfire_api_ruby 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb929d2a86955280a7f98f635d10a772415c1f7c
+  data.tar.gz: 02c232c15415593cb71b4c37d57e9dcaea740173
+SHA512:
+  metadata.gz: 31e9390dec95fb43e479af9093799932ee55336ab953e29ada6ee4f7239e8c5986e9bfee69434edf2e6e878bd82807e1fafeb2e515e20dc2642caf83c2f67648
+  data.tar.gz: 44e99072df465dfe7d711bbdeff2ad9da680fb448661b057757829ba2a4ddbfb52901f5b90eda40ce9919830fc07cee2dfd9308548f2dac35e5bee768001833c

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", ">= 2.6.0"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+	gem 'fakeweb'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb
+  jeweler (~> 1.5.2)
+  rspec (>= 2.6.0)
+  shoulda

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "openfire_api"
+  gem.homepage = "http://github.com/babu3009/openfire_api"
+  gem.summary = %Q{ruby client for the openfire userservice api}
+  gem.description = %Q{ruby client for the openfire xmpp-server user_service api}
+  gem.email = "babu3009@gmail.com"
+  gem.authors = ["Babu"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec'
+require 'rspec/core/rake_task'
+desc "Run all examples"
+task RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/openfire_api.rb

@@ -0,0 +1,7 @@
+require 'uri'
+require 'net/http'
+
+module OpenfireApi; end
+
+require 'openfire_api/user_service'
+require 'openfire_api/group_service'

data/lib/openfire_api/group_service.rb

@@ -0,0 +1,78 @@
+class  OpenfireApi::GroupService
+
+  @@api_path = "plugins/groupService/groupservice"
+  @@api_exceptions = %w(GroupServiceDisabled RequestNotAuthorised IllegalArgumentException GroupNotFoundException GroupAlreadyExistsException)
+
+  class HTTPException < StandardError; end
+  class InvalidResponseException < StandardError; end
+  class GroupServiceDisabledException < StandardError; end
+  class RequestNotAuthorisedException < StandardError; end
+  class IllegalArgumentException < StandardError; end
+  class GroupNotFoundException < StandardError; end
+  class GroupAlreadyExistsException < StandardError; end
+
+  def initialize(options=Hash.new)
+    @options = { :path => @@api_path }.merge(options)
+  end
+
+  def add_group!(opts)
+    submit_request(opts.merge(:type => :add))
+  end
+
+  def delete_group!(opts)
+    submit_request(opts.merge(:type => :delete))
+  end
+
+  def update_group!(opts)
+    submit_request(opts.merge(:type => :update))
+  end
+
+  def lock_group!(opts)
+    submit_request(opts.merge(:type => :disable))
+  end
+
+  def unlock_group!(opts)
+    submit_request(opts.merge(:type => :enable))
+  end
+
+  private
+
+  def build_query(params)
+    "#{build_query_uri.to_s}?#{build_query_params(params)}"
+  end
+
+  def build_query_uri
+    uri = URI.parse(@options[:url])
+    uri.path = File.join(uri.path, @@api_path)
+    uri
+  end
+
+  def build_query_params(params)
+    params.merge!(:secret => @options[:secret])
+    params.to_a.map{ |p| "#{p[0]}=#{p[1]}" }.join('&')
+  end
+
+  def submit_request(params)
+    data = submit_http_request(build_query_uri, build_query_params(params))
+    parse_response(data)
+  end
+
+  def submit_http_request(uri, params)
+    res = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.get("#{uri.path}?#{params}")
+    end
+    return res.body
+  rescue Exception => e
+    raise HTTPException, e.to_s
+  end
+
+  def parse_response(data)
+    error = data.match(/<error>(.*)<\/error>/)
+    if error && @@api_exceptions.include?(error[1])
+      raise eval("#{error[1].gsub('Exception', '')}Exception")
+    end
+    raise InvalidResponseException unless data.match(/<result>ok<\/result>/)
+    return true
+  end
+
+end

data/lib/openfire_api/user_service.rb

@@ -0,0 +1,78 @@
+class OpenfireApi::UserService
+
+  @@api_path = "plugins/userService/userservice"
+  @@api_exceptions = %w(UserServiceDisabled RequestNotAuthorised IllegalArgumentException UserNotFoundException UserAlreadyExistsException)
+
+  class HTTPException < StandardError; end
+  class InvalidResponseException < StandardError; end
+  class UserServiceDisabledException < StandardError; end
+  class RequestNotAuthorisedException < StandardError; end
+  class IllegalArgumentException < StandardError; end
+  class UserNotFoundException < StandardError; end
+  class UserAlreadyExistsException < StandardError; end
+
+  def initialize(options=Hash.new)
+    @options = { :path => @@api_path }.merge(options)
+  end
+
+  def add_user!(opts)
+    submit_request(opts.merge(:type => :add))
+  end
+
+  def delete_user!(opts)
+    submit_request(opts.merge(:type => :delete))
+  end
+
+  def update_user!(opts)
+    submit_request(opts.merge(:type => :update))
+  end
+
+  def lock_user!(opts)
+    submit_request(opts.merge(:type => :disable))
+  end
+
+  def unlock_user!(opts)
+    submit_request(opts.merge(:type => :enable))
+  end
+
+private
+
+  def build_query(params)
+    "#{build_query_uri.to_s}?#{build_query_params(params)}"
+  end
+
+  def build_query_uri
+    uri = URI.parse(@options[:url])
+    uri.path = File.join(uri.path, @@api_path)
+    uri
+  end
+
+  def build_query_params(params)
+    params.merge!(:secret => @options[:secret])
+    params.to_a.map{ |p| "#{p[0]}=#{p[1]}" }.join('&')
+  end
+
+  def submit_request(params)
+    data = submit_http_request(build_query_uri, build_query_params(params))
+    parse_response(data)
+  end
+
+  def submit_http_request(uri, params)
+    res = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.get("#{uri.path}?#{params}")
+    end
+    return res.body
+  rescue Exception => e
+    raise HTTPException, e.to_s
+  end
+
+  def parse_response(data)
+    error = data.match(/<error>(.*)<\/error>/)
+    if error && @@api_exceptions.include?(error[1])
+      raise eval("#{error[1].gsub('Exception', '')}Exception")
+    end
+    raise InvalidResponseException unless data.match(/<result>ok<\/result>/)
+    return true
+  end
+
+end

data/openfire_api.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{openfire_api_ruby}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Asmuth, Babu"]
+  s.date = %q{2014-02-19}
+  s.description = %q{ruby client for the openfire xmpp-server user_service api}
+  s.email = %q{paul@23linesofcode.com, babu309@gmail.com}
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "VERSION",
+    "lib/openfire_api.rb",
+    "lib/openfire_api/user_service.rb",
+    "lib/openfire_api/group_service.rb",
+    "openfire_api.gemspec",
+    "readme.rdoc",
+    "spec/spec_helper.rb",
+    "spec/user_service_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/babu3009/openfire_api}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{ruby client for the openfire userservice api}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/user_service_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

data/readme.rdoc

@@ -0,0 +1,43 @@
+= openfire_api
+
+a ruby client for openfire's user_service api
+
+{<img src="https://secure.travis-ci.org/babu3009/openfire_api.png" />}[http://travis-ci.org/babu3009/openfire_api]
+
+
+== Installation
+
+In your Gemfile
+  gem "mtgox-ruby", :git => "git://github.com/babu3009/openfire_api.git"
+	
+or
+  gem install git://github.com/babu3009/openfire_api.git
+
+
+== Usage
+
+create a new userservice object
+
+  api = OpenfireApi::UserService.new(:url => "http://localhost:9090/", :secret => "BIGSECRET")
+  
+register new user
+  
+  api.add_user!(:username => "user", :password => "pass")
+  api.add_user!(:username => "user", :password => "pass", :name => ..., :email => ..., :groups => ...)
+
+update existing user
+  
+  api.update_user!(:username => "user", :password => "pass")
+  api.update_user!(:username => "user", :password => "pass", :name => ..., :email => ..., :groups => ...)
+
+delete user
+
+  api.delete_user!(:username => "user")
+	
+lock user
+
+  api.lock_user!(:username => "user")
+
+unlock user
+
+  api.unlock_user!(:username => "user")

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rspec'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+ 
+$: << ::File.expand_path('../../lib', __FILE__)
+require 'openfire_api'
+

data/spec/user_service_spec.rb

@@ -0,0 +1,88 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe "User Service" do
+
+  before :all do
+    @user_service = OpenfireApi::UserService.new(:url => "http://fakehost.int:2323/", :secret => "bigsecret")
+  end
+  
+  it "should build query urls" do
+    url = @user_service.send(:build_query_uri)
+    url.to_s.should == "http://fakehost.int:2323/plugins/userService/userservice"
+  end
+  
+  it "should build query params" do
+    params = @user_service.send(:build_query_params, :type => :add, :username => "user", :password => "pw")
+    params.should include("type=add")
+    params.should include("username=user")
+    params.should include("password=pw")
+    params.should include("secret=bigsecret")    
+  end
+  
+  it "should build queries" do
+    url = @user_service.send(:build_query, :type => :add, :username => "user", :password => "pw")
+    url.should include("http://fakehost.int:2323/plugins/userService/userservice?")
+    url.should include("type=add")
+    url.should include("type=add")
+    url.should include("username=user")
+    url.should include("password=pw")
+    url.should include("secret=bigsecret")  
+  end
+  
+  it "should submit requests" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=add&username=user&password=pw&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.send(:submit_request, :type => :add, :username => "user", :password => "pw").should == true
+  end
+  
+  it "should add users" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=add&username=user&password=pw&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.add_user!(:username => "user", :password => "pw").should == true
+  end
+  
+  it "should delete users" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=delete&username=user&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.delete_user!(:username => "user").should == true
+  end
+  
+  it "should update users" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=update&username=user&password=pw&name=horst&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.update_user!(:username => "user", :password => "pw", :name => "horst").should == true
+  end
+  
+  it "should lock users" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=disable&username=user&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.lock_user!(:username => "user").should == true
+  end
+  
+  it "should unlock users" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?type=enable&username=user&secret=bigsecret", :body => "<result>ok</result>")
+    @user_service.unlock_user!(:username => "user").should == true
+  end 
+  
+  it "should handle the error: user service disabled" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?username=user1&type=disable&secret=bigsecret", :body => "<error>UserServiceDisabled</error>")
+    lambda{ @user_service.lock_user!(:username => "user1") }.should raise_error(OpenfireApi::UserService::UserServiceDisabledException)
+  end
+  
+  it "should handle the error: request not authorized" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?username=user1&type=disable&secret=bigsecret", :body => "<error>RequestNotAuthorised</error>")
+    lambda{ @user_service.lock_user!(:username => "user1") }.should raise_error(OpenfireApi::UserService::RequestNotAuthorisedException)
+  end
+  
+  it "should handle the error: illegal argument" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?username=user1&type=disable&secret=bigsecret", :body => "<error>IllegalArgumentException</error>")
+    lambda{ @user_service.lock_user!(:username => "user1") }.should raise_error(OpenfireApi::UserService::IllegalArgumentException)
+  end
+  
+  it "should handle the error: user not found" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?username=user1&type=disable&secret=bigsecret", :body => "<error>UserNotFoundException</error>")
+    lambda{ @user_service.lock_user!(:username => "user1") }.should raise_error(OpenfireApi::UserService::UserNotFoundException)
+  end
+  
+  it "should handle the error: user already exists" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/userService/userservice?username=user1&type=disable&secret=bigsecret", :body => "<error>UserAlreadyExistsException</error>")
+    lambda{ @user_service.lock_user!(:username => "user1") }.should raise_error(OpenfireApi::UserService::UserAlreadyExistsException)
+  end
+
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: openfire_api_ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Paul Asmuth, Babu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  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: ruby client for the openfire xmpp-server user_service api
+email: paul@23linesofcode.com, babu309@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- lib/openfire_api.rb
+- lib/openfire_api/group_service.rb
+- lib/openfire_api/user_service.rb
+- openfire_api.gemspec
+- readme.rdoc
+- spec/spec_helper.rb
+- spec/user_service_spec.rb
+homepage: http://github.com/babu3009/openfire_api
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 3
+summary: ruby client for the openfire userservice api
+test_files:
+- spec/spec_helper.rb
+- spec/user_service_spec.rb
+has_rdoc: