ringcentral_sdk 0.4.0 → 0.5.0

data/lib/ringcentral_sdk/subscription.rb

@@ -1,6 +1,9 @@
 require 'base64'
+require 'logger'
 require 'multi_json'
 require 'observer'
+require 'openssl'
+require 'pubnub'
 require 'timers'
 
 module RingCentralSdk
@@ -11,9 +14,8 @@ module RingCentralSdk
 
     attr_reader :event_filters
 
-    def initialize(platform, pubnub_factory)
+    def initialize(platform)
       @_platform = platform
-      @_pubnub_factory = pubnub_factory
       @event_filters = []
       @_timeout = nil
       @_subscription = nil_subscription()
@@ -73,7 +75,7 @@ module RingCentralSdk
         response = @_platform.client.post do |req|
           req.url 'subscription'
           req.body = {
-            :eventFilters    => _get_full_events_filter(),
+            :eventFilters    => @_platform.create_urls(@event_filters),
             :deliveryMode    => {
               :transportType => 'PubNub'
             }
@@ -91,7 +93,6 @@ module RingCentralSdk
         raise 'Subscribe HTTP Request Error'
       end
 
-      return nil
     end
 
     def renew(events=nil)
@@ -109,9 +110,9 @@ module RingCentralSdk
 
       begin
         response = @_platform.client.put do |req|
-          req.url 'subscription' + @_subscription['id']
+          req.url 'subscription/' + @_subscription['id'].to_s
           req.body = {
-            :eventFilters => _get_full_events_filter()
+            :eventFilters => @_platform.create_urls(@event_filters),
           }
         end
 
@@ -133,6 +134,7 @@ module RingCentralSdk
       end
 
       begin
+        url = 'subscription/' + @_subscription['id'].to_s
         response = @_platform.client.delete do |req|
           req.url = 'subscription' + @_subscription['id']
         end
@@ -183,7 +185,8 @@ module RingCentralSdk
       end
 
       s_key = @_subscription['deliveryMode']['subscriberKey']
-      @_pubnub = @_pubnub_factory.pubnub(s_key, false, '')
+
+      @_pubnub = new_pubnub(s_key, false, '')
 
       callback = lambda { |envelope|
       	_notify(envelope.msg)
@@ -214,14 +217,13 @@ module RingCentralSdk
 
       if _encrypted?()
         delivery_mode = @_subscription['deliveryMode']
-        key = Base64.decode64(delivery_mode['encryptionKey'])
-        ciphertext = Base64.decode64(message)
 
-        decipher = OpenSSL::Cipher::AES.new(128, :ECB)
-        decipher.decrypt
-        decipher.key = key
+        cipher = OpenSSL::Cipher::AES.new(128, :ECB)
+        cipher.decrypt
+        cipher.key = Base64.decode64(delivery_mode['encryptionKey'].to_s)
 
-        plaintext = decipher.update(ciphertext) + decipher.final
+        ciphertext = Base64.decode64(message)
+        plaintext = cipher.update(ciphertext) + cipher.final
 
         message = MultiJson.decode(plaintext)
       end
@@ -244,16 +246,6 @@ module RingCentralSdk
       end
     end
 
-    def _get_full_events_filter()
-      full_events_filter = []
-      @event_filters.each do |filter|
-        if filter.to_s
-          full_events_filter.push(@_platform.create_url(filter.to_s))
-        end
-      end
-      return full_events_filter
-    end
-
     def _set_timeout()
       time_to_expiration = @_subscription['expiresIn'] - RENEW_HANDICAP
       @_timeout = Timers::Group.new
@@ -268,5 +260,21 @@ module RingCentralSdk
       end
     end
 
+    def new_pubnub(subscribe_key='', ssl_on=false, publish_key='', my_logger=nil)
+      my_logger = Logger.new(STDOUT) if my_logger.nil?
+
+      return Pubnub.new(
+        :subscribe_key    => subscribe_key.to_s,
+        :publish_key      => publish_key.to_s,
+        :error_callback   => lambda { |msg|
+          puts "Error callback says: #{msg.inspect}"
+        },
+        :connect_callback => lambda { |msg|
+          puts "CONNECTED: #{msg.inspect}"
+        },
+        :logger => my_logger
+      )
+    end
+
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require "mocha/test_unit"
+require 'ringcentral_sdk'
+
+rcsdk = RingCentralSdk.new(
+  'my_app_key',
+  'my_app_secret',
+  RingCentralSdk::RC_SERVER_SANDBOX
+)

data/test/test_helper_fax.rb

@@ -0,0 +1,84 @@
+require './test/test_helper.rb'
+
+class RingCentralSdkHelperFaxTest < Test::Unit::TestCase
+  def testSetup
+
+    fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      nil, # Can be nil or {} for defaults '~'
+      {
+        # phone numbers are in E.164 format with or without leading '+'
+        :to            => '+16505551212',
+        :faxResolution => 'High',
+        :coverPageText => 'RingCentral fax demo using Ruby SDK!'
+      },
+      :text => 'RingCentral fax demo using Ruby SDK!'
+    )
+
+    assert_equal "RingCentralSdk::Helpers::CreateFaxRequest", fax.class.name
+    assert_equal 'account/~/extension/~/fax', fax.url()
+
+    fax2 = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      { :account_id => '111111111', :extension_id => '222222222' }, # Can be nil or {} for defaults '~'
+      {
+        # phone numbers are in E.164 format with or without leading '+'
+        "to"           => { :phoneNumber => '+16505551212' },
+        :faxResolution => 'High',
+        :coverPageText => 'RingCentral fax demo using Ruby SDK!'
+      },
+      :file_name => './scripts/test_file.pdf'
+    )
+
+    assert_equal 'account/111111111/extension/222222222/fax', fax2.url()
+
+    assert_raise do
+      fax2.add_file('non-existent_file_path')
+    end
+
+    fax3 = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      { :account_id => 111111111, :extension_id => 222222222 }, # Can be nil or {} for defaults '~'
+      {
+        # phone numbers are in E.164 format with or without leading '+'
+        :to           => [{ :phoneNumber => '+16505551212' }],
+        :faxResolution => 'High',
+        :coverPageText => 'RingCentral fax demo using Ruby SDK!'
+      },
+      :text => 'RingCentral fax demo using Ruby SDK!'
+    )
+
+    assert_equal 'account/111111111/extension/222222222/fax', fax3.url()
+
+    fax4 = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      { :account_id => 111111111, :extension_id => 222222222 }, # Can be nil or {} for defaults '~'
+      '{"to":"+16505551212","coverPageText":"RingCentral fax demo using Ruby SDK!"}',
+      :text => 'RingCentral fax demo using Ruby SDK!'
+    )
+    assert_equal 'account/111111111/extension/222222222/fax', fax4.url()
+
+    fax5 = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      { :account_id => 111111111, :extension_id => 222222222 }, # Can be nil or {} for defaults '~'
+      '{"coverPageText":"RingCentral fax demo using Ruby SDK!"}',
+      :text => 'RingCentral fax demo using Ruby SDK!'
+    )
+    assert_equal 'account/111111111/extension/222222222/fax', fax5.url()
+
+    assert_equal 'application/pdf', fax.get_file_content_type('example.pdf')
+    assert_equal 'attachment', fax.get_attachment_content_disposition()
+    assert_equal 'attachment; filename="example.pdf"', fax.get_attachment_content_disposition('example.pdf')
+    assert_equal 'attachment; filename="example.pdf"', fax.get_attachment_content_disposition('/path/to/example.pdf')
+    assert_equal 'post', fax.method()
+
+    content_type = fax.content_type()
+    content_type_prefix = ''
+    boundary = ''
+    if content_type =~ /^(multipart\/mixed;\s+boundary=)(.*)$/
+      content_type_prefix = $1
+      boundary = $2
+    end
+    assert_equal 'multipart/mixed; boundary=', content_type_prefix
+
+    lines = fax.body.split(/\r?\n/)
+    assert_equal '--' + boundary, lines[0]
+    assert_equal '--' + boundary + '--', lines[-1]
+
+  end
+end

data/test/test_helper_inflator_contact_info.rb

@@ -0,0 +1,21 @@
+require './test/test_helper.rb'
+
+class RingCentralSdkHelperInflatorContactInfoTest < Test::Unit::TestCase
+  def testSetup
+
+    inf  = RingCentralSdk::Helpers::Inflator::ContactInfo.new
+
+    arr1 = inf.inflate_to_array(16505551212)
+    assert_equal 16505551212, arr1[0][:phoneNumber]
+
+    arr2 = inf.inflate_to_array('+16505551212')
+    assert_equal '+16505551212', arr2[0][:phoneNumber]
+
+    arr3 = inf.inflate_to_array({:phoneNumber=>16505551212})
+    assert_equal 16505551212, arr3[0][:phoneNumber]
+
+    arr4 = inf.inflate_to_array([{:phoneNumber=>16505551212}])
+    assert_equal 16505551212, arr4[0][:phoneNumber]   
+
+  end
+end

data/test/test_helper_request.rb

@@ -0,0 +1,14 @@
+require './test/test_helper.rb'
+
+class RingCentralSdkHelperRequestTest < Test::Unit::TestCase
+  def testSetup
+
+    req = RingCentralSdk::Helpers::Request.new
+
+    assert_equal 'get', req.method()
+    assert_equal '', req.url()
+    assert_equal '', req.content_type()
+    assert_equal '', req.body()
+
+  end
+end

data/test/test_platform.rb

@@ -0,0 +1,209 @@
+require './test/test_helper.rb'
+
+require 'faraday'
+require 'oauth2'
+
+class RingCentralSdkPlatformTest < Test::Unit::TestCase
+  def setup
+    @rcsdk = RingCentralSdk.new(
+      'my_app_key',
+      'my_app_secret',
+      RingCentralSdk::RC_SERVER_SANDBOX
+    )
+  end
+
+  def test_main
+    assert_equal "bXlfYXBwX2tleTpteV9hcHBfc2VjcmV0", @rcsdk.send(:get_api_key)
+  end
+
+  def test_set_client
+    rcsdk = new_rcsdk()
+    assert_equal true, rcsdk.oauth2client.is_a?(OAuth2::Client)
+
+    rcsdk.set_oauth2_client()
+    assert_equal true, rcsdk.oauth2client.is_a?(OAuth2::Client)
+
+    rcsdk = new_rcsdk()
+    oauth2client = OAuth2::Client.new(
+      'my_app_key',
+      'my_app_secret',
+      :site      => RingCentralSdk::RC_SERVER_SANDBOX,
+      :token_url => rcsdk.class::TOKEN_ENDPOINT)
+    rcsdk.set_oauth2_client(oauth2client)
+    assert_equal true, rcsdk.oauth2client.is_a?(OAuth2::Client) 
+
+    assert_raise do
+      @rcsdk.set_oauth2_client('test')
+    end
+  end
+
+  def test_set_token
+    token_data = {:access_token => 'test_token'}
+
+    @rcsdk.set_token(token_data)
+
+    assert_equal 'OAuth2::AccessToken', @rcsdk.token.class.name
+    assert_equal 'Faraday::Connection', @rcsdk.client.class.name
+
+    assert_raise do
+      @rcsdk.set_token('test')
+    end
+  end
+
+  def test_authorize_url_default
+    rcsdk = RingCentralSdk.new(
+      'my_app_key',
+      'my_app_secret',
+      RingCentralSdk::RC_SERVER_PRODUCTION,
+      {:redirect_uri => 'http://localhost:4567/oauth'}
+    )
+    authorize_url = rcsdk.authorize_url()
+
+    assert_equal true, authorize_url.is_a?(String)
+    assert_equal 0, authorize_url.index(RingCentralSdk::RC_SERVER_PRODUCTION)
+    assert_equal true, (authorize_url.index('localhost') > 0) ? true : false
+  end
+
+  def test_authorize_url_explicit
+    authorize_url = @rcsdk.authorize_url({:redirect_uri => 'http://localhost:4567/oauth'})
+
+    assert_equal 0, authorize_url.index(RingCentralSdk::RC_SERVER_SANDBOX)
+    assert_equal true, (authorize_url.index('localhost') > 0) ? true : false
+  end
+
+  def test_create_url
+    assert_equal '/restapi/v1.0/subscribe', @rcsdk.create_url('subscribe')
+    assert_equal '/restapi/v1.0/subscribe', @rcsdk.create_url('/subscribe')
+    assert_equal RingCentralSdk::RC_SERVER_SANDBOX + '/restapi/v1.0/subscribe', @rcsdk.create_url('subscribe', true)
+    assert_equal RingCentralSdk::RC_SERVER_SANDBOX + '/restapi/v1.0/subscribe', @rcsdk.create_url('/subscribe', true)
+    assert_equal RingCentralSdk::RC_SERVER_SANDBOX + '/restapi/v1.0/subscribe', @rcsdk.create_url('subscribe', true)
+    assert_equal RingCentralSdk::RC_SERVER_SANDBOX + '/restapi/v1.0/subscribe', @rcsdk.create_url('/subscribe', true)
+  end
+
+  def test_create_urls
+    urls = @rcsdk.create_urls(['subscribe'])
+    assert_equal '/restapi/v1.0/subscribe', urls[0]
+    assert_raise do
+      @rcsdk.create_urls(nil)
+    end
+  end
+
+  def test_authorize_code
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize_code('my_test_auth_code')
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+
+    rcsdk = new_rcsdk({:redirect_uri => 'http://localhost:4567/oauth'})
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize_code('my_test_auth_code')
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize_code('my_test_auth_code')
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize_code('my_test_auth_code', {:redirect_uri => 'http://localhost:4567/oauth'})
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+  end
+
+  def test_authorize_password
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.password.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize('my_test_username', 'my_test_extension', 'my_test_password')
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+  end
+
+  def test_request
+    assert_raise do
+      @rcsdk.request()
+    end
+
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.password.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize('my_test_username', 'my_test_extension', 'my_test_password')
+
+    #@rcsdk.client.stubs(:post).returns(Faraday::Response.new)
+    Faraday::Connection.any_instance.stubs(:post).returns(Faraday::Response.new)
+
+    fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
+      nil, # Can be nil or {} for defaults '~'
+      {
+        # phone numbers are in E.164 format with or without leading '+'
+        :to            => '+16505551212',
+        :faxResolution => 'High',
+        :coverPageText => 'RingCentral fax demo using Ruby SDK!'
+      },
+      :text => 'RingCentral fax demo using Ruby SDK!'
+    )
+    res = rcsdk.request(fax)
+    assert_equal 'Faraday::Response', res.class.name
+  end
+
+  def new_rcsdk(opts={})
+    return RingCentralSdk.new(
+      'my_app_key',
+      'my_app_secret',
+      RingCentralSdk::RC_SERVER_PRODUCTION,
+      opts
+    )
+  end
+
+  def data_auth_token
+    json = '{
+  "access_token": "my_test_access_token",
+  "token_type": "bearer",
+  "expires_in": 3599,
+  "refresh_token": "my_test_refresh_token",
+  "refresh_token_expires_in": 604799,
+  "scope": "ReadCallLog DirectRingOut EditCallLog ReadAccounts Contacts EditExtensions ReadContacts SMS EditPresence RingOut EditCustomData ReadPresence EditPaymentInfo Interoperability Accounts NumberLookup InternalMessages ReadCallRecording EditAccounts Faxes EditReportingSettings ReadClientInfo EditMessages VoipCalling ReadMessages",
+  "owner_id": "1234567890"
+      }'
+    data = JSON.parse(json, :symbolize_names=>true)
+    return data
+  end
+end