super_settings 0.0.0.rc1 → 0.0.1.rc1

data/lib/super_settings/setting.rb

@@ -5,7 +5,7 @@ module SuperSettings
   # updating settings.
   #
   # This class does not deal with actually persisting settings to and fetching them from a data store.
-  # You need to specify the storage engine you want to use with the `storage` class method. This gem
+  # You need to specify the storage engine you want to use with the +storage+ class method. This gem
   # ships with storage engines for ActiveRecord, Redis, and HTTP (microservice). See the SuperSettings::Storage
   # class for more details.
   class Setting
@@ -17,9 +17,8 @@ module SuperSettings
     BOOLEAN = "boolean"
     DATETIME = "datetime"
     ARRAY = "array"
-    SECRET = "secret"
 
-    VALUE_TYPES = [STRING, INTEGER, FLOAT, BOOLEAN, DATETIME, ARRAY, SECRET].freeze
+    VALUE_TYPES = [STRING, INTEGER, FLOAT, BOOLEAN, DATETIME, ARRAY].freeze
 
     ARRAY_DELIMITER = /[\n\r]+/.freeze
 
@@ -36,8 +35,8 @@ module SuperSettings
 
     class << self
       # Set a cache to use for caching values. This feature is optional. The cache must respond
-      # to `delete(key)` and `fetch(key, &block)`. If you are running in a Rails environment,
-      # you can use `Rails.cache` or any ActiveSupport::Cache::Store object.
+      # to +delete(key)+ and +fetch(key, &block)+. If you are running in a Rails environment,
+      # you can use +Rails.cache+ or any ActiveSupport::Cache::Store object.
       attr_accessor :cache
 
       # Set the storage class to use for persisting data.
@@ -56,6 +55,7 @@ module SuperSettings
       end
 
       # Create a new setting with the specified attributes.
+      #
       # @param attributes [Hash] hash of attribute names and values
       # @return [Setting]
       def create!(attributes)
@@ -68,6 +68,7 @@ module SuperSettings
 
       # Get all the settings. This will even return settings that have been marked as deleted.
       # If you just want current settings, then call #active instead.
+      #
       # @return [Array<Setting>]
       def all
         storage.with_connection do
@@ -76,6 +77,7 @@ module SuperSettings
       end
 
       # Get all the current settings.
+      #
       # @return [Array<Setting>]
       def active
         storage.with_connection do
@@ -84,6 +86,7 @@ module SuperSettings
       end
 
       # Get all settings that have been updated since the specified time stamp.
+      #
       # @param time [Time]
       # @return [Array<Setting>]
       def updated_since(time)
@@ -93,6 +96,7 @@ module SuperSettings
       end
 
       # Get a setting by its unique key.
+      #
       # @return Setting
       def find_by_key(key)
         record = storage.with_connection { storage.find_by_key(key) }
@@ -103,6 +107,7 @@ module SuperSettings
 
       # Return the maximum updated at value from all the rows. This is used in the caching
       # scheme to determine if data needs to be reloaded from the database.
+      #
       # @return [Time]
       def last_updated_at
         fetch_from_cache(LAST_UPDATED_CACHE_KEY) do
@@ -113,22 +118,20 @@ module SuperSettings
       # Bulk update settings in a single database transaction. No changes will be saved
       # if there are any invalid records.
       #
-      # Example:
+      # @example
       #
-      # ```
-      # SuperSettings.bulk_update([
-      #   {
-      #     key: "setting-key",
-      #     value: "foobar",
-      #     value_type: "string",
-      #     description: "A sample setting"
-      #   },
-      #   {
-      #     key: "setting-to-delete",
-      #     deleted: true
-      #   }
-      # ])
-      # ```
+      #   SuperSettings.bulk_update([
+      #     {
+      #       key: "setting-key",
+      #       value: "foobar",
+      #       value_type: "string",
+      #       description: "A sample setting"
+      #     },
+      #     {
+      #       key: "setting-to-delete",
+      #       deleted: true
+      #     }
+      #   ])
       #
       # @param params [Array] Array of hashes with setting attributes. Each hash must include
       #   a "key" element to identify the setting. To update a key, it must also include at least
@@ -136,7 +139,7 @@ module SuperSettings
       #   the hash, it will be updated. If a setting with the given key does not exist, it will be created.
       #   A setting may also be deleted by providing the attribute "deleted: true".
       # @return [Array] Boolean indicating if update succeeded, Array of settings affected by the update;
-      #   if the settings were not updated, the `errors` on the settings that failed validation will be filled.
+      #   if the settings were not updated, the +errors+ on the settings that failed validation will be filled.
       def bulk_update(params, changed_by = nil)
         all_valid, settings = update_settings(params, changed_by)
         if all_valid
@@ -153,6 +156,8 @@ module SuperSettings
       end
 
       # Determine the value type from a value.
+      #
+      # @return [String]
       def value_type(value)
         case value
         when Integer
@@ -171,6 +176,7 @@ module SuperSettings
       end
 
       # Clear the last updated timestamp from the cache.
+      #
       # @api private
       def clear_last_updated_cache
         cache&.delete(Setting::LAST_UPDATED_CACHE_KEY)
@@ -179,8 +185,9 @@ module SuperSettings
       private
 
       # Updates settings in memory from an array of parameters.
-      # @param params [Array<Hash>] Each hash must contain a `key` element and may contain elements
-      #     for `value`, `value_type`, `description`, and `deleted`.
+      #
+      # @param params [Array<Hash>] Each hash must contain a "key" element and may contain elements
+      #     for "value", "value_type", "description", and "deleted".
       # @param changed_by [String] Value to be stored in the history for each setting
       # @return [Array] The first value is a boolean indicating if all the settings are valid,
       #     the second is an array of settings with their attributes updated in memory and ready to be saved.
@@ -247,20 +254,25 @@ module SuperSettings
       end
     end
 
-    # @return [String] the unique key for the setting.
+    # Get the unique key for the setting.
+    #
+    # @return [String]
     def key
       @record.key
     end
 
-    # Set the value of the setting.
-    # @param val [String]
+    # Set the value of the setting. The value will be coerced to a string for storage.
+    #
+    # @param val [Object]
     def key=(val)
       val = val&.to_s
       will_change!(:key, val) unless key == val
       @record.key = val
     end
 
-    # @return [Object] the value of a setting coerced to the appropriate class depending on its value type.
+    # The value of a setting coerced to the appropriate class depending on its value type.
+    #
+    # @return [Object]
     def value
       if deleted?
         nil
@@ -270,6 +282,7 @@ module SuperSettings
     end
 
     # Set the value of the setting.
+    #
     # @param val [Object]
     def value=(val)
       val = serialize(val) unless val.is_a?(Array)
@@ -277,22 +290,31 @@ module SuperSettings
       self.raw_value = val
     end
 
+    # Get the type of value being stored in the setting.
+    #
+    # @return [String] one of string, integer, float, boolean, datetime, or array.
     def value_type
       @record.value_type
     end
 
     # Set the value type of the setting.
-    # @param val [String] one of string, integer, float, boolean, datetime, array, or secret.
+    #
+    # @param val [String] one of string, integer, float, boolean, datetime, or array.
     def value_type=(val)
       val = val&.to_s
       will_change!(:value_type, val) unless value_type == val
       @record.value_type = val
     end
 
+    # Get the description for the setting.
+    #
+    # @return [String]
     def description
       @record.description
     end
 
+    # Set the description of the setting.
+    #
     # @param val [String]
     def description=(val)
       val = val&.to_s
@@ -301,6 +323,9 @@ module SuperSettings
       @record.description = val
     end
 
+    # Return true if the setting has been marked as deleted.
+    #
+    # @return [Boolean]
     def deleted?
       @record.deleted?
     end
@@ -309,6 +334,7 @@ module SuperSettings
 
     # Set the deleted flag on the setting. Deleted settings are not visible but are not actually
     # removed from the data store.
+    #
     # @param val [Boolean]
     def deleted=(val)
       val = Coerce.boolean(val)
@@ -316,10 +342,15 @@ module SuperSettings
       @record.deleted = val
     end
 
+    # Get the time the setting was first created.
+    #
+    # @return [Time]
     def created_at
       @record.created_at
     end
 
+    # Set the time when the setting was created.
+    #
     # @param val [Time, DateTime]
     def created_at=(val)
       val = Coerce.time(val)
@@ -327,10 +358,15 @@ module SuperSettings
       @record.created_at = val
     end
 
+    # Get the time the setting was last updated.
+    #
+    # @return [Time]
     def updated_at
       @record.updated_at
     end
 
+    # Set the time when the setting was last updated.
+    #
     # @param val [Time, DateTime]
     def updated_at=(val)
       val = Coerce.time(val)
@@ -338,50 +374,49 @@ module SuperSettings
       @record.updated_at = val
     end
 
-    # @return [true] if the setting has a string value type.
+    # Return true if the setting has a string value type.
+    #
+    # @return [Boolean]
     def string?
       value_type == STRING
     end
 
-    # @return [true] if the setting has an integer value type.
+    # Return true if the setting has an integer value type.
+    #
+    # @return [Boolean]
     def integer?
       value_type == INTEGER
     end
 
-    # @return [true] if the setting has a float value type.
+    # Return true if the setting has a float value type.
+    # @return [Boolean]
     def float?
       value_type == FLOAT
     end
 
-    # @return [true] if the setting has a boolean value type.
+    # Return true if the setting has a boolean value type.
+    # @return [Boolean]
     def boolean?
       value_type == BOOLEAN
     end
 
-    # @return [true] if the setting has a datetime value type.
+    # Return true if the setting has a datetime value type.
+    # @return [Boolean]
     def datetime?
       value_type == DATETIME
     end
 
-    # @return [true] if the setting has an array value type.
+    # Return true if the setting has an array value type.
+    # @return [Boolean]
     def array?
       value_type == ARRAY
     end
 
-    # @return [true] if the setting has a secret value type.
-    def secret?
-      value_type == SECRET
-    end
-
-    # @return [true] if the setting is a secret setting and the value is encrypted in the database.
-    def encrypted?
-      secret? && Encryption.encrypted?(raw_value)
-    end
-
     # Save the setting to the data storage engine.
+    #
     # @return [void]
     def save!
-      set_raw_value
+      record_value_change
 
       unless valid?
         raise InvalidRecordError.new(errors.values.join("; "))
@@ -398,7 +433,6 @@ module SuperSettings
 
         begin
           self.class.clear_last_updated_cache
-          redact_history! if history_needs_redacting?
         ensure
           clear_changes
         end
@@ -406,27 +440,36 @@ module SuperSettings
       nil
     end
 
-    # @return [Boolean] true if the record has been stored in the data storage engine.
+    # Return true if the record has been stored in the data storage engine.
+    #
+    # @return [Boolean]
     def persisted?
       @record.persisted?
     end
 
-    # @return [Boolean] true if the record has valid data.
+    # Return true if the record has valid data.
+    #
+    # @return [Boolean]
     def valid?
       validate!
       @errors.empty?
     end
 
-    # @return [Hash<String, Array<String>>] hash of errors generated from the last call to `valid?`
+    # Return hash of errors generated from the last call to +valid?+
+    #
+    # @return [Hash<String, Array<String>>]
     attr_reader :errors
 
     # Mark the record as deleted. The record will not actually be deleted since it's still needed
     # for caching purposes, but it will no longer be returned by queries.
+    #
+    # @return [void]
     def delete!
       update!(deleted: true)
     end
 
     # Update the setting attributes and save it.
+    #
     # @param attributes [Hash]
     # @return [void]
     def update!(attributes)
@@ -436,12 +479,14 @@ module SuperSettings
 
     # Return array of history items reflecting changes made to the setting over time. Items
     # should be returned in reverse chronological order so that the most recent changes are first.
+    #
     # @return [Array<SuperSettings::History>]
     def history(limit: nil, offset: 0)
       @record.history(limit: limit, offset: offset)
     end
 
     # Serialize to a hash that is used for rendering JSON responses.
+    #
     # @return [Hash]
     def as_json(options = nil)
       attributes = {
@@ -452,12 +497,12 @@ module SuperSettings
         created_at: created_at,
         updated_at: updated_at
       }
-      attributes[:encrypted] = encrypted? if secret?
       attributes[:deleted] = true if deleted?
       attributes
     end
 
     # Serialize to a JSON string.
+    #
     # @return [String]
     def to_json(options = nil)
       as_json.to_json(options)
@@ -486,12 +531,6 @@ module SuperSettings
         else
           Array(value).reject { |v| v.respond_to?(:empty?) ? v.empty? : v.to_s.empty? }.collect { |v| v.to_s.freeze }.freeze
         end
-      when Setting::SECRET
-        begin
-          Encryption.decrypt(value).freeze
-        rescue Encryption::InvalidSecretError
-          nil
-        end
       else
         value.freeze
       end
@@ -510,18 +549,10 @@ module SuperSettings
       end
     end
 
-    # Set the raw string value that will be persisted to the data store.
-    def set_raw_value
-      if value_type == Setting::SECRET && !raw_value.to_s.empty? && (changed?(:raw_value) || !Encryption.encrypted?(raw_value))
-        self.raw_value = Encryption.encrypt(raw_value)
-      end
-      record_value_change
-    end
-
     # Update the histories association whenever the value or key is changed.
     def record_value_change
       return unless changed?(:raw_value) || changed?(:deleted) || changed?(:key)
-      recorded_value = (deleted? || value_type == Setting::SECRET ? nil : raw_value)
+      recorded_value = (deleted? ? nil : raw_value)
       @record.create_history(value: recorded_value, deleted: deleted?, changed_by: changed_by, created_at: Time.now)
     end
 
@@ -544,14 +575,6 @@ module SuperSettings
       @changes.include?(attribute.to_s)
     end
 
-    def history_needs_redacting?
-      value_type == Setting::SECRET && changed?(:value_type)
-    end
-
-    def redact_history!
-      @record.send(:redact_history!)
-    end
-
     def raw_value=(val)
       val = val&.to_s
       val = nil if val&.empty?

data/lib/super_settings/storage/active_record_storage.rb

@@ -4,9 +4,11 @@ module SuperSettings
   module Storage
     # ActiveRecord implementation of the SuperSettings::Storage model.
     #
-    # To use this model, you must run the migration included with the gem. The migration
-    # can be installed with `rake app:super_settings:install:migrations` if the gem is mounted
-    # as an engine in a Rails application.
+    # To use this model, you must run the migration included with the gem. If the gem
+    # is mounted as an engine in a Rails applicationThe migration can be installed with
+    #
+    # @example
+    #   rake app:super_settings:install:migrations
     class ActiveRecordStorage
       # Base class that the models extend from.
       class ApplicationRecord < ActiveRecord::Base
@@ -85,7 +87,7 @@ module SuperSettings
       end
 
       delegate :key, :key=, :raw_value, :raw_value=, :value_type, :value_type=, :description, :description=,
-        :deleted?, :deleted=, :updated_at, :updated_at=, :created_at, :created_at=, :persisted?, :save!,
+        :deleted?, :deleted=, :updated_at, :updated_at=, :created_at, :created_at=, :persisted?,
         to: :@model
 
       def initialize(attributes = {})
@@ -96,6 +98,28 @@ module SuperSettings
         end
       end
 
+      def save!
+        begin
+          @model.save!
+        rescue ActiveRecord::RecordNotUnique => e
+          # Gracefully handle duplicate key constraint on the database; in this case the existing
+          # record should be updated.
+          duplicate = @model.class.find_by(key: @model.key)
+          raise e if duplicate == @model
+          duplicate.raw_value = @model.raw_value
+          duplicate.value_type = @model.value_type
+          duplicate.description = @model.description
+          duplicate.deleted = false
+          @model.transaction do
+            if @model.persisted?
+              @model.reload.update!(deleted: true)
+            end
+            duplicate.save!
+          end
+          @model = duplicate
+        end
+      end
+
       def history(limit: nil, offset: 0)
         finder = @model.history_items.order(id: :desc).offset(offset)
         finder = finder.limit(limit) if limit
@@ -112,12 +136,6 @@ module SuperSettings
           @model.history_items.build(history_attributes)
         end
       end
-
-      protected
-
-      def redact_history!
-        @model.history_items.update_all(value: nil)
-      end
     end
   end
 end

data/lib/super_settings/storage/http_storage.rb

@@ -3,11 +3,11 @@
 require "json"
 require "net/http"
 
-# SuperSettings::Storage model that reads from a remote service running the SuperSettings REST API.
-# This storage engine is read only. It is intended to allow microservices to read settings from a
-# central application that exposes the SuperSettings::RestAPI.
 module SuperSettings
   module Storage
+    # SuperSettings::Storage model that reads from a remote service running the SuperSettings REST API.
+    # This storage engine is read only. It is intended to allow microservices to read settings from a
+    # central application that exposes the SuperSettings::RestAPI.
     class HttpStorage
       include Storage
 
@@ -92,14 +92,14 @@ module SuperSettings
         private
 
         def call_api(method, path, params = {})
-          url_params = (method == :get ? query_params.merge(params) : query_params)
+          url_params = ((method == :get) ? query_params.merge(params) : query_params)
           uri = api_uri(path, url_params)
 
           body = nil
           request_headers = DEFAULT_HEADERS.merge(headers)
           if method == :post && !params&.empty?
             body = params.to_json
-            request_headers["Content-Type"] = "application/json; charset=utf8-"
+            request_headers["content-type"] = "application/json; charset=utf8-"
           end
 
           response = http_request(method: method, uri: uri, headers: request_headers, body: body)
@@ -131,7 +131,7 @@ module SuperSettings
               http.verify_mode = OpenSSL::SSL::VERIFY_NONE
             end
 
-            request = (method == :post ? Net::HTTP::Post.new(uri.request_uri) : Net::HTTP::Get.new(uri.request_uri))
+            request = ((method == :post) ? Net::HTTP::Post.new(uri.request_uri) : Net::HTTP::Get.new(uri.request_uri))
             set_headers(request, headers)
             request.body = body if body
 
@@ -144,7 +144,7 @@ module SuperSettings
           end
 
           if response.is_a?(Net::HTTPRedirection)
-            location = resp["Location"]
+            location = resp["location"]
             if redirect_count < 5 && SuperSettings::Coerce.present?(location)
               return http_request(method: :get, uri: URI(location), headers: headers, body: body, redirect_count: redirect_count + 1)
             end
@@ -255,12 +255,6 @@ module SuperSettings
         !!(defined?(@persisted) && @persisted)
       end
 
-      protected
-
-      def redact_history!
-        # No-op since history is maintained by the source system.
-      end
-
       private
 
       def set_persisted!
@@ -270,10 +264,6 @@ module SuperSettings
       def call_api(method, path, params = {})
         self.class.send(:call_api, method, path, params)
       end
-
-      def encrypted=(value)
-        # No op; needed for API compatibility
-      end
     end
   end
 end

data/lib/super_settings/storage/redis_storage.rb

@@ -2,27 +2,26 @@
 
 require "json"
 
-# Redis implementation of the SuperSettings::Storage model.
-#
-# You must define the redis connection to use by setting the redis attribute on the class.
-# This can either be a `Redis` object or a block that yields a `Redis` object. You can use the
-# block form if you need to get the `Redis` object at runtime instead of having a static object.
-#
-# ```ruby
-# SuperSettings::Storage::RedisStorage.redis = Redis.new(url: ENV["REDIS_URL"])
-#
-# SuperSettings::Storage::RedisStorage.redis = lambda { RedisClient.get(:settings) }
-# ```
-#
-# You can also use the [connection_pool]() gem to provide a pool of Redis connecions for
-# a multi-threaded application. The connection_pool gem is not a dependency of this gem,
-# so you would need to add it to your application dependencies to use it.
-#
-# ```ruby
-# SuperSettings::Storage::RedisStorage.redis = ConnectionPool.new(size: 5) { Redis.new(url: ENV["REDIS_URL"]) }
-# ```
 module SuperSettings
   module Storage
+    # Redis implementation of the SuperSettings::Storage model.
+    #
+    # You must define the redis connection to use by setting the redis attribute on the class.
+    # This can either be a +Redis+ object or a block that yields a +Redis+ object. You can use the
+    # block form if you need to get the Redis object at runtime instead of having a static object.
+    #
+    # You can also use the [connection_pool]() gem to provide a pool of Redis connecions for
+    # a multi-threaded application. The connection_pool gem is not a dependency of this gem,
+    # so you would need to add it to your application dependencies to use it.
+    #
+    # @example
+    #   SuperSettings::Storage::RedisStorage.redis = Redis.new(url: ENV["REDIS_URL"])
+    #
+    # @example
+    #   SuperSettings::Storage::RedisStorage.redis = lambda { RedisClient.get(:settings) }
+    #
+    # @example
+    #   SuperSettings::Storage::RedisStorage.redis = ConnectionPool.new(size: 5) { Redis.new(url: ENV["REDIS_URL"]) }
     class RedisStorage
       include Storage
 
@@ -122,7 +121,8 @@ module SuperSettings
         def find_by_key(key)
           json = with_redis { |redis| redis.hget(SETTINGS_KEY, key) }
           return nil unless json
-          load_from_json(json)
+          record = load_from_json(json)
+          record unless record.deleted?
         end
 
         def last_updated_at
@@ -249,19 +249,6 @@ module SuperSettings
         !!(defined?(@persisted) && @persisted)
       end
 
-      protected
-
-      def redact_history!
-        after_commit do
-          histories = HistoryStorage.find_all_by_key(key: key)
-          histories.each { |item| item.value = nil }
-          self.class.transaction do
-            HistoryStorage.destroy_all_by_key(key)
-            histories.reverse.each(&:save!)
-          end
-        end
-      end
-
       private
 
       def after_commit(&block)