gfspark 0.0.1 → 0.1.1

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/
+.gfspark

data/README.md

@@ -2,7 +2,7 @@
 
 Growth Forecast on Terminal.
 
-gfspark is CLI graph viewer for Growth Forecast.
+gfspark is a CLI graph viewer for Growth Forecast.
 
 ## Installation
 
@@ -18,8 +18,14 @@ Or install it yourself as:
 
     $ gem install gfspark
 
+## ScreenShots
+
+<img src='https://github.com/yuroyoro/gfspark/raw/master/images/gfspark_screenshot.png' width='600'/>
+
 ## Usage
 
+    gfspark : Growth Forecast on Terminal
+
     usage: gfspark <url|path|service_name> [section_name] [graph_name]
 
       Examples:
@@ -32,15 +38,53 @@ Or install it yourself as:
         -u, --user=USER
         -p, --pass=PASS
         -t=VALUE                         Range of Graph
-            --from=VALUE                 Start date of graph.(2011/12/08 12:10:00) required if t=c or sc
-            --to=VALUE                   End date of graph.(2011/12/08 12:10:00) required if t=c or sc
-        -h, --height=VALUE               graph height.(default 10
-        -w, --width=VALUE                graph width.(default is deteced from $COLUMNS
-        -c, --color=VALUE                Color of graph bar
+            --gmode=VALUE                graph mode: gauge or subtract (default is gauge)
+            --from=VALUE                 Start date of graph (2011/12/08 12:10:00) required if t=c or sc
+            --to=VALUE                   End date of graph (2011/12/08 12:10:00) required if t=c or sc
+        -h, --height=VALUE               graph height (default 10
+        -w, --width=VALUE                graph width (default is deteced from $COLUMNS)
+        -c, --color=VALUE                Color of graph bar (black/red/green/yellow/blue/magenta/cyan/white)
+        -n, --non-fullwidth-font         Show bar symbol as fullwidth
             --sslnoverify                don't verify SSL
             --sslcacert=v                SSL CA CERT
             --debug                      debug print
 
+        -t option detail:
+            y : Year (1day avg)
+            m : Month (2hour avg)
+            w : Week (30min avg)
+           3d : 3 Days (5min avg)
+          s3d : 3 Days (5min avg)
+            d : Day (5min avg)
+           sd : Day (1min avg)
+           8h : 8 Hours (5min avg)
+          s8h : 8 Hours (1min avg)
+           4h : 4 Hours (5min avg)
+          s4h : 4 Hours (1min avg)
+            h : Hour (5min avg),
+           sh : Hour (1min avg)
+            n : Half Day (5min avg)
+           sn : Half Day (1min avg)
+            c : Custom (5min avg)
+           sc : Custom (1min avg)
+
+gfspark does not supports "COMPLEX GRAPH".
+if graph output is broken, try `--non-fullwidth-font` option.
+For example, your Terminal font is "Rickty", then it'll be fix graph output problem.
+
+## Configuration
+
+gfspark load default settings from `.gfspark` file.
+This configuration file is searched from current dirctory to pararents, or your home directory(~/.gfspark).
+
+.gfspark is YAML file.  It's contents is like bellow
+
+    url: http://your.growthforecast.com/
+    color: red
+    username: "your basic auth username"
+    password: "your basic auth password"
+    non_fullwidth_font: true
+
 ## Contributing
 
 1. Fork it

data/lib/gfspark.rb

@@ -27,10 +27,16 @@ module Gfspark
     app = nil
     begin
       app = Gfspark::App.new(argv)
-      if app.valid
+      if app && app.debug
+        puts "App Instance Variables ----"
+        pp app
+        puts "---------------------------"
+      end
+
+      if app && app.valid
         status = app.execute
       else
-        app.help
+        app.help if app
         return false
       end
     rescue => e

data/lib/gfspark/app.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 class Gfspark::App
   include Term::ANSIColor
   include ::Gfspark::Config
@@ -17,12 +18,18 @@ class Gfspark::App
     @options = load_default_settings
     try_url(args) || try_path(args) || try_default(args)
 
-    unless @url && @service && @section && @graph
-      puts "Invalid Arguments"
+    required_args = [:url, :service, :section, :graph]
+    unless required_args.map(&:to_s).map(&"@".method(:+)).map(&method(:instance_variable_get)).inject(true, :&)
+      puts "Invalid Arguments: check arguments or your .gfspark file"
+      required_args.each do |n|
+        puts "  #{n} is required" unless instance_variable_get("@#{n}")
+      end
+      puts ""
       @valid = false
       return
     end
 
+    @valid = true
     detect_width_and_height!
     set_ssl_options!
   end
@@ -31,17 +38,30 @@ class Gfspark::App
     json    = fetch(:xport)
     summary = fetch(:summary)
 
-    render(json, summary)
+    url = to_url(:view_graph)
+    render(json, summary, url)
     true
   end
 
+  def to_url(api)
+    url = "#{@url}/#{api.to_s}/#{@service}/#{@section}/#{@graph}"
+    queries = {}
+    queries[:t]     = @options[:t] || "d"
+    queries[:width] = @width
+    queries[:gmode] = @options[:gmode] if @options[:gmode]
+    queries[:from]  = @options[:from]  if @options[:from]
+    queries[:to]    = @options[:to]    if @options[:to]
+    "#{url}?#{queries.map{|k,v| "#{k}=#{v}"}.join("&")}"
+  end
+
   def fetch(api)
     url = "#{@url}/#{api.to_s}/#{@service}/#{@section}/#{@graph}"
     queries = {}
     queries[:t]     = @options[:t] || "d"
     queries[:width] = @width
-    queries[:from]  = @options[:from] if @options[:from].nil?
-    queries[:to]    = @options[:to] if @options[:to].nil?
+    queries[:gmode] = @options[:gmode] if @options[:gmode]
+    queries[:from]  = @options[:from]  if @options[:from].nil?
+    queries[:to]    = @options[:to]    if @options[:to].nil?
 
     json = fetch_json(url, {}, queries)
   end

data/lib/gfspark/config.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Gfspark::Config
 
   def try_url(args)
@@ -60,6 +61,11 @@ module Gfspark::Config
     MSG
     puts "  Options:"
     puts @opt_parse_obj.summarize
+    puts <<-MSG
+
+    -t option detail:
+#{Gfspark::Graph::RANGE_DEFS.map{|k,v| sprintf("      %3s : %s", k, v)}.join("\n")}
+    MSG
   end
 
   def parse_options(args)
@@ -102,6 +108,7 @@ module Gfspark::Config
     return YAML.load_file filename if File.exists? filename
   end
 
+  COLORS = [ :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
 
   def opt_parser
     OptionParser.new{|opts|
@@ -110,11 +117,13 @@ module Gfspark::Config
       opts.on('-u=USER',  '--user=USER'){|v| @options[:username] = v }
       opts.on('-p=PASS',  '--pass=PASS'){|v| @options[:password] = v }
       opts.on("-t=VALUE", "Range of Graph"){|v| @options[:t] = v}
-      opts.on("--from=VALUE", "Start date of graph.(2011/12/08 12:10:00) required if t=c or sc"){|v| @options[:from] = v}
-      opts.on("--to=VALUE", "End date of graph.(2011/12/08 12:10:00) required if t=c or sc"){|v| @options[:to] = v}
-      opts.on("-h=VALUE", "--height=VALUE", "graph height.(default 10"){|v| @options[:height] = v}
-      opts.on("-w=VALUE", "--width=VALUE", "graph width.(default is deteced from $COLUMNS"){|v| @options[:width] = v}
-      opts.on("-c=VALUE", "--color=VALUE", "Color of graph bar"){|v| @options[:color] = v}
+      opts.on("--gmode=VALUE", "graph mode: gauge or subtract (default is gauge)"){|v| @options[:gmode] = v}
+      opts.on("--from=VALUE", "Start date of graph (2011/12/08 12:10:00) required if t=c or sc"){|v| @options[:from] = v}
+      opts.on("--to=VALUE", "End date of graph (2011/12/08 12:10:00) required if t=c or sc"){|v| @options[:to] = v}
+      opts.on("-h=VALUE", "--height=VALUE", "graph height (default 10"){|v| @options[:height] = v}
+      opts.on("-w=VALUE", "--width=VALUE", "graph width (default is deteced from $COLUMNS)"){|v| @options[:width] = v}
+      opts.on("-c=VALUE", "--color=VALUE", "Color of graph bar (#{COLORS.join("/")})"){|v| @options[:color] = v if COLORS.include?(v.to_sym)}
+      opts.on("-n", "--non-fullwidth-font", "Show bar symbol as fullwidth"){ @options[:non_fullwidth_font] = true }
       opts.on("--sslnoverify", "don't verify SSL"){|v| @options[:sslNoVerify] = true}
       opts.on("--sslcacert=v", "SSL CA CERT"){|v| @options[:sslCaCert] = v}
       opts.on("--debug", "debug print"){@debug= true }

data/lib/gfspark/connection.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Gfspark::Connection
   @ssl_options = {}
 
@@ -14,7 +15,7 @@ module Gfspark::Connection
 
   def fetch_json(url, options = {}, params = {})
     response = send_request(url, {},options, params, :get)
-    raise response.code unless response_success?(response)
+    raise "#{response.code} #{response.msg}" unless response_success?(response)
     json = JSON.parse(response.body)
 
     if @debug

data/lib/gfspark/graph.rb

@@ -1,16 +1,27 @@
+# -*- coding: utf-8 -*-
 module Gfspark::Graph
   @height = 20
 
-  BARS = ["　",  "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" ]
-  def bar(val, unit)
+  BARS = ["  ",  "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" ]
+  def bar(val, unit, non_fullwidth_font = false)
     n = (val.to_f/unit).ceil
     @height.times.map{|i|
       x = n - (i * 8)
-      (x > 0) ?  (x < 8) ? BARS[x] : BARS.last : "　"
+      if x <= 0
+        BARS.first
+      else
+        bar_symbol = if x < 8
+          BARS[x]
+        else
+          BARS.last
+        end
+        bar_symbol += " " if non_fullwidth_font
+        bar_symbol
+      end
     }
   end
 
-  def render(json, summary)
+  def render(json, summary, url = nil)
     rows = json['rows']
     max = rows.flatten.compact.max
     max_val = (max / 8).ceil * 8
@@ -20,12 +31,14 @@ module Gfspark::Graph
     e = Time.at(json["end_timestamp"].to_i).strftime("%Y-%m-%d %H:%M:%S")
 
     puts "  #{blue(json["column_names"].first)}"
+    puts "    #{yellow(url)}"
     puts ""
     puts "    #{period_title}   #{s} - #{e}"
     puts ""
 
     result = []
-    rows.flatten.map{|row| bar(row, unit)}.transpose.reverse.each_with_index do |row, i|
+
+    rows.flatten.map{|row| bar(row, unit, @options[:non_fullwidth_font])}.transpose.reverse.each_with_index do |row, i|
       i = (@height- i)
       label = i.even? ? sprintf("%.1f", unit * i * 8) : ""
       line = row.join
@@ -43,30 +56,31 @@ module Gfspark::Graph
 
   def period_title
     case @options[:t]
-      when "c", "sc" then sprintf(RANGES[@options[:t]], @options[:from], @options[:to])
+      when "c", "sc" then sprintf("%s to %s", @options[:from], @options[:to])
       else RANGES[@options[:t]]
     end
   end
 
-  RANGES = {
-    "y"   => 'Year (1day avg)',
-    "m"   => 'Month (2hour avg)',
-    "w"   => 'Week (30min avg)',
-    "3d"  => '3 Days (5min avg)',
-    "s3d" => '3 Days (5min avg)',
-    "d"   => 'Day (5min avg)',
-    "sd"  => 'Day (1min avg)' ,
-    "8h"  => '8 Hours (5min avg)',
-    "s8h" => '8 Hours (1min avg)' ,
-    "4h"  => '4 Hours (5min avg)',
-    "s4h" => '4 Hours (1min avg)' ,
-    "h"   => 'Hour (5min avg), ',
-    "sh"  => 'Hour (1min avg)' ,
-    "n"   => 'Half Day (5min avg)',
-    "sn"  => 'Half Day (1min avg)',
-    "c"   => "%s to $s",
-    "sc"  => "%s to $s"
-  }
+  RANGE_DEFS = [
+    ["y"   , 'Year (1day avg)'],
+    ["m"   , 'Month (2hour avg)'],
+    ["w"   , 'Week (30min avg)'],
+    ["3d"  , '3 Days (5min avg)'],
+    ["s3d" , '3 Days (5min avg)'],
+    ["d"   , 'Day (5min avg)'],
+    ["sd"  , 'Day (1min avg)' ],
+    ["8h"  , '8 Hours (5min avg)'],
+    ["s8h" , '8 Hours (1min avg)' ],
+    ["4h"  , '4 Hours (5min avg)'],
+    ["s4h" , '4 Hours (1min avg)' ],
+    ["h"   , 'Hour (5min avg), '],
+    ["sh"  , 'Hour (1min avg)' ],
+    ["n"   , 'Half Day (5min avg)'],
+    ["sn"  , 'Half Day (1min avg)'],
+    ["c"   , "Custom (5min avg)"],
+    ["sc"  , "Custom (1min avg)"]
+  ]
+  RANGES = Hash[*RANGE_DEFS.flatten]
 
   def range_arg?(t)
     RANGES.keys.include? t

data/lib/gfspark/version.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Gfspark
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gfspark
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tomohito Ozaki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-28 00:00:00 +09:00
+date: 2013-05-29 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - Rakefile
 - bin/gfspark
 - gfspark.gemspec
+- images/gfspark_screenshot.png
 - lib/gfspark.rb
 - lib/gfspark/app.rb
 - lib/gfspark/config.rb