flipper-ui 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb876470ebb6b05094e57f03964f9c32eac27f52dd449ea6bba74a40d5aaa4bd
-  data.tar.gz: 2511d18885a5b94104ba2e8ad5845079be6425ea18425f5cfd01ac080cc7d0ad
+  metadata.gz: 44a654fa6a9daf9af3272f25d414b8a953f829a9ddb500a6a085a5919fc783bb
+  data.tar.gz: 5466d76522f8a94747ebeb162a9e1836094a31267cd6a9e9f84e785af3ac34eb
 SHA512:
-  metadata.gz: d92a393344d56c17ef6e2c745d210879b5c2a457926f9663461fd68c4368294328bf81c3710b197f9744739e7d3ffc52a30ea8af6adce49a63bca5e58da23ee3
-  data.tar.gz: e4f03b7e76dc5238a4e7e02ba9a77beaa2c92e21b1b92c931f932bd2d588e789eec4e826e1d0ea833fb9f9918610d71a317a42d0ed49dc1595a7da592886df0f
+  metadata.gz: 4e1fe362a0eccc247eb9ca1420c342a1dc9eeb95c17e5aaa09c8ae30346e42b71432afd3dc557322ada8ec9cab933dc1c6c2a4e4ef867f44898e8ac50727d693
+  data.tar.gz: bfb07f42f6aa93c1e5bb6385ef68f02ae4226b29d2268ba7904b7349896a2dde2cc5f1f09207dec163892814b78ebab7ed9dc36bed4797b582ebff2d65367b4d

data/examples/ui/authorization.ru

@@ -5,6 +5,7 @@
 #   http://localhost:9999/
 #
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/ui"
 require "flipper/adapters/pstore"
 
@@ -40,6 +41,8 @@ end
 # Flipper.enable_percentage_of_actors(:new_cache, 15)
 # Flipper.add("a/b")
 
+use Rack::Reloader
+
 run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"
   builder.use FlipperReadOnlyMiddleware

data/examples/ui/basic.ru

@@ -9,6 +9,7 @@
 #   http://localhost:9999/
 #
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/ui"
 require "flipper/adapters/pstore"
 
@@ -26,7 +27,7 @@ Flipper::UI.configure do |config|
   config.feature_creation_enabled = true
   config.feature_removal_enabled = true
   config.cloud_recommendation = true
-  config.confirm_fully_enable = true
+  config.confirm_fully_enable = false
   # config.show_feature_description_in_list = true
   config.descriptions_source = lambda do |_keys|
     {
@@ -54,6 +55,8 @@ end
 # Flipper.enable_percentage_of_actors(:new_cache, 15)
 # Flipper.add("a/b")
 
+use Rack::Reloader
+
 run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"
 }

data/examples/ui/read_only.ru

@@ -9,6 +9,7 @@
 #   http://localhost:9999/
 #
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/ui"
 require "flipper/adapters/pstore"
 
@@ -38,6 +39,8 @@ end
 # Flipper.enable_percentage_of_actors(:new_cache, 15)
 # Flipper.add("a/b")
 
+use Rack::Reloader
+
 run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"
 }

data/lib/flipper/ui/action.rb

@@ -174,7 +174,12 @@ module Flipper
       # Returns a response.
       def json_response(object)
         header 'Content-Type', 'application/json'
-        body = JSON.dump(object)
+        body = case object
+        when String
+          object
+        else
+          JSON.dump(object)
+        end
         halt [@code, @headers, [body]]
       end
 

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

@@ -0,0 +1,19 @@
+require 'flipper/ui/action'
+require 'flipper/ui/util'
+
+module Flipper
+  module UI
+    module Actions
+      class Export < UI::Action
+        route %r{\A/settings\/export/?\Z}
+
+        def post
+          header 'Content-Disposition', "Attachment;filename=flipper_#{flipper.adapter.adapter.name}_#{Time.now.to_i}.json"
+
+          export = flipper.export(format: :json, version: 1)
+          json_response export.contents
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'flipper/ui/action'
+require 'flipper/ui/util'
+
+module Flipper
+  module UI
+    module Actions
+      class Import < UI::Action
+        route %r{\A/settings\/import/?\Z}
+
+        def post
+          contents = params['file'][:tempfile].read
+          export = Flipper::Exporters::Json::Export.new(contents: contents)
+          flipper.import(export)
+          redirect_to "/features"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'flipper/ui/action'
+require 'flipper/ui/util'
+
+module Flipper
+  module UI
+    module Actions
+      class Settings < UI::Action
+        route %r{\A/settings/?\Z}
+
+        def get
+          @page_title = 'Settings'
+
+          breadcrumb 'Home', '/'
+          breadcrumb 'Settings'
+
+          view_response :settings
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/middleware.rb

@@ -25,6 +25,9 @@ module Flipper
         @action_collection.add UI::Actions::PercentageOfActorsGate
         @action_collection.add UI::Actions::Feature
         @action_collection.add UI::Actions::Features
+        @action_collection.add UI::Actions::Export
+        @action_collection.add UI::Actions::Import
+        @action_collection.add UI::Actions::Settings
 
         # Static Assets/Files
         @action_collection.add UI::Actions::File

data/lib/flipper/ui/views/layout.erb

@@ -17,6 +17,12 @@
         </div>
       <%- end -%>
 
+      <div class="container text-muted small mb-3">
+        <a href="https://www.flippercloud.io/docs/ui?utm_source=oss&utm_medium=ui&utm_campaign=docs">Docs</a> &bull;
+        <a href="<%= script_name %>/settings">Settings</a> &bull;
+        Version: <%= Flipper::VERSION %>
+      </div>
+
       <nav aria-label="breadcrumb">
         <ol class="breadcrumb bg-white border align-items-center mb-4">
           <% @breadcrumbs.each do |breadcrumb| %>

data/lib/flipper/ui/views/settings.erb

@@ -0,0 +1,26 @@
+<div class="card mb-4 ">
+  <div class="card-header">
+    <h4 class="m-0">Export</h4>
+  </div>
+  <div class="card-body">
+    <form action="<%= script_name %>/settings/export" method="post">
+      <%== csrf_input_tag %>
+      <p>Download all your feature data in a single file.</p>
+      <input type="submit" value="Download" class="btn btn-sm btn-light">
+    </form>
+  </div>
+</div>
+
+<div class="card">
+  <div class="card-header">
+    <h4 class="m-0">Import</h4>
+  </div>
+  <div class="card-body">
+    <p>Import a backup file to restore your feature data. This will overwrite any of your existing feature data so be sure you are uploading the correct export.</p>
+    <form action="<%= script_name %>/settings/import" method="post" class="form-inline" enctype="multipart/form-data">
+      <%== csrf_input_tag %>
+      <input type="file" name="file" class="form-control form-control-sm mr-sm-2 mb-2 mb-sm-0">
+      <input type="submit" value="Import" class="btn btn-sm btn-light">
+    </form>
+  </div>
+</div>

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.26.0'.freeze
+  VERSION = '0.27.0'.freeze
 end

data/spec/flipper/ui/actions/export_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Flipper::UI::Actions::Features do
+  let(:token) do
+    if Rack::Protection::AuthenticityToken.respond_to?(:random_token)
+      Rack::Protection::AuthenticityToken.random_token
+    else
+      'a'
+    end
+  end
+
+  let(:session) do
+    { :csrf => token, 'csrf' => token, '_csrf_token' => token }
+  end
+
+  describe "POST /settings/export" do
+    before do
+      flipper.enable_percentage_of_actors :search, 10
+      flipper.enable_percentage_of_time :search, 15
+      flipper.enable_actor :search, Flipper::Actor.new('User;1')
+      flipper.enable_actor :search, Flipper::Actor.new('User;100')
+      flipper.enable_group :search, :admins
+      flipper.enable_group :search, :employees
+      flipper.enable :plausible
+      flipper.disable :google_analytics
+
+      post '/settings/export',
+        {'authenticity_token' => token},
+        'rack.session' => session
+    end
+
+    it 'responds with success' do
+      expect(last_response.status).to be(200)
+    end
+
+    it 'sets content disposition' do
+      expect(last_response.headers['Content-Disposition']).to match(/Attachment;filename=flipper_memory_[0-9]*\.json/)
+    end
+
+    it 'renders json' do
+      data = JSON.parse(last_response.body)
+      expect(last_response.headers['Content-Type']).to eq('application/json')
+      expect(data['version']).to eq(1)
+      expect(data['features']).to eq({
+        "search"=> {"boolean"=>nil, "groups"=>["admins", "employees"], "actors"=>["User;1", "User;100"], "percentage_of_actors"=>"10", "percentage_of_time"=>"15"},
+        "plausible"=> {"boolean"=>"true", "groups"=>[], "actors"=>[], "percentage_of_actors"=>nil, "percentage_of_time"=>nil},
+        "google_analytics"=> {"boolean"=>nil, "groups"=>[], "actors"=>[], "percentage_of_actors"=>nil, "percentage_of_time"=>nil},
+      })
+    end
+  end
+end

data/spec/flipper/ui/actions/import_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Flipper::UI::Actions::Import do
+  let(:token) do
+    if Rack::Protection::AuthenticityToken.respond_to?(:random_token)
+      Rack::Protection::AuthenticityToken.random_token
+    else
+      'a'
+    end
+  end
+
+  let(:session) do
+    { :csrf => token, 'csrf' => token, '_csrf_token' => token }
+  end
+
+  describe "POST /settings/import" do
+    before do
+      flipper.enable :plausible
+      flipper.disable :google_analytics
+      path = FlipperRoot.join("spec", "fixtures", "flipper_pstore_1679087600.json")
+
+      post '/settings/import',
+        {
+          'authenticity_token' => token,
+          'file' => Rack::Test::UploadedFile.new(path, "application/json"),
+        },
+        'rack.session' => session
+    end
+
+    it 'imports the file export' do
+      expect(flipper[:search].actors_value).to eq(Set.new(['john', 'another', 'testing']))
+      expect(flipper[:search].groups_value).to eq(Set.new(['admins']))
+      expect(flipper[:google_analytics_tag].percentage_of_actors_value).to eq(100)
+      expect(flipper[:new_pricing].boolean_value).to eq(true)
+      expect(flipper[:nope].boolean_value).to eq(false)
+    end
+
+    it 'responds with redirect to settings' do
+      expect(last_response.status).to be(302)
+      expect(last_response.headers['Location']).to eq('/features')
+    end
+  end
+end

data/spec/flipper/ui/actions/settings_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe Flipper::UI::Actions::Settings do
+  let(:token) do
+    if Rack::Protection::AuthenticityToken.respond_to?(:random_token)
+      Rack::Protection::AuthenticityToken.random_token
+    else
+      'a'
+    end
+  end
+
+  let(:session) do
+    { :csrf => token, 'csrf' => token, '_csrf_token' => token }
+  end
+
+  describe 'GET /settings' do
+    before do
+      get '/settings'
+    end
+
+    it 'responds with success' do
+      expect(last_response.status).to be(200)
+    end
+
+    it 'renders template' do
+      expect(last_response.body).to include('Download')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.27.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.27.0
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -116,13 +116,16 @@ files:
 - lib/flipper/ui/actions/actors_gate.rb
 - lib/flipper/ui/actions/add_feature.rb
 - lib/flipper/ui/actions/boolean_gate.rb
+- lib/flipper/ui/actions/export.rb
 - lib/flipper/ui/actions/feature.rb
 - lib/flipper/ui/actions/features.rb
 - lib/flipper/ui/actions/file.rb
 - lib/flipper/ui/actions/groups_gate.rb
 - lib/flipper/ui/actions/home.rb
+- lib/flipper/ui/actions/import.rb
 - lib/flipper/ui/actions/percentage_of_actors_gate.rb
 - lib/flipper/ui/actions/percentage_of_time_gate.rb
+- lib/flipper/ui/actions/settings.rb
 - lib/flipper/ui/configuration.rb
 - lib/flipper/ui/configuration/option.rb
 - lib/flipper/ui/decorators/feature.rb
@@ -142,18 +145,22 @@ files:
 - lib/flipper/ui/views/features.erb
 - lib/flipper/ui/views/layout.erb
 - lib/flipper/ui/views/read_only.erb
+- lib/flipper/ui/views/settings.erb
 - lib/flipper/version.rb
 - spec/flipper/ui/action_spec.rb
 - spec/flipper/ui/actions/actors_gate_spec.rb
 - spec/flipper/ui/actions/add_feature_spec.rb
 - spec/flipper/ui/actions/boolean_gate_spec.rb
+- spec/flipper/ui/actions/export_spec.rb
 - spec/flipper/ui/actions/feature_spec.rb
 - spec/flipper/ui/actions/features_spec.rb
 - spec/flipper/ui/actions/file_spec.rb
 - spec/flipper/ui/actions/groups_gate_spec.rb
 - spec/flipper/ui/actions/home_spec.rb
+- spec/flipper/ui/actions/import_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/ui/actions/percentage_of_time_gate_spec.rb
+- spec/flipper/ui/actions/settings_spec.rb
 - spec/flipper/ui/configuration_spec.rb
 - spec/flipper/ui/decorators/feature_spec.rb
 - spec/flipper/ui/decorators/gate_spec.rb
@@ -188,13 +195,16 @@ test_files:
 - spec/flipper/ui/actions/actors_gate_spec.rb
 - spec/flipper/ui/actions/add_feature_spec.rb
 - spec/flipper/ui/actions/boolean_gate_spec.rb
+- spec/flipper/ui/actions/export_spec.rb
 - spec/flipper/ui/actions/feature_spec.rb
 - spec/flipper/ui/actions/features_spec.rb
 - spec/flipper/ui/actions/file_spec.rb
 - spec/flipper/ui/actions/groups_gate_spec.rb
 - spec/flipper/ui/actions/home_spec.rb
+- spec/flipper/ui/actions/import_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/ui/actions/percentage_of_time_gate_spec.rb
+- spec/flipper/ui/actions/settings_spec.rb
 - spec/flipper/ui/configuration_spec.rb
 - spec/flipper/ui/decorators/feature_spec.rb
 - spec/flipper/ui/decorators/gate_spec.rb