voltos 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4a9232be59e0741a341ca3a1943193065ac1f30
-  data.tar.gz: 834922be6fa5007ab33c003a7d6db02844d67ec0
+  metadata.gz: 31b2704117c58bd5257ac339ee941f8de2973283
+  data.tar.gz: 4786a3ba2725165f9ea84df0eb4ce326c63df63d
 SHA512:
-  metadata.gz: 05c840cf8ee45113e9947f59244910bedb483232bf8c4be518e9091bce98a9511c653971f3a34860f34d4207d32cc21770674ac50df41a7926e7012347fcd67f
-  data.tar.gz: ea54395afa3f468b0e50b3a91f9223a974a91eca82509cf4f397919cd70cf59d115306eb2353a354e321deeb1cfbedb60ecc8739d733a4ff84f57171c34e35f5
+  metadata.gz: db19f9d34d21161730136bde177f3fcc2abe34edd455379618add46809583712eea20d61a31c99aa0138bd871876e448caa7692653a23cba0967e66cfe2fc9e5
+  data.tar.gz: 1f75eae336dd7c191c52bce2aa3bb44064a628166b74cc01e03bed4d18ea10bbb93346495dad5101e30c4a9f752e75ea33331a8f5475f07e3660932f7d500390

data/README.md

@@ -1,6 +1,8 @@
 # Voltos Ruby bindings
 
-This gem provides Voltos Ruby bindings for provide a small SDK for access to the Voltos API from apps written in Ruby. Voltos ([https://voltos.online](https://voltos.online)) provides credentials-as-a-service for app and system developers.
+This gem provides Voltos Ruby bindings to access the Voltos API from apps written in Ruby. Voltos ([https://voltos.online](https://voltos.online)) provides credentials-as-a-service for app and system developers.
+
+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. 
 
 ## Installation
 
@@ -20,24 +22,71 @@ Or install it yourself as:
 
 ## Getting started
 
-1. Find your unique Voltos API key. See "Bundle" settings.
+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. Set this key as an environment variable, e.g.
+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
    ```
-   We'll use this key to load up our Voltos credentials (don't worry, you'll only need to set one key this way).
+   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, prior to where your trying to use any credentials
+3. Require the `voltos` gem early on, before you use the credentials:
    ```ruby
    require 'voltos'
-    # access the credential "MAILER_API_TOKEN" that's in the bundle
-    puts ENV["MAILER_API_TOKEN"]
+   
+   # 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
+   ```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/voltos-online/voltos-ruby

data/lib/voltos/rails.rb

@@ -0,0 +1,22 @@
+begin
+  module Voltos
+    class Railtie < Rails::Railtie
+      config.before_configuration { load }
+
+      def load
+        Voltos.configure
+        Voltos.load
+      end
+
+      def root
+        Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
+      end
+
+      def self.load
+        instance.load
+      end
+    end
+  end
+rescue NameError
+  # Rails not loaded
+end

data/lib/voltos/version.rb

@@ -1,3 +1,3 @@
 module Voltos
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/voltos.rb

@@ -10,7 +10,7 @@ module Voltos
 
   def self.configure
     self.configuration ||= Configuration.new
-    yield(configuration)
+    yield(configuration) if block_given?
   end
 
   def self.load
@@ -58,11 +58,20 @@ module Voltos
 
     def initialize
       @api_url = ENV["VOLTOS_API_URL"] || "https://voltos.online/v1"
-      @api_key = ENV["VOLTOS_API_KEY"]
+      @api_key = ENV["VOLTOS_KEY"]
     end
   end
 end
 
-if ENV["VOLTOS_API_KEY"]
+begin
+  if Rails
+    require 'voltos/rails'
+  end
+rescue NameError
+  # Rails not loaded
+end
+
+Voltos.configure
+if ENV["VOLTOS_KEY"]
   Voltos.load
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel May
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - bin/console
 - bin/setup
 - lib/voltos.rb
+- lib/voltos/rails.rb
 - lib/voltos/version.rb
 - voltos.gemspec
 homepage: http://rubygems.org/gems/voltos
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Access Voltos API