evervault 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d24159a979aa8a8a684447e804ce5280bb03946ff7b81847d3ca34cdc794c488
-  data.tar.gz: 5b5c762a8abab38f848c506acf3674a8b39357d06f4d57c2fd4d71e8949c2886
+  metadata.gz: a38c1eb9f440a16bb8c846d10336b8a394a47bf10cafb4e269a2f69f10cd687f
+  data.tar.gz: 53c2a6ebd6e25749e428b6ae04515cd9ceb8bb3140f65f5850c7dbd604189a81
 SHA512:
-  metadata.gz: 3e4b9c709918dd7623c7c5209d7b0848a9eef6f1c80c016234f266eb9ecca3994229f298e5001b2a14341fe687b52b37672705971366f7d027a2e91f2639528f
-  data.tar.gz: f11ad2a4010f1aaf6f1c11efe6e5fb1fe9db8f4efae07e581de4eaef7af41b8f78adf3e348182c8b65cbad694fe85009786da9da6d5ea7fc4d05fe7142942cae
+  metadata.gz: 6809469590bc323deb1b25c5605e465d4f2e90adfc21d9855236c2d43b1ae468452279bb81aa60a087b65291d8e2b9a755a5aa57ae4495591784771dfb8ff000
+  data.tar.gz: 7d4cfa9cd38b54115b4b6dd5fd2caaa2ff696015ea3ec40543da42391a1c3437da9cdcf99f1b93177b5a5142e93c7f0abec15e93e52a77afb415075579e8a43d

data/.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "privatePackages": {
+    "version": true,
+    "tag": true
+  }
+}

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: '/'
+    schedule:
+      interval: weekly
+  # Github Actions
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: weekly

data/.github/workflows/e2e.yml

@@ -0,0 +1,25 @@
+name: evervault-e2e-tests
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: [3.0, 3.1, 3.2]
+    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 e2e_tests
+        env:
+          EVERVAULT_APP_UUID: ${{ secrets.EV_APP_UUID }}
+          EVERVAULT_API_KEY: ${{ secrets.EV_API_KEY }}
+          EVERVAULT_FUNCTION_NAME: ${{ secrets.EV_FUNCTION_NAME }}
+          EVERVAULT_INITIALIZATION_ERROR_FUNCTION_NAME: ${{ secrets.EV_INITIALIZATION_ERROR_FUNCTION_NAME }}
+          EVERVAULT_SYNTHETIC_ENDPOINT_URL: ${{ secrets.EVERVAULT_SYNTHETIC_ENDPOINT_URL }}

data/.github/workflows/linters.yml

@@ -0,0 +1,23 @@
+name: Linters
+on:
+  - pull_request
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Cache gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-rubocop-
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel --only Layout

data/.github/workflows/release.yml

@@ -1,39 +1,58 @@
-name: Publish Gem
-
+name: Release
 on:
   push:
-    tags:
-      - v*
-
+    branches:
+      - master
+      - main
 jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu, macos]
-        ruby: [2.6, 2.7, 3.1, 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
-
-  build:
+  release:
     runs-on: ubuntu-latest
-    needs: test
-    
     steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Get tags
+        run: git fetch --tags origin
+      - name: Install Node Dependencies
+        run: npm install
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - name: Release Gem
-        if: contains(github.ref, 'refs/tags/v')
-        run: ./scripts/release.sh
+          ruby-version: 3.0
+      - name: Create Release Pull Request
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          title: 'New Release'
+          commit: 'Release new version'
+          version: npm run version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Create new release
+        if: steps.changesets.outputs.hasChangesets == 'false'
+        run: |
+          npx changeset tag && git push origin --tags
+          COMMIT_TAG=$(git tag --points-at HEAD)
+          if [ -n "$COMMIT_TAG" ]; then
+            echo "A tag is attached to HEAD. Creating a new release..."
+            echo "${{ secrets.GH_TOKEN }}" | gh auth login --with-token
+            CHANGELOG=$(awk '
+              BEGIN { recording=0; }
+              /^## / {
+                  if(recording) { exit; }
+                  recording=1;
+                  next;
+              }
+              recording {
+                  print;
+              }
+            ' CHANGELOG.md)
+            gh release create $COMMIT_TAG -t "$COMMIT_TAG" -n "$CHANGELOG"
+            sh ./scripts/release.sh
+          else
+            echo "No tag attached to HEAD. No new release needed."
+          fi
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

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

@@ -1,19 +1,19 @@
 name: evervault-unit-tests
 on: [push]
-
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, macos]
-        ruby: [2.6, 2.7, 3.1, truffleruby]
+        os: [ubuntu]
+        ruby: [3.0, 3.1, 3.2]
     runs-on: ${{ matrix.os }}-latest
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    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
+      - run: bundle exec rake unit_tests

data/.gitignore

@@ -10,6 +10,7 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+.rspec_status_e2e
 
 # rbenv
 .ruby_version
@@ -18,4 +19,9 @@ Gemfile.lock
 .idea/
 
 # VSCode
-.vscode/
+.vscode/
+
+# node_modules
+/node_modules/
+package-lock.json
+.env

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# evervault-ruby
+
+## 3.0.1
+
+### Patch Changes
+
+- 55a80b9: tidy up string encryption
+- 55a80b9: Improved API for configuring the Evervault::Client.
+
+  Previously there was no way to set the curve used for encryption. This can now
+  be configured via the .configure method.
+
+  ```
+  Evervault.configure do |config|
+    config.curve = "secp256k1"
+  end
+  ```
+
+## 3.0.0
+
+### Major Changes
+
+- f4d3d01: Simplifying errors thrown by the SDK.
+
+  Previously we exposed many different error types for users to handle, but in most cases these errors were not something that could be caught and handled, but were rather indicative of a larger configuration issue. This change simplifies the errors thrown by returning an EvervaultError with accompanying error message by default, unless they are a transient error which can be handled programmatically, in which case a specific error is returned.
+
+- dd84f66: We have dropped support for Ruby 2.6 and 2.7 as they are now both in end of life status.
+  See more: https://www.ruby-lang.org/en/downloads/branches
+- b2188aa: Migrated Function run requests to new API.
+
+  We have released a new API for Function run requests which is more robust, more extensible, and which provides more useful error messages when Function runs fail. In addition, we have removed async Function run requests and specifying the version of the Function to run. For more details check out https://docs.evervault.com/sdks/ruby#run()
+
+### Minor Changes
+
+- b7f5c1a: The `encrypt` function has been enhanced to accept an optional Data Role.
+
+  This role, once specified, is associated with the data upon encryption. Data Roles can be created in the Evervault Dashboard (Data Roles section) and provide a mechanism for setting clear rules that dictate how and when data, tagged with that role, can be decrypted. For more details check out https://docs.evervault.com/sdks/ruby#encrypt()
+
+  Evervault.encrypt("hello world!", "allow-all");
+
+### Patch Changes
+
+- 7d91003: Add Faraday as a gem dependency

data/Gemfile

@@ -1,12 +1,15 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in evervault.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "pry"
-gem "webmock"
-gem "gem-release"
-gem "faraday"
-gem "rexml"
+gem 'faraday'
+gem 'gem-release'
+gem 'pry'
+gem 'rake', '~> 12.0'
+gem 'rexml'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'webmock'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Jonny
+Copyright (c) 2020 Evervault
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,173 +4,7 @@
 
 # Evervault Ruby SDK
 
-The [Evervault](https://evervault.com) Ruby SDK is a toolkit for encrypting data as it enters your server, working with Functions, and proxying your outbound API requests to specific domains through [Outbound Relay](https://docs.evervault.com/concepts/outbound-relay/overview) to allow them to be decrypted before reaching their target.
-
-## Getting Started
-
-Before starting with the Evervault Ruby SDK, you will need to [create an account](https://app.evervault.com/register) and a team.
-
-For full installation support, [book time here](https://calendly.com/evervault/support).
-
-## Documentation
-
-See the Evervault [Ruby SDK documentation](https://docs.evervault.com/reference/ruby-sdk).
-
-## Installation
-
-There are two ways to install the Ruby SDK.
-
-#### 1. With Gemfile
-
-Add this line to your application's `Gemfile`:
-
-```ruby
-gem 'evervault'
-```
-
-Then, run:
-
-```sh
-bundle install
-```
-#### 2. By yourself
-
-Just run:
-
-```sh
-gem install evervault
-```
-
-## Setup
-
-To make Evervault available for use in your app:
-
-```ruby
-require "evervault"
-
-# Initialize the client with your App's ID and App's API key
-Evervault.app_id = <YOUR-APP-ID>
-Evervault.api_key = <YOUR-API-KEY>
-
-# Encrypt your data
-encrypted_data = Evervault.encrypt('Hello World!')
-
-# Decrypt your data
-decrypted = Evervault.decrypt(encrypted_data)
-
-# Process the encrypted data using a Function
-result = Evervault.run(<FUNCTION-NAME>, encrypted_data)
-
-# Send the decrypted data to a third-party API
-Evervault.enable_outbound_relay
-uri = URI('https://example.com')
-req = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
-req.body = encrypted_data.to_json
-http = Net::HTTP.new(uri.host, uri.port)
-http.use_ssl = true
-res = http.request(req)
-
-```
-
-## Reference
-
-The Evervault Ruby SDK exposes four methods.
-
-### Evervault.encrypt
-
-`Evervault.encrypt` encrypts data for use in your [Evervault Functions](https://docs.evervault.com/concepts/functions/overview). To encrypt data on your server, simply pass a supported value into the `Evervault.encrypt` method and then you can store the encrypted data in your database as normal.
-
-```ruby
-Evervault.encrypt(data = String | Number | Boolean | Hash | Array)
-```
-
-| Parameter | Type                                           | Description          |
-| --------- | ---------------------------------------------- | -------------------- |
-| data      | `String`, `Number`, `Boolean`, `Hash`, `Array` | Data to be encrypted |
-
-### Evervault.decrypt
-
-`Evervault.decrypt` decrypts data previously encrypted with the `encrypt()` function or through Evervault's Relay (Evervault's encryption proxy).
-An API Key with the `decrypt` permission must be used to perform this operation.
-
-```ruby
-Evervault.decrypt(data = String | Array | Hash)
-```
-
-| Parameter | Type                      | Description          |
-| --------- | ------------------------- | -------------------- |
-| data      | `String`, `Array`, `Hash` | Data to be decrypted |
-
-### Evervault.create_client_side_decrypt_token
-`Evervault.create_client_side_token` is used to generate a time-bound token that can be used by front-end applications to decrypt Evervault encrypted data. 
-
-```ruby
-time_now = Time.now
-time_in_five_minutes = time_now + 300
-Evervault.create_client_side_decrypt_token(encrypted_data, time_in_five_minutes)
-```
-
-| Parameter | Type                      | Description                                                                                                                        |
-| --------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-| data      | `String`, `Array`, `Hash` | The payload the token can be used to decrypt.                                                                                      |
-| expiry    | `Time`                    | Optional -- The time the token should expire. The max expiry is 10 minutes in the future. If not supplied it defaults to 5 minutes |
-
-
-### Evervault.enable_outbound_relay
-
-`Evervault.enable_outbound_relay` configures your application to proxy HTTP requests using Outbound Relay based on the configuration created in the Evervault UI. See [Outbound Relay](https://docs.evervault.com/concepts/outbound-relay/overview) to learn more.
-
-```ruby
-Evervault.enable_outbound_relay([decryption_domains = Array])
-```
-
-| Parameter | Type | Description |
-| --------- | ---- | ----------- |
-| decryption_domains | `Array` | Optional -- Requests sent to any of the domains listed will be proxied through Outbound Relay. This will override the configuration created using the Evervault UI. |
-
-### Evervault.run
-
-`Evervault.run` invokes a Function with a given payload.
-An API Key with the `run Function` permission must be used to perform this operation.
-
-```ruby
-Evervault.run(function_name = String, data = Hash[, options = Hash])
-```
-
-| Parameter | Type | Description |
-| --------- | ---- | ----------- |
-| function_name | String | Name of the Function to be run |
-| data | Hash | Payload for the Function |
-| options | Hash | [Options for the Function run](#Function-Run-Options) |
-
-#### Function Run Options
-
-| Option | Type | Default | Description |
-| ------ | ---- | ------- | ----------- |
-| `async` | `Boolean` | `false` | Run your Function in async mode. Async Function runs will be queued for processing. |
-| `version` | `Integer` | `nil` | Specify the version of your Function to run. By default, the latest version will be run. |
-
-### Evervault.create_run_token
-
-`Evervault.create_run_token` creates a single use, time bound token for invoking a Function.
-An API Key with the `create Run Token` permission must be used to perform this operation.
-
-```ruby
-Evervault.create_run_token(function_name = String, data = Hash)
-```
-
-| Parameter | Type   | Description                                          |
-| --------- | ------ | ---------------------------------------------------- |
-| function_name | String | Name of the Function the run token should be created for |
-| data      | Hash   | Payload that the token can be used with              |
-
-## 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).
-
-[Rbenv](https://github.com/rbenv/rbenv) can also be used to install specific versions of Ruby.
+See the Evervault [Ruby SDK documentation](https://docs.evervault.com/sdks/ruby) to learn how to install, set up, and use the SDK.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,23 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task :default => :spec
+task :e2e_tests do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/e2e/*_spec.rb'
+  end
+  Rake::Task['spec'].execute
+end
+
+task :unit_tests do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/evervault_spec.rb, spec/evervault/**/*_spec.rb'
+  end
+  Rake::Task['spec'].execute
+end
+
+task :default do
+  RSpec::Core::RakeTask.new(:spec)
+  Rake::Task['spec'].execute
+end

data/bin/console

@@ -1,8 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "evervault"
-require "pry"
+require 'dotenv'
+Dotenv.load
+
+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.
@@ -11,5 +15,4 @@ require "pry"
 # require "pry"
 # Pry.start
 
-require "pry"
 Pry.start

data/evervault.gemspec

@@ -1,25 +1,31 @@
+# frozen_string_literal: true
+
 require_relative 'lib/evervault/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "evervault"
+  spec.name          = 'evervault'
   spec.version       = Evervault::VERSION
-  spec.authors       = ["Jonny O'Mahony"]
-  spec.email         = ["jonny@evervault.com"]
+  spec.authors       = ['Evervault']
+  spec.email         = 'support@evervault.com'
+  spec.summary       = 'Ruby SDK to run Evervault'
+  spec.homepage      = 'https://evervault.com'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
 
-  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'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/evervault/evervault-ruby"
+  spec.add_dependency 'faraday', ['>= 2.0', '< 3.0']
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'simplecov'
 end