cpaas-sdk 1.1.0 → 1.2.0

data/lib/cpaas-sdk/version.rb

@@ -1,3 +1,3 @@
 module Cpaas
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/tutorials/2FA.md

@@ -1,5 +1,5 @@
 # Two-Factor Authentication
-$KANDY$ provides [Authentication API](/developer/references/ruby/1.0.0#twofactor-send-code) using which a two-factor authentication (2FA) flow can be implemented.
+$KANDY$ provides [Authentication API](/developer/references/ruby/1.2.0#twofactor-send-code) using which a two-factor authentication (2FA) flow can be implemented.
 
 Sections below describe two sample use cases, two-factor authentication via SMS and two-factor authentication via e-mail.
 
@@ -16,7 +16,7 @@ The following diagram explains a sample use case and its logical flow for two-fa
 6. MyApp web server sends validation request to $KANDY$ with the code user entered and receives the result
 7. MyApp web page takes the action based on the result
 
-Your $KANDY$ admin can purchase SMS DID and assign to the MyApp project, so that the two-factor authentication SMS sent to app users always has the same originating number seen on the phone. Otherwise, the number seen on app users' phones may differ per transaction.
+Your $KANDY$ admin can purchase SMS DID and assign to the project or user, so that the two-factor authentication SMS sent to app users always has the same originating number seen on the phone. Otherwise, the number seen on app users' phones may differ per transaction.
 
 First, MyApp web server sends request to send a two-factor authentication code:
 
@@ -106,5 +106,8 @@ The `code` can be:
 + Resend using the same resource, which "invalidates" the previously sent code and triggers a new SMS or email containing a new code.
 + Deleted explicitly if desired (deletion operation does not block the previously started send operation)
 
+## Example
+To learn more, check the [2FA starter app](https://github.com/Kandy-IO/kandy-cpaas-ruby-sdk/tree/v1.2.0/examples/2fa).
+
 ## References
-For all two factor authentication related method details, refer to [Two Factor Authentication](/developer/references/ruby/1.0.0#twofactor-send-code).
+For all two factor authentication related method details, refer to [Two Factor Authentication](/developer/references/ruby/1.2.0#twofactor-send-code).

data/tutorials/GetStarted.md

@@ -38,10 +38,16 @@ After you've configured the SDK client, you can begin playing around with it to
 
 Before starting, you need to learn following information from your CPaaS account, specifically from Developer Portal.
 
-Log into your Developer Portal account and the configuration information required to be authenticated should be under:
+If you want to authenticate using CPaaS account's credentials, the configuration information required should be under:
 
-+ `Projects` -> `{your project}` -> `Project info`/`Project secret`
++ `Home` -> `Personal Profile` (top right corner) -> `Details`
+> + `Email` should be mapped to `email`
+> + Your account password should be mapped to `password`
+> + `Account client ID` should be mapped to `client_id`
+
+Alternatively if you want to use your project's credentials, the configuration information required should be under:
 
++ `Projects` -> `{your project}` -> `Project info`/`Project secret`
 > + `Private Project key` should be mapped to `client_id`
 > + `Private Project secret` should be mapped to `client_secret`
 
@@ -49,7 +55,16 @@ Log into your Developer Portal account and the configuration information require
 Cpaas.configure do |config|
   config.client_id = '<private project key>'
   config.client_secret = '<private project secret>'
-  config.base_url = '$KANDYFQDN$'
+  config.base_url = 'https://$KANDYFQDN$'
+end
+
+# or
+
+Cpaas.configure do |config|
+  config.client_id = '<account client ID>'
+  config.email = '<account email>'
+  config.password = '<account password>'
+  config.base_url = 'https://$KANDYFQDN$'
 end
 ```
 

data/tutorials/SMSMessaging.md

@@ -15,7 +15,7 @@ Cpaas::Conversation.create_message({
 Before moving to how the response body looks, let's walk through the highlights on the SMS request:
 
 + `sender_address` indicates which DID number that user desires to send the SMS from. It is expected to be an E.164 formatted number.
-    + If `sender_address` field contains `default` keyword, $KANDY$ discovers the default assigned SMS DID number for that user and utilizes it as the sender address.
+    + If `sender_address` field contains `default` keyword, $KANDY$ discovers the default assigned SMS DID number for that user or project and utilizes it as the sender address.
 + `destination_address` can either be an array of phone numbers or a single phone number string within the params containing the destinations that corresponding SMS message will be sent. For SDK v1, only one destination is supported on $KANDY$.
 + Address value needs to contain a phone number, ideally in E.164 format. Some valid formats are:
   - +16131234567
@@ -24,7 +24,7 @@ Before moving to how the response body looks, let's walk through the highlights
   - sip:6131234567@domain
 + `message` field contains the text message in `UTF-8` encoded format.
 
-> The number provided in `sender_address` field should be purchased by the account and assigned to the project, otherwise $KANDY$ replies back with a Forbidden error.
+> The number provided in `sender_address` field should be purchased by the account and assigned to the project or user, otherwise $KANDY$ replies back with a Forbidden error.
 
 Now, let's check the successful response:
 
@@ -59,8 +59,8 @@ Cpaas::Conversation.subscribe({
   destination_address: '+16139998877'
 })
 ```
-+ `destination_address` is an optional parameter to indicate which SMS DID number has been desired to receive SMS messages. Corresponding number should be one of the assigned/purchased numbers of the project, otherwise $KANDY$ replies back with Forbidden error. Also not providing this parameter triggers $KANDY$ to use the default assigned DID number against this user, in which case the response message for the subscription contains the `destination_address` field. It is highly recommended to provide `destination_address` parameter.
-+ `webhook_url` is a webhook that is present in your application which is accessible from the public web. The sms notifications would be delivered to the webhook and the received notification can be consumed by using the `Cpaas::Notification.parse` helper method. The usage of `Cpaas::Notification.parse` is explained in Step 2.
++ `destination_address` is an optional parameter to indicate which SMS DID number has been desired to receive SMS messages. Corresponding number should be one of the assigned/purchased numbers of the project or user, otherwise $KANDY$ replies back with Forbidden error. Also not providing this parameter triggers $KANDY$ to use the default assigned DID number against this project or user, in which case the response message for the subscription contains the `destination_address` field. It is highly recommended to provide `destination_address` parameter.
++ `webhook_url` is a webhook endpoint that is present in your application server which is accessible from the public web. The sms notifications would be delivered to this webhook endpoint and the received notification can be consumed by using the `Cpaas::Notification.parse` helper method. The usage of `Cpaas::Notification.parse` is explained in Step 2.
 
 A successful subscription would return:
 ```ruby
@@ -72,14 +72,17 @@ A successful subscription would return:
 ```
 
 > + For every number required to receive incoming SMS, there should be an individual subscription.
-> + When a number has been unassigned from a project, all corresponding inbound SMS subscriptions are cancelled and `sms_subscription_cancellation_notification` notification is sent.
+> + When a number has been unassigned from a project or user, all corresponding inbound SMS subscriptions are cancelled and `sms_subscription_cancellation_notification` notification is sent.
 
-Now, you are ready to receive inbound SMS messages via webhook, for example - 'https://myapp.com/inbound-sms/webhook'.
+Now, you are ready to receive inbound SMS messages via webhook endpoint, for example - 'https://myapp.com/inbound-sms/webhook'. For more information about webhook and subscription, you can refer the [SMS starter app](https://github.com/Kandy-IO/kandy-cpaas-ruby-sdk/tree/v1.2.0/examples/sms).
 
 ### Step 2: Receiving notification
-An inbound SMS notification via webhook can be parsed by using the `Cpaas::Notification.parse` method:
+An inbound SMS notification received by your webhook endpoint can be parsed by using the `Cpaas::Notification.parse` method:
 
 ```ruby
+  # This is a sample representation of the  method present in your application server
+  # that receives request when the particular webhook endpoint (passed as webhook_url)
+  # is hit by the CPaaS server with a notification as the request's body.
   def webhook(inbound_notification)
     parsed_Response = Cpaas::Notification.parse(inbound_notification)
   end
@@ -102,6 +105,9 @@ The parsed response returned from the `Cpaas::Notification.parse` method can loo
 $KANDY$ provides notification for outbound SMS messages, to sync all online clients up-to-date in real time. The outbound notification received can also be parsed by using the `Cpaas::Notification.parse` method:
 
 ```ruby
+  # This is a sample representation of the  method present in your application server
+  # that receives request when the particular webhook endpoint (passed as webhook_url)
+  # is hit by the CPaaS server with a notification as the request's body.
   def webhook(outbound_notification)
     parsed_response = Cpaas::Notification.parse(outbound_notification)
   end
@@ -126,6 +132,8 @@ With the help of this notification, clients can sync their view on sent SMS mess
 
 > For trial users, maximum number of SMS messages stored is 1000. When new messages are inserted to history, oldest ones are being removed.
 
+## Example
+To learn more, check the [SMS starter app](https://github.com/Kandy-IO/kandy-cpaas-ruby-sdk/tree/v1.2.0/examples/sms).
 
 ## References
-For all SMS related method details, refer to [SMS](/developer/references/ruby/1.0.0#sms-send).
+For all SMS related method details, refer to [SMS](/developer/references/ruby/1.2.0#sms-send).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpaas-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Keepworks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - bin/console
 - bin/setup
 - cpaas-sdk.gemspec
+- developer-notes.md
 - docs/Cpaas.html
 - docs/Cpaas/Conversation.html
 - docs/Cpaas/Notification.html