rollout-ui 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e342dafb4fb3a868d96da458d3227d4d177d168a28e640d3ba6eb4e85caa3393
-  data.tar.gz: f7d5778665b1da78012854c306b1df04797fe924fa5733d68de3bd1428ce8c84
+  metadata.gz: 46ae18c9e6daeba114f85ef7608108c76095761a97446d570da01f7412f80183
+  data.tar.gz: f38e59a3c048cd04074b9d85bb708c1aa8d07d6b94c1b1ba0e66bf616d0fdae9
 SHA512:
-  metadata.gz: b91d583fecd5e7b9ba6d0d1adfddec7e5a8894e943d80c9c258bb7399d40fc1687cdbe0b72129b111e5c3dfb162d1fc445784660e09c37adeaa8f95165956658
-  data.tar.gz: cf24e7f1bb6b083bad9fd4e30f1838cef1b746f662eb3b94f5de28beb69485f2729a38f302b30a3b807505a22259eb951564ef24bf25bb075af56206b2b57ab2
+  metadata.gz: 1fa46d7b3ed9372bd46059d5f0513d8ba18964c97787ad8b552df5e82f4ce2a378d31d6407d095d586df948897c07dd890c99359ac548624f10c83308fcfc368
+  data.tar.gz: 9286a654951b7f8462bd8e8742d351f23dda33afe8097245bb339ad15314ccafe8a84614448c8c2c393fdf4cfc721f533d600b0ebd11d051469394895e4fa072

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.3.0"
   end
 end

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,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rollout', '~> 2.5'
   spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'sinatra-contrib', '~> 2.1'
   spec.add_dependency 'slim', '~> 4.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 '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.3.0
 platform: ruby
 authors:
 - FetLife
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rollout
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -56,14 +70,14 @@ dependencies:
   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 +122,34 @@ 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: 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