ringcentral-sdk 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74403294f6706daa698a0dc6e079c8f32786eb3a
-  data.tar.gz: ca292de945b064added3734ca38c861d1f22bbe1
+  metadata.gz: 985e9f0cf6416e2288c2330b596fde160e32a381
+  data.tar.gz: 631d59c2a2c13baa8178fadfc466c6044209b9c4
 SHA512:
-  metadata.gz: 969e4771863da2fdedda6c518fa8cbd56d01a048b5eaa6e65ceb028572236a44c4f13b8e520b883d9f3ef3fd234c4f537e490bc8753e8bd18cc33a0f42d6f205
-  data.tar.gz: b1f1269490113051cf9eb88f770a8b7daf4abfdd90367a2328a9ca1c11585773ea809d36237fc216a47019404e62fd2c10ae98fdec017053c626a01529baf864
+  metadata.gz: 2b44f5dddcbc5c65b8c1484844665ce01c2944f42f71d708992bfacbd54f0a977c98b8f87a566a456afc2bc17056328e7663e279aca1559e44059556bfecb906
+  data.tar.gz: 1206c7a15bb653e5cb412e1b814031c4b7726f53f39875a56e2cb8688096a1abe68ae6d7aef7c552c2a0f5d2842eeea35d1e03d7002dab44c976ad556205875f

data/README.md

@@ -1,9 +1,13 @@
-# RingCentral Ruby SDK
+# ringcentral-ruby
+
+Ruby SDK for RingCentral.
 
 
 ## Installation
 
-Add `gem 'ringcentral-sdk'` to `Gemfile` and run `bundle install`.
+```
+gem install ringcentral-sdk
+```
 
 
 ## Documentation
@@ -21,12 +25,12 @@ rc.authorize(username: ENV['username'], extension: ENV['extension'], password: E
 
 # get
 r = rc.get('/restapi/v1.0/account/~/extension/~')
-assert_not_equal nil, r
-assert_equal '101', JSON.parse(r.body)['extensionNumber']
+expect(r).not_to be_nil
+expect('101').to eq(JSON.parse(r.body)['extensionNumber'])
 ```
 
 
-For more sample code, please refer to the [test cases](/test).
+For more sample code, please refer to the [test cases](/spec).
 
 
 ## How to test
@@ -44,7 +48,7 @@ password=password
 receiver=number-to-receiver-sms
 ```
 
-Run `rake test`
+Run `rspec`
 
 
 ## License
@@ -55,5 +59,6 @@ MIT
 ## Todo
 
 - Travis CI
-- code coverage
-- PubNub subscription
+- Code coverage
+- Batch requests
+- Fax & SMS

data/ringcentral-sdk.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.2.2'
+  gem.version       = '0.3.0'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
   gem.summary       = 'RingCentral Ruby SDK.'
-  gem.homepage      = 'https://github.com/tylerlong/ringcentral-ruby'
+  gem.homepage      = 'https://github.com/ringcentral/ringcentral-ruby'
   gem.license       = 'MIT'
 
   gem.require_paths = ['lib']
-  gem.files         = %w(Rakefile README.md ringcentral-sdk.gemspec)
+  gem.files         = %w(README.md ringcentral-sdk.gemspec)
   gem.files        += Dir['lib/**/*.rb']
-  gem.test_files    = Dir['test/**/*.rb']
+  gem.test_files    = Dir['spec/**/*.rb']
 
   gem.add_dependency('rest-client', '~> 2.0', '>= 2.0.2')
   gem.add_dependency('addressable', '~> 2.5', '>= 2.5.2')

data/spec/ringcentral_spec.rb

@@ -0,0 +1,81 @@
+require 'ringcentral'
+
+RSpec.describe 'RingCentral' do
+  describe 'ringcentral' do
+    it 'test_class_variables' do
+      expect('https://platform.devtest.ringcentral.com').to eq(RingCentral.SANDBOX_SERVER)
+      expect('https://platform.ringcentral.com').to eq(RingCentral.PRODUCTION_SERVER)
+    end
+
+    it 'test_initializer' do
+      rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
+      expect('app_key').to eq(rc.app_key)
+      expect('app_secret').to eq(rc.app_secret)
+      expect('https://platform.devtest.ringcentral.com').to eq(rc.server)
+      expect(true).to eq(rc.auto_refresh)
+    end
+
+    it 'test_authorize_uri' do
+      rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
+      expect(RingCentral.SANDBOX_SERVER + '/restapi/oauth/authorize?client_id=app_secret&redirect_uri=https%3A%2F%2Fexample.com&response_type=code&state=mystate').to eq(rc.authorize_uri('https://example.com', 'mystate'))
+    end
+
+    it 'test_password_flow' do
+      Dotenv.load
+      rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+      expect(rc.token).to be_nil
+
+      # create token
+      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+      expect(rc.token).not_to be_nil
+
+      # refresh token
+      rc.refresh
+      expect(rc.token).not_to be_nil
+
+      # revoke token
+      rc.revoke
+      expect(rc.token).to be_nil
+    end
+
+    it 'test_http_methods' do
+      Dotenv.load
+      rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+
+      # get
+      r = rc.get('/restapi/v1.0/account/~/extension/~')
+      expect(r).not_to be_nil
+      expect('101').to eq(JSON.parse(r.body)['extensionNumber'])
+
+      # post
+      r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+        to: [{phoneNumber: ENV['receiver']}],
+        from: {phoneNumber: ENV['username']},
+        text: 'Hello world'
+      })
+      expect(r).not_to be_nil
+      message = JSON.parse(r.body)
+      expect('SMS').to eq(message['type'])
+      messageUrl = "/restapi/v1.0/account/~/extension/~/message-store/#{message['id']}"
+
+      # put
+      r = rc.put(messageUrl, payload: { readStatus: 'Unread' })
+      expect(r).not_to be_nil
+      message = JSON.parse(r.body)
+      expect('Unread').to eq(message['readStatus'])
+      r = rc.put(messageUrl, payload: { readStatus: 'Read' })
+      expect(r).not_to be_nil
+      message = JSON.parse(r.body)
+      expect('Read').to eq(message['readStatus'])
+
+      # delete
+      r = rc.delete(messageUrl)
+      expect(r).not_to be_nil
+      r = rc.get(messageUrl)
+      expect(r).not_to be_nil
+      message = JSON.parse(r.body)
+      expect('Deleted').to eq(message['availability'])
+    end
+  end
+end

data/spec/subscription_spec.rb

@@ -0,0 +1,31 @@
+require 'ringcentral'
+require 'dotenv'
+require 'rspec'
+
+RSpec.describe 'Subscription' do
+  describe 'subscription' do
+    it 'receives message notification' do
+      Dotenv.load
+      rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+
+      events = [
+        '/restapi/v1.0/account/~/extension/~/message-store',
+      ]
+      count = 0
+      subscription = rc.subscription(events, lambda { |message|
+        count += 1
+      })
+      subscription.subscribe()
+
+      rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+        to: [{phoneNumber: ENV['receiver']}],
+        from: {phoneNumber: ENV['username']},
+        text: 'Hello world'
+      })
+      sleep(20)
+
+      expect(count).to be > 0
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Liu
@@ -98,13 +98,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- Rakefile
 - lib/ringcentral.rb
 - lib/subscription.rb
 - ringcentral-sdk.gemspec
-- test/test_ringcentral.rb
-- test/test_subscription.rb
-homepage: https://github.com/tylerlong/ringcentral-ruby
+- spec/ringcentral_spec.rb
+- spec/subscription_spec.rb
+homepage: https://github.com/ringcentral/ringcentral-ruby
 licenses:
 - MIT
 metadata: {}
@@ -129,5 +128,5 @@ signing_key:
 specification_version: 4
 summary: RingCentral Ruby SDK.
 test_files:
-- test/test_ringcentral.rb
-- test/test_subscription.rb
+- spec/ringcentral_spec.rb
+- spec/subscription_spec.rb

data/Rakefile

@@ -1,8 +0,0 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/test/test_ringcentral.rb

@@ -1,81 +0,0 @@
-require 'test/unit'
-require 'ringcentral'
-require 'dotenv'
-
-class RingCentralTest < Test::Unit::TestCase
-  def test_class_variables
-    assert_equal 'https://platform.devtest.ringcentral.com', RingCentral.SANDBOX_SERVER
-    assert_equal 'https://platform.ringcentral.com', RingCentral.PRODUCTION_SERVER
-  end
-
-  def test_initializer
-    rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
-    assert_equal 'app_key', rc.app_key
-    assert_equal 'app_secret', rc.app_secret
-    assert_equal 'https://platform.devtest.ringcentral.com', rc.server
-    assert_equal true, rc.auto_refresh
-  end
-
-  def test_authorize_uri
-    rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
-    assert_equal RingCentral.SANDBOX_SERVER + '/restapi/oauth/authorize?client_id=app_secret&redirect_uri=https%3A%2F%2Fexample.com&response_type=code&state=mystate', rc.authorize_uri('https://example.com', 'mystate')
-  end
-
-  def test_password_flow
-    Dotenv.load
-    rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
-    assert_equal nil, rc.token
-
-    # create token
-    rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
-    assert_not_equal nil, rc.token
-
-    # refresh token
-    rc.refresh
-    assert_not_equal nil, rc.token
-
-    # revoke token
-    rc.revoke
-    assert_equal nil, rc.token
-  end
-
-  def test_http_methods
-    Dotenv.load
-    rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
-    rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
-
-    # get
-    r = rc.get('/restapi/v1.0/account/~/extension/~')
-    assert_not_equal nil, r
-    assert_equal '101', JSON.parse(r.body)['extensionNumber']
-
-    # post
-    r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-      to: [{phoneNumber: ENV['receiver']}],
-      from: {phoneNumber: ENV['username']},
-      text: 'Hello world'
-    })
-    assert_not_equal nil, r
-    message = JSON.parse(r.body)
-    assert_equal 'SMS', message['type']
-    messageUrl = "/restapi/v1.0/account/~/extension/~/message-store/#{message['id']}"
-
-    # put
-    r = rc.put(messageUrl, payload: { readStatus: 'Unread' })
-    assert_not_equal nil, r
-    message = JSON.parse(r.body)
-    assert_equal 'Unread', message['readStatus']
-    r = rc.put(messageUrl, payload: { readStatus: 'Read' })
-    assert_not_equal nil, r
-    message = JSON.parse(r.body)
-    assert_equal 'Read', message['readStatus']
-
-    # delete
-    r = rc.delete(messageUrl)
-    assert_not_equal nil, r
-    r = rc.get(messageUrl)
-    assert_not_equal nil, r
-    message = JSON.parse(r.body)
-    assert_equal 'Deleted', message['availability']
-  end
-end

data/test/test_subscription.rb

@@ -1,18 +0,0 @@
-require 'test/unit'
-require 'ringcentral'
-require 'dotenv'
-
-class SubscriptionTest < Test::Unit::TestCase
-  def test_create_subscription
-    # Dotenv.load
-    # rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
-    # rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
-    # events = [
-    #   '/restapi/v1.0/account/~/extension/~/message-store',
-    # ]
-    # subscription = rc.subscription(events, ->(message) {
-    #   puts message
-    # })
-    # subscription.subscribe()
-  end
-end