rest_ejabberd 0.0.1

data/README.md

@@ -0,0 +1,9 @@
+# RestEjabberd
+
+Ruby interface to ejabberd's mod_restful
+
+This allows to:
+
+* create a user
+* delete a user
+* change password

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new :all do |t|
+    t.pattern = "test/**/*_test.rb"
+    t.libs = ["lib", "test"]
+  end
+end
+
+task :test => ["test:all"]
+task default: :test

data/lib/rest_ejabberd.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'uri'
+require 'net/http'
+
+class RestEjabberd
+  def initialize(attributes = {})
+    @api = URI.parse attributes.fetch(:api_url, 'http://localhost:8088/api/')
+    @secret = attributes.fetch(:secret)
+    @client = Net::HTTP.new(@api.host, @api.port)
+    @client.set_debug_output $stdout if ENV['DEBUG']
+  end
+
+  def register(username, password, host = @api.host)
+    url = @api + "admin"
+    request = prepare_request(Net::HTTP::Post.new(url.request_uri))
+    request.body = command('register', username, host, password)
+
+    JSON.parse @client.request(request).body
+  end
+
+  def unregister(username, password, host = @api.host)
+    url = @api + "admin"
+    request = prepare_request(Net::HTTP::Post.new(url.request_uri))
+    request.body = command('unregister', username, host)
+
+    response = JSON.parse(@client.request(request).body)
+    response.has_key?("ok")
+  end
+
+  def change_password(username, old_password, new_password, host = @api.host)
+    url = @api + 'register/change_password'
+    request = prepare_request(Net::HTTP::Post.new(url.request_uri))
+    request.body = change_password_command(username, host, old_password, new_password)
+
+    @client.request(request).body == '"ok"'
+  end
+
+  def is_registered?(username, password, host = @api.host)
+    url = @api + "register/is_registered?username=#{username}&host=#{host}&key=#{@secret}"
+    request = prepare_request(Net::HTTP::Get.new(url.request_uri))
+    @client.request(request).body == 'true'
+  end
+
+  private
+
+  def command(command, *args)
+    {
+      key: @secret,
+      command: command,
+      args: args
+    }.to_json
+  end
+
+  def change_password_command(username, host, old_password, new_password)
+    # { "key":"secret", "username":"t1", "host":"localhost", "old_password":"hejhej", "new_password":"sansan" }
+    {
+      key: @secret,
+      username: username,
+      host: host,
+      old_password: old_password,
+      new_password: new_password
+    }.to_json
+  end
+
+  def prepare_request(request)
+    request['Content-Type'] = 'application/json'
+    request
+  end
+end

data/rest_ejabberd.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "rest_ejabberd"
+  s.version           = "0.0.1"
+  s.summary           = "Ruby interface for ejabberd's mod_restful"
+  s.description       = "Easy tool to use ejabberd's mod_restful from Ruby"
+  s.authors           = ["elcuervo"]
+  s.email             = ["yo@brunoaguirre.com"]
+  s.homepage          = "http://github.com/elcuervo/rest_ejabberd"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files test`.split("\n")
+
+  s.add_development_dependency("minitest", "~> 3.1.0")
+  s.add_development_dependency("vcr", "~> 2.1.1")
+end

data/test/fixtures/cassettes/change_user_password.yml

@@ -0,0 +1,158 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://localhost:8088/api/admin
+    body: 
+      encoding: UTF-8
+      string: "{\"key\":\"secret\",\"command\":\"register\",\"args\":[\"test\",\"localhost\",\"password\"]}"
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "52"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "{\"ok\":\"User test@localhost successfully registered\"}"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:45:07 GMT
+- request: 
+    method: post
+    uri: http://localhost:8088/api/register/change_password
+    body: 
+      encoding: UTF-8
+      string: "{\"key\":\"secret\",\"username\":\"test\",\"host\":\"localhost\",\"old_password\":\"password\",\"new_password\":\"newpassword\"}"
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "4"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "\"ok\""
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:45:07 GMT
+- request: 
+    method: get
+    uri: http://localhost:8088/api/register/is_registered?username=test&host=localhost&key=secret
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "4"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "true"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:45:07 GMT
+- request: 
+    method: post
+    uri: http://localhost:8088/api/admin
+    body: 
+      encoding: UTF-8
+      string: "{\"key\":\"secret\",\"command\":\"unregister\",\"args\":[\"test\",\"localhost\"]}"
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "9"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "{\"ok\":\"\"}"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:45:07 GMT
+- request: 
+    method: get
+    uri: http://localhost:8088/api/register/is_registered?username=test&host=localhost&key=secret
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "5"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "false"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:45:07 GMT
+recorded_with: VCR 2.1.1

data/test/fixtures/cassettes/create_and_remove_a_user.yml

@@ -0,0 +1,65 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://localhost:8088/api/admin
+    body: 
+      encoding: UTF-8
+      string: "{\"key\":\"secret\",\"command\":\"register\",\"args\":[\"test\",\"localhost\",\"password\"]}"
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "52"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "{\"ok\":\"User test@localhost successfully registered\"}"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:21:37 GMT
+- request: 
+    method: post
+    uri: http://localhost:8088/api/admin
+    body: 
+      encoding: UTF-8
+      string: "{\"key\":\"secret\",\"command\":\"unregister\",\"args\":[\"test\",\"localhost\"]}"
+    headers: 
+      accept: 
+      - "*/*"
+      user-agent: 
+      - Ruby
+      content-type: 
+      - application/json
+      connection: 
+      - close
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      connection: 
+      - close
+      content-length: 
+      - "9"
+      content-type: 
+      - application/json
+    body: 
+      encoding: US-ASCII
+      string: "{\"ok\":\"\"}"
+    http_version: "1.1"
+  recorded_at: Wed, 04 Jul 2012 17:21:37 GMT
+recorded_with: VCR 2.1.1

data/test/rest_ejabberd_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+describe RestEjabberd do
+  before do
+    @client = RestEjabberd.new secret: 'secret'
+    @username = 'test'
+    @password = 'password'
+  end
+
+  it 'should register and unregister a user' do
+    VCR.use_cassette("create and remove a user") do
+      response = @client.register @username, @password
+
+      assert response.has_key?("ok")
+      assert @client.unregister @username, @password
+    end
+  end
+
+  it 'should change a user password' do
+    VCR.use_cassette("change user password") do
+      @client.register @username, @password
+
+      assert @client.change_password @username, @password, 'newpassword'
+      assert @client.is_registered?(@username, @password)
+      assert @client.unregister @username, @password
+      assert !@client.is_registered?(@username, @password)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'vcr'
+require 'minitest/autorun'
+require 'rest_ejabberd'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/fixtures/cassettes'
+  c.default_cassette_options = { record: :once }
+  c.hook_into :fakeweb
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rest_ejabberd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- elcuervo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Easy tool to use ejabberd's mod_restful from Ruby
+email:
+- yo@brunoaguirre.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rest_ejabberd.rb
+- rest_ejabberd.gemspec
+- test/fixtures/cassettes/change_user_password.yml
+- test/fixtures/cassettes/create_and_remove_a_user.yml
+- test/rest_ejabberd_test.rb
+- test/test_helper.rb
+homepage: http://github.com/elcuervo/rest_ejabberd
+licenses: []
+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.22
+signing_key: 
+specification_version: 3
+summary: Ruby interface for ejabberd's mod_restful
+test_files:
+- test/fixtures/cassettes/change_user_password.yml
+- test/fixtures/cassettes/create_and_remove_a_user.yml
+- test/rest_ejabberd_test.rb
+- test/test_helper.rb