voltos 0.3.0.rc14 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +80 -66
  3. data/lib/voltos/version.rb +1 -1
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8f69a0b9facf15ca91edcc3aacdb778fc2a1d8f2
4
- data.tar.gz: fd98f3520fc48862d4c46e8679c9eb8c9ce781d7
3
+ metadata.gz: fce1c67e7bdf61cbced27a26f19218350afbd5d9
4
+ data.tar.gz: 2772bec2f61cc7da09bd2ed208e37fd7fcc9e6a7
5
5
  SHA512:
6
- metadata.gz: dfb16c318abf9d9776d71a3898de74f1fe3700b1dcbbd0e16997e0774cc28bbd4f9be5650d9aa239ee7f98f5bc6dfbeaf157f1ba44a5e23803a75f9e38ec35d6
7
- data.tar.gz: 6946992dfd179d36970d063b4096f8cb614a3e0b309f6f46008a2ece34506ee2df787aa8845191e3372f3d992c8a073ee14281925431373de9ac6da2963a7142
6
+ metadata.gz: a2476d79196557f2e0f7fbc1238d51222b2bd7259332f30672cd2b7be5d65df91e2a6df0180e696f93fe452cdc878591387f179dc89e93bd1a8d75bcd3463e39
7
+ data.tar.gz: 4aef9faaf5169a92bcb617fdc546c490e511b456e946b129b2166f800d94aa3ff4e822565ef116cfa31dc2e2004a2103a7f5ec77e1f2ff8034c15785a24cc7ad
data/README.md CHANGED
@@ -4,88 +4,102 @@ This gem provides Voltos Ruby bindings to access the Voltos API from apps writte
4
4
 
5
5
  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.
6
6
 
7
+ ## Contents
8
+ * [Installation](#installation)
9
+ * [Getting started](#getting-started)
10
+
7
11
  ## Installation
8
12
 
9
13
  Add this line to your application's Gemfile:
10
14
 
11
15
  ```ruby
12
- gem 'voltos'
16
+ gem 'voltos', '~> 0.3.0rc14'
13
17
  ```
14
18
 
15
19
  And then execute:
16
20
 
17
- $ bundle
21
+ $ bundle install
18
22
 
19
23
  Or install it yourself as:
20
24
 
21
25
  $ gem install voltos
26
+
27
+ ### Troubleshooting installation
28
+
29
+ **Ubuntu**
30
+
31
+ You may need to install native extensions first:
32
+ ```
33
+ sudo apt-get install libcurl4-openssl-dev
34
+ ```
22
35
 
23
36
  ## Getting started
24
37
 
25
- 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.
26
-
27
- 1. Ensure your bundle(s) are organised how you want, on your Voltos account (https://voltos.online).
28
-
29
- 2. Find the API key for the bundle that you want your app to load (e.g. bundle ``PROD``'s API key: 13579def13579def)
30
-
31
- 2. Set this key as an environment variable in your app, e.g.
32
- ```ruby
33
- $ export VOLTOS_KEY=13579def13579def
34
-
35
- # or on a platform like Heroku
36
- $ heroku config:set VOLTOS_KEY=13579def13579def
37
- ```
38
- 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).
39
-
40
- 3. Require the `voltos` gem early on, before you use the credentials:
41
- ```ruby
42
- require 'voltos'
43
-
44
- # Voltos will automatically load the bundle matching the key you've specified in VOLTOS_KEY
45
- # and load those credentials into ENV, ready to use
46
-
47
- puts ENV['MY_SECRET_KEY']
48
- ```
49
-
50
- ### Multiple bundles
51
-
52
- 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).
53
-
54
- 1. Get the respective API keys for those bundles (e.g. ``VOLTOS_COMMON`` and ``VOLTOS_PROD``).
55
-
56
- 2. Set environment variables for these bundle keys:
57
- ```ruby
58
- $ export VOLTOS_COMMON=1294854fe52417a
59
- $ export VOLTOS_PROD=8646ec352729c3
60
-
61
- # or on a platform like Heroku
62
- $ heroku config:set VOLTOS_COMMON=1294854fe52417a VOLTOS_PROD=8646ec352729c3
63
- ```
64
-
65
- 2. Manually load up each bundle of credentials at appropriate time for your app:
66
- ```ruby
67
-
68
- ## environment.rb - load up COMMON bundle with credentials common to all environments
69
- Voltos.configure do |config|
70
- config.api_key = ENV["VOLTOS_COMMON"]
71
- end
72
-
73
- voltos_creds = Voltos.load
74
- voltos_creds.each do |key,val|
75
- ENV[key] ||= val
76
- end
77
-
78
-
79
- ## production.rb - load up PROD bundle with credentials specific to prod environment
80
- Voltos.configure do |config|
81
- config.api_key = ENV["VOLTOS_PROD"]
82
- end
83
-
84
- voltos_creds = Voltos.load
85
- voltos_creds.each do |key,val|
86
- ENV[key] ||= val
87
- end
88
- ```
38
+ ### Sign up
39
+ ```
40
+ $ voltos signup
41
+ ```
42
+
43
+ ### Sign in
44
+ ```
45
+ $ voltos auth
46
+ ```
47
+
48
+ ### Create bundle of credentials
49
+ ```
50
+ $ voltos create piedpiper-backend
51
+ ```
52
+
53
+ ### Add credentials to bundle
54
+ ```
55
+ ## add to default bundle in use
56
+ $ voltos set MAILSERVICE=17263ed6547a7c7d8372
57
+ $ voltos set DEV_URL=https://dev.piedpiper.io
58
+
59
+ ## or explicitly specify which bundle:
60
+ $ voltos set MAILSERVICE=17263ed6547a7c7d8372 piedpiper-backend
61
+ $ voltos set DEV_URL=https://dev.piedpiper.io piedpiper-backend
62
+ ```
63
+
64
+ ### List credentials in a bundle
65
+ ```
66
+ $ voltos list
67
+ ```
68
+
69
+ ### List all bundles of credentials that you can access
70
+ ```
71
+ $ voltos list --all
72
+ ```
73
+
74
+ ### Share bundle of credentials
75
+ ```
76
+ $ voltos share sasha@hooli.com
77
+ ```
78
+
79
+ ### Unshare bundle of credentials
80
+ ```
81
+ $ voltos retract piedpiper-backend sasha@hooli.com
82
+ ```
83
+
84
+ ### Remove credentials
85
+ ```
86
+ $ voltos unset piedpiper-backend DEV_URL
87
+ ```
88
+
89
+ ### Destroy bundle of credentials
90
+ ```
91
+ $ voltos destroy piedpiper-backend
92
+ ```
93
+
94
+
95
+ ## Using Voltos with your apps
96
+
97
+ When you're done loading up your bundles with credentials, you'll want to start using them with your apps.
98
+
99
+ ### Running locally
100
+
101
+ ### Deploying to Heroku
102
+
89
103
 
90
104
  ## Contributing
91
105
 
@@ -1,3 +1,3 @@
1
1
  module Voltos
2
- VERSION = "0.3.0.rc14"
2
+ VERSION = "0.3.0"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voltos
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0.rc14
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel May
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2016-08-15 00:00:00.000000000 Z
11
+ date: 2016-08-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -155,9 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
155
155
  version: '0'
156
156
  required_rubygems_version: !ruby/object:Gem::Requirement
157
157
  requirements:
158
- - - ">"
158
+ - - ">="
159
159
  - !ruby/object:Gem::Version
160
- version: 1.3.1
160
+ version: '0'
161
161
  requirements: []
162
162
  rubyforge_project:
163
163
  rubygems_version: 2.5.1