my_dashboard 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6921062316bf4ad1280f750f749cf920536bb003
+  data.tar.gz: 9ed70991cdcbea1d76d96303a916f75d50d845d2
+SHA512:
+  metadata.gz: f80dc506499fe6ac919db9a73fa39bf7e47a5da63d688ba07a6d2c65e238d8788ad42857b79061010d2eaee7032917af9479e68aab8669be17eca7e57e0d2520
+  data.tar.gz: 3f1b4b8a365a5025e4e4e8f3eb4e3108b6783f455c9e07363d2f5e32d16aea8ae9cf867ecf4cff8ab9aec810519183d62e3b874236c849cf34807ea8dca3f83d

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+log/*.log
+pkg/
+Gemfile.lock
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.coveralls.yml
+coverage/
+test_widget.*
+.DS_Store

data/.travis.yml

@@ -0,0 +1,9 @@
+bundler_args: "--without development"
+language: ruby
+rvm:
+- 2.0.0
+- 2.2.0
+- 2.3.0
+env:
+  global:
+    secure: R4h1vcshVXcsPmJEAspuY/XBHxyNXbh3jhD7y4VMOZ4MuIgL4Yy+OeMY/+mB74zsbsU/vpcL4gSR72G3so3s/Z/5f8B1CjOlPuIx2W5xlX0O0Duj7dNhWv5MxV2l5lseVEJlN1x+gowfnRJRFWCfzpNSaMRPCrCndQJuWfJyAI27q1HR6kH5Y+AYN6lRssUK1ecNeWlT95COj3l53bgztZr4LPvM0w6B15HR3flJo8B1e/VokLYG3ScjbcZQCU1OItE8mi/CgCkwzIZ7KkBmhsMEPx8to9Ud1ETXwQ+0waGWtbhTxvoRR3ArZsNS4oJfT9hfDTKZIWnQhMXmE9xS+qy2UnW5xF81ng8+bX3/saR0k1LYgVKgWn4NjwUkBw+TD+q1UErqdG2aQbFQqMqsd2+XCbYZW807F/5BxAVPQuQ2h/aMbseO/iFmJctKiCXHO1r4P0X0TkEcYVd3tw34YZM/yczgcXOWSbCKRThjBWCE/zK7S4Rsx0sUn3acRhMCNb26LaLPQctLeGK9UdOf/y5d07SmZ6TSWs9QXVHhBw1RKX1p+n8guZXjuIxQCFsWRGwBlQ14kEovMUrPfsFj2E74C2r3BVXs73PniVe+46e3uvfZYok5tp9PKQgeCm6oH5uROBOw7eCa1UsWYfujzIbMPPFHergjNOev6I34UyE=

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 0.4.1 (05/17/2016)
+
+* Add FlexBox support
+* Removes Batman.js
+
+## 0.3.1 (05/17/2016)
+
+* Add Code Climate integration
+* Add Travis CI integration
+* Add Coveralls integration
+* Fix bug method Configuration doesn't load
+
+## 0.2.1 (05/16/2016)
+
+* Fix broken parameter .gemspec
+
+## 0.2.0 (05/16/2016)
+
+* Add badges for Issues Count, Code Climate, Build Status and Dependency Status
+
+## 0.1.0 (05/16/2016)
+
+* Initial public release - [@danilovaz](https://github.com/danilovaz)

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in my_dashboard.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+group :test, :development do
+  gem 'sqlite3'
+  gem 'rspec-rails', '~> 2.14'
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+  gem 'generator_spec', require: false
+  gem 'codeclimate-test-reporter', require: false
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Danilo Vaz
+
+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/README.md

@@ -0,0 +1,223 @@
+# my_dashboard
+
+[![Issue Count](https://codeclimate.com/github/danilovaz/my_dashboard/badges/issue_count.svg)](https://codeclimate.com/github/danilovaz/my_dashboard)
+[![Code Climate](https://codeclimate.com/github/danilovaz/my_dashboard/badges/gpa.svg)](https://codeclimate.com/github/danilovaz/my_dashboard)[![Coverage Status](https://coveralls.io/repos/github/danilovaz/my_dashboard/badge.svg?branch=master)](https://coveralls.io/github/danilovaz/my_dashboard?branch=master)
+[![Build Status](https://travis-ci.org/danilovaz/my_dashboard.svg?branch=master)](https://travis-ci.org/danilovaz/my_dashboard)
+[![Dependency Status](https://gemnasium.com/badges/github.com/danilovaz/my_dashboard.svg)](https://gemnasium.com/github.com/danilovaz/my_dashboard)
+
+my_dashboard is the Rails Engine version of [Dashing by Shopify](http://shopify.github.io/dashing/) who **uses flexbox** instead [gridster](http://gridster.net/). This is totally inspired by [Dashing-Rails](https://github.com/gottfrois/dashing-rails).
+A huge thanks to Shopify and [Pierre-Louis Gottfrois](https://github.com/gottfrois) for their great work.
+
+<img src="https://dl.dropboxusercontent.com/u/29838807/dashing-rails.png" width="600" />
+
+## Introduction
+
+my_dashboard is a Rails engine that lets you build beautiful dashboards with  [flexbox]().
+
+Check out our demo over [here]().
+
+Key features:
+
+* Use premade widgets, or fully create your own with scss, html, and javascript.
+* Dashboards tottally responsive's using all the power of FlexBox.
+* Widgets harness the power of data bindings to keep things DRY and simple. Powered by batman.js.
+* Use the API to push data to your dashboards, or make use of a simple ruby DSL for fetching data.
+* Drag & Drop interface for re-arranging your widgets.
+* Host your dashboards on Heroku in less than 30 seconds.
+
+## Requirements
+
+* Ruby >=1.9.3
+* Rails 4
+* Redis
+* Multi Threaded server ([puma](https://github.com/puma/puma), [rainbows](http://rainbows.rubyforge.org/))
+
+
+## Getting Started
+
+1. Install the gem by adding the following in your `Gemfile`:
+
+  ```ruby
+  gem 'my_dashboard'
+  ```
+
+2. Install puma server by adding the following in your `Gemfile`:
+
+  ```ruby
+  gem 'puma'
+  ```
+
+3. Bundle install
+
+  ```
+  $ bundle
+  ```
+
+4. Install the dependencies using the following command:
+
+  ```
+  $ rails g my_dashboard:install
+  ```
+
+5. Start redis server:
+
+  ```
+  $ redis-server
+  ```
+
+6. Open `config/environments/development.rb` and add:
+
+  ```ruby
+  config.allow_concurrency = true
+  ```
+
+7. Start your server (must be a multi threaded server - See [Requirements](https://github.com/danilovaz/my_dashboard#requirements))
+
+  ```
+  $ rails s
+  ```
+
+8. Point your browser at [http://localhost:3000/my_dashboard/dashboards](http://localhost:3000/my_dashboard/dashboards) and have fun!
+
+
+**Important Note:** *We need to update the configuration in development to handle multiple requests at the same time. One request for the page we’re working on, and another request for the Server Sent Event controller.*
+
+- - -
+
+Every new my_dashboard project comes with sample widgets & sample dashboards for you to explore. The directory is setup as follows:
+
+* `app/views/my_dashboard/dashboards` — One .erb file for each dashboard that contains the layout for the widgets.
+* `app/jobs` — Your ruby jobs for fetching data (e.g for calling third party APIs like twitter).
+* `app/assets/javascripts/my_dashboard/widgets/` — A widget's name `.js` file containing your widget's js.
+* `app/assets/stylesheets/my_dashboard/widgets/` — A widget's name `.scss` file containing your widget's css.
+* `app/views/my_dashboard/widgets/` — A widget's name `.html` file containing your widget's html.
+* `app/views/layouts/my_dashboard/` — All your custom layouts where your dashboards and widgets will be included.
+
+## Getting Data Into Your Widgets
+
+Providing data to widgets is easy. You specify which widget you want using a widget id, and then pass in the JSON data. There are two ways to do this:
+
+### Jobs
+
+my_dashboard uses [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) to schedule jobs. You can make a new job with `rails g my_dashboard:job sample_job`, which will create a file in the jobs directory called `sample_job.rb`.
+
+Example:
+
+```ruby
+# :first_in sets how long it takes before the job is first run. In this case, it is run immediately
+MyDashboard.scheduler.every '1m', first_in: 1.second.since do |job|
+  MyDashboard.send_event('karma', { current: rand(1000) })
+end
+```
+
+This job will run every minute, and will send a random number to ALL widgets that have `data-id` set to `"karma"`.
+
+You send data using the following method:
+
+```ruby
+MyDashboard.send_event(widget_id, json_formatted_data)
+```
+
+Jobs are where you put stuff such as fetching metrics from a database, or calling a third party API like Twitter. Since the data fetch is happening in only one place, it means that all instances of widgets are in sync.
+
+[Server Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/) are used in order to stream data to the dashboards.
+
+### Redis
+
+my_dashboard uses [Redis](http://redis.io/) to push and pull data and feed your widgets. Since my_dashboard [Requirements](https://github.com/danilovaz/my_dashboard#requirements) can be quite frustrating, I thought it might be useful to use redis.
+
+This way you can have a seperate Rails 4 application (with puma) running your dashboards and push your data to redis from your main Rails 3 application for example.
+
+You can specify my_dashboard redis credentials in `config/initializers/my_dashboard.rb`:
+
+```ruby
+config.redis_host     = '127.0.0.1'
+config.redis_port     = '6379'
+config.redis_password = '123456'
+```
+
+By default my_dashboard subscribed to the following namespace in redis:
+
+```
+my_dashboard_events.*
+```
+
+where `*` can be anything. This give you all the flexibility you need to push to redis. For example the `send_event` method provided by my_dashboard uses the following namespace:
+
+```ruby
+redis.publish("my_dashboard_events.create", {})
+```
+
+You can configure the redis namespace in `config/initializers/my_dashboard.rb`:
+
+```ruby
+config.redis_namespace = 'your_redis_namespace'
+```
+
+### API
+
+#### Widgets
+
+Your widgets can be updated directly over HTTP. Post the data you want in json to `/my_dashboard/widgets/widget_id`. For security, you will also have to include your `auth_token` (which you can generate in `config/initializers/my_dashboard.rb`).
+
+Example:
+
+```
+curl -X PUT http://localhost:3000/my_dashboard/widgets/welcome -d "widget[text]=my_dashboard is awesome"
+```
+
+or
+
+```
+curl -X PUT http://localhost:3000/my_dashboard/widgets/karma -d "widget[current]=100" -d "auth_token=YOUR_AUTH_TOKEN"
+```
+
+or
+
+```ruby
+HTTParty.post('http://localhost:3000/my_dashboard/widgets/karma',
+  body: { auth_token: "YOUR_AUTH_TOKEN", current: 1000 }.to_json)
+```
+
+#### Dasboards
+
+The `reload` action provided by [Shopify Dashing](http://shopify.github.io/dashing/) is currently not available.
+
+## Create a new Widget
+
+In order to create or add a custom widget to my_dashboard, simply follow the following steps:
+
+1. Run `$ rails g my_dashboard:widget my_widget`
+
+2. Edit `app/views/my_dashboard/widgets/my_widget.html`
+
+3. Edit `app/assets/javascripts/my_dashboard/widgets/my_widget.js`
+
+4. Edit `app/assets/stylesheets/my_dashboard/widgets/my_widget.scss`
+
+## Additional Resources
+
+Check out the [wiki](https://github.com/danilovaz/my_dashboard/wiki) for interesting tips such as hosting on Heroku, adding authentication or adding custom widgets.
+
+## Browser Compatibility
+
+Tested in Chrome, Safari 6+, and Firefox 15+.
+
+Does not work in Internet Explorer because it relies on [Server Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/).
+
+## Contributors
+
+* [Shopify Dashing contributors](https://github.com/Shopify/dashing/graphs/contributors)
+* [Dashing-rails contributors](https://github.com/gottfrois/dashing-rails/contributors)
+* [my_dashboard contributors](https://github.com/danilovaz/my_dashboard/contributors)
+
+
+Special thanks to [Pierre-Louis Gottfrois](https://github.com/gottfrois) for his [Dashing-rails](https://github.com/gottfrois/dashing-rails).
+
+All contributions are more than welcome; especially new widgets with supports for flexbox and responsive.
+
+Please add spec to your Pull Requests and run them using: ```$ rake```
+
+## License
+
+my_dashboard is released under the [MIT license](https://github.com/danilovaz/my_dashboard/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec
+task test:    :spec

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

@@ -0,0 +1,17 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require my_dashboard
+//= require_tree .
+//= require my_dashboard.gridster
+//= require default_widgets
+//= require widgets

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require my_dashboard
+ *= require_tree .
+ */

data/app/controllers/my_dashboard/application_controller.rb

@@ -0,0 +1,23 @@
+module MyDashboard
+  class ApplicationController < ActionController::Base
+
+    before_filter :authentication_with_devise
+
+    private
+
+    def authentication_with_devise
+      MyDashboard.config.devise_allowed_models.each do |model|
+        self.send("authenticate_#{model.to_s}!")
+      end
+    end
+
+    def check_accessibility
+      auth_token = params.delete(:auth_token)
+      if !MyDashboard.config.auth_token || auth_token == MyDashboard.config.auth_token
+        true
+      else
+        render nothing: true, status: 401 and return
+      end
+    end
+  end
+end

data/app/controllers/my_dashboard/dashboards_controller.rb

@@ -0,0 +1,31 @@
+module MyDashboard
+  class DashboardsController < ApplicationController
+
+    before_filter :check_dashboard_name, only: :show
+
+    rescue_from ActionView::MissingTemplate, with: :template_not_found
+
+    def index
+      render file: dashboard_path(MyDashboard.config.default_dashboard || MyDashboard.first_dashboard || ''), layout: MyDashboard.config.dashboard_layout_path
+    end
+
+    def show
+      render file: dashboard_path(params[:name]), layout: MyDashboard.config.dashboard_layout_path
+    end
+
+    private
+
+    def check_dashboard_name
+      raise 'bad dashboard name' unless params[:name] =~ /\A[a-zA-z0-9_\-]+\z/
+    end
+
+    def dashboard_path(name)
+      MyDashboard.config.dashboards_views_path.join(name)
+    end
+
+    def template_not_found
+      raise "Count not find template for dashboard '#{params[:name]}'. Define your dashboard in #{dashboard_path('')}"
+    end
+
+  end
+end

data/app/controllers/my_dashboard/events_controller.rb

@@ -0,0 +1,28 @@
+module MyDashboard
+  class EventsController < ApplicationController
+    include ActionController::Live
+
+    def index
+      response.headers['Content-Type']      = 'text/event-stream'
+      response.headers['X-Accel-Buffering'] = 'no'
+      response.stream.write latest_events
+
+      @redis = MyDashboard.redis
+      @redis.psubscribe("#{MyDashboard.config.redis_namespace}.*") do |on|
+        on.pmessage do |pattern, event, data|
+          response.stream.write("data: #{data}\n\n")
+        end
+      end
+    rescue IOError
+      logger.info "[MyDashboard][#{Time.now.utc.to_s}] Stream closed"
+    ensure
+      @redis.quit
+      response.stream.close
+    end
+
+    def latest_events
+      events = MyDashboard.redis.hvals("#{MyDashboard.config.redis_namespace}.latest")
+      events.map { |v| "data: #{v}\n\n" }.join
+    end
+  end
+end