ost-sdk-ruby 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c2dbe89647944477ea3df793d97f22781ada86b58674c4bb2b69bb037b17bd
-  data.tar.gz: 43c28beb04c58f691bb949a866eb2490cedcb8fb43ae58a248c010ad23e54bdc
+  metadata.gz: 21be166483ac9016af3e93792829cf213299c61ad293c9e8421bbd077cd29eb9
+  data.tar.gz: acd5e51154fb5dae1b673e33aeef5bb2ef7297541c4c034a7b95aefe7ec706d1
 SHA512:
-  metadata.gz: 9288e529718029cf220cab1c63d79bf86ee2053fa3efef88a1c378e7754ce83f59f041ad812f90e9a65d108f1e7553262576376dceb5c2fff13d25d9b70efed4
-  data.tar.gz: b9a41cf03bb03eaa034888b41b32d5b232a44e2118777eec7a584d534b9c55179d6f8fac9f22af796649e083e1ea596b077ec8abf90c4cc00991b91df2a3433b
+  metadata.gz: 70c30cbf7b273566adc554d3d771a383b32f2dd22ceb9ff43214584e334da7d42c5a26ef5a314a2119b7224cbd71dc18422ac3184a5dd73940e49fb284654432
+  data.tar.gz: 036160ccaf69aa2b55a2b3d2a45d6beb2104c7e75c2c9539165f0979bafd6b977c06a021af046b073df8e72bd4dcc729fe0b545ebb557c0b920b5f1cb183dd47

data/lib/ost-sdk-ruby/saas.rb

@@ -13,6 +13,7 @@ require_relative 'saas/tokens'
 require_relative 'saas/transactions'
 require_relative 'saas/users'
 require_relative 'saas/base_tokens'
+require_relative 'saas/webhooks'
 
 module OSTSdk
 

data/lib/ost-sdk-ruby/saas/base.rb

@@ -54,6 +54,18 @@ module OSTSdk
         get_value_for_key!(params, "user_id")
       end
 
+      # Get webhook_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   user_id: (String)
+      #
+      def get_webhook_id!(params)
+        get_value_for_key!(params, "webhook_id")
+      end
+
       # Get chain_id key from params hash and delete it
       #
       # Arguments:

data/lib/ost-sdk-ruby/saas/manifest.rb

@@ -5,7 +5,7 @@ module OSTSdk
     class Manifest
 
       attr_reader :balance, :chains, :device_managers, :devices, :price_points, :recovery_owners, :rules,
-                  :sessions, :tokens, :transactions, :users, :base_tokens
+                  :sessions, :tokens, :transactions, :users, :base_tokens, :webhooks
 
       # Initialize
       #
@@ -31,6 +31,7 @@ module OSTSdk
         @transactions = OSTSdk::Saas::Transactions.new(params)
         @users = OSTSdk::Saas::Users.new(params)
         @base_tokens = OSTSdk::Saas::BaseTokens.new(params)
+        @webhooks = OSTSdk::Saas::Webhooks.new(params)
 
       end
 

data/lib/ost-sdk-ruby/saas/webhooks.rb

@@ -0,0 +1,90 @@
+module OSTSdk
+
+  module Saas
+
+    class Webhooks < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/webhooks'
+      end
+
+      # Create a Webhook
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def create(params = {})
+        http_helper.send_post_request("#{@url_prefix}/", params)
+      end
+
+      # Update a Webhook
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def update(params = {})
+        http_helper.send_post_request("#{@url_prefix}/#{get_webhook_id!(params)}", params)
+      end
+
+      # Get webhook details
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_webhook_id!(params)}", params)
+      end
+
+      # List Webhooks
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get_list(params = {})
+        http_helper.send_get_request("#{@url_prefix}/", params)
+      end
+
+      # Delete a Webhook
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def delete(params = {})
+        http_helper.send_delete_request("#{@url_prefix}/#{get_webhook_id!(params)}", params)
+      end
+
+      # Verify webhook request signature
+      #
+      # Returns:
+      #   response: (Boolean)
+      #
+      def verify_signature(params = {})
+        version = params[:version]
+        webhook_secret = params[:webhook_secret]
+        stringified_data = params[:stringified_data]
+        request_timestamp = params[:request_timestamp]
+        signature = params[:signature]
+
+        signature_params = "#{request_timestamp}.#{version}.#{stringified_data}"
+        digest = OpenSSL::Digest.new('sha256')
+        signature_to_be_verified = OpenSSL::HMAC.hexdigest(digest, webhook_secret, signature_params)
+
+        signature == signature_to_be_verified
+
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-sdk-ruby/test/webhooks_test.rb

@@ -0,0 +1,72 @@
+require_relative "../../../lib/ost-sdk-ruby/util"
+require_relative "../../../lib/ost-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class UsersTest < Test::Unit::TestCase
+
+  def webhooks_service
+    @webhooks_service ||= Config::OST_SDK.services.webhooks
+  end
+
+  def test_webhooks_create
+    result = webhooks_service.create({
+                                      topics: ['transactions/initiate', 'transactions/success'],
+                                      url: 'https://testingWebhooks.com'
+                                     })
+    puts "result=>#{result}" unless result["success"]
+    webhook_id = result["data"]["webhook"]["id"]
+    webhooks_get(webhook_id)
+    webhooks_get_all
+    webhooks_update(webhook_id)
+    webhooks_delete(webhook_id)
+    assert_equal(result["success"], true)
+  end
+
+  def webhooks_get(webhook_id)
+    result = webhooks_service.get({
+                                    webhook_id: webhook_id
+                                  })
+    puts "result=>#{result}" unless result["success"]
+    assert_equal(result["success"], true)
+  end
+
+  def webhooks_get_all
+    result = webhooks_service.get_list()
+    puts "result=>#{result}" unless result["success"]
+    assert_equal(result["success"], true)
+  end
+
+  def webhooks_update(webhook_id)
+    result = webhooks_service.update({
+                                         webhook_id: webhook_id,
+                                         topics: ['transactions/initiate', 'transactions/success', 'transactions/failure'],
+                                         status: 'inactive'
+                                       })
+    puts "result=>#{result}" unless result["success"]
+    assert_equal(result["success"], true)
+  end
+
+  def webhooks_delete(webhook_id)
+    result = webhooks_service.delete({
+                                       webhook_id: webhook_id,
+                                     })
+    puts "result=>#{result}" unless result["success"]
+    assert_equal(result["success"], true)
+  end
+
+  def test_webhooks_verify_signature
+    data = {}
+    data[:hello] = 'hello'
+    result = webhooks_service.verify_signature({
+                                                 version: "2",
+                                                 webhook_secret: "mySecret",
+                                                 request_timestamp: "1559902637",
+                                                 signature: "2c56c143550c603a6ff47054803f03ee4755c9c707986ae27f7ca1dd1c92a824",
+                                                 stringified_data: data.to_json
+                                     })
+    puts "result=>#{result}" unless result
+    assert_equal(result, true)
+  end
+
+end

data/lib/ost-sdk-ruby/util/http_helper.rb

@@ -81,6 +81,33 @@ module OSTSdk
         end
       end
 
+      # Send DELETE requests
+      #
+      # Arguments:
+      #   end_point: (String)
+      #   request_params: (Hash)
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def send_delete_request(endpoint, request_params)
+        perform_and_handle_exceptions('u_hh_3', 'DELETE request Failed') do
+          escaped_query_string = get_query_string(endpoint, request_params)
+          raw_url = get_api_url(endpoint) + "?#{escaped_query_string}"
+          uri = URI(raw_url)
+          http = setup_request(uri)
+          if @api_spec
+            return {request_uri: uri.to_s.split("?")[0], request_type: 'DELETE', request_params: escaped_query_string}
+          else
+            result = {}
+            Timeout.timeout(@timeout) do
+              result = http.delete(uri)
+            end
+            return format_response(result)
+          end
+        end
+      end
+
       # Generate a signature for test case. It only creates a signature for a given Hash
       #
       # Arguments:

data/lib/ost-sdk-ruby/version.rb

@@ -1,5 +1,5 @@
 module OSTSdk
 
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ost-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - OST.com Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -62,6 +62,7 @@ files:
 - lib/ost-sdk-ruby/saas/tokens.rb
 - lib/ost-sdk-ruby/saas/transactions.rb
 - lib/ost-sdk-ruby/saas/users.rb
+- lib/ost-sdk-ruby/saas/webhooks.rb
 - lib/ost-sdk-ruby/test/balance_test.rb
 - lib/ost-sdk-ruby/test/base_tokens_test.rb
 - lib/ost-sdk-ruby/test/chains_test.rb
@@ -75,6 +76,7 @@ files:
 - lib/ost-sdk-ruby/test/tokens_test.rb
 - lib/ost-sdk-ruby/test/transactions_test.rb
 - lib/ost-sdk-ruby/test/users_test.rb
+- lib/ost-sdk-ruby/test/webhooks_test.rb
 - lib/ost-sdk-ruby/util.rb
 - lib/ost-sdk-ruby/util/api_credentials.rb
 - lib/ost-sdk-ruby/util/common_validator.rb