evervault 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e666a2b2b7d130e4221e2c25f963fdd6a3e7e986f08127be6f3937ab7f94e52
-  data.tar.gz: dbd8034681606769295e1a2678b019c02f7600b96918c6bb737a5ad0bb9f0616
+  metadata.gz: e3b50c9b63dbb48205dd12e7f25a7df7bde49ccee2945a4a40f999d635d14ca4
+  data.tar.gz: d5582b0e9be47496c09d01581a00e6e3cfd6abf824d8bb57275f3fcd7800ac1d
 SHA512:
-  metadata.gz: 4830d141e96f9b47a65a581bd214a0cd4d86d440e6f2fdc6f70cd9abd7371f86ef331982d65d3850a19edbc56833994aec8463bc5d55fb0c4ea73c66b6d23abe
-  data.tar.gz: 6d22b0c92ea74e1679513b53431ac7ebe78ba79b215eaea9ebf84062cb2ec45ba4a6e99a1075e66c93a39f9d8c7b1305f0e717c2f9408f4270a7a74d34ab5ca3
+  metadata.gz: c01d3201c76b86f8924c8ee8f90feb77da2d6bca98cebb724c10a75c181f6ab8ac7847686044cdc7e3f57ea84918e7f15d4eb66b6e2d792cffb9b362d5da8988
+  data.tar.gz: e0b570280d96839cf6df0cb8c595bc3e9b23b9f60fcb763f75513af4961bd97ffadfae01de40be5c023cc7390d7cead0f8e3c0b8ce6c67bda36e2d62e12b3b7e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    evervault (0.1.1)
+    evervault (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,7 +12,7 @@
 Ruby SDK for [Evervault](https://evervault.com)
 ### Prerequisites
 
-To get started with the Evervault Ruby SDK, you will need to have created a team on the evervault dashboard.
+To get started with the Evervault Ruby 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).
 
@@ -63,7 +63,7 @@ result = evervault.encrypt_and_run(<CAGE-NAME>, { hello: 'World!' })
 
 ### 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.
+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)
@@ -75,20 +75,28 @@ Evervault.encrypt(data = Hash | String)
 
 ### Evervault.run
 
-Run lets you invoke your evervault cages with a given payload.
+Run lets you invoke your Evervault Cages with a given payload.
 
 ```ruby
-Evervault.run(cage_name = String, data = Hash)
+Evervault.run(cage_name = String, data = Hash[, options = Hash])
 ```
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| cageName | String | Name of the cage to be run |
-| data | Hash | Payload for the cage |
+| cageName | String | Name of the Cage to be run |
+| data | Hash | Payload for the Cage |
+| options | Hash | [Options for the Cage run](#Cage-Run-Options) |
+
+#### Cage Run Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `async` | `Boolean` | `false` | Run your Cage in async mode. Async Cage runs will be queued for processing. |
+| `version` | `Integer` | `nil` | Specify the version of your Cage to run. By default, the latest version will be run. |
 
 ### Evervault.encrypt_and_run
 
-Encrypt your data and use it as the payload to invoke the cage.
+Encrypt your data and use it as the payload to invoke the Cage.
 
 ```ruby
 Evervault.encrypt_and_run(cage_name = String, data = Hash)
@@ -96,7 +104,7 @@ Evervault.encrypt_and_run(cage_name = String, data = Hash)
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| cageName | String | Name of the cage to be run |
+| cageName | String | Name of the Cage to be run |
 | data | dict | Data to be encrypted |
 
 ### Evervault.cages
@@ -129,7 +137,7 @@ Evervault.cages
 
 ### Evervault.cage_list
 
-Return a `CageList` object, containing a list of your team's cages
+Return a `CageList` object, containing a list of your team's Cages
 
 ```ruby
 Evervault.cage_list
@@ -167,7 +175,7 @@ Evervault.cage_list
 
 #### CageList.to_hash
 
-Converts a list of cages to a hash with keys of CageName => Cage Model
+Converts a list of Cages to a hash with keys of CageName => Cage Model
 
 ```ruby
 Evervault.cage_list.to_hash
@@ -210,9 +218,9 @@ Evervault.cage_list.to_hash
 
 ### Evervault::Models::Cage.run
 
-Each Cage model exposes a `run` method, which allows you to run that particular cage.
+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
+*Note*: this does not encrypt data before running the Cage
 ```ruby
 cage = Evervault.cage_list.cages[0]
 cage.run({'name': 'testing'})
@@ -221,7 +229,8 @@ cage.run({'name': 'testing'})
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| data | Hash | Payload for the cage |
+| data | Hash | Payload for the Cage |
+| options | Hash | [Options for the Cage run](#Cage-Run-Options) |
 
 ## Development
 

data/lib/evervault/client.rb

@@ -29,13 +29,13 @@ module Evervault
       @crypto_client.encrypt(data)
     end
 
-    def run(cage_name, encrypted_data)
-      @request.post(cage_name, encrypted_data, cage_run: true)
+    def run(cage_name, encrypted_data, options = {})
+      @request.post(cage_name, encrypted_data, options: options, cage_run: true)
     end
 
-    def encrypt_and_run(cage_name, data)
+    def encrypt_and_run(cage_name, data, options = {})
       encrypted_data = encrypt(data)
-      run(cage_name, encrypted_data)
+      run(cage_name, encrypted_data, options)
     end
 
     def cages

data/lib/evervault/http/request.rb

@@ -25,8 +25,8 @@ module Evervault
         execute(:delete, build_url(path), params)
       end
 
-      def post(path, params, cage_run: false)
-        execute(:post, build_url(path, cage_run), params)
+      def post(path, params, options: {}, cage_run: false)
+        execute(:post, build_url(path, cage_run), params, build_cage_run_headers(options, cage_run))
       end
 
       private def build_url(path, cage_run = false)
@@ -34,23 +34,41 @@ module Evervault
         "#{@cage_run_url}#{path}"
       end
 
-      def execute(method, url, params)
+      def execute(method, url, params, optional_headers = {})
         resp = Faraday.send(method, url) do |req|
             req.body = params.nil? || params.empty? ? nil : params.to_json
-            req.headers = build_headers
+            req.headers = build_headers(optional_headers)
         end
         return JSON.parse(resp.body) if resp.status >= 200 && resp.status <= 300
         Evervault::Errors::ErrorMap.raise_errors_on_failure(resp.status, resp.body)
       end
 
-      private def build_headers
-        {
+      private def build_headers(optional_headers)
+        optional_headers.merge({
           "AcceptEncoding": "gzip, deflate",
           "Accept": "application/json",
           "Content-Type": "application/json",
           "User-Agent": "evervault-ruby/#{VERSION}",
           "Api-Key": @api_key
-        }
+        })
+      end
+
+      private def build_cage_run_headers(options, cage_run = false)
+        optional_headers = {}
+        return optional_headers unless cage_run
+        if options.key?(:async)
+          if options[:async]
+            optional_headers["x-async"] = "true"
+          end
+          options.delete(:async)
+        end
+        if options.key?(:version)
+          if options[:version].is_a? Integer
+            optional_headers["x-version-id"] = options[:version].to_s
+          end
+          options.delete(:version)
+        end
+        optional_headers.merge(options)
       end
     end
   end

data/lib/evervault/models/cage.rb

@@ -9,8 +9,8 @@ module Evervault
         @request = request
       end
 
-      def run(params)
-        @request.post(self.name, params, cage_run: true)
+      def run(params, options = {})
+        @request.post(self.name, params, options: options, cage_run: true)
       end
 
     end

data/lib/evervault/version.rb

@@ -1,3 +1,3 @@
 module Evervault
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evervault
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jonny O'Mahony
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby SDK to run Evervault Cages