openfire_room_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c72a2b81197e2a4668af35a7c07650fd6ad9c1e0
+  data.tar.gz: 82e3d90e9886f15dc6ebd8f2ccbce46abca545f0
+SHA512:
+  metadata.gz: b1ab53027b3a21d27a379553eaa4e36f5898b06dd4499170428c66f8e6c25a4bdaf8ca8e7f5d2a8530f74a20dd069b708513a99e3c50f558864702e4bc0b1f78
+  data.tar.gz: 8a0f4e8b5e3be9a7fcbbd8efc3e873630cc92c2e56875b7d58183e960b5ac41c55f8b193972045355f42325eb437c0fb6092e914dbff4844d20984286162ca82

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec"
+  gem "shoulda"
+  gem "jeweler"
+	gem 'fakeweb'
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    fakeweb (1.3.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.8.1)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  jeweler
+  rspec
+  shoulda

data/README.md

@@ -0,0 +1,23 @@
+# openfire_room_api
+
+a ruby client for openfire's room_service api
+
+## Installation
+
+In your Gemfile
+
+  gem "openfire_room_api"
+
+## Usage
+
+create a new roomservice object
+
+  api = OpenfireRoomApi::RoomService.new(:url => "http://localhost:9090/", :secret => "BIGSECRET")
+
+create a new room
+
+  api.add_room!(:roomname => "room", :jid => "jid", :subdomain => "groupchat")
+
+delete a room
+
+  api.delete_room!(:roomname => "room", :subdomain => "groupchat")

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_room_api"
+  gem.homepage = "https://github.com/wecapslabs/openfire_room_api"
+  gem.summary = %Q{ruby client for the openfire roomservice api}
+  gem.description = %Q{ruby client for the openfire xmpp-server room_service api}
+  gem.email = "flyerhzm@gmail.com"
+  gem.authors = ["Richard Huang"]
+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_room_api.rb

@@ -0,0 +1,6 @@
+require 'uri'
+require 'net/http'
+
+module OpenfireRoomApi; end
+
+require 'openfire_room_api/room_service'

data/lib/openfire_room_api/room_service.rb

@@ -0,0 +1,64 @@
+class OpenfireRoomApi::RoomService
+
+  @@api_path = "plugins/roomService/roomservice"
+  @@api_exceptions = %w(RoomServiceDisabled RequestNotAuthorised NotAllowedException IllegalArgumentException)
+
+  class HTTPException < StandardError; end
+  class InvalidResponseException < StandardError; end
+  class RoomServiceDisabledException < StandardError; end
+  class RequestNotAuthorisedException < StandardError; end
+  class NotAllowedException < StandardError; end
+  class IllegalArgumentException < StandardError; end
+
+  def initialize(options=Hash.new)
+    @options = { :path => @@api_path }.merge(options)
+  end
+
+  def add_room!(opts)
+    submit_request(opts.merge(:type => :add))
+  end
+
+  def delete_room!(opts)
+    submit_request(opts.merge(:type => :delete))
+  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)
+    http = Net::HTTP.new(uri.host, uri.port)
+    resp = http.get("#{uri.path}?#{params}")
+    return resp.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_room_api.gemspec

@@ -0,0 +1,56 @@
+# 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 = "openfire_room_api"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Richard Huang"]
+  s.date = "2013-10-06"
+  s.description = "ruby client for the openfire xmpp-server room_service api"
+  s.email = "flyerhzm@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/openfire_room_api.rb",
+    "lib/openfire_room_api/room_service.rb",
+    "openfire_room_api.gemspec",
+    "spec/room_service_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/wecapslabs/openfire_room_api"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.6"
+  s.summary = "ruby client for the openfire roomservice api"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

data/spec/room_service_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe "Room Service" do
+
+  before :all do
+    @room_service = OpenfireRoomApi::RoomService.new(:url => "http://fakehost.int:2323/", :secret => "bigsecret")
+  end
+
+  it "should build query urls" do
+    url = @room_service.send(:build_query_uri)
+    url.to_s.should == "http://fakehost.int:2323/plugins/roomService/roomservice"
+  end
+
+  it "should build query params" do
+    params = @room_service.send(:build_query_params, :type => :add, :roomname => "room", :subdomain => "groupchat")
+    params.should include("type=add")
+    params.should include("roomname=room")
+    params.should include("subdomain=groupchat")
+    params.should include("secret=bigsecret")
+  end
+
+  it "should build queries" do
+    url = @room_service.send(:build_query, :type => :add, :roomname => "room", :subdomain => "groupchat")
+    url.should include("http://fakehost.int:2323/plugins/roomService/roomservice?")
+    url.should include("type=add")
+    url.should include("roomname=room")
+    url.should include("subdomain=groupchat")
+    url.should include("secret=bigsecret")
+  end
+
+  it "should submit requests" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?type=add&roomname=room&subdomain=groupchat&secret=bigsecret", :body => "<result>ok</result>")
+    @room_service.send(:submit_request, :type => :add, :roomname => "room", :subdomain => "groupchat").should == true
+  end
+
+  it "should add rooms" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?type=add&roomname=room&subdomain=groupchat&secret=bigsecret", :body => "<result>ok</result>")
+    @room_service.add_room!(:roomname => "room", :subdomain => "groupchat").should == true
+  end
+
+  it "should delete rooms" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?type=delete&roomname=room&subdomain=groupchat&secret=bigsecret", :body => "<result>ok</result>")
+    @room_service.delete_room!(:roomname => "room", :subdomain => "groupchat").should == true
+  end
+
+  it "should handle the error: room service disabled" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?roomname=room1&type=add&secret=bigsecret", :body => "<error>RoomServiceDisabled</error>")
+    lambda{ @room_service.add_room!(:roomname => "room1") }.should raise_error(OpenfireRoomApi::RoomService::RoomServiceDisabledException)
+  end
+
+  it "should handle the error: request not authorized" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?roomname=room1&type=add&secret=bigsecret", :body => "<error>RequestNotAuthorised</error>")
+    lambda{ @room_service.add_room!(:roomname => "room1") }.should raise_error(OpenfireRoomApi::RoomService::RequestNotAuthorisedException)
+  end
+
+  it "should handle the error: not allowed" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?roomname=room1&type=add&secret=bigsecret", :body => "<error>NotAllowedException</error>")
+    lambda{ @room_service.add_room!(:roomname => "room1") }.should raise_error(OpenfireRoomApi::RoomService::NotAllowedException)
+  end
+
+  it "should handle the error: illegal argument" do
+    FakeWeb.register_uri(:get, "http://fakehost.int:2323/plugins/roomService/roomservice?roomname=room1&type=add&secret=bigsecret", :body => "<error>IllegalArgumentException</error>")
+    lambda{ @room_service.add_room!(:roomname => "room1") }.should raise_error(OpenfireRoomApi::RoomService::IllegalArgumentException)
+  end
+
+end
+

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_room_api'
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: openfire_room_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !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: 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: jeweler
+  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: 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 room_service api
+email: flyerhzm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/openfire_room_api.rb
+- lib/openfire_room_api/room_service.rb
+- openfire_room_api.gemspec
+- spec/room_service_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wecapslabs/openfire_room_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.0.6
+signing_key: 
+specification_version: 4
+summary: ruby client for the openfire roomservice api
+test_files: []