r_creds 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03db4fe4423fb4084b0d989b6335d6b02fcfbe744aa8b0f8ef502db271b98b35
-  data.tar.gz: b6d7c8d82034779ec276f7effa2bd4cd71e9992d0e6777bd5377c805800e610a
+  metadata.gz: 6edc8f797ac6ff69cfefcb20f7c264ad2e343e31e81587ff22801283d3ef0000
+  data.tar.gz: 1231fafcb7427607baf4bc9a2b3d450db155fba687f2fb1263afa0143962d786
 SHA512:
-  metadata.gz: 4d4af24c475d19b07981ed15edf7ed0309d26ae535ec8868cca3a4f80b905bbcc167091b231b089396da2aec061b3014766e6237bf4e0abdf5fbbc6351fce455
-  data.tar.gz: f084d270504dd7d687330c5366907d5316fcb27d5eb79117d6230b8febf924a38a05ff4b880e10b86de0ea9c9734e555b66a548cf3e9afa893de78e156cf680d
+  metadata.gz: 3bd20b25108f689437f4401e0d3d19bdb6614e88714858cfd43bbcb280410cdd573830f2ad39479e5de67249b1afe31411f4b63c13f401f846343b915ffa50fe
+  data.tar.gz: 3f998b19a77ac0bb665ebd0b28a60c33fe47a07002daa76790de6d4bd5491f30256f3b47e579ff3d03587910f9d0b96231f54cdf65736fd0932213c13cec647a

data/README.md

@@ -1,6 +1,6 @@
 # RCreds
 
-Work simple with creds in Rails 5.2 and above!
+RCreds makes working with Rails 5.2 credentials easier
 
 ## Installation
 
@@ -19,24 +19,33 @@ Or install it yourself as:
     $ gem install r_creds
 
 ## Usage
-
-RCreds give an ability to read credentials in credentials.yml, ENV or use default value!
-
+There are no need to do this:
+```ruby
+Rails.application.credentials[Rails.env.to_sym][:aws][:access_key_id]
+```
+Use RCreds instead:
 ```ruby
-# returns value from credentials.yml for current environment 
-RCreds.fetch(:payment_system, :secret_key) 
+RCreds.fetch(:aws, :access_key_id)
 ```
+
+RCreds give an ability to read credentials in credentials.yml, ENV or use default value!
 ```ruby
-# returns value from credentials.yml for current environment or default 
-RCreds.fetch(:redis, :url, default: 'redis://localhost:6379/0')
+# value set in credentials.yml
+RCreds.fetch(:aws, :access_key_id) # output: secret_key_from_credentials_yaml
+
+# no value in credentials.yml but,
+ENV['AWS_ACCESS_KEY_ID'] = 'aws_key_from_env_variable'
+RCreds.fetch(:aws, :access_key_id) # output: aws_key_from_env_variable
+
+# no value in credentials.yml and ENV - use default
+RCreds.fetch(:aws, :access_key_id, default: 'some_default_test_key') # output: some_default_test_key
 ```
+RCreds searches for values in following order: credentials.yml > ENV > default and returns nil if nothing match
+
+RCreds uses `Rails.env` to determinate environment. But you can set any environement.
 ```ruby
-# if value is set in as ENV variable it will be fetched if it's not set in credentials.yml
-# keys concatenates as in following example
-ENV['REDIS_URL'] = 'redis://real_redis_url'
-RCreds.fetch(:redis, :url, default: 'redis://localhost:6379/0') # output: redis://real_redis_url
+RCreds.fetch(:aws, :access_key_id, environment: 'production')
 ```
-RCreds search for values in following order: credentials.yml > ENV > default:
 
 ## Development
 
@@ -46,7 +55,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/r_creds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/OrestF/r_creds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -54,4 +63,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RCreds project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/r_creds/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RCreds project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OrestF/r_creds/blob/master/CODE_OF_CONDUCT.md).

data/lib/r_creds.rb

@@ -2,7 +2,7 @@ require "r_creds/version"
 require_relative "r_creds/fetcher"
 
 module RCreds
-  def self.fetch(*keys, default: nil)
-    Fetcher.new(keys, default).call
+  def self.fetch(*keys, default: nil, environment: nil)
+    Fetcher.new(keys, default, environment).call
   end
 end

data/lib/r_creds/fetcher.rb

@@ -2,9 +2,10 @@ module RCreds
   class Fetcher
     class NoRailsError < StandardError; end
 
-    def initialize(keys, default)
+    def initialize(keys, default, environment)
       @keys = keys
       @default = default
+      @environment = environment
     end
 
     attr_reader :keys, :default
@@ -14,8 +15,14 @@ module RCreds
       fetch
     end
 
+    private
+
+    def environment
+      (presence?(@environment) || Rails.env).to_sym
+    end
+
     def fetch
-      cred = Rails.application.credentials.dig(Rails.env.to_sym, *keys)
+      cred = Rails.application.credentials.dig(environment, *keys)
 
       presence?(cred) || presence?(ENV[keys.join('_').upcase]) || default
     end

data/lib/r_creds/version.rb

@@ -1,3 +1,3 @@
 module RCreds
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/r_creds.gemspec

@@ -9,10 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["OrestF"]
   spec.email         = ["falchuko@gmail.com"]
 
-  spec.summary       = 'RCreds make working with Rails 5.2 credentials easier'
-  spec.description   = 'RCreds make working with Rails 5.2 credentials easier'
+  spec.summary       = 'RCreds makes working with Rails 5.2 credentials easier'
+  spec.description   = 'RCreds makes working with Rails 5.2 credentials easier'
   spec.homepage      = 'https://github.com/OrestF/r_creds'
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_creds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: RCreds make working with Rails 5.2 credentials easier
+description: RCreds makes working with Rails 5.2 credentials easier
 email:
 - falchuko@gmail.com
 executables: []
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -84,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: RCreds make working with Rails 5.2 credentials easier
+summary: RCreds makes working with Rails 5.2 credentials easier
 test_files: []