gecko-ess 0.1.0

data/lib/gecko/http.rb

@@ -0,0 +1,79 @@
+require 'faraday_middleware/multi_json'
+
+module Gecko
+  class Http
+    def initialize(*args)
+      @connection = Faraday.new(*args) do |connection|
+        connection.response :multi_json, :symbolize_keys => true
+        Gecko.config.connection_builder.call(connection) if Gecko.config.connection_builder.respond_to?(:call)
+        yield connection if block_given?
+        connection.adapter Faraday.default_adapter if connection.builder.handlers.none? { |handler| handler.klass < Faraday::Adapter }
+      end
+      self
+    end
+
+    def headers
+      {
+        :accept => 'application/json',
+        :user_agent => Gecko.config.http_user_agent
+      }
+    end
+
+    def encode_body(body)
+      MultiJson.encode(body)
+    end
+
+    def post(url, body, &request_block)
+      Result.new(@connection.post(url, self.encode_body(body), self.headers, &request_block))
+    end
+
+    class Result
+      Error = Struct.new(:text, :status) do
+        def to_s
+          self.text
+        end
+      end
+
+      attr_reader :response
+      attr_accessor :response_env
+
+      def initialize(response)
+        @response = response
+      end
+
+      def on_complete(&block)
+        self.response.on_complete do |env|
+          self.response_env = env
+          block.call(self.success?, self)
+        end
+      end
+
+      def response_body
+        self.response.body
+      end
+
+      def success?
+        self.http_200? && !self.error?
+      end
+
+      def http_200?
+        self.response.status == 200
+      end
+
+      def error?
+        self.fetch(:success) != true
+      end
+
+      def error
+        Error.new(self.fetch(:error), self.response.status)
+      end
+
+      def fetch(*keys)
+        keys.inject(self.response_body) do |body_hash, key|
+          break unless body_hash
+          body_hash.fetch(key, nil)
+        end
+      end
+    end
+  end
+end

data/lib/gecko/version.rb

@@ -0,0 +1,3 @@
+module Gecko
+  VERSION = "0.1.0"
+end

data/lib/gecko/widget.rb

@@ -0,0 +1,75 @@
+module Gecko
+  class Widget
+    attr_reader :data, :keys
+
+    def initialize(*keys, &block)
+      self.keys = *keys
+      @on_update = nil
+      block.call(self) if block
+      raise ArgumentError, "1 or more widget keys are required" if self.keys.empty?
+    end
+
+    def keys=(*keys)
+      @keys = keys.flatten.compact
+    end
+
+    def on_update(&block)
+      @permanent_on_update = block
+      self
+    end
+
+    def push_url(key)
+      Gecko.config.api_push_url.gsub(/:widget_key/, key)
+    end
+
+    def update(&on_update)
+      self.push_requests do |push_result, key|
+        push_result.on_complete do |*args|
+          args << key
+          @permanent_on_update.call(*args) if @permanent_on_update.respond_to?(:call)
+          on_update.call(*args) if on_update
+        end
+      end
+    end
+
+    def push_requests(&each_result)
+      self.keys.map do |key|
+        http = Gecko::Http.new
+        push_result = http.post(self.push_url(key), self.payload)
+        each_result.call(push_result, key) if each_result
+        push_result
+      end
+    end
+
+    def config(&block)
+      block.call(self)
+      self
+    end
+
+    def config!(&block)
+      self.config(&block).update
+      self
+    end
+
+    def data_payload
+      {}
+    end
+
+    def payload
+      {
+        :api_key => Gecko.config.api_key,
+        :data => self.data_payload
+      }
+    end
+  end
+end
+
+require 'gecko/widget/number_secondary_stat'
+require 'gecko/widget/rag'
+require 'gecko/widget/rag_columns'
+require 'gecko/widget/text'
+
+require 'gecko/graph/pie'
+require 'gecko/graph/geckometer'
+require 'gecko/graph/funnel'
+require 'gecko/graph/line'

data/lib/gecko/widget/number_secondary_stat.rb

@@ -0,0 +1,23 @@
+module Gecko
+  class Widget
+    class NumberSecondaryStat < Widget
+      attr_accessor :primary_text, :primary_value, :primary_prefix, :secondary_text, :secondary_value, :secondary_prefix, :absolute, :type
+
+      def data_payload
+        {:item =>
+          [{
+           :text => self.primary_text,
+           :value => self.primary_value,
+           :prefix => self.primary_prefix
+         }, {
+           :text => self.secondary_text,
+           :value => self.secondary_value,
+           :prefix => self.secondary_prefix
+         }],
+         :absolute => self.absolute,
+         :type => self.type
+        }
+      end
+    end
+  end
+end

data/lib/gecko/widget/rag.rb

@@ -0,0 +1,21 @@
+module Gecko
+  class Widget
+    class Rag < Widget
+      attr_accessor :green_text, :green_value, :amber_text, :amber_value, :red_text, :red_value
+
+      def data_payload
+        {:item =>
+          [{
+          :text => self.red_text,
+          :value => self.red_value
+         }, {
+          :text => self.amber_text,
+          :value => self.amber_value
+         }, {
+          :text => self.green_text,
+          :value => self.green_value
+         }]}
+      end
+    end
+  end
+end

data/lib/gecko/widget/rag_columns.rb

@@ -0,0 +1,21 @@
+module Gecko
+  class Widget
+    class RagColumns < Widget
+      attr_accessor :green_text, :green_value, :amber_text, :amber_value, :red_text, :red_value
+
+      def data_payload
+        {:item =>
+          [{
+          :text => self.red_text,
+          :value => self.red_value
+         }, {
+          :text => self.amber_text,
+          :value => self.amber_value
+         }, {
+          :text => self.green_text,
+          :value => self.green_value
+         }]}
+      end
+    end
+  end
+end

data/lib/gecko/widget/text.rb

@@ -0,0 +1,67 @@
+module Gecko
+  class Widget
+    class Text < Widget
+      include Enumerable
+
+      class Item
+        TYPES = {
+          :normal => 0,
+          :alert => 1,
+          :info => 2
+        }
+        attr_accessor :text
+        attr_reader :type
+
+        def initialize(text = nil, type = :normal)
+          self.text = text
+          self.type = type
+        end
+
+        def type=(type)
+          @type = if type.kind_of?(Numeric)
+            TYPES.values.include?(type) ? type : nil
+          else
+            TYPES.fetch(type, nil)
+          end
+          @type or raise ArgumentError, "#{type} is not a valid text type"
+        end
+      end
+
+      def initialize(*args, &block)
+        super
+        @items = []
+      end
+
+      def reset
+        @items.clear
+        self
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def add(*args)
+        @items.push(Item.new(*args))
+      end
+
+      def [](index)
+        @items[index]
+      end
+
+      def []=(index, *args)
+        @items[index] = Item.new(*args)
+      end
+
+      def delete(index)
+        @items.delete_at(index)
+      end
+
+      def data_payload
+        {
+          :item => self.map{ |item| {:text => item.text, :type => item.type} }
+        }
+      end
+    end
+  end
+end

data/spec/gecko/funnel_spec.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+describe Gecko::Widget::Funnel do
+  it_behaves_like "a Gecko::Widget"
+
+  describe '#payload' do
+    before(:each) do
+      @widget = described_class.new('widget_key')
+    end
+
+    it 'should be empty by default' do
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :type => :standard,
+          :percentage => :show,
+          :item => []
+        }
+      )
+    end
+
+    it 'should be correct hash when values assigned' do
+      @widget.hide_percentage
+      @widget.reverse
+      @widget.add(100, 'benjamin')
+      @widget.add(1, 'washington')
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :type => :reverse,
+          :percentage => :hide,
+          :item => [
+            {:value => 100, :label => 'benjamin'},
+            {:value => 1, :label => 'washington'}
+          ]
+        }
+      )
+    end
+  end
+end

data/spec/gecko/geckometer_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe Gecko::Widget::Geckometer do
+  it_behaves_like "a Gecko::Widget"
+
+  describe '#payload' do
+    before(:each) do
+      @widget = described_class.new('widget_key')
+    end
+
+    it 'should be empty by default' do
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :item => nil,
+          :min => {:value => nil, :text => nil},
+          :max => {:value => nil, :text => nil}
+        }
+      )
+    end
+
+    it 'should be correct hash when values assigned' do
+      @widget.min_value = 0
+      @widget.max_value = 100
+      @widget.min_text = 'min'
+      @widget.max_text = 'max'
+      @widget.value = 50
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :item => 50,
+          :min => {:value => 0, :text => 'min'},
+          :max => {:value => 100, :text => 'max'}
+        }
+      )
+    end
+  end
+end

data/spec/gecko/line_spec.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+describe Gecko::Widget::Line do
+  it_behaves_like "a Gecko::Widget"
+
+  describe '#payload' do
+    before(:each) do
+      @widget = described_class.new('widget_key')
+    end
+
+    it 'should be empty by default' do
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :item => [],
+          :settings => {
+            :axisx => [],
+            :axisy => [],
+            :colour => nil
+          }
+        }
+      )
+    end
+
+    it 'should be correct hash when values assigned' do
+      @widget.x_axis = [1, 2, 3]
+      @widget.y_axis = %w(a b c)
+      @widget.add(5,6,7)
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {
+          :item => [5, 6, 7],
+          :settings => {
+            :axisx => [1, 2, 3],
+            :axisy => ['a', 'b', 'c'],
+            :colour => nil
+          }
+        }
+      )
+    end
+  end
+end

data/spec/gecko/number_and_secondary_stat_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+describe Gecko::Widget::NumberSecondaryStat do
+  it_behaves_like "a Gecko::Widget"
+
+  describe '#payload' do
+    before(:each) do
+      @widget = described_class.new('widget_key')
+    end
+
+    it 'should be empty by default' do
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {:item => [{:value => nil, :text => nil, :prefix => nil}, {:value => nil, :text => nil, :prefix => nil}], :absolute => nil, :type => nil}
+      )
+    end
+
+    it 'should be correct hash when values assigned' do
+      @widget.primary_text = 'text A'
+      @widget.primary_value = 1
+      @widget.primary_prefix = "$"
+      @widget.secondary_text = 'text B'
+      @widget.secondary_value = 2
+      @widget.absolute = "true"
+      @widget.type = "reverse"
+      expect(@widget.payload).to be_a_valid_payload(
+        TEST_API_KEY,
+        {:item => [{:value => 1, :text => 'text A', :prefix => "$"}, {:value => 2, :text => 'text B', :prefix => nil}], :absolute => "true", :type => "reverse"}
+      )
+    end
+  end
+end