ez-credentials 0.1.01 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '029ff47272055e48fb8f23d891a8e55cf495b2bd1075510fb77dd9184828d243'
-  data.tar.gz: 262685a11c8ee06cc195624b1b7a3168d56d20b839c5e3b09fc4704f9ec522c2
+  metadata.gz: efe3550c56924e93ff82abcdac3314ae8297aa10d4028f9ced18fa3598f4fff9
+  data.tar.gz: bef69d939b782aa8011d9930bbeff1b2cae2ae3d5c2d8d086d2b335ffb162e2f
 SHA512:
-  metadata.gz: 64595619b3e9b8405cdcc355c619fa02d1c73daaa8e60136f8b6e37e26018d93cf18b811e9a4b168c94476a84eb75e0e7da78c0af935d7728d5fb1c27e31f69e
-  data.tar.gz: fa0c4936def6c6ddd3e2a80b2f063ac64a04d7a5f2b03dc2292e226ee191d64fa73d1a0199360173f36b49d9a478a520de4aee3aa1abb902dabdc1b369edf776
+  metadata.gz: 84df42e272f9468c62bdf4adfcd2047d9a9a90a071e34eb64d1d039d9bd08c68f38b29f2fbe7d88a081f8948306f50e3e3d66c9231ec65d91ea073a0a945eb41
+  data.tar.gz: 6c63b54e92cb301cddca23ab055b0960d80ebeee53407f50f254ab9b863c9482b2ba4cfc98c5223eacdbee0e6a6e41d5fd23046ccc312545967c701e29cb6864

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ez-credentials (0.1.01)
+    ez-credentials (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,15 +1,12 @@
 # Credentials
-
-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/credentials`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A simple environment-aware wrapper around Rails encrypted credentials.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'credentials'
+gem 'ez-credentials', require 'credentials'
 ```
 
 And then execute:
@@ -18,7 +15,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install credentials
+    $ gem install ez-credentials
 
 ## Usage
 This gem assumes you are in a rails application and are using one encrypted credential file with environmnet namespaces, like the example below:
@@ -38,10 +35,23 @@ production:
     bar: realsecret
 ```
 
-To access credentials in the project for the correct environment, use one of the methods below (the `Credentials` class already takes the environment into account):
-- `Credentials.get('foo.bar')`
-- `Credentials.get(:foo, :bar)`
-- `Credentials.get(:foo)[:bar]`
+The `Credentials` class wraps `Rails.application.credentials` call with environment-aware easy accessors.
+To access credentials in the project for the correct environment, use one of the methods below:
+```ruby
+require 'credentials' # if not required in Gemfile
+
+Credentials.all
+# => {:foo => {:bar => 'baz'}}
+
+Credentials.get(:foo) # also takes string 'foo'
+# => {:bar=>"baz"}
+
+Credentials.get('foo.bar')
+# => "baz"
+
+Credentials.get(:foo, :bar)
+# => "baz"
+```
 
 ---
 

data/lib/credentials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Credentials
-  VERSION = "0.1.01"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ez-credentials
 version: !ruby/object:Gem::Version
-  version: 0.1.01
+  version: 0.1.2
 platform: ruby
 authors:
 - jimjoyce