voltos 0.0.91 → 0.0.93

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84615d94fac33331094e4fb4f12aaca2691fd3ca
-  data.tar.gz: 3272bc09502b501e14cd580b056a19acb9bebdae
+  metadata.gz: 183c110bb7f2b1f56deb19eafb077c0fcd831752
+  data.tar.gz: baae03c07b0dca53be3ce5313342302a0a95f94f
 SHA512:
-  metadata.gz: ba432838eb478ca077fc960fd5b5fa081ebc5c08cbf63ce545d0d9812934a19c5d8bcc05dab2ea65f5cd31fa7b85a558ee8c103c2919d18ffbef9d2a94fd6de5
-  data.tar.gz: 6e992fa08e5bd4a4d51d1ac98aad71bd51c61426cd7246b4e4943a6fee9d4172761762defa134d07298bc1834e4feb54378f61ab6cdec2f86b85608bfd3079ff
+  metadata.gz: d3fd8f96975eb575fdce506196fea796ff66aaca54e0d22af5579e3064c7b8080be56fa3991780173b4823bb58ea2d99d5a8a9af01ecaddf06b8e9668bf31ded
+  data.tar.gz: eb96beb92b2ca1321b71f93fb77c0067e1abaa59fc69f102b3da76f9f8eb7d0c7e7eec8009591085ab79633a4cf3d2c0887096ab2aa386b7f53ce2c4f8435e73

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Voltos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,6 @@
-# Voltos
+# Voltos Ruby bindings
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/voltos`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -20,17 +18,58 @@ Or install it yourself as:
 
     $ gem install voltos
 
-## Usage
+## Getting started
+
+1. Find your unique Voltos API key. See "Account" settings.
+
+2. Set this key as an environment variable, 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).
+   
+3. Load up the Voltos credentials. You'll probably want them early on, prior to where your trying to use them (e.g. in ``environment.rb`` in Rails).
+   ```ruby
+    Voltos.configure do |config|
+      config.api_key = ENV["VOLTOS_KEY"]
+    end
+
+    # load all the bundles of credentials for that API key
+    Voltos.load
+
+    # access the credential "MAILER_API_TOKEN" that's in the "myapp-prod" bundle
+    ENV["MAILER_API_TOKEN"] = Voltos.key("myapp-prod", "MAILER_API_TOKEN")
+    ```
+    Note that we're grabbing the credential and stashing it in an environment variable (``MAILER_API_TOKEN``). This fits pretty well with existing idiom, plus ensures that existing code using environment variables keeps working with no change.
+
+4. You can load different credentials for different environments. For example: let's say you've bundled your credentials into ``myapp-dev`` and ``myapp-prod`` bundles (for development and production environments, respectively). 
+
+    In ``config/environments/development.rb``:
+
+   ```ruby
+    Voltos.configure do |config|
+      config.api_key = ENV["VOLTOS_KEY"]
+    end
 
-TODO: Write usage instructions here
+    Voltos.load
+    ENV["ANALYTICS_KEY"] = Voltos.key("myapp-dev", "ANALYTICS_KEY")
+    ```
 
-## Development
+    Then in ``config/environments/production.rb``:
 
-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.
+   ```ruby
+    Voltos.configure do |config|
+      config.api_key = ENV["VOLTOS_KEY"]
+    end
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    Voltos.load
+    ENV["ANALYTICS_KEY"] = Voltos.key("myapp-prod", "ANALYTICS_KEY")
+    ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/voltos.
+Bug reports and pull requests are welcome on GitHub at https://github.com/voltos-online/voltos-ruby
 

data/lib/voltos/version.rb

@@ -1,3 +1,3 @@
 module Voltos
-  VERSION = "0.0.91"
+  VERSION = "0.0.93"
 end

data/voltos.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "curb", '~> 0'
+  # spec.add_development_dependency "curb", '~> 0'
   # spec.add_development_dependency "json", '~> 1.8.3'
   spec.add_development_dependency 'json', '~> 1.8', '>= 1.8.3'
 
@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   # spec.add_development_dependency 'curb', '~> 0'
   # spec.add_development_dependency "json"
 
-  # spec.add_runtime_dependency "curb", [">= 0"]
+  spec.add_runtime_dependency "curb", [">= 0"]
   # spec.add_runtime_dependency "json", [">= 0"]
   # add_runtime_dependency 'curb', '>= 0', '~> 0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltos
 version: !ruby/object:Gem::Version
-  version: 0.0.91
+  version: 0.0.93
 platform: ruby
 authors:
 - Daniel May
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,39 +53,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: curb
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: json
+  name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.3
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 description: 
 email:
 - daniel@thedanielmay.com
@@ -96,6 +96,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console