oceanex-slanger 0.7.1.3 → 0.7.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +16 -30
  3. data/lib/slanger/version.rb +1 -1
  4. metadata +13 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5e94b170fa4ca189ff90da97498233d1c6af1d7159936510d17af03a259c47df
4
- data.tar.gz: 4779c219ae6bb37e49194b8ae16e1152d261663b0a0932669fcc78e8bc132df5
3
+ metadata.gz: b8d982e2c189e52f3905e70cdcb0b4c9c00cbbe2cc7b173769ad547cecc58773
4
+ data.tar.gz: 8e045a72b30957002c11ba9015d5dc9fd06dbfe0b29274bbbd03cd67fa6a457e
5
5
  SHA512:
6
- metadata.gz: 9447c272e597b97e5ec57939f4b401bfebe3ddd19cf00eb31465984951c1d276d2019d5c7ee01c1c3b7240ca3875042e046d12e54e826ac6f9748f4ca98b50f7
7
- data.tar.gz: 0ec1b39904ebe373b5d09051fa9f987f2684c83aca0fd5b41f7042af30b1a6f09db3bb44401a9f2f1a6617a4a912b1d287e1cf4db2587ec7719adc7d69cbac89
6
+ metadata.gz: 883726b3449fa3f622aa9dbf5a380e7cfc7688bf660d6420d5bdeefdd8247049e958943ac0442d2d17591eca06993f77d1c532189b9bd5f520ef2839ee58e70d
7
+ data.tar.gz: ca574e7bec766e86e5d3ef783c46f7cfaa558e7be5b0fed6a81f6985859d222ab21a907537c04f7b5ed322f79c456e8c5cca3cb0dc6fddb2dabc6868ef3a0f4a
data/README.md CHANGED
@@ -1,10 +1,11 @@
1
1
  # OceanEx Slanger
2
+ [![Gem Version](https://badge.fury.io/rb/oceanex-slanger.svg)](https://badge.fury.io/rb/oceanex-slanger) [![Build Status](https://travis-ci.com/jobleeyoui/slanger.svg?branch=master)](https://travis-ci.com/jobleeyoui/slanger)
2
3
 
3
4
  The OceanEx Slanger inherits from the unmaintained Slanger. The project is backed by OceanEx dev team.
4
5
 
5
6
  We will do regularly bug fixes and security updates.
6
7
 
7
- We might future add more features or provide performance improvements for OceanEx Slanger. The maintenance will continue until we find better option.
8
+ We might further add more features or provide performance improvements for OceanEx Slanger. The maintenance will continue until we find better option.
8
9
 
9
10
  Feel free to log any issue or contribute to the code base.
10
11
 
@@ -57,8 +58,7 @@ rbenv install 2.6.3
57
58
  rbenv global 2.6.3
58
59
  ```
59
60
 
60
- Usually, install the Oceanex Slanger should be pretty easy with the following command. OceanEx Slanger is just a variation of the unmaintained Slanger.
61
- The execution kept the same way as before. Please check our release note to see what is new in additional to the unmaintained Slanger.
61
+ Then install the OceanEx Slanger
62
62
 
63
63
  ```
64
64
  gem install oceanex-slanger
@@ -66,7 +66,7 @@ gem install oceanex-slanger
66
66
 
67
67
  ### Mac
68
68
 
69
- Install the ruby version via brew
69
+ Install the ruby version via home brew
70
70
 
71
71
  ```
72
72
  brew install ruby
@@ -79,8 +79,7 @@ rbenv install 2.6.3
79
79
  rbenv global 2.6.3
80
80
  ```
81
81
 
82
- Installation should be pretty straightforward on linux, however, install OceanEx Slanger might fail on mac os.
83
- This is due to the c compiler converts the warning to error when building the native extension.
82
+ Installation might fail when some dependent gems builds their native extension. This is due to the c compiler converts the warning to error when do so.
84
83
 
85
84
  If you see installation fails due to `implicit-function-declaration`, you could try the following step to suppress the warning.
86
85
 
@@ -93,7 +92,7 @@ gem install oceanex-slanger -- --with-cflags="-Wno-error=implicit-function-decla
93
92
  Both the app key and app secret are just random string, you could choose any string. However, it is recommended to be long
94
93
  enough to keep secure.
95
94
 
96
- Oceanex slanger also depends on redis service, specify the redis url when launching the OceanEx Slanger.
95
+ Oceanex Slanger also depends on redis service, specify the redis url when launching the OceanEx Slanger.
97
96
 
98
97
  ```
99
98
  slanger --app_key $APP_KEY --secret $APP_SECRET -r $REDIS_URL
@@ -122,7 +121,7 @@ Slanger WebSocket server listening on port 8080
122
121
 
123
122
  ## Start the OceanEx Slanger in Docker environment
124
123
 
125
- The OceanEx slanger supports running in docker environment and such approach is already encapsulated in the make command.
124
+ The OceanEx Slanger supports running in docker environment and such approach is already encapsulated in the make command.
126
125
  The dependent Redis docker image is also automatically downloaded and started.
127
126
 
128
127
  For the app key and app secret, please check `docker-compose.yaml` and modify as needed.
@@ -142,10 +141,9 @@ make up
142
141
  make down
143
142
  ```
144
143
 
145
- ## Modifying your application code to use the Slanger service
146
-
147
- Once you have a Slanger instance listening for incoming connections you need to alter you application code to use the Slanger endpoint instead of Pusher. Fortunately this is very simple, unobtrusive, easily reversable, and very painless.
144
+ ## Modifying your application code to use the OceanEx Slanger service
148
145
 
146
+ Once you have a OceanEx Slanger instance listening for incoming connections you need to alter you application code to use the OceanEx Slanger endpoint instead of Pusher. Fortunately this is very simple, unobtrusive, easily reversable, and very painless.
149
147
 
150
148
  First you will need to add code to your server side component that publishes events to the Pusher HTTP REST API, usually this means telling the Pusher client to use a different host and port, e.g. consider this Ruby example
151
149
 
@@ -173,7 +171,7 @@ Of course you could proxy all requests to `ws.example.com` to port 8080 of your
173
171
 
174
172
  # Configuration Options
175
173
 
176
- Slanger supports several configuration options, which can be supplied as command line arguments at invocation. You can also supply a yaml file containing config options. If you use the config file in combination with other configuration options, the values passed on the command line will win. Allows running multiple instances with only a few differences easy.
174
+ OceanEx Slanger supports several configuration options, which can be supplied as command line arguments at invocation. You can also supply a yaml file containing config options. If you use the config file in combination with other configuration options, the values passed on the command line will win. Allows running multiple instances with only a few differences easy.
177
175
 
178
176
  ```
179
177
  -k or --app_key This is the Pusher app key you want to use. This is a required argument on command line or in optional config file
@@ -201,21 +199,6 @@ Slanger supports several configuration options, which can be supplied as command
201
199
  --pid_file The path to a file you want slanger to write it's PID to. Optional.
202
200
  ```
203
201
 
204
- # Why use Slanger instead of Pusher?
205
-
206
- There a few reasons you might want to use Slanger instead of Pusher, e.g.
207
-
208
- - You operate in a heavily regulated industry and are worried about sending data to 3rd parties, and it is an organisational requirement that you own your own infrastructure.
209
- - You might be travelling on an airplane without internet connectivity as I am right now. Airplane rides are very good times to get a lot done, unfortunately external services are also usually unreachable. Remove internet connectivity as a dependency of your development envirionment by running a local Slanger instance in development and Pusher in production.
210
- - Remove the network dependency from your test suite.
211
- - You want to extend the Pusher protocol or have some special requirement. If this applies to you, chances are you are out of luck as Pusher is unlikely to implement something to suit your special use case, and rightly so. With Slanger you are free to modify and extend its behavior anyway that suits your purpose.
212
-
213
- # Why did you write Slanger
214
-
215
- I wanted to write a non-trivial evented app. I also want to write a book on evented programming in Ruby as I feel there is scant good information available on the topic and this project is handy to show publishers.
216
-
217
- Pusher is an awesome service, very reasonably priced, and run by an awesome crew. Give them a spin on your next project.
218
-
219
202
  # Original Author
220
203
 
221
204
  - Stevie Graham
@@ -232,8 +215,11 @@ Pusher is an awesome service, very reasonably priced, and run by an awesome crew
232
215
  - Florian Gilcher
233
216
  - Claudio Poli
234
217
 
235
- # Current Author and Maintainer
236
- - joblee
218
+ # Current Core Team and Contributor
219
+ - Joblee
220
+ - Steve
221
+ - Yao
222
+ - Meng
237
223
 
238
224
 
239
- © 2020 a joblee joint.
225
+ © 2020 a OceanEx joint.
@@ -1,3 +1,3 @@
1
1
  module Slanger
2
- VERSION = "0.7.1.3"
2
+ VERSION = "0.7.1.4"
3
3
  end
metadata CHANGED
@@ -1,14 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: oceanex-slanger
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.1.3
4
+ version: 0.7.1.4
5
5
  platform: ruby
6
6
  authors:
7
- - joblee
7
+ - Joblee
8
+ - Steve
9
+ - Yao
10
+ - Meng
8
11
  autorequire:
9
12
  bindir: bin
10
13
  cert_chain: []
11
- date: 2020-09-13 00:00:00.000000000 Z
14
+ date: 2020-09-15 00:00:00.000000000 Z
12
15
  dependencies:
13
16
  - !ruby/object:Gem::Dependency
14
17
  name: eventmachine
@@ -142,14 +145,14 @@ dependencies:
142
145
  requirements:
143
146
  - - "~>"
144
147
  - !ruby/object:Gem::Version
145
- version: 1.1.6
148
+ version: 1.1.7
146
149
  type: :runtime
147
150
  prerelease: false
148
151
  version_requirements: !ruby/object:Gem::Requirement
149
152
  requirements:
150
153
  - - "~>"
151
154
  - !ruby/object:Gem::Version
152
- version: 1.1.6
155
+ version: 1.1.7
153
156
  - !ruby/object:Gem::Dependency
154
157
  name: oj
155
158
  requirement: !ruby/object:Gem::Requirement
@@ -304,7 +307,7 @@ dependencies:
304
307
  - - "~>"
305
308
  - !ruby/object:Gem::Version
306
309
  version: 13.0.1
307
- description: The oceanex slanger inherits from unmaintained project slanger and continue
310
+ description: The Oceanex Slanger inherits from unmaintained project Slanger and continue
308
311
  to provide update and fixes
309
312
  email:
310
313
  - jobleeyoui@gmail.com
@@ -349,13 +352,13 @@ files:
349
352
  - spec/unit/channel_spec.rb
350
353
  - spec/unit/request_validation_spec.rb
351
354
  - spec/unit/webhook_spec.rb
352
- homepage: https://github.com/jobleeyoui/oceanex-slanger
355
+ homepage: https://github.com/OceanEx/slanger
353
356
  licenses:
354
357
  - MIT
355
358
  metadata:
356
- homepage_uri: https://github.com/jobleeyoui/oceanex-slanger
357
- source_code_uri: https://github.com/jobleeyoui/oceanex-slanger/archive/v0.7.1.1.zip
358
- changelog_uri: https://github.com/jobleeyoui/oceanex-slanger/releases
359
+ homepage_uri: https://github.com/OceanEx/slanger
360
+ source_code_uri: https://github.com/OceanEx/slanger/archive/v0.7.1.4.zip
361
+ changelog_uri: https://github.com/OceanEx/slanger/releases
359
362
  post_install_message:
360
363
  rdoc_options: []
361
364
  require_paths: