ringcentral-rss 0.0.1 → 0.0.2
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 +4 -4
- data/CHANGELOG.md +3 -2
- data/README.md +24 -3
- data/lib/ringcentral-rss.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3d844f42c65b7365305378fcf2cd7d0415b22f09
|
|
4
|
+
data.tar.gz: 370dd56d4b7c40a60c134564935009d2933108f2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0cec2cecf9aa6f228dd652691a62c02746b9a7db46893c00e3c5eb00bb146d6f9132a1230da7093ae7f6ec740cf76b0756fa053747040fb88cca99b679ed63b7
|
|
7
|
+
data.tar.gz: 77b292b6f30e799c2d7d9eded33f673608cfa350a228c837fcbead940775fa22e98bb8a5c57d58c05ebe6e246f2754493dc7a26cbc656333c873b0caaed2e33c
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -13,16 +13,27 @@ RingCentral RSS
|
|
|
13
13
|
|
|
14
14
|
Ruby library to create XML syndication feeds for RingCentral `message-store` REST API responses.
|
|
15
15
|
|
|
16
|
-
This library was originally created in response to a question on
|
|
16
|
+
This library was originally created in response to a question on [archiving RingCentral SMS data using Smarsh via a RSS feed](https://devcommunity.ringcentral.com/ringcentraldev/topics/archive-sms-using-rss).
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
gem install ringcentral-rss
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
While `ringcentral_sdk` isn't strictly required for this SDK, it does build feeds based on the `Faraday::Response` objects returned by the SDK.
|
|
17
25
|
|
|
18
26
|
## Usage
|
|
19
27
|
|
|
20
28
|
```ruby
|
|
29
|
+
require 'ringcentral-rss'
|
|
30
|
+
require 'ringcentral_sdk'
|
|
31
|
+
|
|
21
32
|
client = RingCentralSdk.new [...]
|
|
22
33
|
client.authorize [...]
|
|
23
34
|
|
|
24
35
|
res = client.http.get do |req|
|
|
25
|
-
req.url
|
|
36
|
+
req.url 'account/~/extension/~/message-store'
|
|
26
37
|
req.params['direction'] = 'Outbound'
|
|
27
38
|
req.params['messageType'] = 'SMS'
|
|
28
39
|
end
|
|
@@ -38,7 +49,17 @@ xml = RingCentral::RSS::AtomFeed.new(res).feed.to_xml
|
|
|
38
49
|
Demo scripts are located in the [`scripts` directory of the GitHub repo](https://github.com/ringcentral-ruby/ringcentral-rss-ruby/tree/master/scripts). The following demos are included:
|
|
39
50
|
|
|
40
51
|
* CLI script to retrieve `message-store` endpoint and print out XML
|
|
41
|
-
* Sinatra web service to display XML
|
|
52
|
+
* Sinatra web service to display XML proof of concept for protected services (no included auth)
|
|
53
|
+
|
|
54
|
+
## Background
|
|
55
|
+
|
|
56
|
+
The genesis of this is the requirement to have RingCentral SMS messages available via a RSS feed. There are 3 ways to accomplish this:
|
|
57
|
+
|
|
58
|
+
1. Have a proxy feed that always retrieves the message-store API response and converts it to RSS
|
|
59
|
+
1. Have a script that polls the message-store API and publishes to a remote feed
|
|
60
|
+
1. Have a script that subscribes to the message-store eventFilter and publishes to a remote feed
|
|
61
|
+
|
|
62
|
+
The library code will convert RingCentral message-store API response and message objects into an XML feed. The included Sinatra web service will host this as a proxy feed (option #1 above).
|
|
42
63
|
|
|
43
64
|
### Change Log
|
|
44
65
|
|
data/lib/ringcentral-rss.rb
CHANGED