chameleon 0.1.0 → 0.2.0

data/README.rdoc

@@ -12,7 +12,7 @@ This only works for Rails 3 apps.
 
 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.
+Currently it supports the "number and optional secondary stat", "line" and "pie" widget types.
 
 == SYNOPSIS:
 
@@ -37,42 +37,22 @@ This will generate something similar to the following in "app/widgets/users_widg
     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):
+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 a hash containing a :value, and optionally, a :previous 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)}'")]
+      {
+        :value => User.count,
+        :previous => 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.
+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.
 
-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.
+More documentation on the settings available for the widgets, as well as the different types of widgets, is available on the wiki (http://github.com/ejdraper/chameleon/wiki).
 
 == REQUIREMENTS:
 

data/app/controllers/widgets_controller.rb

@@ -4,7 +4,7 @@ class WidgetsController < ApplicationController
   skip_before_filter :verify_authenticity_token
 
   def show
-    @data = @widget.data.call
+    @data = @widget.data.call(@auth)
     render "#{@widget.type}.xml"
   end
 
@@ -15,6 +15,12 @@ class WidgetsController < ApplicationController
     end
 
     def validate_key
-      raise "Invalid key!" if !@widget.public && (params[@widget.key_parameter].blank? || params[@widget.key_parameter] != @widget.key)
+      return if @widget.public
+      if @widget.auth
+        @auth = @widget.auth.call(self, request, params)
+        raise "Invalid authentication!" if !@auth
+      else
+        raise "Invalid key!" if params[@widget.key_parameter] != @widget.key
+      end
     end
 end

data/app/models/widget.rb

@@ -30,6 +30,11 @@ class Widget
     @key_parameter || :key
   end
 
+  def auth(&block)
+    @auth = block if block_given?
+    @auth
+  end
+
   def type(value = nil)
     @type = value unless value.nil?
     @type

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

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <% @data[:items].each do |item| %>
+    <item><%= item %></item>
+  <% end %>
+  <settings>
+    <% @data[:x_axis].each do |x| %>
+      <axisx><%= x %></axisx>
+    <% end %>
+    <% @data[:y_axis].each do |y| %>
+      <axisy><%= y %></axisy>
+    <% end %>
+    <colour><%= @data[:colour] || "ff9900" %></colour>
+  </settings>
+</root>

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

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

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

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <% @data.each do |item| %>
+    <item>
+      <value><%= item[:value] %></value>
+      <label><%= item[:label] %></label>
+      <colour><%= item[:colour] %></colour>
+    </item>
+  <% end %>
+</root>

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Elliott Draper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 +00:00
+date: 2011-01-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,51 +45,10 @@ files:
 - README.rdoc
 - app/controllers/widgets_controller.rb
 - app/models/widget.rb
+- app/views/widgets/line.xml.erb
 - app/views/widgets/number_and_secondary.xml.erb
+- app/views/widgets/pie.xml.erb
 - config/routes.rb
-- test/chameleon_test.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/widgets/test_widget.rb
-- test/dummy/app/widgets/test_widget2.rb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/production.log
-- test/dummy/log/server.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/javascripts/application.js
-- test/dummy/public/javascripts/controls.js
-- test/dummy/public/javascripts/dragdrop.js
-- test/dummy/public/javascripts/effects.js
-- test/dummy/public/javascripts/prototype.js
-- test/dummy/public/javascripts/rails.js
-- test/dummy/Rakefile
-- test/dummy/script/rails
-- test/functional/widgets_test.rb
-- test/integration/navigation_test.rb
-- test/support/integration_case.rb
-- test/test_helper.rb
-- test/unit/widget_test.rb
 - lib/chameleon.rb
 - lib/generators/chameleon/widget_generator.rb
 has_rdoc: true
@@ -107,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2506435241547963230
+      hash: 2842150292622897971
       segments: 
       - 0
       version: "0"
@@ -116,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2506435241547963230
+      hash: 2842150292622897971
       segments: 
       - 0
       version: "0"

data/test/chameleon_test.rb

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

data/test/dummy/Rakefile

@@ -1,7 +0,0 @@
-# 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

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

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

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

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

@@ -1,14 +0,0 @@
-<!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

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

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

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

data/test/dummy/config.ru

@@ -1,4 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,22 +0,0 @@
-# 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

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

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

@@ -1,26 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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