doppler 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 81538ad7d067d1717e14ad49885bdbc7f059a64b
4
+ data.tar.gz: 90ddb9cfaecb4f9985d7ddfeb224804d69a254e1
5
+ SHA512:
6
+ metadata.gz: cf98ba4bcbb81edce4bde1e3c63c56d9a3f057e028085ad2a2c41182bc920db948f14f870c9915aa1427728c68c340c3f884eab5c1d11ca0e32eb6cbd0c3304b
7
+ data.tar.gz: dff21398b8d3b1f40a5876d9d3418f972b060c460d27ffad48572efb99cfb4da44a05707cd1dcafbb23b8d226bb70cb9b922a556449c0bb3f4d31a6e1194b560
@@ -0,0 +1,50 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /spec/examples.txt
9
+ /test/tmp/
10
+ /test/version_tmp/
11
+ /tmp/
12
+
13
+ # Used by dotenv library to load environment variables.
14
+ # .env
15
+
16
+ ## Specific to RubyMotion:
17
+ .dat*
18
+ .repl_history
19
+ build/
20
+ *.bridgesupport
21
+ build-iPhoneOS/
22
+ build-iPhoneSimulator/
23
+
24
+ ## Specific to RubyMotion (use of CocoaPods):
25
+ #
26
+ # We recommend against adding the Pods directory to your .gitignore. However
27
+ # you should judge for yourself, the pros and cons are mentioned at:
28
+ # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
29
+ #
30
+ # vendor/Pods/
31
+
32
+ ## Documentation cache and generated files:
33
+ /.yardoc/
34
+ /_yardoc/
35
+ /doc/
36
+ /rdoc/
37
+
38
+ ## Environment normalization:
39
+ /.bundle/
40
+ /vendor/bundle
41
+ /lib/bundler/man/
42
+
43
+ # for a library or gem, you might want to ignore these files since the code is
44
+ # intended to run in multiple environments; otherwise, check them in:
45
+ # Gemfile.lock
46
+ # .ruby-version
47
+ # .ruby-gemset
48
+
49
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
50
+ .rvmrc
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at vallelungabrian@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) { "https://github.com/DopplerHQ/ruby-client" }
4
+
5
+ # Specify your gem's dependencies in doppler-client.gemspec
6
+ gemspec
@@ -0,0 +1,24 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ doppler-client (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ hitimes (1.3.0)
10
+ minitest (5.11.3)
11
+ rake (10.5.0)
12
+
13
+ PLATFORMS
14
+ ruby
15
+
16
+ DEPENDENCIES
17
+ bundler (~> 1.16)
18
+ doppler-client!
19
+ hitimes (~> 1.3)
20
+ minitest (~> 5.0)
21
+ rake (~> 10.0)
22
+
23
+ BUNDLED WITH
24
+ 1.16.5
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,140 @@
1
+ # Doppler Ruby Library
2
+
3
+ [![image](https://img.shields.io/gem/v/doppler-client.svg)](https://rubygems.org/gems/doppler-client)
4
+ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/92ec3d37764c40da8dffb6a85c6cbfa4)](https://www.codacy.com/app/Doppler/ruby-client?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DopplerHQ/ruby-client&amp;utm_campaign=Badge_Grade)
5
+
6
+ The Doppler Ruby library provides convenient access to the Doppler API from
7
+ applications written for **only** server-side code.
8
+
9
+ ## Installation
10
+
11
+ Install the gem with:
12
+ ``` bash
13
+ gem install doppler
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ The package needs to be configured with your account's api key which is available in your [Doppler account](https://doppler.com/workplace/api_key), pipeline identifier and the environment name:
19
+
20
+ ``` ruby
21
+ require "doppler"
22
+
23
+ Doppler.configure do |config|
24
+ config.api_key = "api-key"
25
+ config.pipeline = "31"
26
+ config.environment = "development_ruby"
27
+ config.priority = Doppler::PRIORITY_REMOTE
28
+ end
29
+
30
+
31
+ doppler = Doppler::Client.new()
32
+
33
+ # Rest of Application
34
+ ```
35
+
36
+ ## Key Best Practices
37
+
38
+ So if Doppler stores my environment keys, where should I keep my Doppler API keys?
39
+
40
+ That is a great question! We recommend storing your `API_KEY`, `PIPELINE_ID`, and `ENVIRONMENT_NAME`
41
+ in local environment. That means the only keys you should be storing in your local environment are the Doppler keys. All other keys should be be fetched by the Doppler client.
42
+
43
+ ### Fetch Environment Keys
44
+
45
+ You can fetch your environment keys from Doppler by calling the `get(name)` method.
46
+
47
+ ``` ruby
48
+ doppler.get(KEY_NAME)
49
+ ```
50
+
51
+ Here is an example:
52
+
53
+ ``` ruby
54
+ config = {
55
+ "segment_key" => doppler.get("SEGMENT_API_KEY"),
56
+ "algolia_key" => doppler.get("ALGOLIA_API_KEY")
57
+ }
58
+
59
+ ```
60
+
61
+ If there are differences between the values your local environment sets and the ones on Doppler, the client will use the ones provided by Doppler. You can override this behavior by passing in a second argument to the `get(key_name, priority)` method that sets the priority to favor your local environment.
62
+
63
+ For example:
64
+
65
+ ``` ruby
66
+ # Local Enviroment
67
+ os.environ["MAGICAL_KEY"] = "123"
68
+
69
+ # Doppler
70
+ MAGICAL_KEY = "456"
71
+
72
+
73
+ # Default Behavior
74
+ doppler.get("MAGICAL_KEY") # => "456"
75
+
76
+ # Override to Local
77
+ doppler.get("MAGICAL_KEY", Doppler::Priority.local) # => "123"
78
+ ```
79
+
80
+ You can also set the priority globally on initialization:
81
+
82
+ ``` ruby
83
+ Doppler.configure do |config|
84
+ # ...
85
+ config.priority = Doppler::PRIORITY_LOCAL
86
+ end
87
+ ```
88
+
89
+ ## Rails integration
90
+
91
+ Configure `Doppler` with keys and environments, and then you should be all good.
92
+ Please use the following snippet in initializer folder.
93
+
94
+ ```rb
95
+ Doppler.configure do |config|
96
+ config.api_key = "api-key"
97
+ config.pipeline = "31"
98
+ config.environment = "development_ruby"
99
+ config.priority = Doppler::PRIORITY_REMOTE
100
+ end
101
+ ```
102
+
103
+ Example repo found [here](https://github.com/DopplerHQ/rails-sample).
104
+
105
+ ## Local Key Privacy
106
+
107
+ By default the Doppler client will only track the local environment keys that are used during `doppler.get()`.
108
+ Collecting only those local keys helps us automatically setup your pipelines
109
+ for immediate use. After setup we also use your keys to detect when your keys locally have
110
+ changed from what is on Doppler. We then provide a way for you to adopt or reject those changes
111
+ through our dashboard. This can help help when debugging silent bugs or build failures.
112
+
113
+ ### Track Additional Keys
114
+ The Doppler client can also track additional keys by providing an array of keys to the `track_keys` field.
115
+
116
+ ``` ruby
117
+ Doppler.configure do |config|
118
+ # ...
119
+ config.track_keys = [
120
+ "KEY_TO_TRACK"
121
+ ]
122
+ end
123
+ ```
124
+
125
+ ### Ignoring Specific Keys
126
+ Inversely, you can also ignore specific local keys by adding them to the `ignore_keys` array.
127
+
128
+ ``` ruby
129
+ Doppler.configure do |config|
130
+ # ...
131
+ config.ignore_keys = [
132
+ "SUPER_SECRET_KEY"
133
+ ]
134
+ end
135
+ ```
136
+
137
+ ## Extra Information
138
+
139
+ - [Doppler](https://doppler.com)
140
+ - [API KEY](https://doppler.com/workplace/api_key)
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,30 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+
4
+ require "doppler/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "doppler"
8
+ spec.version = Doppler::VERSION
9
+ spec.authors = ["Doppler Team"]
10
+ spec.email = "brian@doppler.com"
11
+
12
+ spec.summary = "The official Doppler Ruby client."
13
+ spec.description = "Doppler helps you manage your API keys and secrets across all your projects. See https://doppler.com for details."
14
+ spec.homepage = "https://github.com/DopplerHQ/ruby-client"
15
+ spec.licenses = "Apache-2.0"
16
+
17
+ # Specify which files should be added to the gem when it is released.
18
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.16"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "minitest", "~> 5.0"
29
+ spec.add_development_dependency "hitimes", "~> 1.3"
30
+ end
@@ -0,0 +1,92 @@
1
+ require 'doppler/client'
2
+
3
+ module Doppler
4
+ # configure doppler host url
5
+ @@host_url = "https://api.doppler.com"
6
+ def self.host_url=(host)
7
+ @@host_url = host_url
8
+ end
9
+ def self.host_url
10
+ @@host_url
11
+ end
12
+
13
+ # configure api key
14
+ @@api_key = "sample-api-key"
15
+ def self.api_key=(api_key)
16
+ @@api_key = api_key
17
+ end
18
+ def self.api_key
19
+ @@api_key
20
+ end
21
+
22
+ # configure pipeline
23
+ @@pipeline = "sample-pipeline"
24
+ def self.pipeline=(pipeline)
25
+ @@pipeline = pipeline
26
+ end
27
+ def self.pipeline
28
+ @@pipeline
29
+ end
30
+
31
+ # configure environment
32
+ @@environment = "development_ruby"
33
+ def self.environment=(environment)
34
+ @@environment = environment
35
+ end
36
+ def self.environment
37
+ @@environment
38
+ end
39
+
40
+ # configure priority
41
+ PRIORITY_REMOTE = 0
42
+ PRIORITY_LOCAL = 1
43
+ @@priority = PRIORITY_REMOTE
44
+ def self.priority=(priority)
45
+ @@priority = priority
46
+ end
47
+ def self.priority
48
+ @@priority
49
+ end
50
+
51
+ # configure track keys
52
+ @@track_keys = []
53
+ def self.track_keys=(track_keys)
54
+ @@track_keys = track_keys
55
+ end
56
+ def self.track_keys
57
+ @@track_keys
58
+ end
59
+
60
+ # configure ignore keys
61
+ @@ignore_keys = []
62
+ def self.ignore_keys=(ignore_keys)
63
+ @@ignore_keys = ignore_keys
64
+ end
65
+ def self.ignore_keys
66
+ @@ignore_keys
67
+ end
68
+
69
+ # configure service to be mocked so that no screenshots are
70
+ # taken, and uploaded to service.
71
+ @@enable_service = false
72
+ def self.enable_service=(enable)
73
+ @@enable_service = enable
74
+ end
75
+ def self.enable_service
76
+ @@enable_service
77
+ end
78
+
79
+ # configure logger, which will be used to log issues if any
80
+ @@logger = Logger.new(STDOUT)
81
+ def self.logger=(new_logger)
82
+ @@logger = new_logger
83
+ end
84
+ def self.logger
85
+ @@logger
86
+ end
87
+
88
+ # helper to configure above variables.
89
+ def self.configure
90
+ yield(self)
91
+ end
92
+ end
@@ -0,0 +1,91 @@
1
+ require 'net/https'
2
+ require 'json'
3
+ require 'set'
4
+ require 'doppler/version'
5
+
6
+ module Doppler
7
+ class Client
8
+ MAX_RETRIES = 10
9
+ ENVIRONMENT_SEGMENT = '/environments/'
10
+
11
+ def initialize()
12
+ startup()
13
+ end
14
+
15
+ def startup
16
+ local_keys = ENV.to_hash
17
+ keys_to_send = local_keys.select { |k, _| Doppler.track_keys.include?(k) }
18
+
19
+ resp = self._request('/fetch_keys', {
20
+ 'local_keys' => keys_to_send
21
+ })
22
+
23
+ @remote_keys = resp['keys']
24
+ end
25
+
26
+ def get(key_name, priority = Doppler.priority)
27
+ value =
28
+ if priority == Doppler::PRIORITY_LOCAL
29
+ ENV[key_name] || @remote_keys[key_name]
30
+ else
31
+ @remote_keys[key_name] || ENV[key_name]
32
+ end
33
+
34
+ unless Doppler.ignore_keys.include?(key_name)
35
+ # TODO: Move this to a background job or thread once we get more customers!
36
+ upload_key_to_server(key_name, value)
37
+ end
38
+
39
+ value
40
+ end
41
+
42
+ def upload_key_to_server(key_name, value)
43
+ if value
44
+ if ENV[key_name] != @remote_keys[key_name]
45
+ _request('/track_key', {
46
+ 'local_keys' => {key_name: ENV[key_name]}
47
+ })
48
+ end
49
+ else
50
+ _request('/missing_key', {
51
+ 'key_name' => key_name
52
+ })
53
+ end
54
+ end
55
+
56
+ def _request(endpoint, body, retry_count=0)
57
+ raise ArgumentError, 'endpoint not string' unless endpoint.is_a? String
58
+
59
+ raw_url = Doppler.host_url + ENVIRONMENT_SEGMENT + Doppler.environment + endpoint
60
+ uri = URI.parse(raw_url)
61
+ header = {
62
+ 'Content-Type': 'application/json',
63
+ 'api-key': Doppler.api_key,
64
+ 'pipeline': Doppler.pipeline,
65
+ 'client-sdk': 'ruby',
66
+ 'client-version': Doppler::VERSION
67
+
68
+ }
69
+ http = ::Net::HTTP.new(uri.host, uri.port)
70
+ http.use_ssl = true
71
+
72
+ begin
73
+ response = http.post(uri.path, body.to_json, header)
74
+ response_data = JSON.parse(response.body)
75
+ if response_data['success'] == false
76
+ raise RuntimeError, response_data["messages"].join(". ")
77
+ end
78
+ rescue => e
79
+ retry_count += 1
80
+
81
+ if retry_count > MAX_RETRIES
82
+ raise e
83
+ else
84
+ return _request(endpoint, body, retry_count)
85
+ end
86
+ end
87
+
88
+ return response_data
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,3 @@
1
+ module Doppler
2
+ VERSION = "0.2.0".freeze
3
+ end
metadata ADDED
@@ -0,0 +1,111 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: doppler
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - Doppler Team
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-02-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: hitimes
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.3'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.3'
69
+ description: Doppler helps you manage your API keys and secrets across all your projects.
70
+ See https://doppler.com for details.
71
+ email: brian@doppler.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - CODE_OF_CONDUCT.md
78
+ - Gemfile
79
+ - Gemfile.lock
80
+ - LICENSE
81
+ - README.md
82
+ - Rakefile
83
+ - doppler.gemspec
84
+ - lib/doppler.rb
85
+ - lib/doppler/client.rb
86
+ - lib/doppler/version.rb
87
+ homepage: https://github.com/DopplerHQ/ruby-client
88
+ licenses:
89
+ - Apache-2.0
90
+ metadata: {}
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - ">="
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ required_rubygems_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 2.5.1
108
+ signing_key:
109
+ specification_version: 4
110
+ summary: The official Doppler Ruby client.
111
+ test_files: []