pin_flags 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e808594761335f44f706defa7a34f25b62ac9767f37f1560a99e2969d72dc907
-  data.tar.gz: ef1c7bfae6d439663a32ae59e6c91ef4f82a7dff0b8d226c3d915f9a2c40c903
+  metadata.gz: ae850d2a54a2c64eb154558ae616d98d9d7aa1468d48c6977fc1e09b2afdc176
+  data.tar.gz: 63ed88de0f0d12eb5c810756a8ba598c2aca5e7ad0acbb56710040000c1b7341
 SHA512:
-  metadata.gz: cc4ac28226a71c9bf24bd3960c342ec9d80af53e06ad17001bb4a92b7e02459f5b261c14cb6cc55c07bcb432295c26eb44f0a5bd55da0d7d8a70d727ab932ab1
-  data.tar.gz: 3bc237063b2b339e77fd11cddbcb0b0a66f64e32aac3ff5e14365d3eea231431dd08f2db945159eb2f35ec9222763c189dd95366bd61a3e325bced158a57b97a
+  metadata.gz: 3e1b94b8fd24b8283c7642a30c2a35da25945c9e4c985a5389565b1f8f5c679b5edd89a6c5cb380d5e26da1c3285b77af0b5546ea4e3a5ec7bc0c27e37e2ce6a
+  data.tar.gz: f883bb9bcc2bc55888c948d7eb6a7c8789485d962bdaeb7c683583dd91bb0561440a0855093a9c54cf8f573d8c7831416f7f3a9664d66ed2a1b1f7271da80bf9

data/README.md

@@ -10,7 +10,7 @@ A lightweight Rails engine for managing entity based features with built-in cach
 
 - 🚀 Polymorphic "feature tags" which can be tied to any ActiveRecord Model 
 - ⚡ Built-in caching with configurable expiry
-- 🎨 An admn UI that stays out of your way with minified [BulmaCSS](https://github.com/jgthms/bulma) and [AplineJS](https://github.com/alpinejs/alpine)
+- 🎨 An admn UI that stays out of your way with minified [BulmaCSS](https://github.com/jgthms/bulma) and [AlpineJS](https://github.com/alpinejs/alpine)
 - 🔒 Isolated namespace to avoid conflicts
 - 💉 No dependency on Stimulus 
 
@@ -54,6 +54,48 @@ PinFlags.config do |config|
 end
 ```
 
+### HTTP Basic Authentication
+
+PinFlags includes built-in HTTP Basic Authentication to protect the admin interface. Configure it in your initializer:
+
+```ruby
+PinFlags.config do |config|
+  config.cache_prefix = "budget_tracker_pin_flags"
+  config.cache_expiry = 1.hour
+  config.http_basic_auth_enabled = true    # Default: true
+  config.http_basic_auth_user = "admin"    # Default: "pin_flags_admin"  
+  config.http_basic_auth_password = "password"  # Default: "please_change_me"
+end
+```
+
+**Security Note:** Always change the default credentials in production environments.
+
+### Consider using environment variables for sensitive information:
+
+```ruby
+PinFlags.config do |config|
+  config.http_basic_auth_user = ENV["PIN_FLAGS_USER"] || "pin_flags_admin"
+  config.http_basic_auth_password = ENV["PIN_FLAGS_PASSWORD"] || "please_change_me"
+end
+```
+
+### Or use Rails credentials:
+
+```ruby
+PinFlags.config do |config|
+  config.http_basic_auth_user = Rails.application.credentials.pin_flags[:user] || "pin_flags_admin"
+  config.http_basic_auth_password = Rails.application.credentials.pin_flags[:password] || "please_change_me"
+end
+```
+
+To disable authentication entirely:
+
+```ruby
+PinFlags.config do |config|
+  config.http_basic_auth_enabled = false
+end
+```
+
 ## Usage
 
 ### Include the module in any of your ActiveRecord models:
@@ -167,6 +209,9 @@ end
 |--------|-------------|---------|
 | `cache_prefix` | Prefix for cache keys | `"pin_flags"` |
 | `cache_expiry` | Cache expiration time | `12.hours` |
+| `http_basic_auth_enabled` | Enable HTTP Basic Authentication | `true` |
+| `http_basic_auth_user` | Username for admin interface | `"pin_flags_admin"` |
+| `http_basic_auth_password` | Password for admin interface | `"secure_password"` |
 
 ## Development
 

data/app/controllers/concerns/pin_flags/basic_authentication.rb

@@ -0,0 +1,25 @@
+module PinFlags::BasicAuthentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :authenticate_by_http_basic
+  end
+
+  private
+    def authenticate_by_http_basic
+      if http_basic_authentication_enabled?
+        http_basic_authenticate_or_request_with(**http_basic_authentication_credentials)
+      end
+    end
+
+    def http_basic_authentication_enabled?
+      PinFlags.http_basic_auth_enabled
+    end
+
+    def http_basic_authentication_credentials
+      {
+        name: PinFlags.http_basic_auth_user,
+        password: PinFlags.http_basic_auth_password
+      }.transform_values(&:presence)
+    end
+end

data/app/controllers/pin_flags/application_controller.rb

@@ -1,5 +1,7 @@
 module PinFlags
   class ApplicationController < ActionController::Base
+    include PinFlags::BasicAuthentication
+
     layout "pin_flags/application"
     protect_from_forgery with: :exception
   end

data/lib/pin_flags/version.rb

@@ -1,3 +1,3 @@
 module PinFlags
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/pin_flags.rb

@@ -6,6 +6,10 @@ module PinFlags
   mattr_accessor :cache_prefix, default: "pin_flags"
   mattr_accessor :cache_expiry, default: 12.hours
 
+  mattr_accessor :http_basic_auth_enabled, default: true
+  mattr_accessor :http_basic_auth_user, default: "pin_flags_admin"
+  mattr_accessor :http_basic_auth_password, default: "please_change_me"
+
   def self.config
     yield self if block_given?
     self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pin_flags
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Demetrious Wilson
@@ -116,6 +116,7 @@ files:
 - app/assets/stylesheets/pin_flags/application.css
 - app/assets/stylesheets/pin_flags/bulma.min.css
 - app/assets/stylesheets/pin_flags/forms.css
+- app/controllers/concerns/pin_flags/basic_authentication.rb
 - app/controllers/pin_flags/application_controller.rb
 - app/controllers/pin_flags/feature_tags/exports_controller.rb
 - app/controllers/pin_flags/feature_tags/feature_subscriptions_controller.rb