ringcentral_sdk 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18dd0357491d7aae9396a5a45bfa4f789775747b
-  data.tar.gz: 5a0880db95194fa5a7b95c2e64c67f664ca13fae
+  metadata.gz: 07264090af5d1e993dcdf5a5b09ef2dbf6c0c85b
+  data.tar.gz: b062c4ae0cf678e992e8b0612a465f9c416f428a
 SHA512:
-  metadata.gz: c4ef8a3fe7f1eacdf40c06e9970632699f74679a25e7325c83639086432e6475227427bc8aebe8d7e80982785e1ae77ff5dd4d87c71b755cd56bcc62e89535a6
-  data.tar.gz: b4790e53b272994ebafbdda8e61a3cb34d2b082ee9ae0b33b9094d3d9c062d8eb05cee74193579f29cf1feeadb4921f538f3ab86416effa155e2728d40f6d7a3
+  metadata.gz: 3011b35d44c0c67626064f1c60d0262cfa15d862b3117cb54f7a965a045384a9b90ee40c4e6c29e821ccbedd95c1bd97d5f671292ecba55df10d2f2021491ab3
+  data.tar.gz: 228f26ac20d9dcd1ac2d3be50ededa6b23fadbe5af57cbf009cd509b150ba1739a66747c2625dd240fd0f29dd10b4909ecb12f115e67d997e283f62c8b1be31e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 CHANGELOG
 ---------
+- **2015-05-31**: 0.1.0
+  - Add OAuth token refresh
+  - Add OAuth2::AccessToken support
+  - Add Code Climate hook
+- **2015-05-19**: 0.0.4
+  - Request helpers are now subclasses
+  - sdk.request() and platform.request() methods added to handle request helpers
+  - Fax helper uses file mime-type in preference to generic octet-stream
+  - Initial mkdocs and Read the Docs effort added
+  - Travis CI and Coveralls hooks added
 - **2015-05-14**: 0.0.3
   - First public release
 - **2015-03-08**: 0.0.2

data/README.md

@@ -11,11 +11,14 @@ This is an unofficial Ruby SDK for the RingCentral Connect Platform REST API (ht
 
 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.
 
+Preliminary documentation can be found on [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/).
+
 This SDK is an early stage library and subject to breaking changes.
 
 ## Included
 
 * OAuth authorization
+* OAuth token refresh
 * Faraday client with OAuth bearer token handling
 * Fax helper to create multipart/mixed messages
 
@@ -23,9 +26,8 @@ This SDK is an early stage library and subject to breaking changes.
 
 The following items are still needed for this SDK. Contributions are most welcome.
 
-* Token refresh
 * Subscriptions
-* Additional tests
+* Mock tests
 
 Installation
 ============
@@ -125,7 +127,6 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
-    :faxResolution => 'High',
     :coverPageText => 'RingCentral fax text demo using Ruby!'
   },
   :text => 'RingCentral Fax via Ruby!'
@@ -144,7 +145,6 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
-    :faxResolution => 'High',
     :coverPageText => 'RingCentral fax PDF demo using Ruby!'
   },
   :file_name     => '/path/to/my_file.pdf'
@@ -162,7 +162,6 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
     {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
-    :faxResolution => 'High',
     :coverPageText => 'RingCentral fax TIFF base64 demo using Ruby!'
   },
   :file_name     => '/path/to/my_file.tif',

data/VERSION.txt

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/ringcentral_sdk/helpers.rb

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

data/lib/ringcentral_sdk/helpers/fax.rb

@@ -7,7 +7,7 @@ module RingCentralSdk::Helpers
   class CreateFaxRequest < RingCentralSdk::Helpers::Request
     attr_reader :msg
 
-    def initialize(path_params=nil,metadata=nil,options=nil)
+    def initialize(path_params=nil, metadata=nil, options=nil)
 
       @msg = MIME::Multipart::Mixed.new
       @msg.headers.delete('Content-Id')
@@ -20,85 +20,83 @@ module RingCentralSdk::Helpers
 
       if options.is_a?(Hash)
         if options.has_key?(:file_name)
-          if options.has_key?(:base64_encode) && options[:base64_encode]
-            add_file_base64(options[:file_name],options[:file_content_type])
-          else
-            add_file_octet_stream(options[:file_name])
-          end
+          add_file(options[:file_name], options[:file_content_type], options[:base64_encode])
         elsif options.has_key?(:text)
           add_file_text(options[:text])
         end
       end
     end
 
-    def add_metadata(json=nil)
-      if json.is_a?(Hash)
-        json = MultiJson.encode(json)
+    def add_metadata(meta=nil)
+      meta = inflate_metadata(meta)
+      json = MultiJson.encode(meta)
+      json_part = MIME::Text.new(json)
+      json_part.headers.delete('Content-Id')
+      json_part.headers.set('Content-Type','application/json')
+      @msg.add(json_part)
+      return true
+    end
+
+    def inflate_metadata(meta=nil)
+      if meta.is_a?(String)
+        meta = MultiJson.decode(meta,:symbolize_keys=>true)
       end
-      if json.is_a?(String)
-        json_part = MIME::Text.new(json)
-        json_part.headers.delete('Content-Id')
-        json_part.headers.set('Content-Type','application/json')
-        @msg.add(json_part)
-        return true
+      if meta.is_a?(Hash)
+        inf = RingCentralSdk::Helpers::Inflator::ContactInfo.new
+
+        if meta.has_key?(:to)
+          meta[:to] = inf.inflate_to_array( meta[:to] )
+        elsif meta.has_key?("to")
+          meta["to"] = inf.inflate_to_array( meta["to"] )
+        else
+          meta[:to] = inf.inflate_to_array( nil )
+        end
       end
-      return false
+      return meta
     end
 
-    def add_file_text(text=nil,charset='UTF-8')
+    def add_file_text(text=nil, charset='UTF-8')
       return unless text.is_a?(String)
       text_part = MIME::Text.new(text,'plain')
       text_part.headers.delete('Content-Id')
       @msg.add(text_part)
     end
 
-    def add_file_base64(file_name=nil,content_type=nil)
-      unless file_name.is_a?(String) && File.file?(file_name)
-        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_base64 = Base64.encode64(File.binread(file_name))
+    def add_file(file_name=nil, content_type=nil, base64_encode=false)
+      file_part = get_file_part(file_name, content_type, base64_encode)
 
-      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-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)
+      @msg.add(file_part)
       return true
     end
 
-    def add_file_octet_stream(file_name=nil)
-      unless file_name.is_a?(String) && File.file?(file_name)
-        return false
+    def get_file_part(file_name=nil, content_type=nil, base64_encode=false)
+
+      unless File.file?(file_name.to_s)
+        raise "File \"#{file_name.to_s}\" does not exist or cannot be read"
       end
 
-      content_type = (content_type.is_a?(String) && content_type =~ /^[^\/\s]+\/[^\/\s]+/) \
-        ? content_type : MIME::Types.type_for(file_name).first.content_type
+      file_part  = base64_encode \
+        ? MIME::Text.new(Base64.encode64(File.binread(file_name))) \
+        : MIME::Application.new(File.binread(file_name))
+      file_part.headers.delete('Content-Id')
+      file_part.headers.set('Content-Type', get_file_content_type(file_name, content_type))
+      file_part.headers.set('Content-Disposition', get_attachment_content_disposition(file_name))
+      file_part.headers.set('Content-Transfer-Encoding', 'base64') if base64_encode
+      return file_part
+    end
 
-      base_name  = File.basename(file_name)
-      file_bytes = File.binread(file_name)
+    def get_file_content_type(file_name=nil, content_type=nil)
+      return (content_type.is_a?(String) && content_type =~ /^[^\/\s]+\/[^\/\s]+/) \
+        ? content_type : MIME::Types.type_for(file_name).first.content_type || 'application/octet-stream'
+    end
 
-      file_part  = MIME::Application.new(file_bytes)
-      file_part.headers.delete('Content-Id')
-      file_part.headers.set('Content-Type', content_type)
+    def get_attachment_content_disposition(file_name=nil)
+      base_name = File.basename(file_name.to_s)
       if base_name.is_a?(String) && base_name.length>0
-        file_part.headers.set('Content-Disposition', "attachment; filename=\"#{base_name}\"")
+        return "attachment; filename=\"#{base_name}\""
       else
-        file_part.headers.set('Content-Disposition', 'attachment')
+        return 'attachment'
       end
-
-      @msg.add(file_part)
-      return true
     end
 
     def method()
@@ -106,26 +104,22 @@ module RingCentralSdk::Helpers
     end
 
     def url()
-      account_id   = "~"
-      extension_id = "~"
+
+      vals = {:account_id => '~', :extension_id => '~'}
+
       if @path_params.is_a?(Hash)
-        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_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
+        vals.keys.each do |key|
+          next unless @path_params.has_key?(key)
+          if @path_params[key].is_a?(String) && @path_params[key].length>0
+            vals[key] = @path_params[key]
+          elsif @path_params[key].is_a?(Integer) && @path_params[key]>0
+            vals[key] = @path_params[key].to_s
           end
         end
       end
-      url = "account/#{account_id.to_s}/extension/#{extension_id.to_s}/fax"
-      return url
+
+      return "account/#{vals[:account_id].to_s}/extension/#{vals[:extension_id].to_s}/fax"
+
     end
 
     def content_type()
@@ -137,15 +131,15 @@ module RingCentralSdk::Helpers
     end
 
     # Experimental
-    def _add_file(file_name=nil)
-      if file_name.is_a?(String) && File.file?(file_name)
-        file_msg = MIME::DiscreteMediaFactory.create(file_name)
-        file_msg.headers.delete('Content-Id')
-        @msg.add(file_msg)
-        return true
-      end
-      return false
-    end
-    private :_add_file
+    #def _add_file(file_name=nil)
+    #  if file_name.is_a?(String) && File.file?(file_name)
+    #    file_msg = MIME::DiscreteMediaFactory.create(file_name)
+    #    file_msg.headers.delete('Content-Id')
+    #    @msg.add(file_msg)
+    #    return true
+    #  end
+    #  return false
+    #end
+    #private :_add_file
   end
 end

data/lib/ringcentral_sdk/helpers/inflator.rb

@@ -0,0 +1,3 @@
+module RingCentralSdk::Helpers::Inflator
+  autoload :ContactInfo, 'ringcentral_sdk/helpers/inflator/contact_info'
+end

data/lib/ringcentral_sdk/helpers/inflator/contact_info.rb

@@ -0,0 +1,15 @@
+module RingCentralSdk::Helpers::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}]
+      end
+      return contacts
+    end
+  end
+end

data/lib/ringcentral_sdk/platform.rb

@@ -1,5 +1,3 @@
 module RingCentralSdk::Platform
-	autoload :Auth, 'ringcentral_sdk/platform/auth'
-	autoload :Parser, 'ringcentral_sdk/platform/parser'
 	autoload :Platform, 'ringcentral_sdk/platform/platform'
 end

data/lib/ringcentral_sdk/platform/platform.rb

@@ -1,6 +1,8 @@
 require 'base64'
 require 'faraday'
 require 'faraday_middleware'
+require 'faraday_middleware/oauth2_refresh'
+require 'oauth2'
 
 module RingCentralSdk::Platform
   class Platform
@@ -15,21 +17,16 @@ module RingCentralSdk::Platform
     API_VERSION       = 'v1.0'
     URL_PREFIX        = '/restapi'
 
-    attr_reader :client
+    attr_reader   :client
+    attr_accessor :server_url
 
-    def initialize(app_key='',app_secret='',server_url='https://platform.devtest.ringcentral.com')
+    def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX)
 
       @app_key    = app_key
       @app_secret = app_secret
       @server_url = server_url
-      @_auth       = RingCentralSdk::Platform::Auth.new
-
-      @client     = Faraday.new(:url => get_api_version_url()) do |conn|
-        conn.request  :json
-        conn.request  :url_encoded
-        conn.response :json, :content_type => 'application/json'
-        conn.adapter  Faraday.default_adapter
-      end
+      @token      = nil
+      @client     = nil
 
     end
 
@@ -37,33 +34,36 @@ module RingCentralSdk::Platform
       return @server_url + URL_PREFIX + '/' + API_VERSION 
     end
 
-    def authorize(username='',extension='',password='',remember=false)
+    def authorize(username='', extension='', password='', remember=false)
 
-      response = _auth_call({}, {
-        :grant_type        => 'password',
-        :username          => username,
-        :extension         => extension.is_a?(String) || extension.is_a?(Integer) ? extension : '',
-        :password          => password,
-        :access_token_ttl  => ACCESS_TOKEN_TTL,
-        :refresh_token_ttl => remember ? REFRESH_TOKEN_TTL_REMEMBER : REFRESH_TOKEN_TTL
-      })
+      oauth2 = OAuth2::Client.new(@app_key, @app_secret,
+        :site      => @server_url,
+        :token_url => TOKEN_ENDPOINT)
 
-      @_auth.set_data( response.body )
-      @_auth.remember = remember
+      token = oauth2.password.get_token(username, password, {
+        :extension => extension,
+        :headers   => { 'Authorization' => 'Basic ' + get_api_key() } })
 
-      if response.body.has_key?("access_token") && response.body["access_token"].is_a?(String)
-        @client.headers['Authorization'] = 'Bearer ' + response.body["access_token"]
-      end
+      authorized(token)
 
-      return response
     end
 
-    #def refresh()
-    #end
+    def authorized(token=nil)
+      @token = token
+
+      @client = Faraday.new(:url => get_api_version_url()) do |conn|
+        conn.request  :oauth2_refresh, @token
+        conn.request  :json
+        conn.request  :url_encoded
+        conn.response :json, :content_type => 'application/json'
+        conn.adapter  Faraday.default_adapter
+      end
+
+    end
 
     def get_api_key()
       api_key = (@app_key.is_a?(String) && @app_secret.is_a?(String)) \
-        ? Base64.encode64(@app_key + ":" + @app_secret).gsub(/[\s\r\n]/,"") : ''
+        ? Base64.strict_encode64("#{@app_key}:#{@app_secret}") : ''
       return api_key
     end
 
@@ -74,17 +74,6 @@ module RingCentralSdk::Platform
       return ''
     end
 
-    def _auth_call(queryParams={},body={})
-      return @client.post do |req|
-        req.url TOKEN_ENDPOINT
-        req.headers['Authorization'] = 'Basic ' + get_api_key()
-        req.headers['Content-Type']  = 'application/x-www-form-urlencoded;charset=UTF-8'
-        if body.is_a?(Hash) && body.size > 0
-          req.body = body
-        end
-      end
-    end
-
     def request(helper=nil)
       unless helper.is_a?(RingCentralSdk::Helpers::Request)
         raise 'Request is not a RingCentralSdk::Helpers::Request'
@@ -101,6 +90,6 @@ module RingCentralSdk::Platform
       return nil
     end
     
-    private :_auth_call, :get_api_key, :get_api_version_url, :get_auth_header
+    private :get_api_version_url
   end
 end

data/lib/ringcentral_sdk/sdk.rb

@@ -4,11 +4,11 @@ module RingCentralSdk
     RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
     RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'
 
-    attr_reader :parser
+    #attr_reader :parser
     attr_reader :platform
 
     def initialize(app_key=nil,app_secret=nil,server_url=nil,username=nil,extension=nil,password=nil)
-      @parser   = RingCentralSdk::Platform::Parser.new
+      #@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)

data/test/test_setup.rb

@@ -11,7 +11,6 @@ class RingCentralSdkTest < Test::Unit::TestCase
 
     assert_equal "RingCentralSdk::Sdk", rcsdk.class.name
     assert_equal "RingCentralSdk::Platform::Platform", rcsdk.platform.class.name
-    assert_equal "Faraday::Connection", rcsdk.platform.client.class.name
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,12 +51,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime
+  name: faraday_middleware-oauth2_refresh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
@@ -64,9 +61,20 @@ dependencies:
   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
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
@@ -94,9 +102,6 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
@@ -104,9 +109,20 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  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'
@@ -124,10 +140,10 @@ files:
 - lib/ringcentral_sdk.rb
 - lib/ringcentral_sdk/helpers.rb
 - lib/ringcentral_sdk/helpers/fax.rb
+- lib/ringcentral_sdk/helpers/inflator.rb
+- lib/ringcentral_sdk/helpers/inflator/contact_info.rb
 - lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/platform.rb
-- lib/ringcentral_sdk/platform/auth.rb
-- lib/ringcentral_sdk/platform/parser.rb
 - lib/ringcentral_sdk/platform/platform.rb
 - lib/ringcentral_sdk/sdk.rb
 - test/test_setup.rb

data/lib/ringcentral_sdk/platform/auth.rb

@@ -1,36 +0,0 @@
-require 'time'
-
-module RingCentralSdk::Platform
-  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"]   : ''
-
-      @data = data
-      return true
-    end
-
-    def is_access_token_valid()
-      return _is_token_date_valid(@expire_time)
-    end
-
-    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

data/lib/ringcentral_sdk/platform/parser.rb

@@ -1,5 +0,0 @@
-module RingCentralSdk::Platform
-	class Parser
-
-	end
-end