evervault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e83fca85d13b65463d59ce895338341fc504f961f148bb674df43412896f621
+  data.tar.gz: 7737c63198b95422dde627271577ec1b16428604b680751b016062cd6cee8b7c
+SHA512:
+  metadata.gz: e3d1977f9f8350c320ec115311f42671c00b360dd9623a3a2e8f3e769ed7b1b6576eeb5db5b0b7140557a627927e542a3cb6c3375ecad813a1515dd2b4ec2646
+  data.tar.gz: c5b31592a06d3dacb5cc1225cfc69fba44d88757e8c28f0209787a9641a0c0b6b99f6bf5b45b01031bbe91e823ae8bebda340f871b476ad498094f0229dab11d

data/.github/workflows/run-tests.yml

@@ -0,0 +1,23 @@
+name: Run test matrix
+on:
+  push:
+    branches:
+      - "**"
+      - "!master"
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7, jruby, jruby-head, truffleruby]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# JetBrains
+.idea/
+
+# VSCode
+.vscode/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in evervault.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "pry"
+gem "typhoeus"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    evervault (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  evervault!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  typhoeus
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jonny
+
+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,233 @@
+# Evervault
+
+Ruby SDK for [Evervault](https://evervault.com)
+
+## Getting Started
+
+### Prerequisites
+
+To get started with the Evervault Python SDK, you will need to have created a team on the evervault dashboard.
+
+We are currently in invite-only early access. You can apply for early access [here](https://evervault.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evervault'
+```
+
+And then execute:
+```sh
+     bundle install
+```
+Or install it yourself as:
+```sh
+     gem install evervault
+```
+
+## Setup
+
+Evervault can be initialized as a singleton throughout the lifecycle of your application.
+```ruby
+require "evervault"
+
+# Initialize the client with your team's api key
+Evervault.api_key = <YOUR-API-KEY>
+
+# Encrypt your data and run a cage
+result = Evervault.encrypt_and_run(<CAGE-NAME>, { hello: 'World!' })
+```
+
+It's recommended to re-use your Evervault client, to prevent additional overhead of loading keys at runtime, so the singleton pattern should be the go-to pattern for most use-cases.
+
+However, if you'd prefer to initialize different clients at different times, for example, if you have multiple teams and need to switch context, you can simply create a client:
+```ruby
+require "evervault"
+
+# Initialize the client with your team's api key
+evervault = Evervault::Client.new(api_key: <YOUR-API-KEY>)
+
+# Encrypt your data and run a cage
+result = evervault.encrypt_and_run(<CAGE-NAME>, { hello: 'World!' })
+```
+
+## API Reference
+
+### evervault.encrypt
+
+Encrypt lets you encrypt data for use in any of your evervault cages. You can use it to store encrypted data to be used in a cage at another time.
+
+```ruby
+Evervault.encrypt(data = Hash | String)
+```
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| data | Hash or String | Data to be encrypted |
+
+### evervault.run
+
+Run lets you invoke your evervault cages with a given payload.
+
+```ruby
+Evervault.run(cage_name = String, data = Hash)
+```
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| cageName | String | Name of the cage to be run |
+| data | Hash | Payload for the cage |
+
+### evervault.encryptAndRun
+
+Encrypt your data and use it as the payload to invoke the cage.
+
+```ruby
+Evervault.encrypt_and_run(cage_name = String, data = Hash)
+```
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| cageName | String | Name of the cage to be run |
+| data | dict | Data to be encrypted |
+
+### evervault.cages
+
+Return a hash of your team's Cage objects in hash format, with cage-name as keys
+
+```ruby
+Evervault.cages
+=> {"hello-cage-chilly-plum"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4438
+   @name="hello-cage-chilly-plum",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="c8a7ed58-4858-4510-a542-43125ccd1183">,
+ "hello-cage-filthy-fuchsia"=>
+  #<Evervault::Models::Cage:0x00007f8b900b43e8
+   @name="hello-cage-filthy-fuchsia",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="9af32d2b-53fa-406a-9abf-6a240648b45b">,
+ "hello-cage-extra-amaranth"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4398
+   @name="hello-cage-extra-amaranth",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="5b99011e-a64d-4af7-bf81-619c8cb8c67f">,
+ "twilio-cage-explicit-salmon"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4348
+   @name="twilio-cage-explicit-salmon",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="55986772-4db7-4695-ba44-1b807290ddea">}
+```
+
+### evervault.cage_list
+
+Return a `CageList` object, containing a list of your team's cages
+
+```ruby
+Evervault.cage_list
+=> #<Evervault::Models::CageList:0x00007f8b900b44b0
+ @cages=
+  [#<Evervault::Models::Cage:0x00007f8b900b4438
+    @name="hello-cage-chilly-plum",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="c8a7ed58-4858-4510-a542-43125ccd1183">,
+   #<Evervault::Models::Cage:0x00007f8b900b43e8
+    @name="hello-cage-filthy-fuchsia",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="9af32d2b-53fa-406a-9abf-6a240648b45b">,
+   #<Evervault::Models::Cage:0x00007f8b900b4398
+    @name="hello-cage-extra-amaranth",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="5b99011e-a64d-4af7-bf81-619c8cb8c67f">,
+   #<Evervault::Models::Cage:0x00007f8b900b4348
+    @name="twilio-cage-explicit-salmon",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="55986772-4db7-4695-ba44-1b807290ddea">,
+   #<Evervault::Models::Cage:0x00007f8b900b42f8
+    @name="hello-cage-collective-aquamarine",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="01691e76-691b-473e-aad5-44bf813ef146">,
+   #<Evervault::Models::Cage:0x00007f8b900b42a8
+    @name="twilio-cage-bored-scarlet",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="dc056e8b-faf3-445b-9c95-0885b983c302">,
+   #<Evervault::Models::Cage:0x00007f8b900b4258
+    @name="hello-cage-front-emerald",
+    @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+    @uuid="a30295e6-91fc-4d1d-837c-ac4c9b87d02d">]>
+```
+
+#### CageList.to_hash
+
+Converts a list of cages to a hash with keys of CageName => Cage Model
+
+```ruby
+Evervault.cage_list.to_hash
+=> {"hello-cage-chilly-plum"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4438
+   @name="hello-cage-chilly-plum",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="c8a7ed58-4858-4510-a542-43125ccd1183">,
+ "hello-cage-filthy-fuchsia"=>
+  #<Evervault::Models::Cage:0x00007f8b900b43e8
+   @name="hello-cage-filthy-fuchsia",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="9af32d2b-53fa-406a-9abf-6a240648b45b">,
+ "hello-cage-extra-amaranth"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4398
+   @name="hello-cage-extra-amaranth",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="5b99011e-a64d-4af7-bf81-619c8cb8c67f">,
+ "twilio-cage-explicit-salmon"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4348
+   @name="twilio-cage-explicit-salmon",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="55986772-4db7-4695-ba44-1b807290ddea">,
+ "hello-cage-collective-aquamarine"=>
+  #<Evervault::Models::Cage:0x00007f8b900b42f8
+   @name="hello-cage-collective-aquamarine",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="01691e76-691b-473e-aad5-44bf813ef146">,
+ "twilio-cage-bored-scarlet"=>
+  #<Evervault::Models::Cage:0x00007f8b900b42a8
+   @name="twilio-cage-bored-scarlet",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="dc056e8b-faf3-445b-9c95-0885b983c302">,
+ "hello-cage-front-emerald"=>
+  #<Evervault::Models::Cage:0x00007f8b900b4258
+   @name="hello-cage-front-emerald",
+   @request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
+   @uuid="a30295e6-91fc-4d1d-837c-ac4c9b87d02d">}
+```
+
+### Evervault::Models::Cage.run
+
+Each Cage model exposes a `run` method, which allows you to run that particular cage.
+
+*Note*: this does not encrypt data before running the cage
+```ruby
+cage = Evervault.cage_list.cages[0]
+cage.run({'name': 'testing'})
+=> {"result"=>{"message"=>"Hello, world!", "details"=>"Please send an encrypted `name` parameter to show cage decryption in action"}, "runId"=>"5428800061ff"}
+```
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| data | Hash | Payload for the cage |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evervault/evervault-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "evervault"
+require "pry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/evervault.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/evervault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evervault"
+  spec.version       = Evervault::VERSION
+  spec.authors       = ["Jonny O'Mahony"]
+  spec.email         = ["jonny@evervault.com"]
+
+  spec.summary       = %q{Ruby SDK to run Evervault Cages}
+  spec.homepage      = "https://evervault.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/evervault/evervault-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/evervault.rb

@@ -0,0 +1,38 @@
+require_relative "evervault/version"
+require_relative "evervault/client"
+require_relative "evervault/errors/errors"
+
+module Evervault
+  class << self
+    attr_accessor :api_key
+
+    def run(cage_name, encrypted_data)
+      client.run(cage_name, encrypted_data)
+    end
+
+    def encrypt_and_run(cage_name, data)
+      client.encrypt_and_run(cage_name, data)
+    end
+
+    def encrypt(data)
+      client.encrypt(data)
+    end
+
+    def cages
+      client.cages
+    end
+
+    def cage_list
+      client.cage_list
+    end
+
+    private def client
+      if api_key.nil?
+        raise Evervault::Errors::AuthenticationError.new(
+                "Please enter your team's API Key"
+              )
+      end
+      @client ||= Evervault::Client.new(api_key: api_key)
+    end
+  end
+end

data/lib/evervault/client.rb

@@ -0,0 +1,50 @@
+require_relative "http/request"
+require_relative "crypto/client"
+require_relative "models/cage_list"
+
+module Evervault
+  class Client
+
+    attr_accessor :api_key, :base_url, :cage_run_url, :request_timeout
+    def initialize(
+      api_key:,
+      base_url: "https://api.evervault.com/",
+      cage_run_url: "https://cage.run/",
+      request_timeout: 30
+    )
+      @api_key = api_key
+      @base_url = base_url
+      @cage_run_url = cage_run_url
+      @request =
+        Evervault::Http::Request.new(
+          api_key: api_key,
+          timeout: request_timeout,
+          base_url: base_url,
+          cage_run_url: cage_run_url
+        )
+      @crypto_client = Evervault::Crypto::Client.new(request: @request)
+    end
+
+    def encrypt(data)
+      @crypto_client.encrypt(data)
+    end
+
+    def run(cage_name, encrypted_data)
+      @request.post(cage_name, encrypted_data, cage_run: true)
+    end
+
+    def encrypt_and_run(cage_name, data)
+      encrypted_data = encrypt(data)
+      run(cage_name, encrypted_data)
+    end
+
+    def cages
+      cage_list.to_hash
+    end
+
+    def cage_list
+      cages = @request.get("cages")
+      @cage_list ||= Evervault::Models::CageList.new(cages: cages["cages"], request: @request)
+    end
+  end
+end

data/lib/evervault/crypto/client.rb

@@ -0,0 +1,102 @@
+require_relative "../errors/errors"
+require_relative "key"
+require "openssl"
+require "base64"
+require "json"
+require "securerandom"
+
+module Evervault
+  module Crypto
+    class Client
+      attr_reader :request
+      def initialize(request:)
+        @request = request
+      end
+
+      def encrypt(data)
+        raise Evervault::Errors::UndefinedDataError.new(
+          "Data is required for encryption"
+        ) if data.nil? || data.empty?
+          
+        if data.instance_of? Hash
+          encrypt_hash(data)
+        elsif encryptable_data?(data)
+          encrypt_string(data)
+        end
+      end
+
+      private def encrypt_string(data)
+        cipher = OpenSSL::Cipher::AES256.new(:GCM).encrypt
+        iv = cipher.random_iv
+        root_key = cipher.random_key
+        cipher.key = root_key
+        cipher.iv = iv
+        encrypted_data = cipher.update(data) + cipher.final
+        encrypted_buffer = encrypted_data + cipher.auth_tag
+        encrypted_key =
+          team_key.public_key.public_encrypt(
+            root_key,
+            OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
+          )
+        data = [encrypted_key, encrypted_buffer, iv].map { |val| Base64.strict_encode64(val) }
+        format(header_type(data), *data)
+      end
+
+      private def encrypt_hash(data)
+        if encryptable_data?(data)
+          return encrypt_string(data)
+        elsif data.instance_of?(Hash)
+          encrypted_data = {}
+          data.each { |key, value| encrypted_data[key] = encrypt_hash(value) }
+          return encrypted_data
+        end
+        data
+      end
+
+      private def encryptable_data?(data)
+        data.instance_of?(String) || data.instance_of?(Array) ||
+          [true, false].include?(data) || data.instance_of?(Integer) ||
+          data.instance_of?(Float)
+      end
+
+      private def team_key
+        @team_key ||= Key.new(public_key: @request.get("cages/key")["key"])
+      end
+
+      private def format(header, encrypted_key, encrypted_data, iv)
+        header =
+          utf8_to_base_64_url(
+            { iss: "evervault", version: 1, datatype: header }.to_json
+          )
+        payload =
+          utf8_to_base_64_url(
+            {
+              cageData: encrypted_key,
+              keyIv: iv,
+              sharedEncryptedData: encrypted_data
+            }.to_json
+          )
+        "#{header}.#{payload}.#{SecureRandom.uuid}"
+      end
+
+      private def utf8_to_base_64_url(data)
+        b64_string = Base64.strict_encode64(data)
+        b64_string.gsub("+", "-").gsub("/", "_")
+      end
+
+      private def header_type(data)
+        if data.instance_of?(Array)
+          return "Array"
+        elsif [true, false].include?(data)
+          return "boolean"
+        elsif data.instance_of?(Hash)
+          return "object"
+        elsif data.instance_of?(Float) || data.instance_of?(Integer)
+          return "number"
+        elsif data.instance_of?(String)
+          return "string"
+        end
+      end
+    end
+  end
+end

data/lib/evervault/crypto/key.rb

@@ -0,0 +1,19 @@
+require "openssl"
+
+module Evervault
+  module Crypto
+    class Key
+      attr_reader :public_key
+      def initialize(public_key:)
+        @public_key = OpenSSL::PKey::RSA.new(format_key(public_key))
+      end
+
+      private def format_key(key)
+        key_header = "-----BEGIN PUBLIC KEY-----\n"
+        key_footer = "-----END PUBLIC KEY-----"
+        return key if key.include?(key_header) && key.include?(key_footer)
+        "#{key_header}#{key.scan(/.{0,64}/).join("\n")}#{key_footer}"
+      end
+    end
+  end
+end

data/lib/evervault/errors/error_map.rb

@@ -0,0 +1,44 @@
+require_relative "errors"
+
+module Evervault
+  module Errors
+    class ErrorMap
+      def self.raise_errors_on_failure(status_code, body)
+        return if status_code < 400
+        case status_code
+        when 404
+          raise ResourceNotFoundError.new("Resource Not Found")
+        when 400
+          raise BadRequestError.new("Bad request")
+        when 401
+          raise AuthenticationError.new("Unauthorized")
+        when 403
+          raise AuthenticationError.new("Forbidden")
+        when 500
+          raise ServerError.new("Server Error")
+        when 502
+          raise BadGatewayError.new("Bad Gateway Error")
+        when 503
+          raise ServiceUnavailableError.new("Service Unavailable")
+        else
+          raise UnexpectedError.new(
+                  self.message_for_unexpected_error_without_type(body)
+                )
+        end
+      end
+
+      private def message_for_unexpected_error_without_type(error_details)
+        if error_details.nil?
+          return(
+            "An unexpected error occurred without message or status code. Please contact Evervault support"
+          )
+        end
+        message = error_details["message"]
+        status_code = error_details["statusCode"]
+        "An unexpected error occured. It occurred with the message: #{
+          message
+        } and http_code: '#{status_code}'. Please contact Evervault support"
+      end
+    end
+  end
+end

data/lib/evervault/errors/errors.rb

@@ -0,0 +1,27 @@
+module Evervault
+  module Errors
+    class EvervaultError < StandardError; end
+
+    class ArgumentError < EvervaultError; end
+
+    class HttpError < EvervaultError; end
+
+    class ResourceNotFoundError < EvervaultError; end
+
+    class AuthenticationError < EvervaultError; end
+
+    class ServerError < EvervaultError; end
+
+    class BadGatewayError < EvervaultError; end
+
+    class ServiceUnavailableError < EvervaultError; end
+
+    class BadRequestError < EvervaultError; end
+
+    class UndefinedDataError < EvervaultError; end
+
+    class InvalidPublicKeyError < EvervaultError; end
+
+    class UnexpectedError < EvervaultError; end
+  end
+end

data/lib/evervault/http/request.rb

@@ -0,0 +1,69 @@
+require "typhoeus"
+require "json"
+require_relative "../version"
+require_relative "../errors/error_map"
+
+module Evervault
+  module Http
+    class Request
+      def initialize(api_key:, base_url:, cage_run_url:, timeout:)
+        @api_key = api_key
+        @timeout = timeout
+        @base_url = base_url
+        @cage_run_url = cage_run_url
+      end
+
+      def get(path, params = nil)
+        execute(:get, build_url(path), params)
+      end
+
+      def put(path, params)
+        execute(:put, build_url(path), params)
+      end
+
+      def delete(path, params)
+        execute(:delete, build_url(path), params)
+      end
+
+      def post(path, params, cage_run: false)
+        execute(:post, build_url(path, cage_run), params)
+      end
+
+      private def build_url(path, cage_run = false)
+        return "#{@base_url}#{path}" unless cage_run
+        "#{@cage_run_url}#{path}"
+      end
+
+      def execute(method, url, params)
+        req =
+          Typhoeus::Request.new(
+            url,
+            method: method, 
+            params: params, 
+            headers: build_headers
+          )
+        req.on_complete do |response|
+          if response.success?
+            return JSON.parse(response.body)
+          else
+            Evervault::Errors::ErrorMap.raise_errors_on_failure(
+              response.code,
+              response.body
+            )
+          end
+        end
+        resp = req.run
+      end
+
+      private def build_headers
+        {
+          "User-Agent": "evervault-ruby/#{VERSION}",
+          "AcceptEncoding": "gzip, deflate",
+          "Accept": "application/json",
+          "Content-Type": "application/json",
+          "Api-Key": @api_key
+        }
+      end
+    end
+  end
+end

data/lib/evervault/models/cage.rb

@@ -0,0 +1,18 @@
+module Evervault
+  module Models
+    class Cage
+
+      attr_reader :name, :uuid
+      def initialize(name:, uuid:, request:)
+        @name = name
+        @uuid = uuid
+        @request = request
+      end
+
+      def run(params)
+        @request.post(self.name, params, cage_run: true)
+      end
+
+    end
+  end
+end

data/lib/evervault/models/cage_list.rb

@@ -0,0 +1,22 @@
+require_relative "cage"
+
+module Evervault
+  module Models
+    class CageList
+      attr_reader :cages
+      def initialize(cages:, request:)
+        @cages = build_cage_list(cages, request)
+      end
+
+      def to_hash
+        cage_hash = {}
+        cages.each { |cage| cage_hash[cage.name] = cage }
+        cage_hash
+      end
+
+      private def build_cage_list(cages, request)
+        cages.map { |cage| Cage.new(name: cage["name"], uuid: cage["uuid"], request: request) }
+      end
+    end
+  end
+end

data/lib/evervault/version.rb

@@ -0,0 +1,3 @@
+module Evervault
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: evervault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonny O'Mahony
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jonny@evervault.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/run-tests.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evervault.gemspec
+- lib/evervault.rb
+- lib/evervault/client.rb
+- lib/evervault/crypto/client.rb
+- lib/evervault/crypto/key.rb
+- lib/evervault/errors/error_map.rb
+- lib/evervault/errors/errors.rb
+- lib/evervault/http/request.rb
+- lib/evervault/models/cage.rb
+- lib/evervault/models/cage_list.rb
+- lib/evervault/version.rb
+homepage: https://evervault.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://evervault.com
+  source_code_uri: https://github.com/evervault/evervault-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby SDK to run Evervault Cages
+test_files: []