grafana-api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8db882d27b2ce8806d6eb17c2476610847d3415
-  data.tar.gz: 2a793a77bb449405582ae6b2a6cf44ea80986a1e
+  metadata.gz: eb679815babc5bcb0c1f9aaae398ad9a0db96528
+  data.tar.gz: 448445928c252bbef2fcad51150b1c4df111fbb2
 SHA512:
-  metadata.gz: 5485c5c075a442b7bbddbdeb3b4a4bd4c611c869136294d237c2d03c2efdf6d40e569121ff255509f4249fffee52ca254779be26bd2cc5ed1216ef3a49c4de91
-  data.tar.gz: 633e33e84f22a60bef80c52640887b89b57d26e9aeefaa7c74ada8166e4b12653dae793607c93db218fc6ffdb71ac7b80fbe1f4457b523da3c237cecf2e5d6e6
+  metadata.gz: 8e51435dfa74cdbc8e0a9d89a70415a37076c6e04d4dd44c645f0c549d401418b04180227afdceede958509403925a884e24548b9a6a7a306a325c072cda94ae
+  data.tar.gz: e6ee4a7fea2f7be1d8cf6be2d2261c439995a5aafc07dc1ffe5937c2845892b87ec01c4433a01d023fa50e603e74f77ae3075456050847cc478e8cf98862eaab

data/lib/grafana.rb

@@ -0,0 +1,2 @@
+
+require 'grafana/client.rb'

data/lib/grafana/admin.rb

@@ -0,0 +1,70 @@
+
+module Grafana
+
+  module Admin
+
+    def get_admin_settings()
+      endpoint = "/api/admin/settings"
+      @logger.info("Getting admin settings (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def update_user_permissions(id, perm)
+
+      valid_perms = ['Viewer','Editor','Read Only Editor','Admin']
+
+      if perm.class.to_s == "String" && !valid_perms.include?(perm)
+        @logger.warn("Basic user permissions include: #{valid_perms.join(',')}") if @debug
+        return false
+      elsif perm.class.to_s == "Hash" &&
+        ( !perm.has_key?('isGrafanaAdmin') || ![true,false].include?(perm['isGrafanaAdmin']) )
+        @logger.warn("Grafana admin permission must be either true or false") if @debug
+        return false
+      end
+
+      @logger.info("Updating user ID #{id} permissions") if @debug
+
+      if perm.class.to_s == 'Hash'
+        endpoint = "/api/admin/users/#{id}/permissions"
+        @logger.info("Updating user ID #{id} permissions (PUT #{endpoint})") if @debug
+        return put_request(endpoint, {"isGrafanaAdmin" => perm['isGrafanaAdmin']}.to_json)
+      else
+        org = self.get_current_org()
+        endpoint = "/api/orgs/#{org['id']}/users/#{id}"
+        @logger.info("Updating user ID #{id} permissions (PUT #{endpoint})") if @debug
+        user = { 
+          'name' => org['name'], 
+          'orgId' => org['id'], 
+          'role' => perm.downcase.capitalize
+        }
+        return patch_request(endpoint, user.to_json)
+      end
+    end
+
+    def delete_user(user_id)
+      if user_id == 1
+        @logger.warn("Can't delete user ID #{user_id} (admin user)") if @debug
+        return false
+      end
+      endpoint = "/api/admin/users/#{user_id}"
+      @logger.info("Deleting user ID #{user_id} (DELETE #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+    def create_user(properties={})
+      endpoint = "/api/admin/users"
+      @logger.info("Creating user: #{properties['name']}") if @debug
+      @logger.info("Data: #{properties.to_s}") if @debug
+      return post_request(endpoint, properties.to_json)
+    end
+
+    def update_user_pass(user_id,password)
+      endpoint = " /api/admin/users/#{user_id}/#{password}"
+      @logger.info("Updating password for user ID #{user_id} (PUT #{endpoint})") if @debug
+      return put_request(endpoint,properties)
+    end
+
+
+  end
+
+end

data/lib/grafana/client.rb

@@ -0,0 +1,100 @@
+  
+require 'rest-client'
+require 'json'
+require 'logger'
+
+module Grafana
+
+  require_relative 'http_request'
+  require_relative 'user'
+  require_relative 'users'
+  require_relative 'datasource'
+  require_relative 'organization'
+  require_relative 'organizations'
+  require_relative 'dashboard'
+  require_relative 'dashboard_template'
+  require_relative 'snapshot'
+  require_relative 'frontend'
+  require_relative 'login'
+  require_relative 'admin'
+  require_relative 'version'
+
+  class Client
+
+    attr_reader :debug, :session_cookies, :headers, :logger, :api_instance
+
+    include Grafana::HttpRequest
+    include Grafana::User
+    include Grafana::Users
+    include Grafana::Datasource
+    include Grafana::Organization
+    include Grafana::Organizations
+    include Grafana::Dashboard
+    include Grafana::DashboardTemplate
+    include Grafana::Snapshot
+    include Grafana::Frontend
+    include Grafana::Login
+    include Grafana::Admin
+
+    def initialize(host="localhost", port=3000, user='admin', pass='', settings={})
+
+      if settings.has_key?('timeout') && settings['timeout'].to_i <= 0
+        settings['timeout'] = 5
+      end
+      
+      if settings.has_key?('open_timeout') && settings['open_timeout'].to_i <= 0
+        settings['open_timeout'] = 5
+      end
+
+      if settings.has_key?('headers') && settings['headers'].class.to_s != 'Hash'
+        settings['headers'] = {}
+      end
+
+      proto = ( settings.has_key?('ssl') && settings['ssl'] == true ? 'https' : 'http')
+      
+      @logger.info("Initializing API client #{proto}://#{host}:#{port}") if @debug
+      @logger.info("Options: #{options}") if @debug
+      
+      @api_instance = RestClient::Resource.new(
+        "#{proto}://#{host}:#{port}", 
+        :timeout => settings['timeout'],
+        :open_timeout => settings['open_timeout'],
+        :headers => settings['headers']
+      )
+      @debug = (settings['debug'] ? true : false)
+      @logger = Logger.new(STDOUT)
+      @headers = nil
+
+      self.login(user, pass)
+      return self
+    end
+
+    def login(user='admin',pass='admin')
+      @logger.info("Attempting to establish user session") if @debug
+      request_data = {'User' => user, 'Password' => pass}
+      begin
+        resp = @api_instance['/login'].post(
+          request_data.to_json, 
+          {:content_type => 'application/json; charset=UTF-8'}
+        )
+        @session_cookies = resp.cookies
+        if resp.code.to_i == 200
+          @headers = {
+            :content_type => 'application/json; charset=UTF-8',
+            :cookies => @session_cookies
+          }
+          return true
+        else
+          return false
+        end
+      rescue => e
+        @logger.error("Error running POST request on /login: #{e}") if @debug
+        @logger.error("Request data: #{request_data.to_json}") if @debug
+        return false
+      end
+      @logger.info("User session initiated") if @debug
+    end
+
+  end # End of Client class
+
+end # End of GrafanaApi module

data/lib/grafana/dashboard.rb

@@ -0,0 +1,60 @@
+
+module Grafana
+
+  module Dashboard
+
+    def create_slug(text)
+      if text =~ /\s/
+        if text =~ /-/
+          text = text.gsub(/\s+/, "").downcase
+        else
+          text = text.gsub(/\s+/, "-").downcase
+        end
+      end
+      return text
+    end
+
+    def get_dashboard(name='')
+      endpoint = "/api/dashboards/db/#{name}"
+      name = self.create_slug(name)
+      @logger.info("Attempting to get dashboard (GET /api/dashboards/db/#{name})") if @debug
+      return get_request(endpoint)
+    end
+
+    def create_dashboard(properties={})
+      endpoint = "/api/dashboards/db"
+      dashboard = self.build_template(properties)
+      @logger.info("Creating dashboard: #{properties['title']} (POST /api/dashboards/db)") if @debug
+      return post_request(endpoint, dashboard)
+    end
+
+    def delete_dashboard(name)
+      name = self.create_slug(name)
+      endpoint = "/api/dashboards/db/#{name}"
+      @logger.info("Deleting dahsboard ID #{id} (DELETE #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+    def get_home_dashboard()
+      endpoint = "/api/dashboards/home"
+      @logger.info("Attempting to get home dashboard (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+    
+    def get_dashboard_tags()
+      endpoint = "/api/dashboards/tags"
+      @logger.info("Attempting to get dashboard tags(GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def search_dashboards(params={})
+      params['query'] = (params['query'].length >= 1 ? CGI::escape(params['query']) : '' )
+      params['starred'] = (params['starred'] ? 'true' : 'false')
+      endpoint = "/api/search/?query=#{params['query']}&starred=#{params['starred']}&tag=#{params['tags']}"
+      @logger.info("Attempting to search for dashboards (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/dashboard_template.rb

@@ -0,0 +1,224 @@
+
+module Grafana
+
+  module DashboardTemplate
+
+    # CloudWatch Namespaces, Dimensions and Metrics Reference:
+    # http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html
+    @@cw_dimensions = []
+
+
+    def build_template(params={})
+
+      if !params.has_key?('from')
+        params['from'] = 'now-2h'
+      end
+      if !params.has_key?('to')
+        params['to'] = 'now'
+      end
+      if params['title'] == ''
+        return false
+      end
+
+      rows = []
+      params['panels'].each do |panel|
+        rows.push(self.build_panel(panel))
+      end
+  
+      tpl = %q[
+      {
+        "dashboard": { 
+          "id": null,
+          "title": "%{title}",
+          "originalTitle": "%{title}",
+          "annotations": {
+            "list": []
+          },
+          "hideControls": false,
+          "timezone": "browser",
+          "editable": true,
+          "rows": [
+            %{rows}
+          ],
+          "time": {
+            "from": "%{from}",
+            "to": "%{to}"
+          },
+          "timepicker": {
+            "collapse": false,
+            "enable": true,
+            "notice": false,
+            "now": true,
+            "refresh_intervals": [
+              "5s",
+              "10s",
+              "30s",
+              "1m",
+              "5m",
+              "15m",
+              "30m",
+              "1h",
+              "2h",
+              "1d"
+            ],
+            "status": "Stable",
+            "time_options": [
+              "5m",
+              "15m",
+              "1h",
+              "6h",
+              "12h",
+              "24h",
+              "2d",
+              "7d",
+              "30d"
+            ],
+            "type": "timepicker"
+          },
+          "tags": ["api-templated"],
+          "templating": {
+            "list": []
+          },
+          "schemaVersion": 7,
+          "sharedCrosshair": false,
+          "style": "dark",
+          "version": 1,
+          "links": []
+        },
+        "overwrite": false
+      }
+      ]
+
+      return tpl % {
+        title: params['title'], 
+        from: params['from'], 
+        to: params['to'], 
+        rows: rows.join(',')
+      }
+
+    end
+
+
+    def build_panel(params={})
+
+      panel = %q[
+        {
+          "collapse": false,
+          "editable": true,
+          "height": "250px",
+          "panels": [
+            {
+              "aliasColors": {},
+              "bars": false,
+              "datasource": "%{datasource}",
+              "editable": true,
+              "error": false,
+              "fill": 1,
+              "grid": {
+                "leftLogBase": 1,
+                "leftMax": null,
+                "leftMin": null,
+                "rightLogBase": 1,
+                "rightMax": null,
+                "rightMin": null,
+                "threshold1": null,
+                "threshold1Color": "rgba(216, 200, 27, 0.27)",
+                "threshold2": null,
+                "threshold2Color": "rgba(234, 112, 112, 0.22)"
+              },
+              "legend": {
+                "avg": false,
+                "current": false,
+                "max": false,
+                "min": false,
+                "show": true,
+                "total": false,
+                "values": false
+              },
+              "lines": true,
+              "linewidth": 2,
+              "links": [],
+              "nullPointMode": "connected",
+              "percentage": false,
+              "pointradius": 5,
+              "points": false,
+              "renderer": "flot",
+              "seriesOverrides": [],
+              "span": 12,
+              "stack": false,
+              "steppedLine": false,
+              "targets": [
+                %{targets}
+              ],
+              "timeFrom": null,
+              "timeShift": null,
+              "title": "%{graph_title}",
+              "tooltip": {
+                "shared": true,
+                "value_type": "cumulative"
+              },
+              "type": "graph",
+              "x-axis": true,
+              "y-axis": true,
+              "y_formats": [
+                "short",
+                "short"
+              ]
+            }
+          ],
+          "title": "Row"
+        }
+      ]
+
+      targets = []
+      params['targets'].each do |t|
+        targets.push(self.build_target(t))
+      end
+
+  
+      return panel % {
+        datasource: params['datasource'],
+        graph_title: params['graph_title'],
+        targets: targets.join(',')
+      }
+
+
+    end
+
+
+    def build_target(params={})
+
+      target = %q[
+        {
+          "alias": "%{legend_alias}",
+          "dimensions": {
+            "%{dimension_name}": "%{dimension_value}"
+          },
+          "metricName": "%{metric_name}",
+          "namespace": "%{namespace}",
+          "period": 60,
+          "query": "",
+          "refId": "A",
+          "region": "%{region}",
+          "statistics": [
+            "Maximum"
+          ],
+          "timeField": "@timestamp"
+        }
+      ]
+
+      return target % {
+        metric_name: params['metric_name'],
+        namespace: params['namespace'],
+        dimension_name: params['dimension_name'],
+        dimension_value: params['dimension_value'],
+        region: params['region'],
+        legend_alias: params['legend_alias'],
+      }
+
+    end
+
+  end
+
+end
+

data/lib/grafana/datasource.rb

@@ -0,0 +1,64 @@
+
+module Grafana
+
+  module Datasource
+
+    def get_cw_namespaces(datasource_id)
+      endpoint = "/api/datasources/proxy/#{datasource_id}"
+      @logger.info("Getting data source namespaces (POST /api/datasources/proxy/#{datasource_id})") if @debug
+      return post_request(endpoint, {"action" => "__GetNamespaces"}.to_json)
+    end
+
+    def get_data_sources()
+      endpoint = "/api/datasources"
+      @logger.info("Attempting to get existing data sources (GET #{endpoint})") if @debug
+      data_sources = get_request(endpoint)
+      if !data_sources
+        return false
+      end
+      data_source_map = {}
+      data_sources.each { |ds|
+        data_source_map[ds['id']] = ds
+      }
+      return data_source_map
+    end 
+
+    def get_data_source(id)
+      endpoint = "/api/datasources/#{id}"
+      @logger.info("Attempting to get existing data source ID #{id}") if @debug
+      return get_request(endpoint)
+    end
+
+    def update_data_source(id, ds={})
+      existing_ds = self.get_data_source(id)
+      ds = existing_ds.merge(ds)
+      endpoint = "/api/datasources/#{id}"
+      @logger.info("Updating data source ID #{id}") if @debug
+      return put_request(endpoint, ds.to_json)
+    end
+
+    def create_data_source(ds={})
+      if ds == {} || !ds.has_key?('name') || !ds.has_key?('database')
+        @logger.error("Error: missing 'name' and 'database' values!") if @debug
+        return false
+      end
+      endpoint = "/api/datasources"
+      @logger.info("Creating data source: #{ds['name']} (database: #{ds['database']})") if @debug
+      return post_request(endpoint, ds.to_json)
+    end
+
+    def delete_data_source(id)
+      endpoint = "/api/datasources/#{id}"
+      @logger.info("Deleting data source #{id} (DELETE #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+    def get_available_data_source_types()
+      endpoint = '/api/datasources/plugins'
+      @logger.info("Attempting to get existing data source types (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/frontend.rb

@@ -0,0 +1,13 @@
+module Grafana
+
+  module Frontend
+
+    def get_frontend_settings()
+      endpoint = "/api/frontend/settings"
+      @logger.info("Getting frontend settings (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/http_request.rb

@@ -0,0 +1,66 @@
+module Grafana
+
+  module HttpRequest
+
+    def get_request(endpoint)
+      @logger.info("Running: Grafana::HttpRequest::#{__method__} on #{endpoint}") if @debug
+      return _issue_request('GET', endpoint)
+    end
+
+    def post_request(endpoint, postdata={})
+      @logger.info("Running: Grafana::HttpRequest::#{__method__} on #{endpoint}") if @debug
+      return _issue_request('POST', endpoint, postdata)
+    end
+
+    def put_request(endpoint, putdata={})
+      @logger.info("Running: Grafana::HttpRequest::#{__method__} on #{endpoint}") if @debug
+      return _issue_request('PUT', endpoint, putdata)
+    end
+
+    def delete_request(endpoint)
+      @logger.info("Running: Grafana::HttpRequest::#{__method__} on #{endpoint}") if @debug
+      return _issue_request('DELETE', endpoint)
+    end
+
+    def patch_request(endpoint, patchdata={})
+      @logger.info("Running: Grafana::HttpRequest::#{__method__} on #{endpoint}") if @debug
+      return _issue_request('PATCH', endpoint, patchdata)
+    end
+
+    def _issue_request(method_type='GET', endpoint='/', data={})
+  
+      begin
+        resp = nil
+        case method_type.upcase
+        when 'GET'
+          resp = @api_instance[endpoint].get(@headers)
+        when 'POST'
+          resp = @api_instance[endpoint].patch(data,@headers)
+        when 'PATCH'
+          resp = @api_instance[endpoint].patch(data,@headers)
+        when 'PUT'
+          resp = @api_instance[endpoint].patch(data,@headers)
+        when 'DELETE'
+          resp = @api_instance[endpoint].patch(@headers)
+        else
+          @logger.error("Error: #{__method__} is not a valid request method.") if @debug
+          return false
+        end
+
+        if (resp.code.to_i >= 200 && resp.code.to_i <= 299) || (resp.code.to_i >= 400 && resp.code.to_i <= 499)
+          return JSON.parse(resp.body)
+        else
+          @logger.error("#{__method__} on #{endpoint} failed: HTTP #{resp.code} - #{resp.body}") if @debug
+          return false
+        end
+
+      rescue => e
+       @logger.error("Error: #{__method__} #{endpoint} error: #{e}") if @debug
+       return false
+      end
+
+    end
+
+  end
+
+end

data/lib/grafana/login.rb

@@ -0,0 +1,13 @@
+module Grafana
+
+  module Login
+
+    def ping_session()
+      endpoint = "/api/login/ping"
+      @logger.info("Pingning current session (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+
+    end
+  end
+
+end

data/lib/grafana/organization.rb

@@ -0,0 +1,33 @@
+
+module Grafana
+
+  module Organization
+
+    def get_current_org()
+      endpoint = "/api/org"
+      @logger.info("Getting current organization (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def update_current_org(properties={})
+      endpoint = "/api/org"
+      @logger.info("Updating current organization (PUT #{endpoint})") if @debug
+      return put_request(endpoint, properties)
+    end
+
+    def get_current_org_users()
+      endpoint = "/api/org/users"
+      @logger.info("Getting organization users (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def add_user_to_current_org(properties={})
+      endpoint = "/api/org/users"
+      @logger.info("Adding user to current organization (POST #{endpoint})") if @debug
+      return post_request(endpoint, properties)
+    end
+
+
+  end
+
+end

data/lib/grafana/organizations.rb

@@ -0,0 +1,46 @@
+
+module Grafana
+
+  module Organizations
+
+    def get_all_orgs()
+      endpoint = "/api/orgs"
+      @logger.info("Getting all organizations (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+
+    def update_org(org_id, properties={})
+      endpoint = "/api/orgs/#{org_id}"
+      @logger.info("Updating orgnaization ID #{org_id} (POST #{endpoint})") if @debug
+      return post_request(endpoint, properties)
+    end
+
+    def get_org_users(org_id)
+      endpoint = "/api/orgs/#{org_id}/users"
+      @logger.info("Getting users in orgnaization ID #{org_id} (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+
+    def add_user_to_org(org_id, user={}) 
+      endpoint = "/api/orgs/#{org_id}/users"
+      @logger.info("Adding user to orgnaization ID #{org_id} (POST #{endpoint})") if @debug
+      return post_request(endpoint, user)
+    end
+
+    def update_org_user(org_id, user_id, properties={})
+      endpoint = "/api/orgs/#{org_id}/users/#{user_id}"
+      @logger.info("Updating user #{user_id} in organization #{org_id} (PATCH #{endpoint})") if @debug
+      return patch_request(endpoint, properties)
+    end
+
+    def delete_user_from_org(org_id, user_id)
+      endpoint = "/api/orgs/#{org_id}/users/#{user_id}"
+      @logger.info("Deleting user #{user_id} in organization #{org_id} (DELETE #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/snapshot.rb

@@ -0,0 +1,25 @@
+module Grafana
+
+  module Snapshot
+
+    def get_snapshot(key)
+      endpoint = "/api/snapshot/#{key}"
+      @logger.info("Getting frontend settings (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def create_snapshot(dashboard={})
+      endpoint = "/api/snapshot"
+      @logger.info("Creating dashboard snapshot (POST #{endpoint})") if @debug
+      return post_request(endpoint, dashboard)
+    end
+
+    def delete_snapshot(key)
+      endpoint = "/api/snapshots-delete/#{key}"
+      @logger.info("Deleting snapshot ID #{key} (GET #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/user.rb

@@ -0,0 +1,44 @@
+
+module Grafana
+
+  module User
+
+    def get_current_user()
+      endpoint = "/api/user"
+      @logger.info("Getting user current user (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def update_current_user_pass(properties={})
+      endpoint = "/api/user/password"
+      @logger.info("Updating current user password (PUT #{endpoint})") if @debug
+      return put_request(endpoint,properties)
+    end
+
+    def switch_current_user_org(org_id)
+      endpoint = "/api/user/using/#{org_id}"
+      @logger.info("Switching current user to Org ID #{id} (GET #{endpoint})") if @debug
+      return post_request(endpoint, {})
+    end
+
+    def get_current_user_orgs()
+      endpoint = "/api/user/orgs"
+      @logger.info("Getting current user organizations (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def add_dashboard_star(dashboard_id)
+      endpoint = "/api/user/stars/dashboard/#{dashboard_id}"
+      @logger.info("Adding start to dashboard ID #{dashboard_id} (GET #{endpoint})") if @debug
+      return post_request(endpoint, {})
+    end
+
+    def remove_dashboard_star(dashboard_id)
+      endpoint = "/api/user/stars/dashboard/#{dashboard_id}"
+      @logger.info("Deleting start on dashboard ID #{dashboard_id} (GET #{endpoint})") if @debug
+      return delete_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/users.rb

@@ -0,0 +1,51 @@
+
+module Grafana
+
+  module Users
+
+    def get_all_users()
+      endpoint = "/api/users"
+      @logger.info("Getting all users (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def get_user_by_id(id)
+      endpoint = "/api/users/#{id}"
+      @logger.info("Getting user ID #{id} (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+    def search_for_users_by(search={})
+      all_users = self.get_all_users()
+      key, value = search.first
+      @logger.info("Searching for users matching #{key} = #{value}") if @debug
+      users = []
+      all_users.each do |u|
+        if u[key] && u[key] == value
+          users.push(u)
+        end
+      end
+      return (users.length >= 1 ? users : false)
+    end
+
+    def update_user_info(id, properties={})
+      endpoint = "/api/users/#{id}"
+      @logger.info("Updating user ID #{id}") if @debug
+      existing_user = self.get_user(id)
+      if !existing_user
+        @logger.error("User #{id} does not exist") if @debug
+        return false
+      end
+      properties = existing_user.merge(properties)
+      return put_request(endpoint,properties.to_json)
+    end
+
+    def get_user_orgs(userid)
+      endpoint = "/api/users/#{userid}/orgs"
+      @logger.info("Getting organizations for user #{id} (GET #{endpoint})") if @debug
+      return get_request(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/version.rb

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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: grafana-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alain Lefebvre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 description: A simple wrapper for the Grafana HTTP API
@@ -44,7 +44,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/grafana-api.rb
+- lib/grafana.rb
+- lib/grafana/admin.rb
+- lib/grafana/client.rb
+- lib/grafana/dashboard.rb
+- lib/grafana/dashboard_template.rb
+- lib/grafana/datasource.rb
+- lib/grafana/frontend.rb
+- lib/grafana/http_request.rb
+- lib/grafana/login.rb
+- lib/grafana/organization.rb
+- lib/grafana/organizations.rb
+- lib/grafana/snapshot.rb
+- lib/grafana/user.rb
+- lib/grafana/users.rb
+- lib/grafana/version.rb
 homepage: http://github.com/lightspeedretail/ruby-grafana-api
 licenses:
 - MIT
@@ -55,18 +69,18 @@ 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.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Grafana API Wrapper
+summary: Grafana HTTP API Wrapper
 test_files: []

data/lib/grafana-api.rb

@@ -1,355 +0,0 @@
-class GrafanaApi
-
-  require 'rest-client'
-  require 'json'
-  require 'logger'
-
-  attr_accessor :debug, :session_cookies, :headers
-
-  def initialize(host="localhost", port=3000, debug=false)
-    @api_instance = RestClient::Resource.new("http://#{host}:#{port}")
-    @debug = debug
-    @logger = Logger.new(STDOUT)
-    @headers = nil
-  end
-
-  def login(user='admin',pass='admin')
-    @logger.info("Attempting to establish user session") if @debug
-    request_data = {'User' => user, 'Password' => pass}
-    begin
-      resp = @api_instance['/login'].post(
-        request_data.to_json, 
-        {:content_type => 'application/json; charset=UTF-8'}
-      )
-      @session_cookies = resp.cookies
-      if resp.code.to_i == 200
-        @headers = {
-          :content_type => 'application/json; charset=UTF-8',
-          :cookies => @session_cookies
-        }
-        return true
-      else
-        return false
-      end
-    rescue => e
-      @logger.error("Error running POST request on /login: #{e}") if @debug
-      @logger.error("Request data: #{request_data.to_json}") if @debug
-      return false
-    end
-    @logger.info("User session initiated") if @debug
-  end
-
-
-
-  def get_user(id)
-    @logger.info("Getting user ID #{id} (GET /api/users/#{id})") if @debug
-    begin
-      resp = @api_instance["/api/users/#{id}"].get(@headers)
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not get user: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not get user: #{e}") if @debug
-     return false
-    end
-  end
-
-  def get_users()
-    @logger.info("Getting all users (GET /api/users)") if @debug
-    begin
-      resp = @api_instance['/api/users'].get(@headers)
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not get list of users: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not get list of users: #{e}") if @debug
-     return false
-    end
-  end
-
-  def search_for_users_by(search={})
-    all_users = self.get_users()
-    key, value = search.first
-    @logger.info("Searching for users matching #{key} = #{value}") if @debug
-    users = []
-    all_users.each do |u|
-      if u[key] && u[key] == value
-        users.push(u)
-      end
-    end
-    return (users.length >= 1 ? users : false)
-  end
-
-  def create_user(properties={})
-    @logger.info("Creating user: #{properties['name']}") if @debug
-    @logger.info("Data: #{properties.to_s}") if @debug
-    begin
-      resp = @api_instance["/api/admin/users"].post(
-        properties.to_json,
-        @headers
-      )
-      result = JSON.parse(resp.body)
-      if resp.code.to_i == 200
-        @logger.info(resp.body) if @debug
-        return true
-      else
-        @logger.error("Data source could not be created: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error creating data source: #{e}") if @debug
-      return false
-    end
-  end
-
-  def update_user_info(id, properties={})
-    @logger.info("Updating user ID #{id}") if @debug
-    begin
-      existing_user = self.get_user(id)
-      if !existing_user
-        @logger.error("User #{id} does not exist") if @debug
-        return false
-      end
-      properties = existing_user.merge(properties)
-      resp = @api_instance["/api/users/#{id}"].put(
-        properties.to_json,
-        @headers
-      )
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not update user (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Could not update user: #{e}") if @debug
-      return false
-    end
-  end
-
-  def update_user_permissions(id, perm)
-
-    valid_perms = ['Viewer','Editor','Read Only Editor','Admin']
-
-    if perm.class.to_s == "String" && 
-      !valid_perms.include?(perm)
-      @logger.warn("Basic user permissions include: #{valid_perms.join(',')}") if @debug
-      return false
-    elsif perm.class.to_s == "Hash" &&
-      (!perm.has_key?('isGrafanaAdmin') ||
-        ![true,false].include?(perm['isGrafanaAdmin']) )
-      @logger.warn("Grafana admin permission must be either true or false") if @debug
-      return false
-    end
-
-    @logger.info("Updating user ID #{id} permissions") if @debug
-    begin
-      if perm.class.to_s == 'Hash'
-        resp = @api_instance["/api/admin/users/#{id}/permissions"].put(
-          {"isGrafanaAdmin" => perm['isGrafanaAdmin']}.to_json,
-          @headers
-        )
-      else
-        org = self.get_current_org()
-        resp = @api_instance["/api/orgs/#{org['id']}/users/#{id}"].patch(
-          { 'name' => org['name'], 'orgId' => org['id'], 
-            'role' => perm.downcase.capitalize
-          }.to_json,
-          @headers
-        )
-      end
-
-      if resp.code.to_i == 200
-        @logger.error("User permissions have been updated: #{resp.body}") if @debug
-        return true
-      else
-        @logger.error("Could not update user permissions (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Could not update user permissions: #{e}") if @debug
-      return false
-    end
-  end
-
-  def delete_user(id)
-    if id == 1
-      @logger.warn("Can't delete user ID #{id} (admin user)") if @debug
-      return false
-    end
-    @logger.info("Deleting user ID #{id} (DELETE /api/admin/users/#{id})") if @debug
-    begin
-      resp = @api_instance["/api/admin/users/#{id}"].delete(@headers)
-      if resp.code.to_i == 200
-        @logger.info("User ID #{id} has been deleted") if @debug
-        return true
-      else
-        @logger.error("Could note delete: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not delete user: #{e}") if @debug
-     return false
-    end
-  end
-
-
-
-  def get_data_sources()
-    begin 
-      @logger.info("Attempting to get existing data sources (GET /api/datasources)") if @debug
-      resp = @api_instance['/api/datasources'].get(@headers)
-      data_sources = JSON.parse(resp.body)
-      data_source_map = {}
-      data_sources.each { |ds|
-        data_source_map[ds['id']] = ds
-      }
-      if resp.code.to_i == 200
-        return data_source_map
-      else
-        @logger.error("Could not retreive data sources (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error getting existing data sources: #{e}") if @debug
-      return false
-    end
-  end 
-
-  def get_data_source(id)
-    begin 
-      @logger.info("Attempting to get existing data source ID #{id}") if @debug
-      resp = @api_instance["/api/datasources/#{id}"].get(@headers)
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not get data source (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error getting existing data sources: #{e}") if @debug
-      return false
-    end
-  end
-
-  def update_data_source(id, ds={})
-    @logger.info("Updating data source ID #{id}") if @debug
-
-    existing_ds = self.get_data_source(id)
-    ds = existing_ds.merge(ds)
-    @logger.info(ds)
-
-    begin
-      resp = @api_instance["/api/datasources/#{id}"].put(
-        ds.to_json,
-        @headers
-      )
-      if resp.code.to_i == 200
-        @logger.info("Data source successfully updated") if @debug
-        return true
-      else
-        @logger.info("Data source could not be updated (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error updating data source: #{e}") if @debug
-      return false
-    end
-  end
-
-  def create_data_source(ds={})
-    @logger.info("Creating data source: #{ds['name']} (database: #{ds['database']})") if @debug
-    begin
-      resp = @api_instance["/api/datasources"].post(
-        ds.to_json,
-        @headers
-      )
-      result = JSON.parse(resp.body)
-      if resp.code.to_i == 200
-        @logger.info("Data source ID #{result['id']} has been created") if @debug
-        return true
-      else
-        @logger.error("Data source could not be created (HTTP #{resp.code}: #{resp.body})") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error creating data source: #{e}") if @debug
-      return false
-    end
-  end
-
-  def delete_data_source(id)
-    @logger.info("Deleting data source #{id}") if @debug
-    begin
-      resp = @api_instance["/api/datasources/#{id}"].delete(@headers)
-      result = JSON.parse(resp.body)
-      if resp.code.to_i == 200
-        @logger.info("Data source ID #{id} has been deleted") if @debug
-        return true
-      else
-        @logger.error("Data source could not be deleted (HTTP #{resp.code}): #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-      @logger.error("Error creating data source: #{e}") if @debug
-      return false
-    end
-  end
-
-
-
-  def get_current_org()
-    @logger.info("Getting current organization (GET /api/org)") if @debug
-    begin
-      resp = @api_instance['/api/org'].get(@headers)
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not get current organization: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not get current organization: #{e}") if @debug
-     return false
-    end
-  end
-
-  def ping_session()
-    @logger.info("Pingning current session (GET /api/login/ping)") if @debug
-    begin
-      resp = @api_instance['/api/login/ping'].get(@headers)
-      if resp.code.to_i == 200
-        return true
-      else
-        @logger.error("Could not ping session: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not ping session: #{e}") if @debug
-     return false
-    end
-  end
-
-  def get_admin_settings()
-    @logger.info("Getting admin settings (GET /api/admin/settings)") if @debug
-    begin
-      resp = @api_instance['/api/admin/settings'].get(@headers)
-      if resp.code.to_i == 200
-        return JSON.parse(resp.body)
-      else
-        @logger.error("Could not get admin settings: #{resp.body}") if @debug
-        return false
-      end
-    rescue => e
-     @logger.error("Could not get admin settings: #{e}") if @debug
-     return false
-    end
-  end
-
-end