flipper-ui 0.2.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e9d451a699e2b1acd1697ffea82cace549570b2
+  data.tar.gz: 012aa58d86f51d10b433a48ad0a7503d601b948d
+SHA512:
+  metadata.gz: a2911695881ddf0c229fbf06bd1249e0f6439d0703c8783c702bbf7bf4715070ed48b61b902ef9fc4c6d97f0d17ebea4ec7172048f1ca586c0a7ddeb89623d47
+  data.tar.gz: 5d110e6a66dac9408c36ae2a3222598893a57254e88e11cddce3977dadb70f10f74139464ef76340623973354ccc0172ba9e9a4a3003abbe9ed69ffe0b27ca01

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.sass-cache
+log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'shotgun'
+gem 'rspec'
+gem 'rack-test'
+gem 'activesupport'
+
+group(:guard) do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-coffeescript'
+  gem 'guard-sass'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,26 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { "spec" }
+  watch('spec/helper.rb')  { "spec" }
+end
+
+coffee_options = {
+  :input => 'lib/flipper/ui/assets/javascripts',
+  :output => 'lib/flipper/ui/public/js',
+  :all_on_start => false,
+}
+guard 'coffeescript', coffee_options
+
+sass_options = {
+  :input => 'lib/flipper/ui/assets/stylesheets',
+  :output => 'lib/flipper/ui/public/css',
+}
+guard 'sass', sass_options

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Nunemaker
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# 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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-ui'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-ui
+
+## Usage
+
+### Rails
+
+Given that you've already initialized `Flipper` as per the [flipper](https://github.com/jnunemaker/flipper) readme:
+
+```ruby
+# config/initializers/flipper.rb
+$flipper = Flipper.new(...)
+```
+
+you can mount `Flipper::UI` to a route of your choice:
+```ruby
+# config/routes.rb
+
+YourRailsApp::Application.routes.draw do
+  mount Flipper::UI.app($flipper) => '/flipper'
+end
+```
+
+#### Security
+
+You almost certainly want to limit access when using Flipper::UI in production. Using [routes constraints](http://guides.rubyonrails.org/routing.html#request-based-constraints) is one way to achieve this:
+
+```ruby
+# config/routes.rb
+
+flipper_constraint = lambda { |request| request.remote_ip == '127.0.0.1' }
+constraints flipper_constraint do
+  mount Flipper::UI.app($flipper) => '/flipper'
+end
+```
+
+Another example of a route constrain using the current_user when using Devise or another warden based authentication system:
+
+```ruby
+# initializers/admin_access.rb
+
+class CanAccessFlipperUI
+  def self.matches?(request)
+    current_user = request.env['warden'].user
+
+    return current_user.present? && current_user.respond_to?(:is_admin?) && current_user.is_admin?
+  end
+end
+
+# config/routes.rb
+
+constraints CanAccessFlipperUI do
+  mount Flipper::UI.app($flipper) => '/flipper'
+end
+```
+
+
+### Standalone
+
+Minimal example for Rack:
+
+```ruby
+# config.ru
+
+require 'flipper-ui'
+require 'flipper/adapters/memory'
+
+adapter = Flipper::Adapters::Memory.new
+flipper = Flipper.new(adapter)
+
+run Flipper::UI.app(flipper)
+```
+
+See [examples/basic.ru](https://github.com/jnunemaker/flipper-ui/blob/master/examples/basic.ru) for a more full example
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. **Fire up the app** (`script/server`)
+4. **Start up guard** (`bundle exec guard` for automatic coffeescript/sass compilation and such).
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/examples/basic.ru

@@ -0,0 +1,44 @@
+#
+# Usage:
+#   bundle exec rackup examples/basic.ru
+#   http://localhost:9292/
+#
+require 'pp'
+require 'logger'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'flipper-ui'
+require 'flipper/adapters/memory'
+
+Flipper.register(:admins) { |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+}
+
+Flipper.register(:early_access) { |actor|
+  actor.respond_to?(:early?) && actor.early?
+}
+
+# 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.random(5)
+flipper[:new_cache].enable flipper.actors(15)
+
+run Flipper::UI.app(flipper)

data/examples/flipper.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Flipper</title>
+    <link rel="stylesheet" type="text/css" href="/css/application.css">
+    <style type="text/css">
+      * { margin:0; padding:0; }
+      body {text-align:center;}
+    </style>
+  </head>
+  <body>
+    <img src="flipper.png" />
+  </body>
+</html>

data/flipper-ui.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+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.homepage      = "https://github.com/jnunemaker/flipper-ui"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "flipper-ui"
+  gem.require_paths = ["lib"]
+  gem.version       = Flipper::UI::VERSION
+
+  gem.add_dependency 'rack'
+  gem.add_dependency 'flipper', '~> 0.7.0.beta1'
+  gem.add_dependency 'erubis'
+end

data/lib/flipper-ui.rb

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

data/lib/flipper/ui.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+require 'rack'
+require 'flipper'
+require 'multi_json'
+
+module Flipper
+  module UI
+    def self.root
+      @root ||= Pathname(__FILE__).dirname.expand_path.join('ui')
+    end
+
+    def self.app(flipper)
+      app = lambda { |env| [200, {'Content-Type' => 'text/html'}, ['']] }
+      builder = Rack::Builder.new
+      yield builder if block_given?
+      builder.use Middleware, flipper
+      builder.run app
+      builder
+    end
+  end
+end
+
+require 'flipper/ui/middleware'

data/lib/flipper/ui/action.rb

@@ -0,0 +1,172 @@
+require 'forwardable'
+require 'flipper/ui/error'
+require 'flipper/ui/eruby'
+require 'json'
+
+module Flipper
+  module UI
+    class Action
+      extend Forwardable
+
+      # Public: Call this in subclasses so the action knows its route.
+      #
+      # regex - The Regexp that this action should run for.
+      #
+      # Returns nothing.
+      def self.route(regex)
+        @regex = regex
+      end
+
+      # Internal: Initializes and runs an action for a given request.
+      #
+      # flipper - The Flipper::DSL instance.
+      # request - The Rack::Request that was sent.
+      #
+      # Returns result of Action#run.
+      def self.run(flipper, request)
+        new(flipper, request).run
+      end
+
+      # Internal: The regex that matches which routes this action will work for.
+      def self.regex
+        @regex || raise("#{name}.route is not set")
+      end
+
+      # Private: The path to the views folder.
+      def self.views_path
+        @views_path ||= Flipper::UI.root.join('views')
+      end
+
+      # Private: The path to the public folder.
+      def self.public_path
+        @public_path ||= Flipper::UI.root.join('public')
+      end
+
+      # Public: The instance of the Flipper::DSL the middleware was
+      # initialized with.
+      attr_reader :flipper
+
+      # Public: The Rack::Request to provide a response for.
+      attr_reader :request
+
+      # Public: The params for the request.
+      def_delegator :@request, :params
+
+      def initialize(flipper, request)
+        @flipper, @request = flipper, request
+        @code = 200
+        @headers = {}
+      end
+
+      # Public: Runs the request method for the provided request.
+      #
+      # Returns whatever the request method returns in the action.
+      def run
+        if respond_to?(request_method_name)
+          catch(:halt) { send(request_method_name) }
+        else
+          raise UI::RequestMethodNotSupported, "#{self.class} does not support request method #{request_method_name.inspect}"
+        end
+      end
+
+      # Public: Runs another action from within the request method of a
+      # different action.
+      #
+      # action_class - The class of the other action to run.
+      #
+      # Examples
+      #
+      #   run_other_action Index
+      #   # => result of running Index action
+      #
+      # Returns result of other action.
+      def run_other_action(action_class)
+        action_class.new(flipper, request).run
+      end
+
+      # Public: Call this with a response to immediately stop the current action
+      # and respond however you want.
+      #
+      # response - The response you would like to return.
+      def halt(response)
+        throw :halt, response
+      end
+
+      # Public: Compiles a view and returns rack response with that as the body.
+      #
+      # name - The Symbol name of the view.
+      #
+      # Returns a response.
+      def view_response(name)
+        header 'Content-Type', 'text/html'
+        body = view_with_layout { view_without_layout name }
+        [@code, @headers, [body]]
+      end
+
+      # Public: Dumps an object as json and returns rack response with that as
+      # the body. Automatically sets Content-Type to "application/json".
+      #
+      # object - The Object that should be dumped as json.
+      #
+      # Returns a response.
+      def json_response(object)
+        header 'Content-Type', 'application/json'
+        body = JSON.dump(object)
+        [@code, @headers, [body]]
+      end
+
+      # Public: Set the status code for the response.
+      #
+      # code - The Integer code you would like the response to return.
+      def status(code)
+        @code = code.to_i
+      end
+
+      # Public: Set a header.
+      #
+      # name - The String name of the header.
+      # value - The value of the header.
+      def header(name, value)
+        @headers[name] = value
+      end
+
+      # Private
+      def view_with_layout(&block)
+        view :layout, &block
+      end
+
+      # Private
+      def view_without_layout(name)
+        view name
+      end
+
+      # Private
+      def view(name)
+        path = views_path.join("#{name}.erb")
+        contents = path.read
+        compiled = Eruby.new(contents)
+        compiled.result Proc.new {}.binding
+      end
+
+      # Internal: The path the app is mounted at.
+      def script_name
+        request.env['SCRIPT_NAME']
+      end
+
+      # Private
+      def views_path
+        self.class.views_path
+      end
+
+      # Private
+      def public_path
+        self.class.public_path
+      end
+
+      # Private: Returns the request method converted to an action method.
+      def request_method_name
+        @request_method_name ||= @request.request_method.downcase
+      end
+    end
+  end
+end