rollout-ui 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e342dafb4fb3a868d96da458d3227d4d177d168a28e640d3ba6eb4e85caa3393
-  data.tar.gz: f7d5778665b1da78012854c306b1df04797fe924fa5733d68de3bd1428ce8c84
+  metadata.gz: 8a1ec80944aa3ae6f4c7fc142dceb5b0f5f87d111a3a9cec771be3325d5996a8
+  data.tar.gz: df9d961f8306cdfd1bd377d6bb6629238c4e2f8ea901c796f27442f03bfa85c1
 SHA512:
-  metadata.gz: b91d583fecd5e7b9ba6d0d1adfddec7e5a8894e943d80c9c258bb7399d40fc1687cdbe0b72129b111e5c3dfb162d1fc445784660e09c37adeaa8f95165956658
-  data.tar.gz: cf24e7f1bb6b083bad9fd4e30f1838cef1b746f662eb3b94f5de28beb69485f2729a38f302b30a3b807505a22259eb951564ef24bf25bb075af56206b2b57ab2
+  metadata.gz: 952b01c7614a32d8f2ecd7b94f54f02fe8b0483314c1861065c93400ffa7abd6bba639e47639a0ce084fc173ae3b002944ad21bce9bc504273a3cb7c6fa2785e
+  data.tar.gz: 59bcfcb7bbfa61c371b16e692f14afe9b30b7b50b2072eede8849d8c9267b3d54012e1fd8db79571c009b55523f8bc450d13b125e766e9b7ed835c7bf28fc5cb

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.0

data/README.md

@@ -58,6 +58,15 @@ Rails.application.routes.draw do
 end
 ```
 
+## API Endpoints
+
+The index and show routes can also respond with JSON data instead of HTML when the request's `Accept` header is
+`application/json`
+
+The index route also accepts query parameters to filter by user or group:
+`/admin/rollout?user=someone`
+`/admin/rollout?group=developers`
+
 ## Logging
 
 To get the most out of **rollout-ui**, we recommend you to turn on logging

data/lib/rollout/ui/helpers.rb

@@ -84,5 +84,29 @@ module Rollout::UI
         value
       end
     end
+
+    def json_request?
+      request.env['HTTP_ACCEPT'] == 'application/json'
+    end
+
+    # Filters features by user and group if those params are provided
+    def filtered_features(rollout, feature_names)
+      feature_names.select do |feature_name|
+        feature = rollout.get(feature_name)
+        user_match = params[:user].nil? || feature.users.member?(params[:user])
+        group_match = params[:group].nil? || feature.groups.member?(params[:group].to_sym)
+        user_match && group_match
+      end
+    end
+
+    # Returns a hash of feature data to be rendered as json
+    def feature_to_hash(feature)
+      {
+        data: feature.data,
+        groups: feature.groups,
+        name: feature.name,
+        percentage: feature.percentage
+      }
+    end
   end
 end

data/lib/rollout/ui/version.rb

@@ -1,5 +1,5 @@
 class Rollout
   module UI
-    VERSION = "0.2.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/rollout/ui/views/features/index.slim

@@ -24,7 +24,7 @@ h2.font-semibold.text-xl.text-gray-500.pt-12.flex.items-center
       - @features.each do |feature_name|
         - feature = @rollout.get(feature_name)
         tr.border-b.border-gray-200
-          td.py-2.whitespace-no-wrap
+          td.py-2
             a.text-blue-600(href=feature_path(feature.name) class='hover:text-blue-700 hover:underline')
               = feature_name
             div.text-gray-500.text-xs = feature.data['description']

data/lib/rollout/ui/views/features/show.slim

@@ -5,64 +5,69 @@ h2.font-semibold.text-xl.text-gray-500.pt-12
   = @feature.name
 
 .w-8.h-1.bg-gray-300.my-10
+main.p-6.bg-gray-100.max-w-lg.w-full.text-sm.rounded-sm
+  form#updateFormSubmit action=feature_path(@feature.name) method='POST'
+    .mb-5
+      label.block.text-gray-500.mb-2(for='description') Description
+      input.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
+        name='description'
+        id='description'
+        value=@feature.data['description']
+        class='hover:border-gray-500'
+      )
 
-form.p-6.bg-gray-100.max-w-lg.w-full.text-sm.rounded-sm action=feature_path(@feature.name) method='POST'
-  .mb-5
-    label.block.text-gray-500.mb-2(for='description') Description
-    input.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
-      name='description'
-      id='description'
-      value=@feature.data['description']
-      class='hover:border-gray-500'
-    )
-
-  .mb-5
-    label.block.text-gray-500.mb-2(for='groups')
-      | Groups
-      span.ml-1.text-gray-400
-        | (multi-select)
-    select.block.appearance-none.w-full.bg-white.border.border-gray-300.px-4.py-3.rounded-sm.leading-relaxed(name="groups[]" id='groups' multiple=true size=(@rollout.groups.count + 1))
-      option.py-1.px-1(value='' selected=(@feature.groups.count == 0))
-        = '(none)'
-      - @rollout.groups.each do |group|
-        option.py-1.px-1(
-          value=group
-          selected=@feature.groups.include?(group)
-        )
-          = group
-
-  .mb-5
-    label.block.text-gray-500.mb-2(for='percentage') Percentage
-    input.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
-      name='percentage'
-      id='percentage'
-      value=@feature.percentage
-      class='hover:border-gray-500'
-      type='number'
-      step='0.1'
-    )
-
-  .mb-5
-    label.block.text-gray-500.mb-2 Users
+    .mb-5
+      label.block.text-gray-500.mb-2(for='groups')
+        | Groups
+        span.ml-1.text-gray-400
+          | (multi-select)
+      select.block.appearance-none.w-full.bg-white.border.border-gray-300.px-4.py-3.rounded-sm.leading-relaxed(name="groups[]" id='groups' multiple=true size=(@rollout.groups.count + 1))
+        option.py-1.px-1(value='' selected=(@feature.groups.count == 0))
+          = '(none)'
+        - @rollout.groups.each do |group|
+          option.py-1.px-1(
+            value=group
+            selected=@feature.groups.include?(group)
+          )
+            = group
 
-    - if @feature.users.count > 100
-      .appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-gray-100
-        = @feature.users.count
-    - else
-      textarea.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
-        name='users'
-        id='users'
-        value=@feature.users.join(', ')
+    .mb-5
+      label.block.text-gray-500.mb-2(for='percentage') Percentage
+      input.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
+        name='percentage'
+        id='percentage'
+        value=@feature.percentage
         class='hover:border-gray-500'
-        rows='2'
+        type='number'
+        step='0.1'
       )
-        = @feature.users.join(', ')
+
+    .mb-5
+      label.block.text-gray-500.mb-2 Users
+
+      - if @feature.users.count > 150
+        .appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-gray-100
+          = @feature.users.count
+      - else
+        textarea.appearance-none.border.rounded-sm.w-full.py-2.px-4.text-gray-600.leading-relaxed.bg-white(
+          name='users'
+          id='users'
+          value=@feature.users.join(', ')
+          class='hover:border-gray-500'
+          rows='2'
+        )
+          = @feature.users.join(', ')
 
   .flex.items-center.justify-end
     form action=delete_feature_path(@feature.name) method='POST'
       button.mr-5.text-gray-600(class='hover:underline' type='submit' onclick="return confirm('Are you sure you want to delete #{@feature.name}?')")
-        ' Delete
-    button.py-4.px-5.bg-gray-700.text-gray-200.rounded-sm.font-bold.leading-none.transition-colors.duration-200(class='hover:bg-gray-800' type='submit') Update
+        | Delete
+    button.py-4.px-5.bg-gray-700.text-gray-200.rounded-sm.font-bold.leading-none.transition-colors.duration-200(
+      type='submit'
+      class='hover:bg-gray-800'
+      form='updateFormSubmit'
+    )
+      | Update
 
 - history_events = @rollout.respond_to?(:logging) ? @rollout.logging.events(@feature.name).reverse : []
 

data/lib/rollout/ui/web.rb

@@ -1,4 +1,5 @@
 require "sinatra"
+require "sinatra/json"
 require "rollout"
 
 require "rollout/ui/version"
@@ -15,8 +16,15 @@ module Rollout::UI
     get '/' do
       @rollout = config.get(:instance)
       @features = @rollout.features.sort_by(&:downcase)
-
-      slim :'features/index'
+      if json_request?
+        json(
+          filtered_features(@rollout, @features).map do |feature|
+            feature_to_hash(@rollout.get(feature))
+          end
+        )
+      else
+        slim :'features/index'
+      end
     end
 
     get '/features/new' do
@@ -31,7 +39,11 @@ module Rollout::UI
       @rollout = config.get(:instance)
       @feature = @rollout.get(params[:feature_name])
 
-      slim :'features/show'
+      if json_request?
+        json(feature_to_hash(@feature))
+      else
+        slim :'features/show'
+      end
     end
 
     post '/features/:feature_name' do

data/rollout-ui.gemspec

@@ -24,10 +24,14 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rollout', '~> 2.5'
   spec.add_dependency 'sinatra', '~> 2.0'
-  spec.add_dependency 'slim', '~> 4.0'
+  spec.add_dependency 'sinatra-contrib', '~> 2.1'
+  spec.add_dependency 'slim', ['>= 3.0', '< 5.0']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rerun', '~> 0.13'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollout-ui
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - FetLife
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rollout
@@ -39,31 +39,51 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
@@ -108,6 +128,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - dev@fetlife.com
@@ -143,7 +205,7 @@ homepage: https://github.com/fetlife/rollout-ui
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []