mod_rest 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +50 -0
- data/Rakefile +10 -0
- data/lib/generators/mod_rest.rb +7 -0
- data/lib/generators/templates/mod_rest.rb +2 -0
- data/lib/mod_rest/version.rb +3 -0
- data/lib/mod_rest.rb +105 -0
- data/mod_rest.gemspec +24 -0
- data/mod_rest.yml +25 -0
- metadata +97 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 977d74916e2d069ea1dc9fb6209725f3a2432585
|
4
|
+
data.tar.gz: 8f3a9ec9edb2b8d07508a4f35bee7a5856da9f81
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b243549d0d67f1c08ab9a83df28e01cecf1999a5add90cccf58177ffc342f1585b812f38a1ee115abf703719b4987ab5407f50f60b0ead4a1a7054e292c91990
|
7
|
+
data.tar.gz: 3acd06941af976a94ed925adaee42812744ee13579a274b97719bdc7cffbd34e59c3d74891af946ff6d9ae4ad06e0d9dfbcc85aed7ecece39a36017436f66687
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2016 deepakshinde
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# ModRestApi for Ejabberd Xmpp server
|
2
|
+
|
3
|
+
Ruby interface to ejabberd's https://github.com/processone/ejabberd-contrib/tree/master/mod_rest
|
4
|
+
|
5
|
+
This allows to:
|
6
|
+
|
7
|
+
* Register a new user
|
8
|
+
* Unregister a user
|
9
|
+
* Check status
|
10
|
+
* Change password
|
11
|
+
* Check all online user
|
12
|
+
* Check all registered_users
|
13
|
+
* Add subscribe friend
|
14
|
+
* Get user's friends
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
## Installation
|
19
|
+
Note. First setup Ejabberd server with mod_rest module.
|
20
|
+
|
21
|
+
Add this line to your application's Gemfile:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
gem 'mod_rest'
|
25
|
+
```
|
26
|
+
|
27
|
+
And then execute:
|
28
|
+
|
29
|
+
$ bundle
|
30
|
+
|
31
|
+
Or install it yourself as:
|
32
|
+
|
33
|
+
$ gem install mod_rest
|
34
|
+
|
35
|
+
## Usage
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
client = ModRest::Client.new
|
39
|
+
cleint.register(username, password)
|
40
|
+
|
41
|
+
```
|
42
|
+
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
1. Fork it ( https://github.com/[my-github-username]/mod_rest/fork )
|
47
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
48
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
49
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
50
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
data/lib/mod_rest.rb
ADDED
@@ -0,0 +1,105 @@
|
|
1
|
+
require 'mod_rest/version'
|
2
|
+
require 'json'
|
3
|
+
require 'net/http'
|
4
|
+
|
5
|
+
module ModRest
|
6
|
+
class Client
|
7
|
+
# New initialize object
|
8
|
+
def initialize(attributes = {})
|
9
|
+
@url = URI.parse attributes.fetch(:url, URL)
|
10
|
+
@host = attributes.fetch(:host, VIRTUAL_HOST)
|
11
|
+
@client = Net::HTTP.new(@url.host, @url.port)
|
12
|
+
end
|
13
|
+
|
14
|
+
# Register a new user
|
15
|
+
# Take params username and password
|
16
|
+
def register(username, password)
|
17
|
+
data = "register #{username} #{@host} #{password}"
|
18
|
+
response data
|
19
|
+
end
|
20
|
+
|
21
|
+
# Unregister user
|
22
|
+
# Take params username
|
23
|
+
def unregister(username)
|
24
|
+
data = "unregister #{username} #{@host}"
|
25
|
+
response data
|
26
|
+
end
|
27
|
+
|
28
|
+
# Change user's password
|
29
|
+
# Take params username and new password
|
30
|
+
def change_password(username, new_password)
|
31
|
+
data = "change_password #{username} #{@host} #{new_password}"
|
32
|
+
response(data)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Check all online user
|
36
|
+
def online_users
|
37
|
+
data = "connected_users"
|
38
|
+
response(data)
|
39
|
+
end
|
40
|
+
|
41
|
+
# Get the number of established sessions
|
42
|
+
def connected_users_number
|
43
|
+
data = "connected_users_number"
|
44
|
+
response(data)
|
45
|
+
end
|
46
|
+
|
47
|
+
#Disconnect user’s active sessions
|
48
|
+
def kick_user username
|
49
|
+
data = "kick_user #{username} #{@host}"
|
50
|
+
response(data)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Delete offline messages older than the given days.
|
54
|
+
def delete_old_messages day
|
55
|
+
data = "delete_old_messages #{day}"
|
56
|
+
response(data)
|
57
|
+
end
|
58
|
+
|
59
|
+
# List user’s connected resources
|
60
|
+
def user_resources username
|
61
|
+
data = "user_resources"
|
62
|
+
response(data)
|
63
|
+
end
|
64
|
+
|
65
|
+
def status
|
66
|
+
data = "status"
|
67
|
+
response(data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# List all registered users in HOST
|
71
|
+
def register_users
|
72
|
+
data = "registered_users #{@host}"
|
73
|
+
response(data)
|
74
|
+
end
|
75
|
+
|
76
|
+
# add buddy and auto subscription
|
77
|
+
def add_friend(username, friend_name, nicname = "")
|
78
|
+
nic = nicname.blank? ? username : nicname
|
79
|
+
data = "add_rosteritem #{username} #{@host} #{friend_name} #{@host } #{nic} Match both"
|
80
|
+
response(data)
|
81
|
+
end
|
82
|
+
|
83
|
+
def get_friends(username)
|
84
|
+
data = "get_roster #{username} #{@host}"
|
85
|
+
response(data)
|
86
|
+
end
|
87
|
+
|
88
|
+
private
|
89
|
+
def prepare_request request
|
90
|
+
request['Content-Type'] = 'application/json'
|
91
|
+
request['Accept'] = 'application/json'
|
92
|
+
request
|
93
|
+
end
|
94
|
+
|
95
|
+
def response(body)
|
96
|
+
request = prepare_request(Net::HTTP::Post.new(@url.request_uri))
|
97
|
+
request.body = body
|
98
|
+
msg = @client.request(request).body
|
99
|
+
{ status: true, message: msg }
|
100
|
+
rescue Exception => e
|
101
|
+
{ status: false, message: e.message }
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
data/mod_rest.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'mod_rest/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "mod_rest"
|
8
|
+
spec.version = ModRest::VERSION
|
9
|
+
spec.authors = ['deepakshinde']
|
10
|
+
spec.email = ['deepak2726@gmail.com']
|
11
|
+
spec.summary = %q{Ruby interface to ejabberd's(XMPP server) mod_rest module}
|
12
|
+
spec.description = %q{ejabberdctl command for ruby developer}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "rspec-rails", "~> 3.4"
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
end
|
data/mod_rest.yml
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
access:
|
2
|
+
configure:
|
3
|
+
admin: allow
|
4
|
+
commands_admin_access: configure
|
5
|
+
modules:
|
6
|
+
mod_rest:
|
7
|
+
allowed_ips:
|
8
|
+
- "allowed_ips"
|
9
|
+
allowed_destinations:
|
10
|
+
- "all"
|
11
|
+
allowed_stanza_types:
|
12
|
+
- "all"
|
13
|
+
access_command:
|
14
|
+
configure:
|
15
|
+
- register
|
16
|
+
- unregister
|
17
|
+
- status
|
18
|
+
- registered_users
|
19
|
+
- connected_users
|
20
|
+
listen:
|
21
|
+
-
|
22
|
+
port: 5285
|
23
|
+
module: ejabberd_http
|
24
|
+
request_handlers:
|
25
|
+
"/rest": mod_rest
|
metadata
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: mod_rest
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- deepakshinde
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-09-13 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rspec-rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.4'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.4'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.7'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.7'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
description: ejabberdctl command for ruby developer
|
56
|
+
email:
|
57
|
+
- deepak2726@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- lib/generators/mod_rest.rb
|
68
|
+
- lib/generators/templates/mod_rest.rb
|
69
|
+
- lib/mod_rest.rb
|
70
|
+
- lib/mod_rest/version.rb
|
71
|
+
- mod_rest.gemspec
|
72
|
+
- mod_rest.yml
|
73
|
+
homepage: ''
|
74
|
+
licenses:
|
75
|
+
- MIT
|
76
|
+
metadata: {}
|
77
|
+
post_install_message:
|
78
|
+
rdoc_options: []
|
79
|
+
require_paths:
|
80
|
+
- lib
|
81
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - ">="
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
requirements: []
|
92
|
+
rubyforge_project:
|
93
|
+
rubygems_version: 2.5.1
|
94
|
+
signing_key:
|
95
|
+
specification_version: 4
|
96
|
+
summary: Ruby interface to ejabberd's(XMPP server) mod_rest module
|
97
|
+
test_files: []
|