databox 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35f81369b4cdc7ba2b9abff91729aecdec96818
-  data.tar.gz: 6da7f16169fc7f16deaefc6796b192bbfacbe789
+  metadata.gz: ebc311f8414ee0dd1a0cf856a578bcf289c2d58a
+  data.tar.gz: a8ec62fdd9426a618aa08d12e539f7256842ee9a
 SHA512:
-  metadata.gz: 546f51c0c865a0caaf9af5e016d5ab952fdd6a1a52c945f1ddea16d431b68c15497e6d6cd662c9df127f5f6a42a068960411ab2475bc2e38cc4577301af60ed6
-  data.tar.gz: a2c4927156b9da8155de87d9d4e03fbca9042e9640174a02f06ad4283173e2d0ebc238c7a77a9479d90aa52d1fe3c095068538942ee2373adbd8a06ddcd7718e
+  metadata.gz: 6c34368d669eb3d88fad6f36feab65492dd3e31841a31b6a2a8edfdde0d44e9194b2d8383c49fc82cc9a8420bd3c0d96303fdd320d289af633e00bdaea270c0d
+  data.tar.gz: 6171690938429e91d87b0ebd6dc2872f13e28bb7cda917d6f7debedc0e32df271f7235b21933e0ddfdbf9c16760310e8f3b4bc8c07dbef4bd5a664ce4d832d00

data/.gitignore

@@ -1,4 +1,5 @@
 *.sh
+!*test_*sh
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -1,6 +1,6 @@
 # Databox
 
-[![Gem Version][fury-badge]][fury] [![Build Status][travis-badge]][travis] [![Coverage Status](https://coveralls.io/repos/otobrglez/databox/badge.png)](https://coveralls.io/r/otobrglez/databox)
+[![Gem Version][fury-badge]][fury] [![Build Status][travis-badge]][travis] [![Coverage Status](https://coveralls.io/repos/otobrglez/databox/badge.png?branch=master)](https://coveralls.io/r/otobrglez/databox?branch=master)
 
 Ruby Gem for [Databox](http://databox.com/) - Mobile Executive Dashboard.
 
@@ -22,26 +22,96 @@ Or install it yourself as:
 
 ## Usage
 
-You can use Databox::Client directly to insert raw KPIs. This is done by invoking Databox::Client and pushing Hash or Array of Hashes to it.
+Before using Databox gem you have to initialize it with key and token. There are 3 ways how you can do initialization.
 
+- Within simple initializer
+
+  ```ruby
+  Databox.configure do |c|
+    c.token   = "YOUR_TOKEN"
+    c.key     = "YOUR_KEY"
+  end
+  ```
+
+- By setting system ```ENV``` variables ```DATABOX_KEY``` and ```DATABOX_TOKEN```
+
+- If your are using custom integration with different key please use ```id```.
+
+  ```ruby
+  chart = Databox::LineChart.new "my_line", id: "OTHER_KEY"
+  ```
+
+Databox gem support following widgets
+
+| Widget          | Implemented   | Example                        | Databox Documentation
+| --------------- | :-----------: | ------------------------------ | ----------------------
+| Big Number      | Yes           | [Example](#big-number)         | [Basic Widgets / Big Number](https://developers.databox.com/push/v1/widgets/main/#big-number)
+| Compare         | Yes           | [Example](#compare)            | [Basic Widgets / Compare](https://developers.databox.com/push/v1/widgets/main/#compare)
+| Internal        | Yes           | [Example](#interval)    | [Basic Widgets / Interval Values](https://developers.databox.com/push/v1/widgets/main/#interval-values)
+| Line Chart      | Yes           | [Example](#line-chart)         | [Basic Widgets / Line Chart](https://developers.databox.com/push/v1/widgets/main/#line-chart-and-bar-chart)
+| Bar Chart       | Yes           | [Example](#bar-chart)          | [Basic Widgets / Bar Chart](https://developers.databox.com/push/v1/widgets/main/#line-chart-and-bar-chart)
+| Pipeline        | Yes           | [Example](#pipeline)           | [Pipeline](https://developers.databox.com/push/v1/widgets/pipeline/)
+| Funnel          | Yes           | [Example](#funnel)             | [Funnel](https://developers.databox.com/push/v1/widgets/funnel/)
+| Pie             | Yes           | [Example](#pie)                | [Pie](https://developers.databox.com/push/v1/widgets/pie/)
+| Progress        | Yes           | [Example](#progress)           | [Progress](https://developers.databox.com/push/v1/widgets/progress/)
+| Table           | No            |                                |
+| Messages        | Yes           | [Example](#messages)           | [Messages](https://developers.databox.com/push/v1/widgets/messages/)
+
+
+### Big Number
 ```ruby
-client = Databox.client
+number = Databox::BigNumber.new "just_number"
+number.set 5000
+number.save
 
-client.push([{
-  key: "name",
-  date: "2014-01-22T12:00:00",
-  value: 1
-}])
+# You can set date on initialize
+number_dated = Databox::BigNumber.new "just_number", date: "2014-02-03"
+# Or when setting number
+number_dated.set 10_000, "2014-02-03"
+number_dated.save
 
-puts client.logs
 ```
 
-Databox gem support following widgets
+### Line Chart
+```ruby
+chart = Databox::LineChart.new "my_line"
+chart.add 40,   "2014-01-29"
+chart.add 100,  "2014-02-01"
+chart.add 500,  "2014-02-02"
+chart.add 20,   "2014-02-03"
+chart.save
+
+```
+
+### Bar Chart
+```ruby
+chart = Databox::BarChart.new "my_bar"
+chart.add 40,   "2014-01-29"
+chart.add 100,  "2014-02-01"
+chart.add 500,  "2014-02-02"
+chart.add 20,   "2014-02-03"
+chart.save
+```
+
+### Compare
+```ruby
+compare = Databox::BarChart.new "my_compare"
+compare.add 40,   "2014-01-29"
+compare.add 100,  "2014-02-01"
+compare.add 500,  "2014-02-02"
+compare.add 20,   "2014-02-03"
+compare.save
+```
 
-- [Pipeline](https://developers.databox.com/push/v1/widgets/pipeline)
-- [Funnel](https://developers.databox.com/push/v1/widgets/funnel)
-- [Pie](https://developers.databox.com/push/v1/widgets/pie)
-- [Messages](https://developers.databox.com/push/v1/widgets/messages)
+### Interval
+```ruby
+interval = Databox::BarChart.new "my_interval"
+interval.add 40,   "2014-01-29"
+interval.add 100,  "2014-02-01"
+interval.add 500,  "2014-02-02"
+interval.add 20,   "2014-02-03"
+interval.save
+```
 
 ### Pipeline
 ```ruby
@@ -73,6 +143,13 @@ pie.add "E", 7_423
 pie.save
 ```
 
+### Progress
+```ruby
+progress = Databox::Progress.new "my_progress"
+progress.set "33% done", 100, 33
+pie.save
+```
+
 ### Messages
 
 ```ruby
@@ -82,6 +159,22 @@ messages.add "Second message"
 messages.save
 ```
 
+## Using client directly
+
+You can also use Databox::Client directly to insert raw KPIs. This is done by invoking Databox::Client and pushing Hash or Array of Hashes to it.
+
+```ruby
+client = Databox.client
+
+client.push([{
+  key: "name",
+  date: "2014-01-22T12:00:00",
+  value: 1
+}])
+
+puts client.logs
+```
+
 ## Versions
 
 [Databox](https://github.com/otobrglez/databox) is tested on following Ruby versions

data/lib/databox.rb

@@ -6,9 +6,16 @@ module Databox
   autoload :Configuration,  "databox/configuration"
   autoload :Integration,    "databox/integration"
 
+  autoload :BigNumber,      "databox/integration"
+  autoload :LineChart,      "databox/integration"
+  autoload :BarChart,       "databox/integration"
+  autoload :Compare,        "databox/integration"
+  autoload :Interval,       "databox/integration"
+
   autoload :Pipeline,       "databox/integration"
   autoload :Funnel,         "databox/integration"
   autoload :Pie,            "databox/integration"
+  autoload :Progress,       "databox/integration"
   autoload :Messages,       "databox/integration"
 
 

data/lib/databox/integration.rb

@@ -1,6 +1,6 @@
 class Databox::Integration < Databox::Client
 
-  attr_accessor :name, :list, :date
+  attr_accessor :name, :list, :set_item, :date
 
   def initialize name, options={date: nil, id: nil}
     super()
@@ -10,11 +10,13 @@ class Databox::Integration < Databox::Client
     @token  = options[:id]    unless options[:id].nil?
 
     @list = []
+    @set_item = nil
   end
 
   def save
     if push(to_data).success?
       @list = []
+      @set_item = nil
       true
     else
       false
@@ -53,8 +55,71 @@ class Databox::Pipeline < Databox::Integration
 
 end
 
+
+
+
 #TODO: Add support for icons
 #TODO: Add support for changes
 class Databox::Funnel < Databox::Pipeline; end;
 class Databox::Pie < Databox:: Pipeline; end;
 
+
+
+class Databox::Progress < Databox::Integration
+
+  def add *args
+    raise "Progress does not support add!"
+  end
+
+  def set message, max, value
+    @set_item = [message, max, value]
+  end
+
+  def to_data
+    [
+      { key: "#{name}@label",     value: @set_item.first },
+      { key: "#{name}@max_value", value: @set_item[1] },
+      { key: "#{name}",           value: @set_item.last },
+    ]
+  end
+
+end
+
+
+
+class Databox::BigNumber < Databox::Integration
+  def set number, date=nil
+    date ||= @date
+    @set_item = [number, date]
+  end
+
+  def to_data
+    out = {key: name, value: @set_item.first}
+    out.merge!({date: @set_item[1]}) unless @set_item[1].nil?
+    out
+  end
+end
+
+
+
+class Databox::LineChart < Databox::Integration
+
+  def add value, date=nil
+    date ||= @date
+    @list.push [value, date]
+  end
+
+  def to_data
+    @list.map do |i|
+      out = {key: name, value: i.first}
+      out.merge!({date: i[1]}) unless i[1].nil?
+      out
+    end
+  end
+end
+
+class Databox::BarChart < Databox::LineChart; end;
+
+class Databox::Compare < Databox::LineChart; end;
+
+class Databox::Interval < Databox::LineChart; end;

data/lib/databox/version.rb

@@ -1,3 +1,3 @@
 module Databox
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/databox/bar_chart_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Databox::BarChart do
+
+  let(:chart){ Databox::BarChart.new "my_bar" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "bar_chart_simple" }
+    }
+
+    before do
+      chart.add 2000, "2014-01-29"
+      chart.add 1600, "2014-02-01"
+      chart.add 999,  "2014-02-03"
+    end
+
+    it { expect(chart.save).to be_true }
+
+  end
+
+end

data/spec/databox/big_number_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Databox::BigNumber do
+
+  let(:number){ Databox::BigNumber.new "just_number" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "big_number_simple" }
+    }
+
+    before { number.set 5000, "2014-02-03T00:00:00" }
+    it { expect(number.to_data[:date]).not_to be_nil }
+    it { expect(number.save).to be_true }
+  end
+
+  context "without date" do
+    before { number.set 5000 }
+    it { expect(number.to_data[:date]).to be_nil }
+  end
+
+  context "with constructor" do
+    let(:number_2){ Databox::BigNumber.new "just_number", date: "2014-01-26T00:00:00" }
+    before{ number_2.set 60000 }
+    it { expect(number_2.to_data[:date]).not_to be_nil }
+  end
+
+end

data/spec/databox/compare_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Databox::Compare do
+
+  let(:compare){ Databox::Compare.new "my_compare" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "compare_simple" }
+    }
+
+    before do
+      compare.add 2000, "2014-01-25"
+      compare.add 1600, "2014-01-26"
+    end
+
+    it { expect(compare.save).to be_true }
+
+  end
+
+end

data/spec/databox/interval_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Databox::Interval do
+
+  let(:interval){ Databox::Interval.new "my_interval" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "interval_simple" }
+    }
+
+    before do
+      interval.add 2000, "2014-01-25"
+      interval.add 1600, "2014-01-26"
+      interval.add 2200, "2014-01-27"
+    end
+
+    it { expect(interval.save).to be_true }
+
+  end
+
+end

data/spec/databox/line_chart_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Databox::LineChart do
+
+  let(:chart){ Databox::LineChart.new "my_line" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "line_chart_simple" }
+    }
+
+    before do
+      chart.add 2000, "2014-01-29"
+      chart.add 1600, "2014-02-01"
+      chart.add 999,  "2014-02-03"
+    end
+
+    it { expect(chart.save).to be_true }
+
+  end
+
+end

data/spec/databox/pie_spec.rb

@@ -2,13 +2,6 @@ require "spec_helper"
 
 describe Databox::Pie do
 
-  before do
-    Databox.configure do |c|
-      c.token   = "218oxlmk3ikkogo0"
-      c.key = "3s70rekrhcmcgkccssckc448kgw04ssk"
-    end
-  end
-
   let(:pie){ Databox::Pie.new "my_pie" }
 
   context "simple" do

data/spec/databox/pipeline_spec.rb

@@ -2,13 +2,6 @@ require "spec_helper"
 
 describe Databox::Pipeline do
 
-  before do
-    Databox.configure do |c|
-      c.token   = "218oxlmk3ikkogo0"
-      c.key = "3s70rekrhcmcgkccssckc448kgw04ssk"
-    end
-  end
-
   let(:pipeline){ Databox::Pipeline.new "pipe_visits" }
 
   context "simple" do

data/spec/databox/progress_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Databox::Progress do
+
+  let(:progress){ Databox::Progress.new "my_progress" }
+
+  context "simple" do
+    before {
+      stub_request(:post, /push/)
+      .to_return { request_from "progress_simple" }
+    }
+
+    before do
+      progress.set "33% done", 100, 33
+    end
+
+    it { expect(progress.save).to be_true }
+  end
+
+end

data/spec/requests/bar_chart_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 16:38:19 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=kir9md6qrahslhdk382jnce183; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 3"}}

data/spec/requests/big_number_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 15:40:07 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=fe0da7292u1ml3o45ncd1qfki2; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 1"}}

data/spec/requests/compare_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 17:11:01 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=oig14572o7e69prfurj46ma8f5; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 2"}}

data/spec/requests/interval_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 17:13:25 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=qliamr23ikod7pnj71o5dgsbs7; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 3"}}

data/spec/requests/line_chart_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 16:35:58 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=e5eismum62no56aj0t2n6qnhd1; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 3"}}

data/spec/requests/progress_simple.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Mon, 03 Feb 2014 12:45:22 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+X-Powered-By: PHP/5.4.23
+Set-Cookie: zep_uid=ne5mu4nrs89cppe1cjco8u03r1; path=/
+Expires: Thu, 19 Nov 1981 08:52:00 GMT
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+
+{"response":{"type":"success","message":"Items stored: 3"}}

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require "bundler/setup"
 
-require 'coveralls'
-Coveralls.wear!
+if ENV["TRAVIS"]=="true"
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 if ENV['COVERAGE']
   require 'simplecov'

data/test_rvms.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Define different RVMs
+declare -a RVMS=(\
+  'ruby-1.9.3-p484@databox' \
+  'ruby-2.0.0-p353@databox' \
+  # Add others here
+)
+
+# Loop over RSMs and exec RSpec
+for r in "${RVMS[@]}"; do
+  set -o verbose
+  echo "Testing $r"
+  rvm $r exec bundle install --quiet
+  rvm $r exec bundle exec rspec --fail-fast --format=progress
+done

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: databox
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Oto Brglez
@@ -202,22 +202,35 @@ files:
 - lib/databox/configuration.rb
 - lib/databox/integration.rb
 - lib/databox/version.rb
+- spec/databox/bar_chart_spec.rb
+- spec/databox/big_number_spec.rb
 - spec/databox/client_spec.rb
+- spec/databox/compare_spec.rb
 - spec/databox/funnel_spec.rb
 - spec/databox/integration_spec.rb
+- spec/databox/interval_spec.rb
+- spec/databox/line_chart_spec.rb
 - spec/databox/messages_spec.rb
 - spec/databox/pie_spec.rb
 - spec/databox/pipeline_spec.rb
+- spec/databox/progress_spec.rb
 - spec/databox_spec.rb
+- spec/requests/bar_chart_simple.txt
+- spec/requests/big_number_simple.txt
+- spec/requests/compare_simple.txt
 - spec/requests/funnel_simple.txt
+- spec/requests/interval_simple.txt
 - spec/requests/invalid_push.txt
+- spec/requests/line_chart_simple.txt
 - spec/requests/logs.txt
 - spec/requests/multiple_message.txt
 - spec/requests/pie_simple.txt
 - spec/requests/pipeline_simple.txt
+- spec/requests/progress_simple.txt
 - spec/requests/simple_message.txt
 - spec/requests/simple_push.txt
 - spec/spec_helper.rb
+- test_rvms.sh
 homepage: https://github.com/otobrglez/databox
 licenses:
 - MIT
@@ -243,19 +256,31 @@ signing_key:
 specification_version: 4
 summary: API wrapper for Databox
 test_files:
+- spec/databox/bar_chart_spec.rb
+- spec/databox/big_number_spec.rb
 - spec/databox/client_spec.rb
+- spec/databox/compare_spec.rb
 - spec/databox/funnel_spec.rb
 - spec/databox/integration_spec.rb
+- spec/databox/interval_spec.rb
+- spec/databox/line_chart_spec.rb
 - spec/databox/messages_spec.rb
 - spec/databox/pie_spec.rb
 - spec/databox/pipeline_spec.rb
+- spec/databox/progress_spec.rb
 - spec/databox_spec.rb
+- spec/requests/bar_chart_simple.txt
+- spec/requests/big_number_simple.txt
+- spec/requests/compare_simple.txt
 - spec/requests/funnel_simple.txt
+- spec/requests/interval_simple.txt
 - spec/requests/invalid_push.txt
+- spec/requests/line_chart_simple.txt
 - spec/requests/logs.txt
 - spec/requests/multiple_message.txt
 - spec/requests/pie_simple.txt
 - spec/requests/pipeline_simple.txt
+- spec/requests/progress_simple.txt
 - spec/requests/simple_message.txt
 - spec/requests/simple_push.txt
 - spec/spec_helper.rb