dashing_api 0.0.1

data/README.md

@@ -0,0 +1,108 @@
+# Dashing API
+
+## Test it locally
+
+Build a gem:
+```sh
+rake build
+```
+
+Install:
+```sh
+rake install
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  ```sh
+  gem 'dashing_api'
+  ```
+
+And then execute:
+
+  ```sh
+  bundle
+  ```
+
+Or install it yourself as:
+
+  ```sh
+  gem install dashing_api
+  ```
+
+## API endpoints
+
+List the existing widgets:
+```sh
+curl http://$DASHING_HOST/widgets/
+```
+
+List the existing dashboards:
+```sh
+curl http://$DASHING_HOST/dashboards/
+```
+
+Check if a dashboard exists:
+```sh
+curl http://$DASHING_HOST/dashboards/:id
+```
+
+Get the current status of a tile:
+```sh
+curl -i -H "Accept: application/json" http://$DASHING_HOST/tiles/:id.json
+```
+
+Check if a job script exist for data-id:
+```sh
+curl -i http://$DASHING_HOST/jobs/:id
+```
+
+Check if a tile exists on a dashboard:
+```sh
+curl -i http://$DASHING_HOST/tiles/:dashboard/:hosts
+```
+
+Delete a dashboard:
+```sh
+curl -X DELETE -H "Content-type: application/json" -d '{"auth_token": "$DASHING_AUTH_TOKEN"}' http://$DASHING_HOST/dashboards/:dashboard
+```
+
+Rename a dashboard:
+```sh
+curl -i -H 'Accept: application/json' -X PUT -d '{"auth_token": "$DASHING_AUTH_TOKEN", "from": "", "to": ""}' http://$DASHING_HOST/dashboards/
+```
+
+Replace a tile on a dashboard:
+```sh
+curl -i -H 'Accept: application/json' -X PUT -d '{"auth_token": "$DASHING_AUTH_TOKEN", "dashboard": "", "from": "", "to": ""}' http://$DASHING_HOST/tiles/
+```
+
+Create a dashboard
+```sh
+curl -i -H 'Accept: application/json' -X POST -d '{"auth_token": "$DASHING_AUTH_TOKEN", "tiles": {"hosts": [" "," "], "titles": [" ", " "], "widgets": [" ", " "], "urls": [" ", " "]}}' http://$DASHING_HOST/dashboards/:dashboard
+```
+
+Delete a tile/ tiles from a dashboard:
+```sh
+curl -i -H 'Accept: application/json' -X DELETE -d '{"auth_token": "$DASHING_AUTH_TOKEN", "tiles": [" ", " "]}' http://$DASHING_HOST/tiles/:dashboard
+```
+
+Add a tile/tiles to a dashboard
+```sh
+curl -i -H 'Accept: application/json' -X PUT -d '{"auth_token": "$DASHING_AUTH_TOKEN", "tiles": {"hosts": [" "," "], "titles": [" ", " "], "widgets": [" ", " "], "urls": [" ", " "]}}' http://$DASHING_HOST/tiles/:dashboard
+```
+
+Ping hosts and add to/ remove tiles from a dashboard
+```sh
+curl -i -H 'Accept: application/json' -X PUT -d '{"auth_token": "$DASHING_AUTH_TOKEN", "tiles": {"hosts": [" "," "], "titles": [" ", " "], "widgets": [" ", " "], "urls": [" ", " "]}}' http://$DASHING_HOST/ping/:dashboard
+```
+
+## Contributing
+
+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

data/lib/dashing_api/api.rb

@@ -0,0 +1,304 @@
+require 'json'
+require 'sinatra'
+require_relative 'helperFunctions'
+
+functions = HelperFunctions.new
+
+# A noobie way of overriding not_found block for 404
+error 404 do
+    content_type :json
+    { :error => 404, :message => @message }.to_json
+end
+
+error 403 do
+    content_type :json
+    { :error => 403, :message => @message }.to_json
+end
+
+# Get the current status of the tile
+get '/tiles/:id.json' do
+    content_type :json
+    if data = settings.history[params[:id]]
+    	data.split[1]
+    else
+    	@message = "Host " + params[:id] + "does not exist"
+    	404
+    end	
+end  
+
+# List all widgets
+get '/widgets/' do
+    content_type :json
+    widgets = Array.new()
+
+    Dir.entries(settings.root+'/widgets/').each do |widget|
+	if !File.directory? widget 
+	    widgets.push widget
+	end
+    end
+
+    { :widgets => widgets }.to_json
+end
+
+# List all dashboards
+get '/dashboards/' do
+    content_type :json
+    dashboards = Array.new()
+
+    # Get the name of the dashboard only. Strip the path
+    Dir.entries(settings.root+'/dashboards/').each do |dashboard|
+    	dashArray = dashboard.split("/")
+	dashboard = dashArray[dashArray.length-1]
+	if dashboard.include? ".erb"
+            dashboards.push dashboard
+	end
+    end
+
+    { :dashboards => dashboards }.to_json
+end
+
+# Check is a dashboard exists
+get '/dashboards/:dashboard' do
+    dashboard = params[:dashboard]    
+    if functions.dashboardExists(dashboard, settings.root)
+    	{ :dashboard => dashboard, :message => 'Dashboard ' +dashboard+  ' exists' }.to_json
+    else
+    	@message = "Dashboard " + dashboard + " does not exist"
+	404
+    end
+end
+
+# Rename a dashboard
+put '/dashboards/' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    from = body["from"]
+    to = body["to"]
+    
+    if functions.checkAuthToken(body, settings.auth_token)
+    	if functions.dashboardExists(from, settings.root)
+      	    File.rename(settings.root+'/dashboards/'+from+'.erb', settings.root+'/dashboards/'+to+'.erb')
+            { :message => 'Dashboard Renamed from ' + from +' to ' + to }.to_json
+      	else
+      	    @message = "Dashboard " + from + " does not exist"
+      	    404
+      	end
+    else
+    	@message = "Invalid API Key!"
+    	403
+    end
+end
+
+# Delete a dashboard
+delete '/dashboards/:dashboard' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = params[:dashboard]
+   
+    if functions.checkAuthToken(body, settings.auth_token)
+        if dashboard != settings.default_dashboard
+            if functions.dashboardExists(dashboard, settings.root)
+                File.delete(settings.root+'/dashboards/'+dashboard+'.erb')
+                { :dashboard => dashboard, :message => 'Dashboard ' +dashboard+ ' deleted' }.to_json
+		status 202
+            else
+            	@message = "Dashboard " + dashboard + " does not exist"
+		404
+            end
+        else
+            @message = "Cannot delete the default dashboard"
+	    403
+        end
+    else
+    	@message = "Invalid API Key"
+	403
+    end
+end
+
+  
+# Check if a job script is working
+get '/jobs/:id' do
+    content_type :json
+    hostName = params[:id]
+    if settings.history[hostName]
+        { :tile => hostName, :message => 'Host' +hostName+ ' has a job script' }.to_json
+    else
+    	@message = "Host " + hostName + " does not have a job script"
+	404
+    end
+end
+  
+# Check if a tile exists on a dashboard
+get '/tiles/:dashboard/:hosts'  do
+    hosts = params[:hosts]
+    dashboard = params[:dashboard]
+    if functions.dashboardExists(dashboard, settings.root)
+        output = functions.tileExists(dashboard, hosts, settings.root)
+        if output.empty?
+            { :dashboard => dashboard, :tiles => hosts, :message => 'Tiles exists on the dashboard' }.to_json
+        else
+            @message = "Tiles " +output.join(',')+ "does not exist on the dashboard " +dashboard
+	    404
+        end
+    else
+    	@message = "Dashboard " + dashboard + " does not exist"
+	404
+    end
+end
+
+
+# Replace a tile id on a dashboard
+put '/tiles/' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = body["dashboard"]
+    from = body["from"]
+    to = body["to"]
+  
+    if functions.checkAuthToken(body, settings.auth_token)
+        if dashboard != settings.default_dashboard
+            if functions.dashboardExists(dashboard, settings.root)
+                output = functions.tileExists(dashboard,from, settings.root)
+                if output.empty?
+                    File.write(settings.root+"/dashboards/"+dashboard+".erb",File.open(settings.root+"/dashboards/"+dashboard+".erb",&:read).gsub(from,to))
+                    { :dashboard => dashboard, :tile => to, :message => 'Tile Renamed' }.to_json
+                else
+                    @message = "Tile " + from + " does not exist on the dashboard " + dashboard + ". Make sure you have given the correct tile name"
+		    404
+                end
+            else
+            	@message = "Dashboard " + dashboard + " does not exist"
+		404
+            end
+        else
+            @message = "Cannot modify the default dashboard"
+	    403
+        end
+    else
+    	@message = "Invalid API Key!"
+        403
+    end
+end
+
+# Create a new dashboard
+post '/dashboards/:dashboard' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = params[:dashboard]
+
+    if functions.checkAuthToken(body, settings.auth_token)
+        if !functions.dashboardExists(dashboard, settings.root)
+            if functions.createDashboard(body, dashboard, settings.root) 
+                dashboardLink = "http://"+functions.getHost()+"/"+dashboard
+                { :message => 'Dashboard Created', :dashboardLink => dashboardLink }.to_json
+            else
+            	{ :message => 'Error while creating the dashboard. Try again!' }.to_json
+            end
+        else
+	    status 400
+            { :dashboard => dashboard, :message => 'Dashboard already exists' }.to_json
+        end
+    else
+    	@message = "Invalid API Key!"
+	403
+    end
+end
+
+
+# Delete a tile
+delete '/tiles/:dashboard' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = params[:dashboard]
+    tiles = body["tiles"]
+
+    if functions.checkAuthToken(body, settings.auth_token)
+        if dashboard != settings.default_dashboard
+            if functions.dashboardExists(dashboard, settings.root)
+                output = functions.tileExists(dashboard, tiles, settings.root)
+                if output.empty?
+                    functions.deleteTile(dashboard, tiles, settings.root)
+                    { :message => 'Tiles '+tiles.join(',')+ ' removed from the dashboard ' +dashboard  }.to_json
+		    status 202
+                else
+                    @message = "Hosts "+output.join(',')+" are not on the dashboard " + dashboard
+                    404
+                end
+            else
+                @message = "Dashboard "+dashboard+" does not exist!"
+                404
+            end
+        else
+            @message = "Cant modify the default dashboard"
+            403
+        end
+    else
+        @message = "Invalid API Key!"
+        403
+    end
+end
+
+#Add tile to dashboard
+put '/tiles/:dashboard' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = params[:dashboard]
+    tiles = body["tiles"]["hosts"]
+
+    if functions.checkAuthToken(body, settings.auth_token)
+        if dashboard != settings.default_dashboard
+            if functions.dashboardExists(dashboard, settings.root)
+                output = functions.tileExists(dashboard, tiles, settings.root)
+                if output.empty?
+                    { :message => 'Tiles '+tiles.join(',')+ ' already on the dashboard ' +dashboard }.to_json
+                else
+                    if functions.addTile(dashboard, body, settings.root)
+                        { :message => 'Tiles '+tiles.join(',')+ ' added to the dashboard '+ dashboard  }.to_json
+                    else
+                        @message = "Please provide all details for the tiles"
+                        404
+                    end
+                end
+            else
+                @message = "Dashboard "+dashboard+" does not exist!"
+                404
+            end
+        else
+            @message = "Cant modify the default dashboard"
+            403
+        end
+    else
+        @message = "Invalid API Key!"
+        403
+    end
+end
+
+
+#Ping and add/ remove tile
+
+put '/ping/:dashboard' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+    dashboard = params[:dashboard]
+
+    if functions.checkAuthToken(body, settings.auth_token)
+        if dashboard != settings.default_dashboard
+            if functions.dashboardExists(dashboard, settings.root)
+                if functions.pingHosts(dashboard, body, settings.root)
+                    { :message => "Tiles added/ removed successfully" }.to_json
+                else
+                    { :message => "Body contains duplicate values" }.to_json
+                end
+            else
+                @message = "Dashboard "+dashboard+" does not exist!"
+                404
+            end
+        else
+            @message = "Cant modify the default dashboard"
+            403
+        end
+    else
+        @message = "Invalid API Key!"
+       403
+   end
+end

data/lib/dashing_api/helperFunctions.rb

@@ -0,0 +1,272 @@
+require 'erb'
+require 'socket'
+require 'nokogiri'
+require 'open-uri'
+require 'net/ping'
+  
+def newDashboardTemplate()
+   %{
+    	<script type='text/javascript'>
+      	$(function myFunction() {
+        	$('li').live('click', function(e) { 
+        	var widget = $(this).find('widget');
+            var url = widget.data('url');
+            window.open(url, '_blank', "width=900, height=900, scrollvars=yes, toolbar=yes, resizable=yes");
+        	});
+    	});
+      	</script>
+
+      	<div class="gridster">
+        	<ul>
+         	<% for i in 0..body["tiles"]["hosts"].length-1 %>
+            <li data-row="1" data-col="1" data-sizex="2" data-sizey="2" onClick="myFunction()">
+               <div data-id="<%= body["tiles"]["hosts"][i] %>" data-view="<%= body["tiles"]["widgets"][i]  %>" data-unordered="true" data-title="<%= body["tiles"]["titles"][i] %>" data-url="<%= body["tiles"]["urls"][i]  %>" data-bind-style="status" style="style"></div>
+            </li>
+         	<% end %>
+         	</ul>
+      	</div>
+   }
+end
+
+def addDeleteTileTemplate()
+   %{
+        <script type='text/javascript'>
+        $(function myFunction() {
+                $('li').live('click', function(e) {
+                var widget = $(this).find('widget');
+            var url = widget.data('url');
+            window.open(url, '_blank', "width=900, height=900, scrollvars=yes, toolbar=yes, resizable=yes");
+                });
+        });
+        </script>
+        <div class="gridster">
+                <ul>
+                <% for i in 0..body.length-1%>
+                        <%= body[i] %>
+                <% end %>
+                </ul>
+        </div>
+   }
+end
+
+class HelperFunctions
+
+    include ERB::Util
+
+    def initialize
+    	@newDashboardTemplate = newDashboardTemplate
+    	@addDeleteTileTemplate = addDeleteTileTemplate
+    end
+
+    # Check if the auth_token is a valid 
+    def checkAuthToken(body, token)
+    	auth_token = body["auth_token"]
+    	if token == auth_token
+       	    return true
+    	else
+       	    return false
+    	end
+    end
+
+    # Check if a nagios host/hosts exists on a dashboard
+    def tileExists(dashboard, hosts, directory)
+    	if hosts.kind_of?(Array)
+       	    arrHosts = hosts
+    	else
+       	    arrHosts = hosts.split(",")
+    	end
+
+	doNotExist = Array.new
+    	for hosts in arrHosts
+    	    host = "data-id=\""+hosts+"\""
+       	    if File.foreach(directory+'/dashboards/'+dashboard+'.erb').any?{ |l| l[host]  }
+                next
+       	    else 
+          	doNotExist.push(hosts)
+       	    end
+    	end
+    	return doNotExist
+    end
+
+    # Check if the dashboard exists within the dashboard folder
+    def dashboardExists(dashboardName, directory)
+    	if File.exist?(directory+'/dashboards/'+dashboardName+'.erb')
+       	    return true
+    	else
+       	    return false
+    	end
+    end
+
+    def render(body, template)
+        ERB.new(template).result(binding)
+    end
+
+    def save(file, body, template)
+    	File.new(file, "w")
+     	File.open(file, "w+") do |f|
+            f.write(render(body, template))
+     	end
+    end
+
+    def checkArray(body)
+        hostLen = body["tiles"]["hosts"].length
+     	widgetLen = body["tiles"]["widgets"].length
+     	titleLen = body["tiles"]["titles"].length
+     	
+     	if hostLen.equal?(widgetLen) and widgetLen.equal?(titleLen)
+     	    return true
+     	else
+     	    return false
+     	end
+    end
+     	
+    def createDashboard(body, dashboard, directory)
+        dashboard = directory+'/dashboards/'+dashboard+'.erb'
+        if checkArray(body) 
+    	    save(dashboard, body, @newDashboardTemplate)
+    	    return true
+    	else
+    	    return false
+    	end
+    end
+  
+    def getHtmlElements(dashboard, hosts)
+        liElements = Array.new
+        finalElement = Array.new
+        doc = Nokogiri::HTML(open(dashboard))
+        liElements = doc.search('div > ul > li')
+
+        liElements.each do |item|
+            element = item.to_s
+            if hosts.any? { |w| element[w] }
+                next
+            else
+                finalElement.push(element)
+            end
+        end
+        return finalElement
+    end
+  
+    def deleteTile(dashboard, hosts, directory)
+        liElements = Array.new
+        finalElement = Array.new
+        dashboard = directory+'/dashboards/'+dashboard+'.erb'
+
+        doc = Nokogiri::HTML(open(dashboard))
+        liElements = doc.search('div > ul > li')
+
+        liElements.each do |item|
+            element = item.to_s
+            if hosts.any? { |w| element[w] }
+                next
+            else
+                finalElement.push(element)
+            end
+        end
+        save(dashboard, finalElement, @addDeleteTileTemplate)
+    end
+    
+    def addTile(dashboard, body, directory)
+        dashboard = directory+'/dashboards/'+dashboard+'.erb'
+        finalElement = Array.new
+        if checkArray(body)
+            finalElement = getHtmlElements(dashboard, body['tiles']['hosts'])
+
+            for i in 0..body["tiles"]["hosts"].length-1
+                host = body["tiles"]["hosts"][i]
+                widget = body["tiles"]["widgets"][i]
+                title = body["tiles"]["titles"][i]
+                url = body["tiles"]["urls"][i]
+
+                tileElement = ["<li data-row=\"1\"  data-col=\"1\" data-sizex=\"2\" data-sizey=\"2\" onClick=\"myFunction()\">
+                                <div data-id=\"", host,"\" data-view=\"", widget,"\" data-unordered=\"true\" data-title=\"", title,"\" data-url=\"", url, "\" data-bind-style=\"status\" style=\"style\"></div>
+                               </li>"  ].join
+                finalElement.push(tileElement)
+            end
+            save(dashboard, finalElement, @addDeleteTileTemplate)
+            return true
+        else
+            return false
+        end
+    end
+
+    def up?(host)
+        check = Net::Ping::External.new(host)
+        return check.ping?
+    end
+
+
+    def uniq?(array)
+        if array.length == array.uniq.length
+            return true
+        else
+            return false
+        end
+    end
+
+    def pingHosts(dashboard, body, directory)
+        notFound = Array.new
+
+        upArr = Array.new
+        downArr = Array.new
+
+        if uniq?(body["tiles"]["hosts"])
+            body["tiles"]["hosts"].each do |host|
+                if up?(host)
+                    upArr.push(host)
+                else
+                    downArr.push(host)
+                end
+            end
+
+            upOutput = tileExists(dashboard, upArr, directory)
+
+            if !upOutput.empty?
+                hosts = Array.new
+                titles = Array.new
+                widgets = Array.new
+                urls = Array.new
+
+                for i in 0..upOutput.length-1
+                    host = upOutput[i]
+                    for j in 0..body["tiles"]["hosts"].length-1
+                            checkhost = body["tiles"]["hosts"][j]
+                            if checkhost == host
+                                hosts.push(host)
+                                widgets.push(body["tiles"]["widgets"][j])
+                                titles.push(body["tiles"]["titles"][j])
+                                urls.push(body["tiles"]["urls"][j])
+                            else
+                                next
+                            end
+                    end
+                end
+
+                jsonArray = { :tiles => { :hosts => hosts, :widgets => widgets, :titles => titles, :urls => urls} }.to_json
+                objArray = JSON.parse(jsonArray)
+
+                addTile(dashboard, objArray, directory)
+            end
+
+            downOutput = tileExists(dashboard, downArr, directory)
+
+            if !downOutput.empty?
+                tileToRemove = downArr - downOutput
+            else
+                tileToRemove = downArr
+            end
+
+            deleteTile(dashboard, tileToRemove, directory)
+            return true
+        else
+            return false
+        end
+    end
+
+
+    # Get the hostname
+    def getHost()
+        return Socket.gethostname
+    end
+end
+

data/lib/dashing_api/version.rb

@@ -0,0 +1,3 @@
+module DashingApi
+  VERSION = "0.0.1"
+end

data/lib/dashing_api.rb

@@ -0,0 +1,6 @@
+require 'dashing_api/version'
+require 'dashing_api/api'
+
+module DashingApi
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: dashing_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- FT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API for interaction with dashing
+email:
+- jermila.dhas@ft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dashing_api.rb
+- lib/dashing_api/version.rb
+- lib/dashing_api/api.rb
+- lib/dashing_api/helperFunctions.rb
+homepage: https://github.com/Financial-Times/dashing_api.git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: API for interaction with dashing
+test_files: []