ringcentral_sdk 1.3.4 → 2.0.0

data/lib/ringcentral_sdk/rest/messages_retriever.rb

@@ -1,45 +1,42 @@
 require 'date'
 require 'jsondoc'
 
-module RingCentralSdk::REST
-  class MessagesRetriever
-    attr_accessor :range
-    def initialize(client)
-      @client = client
-      @range = 1.0 # minutes
-    end
-
-    def retrieve_for_event(event, params={})
-      unless event.is_a? RingCentralSdk::REST::Event
-        fail 'retrieve_for_event requires RingCentralSdk::REST::Event argument'
+module RingCentralSdk
+  module REST
+    # MessagesRetrieve is a class that will retrieve matching records for an event
+    class MessagesRetriever
+      attr_accessor :range
+      def initialize(client)
+        @client = client
+        @range = 1.0 # minutes
       end
-      url = event.doc.getAttr :event
-      last_updated_s = event.doc.getAttr('body.lastUpdated')
-      last_updated_dt = DateTime.iso8601(last_updated_s)
 
-      params.merge!(
-        dateFrom: (last_updated_dt - (@range/1440.0)).to_s,
-        dateTo: (last_updated_dt + (@range/1440.0)).to_s)
-      
-      if event.new_sms_count > 0
-        params[:messageType] = 'SMS'
-      end
+      def retrieve_for_event(event, params = {})
+        unless event.is_a? RingCentralSdk::REST::Event
+          raise ArgumentError, 'retrieve_for_event requires RingCentralSdk::REST::Event argument'
+        end
+        url = event.doc.getAttr :event
+        last_updated_s = event.doc.getAttr('body.lastUpdated')
+        last_updated_dt = DateTime.iso8601(last_updated_s)
 
-      res = @client.http.get do |req|
-        req.url url
-        req.params = params
-      end
+        params[:dateFrom] = (last_updated_dt - (@range / 1440.0)).to_s
+        params[:dateTo] = (last_updated_dt + (@range / 1440.0)).to_s
+        params[:messageType] = 'SMS' if event.new_sms_count > 0
+
+        res = @client.http.get do |req|
+          req.url url
+          req.params = params
+        end
 
-      messages = []
+        messages = []
 
-      res.body['records'].each do |rec|
-        rec_last_modified_time = rec['lastModifiedTime']
-        rec_last_modified_time_dt = DateTime.iso8601(rec_last_modified_time)
-        if rec_last_modified_time_dt == last_updated_dt
-          messages.push rec
+        res.body['records'].each do |rec|
+          rec_last_modified_time = rec['lastModifiedTime']
+          rec_last_modified_time_dt = DateTime.iso8601(rec_last_modified_time)
+          messages.push(rec) if rec_last_modified_time_dt == last_updated_dt
         end
+        messages
       end
-      return messages
-   end
+    end
   end
 end

data/lib/ringcentral_sdk/rest/request.rb

@@ -1,6 +1,11 @@
-module RingCentralSdk::REST::Request
-  autoload :Base, 'ringcentral_sdk/rest/request/base'
-  autoload :Fax, 'ringcentral_sdk/rest/request/fax'
-  autoload :Inflator, 'ringcentral_sdk/rest/request/inflator'
-  autoload :Simple, 'ringcentral_sdk/rest/request/simple'
+module RingCentralSdk
+  module REST
+    # Request is the module namespace for various API request helpers.
+    module Request
+      autoload :Base, 'ringcentral_sdk/rest/request/base'
+      autoload :Fax, 'ringcentral_sdk/rest/request/fax'
+      autoload :Inflator, 'ringcentral_sdk/rest/request/inflator'
+      autoload :Simple, 'ringcentral_sdk/rest/request/simple'
+    end
+  end
 end

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

@@ -1,27 +1,32 @@
-module RingCentralSdk::REST::Request
-  class Base
-    def method
-      return 'get' # HTTP methods
-    end
+module RingCentralSdk
+  module REST
+    module Request
+      # Base class for various types of requests.
+      class Base
+        def method
+          'get' # HTTP methods
+        end
 
-    def url
-      return ''
-    end
+        def url
+          ''
+        end
 
-    def params
-      return {}
-    end
+        def params
+          {}
+        end
 
-    def headers
-      return {}
-    end
+        def headers
+          {}
+        end
 
-    def content_type
-      return ''
-    end
+        def content_type
+          ''
+        end
 
-    def body
-      return '' # '' || Hash
+        def body
+          '' # '' || Hash
+        end
+      end
     end
   end
 end

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

@@ -4,112 +4,109 @@ require 'mime/types'
 require 'mime_builder'
 require 'multi_json'
 
-module RingCentralSdk::REST::Request
-  class Fax < RingCentralSdk::REST::Request::Base
-    attr_reader :msg
-
-    attr_reader :account_id
-    attr_reader :extension_id
-
-    def initialize(opts={})
-      @metadata_part_encode_base64 = true
-
-      @msg = MIME::Multipart::Mixed.new
-      @msg.headers.delete('Content-Id')
-
-      add_path(opts)
-      add_part_meta(opts)
-      add_part_text(opts[:text])
-      add_parts(opts[:files])
-      add_parts(opts[:parts])
-    end
+module RingCentralSdk
+  module REST
+    module Request
+      # Helper to create a fax request
+      class Fax < RingCentralSdk::REST::Request::Base
+        attr_reader :msg
+
+        attr_reader :account_id
+        attr_reader :extension_id
+
+        def initialize(opts = {})
+          @metadata_part_encode_base64 = true
+
+          @msg = MIME::Multipart::Mixed.new
+          @msg.headers.delete('Content-Id')
+
+          add_path(opts)
+          add_part_meta(opts)
+          add_part_text(opts[:text])
+          add_parts(opts[:files])
+          add_parts(opts[:parts])
+        end
 
-    def add_path(opts={})
-      @account_id = opts[:accountId] ||= '~'
-      @extension_id = opts[:extensionId] ||= '~'
-    end
+        def add_path(opts = {})
+          @account_id = opts[:accountId] ||= '~'
+          @extension_id = opts[:extensionId] ||= '~'
+        end
 
-    def add_part_meta(opts={})
-      meta = create_metadata opts
-      json = MultiJson.encode meta
-      json = Base64.encode64(json) if @metadata_part_encode_base64
-      json_part = MIME::Text.new(json)
-      json_part.headers.delete('Content-Id')
-      json_part.headers.set('Content-Type', 'application/json')
-      json_part.headers.set('Content-Transfer-Encoding', 'base64') if @metadata_part_encode_base64
-      @msg.add(json_part)
-      true
-    end
+        def add_part_meta(opts = {})
+          meta = create_metadata opts
+          @msg.add MIMEBuilder::JSON.new(meta).mime
+          true
+        end
 
-    def create_metadata(opts={})
-      meta = {}
-      return meta unless opts.is_a?(Hash)
+        def create_metadata(opts = {})
+          meta = {}
+          return meta unless opts.is_a?(Hash)
 
-      inf = RingCentralSdk::REST::Request::Inflator::ContactInfo.new
-      meta[:to] = inf.inflate_to_array opts[:to]
+          inf = RingCentralSdk::REST::Request::Inflator::ContactInfo.new
+          meta[:to] = inf.inflate_to_array opts[:to]
 
-      processed = {
-        accountId: 1,
-        extensionId: 1,
-        to: 1,
-        text: 1,
-        files: 1,
-        parts: 1
-      }
+          processed = {
+            accountId: 1,
+            extensionId: 1,
+            to: 1,
+            text: 1,
+            files: 1,
+            parts: 1
+          }
 
-      opts.each do |k,v|
-        meta[k] = v unless processed.key? k
-      end
+          opts.each do |k, v|
+            meta[k] = v unless processed.key? k
+          end
 
-      meta
-    end
+          meta
+        end
 
-    def add_part_text(text=nil, opts={})
-      return unless !text.nil? && text.to_s.length>0
-      opts[:content_id_disable] = true
-      text_part = MIMEBuilder::Text.new(text, opts)
-      @msg.add text_part.mime
-    end
+        def add_part_text(text = nil, opts = {})
+          return if text.nil? || text.to_s.empty?
+          opts[:content_id_disable] = true
+          text_part = MIMEBuilder::Text.new text, opts
+          @msg.add text_part.mime
+        end
 
-    def add_parts(parts=[])
-      return if parts.nil?
-      unless parts.is_a? Array
-        raise 'invalid parameter[0]. needs to be an array'
-      end
-      parts.each do |part|
-        if part.is_a? MIME::Media
-          @msg.add part
-        elsif part.is_a?(String)
-          file_part = MIMEBuilder::Filepath.new(part)
-          @msg.add file_part.mime
-        elsif part.is_a? Hash
-          part[:content_id_disable] = true
-          part[:is_attachment] = true
-          if part.key? :filename
-            file_part = MIMEBuilder::Filepath.new(part[:filename], part)
-            @msg.add file_part.mime
-          elsif part.key? :text
-            text_part = MIMEBuilder::Text.new(part[:text], part)
-            @msg.add text_part.mime
+        def add_parts(parts = [])
+          return if parts.nil?
+          unless parts.is_a? Array
+            raise 'invalid parameter[0]. needs to be an array'
+          end
+          parts.each do |part|
+            if part.is_a? MIME::Media
+              @msg.add part
+            elsif part.is_a?(String)
+              file_part = MIMEBuilder::Filepath.new part
+              @msg.add file_part.mime
+            elsif part.is_a? Hash
+              part[:content_id_disable] = true
+              part[:is_attachment] = true
+              if part.key? :filename
+                @msg.add MIMEBuilder::Filepath.new(part[:filename], part).mime
+              elsif part.key? :text
+                @msg.add MIMEBuilder::Text.new(part[:text], part).mime
+              end
+            end
           end
         end
-      end
-    end
 
-    def method()
-      'post'
-    end
+        def method
+          'post'
+        end
 
-    def url()
-      "account/#{@account_id.to_s}/extension/#{@extension_id.to_s}/fax"
-    end
+        def url
+          "account/#{@account_id}/extension/#{@extension_id}/fax"
+        end
 
-    def content_type()
-      @msg.headers.get('Content-Type').to_s
-    end
+        def content_type
+          @msg.headers.get('Content-Type').to_s
+        end
 
-    def body()
-      @msg.body.to_s
+        def body
+          @msg.body.to_s
+        end
+      end
     end
   end
 end

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

@@ -1,3 +1,10 @@
-module RingCentralSdk::REST::Request::Inflator
-  autoload :ContactInfo, 'ringcentral_sdk/rest/request/inflator/contact_info'
+module RingCentralSdk
+  module REST
+    module Request
+      # Inflator is the namespace for inflator classes such as ContactInfo
+      module Inflator
+        autoload :ContactInfo, 'ringcentral_sdk/rest/request/inflator/contact_info'
+      end
+    end
+  end
 end

data/lib/ringcentral_sdk/rest/request/inflator/contact_info.rb

@@ -1,15 +1,22 @@
-module RingCentralSdk::REST::Request::Inflator
-  class ContactInfo
-    def inflate_to_array(any=nil)
-      contacts   = []
-      if any.is_a?(Array)
-        contacts = any
-      elsif any.is_a?(Hash)
-        contacts = [any]
-      elsif any.is_a?(String) || any.is_a?(Integer)
-        contacts = [{:phoneNumber=>any}]
+module RingCentralSdk
+  module REST
+    module Request
+      module Inflator
+        # ContactInfo class will inflate contact info to array
+        class ContactInfo
+          def inflate_to_array(any = nil)
+            contacts = []
+            if any.is_a?(Array)
+              contacts = any
+            elsif any.is_a?(Hash)
+              contacts = [any]
+            elsif any.is_a?(String) || any.is_a?(Integer)
+              contacts = [{ phoneNumber: any }]
+            end
+            contacts
+          end
+        end
       end
-      return contacts
     end
   end
-end
+end

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

@@ -1,39 +1,29 @@
-module RingCentralSdk::REST::Request
-  class Simple < RingCentralSdk::REST::Request::Base
-    def initialize(opts = {})
-      @method = opts[:method]
-      @url = opts[:url]
-      @params = opts[:params]
-      @headers = opts[:headers]
-      @body = opts[:body].nil? ? {} : opts[:body]
-      if @body.is_a? Hash 
-        @headers = {} unless @headers.is_a? Hash 
-        @headers['Content-Type'] = 'application/json'
-      end
-
-      def content_type
-        ct = @headers.is_a?(Hash) \
-          ? @headers['Content-Type'] || '' : 'application/json'
-      end
-
-      def method
-        @method
-      end
+module RingCentralSdk
+  module REST
+    module Request
+      # Simple is a generic simple request class.
+      class Simple < RingCentralSdk::REST::Request::Base
+        attr_reader :method
+        attr_reader :url
+        attr_reader :params
+        attr_reader :headers
+        attr_reader :body
 
-      def url
-        @url
-      end
-
-      def params
-        @params
-      end
-
-      def headers
-        @headers
-      end
+        def initialize(opts = {})
+          @method = opts[:method]
+          @url = opts[:url]
+          @params = opts[:params]
+          @headers = opts[:headers]
+          @body = opts[:body].nil? ? {} : opts[:body]
+          if @body.is_a? Hash
+            @headers = {} unless @headers.is_a? Hash
+            @headers['Content-Type'] = 'application/json'
+          end
+        end
 
-      def body
-        @body
+        def content_type
+          @headers.is_a?(Hash) ? @headers['Content-Type'] || '' : 'application/json'
+        end
       end
     end
   end