doppler-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d7f6b03743332da764917f49710df2b127cb344
-  data.tar.gz: 29877f453214135f86556bed11be6991fe329ff6
+  metadata.gz: 9bb08eeff831da656b658d211696f8fc98b9c306
+  data.tar.gz: f80ffc0eee91e244d990bbc06bda63882ee46a4d
 SHA512:
-  metadata.gz: 433a86772655ccfd58e78f3ba29d058c5a23c1671a242d2667dfd1a312cb87bed2a9876f5ab2c46912e564d4628b28794c3f2b5143dbbc4895dd270e0ac8f048
-  data.tar.gz: 9a890472004451d05d85f8d20694cb0eac73839be203aecf92da59f66f3412b73bd46b2794714f25f124727196928366f6aea5d0771704f3a61ee640a7a71c9b
+  metadata.gz: 7127af99279f088c652c1e90e4b1644c78a02d140729c0e52b4210e5bf4b4776e4c35f71635006899fd78a02ec471825497930862170b1f5d1c255006bfb79e2
+  data.tar.gz: 0d8c635f4911b7f92edf01b1754c200a60effe17665fe00e5a8ef5828f02b950822afd06bc891395120409186c94c169f8f27c67d41b461a4fb78c864929a55d

data/README.md

@@ -81,7 +81,7 @@ You can also set the priority globally on initialization:
 doppler = Doppler::Client.new(
   api_key = ENV["API_KEY"],
   pipeline = ENV["PIPELINE_ID"],
-  environment = ENV["ENVIRONMENT_NAME"]
+  environment = ENV["ENVIRONMENT_NAME"],
   priority = Doppler::Priority.local
 )
 
@@ -90,32 +90,39 @@ doppler = Doppler::Client.new(
 
 ## Local Key Privacy
 
-By default the Doppler client will send all your local environment keys on `init`. This
-is done for 2 reasons. Collecting your local keys helps us automatically setup your pipelines
+By default the Doppler client will only track the local environment keys that are used during `doppler.get()`.
+Collecting only those local keys helps us automatically setup your pipelines
 for immediate use. After setup we also use your keys to detect when your keys locally have
 changed from what is on Doppler. We then provide a way for you to adopt or reject those changes
 through our dashboard. This can help help when debugging silent bugs or build failures.
 
-If you would like the Doppler client to not send your keys we provide 2 ways to do it.
-
-### Globally
-To ensure all your local keys are not sent to Doppler, set the `send_local_keys` attribute to `false`.
+### Track Additional Keys
+The Doppler client can also track additional keys by providing an array of keys to the `track_keys` field.
 
 ``` ruby
 doppler = Doppler::Client.new(
-  # ...
-  send_local_keys = false  # DEFAUTLS => True
+  api_key = ENV["API_KEY"],
+  pipeline = ENV["PIPELINE_ID"],
+  environment = ENV["ENVIRONMENT_NAME"],
+  priority = Doppler::Priority.local,
+  track_keys = [
+    "KEY_TO_TRACK"
+  ]
 )
 ```
 
 
-### Individual Key
-You can also ignore specific local keys by adding them to the `ignore_keys` array.
+### Ignoring Specific Keys
+Inversely, you can also ignore specific local keys by adding them to the `ignore_keys` array.
 
 ``` ruby
 doppler = Doppler::Client.new(
-  # ...
-  ignore_keys: [
+  api_key = ENV["API_KEY"],
+  pipeline = ENV["PIPELINE_ID"],
+  environment = ENV["ENVIRONMENT_NAME"],
+  priority = Doppler::Priority.local,
+  track_keys = [],
+  ignore_keys = [
     "SUPER_SECRET_KEY"
   ]
 )

data/doppler-client.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "doppler-client"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   spec.authors       = ["Doppler Team"]
   spec.email         = "brian@doppler.market"
 

data/lib/doppler/client.rb

@@ -1,4 +1,3 @@
-require "doppler/client/version"
 require 'net/https'
 require 'json'
 require 'set'
@@ -22,17 +21,19 @@ module Doppler
     @@environ_segment = '/environments/'
     @@max_retries = 0
 
-    def initialize(api_key, pipeline, environment, priority = Priority.remote, send_local_keys = true, ignore_keys = [])
+    def initialize(api_key, pipeline, environment, priority = Priority.remote, track_keys = [], ignore_keys = [])
         raise ArgumentError, 'api_key not string' unless api_key.is_a? String
         raise ArgumentError, 'pipeline not string' unless pipeline.is_a? String
         raise ArgumentError, 'api_key not string' unless environment.is_a? String
         raise ArgumentError, 'priority not numeric' unless priority.is_a? Numeric 
+        raise ArgumentError, 'track_keys not array' unless track_keys.is_a? Array 
+        raise ArgumentError, 'ignore_keys not array' unless ignore_keys.is_a? Array 
 
         @api_key = api_key
         @pipeline = pipeline
         @environment = environment
         @default_priority = priority
-        @send_local_keys = send_local_keys
+        @track_keys = track_keys.to_set
         @ignore_keys = ignore_keys.to_set
         @host = ENV[@@host_key] ? ENV[@@host_key] : @@default_host
         
@@ -45,7 +46,7 @@ module Doppler
         
         if @send_local_keys
             local_keys.each do |key, value|                
-                if not @ignore_keys.include?(key)
+                if @track_keys.include?(key)
                     keys_to_send[key] = value
                 end  
             end
@@ -60,22 +61,33 @@ module Doppler
 
     def get(key_name, priority = nil)
         priority = priority != nil ? priority : @default_priority
-
-        if @remote_keys.key?(key_name)
-            if priority == Priority.local
-                return ENV[key_name] ? ENV[key_name] : @remote_keys[key_name]
-            else
-                return @remote_keys[key_name]
-            end
+        value = nil
+        
+        if priority == Priority.local
+            value = ENV[key_name] ? ENV[key_name] : @remote_keys[key_name]
+        else
+            value = @remote_keys[key_name] ? @remote_keys[key_name] : ENV[key_name]
         end
         
         if not @ignore_keys.include?(key_name)
-            _request('/missing_key', {
-                'key_name' => key_name
-            })
+              if value != nil
+                if ENV[key_name] != @remote_keys[key_name]
+                    local_keys = {}
+                    local_keys[key_name] = ENV[key_name]
+                    
+                    _request('/track_key', {
+                        'local_keys' => local_keys
+                    })
+                end
+            else
+                _request('/missing_key', {
+                    'key_name' => key_name
+                })
+                
+            end
         end
 
-        return ENV[key_name]
+        return value
     end
 
     def _request(endpoint, body, retry_count=0)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doppler-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Doppler Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler