cpaas-sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be04a70b357316c000cfc6437488b4d71d34bcf528bef33136c7dcc36cc0858
-  data.tar.gz: f3fd34a38d1828259e6017edb66d4976c30983da9cc37b4fc59e814de77efeef
+  metadata.gz: 3bd743f490632a5245f1c0cd2baf7187cf8623f38ded092fe0f020470445e419
+  data.tar.gz: 4b9bfcd28a1bf3c555686f79eea6e6c10fd276a2192f4dbf28cffc3ee9d87fd4
 SHA512:
-  metadata.gz: d9f9d3c7ac7369828012a8bfa7a40ab5a0288674c124d229b67ce39f4e2ee9e9f87ba6611d720730e31c3cf9157e384fe346d513780d6d3b4a93570f021dcec8
-  data.tar.gz: a0a41e797bda278bba07beef141cbfe7afd64950ba1e23836e9a86b4152488b5709d9df22fcda1c0ba9584e1899599531efd49d87108ffc4d6d0a35f184c397b
+  metadata.gz: 202495f68be89189d7336ce9d1a282aa35832a7699d621935d366e08d4ce720d72afcd002ee59bf0f7c5fba4e8f0e70a655fba247781c4f9b4a06b365f1e9a19
+  data.tar.gz: 9f69c5ce0195a0dc4e88eeb2e41770d897a390bf3328218f28ae676216b4ddfa4601afbbbc223b3111ed5e145961b8ffcea78c8b44afd81e4d85d4baa729b625

data/.gitignore

@@ -9,3 +9,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+/cpaas-*.gem

data/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 + This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 + The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) recommendations.
 
+## 1.1.0 - 2019-12-10
+
+### Added
+- Added `subject` to list of params for Twofactor's sendCode and resendCode methods to enable sending code via email.
 
 ## 1.0.0
 

data/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in cpaas-ruby.gemspec
+# Specify your gem's dependencies in cpaas-sdk.gemspec
 gemspec

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cpaas-ruby'
+gem 'cpaas-sdk'
 ```
 
 And then execute:
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install cpaas-ruby
+    $ gem install cpaas-sdk
 
 ## Reference
 

data/examples/2fa/Gemfile

@@ -5,4 +5,4 @@ gem 'httparty'
 gem 'dotenv'
 gem 'rerun'
 gem 'pry'
-gem 'cpaas-sdk', path: './../../'
+gem 'cpaas-sdk', '~> 1.0'

data/examples/sms/Gemfile

@@ -5,4 +5,4 @@ gem 'httparty'
 gem 'dotenv'
 gem 'rerun'
 gem 'pry'
-gem 'cpaas-sdk', path: './../../'
+gem 'cpaas-sdk', '~> 1.0'

data/examples/sms/app.rb

@@ -30,7 +30,6 @@ class App < Sinatra::Application
     #
     # The method create_message would send an sms when the 'type' attribute is 'SMS'
     #
-    puts ENV['PHONE_NUMBER']
     response = Cpaas::Conversation.create_message({
       type: Cpaas::Conversation.types[:SMS],
       destination_address: params['number'],

data/examples/sms/config.ru

@@ -3,6 +3,9 @@ require 'rubygems'
 require 'bundler'
 
 require './app'
+require './helper'
+
+initial_setup
 
 Bundler.require
 Dotenv.load

data/examples/sms/helper.rb

@@ -1,5 +1,6 @@
 FILE_NAME = 'notifications.json'
-PATH = "#{Dir.pwd}/tmp/#{FILE_NAME}"
+DIR_NAME = "tmp"
+PATH = "#{Dir.pwd}/#{DIR_NAME}/#{FILE_NAME}"
 
 def error_message(error)
   "#{error[:name]}: #{error[:message]} (#{error[:exception_id]})"
@@ -31,3 +32,16 @@ def write_file(content)
   notification_file.puts(content)
   notification_file.close
 end
+
+def initial_setup
+  if !File.file?(PATH)
+    dirname = File.dirname(Dir.pwd)
+    unless File.directory?(DIR_NAME)
+      FileUtils.mkdir_p(DIR_NAME)
+    end
+
+    notification_file = File.new(PATH, 'w')
+    notification_file.puts("{}")
+    notification_file.close
+  end
+end

data/lib/cpaas-sdk/resources/twofactor.rb

@@ -14,6 +14,7 @@ module Cpaas
     # @option params [String|Array[string]] :destination_address Destination address of the authentication code being sent. For sms type authentication codes, it should contain a E164 phone number. For e-mail type authentication codes, it should contain a valid e-mail address.
     # @option params [String] :message Message text sent to the destination, containing the placeholder for the code within the text. CPaaS requires to have *{code}* string within the text in order to generate a code and inject into the text. For email type code, one usage is to have the *{code}* string located within the link in order to get a unique link.
     # @option params [String] :method ('sms') +optional+ Type of the authentication code delivery method, sms and email are supported types. Possible values: sms, email
+    # @option params [String] :subject +optional+ When the method is passed as email then subject becomes a mandatory field to pass. The value passed becomes the subject line of the 2FA code email that is sent out to the destination_address.
     # @option params [Number] :expiry (120) +optional+ Lifetime duration of the code sent in seconds. This can contain values between 30 and 3600 seconds.
     # @option params [Number] :length (6) +optional+ Length of the authentication code tha CPaaS should generate for this request. It can contain values between 4 and 10.
     # @option params [String] :type ('numeric') +optional+ Type of the code that is generated. If not provided, default value is numeric. Possible values: numeric, alphanumeric, alphabetic
@@ -31,6 +32,7 @@ module Cpaas
               type: params[:type] || 'numeric'
             },
             expiry: params[:expiry] || 120,
+            subject: params[:subject],
             message: params[:message]
           }
         }
@@ -86,6 +88,7 @@ module Cpaas
     # @option params [String] :message Message text sent to the destination, containing the placeholder for the code within the text. CPaaS requires to have *{code}* string within the text in order to generate a code and inject into the text. For email type code, one usage is to have the *{code}* string located within the link in order to get a unique link.
     # @option params [String] :code_id ID of the authentication code.
     # @option params [String] :method ('sms') +optional+ Type of the authentication code delivery method, sms and email are supported types. Possible values: sms, email
+    # @option params [String] :subject +optional+ When the method is passed as email then subject becomes a mandatory field to pass. The value passed becomes the subject line of the 2FA code email that is sent out to the destination_address.
     # @option params [Number] :expiry (120) +optional+ Lifetime duration of the code sent in seconds. This can contain values between 30 and 3600 seconds.
     # @option params [Number] :length (6) +optional+ Length of the authentication code tha CPaaS should generate for this request. It can contain values between 4 and 10.
     # @option params [String] :type ('numeric') +optional+ Type of the code that is generated. If not provided, default value is numeric. Possible values: numeric, alphanumeric, alphabetic
@@ -103,6 +106,7 @@ module Cpaas
               type: params[:type] || 'numeric'
             },
             expiry: params[:expiry] || 120,
+            subject: params[:subject],
             message: params[:message]
           }
         }

data/lib/cpaas-sdk/version.rb

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

data/tutorials/2FA.md

@@ -39,7 +39,7 @@ The response contains `code_id` which is a unique ID needed for `verify_code`. T
 
 Walking through the method parameters:
 
-+ `destination_address` is required with a routable destination number in E.164 format, either with tel schema or not. For v1, only one address is supported.
++ `destination_address` is required with a routable destination number in E.164 format, either with tel schema or not. For SDK v1, only one address is supported.
 + `method` is mandatory and must have `sms` for verification via SMS flow.
 + `expiry` indicates the desired period of time in seconds that the code will be valid on $KANDY$. It is optional having default value as 120 seconds, while application can ask for values between 30 and 3600 seconds.
 + `message` is required with a `{code}` string within the text so that $KANDY$ can replace that with the real code generated, and send it as the SMS content.
@@ -76,7 +76,7 @@ An invalid/failed verification will have the following response:
 ## Two-Factor Authentication via E-mail
 A similar flow with the SMS section above can be implemented for e-mail verification.
 
-The following email code request example, requires insertion of the generated code within the link that the user is supposed to click and navigate to the application's web service:
+The following email code request example, requires an additional parameter `subject`. When value `email` is used in the `method` parameter then `subject` becomes a mandatory field to pass. The value passed becomes the subject line of the 2FA code email that is sent out to the destinationAddress:
 
 ```ruby
 Cpaas::Twofactor.send_code({
@@ -85,7 +85,8 @@ Cpaas::Twofactor.send_code({
   length: 10,
   type: 'alphanumeric',
   expiry: 3600,
-  message: 'Here is your code: {code}'
+  message: 'Here is your code: {code}',
+  subject: 'Verification code'
 })
 ```
 The response contains `code_id` which is a unique ID needed for `verify_code`. The response object can look something like this:
@@ -95,7 +96,7 @@ The response contains `code_id` which is a unique ID needed for `verify_code`. T
   }
 ```
 
-As can be seen within the example, `method` parameter has `email` value, while `destination_address` field includes a destination e-mail address. For v1, only plain text is supported.
+As can be seen within the example, `method` parameter has `email` value, while `destination_address` field includes a destination e-mail address. For SDK v1, only plain text is supported.
 
 Verification procedure for two-factor authentication via e-mail is same with two-factor authentication via SMS as described in previous section.
 

data/tutorials/GetStarted.md

@@ -9,7 +9,7 @@ To begin, you will need to install the ruby library in your application. The lib
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cpaas-ruby'
+gem 'cpaas-sdk'
 ```
 
 And then execute:
@@ -20,7 +20,7 @@ bundle
 
 Or install it yourself as:
 ```bash
-gem install cpaas-ruby
+gem install cpaas-sdk
 ```
 
 In your application, you simply need to create a new initializer `config/initializers/cpaas.rb`.
@@ -36,6 +36,15 @@ After you've configured the SDK client, you can begin playing around with it to
 
 ## Configuration
 
+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:
+
++ `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`
+
 ```ruby
 Cpaas.configure do |config|
   config.client_id = '<private project key>'
@@ -44,16 +53,9 @@ Cpaas.configure do |config|
 end
 ```
 
-The information required to be authenticated 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`
-
 ## Usage
 
-All modules can be accessed via the client instance. All method invocations follow the namespaced signature
+All modules can be accessed via `Cpaas`, refer to [References](/developer/references/ruby) for details about all modules and it's methods. All method invocations follow the namespaced signature
 
 `{Client}::{ModuleName}.{method_name}(params)`
 

data/tutorials/SMSMessaging.md

@@ -16,16 +16,15 @@ Before moving to how the response body looks, let's walk through the highlights
 
 + `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.
-+ `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 v1, only one destination is supported on $KANDY$.
++ `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
-  - 6131234567
   - tel:+16131234567
   - sip:+16131234567@domain
   - sip:6131234567@domain
 + `message` field contains the text message in `UTF-8` encoded format.
 
-> The number provided in `sender_address` field should be an assigned/purchased number for the user, 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, otherwise $KANDY$ replies back with a Forbidden error.
 
 Now, let's check the successful response:
 
@@ -39,9 +38,9 @@ Now, let's check the successful response:
   sender_address: '+16139998877'
 }
 ```
-In case of requesting `default` sender_address usage, sender_address field in response can be used to understand the actual number used since it contains the number being used as from address.
+In case of passing `default` as sender_address in the request, the actual number from which sms is sent can be identified with `sender_address` field in the response
 
-> + The delivery_status can have the following values `DeliveredToNetwork`, `DeliveryImpossible`
+> + The delivery_status can have the following values: `DeliveredToNetwork`, `DeliveryImpossible`
 
 
 ## Receive SMS
@@ -60,7 +59,7 @@ 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 user or project/application, 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.
++ `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.
 
 A successful subscription would return:
@@ -73,7 +72,7 @@ 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 user or project/application, all corresponding inbound SMS subscriptions are cancelled and `sms_subscription_cancellation_notification` notification is sent.
+> + When a number has been unassigned from a project, 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'.
 

data/tutorials/index.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <title>Node.js SDK Tutorials</title>
+    <title>Ruby SDK Tutorials</title>
     <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css">
   </head>
   <body>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpaas-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Keepworks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,7 @@ files:
 - docs/Cpaas.html
 - docs/Cpaas/Conversation.html
 - docs/Cpaas/Notification.html
-- docs/Cpaas/TwoFactor.html
+- docs/Cpaas/Twofactor.html
 - docs/_index.html
 - docs/_index.md
 - docs/class_list.html