uni-sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f133686b5f0658fb55dd663ae9e21265b30962850459576011158d4617408955
-  data.tar.gz: 49acfe7169e8b12aed8195e2c530e25d595a3a32c58510fe436b17a938468146
+  metadata.gz: 3cb626b3043c1497ec5732f0d0d86507c269a0ec30cad9cbacf48beb6cb531b0
+  data.tar.gz: 0cf681f5fb70e49bac70024ed0d1f9a25738387ddac907f36cb9abcb0f8dd0a4
 SHA512:
-  metadata.gz: 0f58800a7bd0fccd02ed8b99ff90a56a17c3a0e0b20b6367b108c5b9e47299ea28950bd83da6a1335a5a7f18221e1c7860492bb7f1a57adc28a9f2f2eeda9bab
-  data.tar.gz: 71c5083c3357f64217e20833d8cca6b23986732ad60dc324c7b8661daad0bb8f5a0e8866f0fd2d6ee850d81197afe254952f7154f5ba410ac74a83b76903a3a6
+  metadata.gz: 71390fa7276f0a95ebdd5db4334371401b3a2127b53168e65aced5e27ed07c5f04d61221fc87b7e0f5e2308ba5b8462bb7ee803f695a6f40b02f6da1209a053e
+  data.tar.gz: fa7cbd789c467a8c8ded1c699372f884e4535c93a782005951a5ece86d4160274dea9debd2cd721a148d2469c02c64d7bec5a9d8980285592928531acc539f9a

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_STORE
+.bundle/
+.yardoc
+_yardoc/
+Gemfile.lock
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+bin/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uni-sdk.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/README.md

@@ -0,0 +1,117 @@
+# Unimatrix Ruby SDK
+
+[![Gem Version](https://img.shields.io/gem/v/uni-sdk.svg)](https://rubygems.org/gems/uni-sdk) [![Release](https://img.shields.io/github/release/unimtx/uni-ruby-sdk.svg)](https://github.com/unimtx/uni-ruby-sdk/releases/latest) [![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/unimtx/uni-ruby-sdk/blob/main/LICENSE)
+
+The Unimatrix Ruby SDK provides convenient access to integrate communication capabilities into your Ruby applications using the Unimatrix HTTP API. The SDK provides support for sending SMS, 2FA verification, and phone number lookup.
+
+## Getting started
+
+Before you begin, you need an [Unimatrix](https://www.unimtx.com/) account. If you don't have one yet, you can [sign up](https://www.unimtx.com/signup?s=ruby.sdk.gh) for an Unimatrix account and get free credits to get you started.
+
+## Documentation
+
+Check out the documentation at [unimtx.com/docs](https://www.unimtx.com/docs) for a quick overview.
+
+## Installation
+
+The recommended way to install the Unimatrix SDK for Ruby is to use the gem package manager, which is available on [RubyGems](https://rubygems.org/gems/uni-sdk).
+
+Run the following command to add `uni-sdk` as a dependency to your project:
+
+```bash
+gem install uni-sdk
+```
+
+If you are installing via Bundler, add this line to your application's Gemfile:
+
+```ruby
+gem 'uni-sdk'
+```
+
+## Usage
+
+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.
+
+```ruby
+
+require 'uni-sdk'
+
+client = Uni::Client.new('your access key id', 'your access key secret')
+
+begin
+  resp = client.messages.send({
+    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
+
+### Other Unimatrix SDKs
+
+To find Unimatrix SDKs in other programming languages, check out the list below:
+
+- [Java](https://github.com/unimtx/uni-java-sdk)
+- [Go](https://github.com/unimtx/uni-go-sdk)
+- [Node.js](https://github.com/unimtx/uni-node-sdk)
+- [Python](https://github.com/unimtx/uni-python-sdk)
+- [PHP](https://github.com/unimtx/uni-php-sdk)
+- [.NET](https://github.com/unimtx/uni-dotnet-sdk)
+
+## License
+
+This library is released under the [MIT License](https://github.com/unimtx/uni-ruby-sdk/blob/main/LICENSE).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

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

@@ -0,0 +1,13 @@
+require 'uni-sdk'
+
+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
+    text: 'Your verification code is 2048.'
+  })
+  puts resp.data
+rescue Uni::UniError => e
+  puts 'Exception: ' + e.message
+end

data/lib/uni-sdk/client.rb

@@ -0,0 +1,66 @@
+require 'faraday'
+
+module Uni
+    class Client
+        @@name = 'uni-ruby-sdk'
+        @@default_endpoint = 'https://api.unimtx.com'
+        @@default_signing_algorithm = 'hmac-sha256'
+
+        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 || 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
+
+        def _sign(query={})
+            algorithm = @signing_algorithm.split('-')[1]
+            query['algorithm'] = @signing_algorithm
+            query['timestamp'] = Time.now.strftime('%s%L')
+            query['nonce'] = rand(36**16).to_s(36)
+
+            sorted_query = query.sort_by { |k, v| k.to_s }
+            str_to_sign = URI.encode_www_form(sorted_query)
+
+            query['signature'] = OpenSSL::HMAC.hexdigest(algorithm, @access_key_secret, str_to_sign)
+        end
+
+        def request(action, data={})
+            query = {
+                action: action,
+                accessKeyId: @access_key_id
+            }
+
+            if !@access_key_secret.nil?
+                _sign(query)
+            end
+
+            conn = Faraday.new(
+                url: @endpoint,
+                params: query,
+                headers: {
+                    'User-Agent': @user_agent,
+                    'Content-Type': 'application/json;charset=utf-8',
+                    'Accept': 'application/json',
+                }
+            ) do |f|
+                f.response :json
+            end
+
+            response = conn.post('/', data.to_json)
+
+            Uni::Response.new(response)
+        end
+
+        def messages()
+            Uni::Modal::Message.new(self)
+        end
+
+        def otp()
+            Uni::Modal::Otp.new(self)
+        end
+    end
+end

data/lib/uni-sdk/error.rb

@@ -0,0 +1,16 @@
+module Uni
+    class UniError < StandardError
+        attr_reader :message, :response, :code, :request_id, :message
+
+        def initialize(message, response=nil)
+            @response = response
+            @code = (response.nil? ? nil : response.code) || '-1'
+            @request_id = response.nil? ? nil : response.request_id
+            @message = '[' + @code + '] ' + message
+        end
+
+        def to_s
+            message
+        end
+    end
+end

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

@@ -0,0 +1,13 @@
+module Uni
+    module Modal
+        class Message
+            def initialize(client)
+                @client = client
+            end
+
+            def send(data={})
+                @client.request('sms.message.send', data)
+            end
+        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

@@ -0,0 +1,7 @@
+require_relative 'modal/message'
+require_relative 'modal/otp'
+
+module Uni
+  module Model
+  end
+end

data/lib/uni-sdk/response.rb

@@ -0,0 +1,25 @@
+module Uni
+  class Response
+    @@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
+        @status = response.status
+        @headers = response.headers
+        @body = response.body
+        @request_id = @headers[@@request_id_header_key]
+        @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)
+        end
+    end
+
+  end
+end

data/lib/uni-sdk/version.rb

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

data/lib/uni-sdk.rb

@@ -0,0 +1,8 @@
+require_relative 'uni-sdk/version'
+require_relative 'uni-sdk/client'
+require_relative 'uni-sdk/error'
+require_relative 'uni-sdk/modal'
+require_relative 'uni-sdk/response'
+
+module Uni
+end

data/uni-sdk.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/uni-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uni-sdk'
+  spec.version       = Uni::VERSION
+  spec.authors       = ['Unimatrix']
+  spec.email         = ['dev@unimtx.com']
+
+  spec.summary       = 'Unimatrix Ruby SDK'
+  spec.description   = 'The official Unimatrix SDK for Ruby, provides convenient access to integrate communication capabilities into your Ruby applications using the Unimatrix HTTP API. The SDK provides support for sending SMS, 2FA verification, and phone number lookup.'
+  spec.homepage      = 'https://unimtx.com'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['documentation_uri'] = 'https://www.unimtx.com/docs'
+  spec.metadata['source_code_uri'] = 'https://github.com/unimtx/uni-ruby-sdk'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('faraday', '>= 2.7.0', '< 3.0')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uni-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Unimatrix
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-12-17 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,7 +40,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
 - 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
 homepage: https://unimtx.com
 licenses:
 - MIT