Merge pull request #474 from education/flipping-flippers

Add Flipper to Classroom

Gemfile

@@ -12,6 +12,9 @@ gem 'coffee-rails', '~> 4.1.0'
 gem 'draper'
 
 gem 'faraday-http-cache'
+gem 'flipper'
+gem 'flipper-redis'
+gem 'flipper-ui'
 
 gem 'geo_pattern'
 
@@ -39,6 +42,7 @@ gem 'puma'
 gem 'puma_worker_killer'
 
 gem 'rack-canonical-host'
+gem 'redis-namespace'
 
 gem 'sprockets'
 gem 'sass-rails', '~> 5.0'

Gemfile.lock

@@ -122,6 +122,15 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.2.2)
       faraday (~> 0.8)
+    flipper (0.7.4)
+    flipper-redis (0.7.4)
+      flipper (~> 0.7.4)
+      redis (>= 2.2, < 4.0.0)
+    flipper-ui (0.7.4)
+      erubis (~> 2.7.0)
+      flipper (~> 0.7.4)
+      rack (~> 1.4, < 1.7)
+      rack-protection (~> 1.5.3)
     foreman (0.78.0)
       thor (~> 0.19.1)
     geo_pattern (1.4.0)
@@ -257,6 +266,8 @@ GEM
     rainbow (2.0.0)
     rake (10.5.0)
     redis (3.2.2)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
     request_store (1.2.0)
     rspec-core (3.3.2)
       rspec-support (~> 3.3.0)
@@ -353,6 +364,9 @@ DEPENDENCIES
   factory_girl_rails
   faker
   faraday-http-cache
+  flipper
+  flipper-redis
+  flipper-ui
   foreman
   geo_pattern
   jbuilder
@@ -381,6 +395,7 @@ DEPENDENCIES
   rack-tracker
   rails (= 4.2.5.2)
   rails_12factor
+  redis-namespace
   rspec-rails
   rubocop
   sass-rails (~> 5.0)

app/models/assignment.rb

@@ -1,4 +1,5 @@
 class Assignment < ActiveRecord::Base
+  include Flippable
   include GitHubPlan
   include Sluggable
 

app/models/concerns/flippable.rb

@@ -0,0 +1,7 @@
+module Flippable
+  extend ActiveSupport::Concern
+
+  def flipper_id
+    "#{self.class}:#{id}"
+  end
+end

app/models/group_assignment.rb

@@ -1,4 +1,5 @@
 class GroupAssignment < ActiveRecord::Base
+  include Flippable
   include GitHubPlan
   include Sluggable
 

app/models/organization.rb

@@ -1,4 +1,5 @@
 class Organization < ActiveRecord::Base
+  include Flippable
   include Sluggable
 
   update_index('stafftools#organization') { self }
@@ -19,14 +20,10 @@ class Organization < ActiveRecord::Base
 
   validates :slug, uniqueness: true
 
-  # Public
-  #
   def all_assignments
     assignments + group_assignments
   end
 
-  # Public
-  #
   def github_client
     users.sample.github_client
   end

app/models/user.rb

@@ -1,4 +1,6 @@
 class User < ActiveRecord::Base
+  include Flippable
+
   update_index('stafftools#user') { self }
 
   has_many :repo_accesses, dependent: :destroy

app/views/stafftools/_navigation.html.erb

@@ -1,7 +1,9 @@
 <nav class="menu">
-  <span class="menu-heading"><%= octicon('rocket') %> Stafftools</span>
-  <%= link_to stafftools_root_path, class: 'menu-item selected' do %>
-    <%= octicon('search') %>
-    Search
-  <% end %>
+  <span class="menu-heading"><%= octicon('rocket') %> Site Admin</span>
+  <%= link_to 'Search', stafftools_root_path, class: 'menu-item selected' %>
+</nav>
+
+<nav class="menu">
+  <span class="menu-heading"><%= octicon('code') %> Developer Tools</span>
+  <%= link_to 'Features', stafftools_flipper_path, class: 'menu-item' %>
 </nav>

config/initializers/01_redis.rb

@@ -0,0 +1,7 @@
+module Classroom
+  REDIS_URL = ENV['REDISTOGO_URL'] || 'redis://localhost:6379/0'
+
+  def self.redis
+    @redis ||= Redis.new(url: REDIS_URL)
+  end
+end

config/initializers/flipper.rb

@@ -0,0 +1,22 @@
+module Classroom
+  def self.flipper
+    @flipper ||= self.flipper!
+  end
+
+  def self.flipper!
+    adapter = if Rails.env.test?
+                require 'flipper/adapters/memory'
+                Flipper::Adapters::Memory.new
+              else
+                namespaced_client = Redis::Namespace.new(:flipper, :redis => Classroom.redis)
+                Flipper::Adapters::Redis.new(namespaced_client)
+              end
+
+    Flipper.new(adapter)
+  end
+end
+
+# Flipper group for staff
+Flipper.register(:staff) do |user|
+  user.respond_to?(:staff?) && user.staff?
+end

config/routes.rb

@@ -43,7 +43,10 @@
   end
 
   namespace :stafftools do
-    mount Sidekiq::Web  => '/sidekiq', constraints: StaffConstraint.new
+    constraints StaffConstraint.new do
+      mount Sidekiq::Web  => '/sidekiq'
+      mount Flipper::UI.app(Classroom.flipper) => '/flipper', as: 'flipper'
+    end
 
     root to: 'resources#index'
     get '/resource_search', to: 'resources#search'

spec/models/assignment_spec.rb

@@ -14,15 +14,6 @@
     end
   end
 
-  describe 'when the title is updated' do
-    subject { create(:assignment) }
-
-    it 'updates the slug' do
-      subject.update_attributes(title: 'New Title')
-      expect(subject.slug).to eql('new-title')
-    end
-  end
-
   describe 'uniqueness of title across organization' do
     let(:organization) { create(:organization)    }
     let(:creator)      { organization.users.first }
@@ -57,17 +48,32 @@
     end
   end
 
-  describe '#public?' do
-    it 'returns true if Assignments public_repo column is true' do
-      assignment = create(:assignment)
-      expect(assignment.public?).to be(true)
+  context 'with assignment' do
+    subject { create(:assignment) }
+
+    describe 'when the title is updated' do
+      it 'updates the slug' do
+        subject.update_attributes(title: 'New Title')
+        expect(subject.slug).to eql('new-title')
+      end
+    end
+
+    describe '#flipper_id' do
+      it 'should return an id' do
+        expect(subject.flipper_id).to eq("Assignment:#{subject.id}")
+      end
+    end
+
+    describe '#public?' do
+      it 'returns true if Assignments public_repo column is true' do
+        expect(subject.public?).to be(true)
+      end
     end
-  end
 
-  describe '#private?' do
-    it 'returns false if Assignments public_repo column is true' do
-      assignment = create(:assignment)
-      expect(assignment.private?).to be(false)
+    describe '#private?' do
+      it 'returns false if Assignments public_repo column is true' do
+        expect(subject.private?).to be(false)
+      end
     end
   end
 end

spec/models/group_assignment_spec.rb

@@ -14,15 +14,6 @@
     end
   end
 
-  describe 'when the title is updated' do
-    subject { create(:group_assignment) }
-
-    it 'updates the slug' do
-      subject.update_attributes(title: 'New Title')
-      expect(subject.slug).to eql('new-title')
-    end
-  end
-
   describe 'uniqueness of title across organization' do
     let(:organization) { create(:organization)    }
     let(:creator)      { organization.users.first }
@@ -53,17 +44,32 @@
     end
   end
 
-  describe '#public?' do
-    it 'returns true if Assignments public_repo column is true' do
-      group_assignment = create(:group_assignment)
-      expect(group_assignment.public?).to be(true)
+  context 'with group_assignment' do
+    subject { create(:group_assignment) }
+
+    describe 'when the title is updated' do
+      it 'updates the slug' do
+        subject.update_attributes(title: 'New Title')
+        expect(subject.slug).to eql('new-title')
+      end
+    end
+
+    describe '#flipper_id' do
+      it 'should return an id' do
+        expect(subject.flipper_id).to eq("GroupAssignment:#{subject.id}")
+      end
+    end
+
+    describe '#public?' do
+      it 'returns true if Assignments public_repo column is true' do
+        expect(subject.public?).to be(true)
+      end
     end
-  end
 
-  describe '#private?' do
-    it 'returns false if Assignments public_repo column is true' do
-      group_assignment = create(:group_assignment)
-      expect(group_assignment.private?).to be(false)
+    describe '#private?' do
+      it 'returns false if Assignments public_repo column is true' do
+        expect(subject.private?).to be(false)
+      end
     end
   end
 end

spec/models/organization_spec.rb

@@ -1,18 +1,16 @@
 require 'rails_helper'
 
 RSpec.describe Organization, type: :model do
-  describe 'when title is changed' do
-    subject { create(:organization) }
+  subject { create(:organization) }
 
+  describe 'when title is changed' do
     it 'updates the slug' do
       subject.update_attributes(title: 'New Title')
       expect(subject.slug).to eql("#{subject.github_id}-new-title")
     end
   end
 
   describe '#all_assignments' do
-    subject { create(:organization) }
-
     context 'new Organization' do
       it 'returns an empty array' do
         expect(subject.all_assignments).to be_kind_of(Array)
@@ -40,11 +38,15 @@
     end
   end
 
-  describe '#github_client' do
-    let(:organization) { create(:organization) }
+  describe '#flipper_id' do
+    it 'should return an id' do
+      expect(subject.flipper_id).to eq("Organization:#{subject.id}")
+    end
+  end
 
+  describe '#github_client' do
     it 'selects a users github_client at random' do
-      expect(organization.github_client.class).to eql(Octokit::Client)
+      expect(subject.github_client.class).to eql(Octokit::Client)
     end
   end
 end

spec/models/user_spec.rb

@@ -26,6 +26,12 @@
     end
   end
 
+  describe '#flipper_id' do
+    it 'should return an id' do
+      expect(user.flipper_id).to eq("User:#{user.id}")
+    end
+  end
+
   describe '#github_client' do
     it 'sets or creates a new GitHubClient with the users token' do
       expect(user.github_client.class).to eql(Octokit::Client)