fortress-sdk-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2b2221413093ee926090ed325be2a137e31240ef76d1bd04b9084359a45d9e1
+  data.tar.gz: b01bd23f81ed9baded9782cbb5b4ea24d95a17ac62058f6de3124132863c37ea
+SHA512:
+  metadata.gz: 9cae26f44e083b8e864717f137ec7c4f1fd09c909a3e2a50d688c6e4173aadb189b8df024b447184c34093fcafb685f61403bb847a4368ae23715a685ec06585
+  data.tar.gz: 0c7c28977e775ce3fee1cea2fb4513adbc15a4959c903ca46e906107bb27a1a3e8d88e2a4c661966944b180bc45099053d079c10df21dfdd5e252a314dbbc152

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fortress
+
+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,69 @@
+# Fortress Ruby SDK
+
+Welcome to the Fortress Ruby SDK. This SDK provides a way for you to leverage the power of the Fortress platform in your Ruby applications.
+
+## Installation
+
+You can install the SDK using Gem. Simply run the following command:
+
+```bash
+gem install fortress_sdk_ruby
+```
+
+## Quick Start
+
+Here is a quick example to get you started with the SDK:
+
+```ruby
+require 'fortress_sdk_ruby'
+
+# Initialize the client
+client = Fortress::Client.new(api_key, organization_id)
+
+# Create a new tenant
+client.create_tenant("tenant_name", "alias")
+
+# Connect to the tenant
+conn = client.connect_tenant("tenant_name")
+
+conn.exec('CREATE TABLE users (id SERIAL PRIMARY KEY, name VARCHAR(50))')
+conn.exec("INSERT INTO users (name) VALUES ('Alice')")
+conn.exec('SELECT * FROM users') do |result|
+  result.each do |row|
+    print "User: #{row['name']}\n"
+  end
+end
+
+# Delete the tenant
+client.delete_tenant("tenant_name")
+```
+
+## Documentation
+
+Below is a list of the available functionality in the SDK. Using the SDK you can create a new tenants and point them to existing or new databases. You can also easily route data requests based on tenant names. For more detailed information, please refer to the [Fortress API documentation](https://docs.fortress.build).
+
+Database Management:
+
+- `create_database(database_name: str, alias: str)`: Creates a new database.
+- `delete_database(database_name: str)`: Deletes to a database.
+- `list_databases()`: Lists all databases.
+- `connect_database(database_id: str)`: Connects to a database and turns into SQL connection.
+
+Tenant Management:
+
+- `create_tenant(tenant_name: str, alias: str, database_id: str = "")`: Creates a new tenant.
+- `delete_tenant(tenant_name: str)`: Deletes a tenant.
+- `list_tenants()`: Lists all tenants.
+- `connect_tenant(tenant_name: str)`: Connects to a tenant and turns into SQL connection.
+
+## Configuration
+
+To use the SDK, generate an API key from the Fortress dashboard to initialize the client. Also, provide the organization ID, which is available under the API Keys page on the platform website.
+
+## License
+
+This SDK is licensed under the MIT License.
+
+## Support
+
+If you have any questions or need help, don't hesitate to get in touch with our support team at founders@fortress.build.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/examples/test.rb

@@ -0,0 +1,27 @@
+require_relative 'lib/fortress'
+
+# Create a client
+client = Fortress::Fortress.new('orgId', 'apiKey')
+
+# Create a database
+id = client.create_database('Client 1')
+
+# Create a tenant in that database
+client.create_tenant('client1', 'Client 1', id)
+
+# List all tenants
+client.list_tenants.each do |tenant|
+  print "Tenant: #{tenant.name} (#{tenant.alias})\n"
+end
+
+# Connect to the tenant
+conn = client.connect_tenant('client1')
+conn.exec('CREATE TABLE users (id SERIAL PRIMARY KEY, name VARCHAR(50))')
+conn.exec("INSERT INTO users (name) VALUES ('Alice')")
+conn.exec("INSERT INTO users (name) VALUES ('Bob')")
+conn.exec("INSERT INTO users (name) VALUES ('Charlie')")
+conn.exec('SELECT * FROM users') do |result|
+  result.each do |row|
+    print "User: #{row['name']}\n"
+  end
+end

data/lib/crypto.rb

@@ -0,0 +1,68 @@
+require 'openssl'
+require 'base64'
+require 'digest'
+require 'hmac'
+require 'hmac-sha1'
+
+module Fortress
+  # Crypto provides methods to encrypt and decrypt data using the ECIES algorithm.
+  module Crypto
+    # Decrypts the ciphertext using the provided private key.
+    def self.decrypt(private_key, ciphertext)
+      # Format the private key
+      formated_private_key = "-----BEGIN EC PRIVATE KEY-----\n#{private_key}\n-----END EC PRIVATE KEY-----"
+
+      # Load the private key
+      private_key = OpenSSL::PKey::EC.new(formated_private_key)
+      private_key.check_key
+
+      # Decode the ciphertext
+      ciphertext = Base64.decode64(ciphertext)
+
+      # Extract the ephemeral public key
+      ephemeral_size = ciphertext[0].ord
+      ephemeral_public_key = ciphertext[1, ephemeral_size]
+
+      # Extract the MAC and AES-GCM ciphertext
+      sha1_size = 20
+      aes_size = 16
+      ciphertext = ciphertext[(1 + ephemeral_size)..-1]
+
+      # Verify the ciphertext length
+      raise 'Invalid ciphertext' if ciphertext.length < sha1_size + aes_size
+
+      # Derive the public key
+      eph_pub = OpenSSL::PKey::EC::Point.new(OpenSSL::PKey::EC::Group.new('prime256v1'),
+                                             OpenSSL::BN.new(ephemeral_public_key, 2))
+
+      # Perform the ECDH key exchange
+      shared_key = private_key.dh_compute_key(eph_pub)
+
+      # Derive the shared key
+      shared = Digest::SHA256.digest(shared_key)
+
+      # Verify the MAC
+      tag_start = ciphertext.length - sha1_size
+      hmac = HMAC::SHA1.new(shared[16, 16])
+      hmac.update(ciphertext[0, tag_start])
+      mac = hmac.digest
+
+      raise 'Invalid MAC' unless mac == ciphertext[tag_start..-1]
+
+      # Decrypt the ciphertext using AES-CBC
+      cipher = OpenSSL::Cipher.new('aes-128-cbc')
+      cipher.decrypt
+      cipher.key = shared[0, 16]
+      cipher.iv = ciphertext[0, aes_size]
+      cipher.padding = 0
+
+      plaintext = cipher.update(ciphertext[aes_size, tag_start - aes_size]) + cipher.final
+
+      # Remove padding
+      padding_length = plaintext[-1].ord
+      plaintext = plaintext[0...-padding_length]
+
+      plaintext.force_encoding('UTF-8')
+    end
+  end
+end

data/lib/fortress/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fortress
+  VERSION = '0.1.1'
+end

data/lib/fortress.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require_relative 'fortress/version'
+require_relative 'crypto'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'base64'
+require 'pg'
+
+# Fortress is a Ruby client for the Fortress API.
+#
+# It provides methods to manage tenants and databases in the Fortress platform.
+#
+# @example
+#   fortress = Fortress.new('org_id', 'api_key')
+#
+module Fortress
+  class Error < StandardError; end
+
+  # Define the Tenant struct here
+  Tenant = Struct.new(:name, :alias, :database_id, :date_created) do
+    def to_json(*_args)
+      { id:, alias: self.alias }.to_json
+    end
+  end
+
+  # Define the Database struct here
+  Database = Struct.new(:id, :alias, :bytes_size, :average_read_iops, :average_write_iops, :date_created) do
+    def to_json(*_args)
+      { id:, alias: self.alias }.to_json
+    end
+  end
+
+  # Client provides methods to interact with the Fortress API.
+  # It requires an organization ID and an API key to authenticate requests.
+  class Fortress
+    BASE_URL = 'https://api.fortress.build'
+    attr_reader :org_id, :api_key
+
+    # Create a new Fortress client.
+    # @param org_id [String] The organization ID.
+    # @param api_key [String] The API key.
+    # @return [Fortress] The Fortress client.
+    def initialize(org_id, api_key)
+      @org_id = org_id
+      @api_key = api_key
+    end
+
+    # Connect to a tenant.
+    # @param id [String] The tenant ID.
+    # @return [PG::Connection] The connection to the tenant database.
+    def connect_tenant(id)
+      connection_details = get_connection_uri(id, 'tenant')
+      PG::Connection.new(dbname: connection_details.database, user: connection_details.username,
+                         password: connection_details.password, host: connection_details.url, port: connection_details.port)
+    end
+
+    # Create a tenant in a database.
+    # @param id [String] The tenant ID.
+    # @param tenant_alias [String] The tenant alias.
+    # @param database_id [String] The database ID. (optional)
+    # @return [void]
+    def create_tenant(id, tenant_alias, database_id = nil)
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/tenant/#{id}"
+      body = { alias: tenant_alias }
+      body[:databaseId] = database_id if database_id
+      _ = make_request(:post, endpoint, body)
+    end
+
+    # List all tenants in the organization.
+    # @return [Array<Tenant>] The list of tenants.
+    def list_tenants
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/tenants"
+      response = make_request(:get, endpoint)
+      tenants = response['tenants']
+      tenants.map do |tenant|
+        Tenant.new(tenant['name'], tenant['alias'], tenant['databaseId'], tenant['dateCreated'])
+      end
+    end
+
+    # Delete a tenant.
+    # @param id [String] The tenant ID.
+    # @return [void]
+    def delete_tenant(id)
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/tenant/#{id}"
+      _ = make_request(:delete, endpoint)
+    end
+
+    # Connect to a database.
+    # @param id [String] The database ID.
+    # @return [PG::Connection] The connection to the database.
+    def connect_database(id)
+      connection_details = get_connection_uri(id, 'database')
+      PG::Connection.new(dbname: connection_details.database, user: connection_details.username,
+                         password: connection_details.password, host: connection_details.url, port: connection_details.port)
+    end
+
+    # Create a database.
+    # @param database_alias [String] The database alias.
+    # @return [String] The database ID.
+    def create_database(database_alias)
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/database"
+      response = make_request(:post, endpoint, { alias: database_alias })
+      response['id']
+    end
+
+    # List all databases in the organization.
+    # @return [Array<Database>] The list of databases.
+    def list_databases
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/databases"
+      response = make_request(:get, endpoint)
+      databases = response['databases']
+      databases.map do |database|
+        Database.new(database['id'], database['alias'], database['bytesSize'],
+                     database['averageReadIOPS'], database['averageWriteIOPS'], database['dateCreated'])
+      end
+    end
+
+    # Delete a database.
+    # @param id [String] The database ID.
+    def delete_database(id)
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/database/#{id}"
+      _ = make_request(:delete, endpoint)
+    end
+
+    private
+
+    ConnectionDetails = Struct.new(:database_id, :url, :port, :username, :password, :database) do
+      def to_json(*_args)
+        { database_id:, url:, port:, username:, password:, database: }.to_json
+      end
+    end
+
+    def get_connection_uri(id, type)
+      endpoint = "#{BASE_URL}/v1/organization/#{@org_id}/#{type}/#{id}/uri"
+
+      response = make_request(:get, endpoint)
+      connection_details_encrypted = response['connectionDetails']
+      connection_details_decrypted = Crypto.decrypt(@api_key, connection_details_encrypted)
+      connection_details = JSON.parse(connection_details_decrypted)
+      ConnectionDetails.new(connection_details['databaseId'].to_i, connection_details['url'],
+                            connection_details['port'].to_i, connection_details['username'], connection_details['password'], connection_details['database'])
+    end
+
+    def make_request(method, url, body = nil)
+      uri = URI.parse(url)
+
+      request = Net::HTTP.const_get(method.capitalize).new(uri)
+      request['Content-Type'] = 'application/json'
+      request['Api-Key'] = @api_key
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      # TODO: Enable SSL
+      http.use_ssl = true
+
+      request.body = body.to_json if body
+
+      parse_response(http.request(request))
+    end
+
+    def parse_response(response)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        raise Error, "Request failed with response code #{response.code}: #{response.message}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: fortress-sdk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Fortress
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-22 00:00:00.000000000 Z
+dependencies: []
+description: This is the official Ruby SDK for Fortress. It provides a simple way
+  to interact with the Fortress API.
+email:
+- founder@fortress.build
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- examples/test.rb
+- lib/crypto.rb
+- lib/fortress.rb
+- lib/fortress/version.rb
+homepage: https://fortress.build
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://fortress.build
+  source_code_uri: https://github.com/fortress-build/sdk-ruby
+  changelog_uri: https://github.com/fortress-build/sdk-python
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: The Fortress SDK for Ruby
+test_files: []