chameleon 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Elliott Draper <el@ejdraper.com>
+
+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.rdoc

@@ -0,0 +1,108 @@
+= Chameleon
+
+* http://github.com/ejdraper/chameleon
+
+== DESCRIPTION:
+
+This is a Rails engine designed to make it super easy to expose data from your application as widgets for use with Geckoboard (http://geckoboard.com).
+
+This only works for Rails 3 apps.
+
+== FEATURES:
+
+This provides a generator to build widgets using a basic DSL syntax to describe the data to be exposed, and the settings for it to be exposed under, and also includes the controller/routing necessary to provide an endpoint for Geckoboard to retrieve the data to display on your dashboard.
+
+Currently it supports just the "number and optional secondary stat" widget type, with more widget types to follow shortly.
+
+== SYNOPSIS:
+
+Simply add to your Gemfile as follows:
+
+  gem 'chameleon'
+
+Then run "bundle install" and once installed, you can run:
+
+  rails g chameleon:widget NAME TYPE
+
+to generate a widget within "app/widgets". For example, if you want to generate a widget that exposes the amount of users you have in your app currently:
+
+  rails g chameleon:widget users number_and_secondary
+
+This will generate something similar to the following in "app/widgets/users_widget.rb":
+
+  widget :users do
+    key "3638c90ec12d5a59061ad7b78afcbd050e50b621"
+    type "number_and_secondary"
+    data do
+    end
+  end
+
+To implement your widget, you simply need to alter it to return the required data - for a "number_and_secondary" type of widget, it requires an array containing two values, the first being the current value, and the last being the value to compare it to (such as user count as of yesterday, for example):
+
+  widget :users do
+    key "3618c90ec02d5a57061ad7b78afcbb050e50b608"
+    type "number_and_secondary"
+    data do
+      [User.count, User.count(:conditions => "created_at < '#{1.day.ago.to_s(:db)}'")]
+    end
+  end
+
+You can then point Geckoboard at your widget, http://myapp/widgets/users?key=3618c90ec02d5a57061ad7b78afcbb050e50b608, and Geckoboard will then show the current user count, as well as the percentage difference compared to a day ago. You can optionally just return a single value too, if you don't want the secondary stat.
+
+By default the widgets are secured by the key which is autogenerated within the widget - this has to be passed in via the querystring for the widget to function, as seen above. You can change this value to anything you consider secure, and if you require a parameter other than :key to be used for this security check, you can define the parameter as such:
+
+  widget :users do
+    key "my_updated_key"
+    key_parameter :token
+    type "number_and_secondary"
+    data do
+      [User.count, User.count(:conditions => "created_at < '#{1.day.ago.to_s(:db)}'")]
+    end
+  end
+
+This will now expect the key to be passed in as the :token parameter, for example http://myapp/widgets/users?token=my_updated_key. For data that is acceptable to be publically exposed, you can exclude the key and set the widget as public as follows:
+
+  widget :users do
+    public true
+    type "number_and_secondary"
+    data do
+      [User.count, User.count(:conditions => "created_at < '#{1.day.ago.to_s(:db)}'")]
+    end
+  end
+
+This will now be accessible simply at http://myapp/widgets/users.
+
+Full documentation on the different widget types and data will follow once the other widget types are implemented, but this basic syntax should provide an easy way to expose data from your Rails 3 application to Geckoboard quickly and easily.
+
+== REQUIREMENTS:
+
+A Rails 3 application.
+
+== INSTALL:
+
+It's best to add it to the Gemfile for your Rails 3 app, but if needed you can install the gem manually:
+
+  gem install chameleon
+
+== LICENSE:
+
+Copyright 2010 Elliott Draper <el@ejdraper.com>
+
+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/app/controllers/widgets_controller.rb

@@ -0,0 +1,20 @@
+class WidgetsController < ApplicationController
+  before_filter :find_widget
+  before_filter :validate_key
+  skip_before_filter :verify_authenticity_token
+
+  def show
+    @data = @widget.data.call
+    render "#{@widget.type}.xml"
+  end
+
+  protected
+    def find_widget
+      @widget = Widget.find(params[:id].gsub(".xml", ""))
+      raise "Invalid widget!" if @widget.nil?
+    end
+
+    def validate_key
+      raise "Invalid key!" if !@widget.public && (params[@widget.key_parameter].blank? || params[@widget.key_parameter] != @widget.key)
+    end
+end

data/app/models/widget.rb

@@ -0,0 +1,47 @@
+class Widget
+  cattr_accessor :widgets
+  
+  def self.widget(name, &block) 
+    @@widgets ||= {}
+    @@widgets[name] = Widget.new(name, &block)
+  end
+
+  def self.find(name)
+    Dir.glob(File.join("app", "widgets", "*.rb")).each { |f| load File.expand_path(f) } if Rails.env == "development"
+    (@@widgets || {})[name.to_sym]
+  end
+
+  def initialize(name, &block)
+    @name = name
+    instance_eval(&block)
+  end
+
+  def name
+    @name
+  end
+
+  def key(value = nil)
+    @key = value unless value.nil?
+    @key
+  end
+
+  def key_parameter(value = nil)
+    @key_parameter = value unless value.nil?
+    @key_parameter || :key
+  end
+
+  def type(value = nil)
+    @type = value unless value.nil?
+    @type
+  end
+
+  def public(value = nil)
+    @public = value unless value.nil?
+    @public || false
+  end
+
+  def data(&block)
+    @data = block if block_given?
+    @data
+  end
+end

data/app/views/widgets/number_and_secondary.xml.erb

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <item>
+    <value><%= @data.is_a?(Array) ? @data.first : @data %></value>
+    <text></text>
+  </item>
+  <item>
+    <value><%= @data.is_a?(Array) && @data.length == 2 ? @data.last : nil %></value>
+    <text></text>
+  </item>
+</root>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails::Application.routes.draw do
+  match "widgets/:id", :to => "widgets#show"
+end

data/lib/chameleon.rb

@@ -0,0 +1,14 @@
+module Chameleon
+  class Engine < Rails::Engine
+    engine_name :chameleon
+    initializer "chameleon.initialization" do
+      Dir.glob(File.join("app", "widgets", "*.rb")).each { |f| require File.expand_path(f) }
+    end
+  end
+end
+
+Kernel.class_eval do
+  def widget(name, &block)
+    Widget.widget(name, &block)
+  end
+end

data/lib/generators/chameleon/widget_generator.rb

@@ -0,0 +1,22 @@
+require "rails/generators"
+
+module Chameleon
+  class WidgetGenerator < Rails::Generators::Base
+    desc "Generates a widget for exposing data to Geckoboard"
+    argument :name, :type => :string, :desc => "Name of the widget", :required => true
+    argument :type, :type => :string, :desc => "Type of the widget", :required => true
+
+    def create_widget
+      key = Digest::SHA1.hexdigest("#{self.name}#{self.type}#{Time.now.to_i}#{ENV["USER"]}")
+      data =<<EOF
+widget :#{self.name.underscore} do
+  key "#{key}"
+  type "#{self.type}"
+  data do
+  end
+end
+EOF
+      create_file("app/widgets/#{self.name.underscore}_widget.rb", data)
+    end
+  end
+end

data/test/chameleon_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ChameleonTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Chameleon
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/widgets/test_widget.rb

@@ -0,0 +1,7 @@
+widget :test do
+  key "c6fdeae2af2c327cac35abc2ccacd8619af56821"
+  type "number_and_secondary"
+  data do
+    [1,2]
+  end
+end

data/test/dummy/app/widgets/test_widget2.rb

@@ -0,0 +1,8 @@
+widget :test2 do
+  key "c6fdeae2af2c327cac35abc2ccacd8619af56821"
+  key_parameter :token
+  type "number_and_secondary"
+  data do
+    [1,2]
+  end
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "chameleon"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end