socketserv-ruby 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/CHANGELOG.md +5 -0
- data/Gemfile +4 -0
- data/LICENSE +22 -0
- data/README.md +34 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/lib/socket_serv/client.rb +119 -0
- data/lib/socket_serv/engine.rb +7 -0
- data/lib/socket_serv/rails_helper.rb +7 -0
- data/lib/socket_serv/version.rb +4 -0
- data/lib/socket_serv.rb +43 -0
- data/lib/socketserv-ruby.rb +1 -0
- data/socketserv-ruby.gemspec +37 -0
- metadata +172 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 7e3b2e1485fd2f2b9ad098231c419c183a08ccac
|
4
|
+
data.tar.gz: 31f332a3f1d335799501e6a744b50b3bfb5e42f3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5222627564b888208c49c1628e1a344df5637447ac3a656cf185554b1119ea7ff5e5bbe067a9a0d6c799da663be9cba5ef8b99b912e0c0a9b14abf0796f27395
|
7
|
+
data.tar.gz: 33b7f2a88316e93b1727869c949a147c4e46ecac303de86d222b2309827de958a805941d5447c330dfaf5ecf2efcb7c0f83eed0cc454345ecda7b8c95dc20986
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2015 SocketServ
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
22
|
+
|
data/README.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# socketserv-ruby ![Travis CI](https://travis-ci.org/SocketServ/socketserv-ruby.svg)
|
2
|
+
|
3
|
+
A Ruby library to interface with the [SocketServ](https://www.socketserv.com/) service.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'socketserv-ruby', '~> 0.1.0'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install socketserv-ruby
|
20
|
+
|
21
|
+
`socketserv-ruby` uses a versioning strategy compliant with [semver 2.0](http://semver.org).
|
22
|
+
All changes will be enumerated in [CHANGELOG.md](CHANGELOG.md).
|
23
|
+
|
24
|
+
## Usage
|
25
|
+
|
26
|
+
TODO: Write usage information.
|
27
|
+
|
28
|
+
## Development
|
29
|
+
|
30
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
31
|
+
|
32
|
+
## Contributing
|
33
|
+
|
34
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/SocketServ/socketserv-ruby.
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "socketserv-ruby"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "pry"
|
14
|
+
Pry.start
|
data/bin/setup
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
class SocketServ::Client
|
2
|
+
include HTTParty
|
3
|
+
|
4
|
+
base_uri SocketServ.base_uri
|
5
|
+
|
6
|
+
def self.shared_client(client_id=nil, client_secret=nil)
|
7
|
+
client_secret ||= ENV["SOCKETSERV_APP_SECRET"]
|
8
|
+
client_id ||= ENV["SOCKETSERV_APP_ID"]
|
9
|
+
Thread.current[:socketserv_api] ||= self.new(client_id, client_secret)
|
10
|
+
Thread.current[:socketserv_api].refresh_token!
|
11
|
+
Thread.current[:socketserv_api]
|
12
|
+
end
|
13
|
+
|
14
|
+
def self.test_mode!
|
15
|
+
@@test_mode = true
|
16
|
+
end
|
17
|
+
class_variable_set(:"@@test_mode", false)
|
18
|
+
|
19
|
+
def initialize(client_id, client_secret)
|
20
|
+
@client_id = client_id
|
21
|
+
# The long-lived key.
|
22
|
+
@client_secret = client_secret
|
23
|
+
|
24
|
+
# Refresh the short-lived key.
|
25
|
+
refresh_token!
|
26
|
+
end
|
27
|
+
|
28
|
+
def refresh_token!
|
29
|
+
return @token = JWT.encode({"exp" => (Time.now + 86400).to_i}, "secret") if @@test_mode
|
30
|
+
return unless requires_refresh?
|
31
|
+
|
32
|
+
resp = self.class.post "/oauth/token", {
|
33
|
+
body: {
|
34
|
+
grant_type: "client_credentials",
|
35
|
+
client_id: @client_id,
|
36
|
+
client_secret: @client_secret
|
37
|
+
}
|
38
|
+
}
|
39
|
+
|
40
|
+
if resp.code == 200
|
41
|
+
@token = resp.parsed_response["access_token"]
|
42
|
+
else
|
43
|
+
Rails.logger.fatal "[SocketServ] Token refresh failed (#{resp.code})"
|
44
|
+
@token = nil
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
def new_session(name=nil)
|
49
|
+
return {
|
50
|
+
"name" => name,
|
51
|
+
"id" => "bc5e7d36-76c9-4d8d-9535-6a49d96fea4b"
|
52
|
+
} if @@test_mode
|
53
|
+
|
54
|
+
resp = self.class.post "/api/v1/sessions", authenticated_params({
|
55
|
+
body: {
|
56
|
+
session: {
|
57
|
+
name: name
|
58
|
+
}
|
59
|
+
}
|
60
|
+
})
|
61
|
+
|
62
|
+
if resp.code == 200
|
63
|
+
resp.parsed_response
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
def verify_session(session_id)
|
68
|
+
return true if @@test_mode
|
69
|
+
|
70
|
+
resp = self.class.get "/api/v1/sessions/#{session_id}", authenticated_params
|
71
|
+
|
72
|
+
resp.code == 200
|
73
|
+
end
|
74
|
+
|
75
|
+
def message_to_session(session_id, message_payload)
|
76
|
+
return true if @@test_mode
|
77
|
+
|
78
|
+
resp = self.class.post "/api/v1/sessions/#{session_id}/push", authenticated_params({
|
79
|
+
body: {
|
80
|
+
payload: message_payload
|
81
|
+
}
|
82
|
+
})
|
83
|
+
|
84
|
+
resp.code == 200
|
85
|
+
end
|
86
|
+
|
87
|
+
def message_to_sessions(session_ids, message_payload)
|
88
|
+
return true if @@test_mode
|
89
|
+
|
90
|
+
resp = self.class.post "/api/v1/multi_push", authenticated_params({
|
91
|
+
body: {
|
92
|
+
session_ids: session_ids,
|
93
|
+
payload: message_payload
|
94
|
+
}
|
95
|
+
})
|
96
|
+
|
97
|
+
resp.code == 200
|
98
|
+
end
|
99
|
+
|
100
|
+
private
|
101
|
+
|
102
|
+
def requires_refresh?
|
103
|
+
return true if @token.nil?
|
104
|
+
decoded_token = JWT.decode(@token, nil, false)
|
105
|
+
expires_at = Time.at(decoded_token[0]["exp"])
|
106
|
+
expires_at.past?
|
107
|
+
ensure
|
108
|
+
true
|
109
|
+
end
|
110
|
+
|
111
|
+
def authenticated_params(merge_with={})
|
112
|
+
refresh_token!
|
113
|
+
merge_with.deep_merge({
|
114
|
+
headers: {
|
115
|
+
'Authorization' => @token
|
116
|
+
}
|
117
|
+
})
|
118
|
+
end
|
119
|
+
end
|
data/lib/socket_serv.rb
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
require 'socket_serv/version'
|
2
|
+
|
3
|
+
require 'httparty'
|
4
|
+
require 'jwt'
|
5
|
+
|
6
|
+
class SocketServ
|
7
|
+
def self.base_uri
|
8
|
+
ENV["SOCKETSERV_API_URL"] || "www.socketserv.com:443"
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.websocket_uri
|
12
|
+
if base_uri =~ /:443$/
|
13
|
+
uri = base_uri.gsub(/:443$/, '')
|
14
|
+
"wss://#{uri}/ws"
|
15
|
+
else
|
16
|
+
"ws://#{uri}/ws"
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.configure(&block)
|
21
|
+
block.yield self
|
22
|
+
end
|
23
|
+
|
24
|
+
def self.mint_token(client_id=nil, client_secret=nil)
|
25
|
+
client_secret ||= ENV["SOCKETSERV_APP_SECRET"]
|
26
|
+
client_id ||= ENV["SOCKETSERV_APP_ID"]
|
27
|
+
|
28
|
+
payload = {
|
29
|
+
iss: "Application:#{client_id}",
|
30
|
+
iat: Time.now.to_i,
|
31
|
+
exp: 1.week.from_now.to_i
|
32
|
+
}
|
33
|
+
|
34
|
+
JWT.encode(payload, client_secret, "HS256")
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
require 'socket_serv/client'
|
39
|
+
|
40
|
+
if defined?(::Rails)
|
41
|
+
require 'socket_serv/rails_helper'
|
42
|
+
require 'socket_serv/engine'
|
43
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'socket_serv'
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'socket_serv/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "socketserv-ruby"
|
8
|
+
spec.version = SocketServ::VERSION
|
9
|
+
spec.authors = ["Keita Kobayashi"]
|
10
|
+
spec.email = ["keita@kkob.us"]
|
11
|
+
|
12
|
+
spec.summary = %q{The official SocketServ API Ruby client}
|
13
|
+
spec.homepage = "https://github.com/SocketServ/socketserv-ruby"
|
14
|
+
|
15
|
+
# Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
|
16
|
+
# delete this section to allow pushing this gem to any host.
|
17
|
+
# if spec.respond_to?(:metadata)
|
18
|
+
# spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
|
19
|
+
# else
|
20
|
+
# raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
|
21
|
+
# end
|
22
|
+
|
23
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
24
|
+
spec.bindir = "exe"
|
25
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
26
|
+
spec.require_paths = ["lib"]
|
27
|
+
|
28
|
+
spec.add_dependency "httparty"
|
29
|
+
spec.add_dependency "jwt"
|
30
|
+
|
31
|
+
spec.add_development_dependency "bundler", "~> 1.10"
|
32
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
33
|
+
spec.add_development_dependency "pry"
|
34
|
+
spec.add_development_dependency "rspec"
|
35
|
+
spec.add_development_dependency "webmock"
|
36
|
+
spec.add_development_dependency "vcr"
|
37
|
+
end
|
metadata
ADDED
@@ -0,0 +1,172 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: socketserv-ruby
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Keita Kobayashi
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-09-10 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: httparty
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: jwt
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.10'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.10'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: webmock
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: vcr
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
description:
|
126
|
+
email:
|
127
|
+
- keita@kkob.us
|
128
|
+
executables: []
|
129
|
+
extensions: []
|
130
|
+
extra_rdoc_files: []
|
131
|
+
files:
|
132
|
+
- ".gitignore"
|
133
|
+
- ".rspec"
|
134
|
+
- ".travis.yml"
|
135
|
+
- CHANGELOG.md
|
136
|
+
- Gemfile
|
137
|
+
- LICENSE
|
138
|
+
- README.md
|
139
|
+
- Rakefile
|
140
|
+
- bin/console
|
141
|
+
- bin/setup
|
142
|
+
- lib/socket_serv.rb
|
143
|
+
- lib/socket_serv/client.rb
|
144
|
+
- lib/socket_serv/engine.rb
|
145
|
+
- lib/socket_serv/rails_helper.rb
|
146
|
+
- lib/socket_serv/version.rb
|
147
|
+
- lib/socketserv-ruby.rb
|
148
|
+
- socketserv-ruby.gemspec
|
149
|
+
homepage: https://github.com/SocketServ/socketserv-ruby
|
150
|
+
licenses: []
|
151
|
+
metadata: {}
|
152
|
+
post_install_message:
|
153
|
+
rdoc_options: []
|
154
|
+
require_paths:
|
155
|
+
- lib
|
156
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
157
|
+
requirements:
|
158
|
+
- - ">="
|
159
|
+
- !ruby/object:Gem::Version
|
160
|
+
version: '0'
|
161
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
162
|
+
requirements:
|
163
|
+
- - ">="
|
164
|
+
- !ruby/object:Gem::Version
|
165
|
+
version: '0'
|
166
|
+
requirements: []
|
167
|
+
rubyforge_project:
|
168
|
+
rubygems_version: 2.4.5
|
169
|
+
signing_key:
|
170
|
+
specification_version: 4
|
171
|
+
summary: The official SocketServ API Ruby client
|
172
|
+
test_files: []
|