panic_board_data 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a96cc0a4c0c9defb433c8e52cd435b416725cf75
-  data.tar.gz: 3892a19e078f15052b1a4ef43e5637912704d46c
+  metadata.gz: 187785c2fdbc4bce731a3d75e50e507419e21860
+  data.tar.gz: 22ad3a8fad2d2b45aec4849f22dae2397590ccca
 SHA512:
-  metadata.gz: 960baaac1f93813e6aa934d1d37d608b2ef9da670f8e5912436eaa8d3758dd40fd0a2f748f67a3fbcd8da5cf94184ec04c937ab4dff822cd479e6381825af386
-  data.tar.gz: 4c1024b24e53409d1aafdb8972a5515e2ecda9837bcb8f3bc14e07085b1fb884811a309810404e2c436c5ca58bd18bb23c8c291aa3d36afea08ef12f74238de3
+  metadata.gz: 3d41bc571afe5ca3f7e90c3a0890afda31ead122a7459662039c1455614b56151ee81d8fd5359882c8179b07f209ce0e29c4db13c90435d8f421f5633eed3858
+  data.tar.gz: 88617ad930d4fd4e38e4ca6a8f7d19cba21cbe220eb8d56d871dab13ffbdcaa0430709cc1d70664d9a1f84e0ba4dd139a03c9158fd8272d48b75217f97d5a159

data/README.md

@@ -1,29 +1,115 @@
 # PanicBoardData
 
-TODO: Write a gem description
+This gem exists to make it eaiser to display data on your Panic Status Board.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+The Panic Status Board loads itself with data it pulls from the internet.
 
-    gem 'panic_board_data'
+Therefore, if you want to show very custom data in your Status Board, you'll want to create a website that serves that custom data. 
 
-And then execute:
+With this gem, the easiest way to do this is to create a simple Sinatra application.  Create a simple site that returns the output from this gem, and your custom Status Board will be good-to-go.
 
-    $ bundle
+#### Tables
 
-Or install it yourself as:
+![Table](https://raw.github.com/darrencauthon/panic_board_data/master/samples/tables.jpg "Table")
 
-    $ gem install panic_board_data
+````ruby
+  # Sinatra example
+  get '/my_table' do
 
-## Usage
+    # sample images for our board
+    images = [build_image('http://tinyurl.com/mnvjm96'),
+              build_image('http://tinyurl.com/kt3hp7v')]
+
+    # special note: An array of values (like "images") will
+    # be flattened into a single value in the cell...
+    # so no need to concatenate things like rows of images.
+    data = [['Project A', "5 days", images,    progress_bar_to(3)], 
+            ['Project B', "2 days", images[0], progress_bar_to(7)],
+            ['Project C', "9 days", images[1], progress_bar_to(1)],
+            ['Project D', "1 day",  nil,       progress_bar_to(8)]]
+
+    table = PanicBoardData::Table.new data
+
+    # optionally set the column widths
+    table.widths = [nil, 125, 100]
+
+    # return HTML necessary for import into Status Board
+    table.to_html
+  
+  end
+````
+
+#### Graphs
+
+![Graph](https://raw.github.com/darrencauthon/panic_board_data/master/samples/graphs.jpg "Graph")
+
+````ruby
+  #another Sinatra example
+  get '/graph_example' do
+
+    # one set of data
+    hotdogs = PanicBoardData::DataSequence.new('Hotdogs')
+    hotdogs.data['Sunday']    = 4
+    hotdogs.data['Monday']    = 3
+    hotdogs.data['Tuesday']   = 4
+    hotdogs.data['Wednesday'] = 8
+    hotdogs.data['Thursday']  = 10
+    hotdogs.data['Friday']    = 11
+    hotdogs.data['Saturday']  = 2
+
+    # another set of data
+    burgers = PanicBoardData::DataSequence.new('Burgers')
+    burgers.data['Sunday']    = 1
+    burgers.data['Monday']    = 7
+    burgers.data['Tuesday']   = 5
+    burgers.data['Wednesday'] = 6
+    burgers.data['Thursday']  = 10
+    burgers.data['Friday']    = 15
+    burgers.data['Saturday']  = 5
+
+    # build the graph
+    graph = PanicBoardData::Graph.new
+    graph.title = "Purchases"
+
+    # this can be :bar or :line
+    graph.type = :bar
+
+    # add the sets of data you want to display in the graph
+    graph.data_sequences << hotdogs
+    graph.data_sequences << burgers
+
+    # return JSON necessary for import into Status Board
+    graph.to_json
+
+  end
+````
+
+#### Single Values
+
+These can be really big...
+
+![SingleValue](https://raw.github.com/darrencauthon/panic_board_data/master/samples/single_value_1.jpg "Single Value")
+
+````ruby
+  # yet another Sinatra example
+  get '/single_value' do
+    heading = 'How many people live in the United States?'
+    value = PanicBoardData::SingleValue.new heading, '317,044,240'
+
+    # return HTML necessary for import into Status Board
+    value.to_html
+  end
+````
 
-TODO: Write usage instructions here
+... or very small.
 
-## Contributing
+![SingleValue](https://raw.github.com/darrencauthon/panic_board_data/master/samples/single_value_2.jpg "Single Value")
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+````ruby
+  # yet another Sinatra example
+  get '/single_value' do
+    PanicBoardData::SingleValue.new('Logins Today', 1).to_html
+  end
+````

data/lib/panic_board_data/version.rb

@@ -1,3 +1,3 @@
 module PanicBoardData
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/panic_board_data.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = PanicBoardData::VERSION
   spec.authors       = ["Darren Cauthon"]
   spec.email         = ["darren@cauthon.com"]
-  spec.description   = %q{Export data for Panic Board}
-  spec.summary       = %q{Export data for Panic Board}
-  spec.homepage      = ""
+  spec.description   = %q{Export data for Panic Status Board}
+  spec.summary       = %q{Export data for Panic Status Board}
+  spec.homepage      = "http://www.github.com/darrencauthon/panic_board_data"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panic_board_data
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Darren Cauthon
@@ -94,13 +94,14 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Export data for Panic Board
+description: Export data for Panic Status Board
 email:
 - darren@cauthon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -115,12 +116,16 @@ files:
 - lib/panic_board_data/table.rb
 - lib/panic_board_data/version.rb
 - panic_board_data.gemspec
+- samples/graphs.jpg
+- samples/single_value_1.jpg
+- samples/single_value_2.jpg
+- samples/tables.jpg
 - spec/panic_board_data/graph_spec.rb
 - spec/panic_board_data/kernel_spec.rb
 - spec/panic_board_data/single_value_spec.rb
 - spec/panic_board_data/table_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: http://www.github.com/darrencauthon/panic_board_data
 licenses:
 - MIT
 metadata: {}
@@ -143,7 +148,7 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Export data for Panic Board
+summary: Export data for Panic Status Board
 test_files:
 - spec/panic_board_data/graph_spec.rb
 - spec/panic_board_data/kernel_spec.rb