ringcentral_sdk 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5241b80c9b064f0ee4c021d86316612f3008d896
-  data.tar.gz: 8664676e294bb0205b4347be52bc163f9a345281
+  metadata.gz: 2e86f94a7d493e3b4b86817ff1aec24c89403ea9
+  data.tar.gz: f8943b0a9a385c93ab67d7f4603e54afba43db87
 SHA512:
-  metadata.gz: 375996f0b06a945a6949e0cca5f066de9275031b45703b35917ddf936ff9b7fcb319cf7dbecd43a2e7268830b9addb4a9651b4ae21df7e46610453e838273098
-  data.tar.gz: 8f41184cd1f381bcf8e81561715ee048f113641235d0d5c6195bf2e4706bc181480a3ebdfd8ed44682fdbdd06b8647c0a2df0c6caa2e2f7a57ceb3370856d88c
+  metadata.gz: c6bdaa8da1d04d5daf0b3b72139c485828959191df63296cd6384883b689e7f267caf9489aea9e8df1294324f9937eed5f4549b3a9deb4e60eb558e836c95133
+  data.tar.gz: 681810981b4120fbf3679ff93c5f5dfa12e0ffbf445ea20ba3f751ff2299a0bb49ad418a8270f6c8340040a43bde22b5c4ca6dbbf6de9790c2e6b2f152daaa14

data/Gemfile

@@ -1,29 +1,3 @@
 source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
-gem 'coveralls'
-gem 'dotenv'
-gem 'faraday', '~> 0.9.0'
-gem 'faraday_middleware'
-gem 'faraday_middleware-oauth2_refresh'
-gem 'jsondoc'
-gem 'logger'
-gem 'mime'
-gem 'mime-types'
-gem 'mime_builder'
-gem 'mocha'
-gem 'multi_json'
-gem 'oauth2'
-gem 'pubnub', '~> 3.8.0'
-gem 'rake'
-gem 'simplecov'
-gem 'test-unit'
-gem 'timers'
-
-# Ruby 1.8.7 is not currently supported
-# platforms :ruby_18 do
-#  gem 'mime-types', '~> 1.25'
-#  gem 'rest-client', '~> 1.6.0'
-#  # gem 'mime-types', '~> 2.5'
-# end
-
-# vim:ft=ruby
+gemspec

data/Gemfile.lock

@@ -1,3 +1,21 @@
+PATH
+  remote: .
+  specs:
+    ringcentral_sdk (1.2.3)
+      dotenv (~> 2.1, >= 2.1.0)
+      faraday (~> 0.9, >= 0.9)
+      faraday_middleware (~> 0, >= 0)
+      faraday_middleware-oauth2_refresh (~> 0)
+      jsondoc (~> 0.1, >= 0.1.0)
+      logger
+      mime (~> 0.4, >= 0.4.3)
+      mime-types (~> 3.1)
+      mime_builder (~> 0)
+      multi_json (~> 1.3)
+      oauth2 (~> 1.0, >= 1.0.0)
+      pubnub (~> 4.0, >= 4.0.0)
+      timers (~> 4.1)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -16,91 +34,110 @@ GEM
       timers (>= 4.1.1)
     celluloid-pool (0.20.5)
       timers (>= 4.1.1)
-    celluloid-supervision (0.20.5)
+    celluloid-supervision (0.20.6)
       timers (>= 4.1.1)
-    coveralls (0.8.13)
-      json (~> 1.8)
-      simplecov (~> 0.11.0)
+    concurrent-ruby (1.0.2)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
+      tins (>= 1.6.0, < 2)
     docile (1.1.5)
-    dotenv (2.1.0)
+    dotenv (2.1.1)
+    dry-configurable (0.1.7)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-equalizer (0.2.0)
+    dry-logic (0.3.0)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-equalizer (~> 0.2)
+    dry-monads (0.1.0)
+      dry-equalizer
+    dry-types (0.8.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.3, >= 0.3.0)
+      dry-monads (>= 0.0.1)
+      ice_nine (~> 0.11)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.9.5)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-container (~> 0.2, >= 0.2.8)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.3, >= 0.3.0)
+      dry-types (~> 0.8, >= 0.8.1)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
-    faraday_middleware-oauth2_refresh (0.0.2)
+    faraday_middleware-oauth2_refresh (0.0.3)
       faraday (~> 0.9, >= 0.9)
       faraday_middleware (~> 0, >= 0)
-    hitimes (1.2.3)
-    httpclient (2.7.1)
+    hitimes (1.2.4)
+    httpclient (2.8.2.2)
+    ice_nine (0.11.2)
+    inflecto (0.0.2)
     json (1.8.3)
     jsondoc (0.1.2)
-    jwt (1.5.1)
+    jwt (1.5.4)
     logger (1.2.8)
     metaclass (0.0.4)
     mime (0.4.3)
-    mime-types (3.0)
+    mime-types (3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0221)
-    mime_builder (0.0.2)
+    mime-types-data (3.2016.0521)
+    mime_builder (0.0.3)
       mime
       mime-types (>= 1.25)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.11.2)
+    multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    oauth2 (1.1.0)
+    oauth2 (1.2.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0, < 1.5.2)
+      jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    power_assert (0.2.7)
-    pubnub (3.8.0)
-      celluloid (~> 0.16)
-      httpclient (~> 2.6)
+    power_assert (0.3.0)
+    pubnub (4.0.7)
+      celluloid (~> 0.17)
+      dry-validation (~> 0.8)
+      httpclient (~> 2.8)
       json (~> 1.8)
-    rack (1.6.4)
-    rake (11.1.1)
-    simplecov (0.11.2)
+    rack (2.0.1)
+    rake (11.2.2)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
-    test-unit (3.1.8)
+    test-unit (3.2.1)
       power_assert
     thor (0.19.1)
     timers (4.1.1)
       hitimes
-    tins (1.6.0)
+    tins (1.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   coveralls
-  dotenv
-  faraday (~> 0.9.0)
-  faraday_middleware
-  faraday_middleware-oauth2_refresh
-  jsondoc
-  logger
-  mime
-  mime-types
-  mime_builder
   mocha
-  multi_json
-  oauth2
-  pubnub (~> 3.8.0)
   rake
+  ringcentral_sdk!
   simplecov
   test-unit
-  timers
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -116,7 +116,7 @@ client = RingCentralSdk::REST::Client.new(
   'myAppKey',
   'myAppSecret',
   RingCentralSdk::RC_SERVER_SANDBOX,
-  {redirect_uri: 'http://example.com/oauth'}
+  redirect_uri: 'http://example.com/oauth'
 )
 
 # Retrieve OAuth authorize url using default redirect URL
@@ -232,17 +232,7 @@ sub.destroy()
 
 ## Supported Ruby Versions
 
-This library supports and is [tested against](https://travis-ci.org/grokify/ringcentral-sdk-ruby) the following Ruby implementations:
-
-1. Ruby 2.3.0
-2. Ruby 2.2.0
-3. Ruby 2.1.0
-4. Ruby 2.0.0
-5. Ruby 1.9.3
-6. [JRuby](http://jruby.org/)
-7. [Rubinius](http://rubinius.com/)
-
-Note: Ruby 1.8.7 works except for subscription support which relies on the `pubnub` gem. If there is a need for 1.8.7 support, consider creating a GitHub issue so we can evalute creating a separate library for subscription handling.
+This library is tested against [this list of Ruby implementations](https://travis-ci.org/grokify/ringcentral-sdk-ruby).
 
 ## Releases
 

data/lib/ringcentral_sdk.rb

@@ -1,5 +1,5 @@
 module RingCentralSdk
-  VERSION = '1.2.3'
+  VERSION = '1.3.0'
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
   RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'

data/lib/ringcentral_sdk/rest/client.rb

@@ -4,6 +4,8 @@ require 'faraday_middleware'
 require 'faraday_middleware/oauth2_refresh'
 require 'oauth2'
 
+require 'pp'
+
 module RingCentralSdk::REST
   class Client
     ACCESS_TOKEN_TTL  = 600             # 10 minutes
@@ -21,7 +23,6 @@ module RingCentralSdk::REST
     attr_reader :app_config
     attr_reader :http
     attr_reader :oauth2client
-    attr_reader :token
     attr_reader :user_agent
     attr_reader :messages
 
@@ -48,7 +49,6 @@ module RingCentralSdk::REST
     end
 
     def init_attributes()
-      @token = nil
       @http = nil
       @user_agent = get_user_agent()
     end
@@ -101,8 +101,8 @@ module RingCentralSdk::REST
       @oauth2client.auth_code.authorize_url(_add_redirect_uri(opts))
     end
 
-    def authorize_code(code, opts = {})
-      token = @oauth2client.auth_code.get_token(code, _add_redirect_uri(opts))
+    def authorize_code(code, params = {})
+      token = @oauth2client.auth_code.get_token(code, _add_redirect_uri(params))
       set_token(token)
       return token
     end
@@ -114,16 +114,20 @@ module RingCentralSdk::REST
       return opts
     end
 
-    def authorize_password(username, extension = '', password = '', remember = false)
+    def authorize_password(username, extension = '', password = '', params = {})
       token = @oauth2client.password.get_token(username, password, {
         extension: extension,
-        headers: {'Authorization' => 'Basic ' + get_api_key()}})
+        headers: {'Authorization' => 'Basic ' + get_api_key()}}.merge(params))
       set_token(token)
       return token
     end
 
-    def authorize_user(user, remember = false)
-      authorize_password(user.username, user.extension, user.password)
+    def authorize_user(user, params = {})
+      authorize_password(user.username, user.extension, user.password, params)
+    end
+
+    def token
+      return @http ? @http.builder.app.oauth2_token : nil
     end
 
     def set_token(token)
@@ -135,10 +139,8 @@ module RingCentralSdk::REST
         raise "Token is not a OAuth2::AccessToken"
       end
 
-      @token = token
-
       @http = Faraday.new(url: api_version_url()) do |conn|
-        conn.request :oauth2_refresh, @token
+        conn.request :oauth2_refresh, token
         conn.request :multipart
         conn.request :url_encoded
         conn.request :json

data/mkdocs.yml

@@ -0,0 +1,35 @@
+site_name: RingCentral SDK for Ruby
+site_url: https://github.com/grokify/ringcentral-sdk-ruby
+repo_url: https://github.com/grokify/ringcentral-sdk-ruby.git
+docs_dir: docs
+theme: readthedocs
+pages:
+# Introduction:
+- ['index.md', 'About', 'RingCentral SDK']
+- ['quickstart.md', 'About', 'Quickstart']
+
+## Authorization:
+- ['usage/authorization/Authorization.md', 'Authorization', 'Authorization']
+
+## Generic HTTP
+- ['usage/http-client.md', 'Generic Requests', 'HTTP Client']
+
+## Messaging:
+- ['usage/messages/SMS-Messages.md', 'Messaging', 'SMS Messages']
+- ['usage/messages/Fax-Messages.md', 'Messaging', 'Fax Messages']
+
+## Voice:
+- ['usage/voice/Click-To-Call.md', 'Voice', 'Click-To-Call']
+- ['usage/messages/Call-Recordings.md', 'Voice', 'Call Recordings']
+
+## Answering Rules:
+- ['usage/answering-rules/Answering-Rules-Call-Forwarding.md', 'Answering Rules', 'Call Forwarding']
+
+## Call Queues:
+- ['usage/callqueues/Adding-Removing-Users.md', 'Call Queues', 'Adding and Removing Users']
+- ['usage/callqueues/Member-Status.md', 'Call Queues', 'Member Status']
+
+## Notifications:
+- ['usage/notifications/Subscriptions.md', 'Notifications', 'Subscriptions']
+- ['usage/notifications/Subscribe_to_All_Extensions.md', 'Notifications', 'Subscribe to All Extensions']
+- ['usage/notifications/Subscribe_for_New_SMS.md', 'Notifications', 'Subscribe for New SMS']

data/ringcentral_sdk.gemspec

@@ -0,0 +1,40 @@
+lib = 'ringcentral_sdk'
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+#require File.expand_path('../lib/ringcentral_sdk/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ringcentral_sdk'
+  s.version     = version
+  s.date        = '2016-08-23'
+  s.summary     = 'RingCentral SDK - Ruby SDK for the RingCentral Connect Platform API'
+  s.description = 'A Ruby SDK for the RingCentral Connect Platform API'
+  s.authors     = ['John Wang']
+  s.email       = 'johncwang@gmail.com'
+  s.homepage    = 'https://github.com/grokify/'
+  s.licenses    = ['MIT']
+  s.files       = Dir['lib/**/**/*']
+  s.files      += Dir['[A-Z]*'] + Dir['test/**/*']
+  # s.files.reject! { |fn| fn.include? "CVS" }
+  # s.required_ruby_version = '>= 1.8.7' # 1.8.7+ is tested
+  s.add_dependency 'dotenv', '~> 2.1', '>= 2.1.0'
+  s.add_dependency 'faraday', '~> 0.9', '>= 0.9'
+  s.add_dependency 'faraday_middleware', '~> 0', '>= 0'
+  s.add_dependency 'faraday_middleware-oauth2_refresh', '~> 0'
+  s.add_dependency 'jsondoc', '~> 0.1', '>= 0.1.0'
+  s.add_dependency 'logger'
+  s.add_dependency 'mime', '~> 0.4', '>= 0.4.3'
+  s.add_dependency 'mime-types', '~> 3.1' # >= 1.9 '~> 2.5', '>= 2.5'
+  s.add_dependency 'mime_builder', '~> 0'
+  s.add_dependency 'multi_json', '~> 1.3'
+  s.add_dependency 'oauth2', '~> 1.0', '>= 1.0.0'
+  s.add_dependency 'pubnub', '~> 4.0', '>= 4.0.0'
+  s.add_dependency 'timers', '~> 4.1'
+
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'test-unit'
+end

data/test/test_base.rb

@@ -5,7 +5,7 @@ require 'test/unit'
 require 'mocha/test_unit'
 require 'ringcentral_sdk'
 
-client = RingCentralSdk.new(
+ RingCentralSdk.new(
   'my_app_key',
   'my_app_secret',
   RingCentralSdk::RC_SERVER_SANDBOX

data/test/test_client.rb

@@ -40,8 +40,8 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     oauth2client = OAuth2::Client.new(
       'my_app_key',
       'my_app_secret',
-      :site      => RingCentralSdk::RC_SERVER_SANDBOX,
-      :token_url => rcsdk.class::TOKEN_ENDPOINT)
+      site: RingCentralSdk::RC_SERVER_SANDBOX,
+      token_url: rcsdk.class::TOKEN_ENDPOINT)
     rcsdk.set_oauth2_client(oauth2client)
     assert_equal true, rcsdk.oauth2client.is_a?(OAuth2::Client) 
 
@@ -51,11 +51,13 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
   end
 
   def test_set_token
-    token_data = {:access_token => 'test_token'}
+    token_data = {access_token: 'test_token'}
 
     @rcsdk.set_token(token_data)
 
-    assert_equal 'OAuth2::AccessToken', @rcsdk.token.class.name
+    token = @rcsdk.token
+
+    assert_equal 'OAuth2::AccessToken', token.class.name
     assert_equal 'Faraday::Connection', @rcsdk.http.class.name
 
     assert_raise do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -104,6 +104,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
@@ -130,14 +144,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: mime_builder
   requirement: !ruby/object:Gem::Requirement
@@ -192,20 +206,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !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: mocha
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby SDK for the RingCentral Connect Platform API
 email: johncwang@gmail.com
 executables: []
@@ -251,6 +335,8 @@ files:
 - lib/ringcentral_sdk/rest/request/simple.rb
 - lib/ringcentral_sdk/rest/simple_client.rb
 - lib/ringcentral_sdk/rest/subscription.rb
+- mkdocs.yml
+- ringcentral_sdk.gemspec
 - test/test_base.rb
 - test/test_client.rb
 - test/test_config.rb
@@ -281,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: RingCentral SDK - Ruby SDK for the RingCentral Connect Platform API