starburst 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 975b7fa2f564bb391ef812d9b6718742853633c3
+  data.tar.gz: 81ca5b5b5cafed342dd0cf37ac4932c8871e130a
+SHA512:
+  metadata.gz: 056edfee84823ac0e79e5428e9b9dbf3f13e8d81a282db243e1592bbae5737038e400dddbe06007ab9d1643182545bb6916b4218b99e83ad14c03355c9f41d35
+  data.tar.gz: 8e172552778facca39c43400f620658fa883b7bdb56547a3b9a5e5c4c63f1ebba57b055933e1671b11c705965e8468e32d9657adb850495a3b9ff704b39717aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => ['appraisal:install']
+
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
+end

data/app/assets/javascripts/starburst/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/starburst/starburst.js

@@ -0,0 +1,19 @@
+function ready(fn) {
+  if (document.addEventListener) {
+    document.addEventListener('DOMContentLoaded', fn);
+  } else {
+    document.attachEvent('onreadystatechange', function() {
+      if (document.readyState === 'interactive')
+        fn();
+    });
+  }
+}
+
+ready(function addOneTimeMessagesCallbacks() {
+	var closeButton = document.getElementById('starburst-close');
+	if (closeButton !== null) {
+		closeButton.addEventListener('click', function() {
+			document.getElementById('starburst-announcement').style.display = 'none';
+		});
+	}
+});

data/app/assets/stylesheets/starburst/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/starburst/announcements_controller.rb

@@ -0,0 +1,16 @@
+module Starburst
+	class AnnouncementsController < ApplicationController
+		def mark_as_read
+			announcement = Announcement.find(params[:id].to_i)
+			if respond_to?(Starburst.current_user_method) && send(Starburst.current_user_method) && announcement
+				if AnnouncementView.create(:user => send(Starburst.current_user_method), :announcement => announcement)
+					render :json => :ok
+				else
+					render json: nil, :status => :unprocessable_entity
+				end
+			else
+					render json: nil, :status => :unprocessable_entity
+			end
+		end
+	end
+end

data/app/controllers/starburst/application_controller.rb

@@ -0,0 +1,4 @@
+module Starburst
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/starburst/announcements_helper.rb

@@ -0,0 +1,11 @@
+module Starburst
+  module AnnouncementsHelper
+  	def current_announcement
+		if (defined? current_user) && current_user
+    		@current_announcement ||= Announcement.current(current_user)
+		else
+			false
+		end
+  	end
+  end
+end

data/app/models/starburst/announcement.rb

@@ -0,0 +1,53 @@
+module Starburst
+	class Announcement < ActiveRecord::Base
+		serialize :limit_to_users
+
+		if Rails::VERSION::MAJOR < 4
+			attr_accessible(:title, :body, :start_delivering_at, :stop_delivering_at, :limit_to_users)
+		end
+
+		scope :ready_for_delivery, lambda { 
+			where("(start_delivering_at < ? OR start_delivering_at IS NULL) 
+				AND (stop_delivering_at > ? OR stop_delivering_at IS NULL)", Time.now, Time.now) 
+		}
+
+		scope :unread_by, lambda {|current_user|
+			joins("LEFT JOIN starburst_announcement_views ON 
+				starburst_announcement_views.announcement_id = starburst_announcements.id AND 
+				starburst_announcement_views.user_id = #{Announcement.sanitize(current_user.id)}")
+			.where("starburst_announcement_views.announcement_id IS NULL AND starburst_announcement_views.user_id IS NULL")
+		}
+
+		scope :in_delivery_order, lambda { order("start_delivering_at ASC")}
+
+		def self.current(current_user = nil)
+			if current_user
+				find_announcement_for_current_user(ready_for_delivery.unread_by(current_user).in_delivery_order, current_user)
+			else
+				ready_for_delivery.in_delivery_order.first
+			end
+		end
+
+		def self.find_announcement_for_current_user(announcements, user)
+			user_as_array = user.serializable_hash(methods: Starburst.user_instance_methods)
+			announcements.each do |announcement|
+				if user_matches_conditions(user_as_array, announcement.limit_to_users)
+					return announcement
+				end
+			end
+			return nil
+		end
+
+		def self.user_matches_conditions(user, conditions = nil)
+			if conditions
+				conditions.each do |condition|
+					if user[condition[:field]] != condition[:value]
+						return false
+					end
+				end
+			end
+			return true
+		end
+
+	end
+end

data/app/models/starburst/announcement_view.rb

@@ -0,0 +1,7 @@
+module Starburst
+	class AnnouncementView < ActiveRecord::Base
+		#attr_accessible :announcement, :user
+		belongs_to :announcement
+		belongs_to :user
+	end
+end

data/app/views/announcements/starburst/_announcement.html.erb

@@ -0,0 +1,6 @@
+<% if current_announcement %>
+	<div id="starburst-announcement">
+	 	<p><%= current_announcement.body.html_safe %></p>
+	 	<%= link_to "Close", starburst.mark_as_read_path(current_announcement.id), :method => :post, :remote => true, :id => "starburst-close" %>
+	</div>
+<% end %>

data/app/views/announcements/starburst/_announcement_bootstrap.html.erb

@@ -0,0 +1,8 @@
+<% if current_announcement %>
+	<%= form_tag starburst.mark_as_read_path(current_announcement.id), :remote => true do %>
+		<div class="alert alert-info" id="starburst-announcement" role="alert">
+			<button name="commit" type="submit" class="close" id="starburst-close"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
+			<p><%= current_announcement.body.html_safe %></p>
+		</div>
+	<% end %>
+<% end %>

data/app/views/announcements/starburst/_announcement_foundation.html.erb

@@ -0,0 +1,6 @@
+<% if current_announcement %>
+	<div data-alert class="alert-box">
+	 	<p><%= current_announcement.body.html_safe %></p>
+	 	<%= link_to "&times;".html_safe, starburst.mark_as_read_path(current_announcement.id), :method => :post, :remote => true, :class => "close" %>
+	</div>
+<% end %>

data/app/views/layouts/starburst/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Starburst</title>
+  <%= stylesheet_link_tag    "starburst/application", media: "all" %>
+  <%= javascript_include_tag "starburst/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Starburst::Engine.routes.draw do
+	post "announcements/:id/mark_as_read", to: "announcements#mark_as_read", as: "mark_as_read"
+end

data/db/migrate/20141004214002_create_announcement_tables.rb

@@ -0,0 +1,17 @@
+class CreateAnnouncementTables < ActiveRecord::Migration
+	def change
+		create_table :starburst_announcement_views do |t|
+			t.integer :user_id
+			t.integer :announcement_id
+			t.timestamps
+		end
+		create_table :starburst_announcements do |t|
+			t.text :title
+			t.text :body
+			t.datetime :start_delivering_at
+			t.datetime :stop_delivering_at
+			t.text :limit_to_users
+			t.timestamps
+		end
+	end
+end

data/lib/helpers/starburst/configuration.rb

@@ -0,0 +1,21 @@
+# http://viget.com/extend/easy-gem-configuration-variables-with-defaults
+module Configuration
+  def configuration
+    yield self
+  end
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+  private
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/starburst.rb

@@ -0,0 +1,9 @@
+require "starburst/engine"
+require "helpers/starburst/configuration"
+
+module Starburst
+	extend Configuration
+
+	define_setting :current_user_method, "current_user"
+	define_setting :user_instance_methods
+end

data/lib/starburst/engine.rb

@@ -0,0 +1,13 @@
+module Starburst
+  class Engine < ::Rails::Engine
+    isolate_namespace Starburst
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+  end
+end

data/lib/starburst/version.rb

@@ -0,0 +1,3 @@
+module Starburst
+  VERSION = "0.9.1"
+end

data/lib/tasks/starburst_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :starburst do
+#   # Task goes here
+# end

data/spec/controllers/starburst/announcements_controller_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Starburst
+
+	describe AnnouncementsController do
+		
+		routes { Starburst::Engine.routes } # http://pivotallabs.com/writing-rails-engine-rspec-controller-tests/
+
+		it "marks an announcement as read" do
+			@current_user = mock_model(User, :id => 10)
+			controller.stub(:current_user).and_return(@current_user)
+			announcement = FactoryGirl.create(:announcement)
+			post :mark_as_read, :id => announcement.id
+			expect(response.status).to eq 200
+			expect(AnnouncementView.last.user_id).to eq 10
+			expect(AnnouncementView.all.length).to eq 1
+		end
+		
+		it "does not mark an announcement as read if no one is logged in" do
+			#@current_user = mock_model(User, :id => 10)
+			controller.stub(:current_user).and_return(nil)
+			announcement = FactoryGirl.create(:announcement)
+			post :mark_as_read, :id => announcement.id
+			expect(response.status).to eq 422
+			expect(AnnouncementView.all.length).to eq 0
+		end
+
+		it "has a helper path for mark as read" do
+			expect(mark_as_read_path(1)).to eq "/starburst/announcements/1/mark_as_read"
+		end
+
+	end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+  helper Starburst::AnnouncementsHelper
+end

data/spec/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,5 @@
+class PagesController < ApplicationController
+  def home
+  	
+  end
+end