flipper-ui 0.2.0.beta2 → 0.2.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0066f600077329991959e5bba71ad6a820c1bef8
-  data.tar.gz: 372ff7bd0108faa1eeff9edcdb0f64f8b685c4f1
+  metadata.gz: 71211c26364825d2e5ba11f9669b7355f3fc8687
+  data.tar.gz: add561910d6cc8d6f6993ec7b3a202b567d22d5b
 SHA512:
-  metadata.gz: 7c8a4c2ab207262a94f3d9c88b9ff0f3bc1852085bbccb586f244e59c5c6558bf7c8b19a0642cca79e3f81ea8bcc974cee83d637339b124ae0e2e8b14b3c3235
-  data.tar.gz: 276d8e236e9ee6ab4b984c7e68f4abc16f4235c203631860ade07f694cf15e3749acca051d0e69ab1c1bb2b6a6511190728285319e8235d580ac7b22fdb18103
+  metadata.gz: 7bc66dd6dc92a57168d0260563fceecc003003a6030467566307f7fcc31b310bc20c38f5039778c5dfb78e3f2995018f21ac42d348a0b4f3fa7e881c7e4388fa
+  data.tar.gz: 655a47804905a1edf3f172915617e3056c6842dac461d65cd63b876b5773c3b3d5d62338dc48f8811e35b99428114e09804b7786582a2f9e352e988d2631b6f9

data/Gemfile

@@ -1,17 +1,18 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rake'
-gem 'shotgun'
-gem 'rspec'
-gem 'rack-test'
-gem 'activesupport'
+gem 'rake', '~> 10.0.3'
+gem 'shotgun', '~> 0.9'
+gem 'flipper-redis', '~> 0.7.0.beta1'
+gem 'rspec', '~> 2.12'
+gem 'rack-test', '~> 0.6.1'
+gem 'activesupport', '~> 3.2.13', '< 4.3'
 
 group(:guard) do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-bundler'
-  gem 'guard-coffeescript'
-  gem 'guard-sass'
-  gem 'rb-fsevent'
+  gem 'guard', '~> 1.6.2'
+  gem 'guard-rspec', '~> 2.4.0'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-coffeescript', '~> 1.2.1'
+  gem 'guard-sass', '~> 1.0.2'
+  gem 'rb-fsevent', '~> 0.9.3'
 end

data/README.md

@@ -1,8 +1,6 @@
 # Flipper::UI
 
-UI for the [Flipper](https://github.com/jnunemaker/flipper) gem. __Note__: This is not fully functional yet. The end product will look like this:
-
-![flipper web](./examples/flipper.png)
+UI for the [Flipper](https://github.com/jnunemaker/flipper) gem.
 
 ## Installation
 
@@ -34,7 +32,7 @@ you can mount `Flipper::UI` to a route of your choice:
 # config/routes.rb
 
 YourRailsApp::Application.routes.draw do
-  mount Flipper::UI.app($flipper) => '/flipper'
+  mount Flipper::UI.app($flipper, secret: "_your_session_secret") => '/flipper'
 end
 ```
 
@@ -47,7 +45,7 @@ You almost certainly want to limit access when using Flipper::UI in production.
 
 flipper_constraint = lambda { |request| request.remote_ip == '127.0.0.1' }
 constraints flipper_constraint do
-  mount Flipper::UI.app($flipper) => '/flipper'
+  mount Flipper::UI.app($flipper, secret: "_your_session_secret") => '/flipper'
 end
 ```
 
@@ -67,7 +65,7 @@ end
 # config/routes.rb
 
 constraints CanAccessFlipperUI do
-  mount Flipper::UI.app($flipper) => '/flipper'
+  mount Flipper::UI.app($flipper, secret: "_your_session_secret") => '/flipper'
 end
 ```
 
@@ -85,7 +83,7 @@ require 'flipper/adapters/memory'
 adapter = Flipper::Adapters::Memory.new
 flipper = Flipper.new(adapter)
 
-run Flipper::UI.app(flipper)
+run Flipper::UI.app(flipper, secret: "_your_session_secret")
 ```
 
 See [examples/basic.ru](https://github.com/jnunemaker/flipper-ui/blob/master/examples/basic.ru) for a more full example

data/examples/basic.ru

@@ -3,16 +3,16 @@
 #   bundle exec rackup examples/basic.ru
 #   http://localhost:9292/
 #
-require 'pp'
-require 'logger'
-require 'pathname'
+require "pp"
+require "logger"
+require "pathname"
 
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
+root_path = Pathname(__FILE__).dirname.join("..").expand_path
+lib_path  = root_path.join("lib")
 $:.unshift(lib_path)
 
-require 'flipper-ui'
-require 'flipper/adapters/memory'
+require "flipper-ui"
+require "flipper-redis"
 
 Flipper.register(:admins) { |actor|
   actor.respond_to?(:admin?) && actor.admin?
@@ -23,22 +23,23 @@ Flipper.register(:early_access) { |actor|
 }
 
 # Setup logging of flipper calls.
-require 'flipper/instrumentation/log_subscriber'
-Flipper::Instrumentation::LogSubscriber.logger = Logger.new(STDOUT)
-
-adapter = Flipper::Adapters::Memory.new({})
-flipper = Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications)
-
-Actor = Struct.new(:flipper_id)
-
-flipper[:search_performance_another_long_thing].enable
-flipper[:gauges_tracking].enable
-flipper[:unused].disable
-flipper[:suits].enable Actor.new('1')
-flipper[:suits].enable Actor.new('6')
-flipper[:secrets].enable flipper.group(:admins)
-flipper[:secrets].enable flipper.group(:early_access)
-flipper[:logging].enable flipper.time(5)
-flipper[:new_cache].enable flipper.actors(15)
-
-run Flipper::UI.app(flipper)
+$logger = Logger.new(STDOUT)
+require "active_support/notifications"
+require "flipper/instrumentation/log_subscriber"
+Flipper::Instrumentation::LogSubscriber.logger = $logger
+
+adapter = Flipper::Adapters::Redis.new(Redis.new(port: ENV["GH_REDIS_PORT"]))
+flipper = Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
+
+# You can uncomment these to get some default data:
+# flipper[:search_performance_another_long_thing].enable
+# flipper[:gauges_tracking].enable
+# flipper[:unused].disable
+# flipper[:suits].enable_actor Flipper::UI::Actor.new('1')
+# flipper[:suits].enable_actor Flipper::UI::Actor.new('6')
+# flipper[:secrets].enable_group :admins
+# flipper[:secrets].enable_group :early_access
+# flipper[:logging].enable_percentage_of_time 5
+# flipper[:new_cache].enable_percentage_of_actors 15
+
+run Flipper::UI.app(flipper, secret: "example_secret_dont_use_this")

data/flipper-ui.gemspec

@@ -4,8 +4,9 @@ require File.expand_path('../lib/flipper/ui/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["John Nunemaker"]
   gem.email         = ["nunemaker@gmail.com"]
-  gem.description   = %q{UI for the Flipper gem}
   gem.summary       = %q{UI for the Flipper gem}
+  gem.description   = %q{Rack middleware that provides a fully featured web interface for the flipper gem.}
+  gem.license       = "MIT"
   gem.homepage      = "https://github.com/jnunemaker/flipper-ui"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -15,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Flipper::UI::VERSION
 
-  gem.add_dependency 'rack'
+  gem.add_dependency 'rack', '~> 1.5', '< 1.7'
+  gem.add_dependency 'rack-protection', '~> 1.5.3'
   gem.add_dependency 'flipper', '~> 0.7.0.beta1'
-  gem.add_dependency 'erubis'
+  gem.add_dependency 'erubis', '~> 2.7.0'
 end

data/lib/flipper-ui.rb

@@ -1 +1,2 @@
+require 'flipper'
 require 'flipper/ui'

data/lib/flipper/ui.rb

@@ -1,7 +1,9 @@
 require 'pathname'
 require 'rack'
+require 'rack/methodoverride'
+require 'rack/protection'
 require 'flipper'
-require 'multi_json'
+require 'flipper/middleware/memoizer'
 
 module Flipper
   module UI
@@ -9,10 +11,16 @@ module Flipper
       @root ||= Pathname(__FILE__).dirname.expand_path.join('ui')
     end
 
-    def self.app(flipper)
+    def self.app(flipper, options = {})
       app = lambda { |env| [200, {'Content-Type' => 'text/html'}, ['']] }
       builder = Rack::Builder.new
       yield builder if block_given?
+      secret = options[:secret] || raise(ArgumentError, "Flipper::UI.app missing required option: secret")
+      builder.use Rack::Session::Cookie, secret: secret
+      builder.use Rack::Protection
+      builder.use Rack::Protection::AuthenticityToken
+      builder.use Rack::MethodOverride
+      builder.use Flipper::Middleware::Memoizer, flipper
       builder.use Middleware, flipper
       builder.run app
       builder
@@ -21,3 +29,4 @@ module Flipper
 end
 
 require 'flipper/ui/middleware'
+require 'flipper/ui/actor'

data/lib/flipper/ui/action.rb

@@ -56,6 +56,7 @@ module Flipper
         @flipper, @request = flipper, request
         @code = 200
         @headers = {}
+        @breadcrumbs = []
       end
 
       # Public: Runs the request method for the provided request.
@@ -76,8 +77,8 @@ module Flipper
       #
       # Examples
       #
-      #   run_other_action Index
-      #   # => result of running Index action
+      #   run_other_action Home
+      #   # => result of running Home action
       #
       # Returns result of other action.
       def run_other_action(action_class)
@@ -100,7 +101,7 @@ module Flipper
       def view_response(name)
         header 'Content-Type', 'text/html'
         body = view_with_layout { view_without_layout name }
-        [@code, @headers, [body]]
+        halt [@code, @headers, [body]]
       end
 
       # Public: Dumps an object as json and returns rack response with that as
@@ -112,7 +113,16 @@ module Flipper
       def json_response(object)
         header 'Content-Type', 'application/json'
         body = JSON.dump(object)
-        [@code, @headers, [body]]
+        halt [@code, @headers, [body]]
+      end
+
+      # Public: Redirect to a new location.
+      #
+      # location - The String location to set the Location header to.
+      def redirect_to(location)
+        status 302
+        header "Location", location
+        halt [@code, @headers, [""]]
       end
 
       # Public: Set the status code for the response.
@@ -130,6 +140,28 @@ module Flipper
         @headers[name] = value
       end
 
+      class Breadcrumb
+        attr_reader :text, :href
+
+        def initialize(text, href = nil)
+          @text = text
+          @href = href
+        end
+
+        def active?
+          @href.nil?
+        end
+      end
+
+      # Public: Add a breadcrumb to the trail.
+      #
+      # text - The String text for the breadcrumb.
+      # href - The String href for the anchor tag (optional). If nil, breadcrumb
+      #        is assumed to be the end of the trail.
+      def breadcrumb(text, href = nil)
+        @breadcrumbs << Breadcrumb.new(text, href)
+      end
+
       # Private
       def view_with_layout(&block)
         view :layout, &block
@@ -143,6 +175,11 @@ module Flipper
       # Private
       def view(name)
         path = views_path.join("#{name}.erb")
+
+        unless path.exist?
+          raise "Template does not exist: #{path}"
+        end
+
         contents = path.read
         compiled = Eruby.new(contents)
         compiled.result Proc.new {}.binding
@@ -167,6 +204,10 @@ module Flipper
       def request_method_name
         @request_method_name ||= @request.request_method.downcase
       end
+
+      def csrf_input_tag
+        %Q(<input type="hidden" name="authenticity_token" value="#{@request.session[:csrf]}">)
+      end
     end
   end
 end

data/lib/flipper/ui/actions/actors_gate.rb

@@ -0,0 +1,48 @@
+require 'flipper/ui/action'
+require 'flipper/ui/decorators/feature'
+require 'flipper/ui/util'
+
+module Flipper
+  module UI
+    module Actions
+      class ActorsGate < UI::Action
+        route %r{features/[^/]*/actors/?\Z}
+
+        def get
+          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
+          feature = flipper[feature_name.to_sym]
+          @feature = Decorators::Feature.new(feature)
+
+          breadcrumb "Home", "/"
+          breadcrumb "Features", "/features"
+          breadcrumb @feature.key, "/features/#{@feature.key}"
+          breadcrumb "Add Actor"
+
+          view_response :add_actor
+        end
+
+        def post
+          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
+          feature = flipper[feature_name.to_sym]
+          value = params["value"]
+
+          if Util.blank?(value)
+            error = Rack::Utils.escape("#{value.inspect} is not a valid actor value.")
+            redirect_to("/features/#{feature.key}/actors?error=#{error}")
+          end
+
+          actor = Flipper::UI::Actor.new(value)
+
+          case params["operation"]
+          when "enable"
+            feature.enable_actor actor
+          when "disable"
+            feature.disable_actor actor
+          end
+
+          redirect_to("/features/#{feature.key}")
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/actions/add_feature.rb

@@ -0,0 +1,20 @@
+require 'flipper/ui/action'
+require 'flipper/ui/decorators/feature'
+
+module Flipper
+  module UI
+    module Actions
+      class AddFeature < UI::Action
+        route %r{features/new/?\Z}
+
+        def get
+          breadcrumb "Home", "/"
+          breadcrumb "Features", "/features"
+          breadcrumb "Add"
+
+          view_response :add_feature
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/actions/boolean_gate.rb

@@ -0,0 +1,26 @@
+require 'flipper/ui/action'
+require 'flipper/ui/decorators/feature'
+
+module Flipper
+  module UI
+    module Actions
+      class BooleanGate < UI::Action
+        route %r{features/[^/]*/boolean/?\Z}
+
+        def post
+          feature_name = Rack::Utils.unescape(request.path.split("/")[-2])
+          feature = flipper[feature_name.to_sym]
+          @feature = Decorators::Feature.new(feature)
+
+          if params["action"] == "Enable"
+            feature.enable
+          else
+            feature.disable
+          end
+
+          redirect_to "/features/#{@feature.key}"
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/actions/feature.rb

@@ -0,0 +1,32 @@
+require 'flipper/ui/action'
+require 'flipper/ui/decorators/feature'
+
+module Flipper
+  module UI
+    module Actions
+      class Feature < UI::Action
+
+        route %r{features/[^/]*/?\Z}
+
+        def get
+          feature_name = Rack::Utils.unescape(request.path.split("/").last)
+          @feature = Decorators::Feature.new(flipper[feature_name])
+          @page_title = "#{@feature.key} // Features"
+          @percentages = [0, 1, 5, 10, 15, 25, 50, 75, 100]
+
+          breadcrumb "Features", "/features"
+          breadcrumb @feature.key
+
+          view_response :feature
+        end
+
+        def delete
+          feature_name = Rack::Utils.unescape(request.path.split("/").last)
+          feature = flipper[feature_name]
+          flipper.adapter.remove(feature)
+          redirect_to "/features"
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/actions/features.rb

@@ -1,5 +1,6 @@
 require 'flipper/ui/action'
 require 'flipper/ui/decorators/feature'
+require 'flipper/ui/util'
 
 module Flipper
   module UI
@@ -9,11 +10,30 @@ module Flipper
         route %r{features/?\Z}
 
         def get
-          features = flipper.features.map { |feature|
+          @page_title = "Features"
+          @features = flipper.features.map { |feature|
             Decorators::Feature.new(feature)
-          }.sort_by(&:pretty_name)
+          }.sort
 
-          json_response features.map(&:as_json)
+          @show_blank_slate = @features.empty?
+
+          breadcrumb "Home", "/"
+          breadcrumb "Features"
+
+          view_response :features
+        end
+
+        def post
+          value = params["value"]
+
+          if Util.blank?(value)
+            error = Rack::Utils.escape("#{value.inspect} is not a valid feature name.")
+            redirect_to("/features/new?error=#{error}")
+          end
+
+          flipper.adapter.add(flipper[value])
+
+          redirect_to "/features"
         end
       end
     end