doppler 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81538ad7d067d1717e14ad49885bdbc7f059a64b
-  data.tar.gz: 90ddb9cfaecb4f9985d7ddfeb224804d69a254e1
+  metadata.gz: b02a59489c478d737e5969eab8cf3afecb217c49
+  data.tar.gz: a2335a4f35579d0f3023d5bc3558568562ba2a3b
 SHA512:
-  metadata.gz: cf98ba4bcbb81edce4bde1e3c63c56d9a3f057e028085ad2a2c41182bc920db948f14f870c9915aa1427728c68c340c3f884eab5c1d11ca0e32eb6cbd0c3304b
-  data.tar.gz: dff21398b8d3b1f40a5876d9d3418f972b060c460d27ffad48572efb99cfb4da44a05707cd1dcafbb23b8d226bb70cb9b922a556449c0bb3f4d31a6e1194b560
+  metadata.gz: 3113831876da0c9fe14815642e4e87aa1e41ec5e0b2250b7765068df9d2b1cf0357b5170a7c11f20c7e27784fc4d95db8307c49bbcafa16880fce56c2259bc93
+  data.tar.gz: 4bab5c34a684a22e225fa9bbcd0ccd4d3dbc2d7d7efa263f70204f5f46c62bc978a7f3d2f58db92bdfd066c39fcfaf8d57a71a35ce18803b1564c9d2803c042a

data/.gitignore

@@ -12,6 +12,7 @@
 
 # Used by dotenv library to load environment variables.
 # .env
+backup.env
 
 ## Specific to RubyMotion:
 .dat*

data/README.md

@@ -17,120 +17,71 @@ gem install doppler
 
 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:
 
-``` ruby
-require "doppler"
-
-Doppler.configure do |config|
-  config.api_key = "api-key"
-  config.pipeline = "31"
-  config.environment = "development_ruby"
-  config.priority = Doppler::PRIORITY_REMOTE
-end
 
+### Environment Variables Required
+Please add these environment variables to your `.env` file or infra provider.
 
-doppler = Doppler::Client.new()
-
-# Rest of Application
 ```
-
-## Key Best Practices
-
-So if Doppler stores my environment keys, where should I keep my Doppler API keys?
-
-That is a great question! We recommend storing your `API_KEY`, `PIPELINE_ID`, and `ENVIRONMENT_NAME`
-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.
-
-### Fetch Environment Keys
-
-You can fetch your environment keys from Doppler by calling the `get(name)` method.
-
-``` ruby
-doppler.get(KEY_NAME)
+DOPPLER_API_KEY = <API Key>
+DOPPLER_PIPELINE = <Pipeline ID>
+DOPPLER_ENVIRONMENT = <Environment Name>
 ```
 
-Here is an example:
+### Simple Install
+This installation method will expect the `DOPPLER_API_KEY`, `DOPPLER_PIPELINE`, `DOPPLER_ENVIRONMENT` as environment variables.
 
 ``` ruby
-config = {
-  "segment_key" => doppler.get("SEGMENT_API_KEY"),
-  "algolia_key" => doppler.get("ALGOLIA_API_KEY")
-}
+require "doppler"
+Doppler::Client.new()
 
+# Rest of Application
 ```
 
-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.
-
-For example:
+### Install with Arguments
+This installation method will expect the `api_key`, `pipeline`, `environment` as arguments.
 
 ``` ruby
-# Local Enviroment
-os.environ["MAGICAL_KEY"] = "123"
-
-# Doppler
-MAGICAL_KEY = "456"
-
-
-# Default Behavior
-doppler.get("MAGICAL_KEY") # => "456"
-
-# Override to Local
-doppler.get("MAGICAL_KEY", Doppler::Priority.local) # => "123"
-```
-
-You can also set the priority globally on initialization:
+require "doppler"
 
-``` ruby
 Doppler.configure do |config|
-  # ...
-  config.priority = Doppler::PRIORITY_LOCAL
+  config.api_key = ENV["DOPPLER_API_KEY"]
+  config.pipeline = ENV["DOPPLER_PIPELINE"]
+  config.environment = ENV["DOPPLER_ENVIRONMENT"]
 end
-```
 
-## Rails integration
 
-Configure `Doppler` with keys and environments, and then you should be all good.
-Please use the following snippet in initializer folder.
+Doppler::Client.new()
 
-```rb
-Doppler.configure do |config|
-  config.api_key = "api-key"
-  config.pipeline = "31"
-  config.environment = "development_ruby"
-  config.priority = Doppler::PRIORITY_REMOTE
-end
+# Rest of Application
 ```
 
-Example repo found [here](https://github.com/DopplerHQ/rails-sample).
+## Key Best Practices
+
+So if Doppler stores my environment variables, where should I keep my Doppler API keys?
 
-## Local Key Privacy
+That is a great question! We recommend storing your `DOPPLER_API_KEY`, `DOPPLER_PIPELINE`, and `DOPPLER_ENVIRONMENT` 
+in a `.env` file or with your infra provider. That means the only variables you should be storing in your local environment are the Doppler keys. All other variables should be be fetched by the Doppler client.
 
-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.
 
-### Track Additional Keys
-The Doppler client can also track additional keys by providing an array of keys to the `track_keys` field.
+## Ignoring Specific Variables
+
+In the case you would want to ignore specific variables from Doppler, say a port set by Heroku, you can add it the `ignore_variables` field.
 
 ``` ruby
 Doppler.configure do |config|
-  # ...
-  config.track_keys = [
-    "KEY_TO_TRACK"
-  ]
+  config.ignore_variables = ["PORT"]
 end
 ```
 
-### Ignoring Specific Keys
-Inversely, you can also ignore specific local keys by adding them to the `ignore_keys` array.
+## Fallback to Backup
+
+The Doppler client accepts a `backup_filepath` on init. If provided the client will write
+the Doppler variables to a backup file. If the Doppler client fails to connect to our API
+endpoint (very unlikely), the client will fallback to the variables provided in the backup file.
 
 ``` ruby
 Doppler.configure do |config|
-  # ...
-  config.ignore_keys = [
-    "SUPER_SECRET_KEY"
-  ]
+  config.backup_filepath = "./backup.env"
 end
 ```
 

data/lib/doppler.rb

@@ -11,7 +11,7 @@ module Doppler
   end
 
   # configure api key
-  @@api_key = "sample-api-key"
+  @@api_key = ENV["DOPPLER_API_KEY"]
   def self.api_key=(api_key)
     @@api_key = api_key
   end
@@ -20,7 +20,7 @@ module Doppler
   end
 
   # configure pipeline
-  @@pipeline = "sample-pipeline"
+  @@pipeline = ENV["DOPPLER_PIPELINE"]
   def self.pipeline=(pipeline)
     @@pipeline = pipeline
   end
@@ -29,7 +29,7 @@ module Doppler
   end
 
   # configure environment
-  @@environment = "development_ruby"
+  @@environment = ENV["DOPPLER_ENVIRONMENT"]
   def self.environment=(environment)
     @@environment = environment
   end
@@ -37,56 +37,27 @@ module Doppler
     @@environment
   end
 
-  # configure priority
-  PRIORITY_REMOTE = 0
-  PRIORITY_LOCAL = 1
-  @@priority = PRIORITY_REMOTE
-  def self.priority=(priority)
-    @@priority = priority
+  # configure ignore variables
+  @@ignore_variables = []
+  def self.ignore_variables=(ignore_variables)
+    @@ignore_variables = ignore_variables
   end
-  def self.priority
-    @@priority
+  def self.ignore_variables
+    @@ignore_variables
   end
-
-  # configure track keys
-  @@track_keys = []
-  def self.track_keys=(track_keys)
-    @@track_keys = track_keys
-  end
-  def self.track_keys
-    @@track_keys
-  end
-
-  # configure ignore keys
-  @@ignore_keys = []
-  def self.ignore_keys=(ignore_keys)
-    @@ignore_keys = ignore_keys
-  end
-  def self.ignore_keys
-    @@ignore_keys
-  end
-
-  # configure service to be mocked so that no screenshots are
-  # taken, and uploaded to service.
-  @@enable_service = false
-  def self.enable_service=(enable)
-    @@enable_service = enable
-  end
-  def self.enable_service
-    @@enable_service
-  end
-
-  # configure logger, which will be used to log issues if any
-  @@logger = Logger.new(STDOUT)
-  def self.logger=(new_logger)
-    @@logger = new_logger
+  
+  # configure backup file
+  @@backup_filepath = nil
+  def self.backup_filepath=(backup_filepath)
+    @@backup_filepath = backup_filepath
   end
-  def self.logger
-    @@logger
+  def self.backup_filepath
+    @@backup_filepath
   end
 
   # helper to configure above variables.
   def self.configure
     yield(self)
   end
+  
 end

data/lib/doppler/client.rb

@@ -1,6 +1,5 @@
 require 'net/https'
 require 'json'
-require 'set'
 require 'doppler/version'
 
 module Doppler
@@ -9,50 +8,57 @@ module Doppler
     ENVIRONMENT_SEGMENT = '/environments/'
 
     def initialize()
+      if Doppler.api_key.nil?
+        raise "Please provide a api key"
+      end
+      
+      if Doppler.pipeline.nil?
+        raise "Please provide a pipeline"
+      end
+      
+      
+      if Doppler.environment.nil?
+        raise "Please provide a environment"
+      end
+         
       startup()
     end
 
     def startup
-      local_keys = ENV.to_hash
-      keys_to_send = local_keys.select { |k, _| Doppler.track_keys.include?(k) }
-
-      resp = self._request('/fetch_keys', {
-                             'local_keys' => keys_to_send
-                           })
-
-      @remote_keys = resp['keys']
+      resp = self._request('/fetch_keys', {})
+      @remote_keys = resp.fetch("keys")
+      
+      overwrite_env()
+      write_to_backup()
     end
-
-    def get(key_name, priority = Doppler.priority)
-      value =
-        if priority == Doppler::PRIORITY_LOCAL
-          ENV[key_name] || @remote_keys[key_name]
-        else
-          @remote_keys[key_name] || ENV[key_name]
+    
+    
+    def overwrite_env      
+      if @remote_keys.nil? 
+        return
+      end
+      
+      @remote_keys.each do |key, value|        
+        unless Doppler.ignore_variables.include?(key)
+          ENV[key] = value
         end
-
-      unless Doppler.ignore_keys.include?(key_name)
-        # TODO: Move this to a background job or thread once we get more customers!
-        upload_key_to_server(key_name, value)
       end
-
-      value
     end
-
-    def upload_key_to_server(key_name, value)
-      if value
-        if ENV[key_name] != @remote_keys[key_name]
-          _request('/track_key', {
-                     'local_keys' => {key_name: ENV[key_name]}
-                   })
+    
+    
+    def write_to_backup
+      unless Doppler.backup_filepath.nil?
+        file = File.open(Doppler.backup_filepath, "w")
+        
+        @remote_keys.each do |key, value|
+          file.puts key + "=" + value
         end
-      else
-        _request('/missing_key', {
-                   'key_name' => key_name
-                 })
+        
+        file.close
       end
     end
 
+
     def _request(endpoint, body, retry_count=0)
       raise ArgumentError, 'endpoint not string' unless endpoint.is_a? String
 
@@ -75,11 +81,30 @@ module Doppler
         if response_data['success'] == false
           raise RuntimeError, response_data["messages"].join(". ")
         end
+        
       rescue => e
         retry_count += 1
 
         if retry_count > MAX_RETRIES
-          raise e
+          if Doppler.backup_filepath.nil? or !File.file?(Doppler.backup_filepath)
+            raise e
+          end
+          
+          keys = {}
+          File.open(Doppler.backup_filepath, "r") do |file|
+            file.each do |line| 
+              parts = line.strip!.split("=")
+              
+              if parts.length == 2
+                keys[parts[0]] = parts[1]
+              end
+            end
+          end
+          
+          data = {}
+          data["keys"] = keys
+          return data
+          
         else
           return _request(endpoint, body, retry_count)
         end

data/lib/doppler/version.rb

@@ -1,3 +1,3 @@
 module Doppler
-  VERSION = "0.2.0".freeze
+  VERSION = "1.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doppler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Doppler Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler