ringcentral_sdk 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c144d9ef786c8473335c8b873781710226b6e1
-  data.tar.gz: dc92d1eb5545de304856d4cf1d26a09ef4d56cc5
+  metadata.gz: b70ade50a441762f3e16344e6c7012505bf90091
+  data.tar.gz: 79b9a35b3726573276a1bc3fcbde970592e72399
 SHA512:
-  metadata.gz: ac6630b7c503c5331077af606f2dd79b2879b8312a7587fead18da645daad460861eaed3b08836789832625654dab041cba70413d23ac210923c883514bf2549
-  data.tar.gz: 8ebc499d0de3211863ff2ec46fa7a4d2b03351e761e7f004b4a5d407c876f3fc3ad7e032d8d66720b10ad7139edfc918ca85b63b73faf4b4d84320e88fb7a0c5
+  metadata.gz: 979970f4904d46bbb97e79bfa6cc2059ed4a82415078b8277c21d0361bfb1998f1a3ae52085db35ef23e4a94c7cb7a7b25ca52c57d9d0a37dfa361ae73100431
+  data.tar.gz: 70804c31f8c0ede3dc3369d3aac266669d6a8b9d8751fa6d31381d984b7e0846e43ee44f3258515732266c30df7da4a971e7c9324ad4233f683fa6d7335fdae1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 CHANGELOG
 ---------
+- **2015-09-14**: 0.2.0
+  - Refactor platform class to remove `authorized` method in favor of `set_token`
+  - Add `User-Agent` header support
+  - Add `RingCentralSdk::VERSION`
+  - Update `README.md` to include token reuse
 - **2015-09-14**: 0.1.4
   - Add OAuth2 token reuse support
 - **2015-08-29**: 0.1.3

data/README.md

@@ -122,6 +122,30 @@ platform.authorize("myUsername", nil, "myPassword")
 platform.authorize("myUsername", "myExtension", "myPassword")
 ```
 
+#### Authentication Lifecycle
+
+The platform class performs token refresh procedure automatically if needed. To save the access and refresh tokens between instances of the SDK, you can save and reuse the token as follows:
+
+```ruby
+# Retrieve and save access token when program is to be stopped:
+
+token_hash = sdk.platform.token.to_hash
+```
+
+After you have saved the token hash, e.g. as JSON, you can reload it in another instance of the SDK as follows:
+
+```ruby
+# Reuse token_hash in new SDK instance
+rcsdk = RingCentralSdk::Sdk.new(
+  "myAppKey",
+  "myAppSecret",
+  RingCentralSdk::Sdk::RC_SERVER_SANDBOX
+)
+sdk2.platform.set_token(token_hash)
+```
+
+Important! You have to manually maintain synchronization of SDK's between requests if you share authentication. When two simultaneous requests will perform refresh, only one will succeed. One of the solutions would be to have semaphor and pause other pending requests while one of them is performing refresh.
+
 See [the authorization docs](http://ringcentral-sdk-ruby.readthedocs.org/en/latest/usage/authorization/Authorization/) for more info including token reuse.
 
 ### API Requests
@@ -189,6 +213,12 @@ response = client.post do |req|
 end
 ```
 
+## Versioning
+
+This project is currently in development and the API can change. During development (Version 0.x.x), versioning a minor version change indicates backward incompatibility.
+
+Once the project is version 1.0.0 or above, it will use [semantic versioning](http://semver.org/).
+
 ## Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)

data/VERSION.txt

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/ringcentral_sdk.rb

@@ -1,3 +1,5 @@
+require 'ringcentral_sdk/version.rb'
+
 module RingCentralSdk
   autoload :Helpers, 'ringcentral_sdk/helpers'
   autoload :Platform, 'ringcentral_sdk/platform'

data/lib/ringcentral_sdk/platform/platform.rb

@@ -21,6 +21,7 @@ module RingCentralSdk::Platform
 
     attr_reader   :client
     attr_reader   :token
+    attr_reader   :ua
 
     def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX)
       @app_key    = app_key
@@ -28,6 +29,7 @@ module RingCentralSdk::Platform
       @server_url = server_url
       @token      = nil
       @client     = nil
+      @user_agent = get_user_agent()
     end
 
     def get_api_version_url()
@@ -41,28 +43,27 @@ module RingCentralSdk::Platform
         :extension => extension,
         :headers   => { 'Authorization' => 'Basic ' + get_api_key() } })
 
-      authorized(token)
+      set_token(token)
     end
 
-    def set_token(token=nil)
-      if token.is_a?(OAuth2::AccessToken)
-        authorized(token)
-      elsif token.is_a?(Hash)
+    def set_token(token)
+      if token.is_a?(Hash)
         oauth2client = get_oauth2_client()
-        oauth2token  = OAuth2::AccessToken::from_hash(oauth2client, token)
-        authorized(oauth2token)
-      else
-        raise "Invalid Token"
+        token = OAuth2::AccessToken::from_hash(oauth2client, token)
+      end
+
+      unless token.is_a?(OAuth2::AccessToken)
+        raise "Token is a OAuth2::AccessToken"
       end
-    end
 
-    def authorized(token=nil)
-      @token = token
+      @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.headers['User-Agent'] = @user_agent
+        conn.headers['Rc-User-Agent'] = @user_agent
         conn.response :json, :content_type => 'application/json'
         conn.adapter  Faraday.default_adapter
       end
@@ -95,7 +96,16 @@ module RingCentralSdk::Platform
       end
       return nil
     end
-    
+
+    def get_user_agent()
+      ua = "ringcentral-sdk-ruby/#{RingCentralSdk::VERSION} %s/%s %s" % [
+        (RUBY_ENGINE rescue nil or "ruby"),
+        RUBY_VERSION,
+        RUBY_PLATFORM
+      ]
+      return ua.strip
+    end
+
     private :get_api_version_url
   end
 end

data/lib/ringcentral_sdk/version.rb

@@ -0,0 +1,3 @@
+module RingCentralSdk
+  VERSION = '0.2.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -154,6 +154,7 @@ files:
 - lib/ringcentral_sdk/platform.rb
 - lib/ringcentral_sdk/platform/platform.rb
 - lib/ringcentral_sdk/sdk.rb
+- lib/ringcentral_sdk/version.rb
 - test/test_setup.rb
 homepage: https://github.com/grokify/
 licenses: []