README.md in evervault-0.1.2 vs README.md in evervault-0.1.3
- old
+ new
@@ -10,11 +10,11 @@
## Getting Started
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).
## Installation
@@ -61,11 +61,11 @@
## 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.
+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)
```
@@ -73,32 +73,40 @@
| --------- | ---- | ----------- |
| data | Hash or String | Data to be encrypted |
### 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)
```
| 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
Return a hash of your team's Cage objects in hash format, with cage-name as keys
@@ -127,11 +135,11 @@
@uuid="55986772-4db7-4695-ba44-1b807290ddea">}
```
### 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
=> #<Evervault::Models::CageList:0x00007f8b900b44b0
@cages=
@@ -165,11 +173,11 @@
@uuid="a30295e6-91fc-4d1d-837c-ac4c9b87d02d">]>
```
#### 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
=> {"hello-cage-chilly-plum"=>
#<Evervault::Models::Cage:0x00007f8b900b4438
@@ -208,21 +216,22 @@
@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.
+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'})
=> {"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 |
+| data | Hash | Payload for the Cage |
+| options | Hash | [Options for the Cage run](#Cage-Run-Options) |
## 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.