plug 0.1.22 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26cd866545ec8b6b12dc3cd25ea7ec9b7cab3ed4fbb06ff083706e30d721f433
-  data.tar.gz: 51d445dd19b35b5374e27a6624e2cb452eaef92e9cc91f69da21c80720e8b197
+  metadata.gz: eb469dfe189640aa012dfba0b1784b6b58af48ab0a72f43f86e18aa9557cf342
+  data.tar.gz: b0ecc6ea23fdbfc103e4b66fbd7ac98c6acbad94e580e2b9372cbc5aa4445607
 SHA512:
-  metadata.gz: e5258d4baba38a6ae2bd2f7976b98d0fe283e0edf9bdd54c309d7e7c2063105520d454b6436e506b80dfaf13d8d59ad63e18d8f31d57247103a110c6ab86c29d
-  data.tar.gz: 57f1a5ad4b52487c6aa734d1f318663d730dc74c0c54ee3ab81cc8d1e401947483327c502a765defe52cc02ce1790d13f18fd81bd166c713a9a1dd18217cafe4
+  metadata.gz: 88ed333f9efd4189debd2e8b892d3da8a33775a1d47919bab8819314b5b0860bb76f0892cb97dee6b93771a5dc543c6c528f3216d42872f5054f0313a5e9840a
+  data.tar.gz: ca7f17e98fc0902191b0734b61c6cb69a4adff7ca3ba7ba1eee7342b0d049793bc06c8022ebf421f1fab2b813ea847432d62f429f2518f44718a8aa41ae2847f

data/README.md

@@ -1,16 +1,15 @@
-# Plug [![Maintainability](https://api.codeclimate.com/v1/badges/6246b1cd8e42603c42f6/maintainability)](https://codeclimate.com/github/DigitalNZ/plug/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6246b1cd8e42603c42f6/test_coverage)](https://codeclimate.com/github/DigitalNZ/plug/test_coverage) [![Build Status](https://travis-ci.org/DigitalNZ/plug.svg?branch=master)](https://travis-ci.org/DigitalNZ/plug)
+# Plug [![Maintainability](https://api.codeclimate.com/v1/badges/6246b1cd8e42603c42f6/maintainability)](https://codeclimate.com/github/DigitalNZ/plug/maintainability) [![Build Status](https://travis-ci.org/DigitalNZ/plug.svg?branch=master)](https://travis-ci.org/DigitalNZ/plug)
 
 A Rails engine to turn on/off features (Feature flipper).
 
 ### Features
 
-- Supports Rails 3 and above
-- MySQL
-- Set notices
+- Manage features with notices
+- Manage site notices with themes
 
 ### Prerequisites
 
-- Rails version 3 and above
+- Rails version 5 and above
 - MySQL
 
 ### Getting Started
@@ -32,9 +31,7 @@ And run the install generator:
 ```bash
 → rails g plug:install
 → rails plug:install:migrations
-→ rake plug:install:migrations # For Rails <= 3.x
-→ rails db:migrate # Newer version of Rails
-→ rake db:migrate # Older version of Rails
+→ rails db:migrate
 → rails s
 ```
 
@@ -85,7 +82,7 @@ Add buttons to the config block to perform rake tasks from the plug dashboard
 #### Themes
 Themes can be added in Site Notices. Themes are just string stored in the database. You still need to style the theme.
 
-By default, we have `default` and `dark` in `config/plug.rb`
+By default, we have `default` and `dark` in `config/plug.rb`. Below is an example on how you can utilise the theme string.
 
 ```haml
 - theme_class = "site-notice--#{site_notice.theme}"
@@ -125,7 +122,7 @@ By default, we have `default` and `dark` in `config/plug.rb`
 
 ### Publishing to `rubygems.org`
 
-Make sure to bump the version. Rubygems don't accept version overrides.
+Make sure to **bump** the version. Rubygems don't accept version overrides.
 
 ```bash
 → gem build plug.gemspec

data/app/controllers/plug/api/features_controller.rb

@@ -0,0 +1,21 @@
+require_dependency 'plug/application_controller'
+
+module Plug
+  module Api
+    class FeaturesController < ApiController
+      # GET /features.json
+      def index
+        @features = Feature.all
+
+        render json: @features
+      end
+
+      # GET /features/slug.json
+      def show
+        @feature = Feature.slug_and_name(params[:slug]).first
+
+        render json: @feature
+      end
+    end
+  end
+end

data/app/models/plug/resources/feature.rb

@@ -0,0 +1,15 @@
+module Plug
+  module Resources
+    class Feature < ActiveResource::Base
+      self.site = Plug.api_path
+
+      def enabled?
+        state == 'enabled'
+      end
+
+      def disabled?
+        state == 'disabled'
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -10,6 +10,8 @@ Plug::Engine.routes.draw do
   namespace :api, defaults: { format: :json } do
     get '/site_notices/:slug', to: 'site_notices#show'
     get '/site_notices', to: 'site_notices#index'
+    get '/features/:slug', to: 'features#show'
+    get '/features', to: 'features#index'
   end
 
   post '/task', to: 'features#task_execution', as: :task_execution

data/db/migrate/20171207020316_create_plug_features.rb

@@ -1,4 +1,4 @@
-class CreatePlugFeatures < ActiveRecord::Migration
+class CreatePlugFeatures < ActiveRecord::Migration[5.1]
   def change
     create_table :plug_features do |t|
       t.string :name

data/db/migrate/20180128202026_add_notice_to_plug_features.rb

@@ -1,4 +1,4 @@
-class AddNoticeToPlugFeatures < ActiveRecord::Migration
+class AddNoticeToPlugFeatures < ActiveRecord::Migration[5.1]
   def change
     add_column :plug_features, :notice, :text
   end

data/db/migrate/20180403024712_create_plug_site_notices.rb

@@ -1,4 +1,4 @@
-class CreatePlugSiteNotices < ActiveRecord::Migration
+class CreatePlugSiteNotices < ActiveRecord::Migration[5.1]
   def change
     create_table :plug_site_notices do |t|
       t.string :name

data/lib/plug/version.rb

@@ -1,3 +1,3 @@
 module Plug
-  VERSION = '0.1.22'
+  VERSION = '0.1.23'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
 platform: ruby
 authors:
 - Ben
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -228,6 +228,7 @@ files:
 - app/assets/stylesheets/plug/variables/_colors.scss
 - app/assets/stylesheets/plug/variables/_typography.scss
 - app/controllers/plug/api/api_controller.rb
+- app/controllers/plug/api/features_controller.rb
 - app/controllers/plug/api/site_notices_controller.rb
 - app/controllers/plug/application_controller.rb
 - app/controllers/plug/features_controller.rb
@@ -237,6 +238,7 @@ files:
 - app/models/plug/application_record.rb
 - app/models/plug/concerns/model_helpers.rb
 - app/models/plug/feature.rb
+- app/models/plug/resources/feature.rb
 - app/models/plug/resources/site_notice.rb
 - app/models/plug/site_notice.rb
 - app/services/plug/task_execution_service.rb