ringcentral-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e43034b49bfa6d2d866165e36e061a6ef701d506
-  data.tar.gz: d6607d5e22320e2461f74a0448f018806d7b4cb3
+  metadata.gz: 22713ecf76dc139e0a97fc0947a1e81c8782d3ae
+  data.tar.gz: 9d3a34d9a689633fcfa6116eda4ce9545657da73
 SHA512:
-  metadata.gz: 8d413033eace79af29bf4ecb81548cd540fd48fd0e93cbb0813a9dbc8af00ce2c56a4276a3b81bd89183ef984a757f7fa88b7a16b05df9d6cce40bd25f714dee
-  data.tar.gz: c27d5e4a229e3e3988a1065661207595a9c59c411f1d42b4771deeaff79765e940e141668a7e91a58444da8894eaf7ebe6cf20e4bae3bc9cf838c465ab4a6d67
+  metadata.gz: 4518d6cc3bf373040f63960cedab921b6e13a776e6ef41b9121c3d0c2b2a04f046f821730ef07445cabfc488306bfb3c7b9252086ab32a5c27e87b291d9dc60e
+  data.tar.gz: bf884572171894c8df910610e0f45ea762155970d342e74a5cbdb164f94ed8756e42f108443e512b47bc7a92309b8b9a01acf3de9063c0d821bfd75d072e152f

data/README.md

@@ -3,7 +3,7 @@
 
 ## Installation
 
-Add `gem 'ringcentral-sdk'` to `Gemfile`.
+Add `gem 'ringcentral-sdk'` to `Gemfile` and run `bundle install`.
 
 
 ## Documentation
@@ -31,6 +31,8 @@ password=password
 receiver=number-to-receiver-sms
 ```
 
+Run `rake test`
+
 
 ## License
 
@@ -39,7 +41,6 @@ MIT
 
 ## Todo
 
-- unit tests
 - Travis CI
 - code coverage
-- publish to https://rubygems.org
+- PubNub subscription

data/lib/ringcentral.rb

@@ -1,5 +1,140 @@
+require 'base64'
+require 'addressable/uri'
+require 'subscription'
+require 'rest-client'
+require 'json'
+
 class RingCentral
-  def self.hi
-    'hello'
+  def self.SANDBOX_SERVER
+    'https://platform.devtest.ringcentral.com'
+  end
+
+  def self.PRODUCTION_SERVER
+    'https://platform.ringcentral.com'
+  end
+
+  attr_reader :app_key, :app_secret, :server
+  attr_accessor :auto_refresh
+
+  def initialize(app_key, app_secret, server)
+    @app_key = app_key
+    @app_secret = app_secret
+    @server = server
+    @auto_refresh = true
+    @token = nil
+  end
+
+  def token
+    @token
+  end
+
+  def token=(value)
+    @token = value
+    if @timer != nil
+      @timer.shutdown
+      @timer = nil
+    end
+    if @auto_refresh && value != nil
+      @timer = Concurrent::TimerTask.new(execution_interval: value.expires_in - 120, timeout_interval: 60) do
+        refresh
+      end
+      @timer.execute
+    end
+  end
+
+  def authorize(username: nil, extension: nil, password: nil, auth_code: nil, redirect_uri: nil)
+    if auth_code != nil
+      payload = {
+        grant_type: 'authorization_code',
+        code: auth_code,
+        redirect_uri: redirect_uri,
+      }
+    else
+      payload = {
+        grant_type: 'password',
+        username: username,
+        extension: extension,
+        password: password,
+      }
+    end
+    @token = nil
+    r = post('/restapi/oauth/token', payload: payload)
+    @token = JSON.parse(r.body)
+  end
+
+  def refresh
+    return if @token == nil
+    payload = {
+      grant_type: 'refresh_token',
+      refresh_token: @token['refresh_token']
+    }
+    @token = nil
+    r = post('/restapi/oauth/token', payload: payload)
+    @token = JSON.parse(r.body)
+  end
+
+  def revoke
+    return if @token == nil
+    payload = {
+      token: @token['access_token']
+    }
+    @token = nil
+    post('/restapi/oauth/revoke', payload: payload)
+  end
+
+  def authorize_uri(redirect_uri, state = '')
+    uri = Addressable::URI.parse(@server) + '/restapi/oauth/authorize'
+    uri.query_values = {
+      response_type: 'code',
+      state: state,
+      redirect_uri: redirect_uri,
+      client_id: @app_secret
+    }
+    uri.to_s
+  end
+
+  def get(endpoint, params = nil)
+    request(:get, endpoint, params: params)
+  end
+
+  def post(endpoint, payload: nil, params: nil, files: nil)
+    request(:post, endpoint, payload: payload, params: params, files: files)
+  end
+
+  def put(endpoint, payload: nil, params: nil, files: nil)
+    request(:put, endpoint, payload: payload, params: params, files: files)
+  end
+
+  def delete(endpoint, params = nil)
+    request(:delete, endpoint, params: params)
+  end
+
+  def subscription(event_filters, callback)
+    Subscription.new(event_filters, callback)
+  end
+
+  private
+
+  def basic_key
+    Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/\s/, '')
+  end
+
+  def autorization_header
+    return "Bearer #{@token['access_token']}" if @token != nil
+    return "Basic #{basic_key}"
+  end
+
+  def request(method, endpoint, params: nil, payload: nil, files: nil)
+    url = (Addressable::URI.parse(@server) + endpoint).to_s
+    user_agent_header = "ringcentral/ringcentral-ruby Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
+    headers = {
+      'Authorization': autorization_header,
+      'RC-User-Agent': user_agent_header
+    }
+    if payload != nil && @token != nil
+      headers['Content-Type'] = 'application/json'
+      payload = payload.to_json
+    end
+    RestClient::Request.execute(method: method.to_sym, url: url, params: params, payload: payload, headers: headers, files: files)
   end
 end

data/lib/subscription.rb

@@ -0,0 +1,2 @@
+class Subscription
+end

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.1.0'
+  gem.version       = '0.2.0'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -13,5 +13,7 @@ Gem::Specification.new do |gem|
   gem.files        += Dir['lib/**/*.rb']
   gem.test_files    = Dir['test/**/*.rb']
 
-  gem.add_dependency('rest-client', '>= 2.0.2')
+  gem.add_dependency('rest-client', '~> 2.0', '>= 2.0.2')
+  gem.add_dependency('addressable', '~> 2.5', '>= 2.5.2')
+  gem.add_dependency('concurrent-ruby', '~> 1.0', '>= 1.0.2')
 end

data/test/test_ringcentral.rb

@@ -1,8 +1,81 @@
 require 'test/unit'
 require 'ringcentral'
+require 'dotenv'
 
 class RingCentralTest < Test::Unit::TestCase
-  def test_hello
-    assert_equal "hello", RingCentral.hi
+  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

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
@@ -21,9 +24,52 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -34,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - lib/ringcentral.rb
+- lib/subscription.rb
 - ringcentral-sdk.gemspec
 - test/test_ringcentral.rb
 homepage: https://github.com/tylerlong/ringcentral-ruby