envoku 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cb3de23b25c163a12dc7320786b5e8aef7e6c0
-  data.tar.gz: ec871654478e09acec6316f18249e274fff24848
+  metadata.gz: df8eba959ce87373465892dd6c02893c3ed62a24
+  data.tar.gz: 590152bb2183123ba32ff460276cec05993ac7db
 SHA512:
-  metadata.gz: 8cbf3e539206de10ccedb8f7b264320435ab131d0241adc5dc6eb6c36c17c0b89b6b29a0b1918920badf0add8c631777f510b1530f49b048603933a876be93c2
-  data.tar.gz: 7f501e221cfc0bd53b87aa77a0b1ba87cc792e1daef744f423fc65626e2b447bae169ee193cc468beb25c8b2801720c1de032d430a44b94a32a4739ac77bcff2
+  metadata.gz: 9e7ab915b62d44ba83a0db455d6b38182e7a17d5c4b11e230a4dbab2eab496a712794d8977e1db68f980d8c1574d94798ada72f4df29bebe795bead0f369afdc
+  data.tar.gz: 847edf89174d7f138277aa5e56711daf812863abbf03201abe87801df9d07d63ff2739f516e855a3cb8d436edade4e2acf95d1b1a9f7ccd88014806444149ed8

data/.simplecov

@@ -2,10 +2,10 @@ require "codeclimate-test-reporter"
 require 'codecov'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  CodeClimate::TestReporter::Formatter,
-  SimpleCov::Formatter::Codecov,
+  (CodeClimate::TestReporter::Formatter if ENV['CODECLIMATE_REPO_TOKEN']),
+  (SimpleCov::Formatter::Codecov if ENV['CODECOV_TOKEN']),
   SimpleCov::Formatter::HTMLFormatter,
-])
+].compact)
 SimpleCov.start do
   add_filter "spec"
   add_group "Adapters", "lib/envoku/adapters/"

data/README.md

@@ -6,7 +6,9 @@
 [![Code Climate](https://codeclimate.com/github/marcqualie/envoku-ruby/badges/gpa.svg)](https://codeclimate.com/github/marcqualie/envoku-ruby)
 [![Issue Count](https://codeclimate.com/github/marcqualie/envoku-ruby/badges/issue_count.svg)](https://codeclimate.com/github/marcqualie/envoku-ruby)
 
-Configuration storage that can be loaded into your application transparently at boot-time.
+**WIP:** This gem is currently under active development. Until **1.0** version backwards-incompatible changes may be introduced with each **0.x** minor version.
+
+Configuration and feature management that is pre-loaded into your application at boot-time.
 
 
 ## Installation
@@ -19,21 +21,23 @@ gem 'envoku'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install envoku
+    $ bundle install
 
 
 ## Usage
 
 When Envoku is loaded it automatically uses Dotenv in the background to preload and other configuration mechanisms you may have to make transitioning seamless.
 
+
 ### Rails
 
 Envoku automatically pre-loads itself during `before_configuration` phase so no configuration is required.
 
+### Sinatra
+
+Use the plain ruby method as early as possible, before any `ENV` variables are accessed. Usually at the top of `app.rb`.
+
+
 ### Plain ruby
 
 Run the following code before you need access to the environment variables
@@ -45,6 +49,12 @@ Envoku.load
 
 ## Features
 
+Feature are defined as standard environment variables as YAML objects in the following format:
+
+``` shell
+ENVOKU_FEATURE_FEATURE1="description: 'Example feature', attribute1: 'something'"
+```
+
 ``` ruby
 all_features = Envoku::Feature.all
 feature = Envoku::Feature.new('FEATURE1')
@@ -52,11 +62,19 @@ feature.enabled? # global for all resources
 feature.enabled_for?(current_user) # does current_user have this feature enabled
 feature.enable_for!(current_user) # enable feature for current_user
 feature.disable_for!(current_user) # disable feature for current_user
+feature.attributes # {"attribute1" => "something"}
+feature.permitted_for?('User') # whether or not this feature is designed for a resource
 resource.feature_enabled?('FEATURE1')
 resource.toggle_feature!('FEATURE1')
 resource.features_enabled
 ```
 
+By default, all features can be used against all resources. To restrict a feature to a certain resource:
+
+``` shell
+ENVOKU_FEATURE_FEATURE1="permitted_resources: 'Organization,User'"
+```
+
 Per-resource features are stored in Redis via the following keys:
 
 ```
@@ -65,6 +83,13 @@ Per-resource features are stored in Redis via the following keys:
 ```
 
 
+## Todo
+
+- ~~Logging~~
+- ~~Show warning when toggling features for non-permitted resources~~
+- Add `Envoku.configure {}` functionality
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/envoku.rb

@@ -1,32 +1,51 @@
 require "redis"
+require "logger"
 
 require "envoku/version"
 require "envoku/adapters/s3"
 require "envoku/feature"
+require "envoku/logger"
 require "envoku/resource"
+require "envoku/utils"
+
+Dotenv.load("#{Dir.pwd}/.env") if defined?(Dotenv) && ENV['RAILS_ENV'] != "test"
 
 require "envoku/rails" if defined?(Rails)
 
 module Envoku
 
+  URL = Envoku::Utils.parsed_url
+  URI = Envoku::Utils.parsed_uri
+
   module_function
 
   def load(options = {})
-    instance = Envoku::Adapters::S3.new options
+    Envoku.logger.info("load using S3 adapter")
+    instance = Envoku::Adapters::S3.new(options)
     instance.load
   end
 
-  def redis
-    @redis ||= ::Redis.new(
-      url: (ENV['ENVOKU_REDIS_URL'] || ENV['REDIS_URL']),
-    )
+  def get_all
+    adapter = Envoku::Adapters::S3.new
+    adapter.load
+    adapter.get_all
   end
 
-  def feature_enabled_for?(feature_name, resource)
-    Feature.new(feature_name).enabled_for?(resource)
+  def get(key)
+    adapter = Envoku::Adapters::S3.new
+    adapter.load
+    adapter.get(key)
   end
 
-  def features_enabled_for(resource)
-    redis.smembers("#{Feature::REDIS_NAMESPACE}#{resource.class.name}:#{resource.id}")
+  def set(key, value)
+    adapter = Envoku::Adapters::S3.new
+    adapter.load
+    adapter.set(key, value)
+  end
+
+  def redis
+    @redis ||= ::Redis.new(
+      url: (ENV['ENVOKU_REDIS_URL'] || ENV['REDIS_URL']),
+    )
   end
 end

data/lib/envoku/adapters/s3.rb

@@ -12,7 +12,7 @@ module Envoku
 
       attr_reader :options
 
-      def initialize custom_options = {}
+      def initialize(custom_options = {})
         default_options = {
           filename: nil,
           bucket_name: nil,
@@ -21,19 +21,47 @@ module Envoku
         }
         @options = OpenStruct.new default_options.merge(custom_options)
         @local_file_name = "/tmp/envoku-#{SecureRandom.hex 16}.env"
+        @data = {}
       end
 
       def load
-        Dotenv.load
+        Envoku.logger.debug("Loading via S3 Adapter")
         apply_environment_options
         return unless options.bucket_name && options.filename && options.access_key_id && options.secret_access_key
+        Envoku.logger.debug("Downloading \"#{options.bucket_name}/#{options.filename}\" from S3")
         FileUtils.rm @local_file_name if File.exists? @local_file_name
         return unless clone_s3_file
-        Dotenv.load @local_file_name
+        @_env_before = ENV.to_h
+        Envoku.logger.debug("Applying ENV vars from S3")
+        @data = Dotenv.load(@local_file_name) || {}
+        @_env_after = ENV.to_h
+        # TODO: Abstract the env diff to adapter base
+        @_env_after.each do |key, value|
+          if !@_env_before.has_key?(key)
+            Envoku.logger.debug("- ADD #{key}")
+            # @data[key] = value
+          elsif @_env_before[key] != value
+            Envoku.logger.debug("- MOD #{key}")
+            # @data[key] = value
+          end
+        end
         FileUtils.rm @local_file_name
         ENV['ENVOKU_REFRESHED_AT'] = Time.now.to_s
       end
 
+      def get_all
+        @data
+      end
+
+      def get(key)
+        @data[key]
+      end
+
+      def set(key, value)
+        # TODO: Not yet implemented
+        @data[key] = value
+      end
+
       private
 
       def clone_s3_file
@@ -48,7 +76,7 @@ module Envoku
           "Expires=#{s3_expires_at.to_i}",
           "Signature=#{CGI.escape Base64.encode64(hmac).strip}"
         ]
-        s3_signed_uri = URI.parse "#{s3_direct_url}?#{query_params.join('&')}"
+        s3_signed_uri = ::URI.parse "#{s3_direct_url}?#{query_params.join('&')}"
         s3_response = Net::HTTP.get_response s3_signed_uri
         if s3_response.is_a? Net::HTTPSuccess
           File.write @local_file_name, s3_response.body
@@ -56,13 +84,12 @@ module Envoku
       end
 
       def apply_environment_options
-        if ENV['ENVOKU_URL']
-          envoku_uri = URI.parse(ENV['ENVOKU_URL'])
-          return nil unless envoku_uri.host && envoku_uri.path && envoku_uri.user && envoku_uri.password
-          @options.filename ||= envoku_uri.path[1..-1]
-          @options.bucket_name ||= envoku_uri.host
-          @options.access_key_id ||= envoku_uri.user
-          @options.secret_access_key ||= envoku_uri.password
+        if Envoku::URL
+          return nil unless Envoku::URI && Envoku::URI.host && Envoku::URI.path && Envoku::URI.user && Envoku::URI.password
+          @options.filename ||= Envoku::URI.path[1..-1]
+          @options.bucket_name ||= Envoku::URI.host
+          @options.access_key_id ||= Envoku::URI.user
+          @options.secret_access_key ||= ::URI.unescape(Envoku::URI.password)
         else
           @options.filename ||= ENV['ENVOKU_FILENAME']
           @options.bucket_name ||= ENV['ENVOKU_BUCKET']

data/lib/envoku/feature.rb

@@ -1,12 +1,24 @@
 require 'yaml'
 
 module Envoku
+
+  module_function
+
+  def feature_enabled_for?(feature_name, resource)
+    Feature.new(feature_name).enabled_for?(resource)
+  end
+
+  def features_enabled_for(resource)
+    redis.smembers("#{Feature::REDIS_NAMESPACE}#{resource.class.name}:#{resource.id}")
+  end
+
   class Feature
     ENV_NAMESPACE = "ENVOKU_FEATURE_"
     REDIS_NAMESPACE = "envoku:features:"
 
     attr_reader :name
     attr_reader :description
+    attr_reader :attributes
 
     def self.all
       keys = ENV.select { |key, value| key.index(ENV_NAMESPACE) == 0 }
@@ -18,13 +30,15 @@ module Envoku
     def initialize(name)
       @name = name
       @enabled = false
+      @attributes = {}
+      @description = nil
       var_string = ENV["#{ENV_NAMESPACE}#{name}"]
       return nil unless var_string
-      attributes = ::YAML.safe_load(var_string) rescue {}
-      attributes.each do |key, value|
-        instance_variable_set(:"@#{key}", value)
-      end
-      @enabled = !!@enabled
+      @attributes = ::YAML.safe_load(var_string) rescue {}
+      @description = @attributes['description']
+      @enabled = !!@attributes['enabled']
+      @attributes.delete('description')
+      @attributes.delete('enabled')
     end
 
     def enabled?
@@ -37,6 +51,7 @@ module Envoku
     end
 
     def enable_for!(resource)
+      Envoku.logger.warn("feature #{name} is not permitted for #{resource.class.name}") unless permitted_for?(resource.class.name)
       Envoku.redis.multi do
         Envoku.redis.sadd("#{REDIS_NAMESPACE}#{@name}:#{resource.class.name}", resource.id.to_s)
         Envoku.redis.sadd("#{REDIS_NAMESPACE}#{resource.class.name}:#{resource.id}", @name)
@@ -44,6 +59,7 @@ module Envoku
     end
 
     def disable_for!(resource)
+      Envoku.logger.warn("feature #{name} is not permitted for #{resource.class.name}") unless permitted_for?(resource.class.name)
       Envoku.redis.multi do
         Envoku.redis.del("#{REDIS_NAMESPACE}#{@name}:#{resource.class.name}")
         Envoku.redis.del("#{REDIS_NAMESPACE}#{resource.class.name}:#{resource.id}")
@@ -54,6 +70,12 @@ module Envoku
       enabled_for?(resource) ? disable_for!(resource) : enable_for!(resource)
     end
 
+    def permitted_for?(resource_klass)
+      return true unless @attributes.has_key?('permitted_resources')
+      resource_klass = resource_klass.class.name unless resource_klass.is_a?(String)
+      @attributes['permitted_resources'].split(',').include?(resource_klass)
+    end
+
     def resources
       list = []
       feature_prefix = "#{REDIS_NAMESPACE}#{@name}"

data/lib/envoku/logger.rb

@@ -0,0 +1,23 @@
+require "logger"
+
+module Envoku
+
+  module_function
+
+  def logger
+    @_logger ||= Envoku::Logger.new(STDOUT)
+  end
+
+  def logger=(logger)
+    @_logger = logger
+  end
+
+  class Logger < ::Logger
+    def initialize(*args)
+      super
+      @progname = "envoku"
+      log_level = (ENV["ENVOKU_LOG_LEVEL"] || ENV["LOG_LEVEL"] || "").upcase
+      @level = ["DEBUG", "INFO", "WARN", "ERROR", "FATAL", "UNKNOWN"].index(log_level) != nil ? Logger.const_get(log_level) : Logger::INFO
+    end
+  end
+end

data/lib/envoku/utils.rb

@@ -0,0 +1,27 @@
+require "uri"
+
+module Envoku
+  module Utils
+
+    module_function
+
+    def parsed_url
+      return nil if ENV['ENVOKU_URL'] == nil || ENV['ENVOKU_URL'] == ""
+      ENV['ENVOKU_URL']
+    end
+
+    def parsed_uri
+      return nil unless parsed_url
+      parser = ::URI::RFC2396_Parser.new
+      uri = parser.parse(parsed_url)
+      uri
+    rescue Exception => error
+      Envoku.logger.error("URI Parse Error: URL = #{parsed_url || '[not set]'}")
+      Envoku.logger.error("  #{error.message}")
+      (0..2).each do |index|
+        Envoku.logger.error("  #{error.backtrace[index]}")
+      end
+      nil
+    end
+  end
+end

data/lib/envoku/version.rb

@@ -1,3 +1,3 @@
 module Envoku
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tasks/envoku.rake

@@ -9,7 +9,8 @@ namespace :envoku do
 
   desc "Show Envoku Info"
   task :info => :load do
-    puts "URL: #{ENV['ENVOKU_URL'] ? ENV['ENVOKU_URL'] : "[not set]"}"
+    puts "URL: #{Envoku::URL || '[not set]'}"
+    puts "URI: #{Envoku::URI.to_yaml}"
   end
 
   desc "List Envoku Features"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envoku
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Qualie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -132,8 +132,10 @@ files:
 - lib/envoku/adapters.rb
 - lib/envoku/adapters/s3.rb
 - lib/envoku/feature.rb
+- lib/envoku/logger.rb
 - lib/envoku/rails.rb
 - lib/envoku/resource.rb
+- lib/envoku/utils.rb
 - lib/envoku/version.rb
 - lib/tasks/envoku.rake
 - script/console