ringcentral-rss 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6627647cd565186e2efd9299aa2591d25768ce5
+  data.tar.gz: e8629c4031f2bebf5858260d5f379ee8b1506812
+SHA512:
+  metadata.gz: df0121ba74796b9a7fa15ed395193e818f21dc79a1d52bd492f25e2cf8170a7d27dc0b6016fe85c38900337b42acbe6b9da9ccfc3634896da8dfdb331e9a9a8d
+  data.tar.gz: 20498982cf5f979acdbcebda2ab94900ed2a3c504a8bd4ac8680da6e45615db9636882de3e64eaa32e79854f0127fdb97a4c87092760959d32c8e4175bab4c45

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+CHANGELOG
+---------
+- **2016-01-07**: 0.0.1
+  - Misc
+    - Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+RingCentral RSS
+===============
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+Ruby library to create XML syndication feeds for RingCentral `message-store` REST API responses.
+
+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).
+
+## Usage
+
+```ruby
+client = RingCentralSdk.new [...]
+client.authorize [...]
+
+res = client.http.get do |req|
+  req.url = 'account/~/extension/~/message-store'
+  req.params['direction'] = 'Outbound'
+  req.params['messageType'] = 'SMS'
+end
+
+rc_feed = RingCentral::RSS::AtomFeed.new res
+xml = rc_feed.feed.to_xml
+
+xml = RingCentral::RSS::AtomFeed.new(res).feed.to_xml
+```
+
+## Demo Scripts
+
+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:
+
+* CLI script to retrieve `message-store` endpoint and print out XML
+* Sinatra web service to display XML
+
+### Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Links
+
+Project Repo
+
+* https://github.com/ringcentral-ruby/ringcentral-rss
+
+RingCentral API Docs
+
+* https://developers.ringcentral.com/library.html
+
+RingCentral Official SDKs
+
+* https://github.com/ringcentral
+
+## Contributing
+
+1. Fork it ( http://github.com/ringcentral-ruby/ringcentral-rss/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+RingCentral RSS is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
+
+RingCentral RSS © 2016 by John Wang
+
+ [gem-version-svg]: https://badge.fury.io/rb/ringcentral-rss.svg
+ [gem-version-link]: http://badge.fury.io/rb/ringcentral-rss
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/ringcentral-rss
+ [downloads-link]: https://rubygems.org/gems/ringcentral-rss
+ [build-status-svg]: https://api.travis-ci.org/ringcentral-ruby/ringcentral-rss-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/ringcentral-ruby/ringcentral-rss-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/ringcentral-ruby/ringcentral-rss-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/ringcentral-ruby/ringcentral-rss-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/ringcentral-ruby/ringcentral-rss-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/ringcentral-ruby/ringcentral-rss-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/ringcentral-ruby/ringcentral-rss-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/ringcentral-ruby/ringcentral-rss-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/ringcentral-ruby/ringcentral-rss-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/ringcentral-ruby/ringcentral-rss-ruby/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/ringcentral-rss/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/ringcentral-ruby/ringcentral-rss-ruby/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task default: :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+task :gendoc do
+  # puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+  system 'yardoc'
+  system 'yard stats --list-undoc'
+end

data/lib/ringcentral-rss/atom_entry.rb

@@ -0,0 +1,43 @@
+require 'atom'
+
+module RingCentral
+  module RSS
+    class AtomEntry
+      attr_accessor :entry
+
+      def initialize(data = nil)
+        load_message(data) unless data.nil?
+      end
+
+      def load_message(data)
+        raise 'Data is not a hash' unless data.is_a? Hash
+
+        @entry = Atom::Entry.new do |e|
+          e.title = build_title data
+          e.links << Atom::Link.new(href: data['uri'])
+          e.id = data['id']
+          e.updated = Time.parse(data['lastModifiedTime'])
+          e.summary = data['subject']
+        end
+      end
+
+      def build_title(data)
+        raise 'Data is not a hash' unless data.is_a? Hash
+
+        parts = []
+
+        if data.key?('to') && (data['to'].length > 0) && data['to'][0]['phoneNumber']
+          to_phone_number = "#{data['to'][0]['phoneNumber']}"
+          parts << "To: #{to_phone_number}" unless to_phone_number.empty?
+        end
+
+        if data.key?('from') && !data['from']['phoneNumber'].empty?
+          from_phone_number = "#{data['from']['phoneNumber']}"
+          parts << "From: #{from_phone_number}"
+        end
+
+        "[#{data['direction']} #{data['type']}] " + parts.join('; ')
+      end
+    end
+  end
+end

data/lib/ringcentral-rss/atom_feed.rb

@@ -0,0 +1,29 @@
+require 'atom'
+
+module RingCentral
+  module RSS
+    class AtomFeed
+      attr_accessor :feed
+
+      def initialize(response = nil, opts = {})
+        if opts.key?(:feed_name) && opts[:feed_name]
+          @feed_name = opts[:feed_name]
+        else
+          @feed_name = 'RingCentral Feed'
+        end
+        load_message_store_response(response) unless response.nil?
+      end
+
+      def load_message_store_response(response)
+        @feed = Atom::Feed.new do |f|
+          f.title = @feed_name
+          f.links << Atom::Link.new(href: "#{response.body['uri']}")
+          f.updated = Time.parse("#{response.headers['date']}")
+          response.body['records'].each do |message|
+            f.entries << RingCentral::RSS::AtomEntry.new(message).entry
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ringcentral-rss.rb

@@ -0,0 +1,8 @@
+require 'ringcentral-rss/atom_entry'
+require 'ringcentral-rss/atom_feed'
+
+module RingCentral
+  module RSS
+    VERSION = '0.0.1'.freeze
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'ringcentral-rss'

data/test/test_setup.rb

@@ -0,0 +1,13 @@
+require './test/test_base.rb'
+require 'ringcentral-rss'
+
+class RingCentralRSSTest < Test::Unit::TestCase
+
+  def test_main
+    feed = RingCentral::RSS::AtomFeed.new
+    assert_equal 'RingCentral::RSS::AtomFeed', feed.class.name
+
+    entry = RingCentral::RSS::AtomEntry.new
+    assert_equal 'RingCentral::RSS::AtomEntry', entry.class.name
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ringcentral-rss
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ratom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Convert RingCentral Message Store Results to RSS
+email: johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/ringcentral-rss.rb
+- lib/ringcentral-rss/atom_entry.rb
+- lib/ringcentral-rss/atom_feed.rb
+- test/test_base.rb
+- test/test_setup.rb
+homepage: https://github.com/grokify/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: RingCentral RSS - Convert RingCentral Message Store Results to RSS
+test_files: []