ringcentral_sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c3f1df736ccb4265c5744bafedd2cf1fa761ac9
-  data.tar.gz: dbe05e105980943d75bdfa5e7d7fd4aade49e51d
+  metadata.gz: b397469518faf248324c39e55e10d65ce93191e2
+  data.tar.gz: b33aad360bf66be021dbb2a3a175befa196f8aea
 SHA512:
-  metadata.gz: edfc8f4eed5683463ec831430a0c692df255460c3a16b6fc059f9eb82a4ce961cc3080a43e8bcd0f7db4662f3ae55df8ae4a673de28d9e099a6d02fe37ad064e
-  data.tar.gz: f4c4d5488b375d18daacf20d46ba3f204f7f3ca824dbe648ad6e01b92da0b80a5cbfc73362657746da45e7b8783d46294b7ee9c235d380b45cb7b919741d4e3a
+  metadata.gz: 2275f8a557e7fbb962c563fc04ed4184d1f5e8f1cab7dbf19ad2205fffc753ffd5bde343881bb919b81f200c9abd8ec76e43bbfff2b7753abe96d16018e522d2
+  data.tar.gz: ca69cc1b1559f6582e5c2c60ea4b454e201573a9e7b05f29148286b815d4cdc4a83ab117854556f98c4d2ab2301c85d399da00f1f68c78686ba2d7cdbd825044

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 CHANGELOG
 ---------
+- **2015-05-31**: 0.1.2
+  - Add Ruby 1.8.7 support
+  - Add CI for Ruby 2.2.0 & 2.1.6: 2.2.2, 2.2.0, 2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.8.7
 - **2015-05-31**: 0.1.1
   - Add Ruby 2.2.2 support
 - **2015-05-31**: 0.1.0

data/README.md

@@ -1,38 +1,71 @@
 RingCentral SDK
 ===============
 
+[![Gem Version](https://badge.fury.io/rb/ringcentral_sdk.svg)](http://badge.fury.io/rb/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/)
+[![Docs](https://img.shields.io/badge/docs-readthedocs-blue.svg)](http://ringcentral-sdk-ruby.readthedocs.org/)
+[![Docs](https://img.shields.io/badge/docs-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).
+## Table of contents
 
-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.
+1. [Overview](#overview)
+  1. [Included](#included)
+  2. [To Do](#to-do)
+2. [Documentation](#documentation)
+3. [Installation](#installation)
+2. [Usage](#usage)
+  1. [Instantiation](#instantiation)
+  1. [Authorization](#authorization)
+  1. [API Requests](#api-requests)
+    1. [SMS Example](#sms-example)
+    2. [Fax Example](#fax-example)
+5. [Change Log](#change-log)
+6. [Links](#links)
+7. [Contributions](#contributions)
+8. [License](#license)
 
-Preliminary documentation can be found on [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/).
+## Overview
+
+This is an unofficial Ruby SDK for the RingCentral for Developers Platform REST API (https://developers.ringcentral.com).
+
+The core SDK objects follow the general design of the [official RingCentral SDKs](https://github.com/ringcentral). Additional functionality is provided for ease of use including request helpers and generalized OAuth2 support.
 
 This SDK is an early stage library and subject to breaking changes.
 
-## Included
+### Included
 
-* OAuth authorization
-* OAuth token refresh
-* Faraday client with OAuth bearer token handling
-* Fax helper to create multipart/mixed messages
+* OAuth2 authorization & token refresh via INTRIDEA OAuth2::AccessToken
+* Generic API requests handled via Faraday client
+* Fax request helper to create multipart/mixed messages
+* Docs via [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/) and [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/)
 
-## To Do
+### To Do
 
 The following items are still needed for this SDK. Contributions are most welcome.
 
 * Subscriptions
 * Mock tests
 
-Installation
-============
+## Documentation
+
+More documentation is available on [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/)
+and [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/). The documentation philosophy is to
+use RubyDoc / YARD for brief documentation and code specific docs while using Read the Docs for
+user guide / tutorial / FAQ style documentation.
+
+In addition the documentation for this Ruby SDK, refer to the official RingCentral guides for
+more information on individual API calls:
+
+1. [API Developer and Reference Guide](https://developers.ringcentral.com/api-docs/latest/index.html) for information on specific APIs.
+1. [API Explorer](http://ringcentral.github.io/api-explorer/)
+1. [CTI Tutorial](http://ringcentral.github.io/cti-tutorial/)
 
-## Via Bundler
+## Installation
+
+### Via Bundler
 
 Add this line to your application's Gemfile:
 
@@ -46,16 +79,19 @@ And then execute:
 $ bundle
 ```
 
-## Via RubyGems
+### Via RubyGems
 
 ```sh
 $ gem install ringcentral_sdk
 ```
 
-Usage
-=====
+## Usage
+
+This provides a very basic guide to using the SDK. Please use the following resources for more information:
 
-## Initialization
+1. [API Developer and Reference Guide](https://developers.ringcentral.com/api-docs/latest/index.html)
+
+### Instantiation
 
 The RingCentral server URLs can be populated manually or via the included constants:
 
@@ -63,8 +99,6 @@ The RingCentral server URLs can be populated manually or via the included consta
 * `RingCentralSdk::Sdk::RC_SERVER_SANDBOX`
 
 ```ruby
-## Initialization ##
-
 require 'ringcentral_sdk'
 
 rcsdk = RingCentralSdk::Sdk.new(
@@ -75,7 +109,7 @@ rcsdk = RingCentralSdk::Sdk.new(
 platform = rcsdk.platform
 ```
 
-## Authentication
+### Authorization
 
 ```ruby
 # Initialize using user phone number without extension number
@@ -87,20 +121,21 @@ platform.authorize("myUsername", nil, "myPassword")
 platform.authorize("myUsername", "myExtension", "myPassword")
 ```
 
-## Creating Requests
+### API Requests
 
-Requests are made using the inclued Faraday client.
+Requests are made using the inclued Faraday client which you can
+retrieve by calling `rcsdk.platform.client` or using it directly.
 
 ```ruby
 client = rcsdk.platform.client
 ```
 
-## Create SMS Message
+#### SMS Example
 
 SMS and other requests can be easily sent directly without helpers.
 
 ```ruby
-# Send SMS - POST request
+# SMS Example
 
 response = client.post do |req|
   req.url 'account/~/extension/~/sms'
@@ -113,35 +148,24 @@ response = client.post do |req|
 end
 ```
 
-## Create Fax Message
+#### Fax Example
 
-A fax helper is included that can be used to create the `multipart/mixed` HTTP request.
+Request helpers are subclasses of `RingCentralSdk::Helpers::Request` and provide standard methods
+that can be called by the `.request()` method of the SDK and Platform objects. This enables the
+requisite information for Faraday to be generated in a standard way.
 
-This consists of instantiating a fax helper object and then executing a Faraday POST request.
+To create your own request helpers, please take a look at the fax one shown below:
 
-### 1) Fax Helper for Text Message
-
-```ruby
-fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
-  { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~'
-  {
-    # phone numbers are in E.164 format with or without leading '+'
-    :to            => [{ :phoneNumber => '+16505551212' }],
-    :coverPageText => 'RingCentral fax text demo using Ruby!'
-  },
-  :text => 'RingCentral Fax via Ruby!'
-)
-# send the fax using Faraday as shown below
-```
-
-### 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%.
+The fax helper is included to help create the `multipart/mixed` HTTP request. This consists of
+instantiating a fax helper object and then executing a Faraday POST request. The helper can then
+be used with the standard faraday client or helper `.request()` method that takes the request
+helper object in its entirety.
 
 ```ruby
+# Fax example using request helper
 
 fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
-  { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~'
+  nil, # auto-inflates to [{:account_id => '~', :extension_id => '~'}]
   {
     # phone numbers are in E.164 format with or without leading '+'
     :to            => [{ :phoneNumber => '+16505551212' }],
@@ -149,30 +173,12 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   },
   :file_name     => '/path/to/my_file.pdf'
 )
-# send the fax using Faraday as shown below
-```
 
-### 3) Fax Helper for File Base64 Encoded (e.g. PDF or TIFF)
+# sending request via request helper methods
+response = sdk.request(fax)
+response = sdk.platform.request(fax)
 
-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 '~'
-    {
-    # phone numbers are in E.164 format with or without leading '+'
-    :to            => [{ :phoneNumber => '+16505551212' }],
-    :coverPageText => 'RingCentral fax TIFF base64 demo using Ruby!'
-  },
-  :file_name     => '/path/to/my_file.tif',
-  :base64_encode => true
-)
-# send the fax using Faraday as shown below
-```
-
-### Sending the fax
-
-```ruby
+# sending request via standard Faraday client
 response = client.post do |req|
   req.url fax.url
   req.headers['Content-Type'] = fax.content_type
@@ -180,14 +186,28 @@ response = client.post do |req|
 end
 ```
 
-Change Log
-==========
-
-- **2015-05-13**: 0.0.3
-  - Initial public release
-
-Links
-=====
+## Change Log
+
+- **2015-05-31**: 0.1.1
+  - Add Ruby 2.2.2 support
+- **2015-05-31**: 0.1.0
+  - Add OAuth token refresh
+  - Add OAuth2::AccessToken support
+  - Add Code Climate hook
+- **2015-05-19**: 0.0.4
+  - Add RingCentralSdk::Helpers::Request as request helpers base class 
+  - Add 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
+  - Convert methods from camelCase to under_scores
+- **2015-03-07**: 0.0.1
+  - Initial release
+
+## Links
 
 Project Repo
 
@@ -205,13 +225,13 @@ RingCentral Official SDKs
 
 * https://github.com/ringcentral
 
-Problems, Comments, Suggestions?
-================================
+## Contributions
+
+Any reports of problems, comments or suggestions are most welcome.
 
-All of the above are most welcome. johncwang@gmail.com
+Please report these on [Github](https://github.com/grokify/ringcentral-sdk-ruby)
 
-License
-=======
+## License
 
 RingCentral SDK is available under an MIT-style license. See {file:LICENSE.txt} for details.
 

data/VERSION.txt

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ringcentral_sdk/helpers/fax.rb

@@ -75,9 +75,14 @@ module RingCentralSdk::Helpers
         raise "File \"#{file_name.to_s}\" does not exist or cannot be read"
       end
 
+      file_bytes = RUBY_VERSION < '1.9' \
+        ? File.open(file_name, 'rb')        { |f| f.read } \
+        : File.open(file_name, 'rb:BINARY') { |f| f.read }
+
       file_part  = base64_encode \
-        ? MIME::Text.new(Base64.encode64(File.binread(file_name))) \
-        : MIME::Application.new(File.binread(file_name))
+        ? MIME::Text.new(Base64.encode64(file_bytes)) \
+        : MIME::Application.new(file_bytes)
+
       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))

data/lib/ringcentral_sdk/platform/platform.rb

@@ -17,7 +17,6 @@ module RingCentralSdk::Platform
     API_VERSION       = 'v1.0'
     URL_PREFIX        = '/restapi'
 
-    attr_reader   :client
     attr_accessor :server_url
 
     def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX)
@@ -63,17 +62,10 @@ module RingCentralSdk::Platform
 
     def get_api_key()
       api_key = (@app_key.is_a?(String) && @app_secret.is_a?(String)) \
-        ? Base64.strict_encode64("#{@app_key}:#{@app_secret}") : ''
+        ? Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/[\s\t\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
-      end
-      return ''
-    end
-
     def request(helper=nil)
       unless helper.is_a?(RingCentralSdk::Helpers::Request)
         raise 'Request is not a RingCentralSdk::Helpers::Request'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - John Wang
@@ -82,22 +82,16 @@ dependencies:
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
     - - '>='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '1.25'
   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'
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement