voltos 0.3.0.rc14 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f69a0b9facf15ca91edcc3aacdb778fc2a1d8f2
-  data.tar.gz: fd98f3520fc48862d4c46e8679c9eb8c9ce781d7
+  metadata.gz: fce1c67e7bdf61cbced27a26f19218350afbd5d9
+  data.tar.gz: 2772bec2f61cc7da09bd2ed208e37fd7fcc9e6a7
 SHA512:
-  metadata.gz: dfb16c318abf9d9776d71a3898de74f1fe3700b1dcbbd0e16997e0774cc28bbd4f9be5650d9aa239ee7f98f5bc6dfbeaf157f1ba44a5e23803a75f9e38ec35d6
-  data.tar.gz: 6946992dfd179d36970d063b4096f8cb614a3e0b309f6f46008a2ece34506ee2df787aa8845191e3372f3d992c8a073ee14281925431373de9ac6da2963a7142
+  metadata.gz: a2476d79196557f2e0f7fbc1238d51222b2bd7259332f30672cd2b7be5d65df91e2a6df0180e696f93fe452cdc878591387f179dc89e93bd1a8d75bcd3463e39
+  data.tar.gz: 4aef9faaf5169a92bcb617fdc546c490e511b456e946b129b2166f800d94aa3ff4e822565ef116cfa31dc2e2004a2103a7f5ec77e1f2ff8034c15785a24cc7ad

data/README.md

@@ -4,88 +4,102 @@ This gem provides Voltos Ruby bindings to access the Voltos API from apps writte
 
 Voltos stores your credentials (e.g. API keys, usernames, passwords, tokens) in a secure, central location - so that your apps can access them, and you can more easily manage them & access to them. 
 
+## Contents
+* [Installation](#installation)
+* [Getting started](#getting-started)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'voltos'
+gem 'voltos', '~> 0.3.0rc14'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install voltos
+    
+### Troubleshooting installation
+
+**Ubuntu**
+
+You may need to install native extensions first:
+```
+sudo apt-get install libcurl4-openssl-dev
+```
 
 ## Getting started
 
-You'll use Voltos to load up a **bundle** of credentials each time. Think of a bundle as credentials that have been logically grouped together, e.g. a ``PROD`` bundle.
-
-1. Ensure your bundle(s) are organised how you want, on your Voltos account (https://voltos.online).
-
-2. Find the API key for the bundle that you want your app to load (e.g. bundle ``PROD``'s API key: 13579def13579def)
-
-2. Set this key as an environment variable in your app, e.g.
-   ```ruby
-   $ export VOLTOS_KEY=13579def13579def
-
-   # or on a platform like Heroku
-   $ heroku config:set VOLTOS_KEY=13579def13579def
-   ```
-   In a moment, we'll use this key to load up the matching Voltos bundle of credentials (and don't worry, you'll only need to set one environment variable this way).
-
-3. Require the `voltos` gem early on, before you use the credentials:
-   ```ruby
-   require 'voltos'
-   
-   # Voltos will automatically load the bundle matching the key you've specified in VOLTOS_KEY
-   # and load those credentials into ENV, ready to use
-   
-   puts ENV['MY_SECRET_KEY']
-    ```
-
-### Multiple bundles
-
-Sometimes, you need to load up more than one bundle (e.g. you have ``DEV`` and ``PROD`` bundles to load when deploying on different environments).
-
-1. Get the respective API keys for those bundles (e.g. ``VOLTOS_COMMON`` and ``VOLTOS_PROD``).
-
-2. Set environment variables for these bundle keys:
-   ```ruby
-   $ export VOLTOS_COMMON=1294854fe52417a
-   $ export VOLTOS_PROD=8646ec352729c3
-   
-   # or on a platform like Heroku
-   $ heroku config:set VOLTOS_COMMON=1294854fe52417a VOLTOS_PROD=8646ec352729c3
-   ```
-
-2. Manually load up each bundle of credentials at appropriate time for your app:
-   ```ruby
-   
-   ## environment.rb - load up COMMON bundle with credentials common to all environments
-   Voltos.configure do |config|
-     config.api_key = ENV["VOLTOS_COMMON"]
-   end
-   
-   voltos_creds = Voltos.load
-   voltos_creds.each do |key,val|
-     ENV[key] ||= val
-   end
-
-
-   ## production.rb - load up PROD bundle with credentials specific to prod environment
-   Voltos.configure do |config|
-     config.api_key = ENV["VOLTOS_PROD"]
-   end
-   
-   voltos_creds = Voltos.load
-   voltos_creds.each do |key,val|
-     ENV[key] ||= val
-   end
-   ```
+### Sign up
+```
+$ voltos signup
+```
+
+### Sign in
+```
+$ voltos auth
+```
+
+### Create bundle of credentials
+```
+$ voltos create piedpiper-backend
+```
+
+### Add credentials to bundle
+```
+## add to default bundle in use
+$ voltos set MAILSERVICE=17263ed6547a7c7d8372
+$ voltos set DEV_URL=https://dev.piedpiper.io
+
+## or explicitly specify which bundle:
+$ voltos set MAILSERVICE=17263ed6547a7c7d8372 piedpiper-backend
+$ voltos set DEV_URL=https://dev.piedpiper.io piedpiper-backend
+```
+
+### List credentials in a bundle
+```
+$ voltos list
+```
+
+### List all bundles of credentials that you can access
+```
+$ voltos list --all
+```
+
+### Share bundle of credentials
+```
+$ voltos share sasha@hooli.com
+```
+
+### Unshare bundle of credentials
+```
+$ voltos retract piedpiper-backend sasha@hooli.com
+```
+
+### Remove credentials
+```
+$ voltos unset piedpiper-backend DEV_URL
+```
+
+### Destroy bundle of credentials
+```
+$ voltos destroy piedpiper-backend
+```
+
+
+## Using Voltos with your apps
+
+When you're done loading up your bundles with credentials, you'll want to start using them with your apps.
+
+### Running locally
+
+### Deploying to Heroku
+
 
 ## Contributing
 

data/lib/voltos/version.rb

@@ -1,3 +1,3 @@
 module Voltos
-  VERSION = "0.3.0.rc14"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltos
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc14
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel May
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,9 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1