ringcentral_sdk 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b4759611557577079618f5bbc1064364479457195d8ff6f467fd08531132517
-  data.tar.gz: 0d5f363462e4e4915d8a878ed9aa6f423e54f5186d5c586db79f4e11b70478bb
+  metadata.gz: 0d7d7bec3a2a5167683da179b619dabe76b73e9feeba8d1c4d141a3135f7f221
+  data.tar.gz: 1655a60eaba12760f98425e2a1bd6a5e9f7b88af83425b9043601f7c751d4fa7
 SHA512:
-  metadata.gz: 8c2e06de3986a6dc7d86331834521cfa536b23379f66235bd5ea52d0fad06244ade05ff75e4d0597117204dea9f488018d76b9c01f0a9eab5707729aed0c0bff
-  data.tar.gz: ad0f95ee35ad69875a10718dc7f3a1eaca8e4d57ffc3a5cfcd4139df640a3bf5943c64de7565351fb3ac23a7c9e9b037600d57b71c510471a5d62bfebd1029d3
+  metadata.gz: cde3465645b5c8d2d0f6e2e803263b8e2af39706fc839c357c17cc296cb15bdfb2b049350b754ac8707c152906019f9cb82a7d51ac6338a7505ed634d1c629d3
+  data.tar.gz: 759da592165de535c34a117540826b0baddbd849b45f06f04066604264c0021d079e849601d56a050e9b1ead5bfa9be941c75f4f55897ca0003881fdfe847460

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ringcentral_sdk (2.2.2)
+    ringcentral_sdk (3.1.0)
       dotenv (~> 2.1, >= 2.8.1)
       faraday (~> 1.10, >= 1.10.3)
       faraday_middleware (~> 1.2, >= 1.2.0)
@@ -14,7 +14,7 @@ PATH
       mime_builder (~> 0.1, >= 0.1.1)
       multi_json (~> 1.3)
       oauth2 (~> 2.0, >= 2.0.9)
-      pubnub (~> 5.0, >= 5.2.1)
+      pubnub (~> 4.0, >= 4.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -123,7 +123,7 @@ GEM
       version_gem (~> 1.1)
     power_assert (2.0.3)
     public_suffix (5.0.1)
-    pubnub (5.2.1)
+    pubnub (4.8.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
@@ -136,6 +136,7 @@ GEM
     rest-client (1.6.7)
       mime-types (>= 1.16)
     ruby2_keywords (0.0.5)
+    rubycop (1.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -164,6 +165,7 @@ DEPENDENCIES
   mocha (~> 2)
   rake (~> 13)
   ringcentral_sdk!
+  rubycop (~> 1.0, >= 1.0.1)
   simplecov (~> 0)
   test-unit (~> 3)
 

data/{LICENSE.md → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2023 John Wang
+Copyright (c) 2015-2024 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -37,14 +37,6 @@ RingCentral SDK for Ruby
 
 A Ruby SDK for the [RingCentral REST API](https://developers.ringcentral.com).
 
-## Important Notes
-
-Version 2.0.0 introduces the following backward breaking changes:
-
-* SDK instantiation by moving to a block-based configuration
-* Removal of `RingCentralSdk::REST::Config` class
-* Removal of `RingCentralSdk::REST::Client.authorize_user` method
-
 ## Documentation
 
 Full documentation and resources are available at:
@@ -84,14 +76,12 @@ require 'ringcentral_sdk'
 
 client = RingCentralSdk::REST::Client.new do |config|
   # App info (mandatory)
-  config.app_key = 'myAppKey'
-  config.app_secret = 'myAppSecret'
+  config.client_id = 'myAppClientID'
+  config.client_secret = 'myAppClientSecret'
   config.server_url = RingCentralSdk::RC_SERVER_SANDBOX
 
-  # User info for password grant (optional)
-  config.username = 'myUsername'
-  config.extension = 'myExtension'
-  config.password = 'myPassword'
+  # JWT Bearer Grant (optional)
+  config.jwt = 'myJwt'
 
   # Set a custom logger (optional)
   config.logger = Logger.new(STDOUT)
@@ -197,6 +187,12 @@ sub.subscribe ['/restapi/v1.0/account/~/extension/~/presence']
 sub.destroy
 ```
 
+### Examples
+
+See examples in the [`scripts`](scripts) folder.
+
+A simple read only script is `account-extensions.rb` which can be used to validate your app configuration.
+
 ### Advanced Use Cases
 
 1. [Subscribing to All Extensions](http://ringcentral-sdk-ruby.readthedocs.org/en/latest/usage/notifications/Subscriptions-All-Extensions/)
@@ -245,18 +241,32 @@ RingCentral Official SDKs
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+### Development
+
+To build local development copy of the gem use:
+
+```
+% gem build ringcentral_sdk.gemspec
+```
+
+This will produce a file like: `ringcentral_sdk-3.1.0.gem` which you can install with:
+
+```
+% gem install ringcentral_sdk-3.1.0.gem
+```
+
 ## License
 
-RingCentral SDK is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
+RingCentral SDK is available under the MIT license. See [LICENSE](LICENSE) for details.
 
-RingCentral SDK © 2015-2023 by John Wang
+RingCentral SDK © 2015-2024 by John Wang
 
  [gem-version-svg]: https://badge.fury.io/rb/ringcentral_sdk.svg
  [gem-version-url]: http://badge.fury.io/rb/ringcentral_sdk
  [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/ringcentral_sdk
  [downloads-url]: https://rubygems.org/gems/ringcentral_sdk
- [build-status-svg]: https://api.travis-ci.org/grokify/ringcentral-sdk-ruby.svg?branch=master
- [build-status-url]: https://travis-ci.org/grokify/ringcentral-sdk-ruby
+ [build-status-svg]: https://github.com/grokify/ringcentral-sdk-ruby/workflows/test/badge.svg
+ [build-status-url]: https://github.com/grokify/ringcentral-sdk-ruby/actions/workflows/test.yaml
  [coverage-status-svg]: https://coveralls.io/repos/grokify/ringcentral-sdk-ruby/badge.svg?branch=master
  [coverage-status-url]: https://coveralls.io/r/grokify/ringcentral-sdk-ruby?branch=master
  [dependency-status-svg]: https://gemnasium.com/grokify/ringcentral-sdk-ruby.svg
@@ -274,7 +284,7 @@ RingCentral SDK © 2015-2023 by John Wang
  [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
  [docs-rubydoc-url]: http://www.rubydoc.info/gems/ringcentral_sdk/
  [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
- [license-url]: https://github.com/grokify/ringcentral-sdk-ruby/blob/master/LICENSE.md
+ [license-url]: https://github.com/grokify/ringcentral-sdk-ruby/blob/master/LICENSE
  [chat-svg]: https://img.shields.io/badge/chat-on%20glip-orange.svg
  [chat-url]: https://glipped.herokuapp.com/
  [stackoverflow-svg]: https://img.shields.io/badge/Stack%20Overflow-ringcentral-orange.svg

data/lib/ringcentral_sdk/rest/cache/extensions.rb

@@ -7,11 +7,8 @@ module RingCentralSdk
       # Extensions cache is a local store that can retrieve all
       # extensions for use locally
       class Extensions
-        attr_accessor :client
-        attr_accessor :account_id
-        attr_reader :extensions_hash
-        attr_reader :extensions_num2id
-        attr_reader :last_retrieved
+        attr_accessor :client, :account_id
+        attr_reader :extensions_hash, :extensions_num2id, :last_retrieved
 
         def initialize(client)
           @client = client

data/lib/ringcentral_sdk/rest/client.rb

@@ -23,12 +23,7 @@ module RingCentralSdk
       URL_PREFIX        = '/restapi'.freeze
       DEFAULT_LANGUAGE  = 'en-us'.freeze
 
-      attr_reader :config
-      attr_reader :http
-      attr_reader :logger
-      attr_reader :oauth2client
-      attr_reader :user_agent
-      attr_reader :messages
+      attr_reader :config, :http, :logger, :messages, :oauth2client, :user_agent
 
       def initialize
         init_attributes
@@ -40,9 +35,12 @@ module RingCentralSdk
 
         @oauth2client = new_oauth2_client
 
-        unless @config.username.to_s.empty?
-          authorize_password @config.username, @config.extension, @config.password
-        end
+        # Remove Password Grant
+        # unless @config.username.to_s.empty?
+        #  authorize_password @config.username, @config.extension, @config.password
+        # end
+
+        authorize_jwt(@config.jwt) unless @config.jwt.to_s.empty?
 
         @messages = RingCentralSdk::REST::Messages.new self
       end
@@ -109,11 +107,20 @@ module RingCentralSdk
         opts
       end
 
-      def authorize_password(username, extension = '', password = '', params = {})
-        token = @oauth2client.password.get_token(username, password, {
-          extension: extension,
-          headers: { 'Authorization' => 'Basic ' + api_key }
-        }.merge(params))
+      # def authorize_password(username, extension = '', password = '', params = {})
+      #  token = @oauth2client.password.get_token(username, password, {
+      #    extension: extension,
+      #    headers: { 'Authorization' => 'Basic ' + api_key }
+      #  }.merge(params))
+      #  set_token token
+      #  token
+      # end
+
+      def authorize_jwt(jwt)
+        token = @oauth2client.get_token({
+          grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+          assertion: jwt
+        })
         set_token token
         token
       end
@@ -238,8 +245,10 @@ module RingCentralSdk
         RingCentralSdk::REST::Subscription.new self
       end
 
-      alias authorize authorize_password
-      alias login authorize_password
+      # alias authorize authorize_password
+      # alias login authorize_password
+      alias authorize authorize_jwt
+      alias login authorize_jwt
       private :api_version_url
     end
   end

data/lib/ringcentral_sdk/rest/configuration.rb

@@ -9,22 +9,13 @@ module RingCentralSdk
   module REST
     # Configuration class populated by Client constructor block
     class Configuration
-      attr_accessor :server_url
-      attr_accessor :client_id
-      attr_accessor :client_secret
-      attr_accessor :redirect_url
-
-      attr_accessor :username
-      attr_accessor :extension
-      attr_accessor :password
-      attr_accessor :token
-      attr_accessor :token_file
-
-      attr_accessor :load_env
-      attr_accessor :headers
-      attr_accessor :retry
-      attr_accessor :retry_options
-      attr_accessor :logger
+      attr_accessor :server_url,
+                    :client_id, :client_secret,
+                    :redirect_url,
+                    :jwt, :token, :token_file,
+                    :load_env,
+                    :headers, :retry, :retry_options,
+                    :logger
 
       def inflate
         @logger = default_logger if !defined?(@logger) || @logger.nil?
@@ -47,9 +38,10 @@ module RingCentralSdk
         @client_id     = ENV['RINGCENTRAL_CLIENT_ID']     if ENV.key? 'RINGCENTRAL_CLIENT_ID'
         @client_secret = ENV['RINGCENTRAL_CLIENT_SECRET'] if ENV.key? 'RINGCENTRAL_CLIENT_SECRET'
         @redirect_url  = ENV['RINGCENTRAL_REDIRECT_URL']  if ENV.key? 'RINGCENTRAL_REDIRECT_URL'
-        @username      = ENV['RINGCENTRAL_USERNAME']      if ENV.key? 'RINGCENTRAL_USERNAME'
-        @extension     = ENV['RINGCENTRAL_EXTENSION']     if ENV.key? 'RINGCENTRAL_EXTENSION'
-        @password      = ENV['RINGCENTRAL_PASSWORD']      if ENV.key? 'RINGCENTRAL_PASSWORD'
+        # @username      = ENV['RINGCENTRAL_USERNAME']      if ENV.key? 'RINGCENTRAL_USERNAME'
+        # @extension     = ENV['RINGCENTRAL_EXTENSION']     if ENV.key? 'RINGCENTRAL_EXTENSION'
+        # @password      = ENV['RINGCENTRAL_PASSWORD']      if ENV.key? 'RINGCENTRAL_PASSWORD'
+        @jwt           = ENV['RINGCENTRAL_JWT']           if ENV.key? 'RINGCENTRAL_JWT'
         @token         = ENV['RINGCENTRAL_TOKEN']         if ENV.key? 'RINGCENTRAL_TOKEN'
         @token_file    = ENV['RINGCENTRAL_TOKEN_FILE']    if ENV.key? 'RINGCENTRAL_TOKEN_FILE'
         @retry         = ENV['RINGCENTRAL_RETRY']         if ENV.key? 'RINGCENTRAL_RETRY'

data/lib/ringcentral_sdk/rest/request/multipart.rb

@@ -15,12 +15,9 @@ module RingCentralSdk
         DEFAULT_BASE64_ENCODE = true
         DEFAULT_CONTENT_ID_DISABLE = true
 
-        attr_accessor :method
-        attr_accessor :mime_part_params
+        attr_accessor :method, :mime_part_params
 
-        attr_reader :mime
-        attr_reader :account_id
-        attr_reader :extension_id
+        attr_reader :mime, :account_id, :extension_id
 
         def initialize(opts = {})
           @mime = MIME::Multipart::Mixed.new

data/lib/ringcentral_sdk.rb

@@ -1,6 +1,6 @@
 # RingCentralSdk is a SDK for the RingCentral REST API
 module RingCentralSdk
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.1.0'.freeze
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'.freeze
   RC_SERVER_SANDBOX = 'https://platform.devtest.ringcentral.com'.freeze

data/pubnub.log

@@ -31,3 +31,27 @@ D, [2023-02-20T07:51:48.766805 #17761] DEBUG -- Pubnub::Telementry: Initialized
 D, [2023-02-20T07:51:48.766950 #17761] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
 D, [2023-02-20T07:51:48.768788 #17761] DEBUG -- Pubnub::Telementry: Initialized Telemetry
 D, [2023-02-20T07:51:48.768823 #17761] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2023-02-20T08:24:30.269889 #18664] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2023-02-20T08:24:30.270993 #18664] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2023-02-20T08:24:30.272699 #18664] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2023-02-20T08:24:30.272733 #18664] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:37:13.047148 #2246] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:37:13.047594 #2246] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:37:13.049664 #2246] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:37:13.049736 #2246] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:38:23.902584 #2281] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:38:23.902745 #2281] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:38:23.904805 #2281] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:38:23.904851 #2281] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:41:04.801211 #2358] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:41:04.801540 #2358] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:42:41.613689 #2402] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:42:41.613863 #2402] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:43:21.311789 #2422] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:43:21.311944 #2422] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:44:29.345106 #2454] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:44:29.345427 #2454] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:44:45.085141 #2465] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:44:45.085321 #2465] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0
+D, [2024-11-09T07:45:59.682038 #2502] DEBUG -- Pubnub::Telementry: Initialized Telemetry
+D, [2024-11-09T07:45:59.682423 #2502] DEBUG -- Pubnub::Client: Created new Pubnub::Client instance. Version: 4.8.0

data/ringcentral_sdk.gemspec

@@ -7,7 +7,7 @@ version = $1
 Gem::Specification.new do |s|
   s.name        = lib
   s.version     = version
-  s.date        = '2023-02-20'
+  s.date        = '2024-11-08'
   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']
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'coveralls', '~> 0'
   s.add_development_dependency 'mocha', '~> 2'
   s.add_development_dependency 'rake', '~> 13'
+  s.add_dependency 'rubocop', '~> 1.68'
   s.add_development_dependency 'simplecov', '~> 0'
   s.add_development_dependency 'test-unit', '~> 3'
 end

data/test/test_setup.rb

@@ -34,8 +34,7 @@ class RingCentralSdkTest < Test::Unit::TestCase
       config.client_id = 'my_app_client_id'
       config.client_secret = 'my_app_client_secret'
       config.server_url = RingCentralSdk::RC_SERVER_SANDBOX
-      config.username = 'my_username'
-      config.password = 'my_password'
+      config.jwt = 'my_jwt'
     end
 
     assert_equal 'my_test_access_token', rcsdk.token.to_hash[:access_token]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -308,6 +308,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.68'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.68'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -345,7 +359,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.md
+- LICENSE
 - README.md
 - Rakefile
 - lib/ringcentral_sdk.rb