rollout_admin 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,47 @@
+# RolloutAdmin
+
+Gem to controll your rollout features via a webinterface. This is the first "not yet clean" version. Please do not use in production environment.
+
+![Image](app/assets/images/rollout_admin/screen.png?raw=true)
+
+## INSTALL
+
+Add rollout_admin to your Gemfile. Then bundle install. Make sure you have rollout installed as well from nedeco git because rollout_admin relies on the IP address extension. This can be found here:
+
+	git@github.com:nedeco/rollout.git
+	
+Make sure to use the branch "workable".
+
+rollout_admin expects that:
+
+- you have a User model with the attributes "id", "name", "email". 
+- Rollout must be initialized and available via $rollout variable.
+
+
+To mount the engine within your project add the following line to your routes.rb: 
+
+	mount RolloutAdmin::Engine => "/rollout_admin"
+
+You will be asked for a username and password when accessing the page for the first time. This is "foo/bar".
+
+**Special hint when using an API**
+
+It turned out that in one of our own projects we wrapped the users object to be accessed via an API. Within our main application controller the API calls got some additional headers for API Key which where not accessable within the rollout_admin engine. Therefor there is an option RolloutAdmin.user_url you can configure to provide the URL used for getting a users list within the RolloutAdmin interface.
+
+Just define an initializer and paste the following:
+
+	# Rollout Admin configuration
+	#
+	RolloutAdmin.user_url = "/just/something/boring.json"
+
+## TODO
+
+- make detailed install instructions
+- add configuration for authentication
+- make ip feature configurable
+- make User model dependency more generic
+- check for failing Ajax calls
+
+## Credits
+
+Thanks to jamesgolick for providing rollout gem. Great work.

data/app/assets/javascripts/rollout_admin/admin.js.erb

@@ -2,6 +2,13 @@
 # import the routes from the engine router to be aware
 # of the mount path when doing javascript ajax calls
 url = RolloutAdmin::Engine.routes.url_helpers 
+
+
+if RolloutAdmin.user_url.nil?
+  user_url=url.get_users_path(:format => :json )
+else
+  user_url=RolloutAdmin.user_url
+end
 %>
 
 $(function(){
@@ -66,7 +73,7 @@ $(function(){
 	    	$('.feature_name').html(context);
 	    	$that = $(this);
 
-			$.getJSON('<%= url.get_users_path(:format => :json )%>', function(json) {
+			$.getJSON('<%= user_url%>', function(json) {
 					userlist='<h5>Select users to add</h5><form id="userlist"><ul class="unstyled">';
 					$.each(json, function() {
 					    userlist += '<li><input type="checkbox", value="'+this.id+'" data-username="'+this.Name+'"> '+this.Name+', '+this.email+'</li>';

data/app/controllers/rollout_admin/admin_controller.rb

@@ -33,8 +33,12 @@ module RolloutAdmin
   end
 
   def get_users
-    @users=User.all
-    render :json => @users
+    if Object.const_defined?('User')
+      @users=User.all
+      render :json => @users
+    else
+      render :json => {'error' => 'no users defined'}
+    end
   end
 
   def add

data/app/views/rollout_admin/admin/_feature.html.erb

@@ -10,7 +10,13 @@
 		  	<ul class="unstyled">
 		  	<% if feature.users.count > 0 %>
 			  	<% feature.users.each {|user| %>
-			  		<li><i class="icon-minus delete_user"></i><%#=User.find(user.to_i).Name%></li>
+			  		<li><i class="icon-minus delete_user"></i>
+			  			<%if Object.const_defined?('User') %>
+			  				<%=User.find(user.to_i).Name%>
+			  			<% else %>
+			  				no User model defined
+			  			<% end %>
+			  		</li>
 				<% } %>
 			<% else %>
 				<li>No members</li>

data/lib/rollout_admin/engine.rb

@@ -3,5 +3,10 @@ module RolloutAdmin
     isolate_namespace RolloutAdmin
     require 'jquery-ui-rails'
     require 'less-rails-bootstrap'
+
+    initializer "rollout_admin.init_task", :before=> :load_config_initializers do |app|
+    	puts "running the initializer"
+    end
+
   end
 end

data/lib/rollout_admin/version.rb

@@ -1,3 +1,3 @@
 module RolloutAdmin
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/rollout_admin.rb

@@ -1,4 +1,6 @@
 require "rollout_admin/engine"
 
 module RolloutAdmin
+    mattr_accessor :user_url
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollout_admin
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -133,6 +133,7 @@ files:
 - app/assets/images/rollout_admin/head_bg.jpg
 - app/assets/images/rollout_admin/icon_todos50x50.png
 - app/assets/images/rollout_admin/main_bg.jpg
+- app/assets/images/rollout_admin/screen.png
 - app/assets/javascripts/rollout_admin/admin.js.erb
 - app/assets/javascripts/rollout_admin/application.js
 - app/assets/javascripts/rollout_admin/failures.js
@@ -154,7 +155,7 @@ files:
 - lib/tasks/rollout_admin_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb

data/README.rdoc

@@ -1,23 +0,0 @@
-= RolloutAdmin
-
-Gem to controll your rollout features via a webinterface. This is the first "not yet clean" version. Please do not use in production environment.
-
-== INSTALL
-
-Add rollout_admin to your Gemfile. Then bundle install. Make sure you have rollout installed as well from nedeco git because rollout_admin relies on the IP address extension.
-
-rollout_admin expects that you have a User model with the attributes "id", "name", "email". Rollout must be initialized and available viw $rollout variable.
-
-Add the following line to your routes.rb: 
-
-  mount RolloutAdmin::Engine => "/rollout_admin"
-
-You will be asked for a username and password. This is "foo/bar".
-
-== TODO
-
-- check dependencies 
-- make detailed install instructions
-- add configuration for authentication
-- make ip feature configurable
-- make User model dependency more generic