ringcentral_sdk 1.3.4 → 2.0.0

data/lib/ringcentral_sdk/rest/configuration.rb

@@ -0,0 +1,91 @@
+require 'dotenv'
+require 'logger'
+require 'multi_json'
+
+module RingCentralSdk
+  module REST
+    # Configuration class populated by Client constructor block
+    class Configuration
+      attr_accessor :server_url
+      attr_accessor :app_key
+      attr_accessor :app_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
+
+      def inflate
+        @logger = default_logger if !defined?(@logger) || @logger.nil?
+        load_environment if load_env
+        inflate_headers
+        inflate_retry
+        inflate_token
+      end
+
+      def default_logger
+        logger = Logger.new STDOUT
+        logger.level = Logger::WARN
+        logger
+      end
+
+      def load_environment
+        Dotenv.load
+        @server_url = ENV['RC_SERVER_URL'] if ENV.key? 'RC_SERVER_URL'
+        @app_key = ENV['RC_APP_KEY'] if ENV.key? 'RC_APP_KEY'
+        @app_secret = ENV['RC_APP_SECRET'] if ENV.key? 'RC_APP_SECRET'
+        @redirect_url = ENV['RC_APP_REDIRECT_URL'] if ENV.key? 'RC_APP_REDIRECT_URL'
+        @username = ENV['RC_USER_USERNAME'] if ENV.key? 'RC_USER_USERNAME'
+        @extension = ENV['RC_USER_EXTENSION'] if ENV.key? 'RC_USER_EXTENSION'
+        @password = ENV['RC_USER_PASSWORD'] if ENV.key? 'RC_USER_PASSWORD'
+        @token = ENV['RC_TOKEN'] if ENV.key? 'RC_TOKEN'
+        @token_file = ENV['RC_TOKEN_FILE'] if ENV.key? 'RC_TOKEN_FILE'
+        @retry = ENV['RC_RETRY'] if ENV.key? 'RC_RETRY'
+        @retry_options = ENV['RC_RETRY_OPTIONS'] if ENV.key? 'RC_RETRY_OPTIONS'
+        @headers = ENV['RC_HEADERS'] if ENV.key? 'RC_HEADERS'
+      end
+
+      def inflate_retry
+        if !defined?(@retry) || @retry.nil? || @retry.empty? || @retry.to_s.downcase == 'false'
+          @retry = false
+          @retry_options = {}
+          return
+        end
+        @retry = true
+        if !@retry_options.nil? && @retry_options.to_s =~ /^\s*{/
+          @retry_options = MultiJson.decode @retry_options.to_s, symbolize_keys: true
+        else
+          @retry_options = {}
+        end
+        @retry_options[:logger] = @logger
+      end
+
+      def inflate_headers
+        @headers = {} unless defined? @headers
+        if !@headers.nil? && @headers.is_a?(String) && @headers =~ /^\s*{/
+          @headers = MultiJson.decode @headers, symbolize_keys: true
+        end
+      end
+
+      def inflate_token
+        @token = nil unless defined? @token
+
+        if (@token.nil? || @token.empty?) && !token_file.nil? && !@token_file.empty?
+          @token = IO.read @token_file if File.exist? @token_file
+        end
+
+        if !defined?(@token) && !@token.nil? && @token.is_a?(String) && @token =~ /^\s*{/
+          @token = MultiJson.decode @token
+        end
+      end
+    end
+  end
+end

data/lib/ringcentral_sdk/rest/event.rb

@@ -1,61 +1,62 @@
 require 'jsondoc'
 require 'multi_json'
 
-module RingCentralSdk::REST
-  class Event
-    attr_accessor :doc
-    def initialize(data = nil)
-      if data.is_a? JsonDoc::Document
-        @doc = data
-      elsif data.is_a? Hash
-        data = _symbolize_keys data
-        @doc = JsonDoc::Document.new(data, false, false, false)
-      elsif data.nil?
-        @doc = JsonDoc::Document.new({}, false, false, false)
-      else
-        raise 'initialize needs JsonDoc::Document or Hash argument'
+module RingCentralSdk
+  module REST
+    # Event represents a Subscription API event
+    class Event
+      attr_accessor :doc
+      def initialize(data = nil)
+        if data.is_a? JsonDoc::Document
+          @doc = data
+        elsif data.is_a? Hash
+          data = _symbolize_keys data
+          @doc = JsonDoc::Document.new(data, false, false, false)
+        elsif data.nil?
+          @doc = JsonDoc::Document.new({}, false, false, false)
+        else
+          raise 'initialize needs JsonDoc::Document or Hash argument'
+        end
       end
-    end
 
-    def _hash_has_string_keys(hash={})
-      hash.each do |k,v|
-        return true if k.is_a? String
+      def _hash_has_string_keys(hash = {})
+        hash.each do |k, _|
+          return true if k.is_a? String
+        end
+        false
       end
-      return false
-    end
 
-    def _symbolize_keys(hash={})
-      if _hash_has_string_keys hash
-        return MultiJson.decode(MultiJson.encode(hash), :symbolize_keys=>true)
+      def _symbolize_keys(hash = {})
+        if _hash_has_string_keys hash
+          return MultiJson.decode(MultiJson.encode(hash), symbolize_keys: true)
+        end
+        hash
       end
-      return hash
-    end
 
-    def new_fax_count
-      new_type_count('fax')
-    end
+      def new_fax_count
+        new_type_count('fax')
+      end
 
-    def new_sms_count
-      new_type_count('sms')
-    end
+      def new_sms_count
+        new_type_count('sms')
+      end
 
-    def new_type_count(type)
-      count = 0
-      have_type = false
-      changes = @doc.getAttr('body.changes')
-      if changes.is_a?(Array) && changes.length > 0
-        changes.each do |change|
-          if change.key?(:type) && change[:type].to_s.downcase == type
-            have_type = true
-            if change.key?(:newCount)
-              count += change[:newCount]
+      def new_type_count(type)
+        count = 0
+        have_type = false
+        changes = @doc.getAttr('body.changes')
+        if changes.is_a?(Array) && !changes.empty?
+          changes.each do |change|
+            if change.key?(:type) && change[:type].to_s.downcase == type
+              have_type = true
+              count += change[:newCount] if change.key? :newCount
             end
           end
         end
+        have_type ? count : -1
       end
-      return have_type ? count : -1
-    end
 
-    private :_hash_has_string_keys, :_symbolize_keys
+      private :_hash_has_string_keys, :_symbolize_keys
+    end
   end
 end

data/lib/ringcentral_sdk/rest/extension.rb

@@ -1,12 +1,15 @@
-module RingCentralSdk::REST
-  class Extension
-    attr_reader :extension_id
-    attr_reader :presence
-    attr_accessor :client
-    def initialize(extension_id, opts={})
-      @extension_id = extension_id
-      @client = opts.has_key?(:client) ? opts[:client] : nil
-      @presence = RingCentralSdk::REST::ExtensionPresence.new(extension_id, opts)
+module RingCentralSdk
+  module REST
+    # Extension represents a RingCentral user extension object
+    class Extension
+      attr_reader :extension_id
+      attr_reader :presence
+      attr_accessor :client
+      def initialize(extension_id, opts = {})
+        @extension_id = extension_id
+        @client = opts.key?(:client) ? opts[:client] : nil
+        @presence = RingCentralSdk::REST::ExtensionPresence.new(extension_id, opts)
+      end
     end
   end
 end

data/lib/ringcentral_sdk/rest/extension_presence.rb

@@ -1,104 +1,99 @@
-module RingCentralSdk::REST
-  class ExtensionPresence
-    attr_accessor :client
-    attr_accessor :account_id
-    attr_accessor :extension_id
-    attr_accessor :presence_data
-
-    def initialize(extension_id, opts={})
-      @client = opts.key?(:client) ? opts[:client] : nil
-      @account_id = '~'
-      @extension_id = extension_id.to_s
-      @presence_data = {}
-    end
-
-    def retrieve()
-      if @extension_id !~ /^[0-9]+$/
-        raise "extension_id is not an integer"
-      end
-
-      res = @client.http.get do |req|
-        req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
+module RingCentralSdk
+  module REST
+    # ExtensionPresence is a helper class to manage presence info
+    class ExtensionPresence
+      attr_accessor :client
+      attr_accessor :account_id
+      attr_accessor :extension_id
+      attr_accessor :presence_data
+
+      def initialize(extension_id, opts = {})
+        @client = opts.key?(:client) ? opts[:client] : nil
+        @account_id = '~'
+        @extension_id = extension_id.to_s
+        @presence_data = {}
       end
 
-      @presence_data = res.body
+      def retrieve
+        raise 'extension_id is not an integer' if @extension_id !~ /^[0-9]+$/
 
-      return @presence_data
-    end
+        res = @client.http.get do |req|
+          req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
+        end
 
-    def department_calls_enable(enable)
-      retrieve()
+        @presence_data = res.body
 
-      unless @presence.is_a?(Hash) && @presence_data.key?('dndStatus')
-        raise 'invalid presence info'
+        @presence_data
       end
 
-      current_status = @presence_data['dndStatus']
-      new_status = new_status_dnd_department_calls(current_status, enable)
+      def department_calls_enable(enable)
+        retrieve
 
-      if current_status != new_status
-        update({dndStatus: new_status})
-      end
+        unless @presence.is_a?(Hash) && @presence_data.key?('dndStatus')
+          raise 'invalid presence info'
+        end
 
-      return new_status
-    end
+        current_status = @presence_data['dndStatus']
+        new_status = new_status_dnd_department_calls(current_status, enable)
 
-    def department_calls_enabled?(reload=false)
-      if reload
-        retrieve()
-      elsif !@presence_data.key?('dndStatus')
-        retrieve()
+        update(dndStatus: new_status) if current_status != new_status
+        new_status
       end
 
-      current_status = @presence_data['dndStatus']
+      def department_calls_enabled?(reload = false)
+        if reload
+          retrieve
+        elsif !@presence_data.key?('dndStatus')
+          retrieve
+        end
 
-      status_enabled = {
-        'DoNotAcceptAnyCalls' => false,
-        'DoNotAcceptDepartmentCalls' => false,
-        'TakeAllCalls' => true,
-        'TakeDepartmentCallsOnly' => true
-      }
+        current_status = @presence_data['dndStatus']
 
-      return status_enabled.key?(current_status) ?
-        status_enabled[current_status] : nil
-    end
+        status_enabled = {
+          'DoNotAcceptAnyCalls' => false,
+          'DoNotAcceptDepartmentCalls' => false,
+          'TakeAllCalls' => true,
+          'TakeDepartmentCallsOnly' => true
+        }
 
-    def update(body=nil)
-      if body.nil?
-        raise 'HTTP request body is required to update presence'
+        status_enabled.key?(current_status) ? status_enabled[current_status] : nil
       end
 
-      res = @client.http.put do |req|
-        req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
-        req.headers['Content-Type'] = 'application/json'
-        req.body = body
-      end
-      
-      @presence_data = res.body
+      def update(body = nil)
+        raise 'HTTP request body is required to update presence' if body.nil?
 
-      return @presence_data
-    end
+        res = @client.http.put do |req|
+          req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
+          req.headers['Content-Type'] = 'application/json'
+          req.body = body
+        end
+
+        @presence_data = res.body
 
-    def new_status_dnd_department_calls(current_status, enable)
-      new_statuses = {
-        enable: {
-          'DoNotAcceptAnyCalls' => 'TakeDepartmentCallsOnly',
-          'DoNotAcceptDepartmentCalls' => 'TakeAllCalls'
-        },
-        disable: {
-          'TakeAllCalls' => 'DoNotAcceptDepartmentCalls',
-          'TakeDepartmentCallsOnly' => 'DoNotAcceptAnyCalls'
+        @presence_data
+      end
+
+      def new_status_dnd_department_calls(current_status, enable)
+        new_statuses = {
+          enable: {
+            'DoNotAcceptAnyCalls' => 'TakeDepartmentCallsOnly',
+            'DoNotAcceptDepartmentCalls' => 'TakeAllCalls'
+          },
+          disable: {
+            'TakeAllCalls' => 'DoNotAcceptDepartmentCalls',
+            'TakeDepartmentCallsOnly' => 'DoNotAcceptAnyCalls'
+          }
         }
-      }
 
-      action = enable ? :enable : :disable
+        action = enable ? :enable : :disable
 
-      new_status = current_status
+        new_status = current_status
 
-      new_status = new_statuses[action][current_status.to_s] \
-        if new_statuses[action].key?(current_status.to_s)
+        new_status = new_statuses[action][current_status.to_s] \
+          if new_statuses[action].key?(current_status.to_s)
 
-      return new_status
+        new_status
+      end
     end
   end
-end
+end

data/lib/ringcentral_sdk/rest/messages.rb

@@ -1,46 +1,55 @@
-module RingCentralSdk::REST
-  class Messages
-    attr_reader :sms
-    attr_reader :fax
+module RingCentralSdk
+  module REST
+    # Messages is a wrapper helper class
+    class Messages
+      attr_reader :sms
+      attr_reader :fax
 
-    def initialize(client)
-      @client = client
-      @sms = RingCentralSdk::REST::MessagesSMS.new(client)
-      @fax = RingCentralSdk::REST::MessagesFax.new(client)
+      def initialize(client)
+        @client = client
+        @sms = RingCentralSdk::REST::MessagesSMS.new(client)
+        @fax = RingCentralSdk::REST::MessagesFax.new(client)
+      end
     end
   end
 end
 
-module RingCentralSdk::REST
-  class MessagesSMS
-    def initialize(client)
-      @client = client
-    end
+module RingCentralSdk
+  module REST
+    # MessagesSMS provides a helper for SMS messages
+    class MessagesSMS
+      def initialize(client)
+        @client = client
+      end
 
-    def create(opts)
-      response = @client.http.post do |req|
-        req.url 'account/~/extension/~/sms'
-        req.headers['Content-Type'] = 'application/json'
-        req.body = {
-          from: { phoneNumber: opts[:from].to_s },
-          to: [ { phoneNumber: opts[:to].to_s } ],
-          text: opts[:text].to_s
-        }
+      def create(opts)
+        response = @client.http.post do |req|
+          req.url 'account/~/extension/~/sms'
+          req.headers['Content-Type'] = 'application/json'
+          req.body = {
+            from: { phoneNumber: opts[:from].to_s },
+            to: [{ phoneNumber: opts[:to].to_s }],
+            text: opts[:text].to_s
+          }
+        end
+        response
       end
-      return response
     end
   end
 end
 
-module RingCentralSdk::REST
-  class MessagesFax
-    def initialize(client)
-      @client = client
-    end
+module RingCentralSdk
+  module REST
+    # MessagesFax provides a helper for fax requests
+    class MessagesFax
+      def initialize(client)
+        @client = client
+      end
 
-    def create(opts)
-      fax = RingCentralSdk::REST::Request::Fax.new(opts)
-      return @client.send_request(fax)
+      def create(opts)
+        fax = RingCentralSdk::REST::Request::Fax.new opts
+        @client.send_request fax
+      end
     end
   end
 end