ringcentral_sdk 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f1dff65956dcafa9e3bd77501e187cf7c67e98
-  data.tar.gz: 8176d3c80e94ff445be20793393d48e6fae8d0f1
+  metadata.gz: 18dd0357491d7aae9396a5a45bfa4f789775747b
+  data.tar.gz: 5a0880db95194fa5a7b95c2e64c67f664ca13fae
 SHA512:
-  metadata.gz: 9e1742a2c45d5c7764a9623f435c674cce3b9f6a4140a2f7c9738a9b43c89ecbb55cdc74a330839ff6de139aca7d4a4db52acfe249e3ac21ef911b6574a44d03
-  data.tar.gz: f8eb9a7e19aeb738fec47dc18af2c5825fe701ff34b8aaf7690258efbd58398ed2f0fcf3604088c511468985f6e299dc27e3b2d4900486ed537a096906d2b206
+  metadata.gz: c4ef8a3fe7f1eacdf40c06e9970632699f74679a25e7325c83639086432e6475227427bc8aebe8d7e80982785e1ae77ff5dd4d87c71b755cd56bcc62e89535a6
+  data.tar.gz: b4790e53b272994ebafbdda8e61a3cb34d2b082ee9ae0b33b9094d3d9c062d8eb05cee74193579f29cf1feeadb4921f538f3ab86416effa155e2728d40f6d7a3

data/README.md

@@ -1,6 +1,12 @@
 RingCentral SDK
 ===============
 
+[![Build Status](https://img.shields.io/travis/grokify/ringcentral-sdk-ruby/master.svg)](https://travis-ci.org/grokify/ringcentral-sdk-ruby)
+[![Code Climate](https://codeclimate.com/github/grokify/ringcentral-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/grokify/ringcentral-sdk-ruby)
+[![Coverage Status](https://coveralls.io/repos/grokify/ringcentral-sdk-ruby/badge.svg?branch=master)](https://coveralls.io/r/grokify/ringcentral-sdk-ruby?branch=master)
+[![Documentation](https://img.shields.io/badge/documentation-rubydoc-blue.svg)](http://www.rubydoc.info/gems/ringcentral_sdk/)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/grokify/ringcentral-sdk-ruby/master/LICENSE.txt)
+
 This is an unofficial Ruby SDK for the RingCentral Connect Platform REST API (https://developers.ringcentral.com).
 
 The core SDK objects follow the general design of the [official RingCentral SDKs](https://github.com/ringcentral). The SDK helper additions are included to make it easier to interact with features of the API.
@@ -24,7 +30,21 @@ The following items are still needed for this SDK. Contributions are most welcom
 Installation
 ============
 
-## RubyGems
+## Via Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ringcentral_sdk'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## Via RubyGems
 
 ```sh
 $ gem install ringcentral_sdk
@@ -75,7 +95,7 @@ client = rcsdk.platform.client
 
 ## Create SMS Message
 
-SMS and other requests are directly without helpers.
+SMS and other requests can be easily sent directly without helpers.
 
 ```ruby
 # Send SMS - POST request
@@ -97,11 +117,11 @@ A fax helper is included that can be used to create the `multipart/mixed` HTTP r
 
 This consists of instantiating a fax helper object and then executing a Faraday POST request.
 
-```ruby
-# 1) Fax Helper for Text Message
+### 1) Fax Helper for Text Message
 
+```ruby
 fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
-  { account_id => '~', extension_id => '~' }, # Can be nil or {} for defaults '~'
+  { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~'
   {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
@@ -110,15 +130,17 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   },
   :text => 'RingCentral Fax via Ruby!'
 )
-# send the fax using Faraday below
+# send the fax using Faraday as shown below
+```
 
-# 2) Fax Helper for File as Raw Bytes (e.g. PDF or TIFF)
+### 2) Fax Helper for File as Raw Bytes (e.g. PDF or TIFF)
 
-# Sending a file as a plain octet-stream is useful in
-# production as it can decrease file size by 30%.
+Sending a file as a plain octet-stream is useful in production as it can decrease file size by 30%.
+
+```ruby
 
 fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
-  { account_id => '~', extension_id => '~' }, # Can be nil or {} for defaults '~'
+  { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~'
   {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
@@ -127,15 +149,16 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   },
   :file_name     => '/path/to/my_file.pdf'
 )
-# send the fax using Faraday below
+# send the fax using Faraday as shown below
+```
 
-# 3) Fax Helper for File Base64 Encoded (e.g. PDF or TIFF)
+### 3) Fax Helper for File Base64 Encoded (e.g. PDF or TIFF)
 
-# Sending a file base64 encoded is useful for debugging
-# purposes as the file can be copy and pasted.
+Sending a file base64 encoded is useful for debugging purposes as the file can be copy and pasted.
 
+```ruby
 fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
-  { account_id => '~', extension_id => '~' }, # Can be nil or {} for defaults '~'
+  { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~'
     {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
@@ -145,10 +168,12 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   :file_name     => '/path/to/my_file.tif',
   :base64_encode => true
 )
-# send the fax using Faraday below
+# send the fax using Faraday as shown below
+```
 
-# Sending the fax
+### Sending the fax
 
+```ruby
 response = client.post do |req|
   req.url fax.url
   req.headers['Content-Type'] = fax.content_type

data/VERSION.txt

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/ringcentral_sdk/helpers.rb

@@ -1,3 +1,4 @@
 module RingCentralSdk::Helpers
   autoload :CreateFaxRequest, 'ringcentral_sdk/helpers/fax'
+  autoload :Request, 'ringcentral_sdk/helpers/request'
 end

data/lib/ringcentral_sdk/helpers/fax.rb

@@ -1,10 +1,10 @@
 require 'base64'
 require 'mime'
-require 'mime-types'
+require 'mime/types'
 require 'multi_json'
 
 module RingCentralSdk::Helpers
-  class CreateFaxRequest
+  class CreateFaxRequest < RingCentralSdk::Helpers::Request
     attr_reader :msg
 
     def initialize(path_params=nil,metadata=nil,options=nil)
@@ -60,12 +60,18 @@ module RingCentralSdk::Helpers
       content_type = (content_type.is_a?(String) && content_type =~ /^[^\/\s]+\/[^\/\s]+/) \
         ? content_type : MIME::Types.type_for(file_name).first.content_type
 
+      base_name   = File.basename(file_name)
       file_base64 = Base64.encode64(File.binread(file_name))
 
       base64_part = MIME::Text.new(file_base64)
       base64_part.headers.delete('Content-Id')
-      base64_part.headers.set('Content-Type',content_type)
+      base64_part.headers.set('Content-Type', content_type)
       base64_part.headers.set('Content-Transfer-Encoding','base64')
+      if base_name.is_a?(String) && base_name.length>0
+        base64_part.headers.set('Content-Disposition', "attachment; filename=\"#{base_name}\"")
+      else
+        base64_part.headers.set('Content-Disposition', 'attachment')
+      end
 
       @msg.add(base64_part)
       return true
@@ -76,12 +82,15 @@ module RingCentralSdk::Helpers
         return false
       end
 
+      content_type = (content_type.is_a?(String) && content_type =~ /^[^\/\s]+\/[^\/\s]+/) \
+        ? content_type : MIME::Types.type_for(file_name).first.content_type
+
       base_name  = File.basename(file_name)
       file_bytes = File.binread(file_name)
 
       file_part  = MIME::Application.new(file_bytes)
       file_part.headers.delete('Content-Id')
-      file_part.headers.set('Content-Type','application/octet-stream')
+      file_part.headers.set('Content-Type', content_type)
       if base_name.is_a?(String) && base_name.length>0
         file_part.headers.set('Content-Disposition', "attachment; filename=\"#{base_name}\"")
       else
@@ -92,18 +101,30 @@ module RingCentralSdk::Helpers
       return true
     end
 
+    def method()
+      return 'post'
+    end
+
     def url()
       account_id   = "~"
       extension_id = "~"
       if @path_params.is_a?(Hash)
-        if @path_params.has?(:account_id) && @path_params[:account_id].length>0
-          account_id = @path_params[:account_id]
+        if @path_params.has_key?(:account_id)
+          if @path_params[:account_id].is_a?(String) && @path_params[:account_id].length>0
+            account_id = @path_params[:account_id]
+          elsif @path_params[:account_id].is_a?(Integer) && @path_params[:account_id]>0
+            account_id = @path_params[:account_id].to_s
+          end
         end
-        if @path_params.has?(:extension_id) && @path_params[:extension_id].length>0
-          account_id = @path_params[:extension_id]
+        if @path_params.has_key?(:extension_id)
+          if @path_params[:extension_id].is_a?(String) && @path_params[:extension_id].length>0
+            extension_id = @path_params[:extension_id]
+          elsif @path_params[:extension_id].is_a?(Integer) && @path_params[:extension_id]>0
+            extension_id = @path_params[:extension_id].to_s
+          end
         end
       end
-      url = "account/#{account_id}/extension/#{extension_id}/fax"
+      url = "account/#{account_id.to_s}/extension/#{extension_id.to_s}/fax"
       return url
     end
 

data/lib/ringcentral_sdk/helpers/request.rb

@@ -0,0 +1,16 @@
+module RingCentralSdk::Helpers
+  class Request
+    def method()
+      return 'get'
+    end
+    def url()
+      return ''
+    end
+    def content_type()
+      return ''
+    end
+    def body()
+      return ''
+    end
+  end
+end

data/lib/ringcentral_sdk/platform/auth.rb

@@ -1,20 +1,36 @@
+require 'time'
+
 module RingCentralSdk::Platform
-	class Auth
-		attr_accessor :data
-		attr_accessor :remember
+  class Auth
+    attr_accessor :data
+    attr_accessor :remember
+
+    attr_reader   :access_token
+    attr_reader   :token_type
+
+    def initialize()
+      @data     = nil
+      @remember = nil
+    end
+    def set_data(data={})
+      return false unless data.is_a?(Hash)
+
+      @access_token = data["access_token"] ? data["access_token"] : ''
+      @expire_time  = data["expire_time"]  ? data["expire_time"]  : 0
+      @token_type   = data["token_type"]   ? data["token_type"]   : ''
 
-		attr_reader   :access_token
+      @data = data
+      return true
+    end
 
-		def initialize()
-			@data     = nil
-			@remember = nil
-		end
-		def set_data(data={})
-			return unless data.is_a?(Hash)
+    def is_access_token_valid()
+      return _is_token_date_valid(@expire_time)
+    end
 
-			@access_token = data["access_token"] ? data["access_token"] : ''
-			@token_type   = data["token_type"]   ? data["token_type"]   : ''
+    def _is_token_date_valid(token_date=nil)
+      return false unless token_date.is_a?(Integer)
+      return token_date > Time.now.to_i
+    end
 
-		end
-	end
+  end
 end

data/lib/ringcentral_sdk/platform/platform.rb

@@ -22,7 +22,7 @@ module RingCentralSdk::Platform
       @app_key    = app_key
       @app_secret = app_secret
       @server_url = server_url
-      @auth       = RingCentralSdk::Platform::Auth.new
+      @_auth       = RingCentralSdk::Platform::Auth.new
 
       @client     = Faraday.new(:url => get_api_version_url()) do |conn|
         conn.request  :json
@@ -39,7 +39,7 @@ module RingCentralSdk::Platform
 
     def authorize(username='',extension='',password='',remember=false)
 
-      response = auth_call({}, {
+      response = _auth_call({}, {
         :grant_type        => 'password',
         :username          => username,
         :extension         => extension.is_a?(String) || extension.is_a?(Integer) ? extension : '',
@@ -48,8 +48,8 @@ module RingCentralSdk::Platform
         :refresh_token_ttl => remember ? REFRESH_TOKEN_TTL_REMEMBER : REFRESH_TOKEN_TTL
       })
 
-      @auth.set_data( response.body )
-      @auth.remember = remember
+      @_auth.set_data( response.body )
+      @_auth.remember = remember
 
       if response.body.has_key?("access_token") && response.body["access_token"].is_a?(String)
         @client.headers['Authorization'] = 'Bearer ' + response.body["access_token"]
@@ -58,22 +58,23 @@ module RingCentralSdk::Platform
       return response
     end
 
+    #def refresh()
+    #end
+
     def get_api_key()
-      if @app_key.is_a?(String) && @app_secret.is_a?(String)
-         return Base64.encode64(@app_key + ":" + @app_secret).gsub(/[\s\r\n]/,"")
-       else
-         return ''
-       end
+      api_key = (@app_key.is_a?(String) && @app_secret.is_a?(String)) \
+        ? Base64.encode64(@app_key + ":" + @app_secret).gsub(/[\s\r\n]/,"") : ''
+      return api_key
     end
 
     def get_auth_header()
-      if @auth.token_type.is_a?(String) && @auth.access_token.is_a?(String)
-        return @auth.token_type + ' ' + @auth.access_token
+      if @_auth.token_type.is_a?(String) && @_auth.access_token.is_a?(String)
+        return @_auth.token_type + ' ' + @_auth.access_token
       end
       return ''
     end
 
-    def auth_call(queryParams={},body={})
+    def _auth_call(queryParams={},body={})
       return @client.post do |req|
         req.url TOKEN_ENDPOINT
         req.headers['Authorization'] = 'Basic ' + get_api_key()
@@ -84,6 +85,22 @@ module RingCentralSdk::Platform
       end
     end
 
-    private :auth_call, :get_api_key, :get_api_version_url, :get_auth_header
+    def request(helper=nil)
+      unless helper.is_a?(RingCentralSdk::Helpers::Request)
+        raise 'Request is not a RingCentralSdk::Helpers::Request'
+      end
+
+      if helper.method.downcase == 'post'
+        resp       =  @client.post do |req|
+          req.url helper.url
+          req.headers['Content-Type'] = helper.content_type if helper.content_type
+          req.body = helper.body if helper.body
+        end
+        return resp
+      end
+      return nil
+    end
+    
+    private :_auth_call, :get_api_key, :get_api_version_url, :get_auth_header
   end
 end

data/lib/ringcentral_sdk/sdk.rb

@@ -7,9 +7,16 @@ module RingCentralSdk
     attr_reader :parser
     attr_reader :platform
 
-    def initialize(app_key=nil,app_secret=nil,server_url=nil)
+    def initialize(app_key=nil,app_secret=nil,server_url=nil,username=nil,extension=nil,password=nil)
       @parser   = RingCentralSdk::Platform::Parser.new
       @platform = RingCentralSdk::Platform::Platform.new(app_key, app_secret, server_url)
+      if not username.nil? and not password.nil?
+        @platform.authorize(username, extension, password)
+      end
+    end
+
+    def request(helper=nil)
+      return @platform.request(helper)
     end
   end
 end

data/test/test_setup.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'ringcentral_sdk'
+require './test/test_helper.rb'
 
 class RingCentralSdkTest < Test::Unit::TestCase
   def testSetup

metadata

@@ -1,95 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-    - - ">="
+        version: '0.9'
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-    - - ">="
+        version: '0.9'
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-    - - ">="
+    - - '>='
       - !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::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-    - - ">="
+    - - '>='
       - !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::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.5'
   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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - '>='
+      - !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::Version
+        version: '0'
 description: An unofficial Ruby SDK for the RingCentral Connect Platform API
 email: johncwang@gmail.com
 executables: []
@@ -104,6 +124,7 @@ files:
 - lib/ringcentral_sdk.rb
 - lib/ringcentral_sdk/helpers.rb
 - lib/ringcentral_sdk/helpers/fax.rb
+- lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/platform.rb
 - lib/ringcentral_sdk/platform/auth.rb
 - lib/ringcentral_sdk/platform/parser.rb
@@ -119,17 +140,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: RingCentral SDK - Unofficial Ruby SDK for the RingCentral Connect Platform