uni-sdk 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d98dcd92ba7b6133a759719b91c85310bef8aa82cdbe1f24f5aa23434f9b43a0
-  data.tar.gz: 5bbc4980ac4a9b81be41607ac010d513e491e129a5800f474a0b34593617398e
+  metadata.gz: 3cb626b3043c1497ec5732f0d0d86507c269a0ec30cad9cbacf48beb6cb531b0
+  data.tar.gz: 0cf681f5fb70e49bac70024ed0d1f9a25738387ddac907f36cb9abcb0f8dd0a4
 SHA512:
-  metadata.gz: e01c4e43e705b69a6b9f0376a3957c705801103c96a8f626ef9de3d8ebeca05a618e37781b69f2271a4b320c8acc7b717f3de56a2af3c44fcbc2a389e6861483
-  data.tar.gz: f96bc1df810aca1e93caf8c89c82fb755a22ab5bdcb5a353ec330857e72af02aa8fc3d280e5f5607b49c97078155880b6702372adcf99c461bf680a11e742b9d
+  metadata.gz: 71390fa7276f0a95ebdd5db4334371401b3a2127b53168e65aced5e27ed07c5f04d61221fc87b7e0f5e2308ba5b8462bb7ee803f695a6f40b02f6da1209a053e
+  data.tar.gz: fa7cbd789c467a8c8ded1c699372f884e4535c93a782005951a5ece86d4160274dea9debd2cd721a148d2469c02c64d7bec5a9d8980285592928531acc539f9a

data/README.md

@@ -32,6 +32,21 @@ gem 'uni-sdk'
 
 The following example shows how to use the Unimatrix Ruby SDK to interact with Unimatrix services.
 
+### Initialize a client
+
+```ruby
+require 'uni-sdk'
+
+client = Uni::Client.new('your access key id', 'your access key secret')
+```
+
+or you can configure your credentials by environment variables:
+
+```sh
+export UNIMTX_ACCESS_KEY_ID=your_access_key_id
+export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret
+```
+
 ### Send SMS
 
 Send a text message to a single recipient.
@@ -44,15 +59,44 @@ client = Uni::Client.new('your access key id', 'your access key secret')
 
 begin
   resp = client.messages.send({
-    to: 'your phone number', # in E.164 format
-    signature: 'your sender name',
-    content: 'Your verification code is 2048.'
+    to: '+1206880xxxx', # in E.164 format
+    text: 'Your verification code is 2048.'
   })
   puts resp.data
 rescue Uni::UniError => e
   puts 'Exception: ' + e.message
 end
+```
+
+### Send verification code
+
+Send a one-time passcode (OTP) to a recipient. The following example will automatically generate a verification code.
+
+```ruby
+require 'uni-sdk'
+
+client = Uni::Client.new()
+
+resp = client.otp.send({
+  to: '+1206880xxxx'
+})
+puts resp.data
+```
+
+### Check verification code
+
+Verify the one-time passcode (OTP) that a user provided. The following example will check whether the user-provided verification code is correct.
+
+```ruby
+require 'uni-sdk'
+
+client = Uni::Client.new()
 
+resp = client.otp.verify({
+  to: '+1206880xxxx',
+  code: '123456' # the code user provided
+})
+puts resp.valid
 ```
 
 ## Reference

data/examples/otp.rb

@@ -0,0 +1,24 @@
+require 'uni-sdk'
+
+client = Uni::Client.new('your access key id', 'your access key secret')
+
+# send a verification code to a recipient
+begin
+  resp = client.otp.send({
+    to: 'your phone number' # in E.164 format
+  })
+  puts resp.data
+rescue Uni::UniError => e
+  puts 'Exception: ' + e.message
+end
+
+# verify a verification code
+begin
+  resp = client.otp.verify({
+    to: 'your phone number', # in E.164 format
+    code: 'the code you received'
+  })
+  puts resp.valid
+rescue Uni::UniError => e
+  puts 'Exception: ' + e.message
+end

data/examples/send.rb

@@ -5,8 +5,7 @@ client = Uni::Client.new('your access key id', 'your access key secret')
 begin
   resp = client.messages.send({
     to: 'your phone number', # in E.164 format
-    signature: 'your sender name',
-    content: 'Your verification code is 2048.'
+    text: 'Your verification code is 2048.'
   })
   puts resp.data
 rescue Uni::UniError => e

data/lib/uni-sdk/client.rb

@@ -9,9 +9,9 @@ module Uni
         attr_accessor :access_key_id, :access_key_secret, :endpoint, :signing_algorithm
 
         def initialize(access_key_id=nil, access_key_secret=nil, endpoint=nil, signing_algorithm=nil)
-            @access_key_id = access_key_id
-            @access_key_secret = access_key_secret
-            @endpoint = endpoint || @@default_endpoint
+            @access_key_id = access_key_id || ENV['UNIMTX_ACCESS_KEY_ID']
+            @access_key_secret = access_key_secret || ENV['UNIMTX_ACCESS_KEY_SECRET']
+            @endpoint = endpoint || ENV['UNIMTX_ENDPOINT'] || @@default_endpoint
             @signing_algorithm = signing_algorithm || @@default_signing_algorithm
             @user_agent = @@name + '/' + Uni::VERSION
         end
@@ -58,5 +58,9 @@ module Uni
         def messages()
             Uni::Modal::Message.new(self)
         end
+
+        def otp()
+            Uni::Modal::Otp.new(self)
+        end
     end
 end

data/lib/uni-sdk/modal/otp.rb

@@ -0,0 +1,19 @@
+module Uni
+    module Modal
+        class Otp
+            def initialize(client)
+                @client = client
+            end
+
+            def send(data={})
+                @client.request('otp.send', data)
+            end
+
+            def verify(data={})
+                resp = @client.request('otp.verify', data)
+                resp.valid = resp.data.nil? ? false : resp.data['valid']
+                resp
+            end
+        end
+    end
+end

data/lib/uni-sdk/modal.rb

@@ -1,4 +1,5 @@
 require_relative 'modal/message'
+require_relative 'modal/otp'
 
 module Uni
   module Model

data/lib/uni-sdk/response.rb

@@ -3,6 +3,7 @@ module Uni
     @@request_id_header_key = 'x-uni-request-id'
 
     attr_reader :raw, :status, :request_id, :code, :message, :data
+    attr_accessor :valid
 
     def initialize(response)
         @raw = response
@@ -13,6 +14,7 @@ module Uni
         @code = @body['code']
         @message = @body['message']
         @data = @body['data']
+        @valid = false
 
         if @status < 200 || @status >= 300 || @code != '0'
           raise UniError.new(@message || response.reason_phrase, self)

data/lib/uni-sdk/version.rb

@@ -1,3 +1,3 @@
 module Uni
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uni-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Unimatrix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -45,12 +45,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/otp.rb
 - examples/send.rb
 - lib/uni-sdk.rb
 - lib/uni-sdk/client.rb
 - lib/uni-sdk/error.rb
 - lib/uni-sdk/modal.rb
 - lib/uni-sdk/modal/message.rb
+- lib/uni-sdk/modal/otp.rb
 - lib/uni-sdk/response.rb
 - lib/uni-sdk/version.rb
 - uni-sdk.gemspec