idkfa 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- data/README.textile +47 -0
- data/lib/idkfa/version.rb +1 -1
- metadata +3 -3
- data/README +0 -0
data/README.textile
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
h1. idkfa
|
|
2
|
+
|
|
3
|
+
Storing keys in your repository is A Bad Idea™. With @idkfa@, you can store them in a YAML file outside your repository yet include them easily.
|
|
4
|
+
|
|
5
|
+
Once installed and setup with @Idkfa.load_keys@, your sensitive information will be stored in upper-cased keys inside @ENV@.
|
|
6
|
+
|
|
7
|
+
Why "idkfa?" Haven't you played Doom?
|
|
8
|
+
|
|
9
|
+
h2. Default Configuration
|
|
10
|
+
|
|
11
|
+
To configure idkfa, you will need to add a @credentials.yml@ file to your project
|
|
12
|
+
|
|
13
|
+
Sample @config/credentials.yml@:
|
|
14
|
+
|
|
15
|
+
bc. common: &COMMON
|
|
16
|
+
domain_url: http://localhost:3000
|
|
17
|
+
my_secret_api_key: something_really_secret
|
|
18
|
+
development:
|
|
19
|
+
<<: *COMMON
|
|
20
|
+
production:
|
|
21
|
+
<<: *COMMON
|
|
22
|
+
|
|
23
|
+
h2. Usage with Rails
|
|
24
|
+
|
|
25
|
+
* Add @gem 'idkfa'@ to your @Gemfile@
|
|
26
|
+
* Run @bundle@
|
|
27
|
+
* Add the @Idkfa.load_keys@ call inside your Application definition in @config/application.rb@:
|
|
28
|
+
|
|
29
|
+
bc. class Application < Rails::Application
|
|
30
|
+
Idkfa.load_keys Rails.env, :credentials => Rails.root.join('config', 'credentials.yml')
|
|
31
|
+
...
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
* In your application, use @ENV['MY_SECRET_API_KEY']@
|
|
35
|
+
|
|
36
|
+
h2. General Usage
|
|
37
|
+
|
|
38
|
+
* Run @gem install idkfa@
|
|
39
|
+
* Use @Idkfa.load_keys :production, :credentials => File.expand_path('../credentials.yml', __FILE__)@ (or similar)
|
|
40
|
+
* In your code, use @ENV['MY_SECRET_API_KEY']@
|
|
41
|
+
|
|
42
|
+
h2. Acknowledgements
|
|
43
|
+
|
|
44
|
+
Written/Conceived by:
|
|
45
|
+
* Bradley Grzesiak - Bendyworks
|
|
46
|
+
* Jaymes Waters - Bendyworks
|
|
47
|
+
* Nick Karpenske - Bendyworks
|
data/lib/idkfa/version.rb
CHANGED
metadata
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: idkfa
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
4
|
prerelease:
|
|
5
|
-
version: 0.0.
|
|
5
|
+
version: 0.0.3
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
8
8
|
- Bradley Grzesiak
|
|
@@ -12,7 +12,7 @@ autorequire:
|
|
|
12
12
|
bindir: bin
|
|
13
13
|
cert_chain: []
|
|
14
14
|
|
|
15
|
-
date: 2011-04-
|
|
15
|
+
date: 2011-04-11 00:00:00 -05:00
|
|
16
16
|
default_executable:
|
|
17
17
|
dependencies:
|
|
18
18
|
- !ruby/object:Gem::Dependency
|
|
@@ -41,7 +41,7 @@ files:
|
|
|
41
41
|
- .gitignore
|
|
42
42
|
- .rvmrc
|
|
43
43
|
- Gemfile
|
|
44
|
-
- README
|
|
44
|
+
- README.textile
|
|
45
45
|
- Rakefile
|
|
46
46
|
- gem_tasks/rspec.rake
|
|
47
47
|
- idkfa.gemspec
|
data/README
DELETED
|
File without changes
|