geckoboard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 407eb2ffdfdf941725c19f6b00912f94470d07f6
+  data.tar.gz: df0c2e6cbdaea03cc960367394aa376aa655b46c
+SHA512:
+  metadata.gz: 7cbadef33776673b86e8a45e853179567ba38393cfe7043f36d5d641692c269e31a9d972cf091b1b591052a3d932b5cdc3ce56edaebd2ac2e5d68a530d72b853
+  data.tar.gz: fb935f56c079706828e53b157d59f7bb186569623d13bf449e03c12ce2a196a80821d7399bed8c9613257e606778d925821acae8caf8e22e4111a3f1b81774e1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,91 @@
+# Geckoboard
+
+A little gem to expose data nicely to [Geckoboard](http://www.geckoboard.com/).
+
+## Install
+
+Install with Rubygems:
+
+    gem install geckoboard
+
+If you use bundler, add it to your Gemfile:
+
+    gem 'geckoboard'
+
+## Usage
+
+### List item
+
+```ruby
+Geckoboard.list_item('text', 'description')
+```
+
+### Trendline
+
+```ruby
+Geckoboard.trendline(
+  'Text',
+  10, # value
+  [1,2,4,7,10] # trendline values
+)
+```
+
+### Comparison
+
+```ruby
+Geckoboard.comparison(10, 20) # first and second value to compare
+```
+
+### Rag
+
+```ruby
+Geckoboard.rag(
+  Geckoboard.gecko_item('Red', 10),
+  Geckoboard.gecko_item('Amber', 20),
+  Geckoboard.gecko_item('Green', 30),
+)
+```
+
+### Geck-o-Meter
+
+```ruby
+Geckoboard.geck_o_meter(
+  80,
+  Geckoboard.gecko_item('Max value', 100),
+  Geckoboard.gecko_item('Min value', 0)
+)
+```
+
+### Pie
+
+```ruby
+Geckoboard.pie([
+  Geckoboard.pie_item(70, '70 percents label', 'FFFF10AA'),
+  Geckoboard.pie_item(30, '30 percents label', 'FFAA0AAA')
+])
+```
+
+### Helper Methods
+
+#### Gecko Item
+```ruby
+  other_attributes = { label: 'label', type: 0 }
+  Geckoboard.gecko_item('text', 'value', other_attributes) # other_attributes are optional
+```
+
+#### Pie Item
+```ruby
+  Geckoboard.pie_item('value', 'label', 'FFFF10') # color is optional
+```
+
+## License
+
+MIT License
+
+Copyright (C) 2014 by Nayeem Syed
+
+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,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/geckoboard.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geckoboard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geckoboard"
+  spec.version       = Geckoboard::VERSION
+  spec.authors       = ["Nayeem Syed"]
+  spec.email         = ["developerinlondon@gmail.com"]
+  spec.summary       = %q{Add update_or_create and delete_then_create to ActiveRecord models}
+  spec.homepage      = "https://github.com/developerinlondon/geckoboard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3", ">= 10.3.2"
+  spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
+  spec.add_development_dependency "pry", "~> 0.9", ">= 0.9.12.6"
+end

data/lib/geckoboard/version.rb

@@ -0,0 +1,3 @@
+class Geckoboard
+  VERSION = "0.0.1"
+end

data/lib/geckoboard.rb

@@ -0,0 +1,51 @@
+require 'geckoboard/version'
+require 'digest/md5'
+require 'json'
+
+class Geckoboard
+  def self.gecko_item(text, value, other_attributes = {})
+    { text: text, value: value }.
+      merge(other_attributes).
+      reject { |_, attribute_value| attribute_value.nil? }
+  end
+
+  def self.trendline(text, value, trendline, gecko_item_attributes = {})
+    widget item: [
+      gecko_item(text, value, gecko_item_attributes),
+      trendline
+    ]
+  end
+
+  def self.comparison(first, second)
+    widget item: [
+      gecko_item('', first),
+      gecko_item('', second)
+    ]
+  end
+
+  def self.list_item text, description, other_attributes = {}
+    widget other_attributes.merge({title: { text: text }, description: description})
+  end
+
+  def self.rag(red, amber, green)
+    widget item: [red, amber, green]
+  end
+
+  def self.pie pie_items
+    widget item: pie_items
+  end
+
+  def self.pie_item(value, label, color = nil)
+    gecko_item(nil, value, { label: label, color: color })
+  end
+
+  def self.geck_o_meter(value, max, min)
+    widget item: value, max: max, min: min
+  end
+
+  protected
+
+  def self.widget(widget)
+    widget.to_json
+  end
+end

data/spec/lib/geckoboard_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+describe Geckoboard do
+  it 'should contain VERSION' do
+    expect(Geckoboard::VERSION).not_to eq be_nil
+  end
+
+  describe '.gecko_item' do
+    context 'with all arguments' do
+      let(:text) { 'text' }
+      let(:value) { 2 }
+      let(:attributes) { { label: 0 } }
+      let(:gecko_item) { Geckoboard.gecko_item(text, value, attributes) }
+
+      it 'should have text' do
+        expect(gecko_item[:text]).to eq text
+      end
+
+      it 'should have value' do
+        expect(gecko_item[:value]).to eq value
+      end
+
+      it 'should have label' do
+        expect(gecko_item[:label]).to eq attributes[:label]
+      end
+    end
+
+    context 'with empty arguments' do
+      let(:text) { nil }
+      let(:value) { nil }
+      let(:attributes) { { label: 0 } }
+      let(:gecko_item) { Geckoboard.gecko_item(text, value, attributes) }
+
+      it 'should not have text' do
+        expect(gecko_item[:text]).to eq text
+      end
+
+      it 'should not have value' do
+        expect(gecko_item[:value]).to eq value
+      end
+
+      it 'should have label' do
+        expect(gecko_item[:label]).to eq attributes[:label]
+      end
+    end
+  end
+
+
+  describe '.trendline' do
+    context 'with arguments' do
+      let(:text) { 'text' }
+      let(:value) { 2 }
+      let(:trendline_array) { [1, 2] }
+      let(:trendline) { Geckoboard.trendline(text, value, trendline_array) }
+      let(:parsed_trendline) { JSON.parse(trendline) }
+
+      it 'should have text' do
+        expect(parsed_trendline['item'].first['text']).to eq text
+      end
+
+      it 'should have value' do
+        expect(parsed_trendline['item'].first['value']).to eq value
+      end
+
+      it 'should have trendline array' do
+        expect(parsed_trendline['item'].last).to eq trendline_array
+      end
+    end
+  end
+
+  describe '.comparison' do
+    context 'with arguments' do
+      let(:first) { 1 }
+      let(:second) { 2 }
+      let(:comparison) { Geckoboard.comparison(first, second) }
+      let(:parsed_comparison) { JSON.parse(comparison) }
+
+      it 'should have first value' do
+        expect(parsed_comparison['item'].first['value']).to eq first
+      end
+
+      it 'should have second value' do
+        expect(parsed_comparison['item'][1]['value']).to eq second
+      end
+    end
+  end
+
+  describe '.list_item' do
+    context 'with arguments' do
+      let(:text) { 'text' }
+      let(:description) { 'description' }
+      let(:list_item) { Geckoboard.list_item(text, description) }
+      let(:parsed_list_item) { JSON.parse(list_item) }
+
+      it 'should have text' do
+        expect(parsed_list_item['title']['text']).to eq text
+      end
+
+      it 'should have description' do
+        expect(parsed_list_item['description']).to eq description
+      end
+    end
+  end
+
+  describe '.rag' do
+    context 'with arguments' do
+      let(:red) { 1 }
+      let(:amber) { 2 }
+      let(:green) { 3 }
+      let(:rag) { Geckoboard.rag(red, amber, green) }
+      let(:parsed_rag) { JSON.parse(rag) }
+
+      it 'should have items' do
+        expect(parsed_rag['item']).to eq [red, amber, green]
+      end
+    end
+  end
+
+  describe '.pie' do
+    context 'with argument' do
+      let(:pie_items) { [1, 2, 3] }
+      let(:pie) { Geckoboard.pie(pie_items) }
+      let(:parsed_pie) { JSON.parse(pie) }
+
+      it 'should have pie item' do
+        expect(parsed_pie['item']).to eq pie_items
+      end
+    end
+  end
+
+  describe '.pie_item' do
+    context 'with argument' do
+      let(:value) { 10 }
+      let(:label) { 'label' }
+      let(:color) { '#ffffff' }
+      let(:pie_item) { Geckoboard.pie_item(value, label, color) }
+
+      it 'should have value' do
+        expect(pie_item[:value]).to eq value
+      end
+
+      it 'should have label' do
+        expect(pie_item[:label]).to eq label
+      end
+
+      it 'should have color' do
+        expect(pie_item[:color]).to eq color
+      end
+    end
+  end
+
+  describe '.geck_o_meter' do
+    context 'with all arguments' do
+      let(:value) { 'value' }
+      let(:max) { 2 }
+      let(:min) { 1 }
+      let(:geck_o_meter) { Geckoboard.geck_o_meter(value, max, min) }
+      let(:parsed_geck_o_meter) { JSON.parse(geck_o_meter) }
+
+      it 'should have value' do
+        expect(parsed_geck_o_meter['item']).to eq value
+      end
+
+      it 'should have max' do
+        expect(parsed_geck_o_meter['max']).to eq max
+      end
+
+      it 'should have min' do
+        expect(parsed_geck_o_meter['min']).to eq min
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'geckoboard'
+require 'pry'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: geckoboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nayeem Syed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+description: 
+email:
+- developerinlondon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- geckoboard.gemspec
+- lib/geckoboard.rb
+- lib/geckoboard/version.rb
+- spec/lib/geckoboard_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/developerinlondon/geckoboard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Add update_or_create and delete_then_create to ActiveRecord models
+test_files:
+- spec/lib/geckoboard_spec.rb
+- spec/spec_helper.rb
+has_rdoc: