flareboard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d2579b252fee593a40c48761c6ac965bab4b39e
+  data.tar.gz: a9673657a91d16531d9f40fa8555aefa8d6a7706
+SHA512:
+  metadata.gz: d7032d8918a66d9ef8f63cee3fe859a8afb95b6034d1bc138ed0aa77b86410d0f2db1d69ae80d43e44855d98c820639e0ac82be51193de62db12186b5d3f5bc4
+  data.tar.gz: 5856f2bdf2487914646e2a3de877aa29f0bd32cd5458617438d9c0a66152c00236ed1826f360820563175483d06a38b2a665e4e523993f8c8a21dbb2a24b95d4

data/README.md

@@ -0,0 +1,89 @@
+##What is Flareboard?
+
+Flareboard is the way to get your [CloudFlare](http://www.cloudflare.com) stats
+to display in your [StatusBoard](http://www.panic.com/statusboard). It has been
+designed to be very easy to install and use. It requires no third-party gems,
+and can be run on any version of ruby from 1.8.7 to 2.1.1.
+
+Add your credentials and sites to flareboard, and it will hit the CloudFlare API
+to grab your stats and convert them into the JSON that Statusboard uses for
+graphing. You can drop the resulting file into a dropbox folder or host it on a
+web server. Unless you are paying for a CloudFlare Pro account, your stats will
+only update every 24 hours, so it's no use running flareboard more often than
+that.
+
+**Note**: For compatibility with 1.8.7. you *will* have to install the JSON gem.
+Also, you have my sympathies for having to use 1.8.7.
+
+## Installation
+
+Copy the file ```bin/flareboard``` onto your computer. Put it either in a bin
+directory in your path or somewhere else. If you are using ruby 1.8.7, then
+you'll have to run ```sudo gem install json``` before it will work.
+
+## Configuration
+
+There are three ways of configuring the script. Via the command-line arguments
+documented in the previous section, via a config file (*~/.flareboard.rc*), or
+by editing the script directly. In order of priority (highest to lowest), it
+will use command-line options, the config file, and then the hard-coded config
+hash in the script.
+
+It is *highly* recommended to use a config file, as passing your API token on
+the command-line is a security risk, and modifying the script itself will make
+upgrades manual and laborious.
+
+### :title
+The title that will show up on your status board
+
+### :token
+Your Cloudflare token - available via their website at
+https://www.cloudflare.com/my-account
+
+### :email
+The email you have registered with cloudflare. **NOT** your username!
+
+### :interval
+Interval Values - see https://www.cloudflare.com/docs/client-api.html for
+latest.
+
+    20-40 only update once a day - it is no use polling more often than that
+    20 = Past 30 days
+    30 = Past 7 days
+    40 = Past day
+    !!! Anything higher than this requires a paid CloudFlare account !!!
+    !!! This also enables greater than daily updates !!!
+    100 = 24 hours ago
+    110 = 12 hours ago
+    120 = 6 hours ago
+
+### :sites
+Sites have a site specific title, a URL, and a color for the graph.
+Colors: yellow, green, red, purple, blue, mediumGray, pink, aqua, orange, lightGray
+
+Here is an example config file, using the same data as the example hash.
+
+    ---
+    :token: XXXXXXX
+    :email: user@example.com
+    :sites:
+    - :title: 'Should I Use That In Prod'
+      :url:   'shouldiusethatinprod.com'
+      :color: 'red'
+    - :title: "It's Not Rocket Science"
+      :url:   'itsnotrocketscience.info'
+      :color: 'purple'
+
+## Usage
+
+    Usage: flareboard [options]
+        -f, --file FILE                  Where to write the JSON output
+                                         Defaults to STDOUT
+        -t, --token TOKEN                Your CloudFlare API token
+        -e, --email EMAIL                Your CloudFlare email address
+        -i, --interval INTERVAL          CloudFlare history interval
+                                         Defaults to 40
+            --title TITLE                Title of the status board
+                                         Defaults to 'Cloudflare - Pageviews'
+
+    If no file is given, flareboard will write to standard out.

data/bin/flareboard

@@ -0,0 +1,220 @@
+#!/usr/bin/env ruby
+# @author David Bishop
+
+require 'net/http'
+if RUBY_VERSION < '1.9'
+  require 'net/https'
+end
+require 'json'
+require 'optparse'
+require 'yaml'
+
+# Rather than dump out a free-form string, on errors dump out something that
+# the status board app can read in and display
+#
+# @param error [String] Short description of the problem
+# @param detail [String] Longer description or specific error code
+# @return [nil]
+def exit_json(error, detail)
+  # return the error in json form
+  sperror = {
+    'error' => {
+      'message' => error,
+      'detail'  => detail
+    }
+  }
+  STDERR.puts error, detail
+  puts sperror.to_json
+  exit 1
+end
+
+# Take the integer that CloudFlare uses and return a description in english
+#
+# @param interval [Integer] Integer needed by Cloudflare API
+# @return [String] Description in english
+def name_interval(interval)
+  title = {
+    20 => 'Last Month',
+    30 => 'Last Week',
+    40 => 'Yesterday',
+    100 => '24 Hours Ago',
+    110 => '12 Hours Ago',
+    120 => '6 Hours Ago'
+  }
+
+  # hash.fetch will return the second parameter if the key doesn't exist
+  title.fetch(interval, 'Invalid interval')
+end
+
+# ~~~~~ CONFIG BEGIN ~~~~~
+
+options = {
+  :title    => 'Cloudflare - Pageviews',
+  :token    => 'XXXXXX',
+  :email    => 'user@example.com',
+  :interval => 40,
+  :graph    => 'bar',
+  :sites    => [
+    { :title => 'Should I Use That In Prod',
+      :url => 'shouldiusethatinprod.com',
+      :color => 'red'
+    },
+    { :title => "It's Not Rocket Science",
+      :url => 'itsnotrocketscience.info',
+      :color => 'purple'
+    }
+  ]
+}
+
+# YOU SHOULD NOT NEED TO EDIT ANYTHING BELOW HERE
+# IF YOU DO, PLEASE OPEN A BUG REPORT AT http://github.com/teancom/flareboard
+# ~~~~~ CONFIG END ~~~~~
+
+# The config file
+CONFIG_FILE = File.join(ENV['HOME'], '.flareboard.rc')
+if File.exist? CONFIG_FILE
+  config_options = YAML.load_file(CONFIG_FILE)
+  options.merge!(config_options)
+end
+
+# The name of this program
+EXE_NAME = File.basename($PROGRAM_NAME)
+# @todo Add support for graph type
+option_parser = OptionParser.new do |opts|
+  opts.on('-f FILE',
+          '--file',
+          'Where to write the JSON output',
+          'Defaults to STDOUT'
+         ) do |file|
+    options[:file] = file
+  end
+  opts.on('-t TOKEN',
+          '--token',
+          'Your CloudFlare API token'
+         ) do |token|
+    options[:token] = token
+  end
+  opts.on('-e EMAIL',
+          '--email',
+          'Your CloudFlare email address'
+         ) do |email|
+    options[:email] = email
+  end
+  opts.on('-i INTERVAL',
+          '--interval',
+          Integer,
+          'CloudFlare history interval',
+          'Defaults to 40'
+         ) do |interval|
+    options[:interval] = interval
+  end
+  opts.on('--title TITLE',
+          'Title of the status board',
+          "Defaults to 'Cloudflare - Pageviews'"
+         ) do |title|
+    options[:title] = title
+  end
+# opts.on('--graph GRAPH',
+#         'The type of graph - bar or line',
+#         'Defaults to bar'
+#        ) do |graph|
+#   options[:graph] = graph
+# end
+  opts.on("\n")
+  opts.on("If no file is given, #{EXE_NAME} will write to standard out.")
+end
+
+option_parser.parse!
+
+if options.key? :file
+  path = File.expand_path(options[:file])
+  dir = File.dirname(path)
+  begin
+    $stdout.reopen(path, 'w')
+  rescue Errno::ENOENT
+    abort "Can't write into #{dir}. Does it exist?"
+  rescue Errno::EACCES
+    abort File.writable?(dir) ? "Can't write #{path}. No permission." : "Can't write into #{dir}. No permission."
+  rescue Errno::EISDIR
+    abort 'Please pass in a file name, not a directory name.'
+  rescue => e
+    abort e.message
+  end
+end
+
+# The graph hash needs to match the JSON object that StatusBoard requires
+graph = {
+  'graph' => {
+    'title'         => options[:title],
+    'type'          => options[:graph],
+    'datasequences' => []
+  }
+}
+
+uri = URI.parse('https://www.cloudflare.com/api_json.html')
+request = Net::HTTP::Post.new(uri.path)
+
+options[:sites].each_with_index do | site, key |
+  request.set_form_data(
+    'a' => 'stats',
+    'tkn' => options[:token],
+    'email' => options[:email],
+    'z' => site[:url],
+    'interval' => options[:interval]
+  )
+  httpreq = Net::HTTP.new(uri.host, uri.port)
+  httpreq.use_ssl = true
+  if RUBY_VERSION < '1.9'
+    httpreq.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+
+  response = httpreq.start do |http|
+    http.request(request)
+  end
+
+  # Got back something other than a 2xx response code
+  unless response.is_a? Net::HTTPSuccess
+    exit_json('Problems contacting the Cloudflare server', response.msg)
+  end
+
+  # Parse the JSON we got back from CloudFlare
+  begin
+    result = JSON.parse(response.body)
+  rescue UnparserError => e
+    exit_json('Unable to parse the Cloudflare JSON', e)
+  end
+
+  # Figure out what sort of error we got back
+  errcodes = { 'E_UNAUTH' => "Couldn't authenticate: ",
+               'err_ts' => 'Invalid interval: ',
+               'err_zone_not_found' => 'Probable typo in site name: ',
+               'E_MAXAPI' => 'CloudFlare wants you to not hit them as much: ',
+               'E_INVLDINPUT' => 'Unknown problem. Congrats! This is weird: '
+  }
+
+  if result['result'] == 'error'
+    if errcodes.key? result['err_code']
+      exit_json(errcodes[result['err_code']] + result['msg'],
+                result['err_code'])
+    else
+      exit_json("Unable to retrieve the Cloudflare JSON: #{result['msg']}",
+                result['err_code'])
+    end
+  end
+
+  totalhits = result['response']['result']['objs'][0]['requestsServed']['cloudflare']
+  crawlerhits = result['response']['result']['objs'][0]['trafficBreakdown']['pageviews']['crawler']
+
+  graph['graph']['datasequences'][key] = {
+    'title'      => site[:title],
+    'color'      => site[:color],
+    'datapoints' => [{
+      'title' => name_interval(options[:interval]),
+      'value' => totalhits - crawlerhits
+    }]
+  }
+  # graph['graph']['datasequences'][key]['datapoints'][0]['title'] = 'Nudiustertian'
+  # graph['graph']['datasequences'][key]['datapoints'][1]['title'] = 'Yesterday'
+end
+
+puts graph.to_json

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: flareboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Bishop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |-
+  flareboard allows you to display your CloudFlare statistics
+                     in the Panic Software's StatusBoard app
+email: david at gnuconsulting dotcom
+executables:
+- flareboard
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/flareboard
+homepage: http://github.com/teancom/flareboard
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: flareboard
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: flareboard gets your cloudflare stats into statusboard
+test_files: []