env_loader 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32ae6d75fb3dceb6dd877846c61d99ed9fe6ec78
-  data.tar.gz: 735ab2959cb12459fc0b3780f97627ee90f67c62
+  metadata.gz: 7bf9112a103965a07c8a3c1bb164c4e87dcc8161
+  data.tar.gz: 0636cf83d8f73eb02e821db1470b5b368860e2bc
 SHA512:
-  metadata.gz: f2f232f7e4a864e55a5b12f8c9ba0127b0ea0230f1389aa478abe51b046932941ae3982de6d441ff799e2bfe3526dfc044fe8c6476217f9f0d8e830137f3de39
-  data.tar.gz: 60148c44dec0e660f10badb02c78eedb515b3959ecc3ec30dfecf8b4d2ea11f816a5d327abc552359b8748dcd5939900bd23b9b4c4d72f241d252df9f0f1ff58
+  metadata.gz: 18f5583f655fd024566ad4159d1b9db41d37db4754ec7717cfd6969290e6a709d25c577f852a8f87fbc8265f0d7fffcf0b5d7607574ed2cd7ad2f3d67f5c7285
+  data.tar.gz: 08873040504616d900db77f6cc782554d2331cf7269b61f40e77af81702efefccad980c5e39d8c7158b5e2b162b078f75bd5e7be071c63cc54f483bf757d588d

data/README.md

@@ -1,6 +1,8 @@
 # EnvLoader
 
-TODO: Write a gem description
+By: Endri Gjiri *www.name-reaction.com*
+
+**EnvLoader** is a utility module with a single `read` method which can read a .yml file and store its data in environment variables. This is useful when dealing with sensitive data that should not be directly entered in the code and stored in version control. Passwords and other information can now simply be stored in a yaml file which is added to .gitignore and then can be accessed through the env_loader gem via ENV variables
 
 ## Installation
 
@@ -18,7 +20,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Include the env_loader gem directly or through bundler
+```ruby
+require 'env_loader'
+```
+
+2. Create a .yml file with all the desired information. For example create a file called credentials.yml with the following content:
+```yml
+username: endri
+password: secret
+```
+
+3. Read the .yml file through the env_loader gem as follows:
+```ruby
+EnvLoader.read('credentials.yml')
+```
+
+The data is now available through Ruby's ENV accessor. Always user uppercase strings as the key even though they were lowercase in the .yml file, for example:
+```ruby
+ENV['USERNAME'] # => "endri"
+ENV['PASSWORD'] # => "secret"
+```
+
+## Usage with Rails
+
+1. Add the env_loader gem to the Gemfile and run `Bundle install`
+
+2. Create a file called *env_variables.yml* in the *config* directory with the desired data. This is the default path where the gem will look in and does not require passing in the path to the `read` method
+
+3. Read the .yml file through the env_loader gem by adding the following line to *config/application.rb*
+```ruby
+EnvLoader.read
+```
+
+The data can now be accessed throughout the Rails app using `ENV['KEY']` as explaied above.
 
 ## Contributing
 

data/lib/env_loader/version.rb

@@ -1,3 +1,3 @@
 module EnvLoader
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/env_loader.rb

@@ -1,13 +1,13 @@
-require "env_loader/version"
+require 'env_loader/version'
 require 'yaml'
 
 module EnvLoader
 
-  def self.read(env_yml_file)
+  def self.read(env_yml_file = File.join('config', 'env_variables.yml'))
     if File.exists? env_yml_file
       if hash = YAML.load(File.open env_yml_file)
         hash.each do |key, value|
-          ENV[key.upcase] = value
+          ENV[key.upcase] = value.to_s if value
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_loader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Endri Gjiri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2014-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Reads a YAML file and creates ENV variables from it