kindtap-platform-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f548b3974570d50307e6fa7d326ec1b51ad02fa9186ab6099c835a1c820572ba
+  data.tar.gz: 65aa39c04cc5d537a2ed6abe5e9adfb7e43f5e42af125a6d8f884fea512fcaa9
+SHA512:
+  metadata.gz: c74f1b178f63da4ba91a2bcbaa6a739bde17e118e04efbf22398aa1c63464f9b545addba4b29fb03568f0972678e1d5434d1765a92fc163e2379727e1ccf38ce
+  data.tar.gz: 9d8d3e6bdf55e874ab300240e27a4253129d388d6c6d126a966165238fdf8e39fe22d210b348874bd678f7bf461b28ff57d58f911c2bd012218a072f390ed2a4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 KindTap
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+## KindTap Platform Library for Ruby
+
+#### This library currently supports generating a signed authorization header which is required to make requests to KindTap Platform APIs.
+
+### Installation
+
+* Add the following to your Gemfile
+
+`gem 'kindtap-platform-ruby', git: 'https://github.com/KindTap/kindtap-platform-ruby.git', tag: '0.1.0'`
+
+### Example using Faraday
+
+#### Important Notes
+
+* the `host` and `x-kt-date` headers are required
+* request body must be a string that matches exactly the body of the HTTP request
+
+```rb
+require 'date'
+require 'faraday'
+require 'json'
+require 'kindtap_platform'
+
+host = 'kindtap-platform-host'
+date = Time.now.utc
+
+path = '/path/to/api/endpoint/'
+service = 'kindtap-platform-service-name'
+key = 'kindtap-client-key'
+secret = 'kindtap-client-secret'
+method = '<http-method>'
+headers = {
+  'Content-Type' => 'application/json',
+  'Host' => host,
+  'X-KT-Date' => KindTapPlatform.stringify_date(date),
+}
+body = JSON.generate({})
+query = {}
+querystring = URI.encode_www_form(query)
+
+headers['Authorization'] = KindTapPlatform.generate_signed_auth_header(
+  service,
+  key,
+  secret,
+  method,
+  path,
+  date,
+  headers,
+  body,
+  query,
+)
+
+session = Faraday.new
+
+response = session.post do |request|
+    request.url "https://#{host}#{path}?#{querystring}"
+    request.headers = headers
+    request.body = body
+end
+
+puts response.body
+```

data/kindtap_platform.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('lib/kindtap_platform/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'kindtap-platform-ruby'
+  spec.version               = KindTapPlatform::VERSION
+  spec.authors               = ['Jeff Trudeau']
+  spec.email                 = ['jeff@kindtap.com']
+  spec.summary               = 'Facilitates integration with KindTap Platform'
+  spec.description           = 'This library currently supports generating a signed authorization header which is required to make requests to KindTap Platform APIs.'
+  spec.homepage              = 'https://github.com/KindTap/kindtap-platform-ruby'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  #spec.required_ruby_version = '~> 2.7'
+  spec.files = Dir[
+    'Gemfile',
+    'kindtap_platform.gemspec',
+    'lib/**/*.rb',
+    'LICENSE',
+    'README.md',
+  ]
+  spec.extra_rdoc_files = [
+    'README.md',
+  ]
+end

data/lib/kindtap_platform/version.rb

@@ -0,0 +1,3 @@
+module KindTapPlatform
+  VERSION = '0.1.0'
+end

data/lib/kindtap_platform.rb

@@ -0,0 +1,118 @@
+module KindTapPlatform
+  DEBUG = false
+
+  class << self
+    ALGO_PRE = "KT1"
+    ALGO = "#{ALGO_PRE}-HMAC-SHA256"
+    AUTH_TYPE = "#{ALGO_PRE.downcase}_request"
+    REGION = "us"
+
+    EQUALS_ENC = URI.encode_www_form_component("=")
+
+    EQUALS_EXPR = /=/
+    MULTI_WS_EXPR = /[ ][ ]+/
+
+    def HMACSHA256(key, data)
+      OpenSSL::HMAC.digest("SHA256", key, data)
+    end
+
+    def SHA256(data)
+      OpenSSL::Digest.hexdigest("SHA256", data)
+    end
+
+    def build_canon_headers(headers)
+      parsed = headers.reduce({}) { |acc, (k, v)|
+        acc.merge({ k.to_s.downcase => v.to_s.gsub(MULTI_WS_EXPR, " ") })
+      }
+      sorted = parsed.sort_by { |k, v| k.to_s.ord }
+      sorted.reduce("") { |acc, cur| acc += "#{cur[0]}:#{cur[1]}\n" }
+    end
+
+    def build_canon_query(params)
+      parsed = params.reduce({}) { |acc, (k, v)|
+        acc.merge({ k.to_s => v.to_s.gsub(EQUALS_EXPR, EQUALS_ENC) })
+      }
+      sorted = parsed.sort_by { |k, v| k.to_s.ord }
+      encoded = sorted.reduce([]) { |acc, cur|
+        acc.push("#{URI.encode_www_form_component(cur[0])}=#{URI.encode_www_form_component(cur[1])}")
+      }
+      encoded.join("&")
+    end
+
+    def build_canon_uri(uri)
+      parts = uri.split("/").filter { |p| p.length > 0 }
+      if parts.length == 0
+        return "/"
+      end
+      encoded = parts.reduce([]) { |acc, cur|
+        acc.push(URI.encode_www_form_component(URI.encode_www_form_component(cur)))
+      }
+      "/#{encoded.join("/")}/"
+    end
+
+    def build_signed_headers(headers)
+      parsed = headers.reduce([]) { |acc, cur| acc.push([cur[0].downcase]) }
+      parsed.join(";")
+    end
+
+    def debug(*args)
+      if KindTapPlatform::DEBUG
+        puts args
+      end
+    end
+
+    def generate_signature_v1(service, secret, method, uri, date, headers, body, params)
+      canon_headers = build_canon_headers(headers)
+      debug({ "canon_headers" => canon_headers })
+      canon_query = build_canon_query(params)
+      debug({ "canon_query" => canon_query })
+      canon_uri = build_canon_uri(uri)
+      debug({ "canon_uri" => canon_uri })
+      signed_headers = build_signed_headers(headers)
+      debug({ "signed_headers" => signed_headers })
+
+      canon_request = [
+        method.upcase,
+        canon_uri,
+        canon_query,
+        canon_headers,
+        signed_headers,
+        SHA256(body),
+      ].join("\n")
+      debug({ "canon_request" => canon_request })
+      canon_request_hash = SHA256(canon_request)
+      debug({ "canon_request_hash" => canon_request_hash })
+
+      cred_date = stringify_date(date, false)
+      cred_scope = "#{cred_date}/#{REGION}/#{service}/#{AUTH_TYPE}"
+
+      msg_to_sign = [
+        ALGO,
+        stringify_date(date),
+        cred_scope,
+        canon_request_hash,
+      ].join("\n")
+      debug({ "msg_to_sign" => msg_to_sign })
+
+      k0 = HMACSHA256("#{ALGO_PRE}#{secret}", cred_date)
+      k1 = HMACSHA256(k0, REGION)
+      k2 = HMACSHA256(k1, service)
+      k3 = HMACSHA256(k2, AUTH_TYPE)
+
+      HMACSHA256(k3, msg_to_sign).unpack("H*")[0]
+    end
+
+    def generate_signed_auth_header(service, key, secret, method, uri, date, headers, body, params)
+      cred_date = stringify_date(date, false)
+      cred_scope = "#{cred_date}/#{REGION}/#{service}/#{AUTH_TYPE}"
+      signed_headers = build_signed_headers(headers)
+      signature = generate_signature_v1(service, secret, method, uri, date, headers, body, params)
+      debug({ "signature" => signature })
+      "#{ALGO} Credential=#{key}/#{cred_scope}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+    end
+
+    def stringify_date(date, full = true)
+      date.strftime(full ? "%Y%m%dT%H%M%SZ" : "%Y%m%d")
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: kindtap-platform-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Trudeau
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-22 00:00:00.000000000 Z
+dependencies: []
+description: This library currently supports generating a signed authorization header
+  which is required to make requests to KindTap Platform APIs.
+email:
+- jeff@kindtap.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- kindtap_platform.gemspec
+- lib/kindtap_platform.rb
+- lib/kindtap_platform/version.rb
+homepage: https://github.com/KindTap/kindtap-platform-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Facilitates integration with KindTap Platform
+test_files: []