google-image-charts 0.4.3

data/README.markdown

@@ -0,0 +1,90 @@
+# Google Image Charts
+
+Ruby library for interfacing with Google's Image Chart API. (Part of the Google Image Visualization API.)
+
+Google Image Charts allows a user to enter series data into a query string and retrieve a PNG or SVG image graph. See [http://code.google.com/apis/chart/image/](http://code.google.com/apis/chart/image/) for more information.
+
+Right now only Line Graphs and Pie Charts are supported. Let me know if you would like to contribute!
+
+## Installation
+
+	gem install google-image-charts
+
+## Line Graph Example
+### Code Sample
+	# Load the library
+	require 'google-image-charts.rb'
+	
+	# Populate the chart details
+	chartDetails = {
+		:title 	=> "Test chart",
+		:height => 250,
+		:width 	=> 400,
+		:data	=> [[4,5,10,6,2,9], [2,2,12,9,11,1]], # Array of data arrays (one for each line)
+		:labels	=> ["Series 1", "Series 2"]
+	}
+	
+	# Create the chart
+	lineGraph = GoogleImageCharts::LineGraph.new(chartDetails)
+	
+	# Use it!
+	chartUrl = lineGraph.chart_url
+	# => "http://chart.apis.google.com/chart?cht=lc&chs=400x250&chd=t:4,5,10,6,2,9%7C2,2,12,9,11,1&chdl=Series%201%7CSeries%202&chdlp=b&chtt=Test%20chart&chco=a&chds=a&chxt=x,y"
+	
+	imageTag = lineGraph.html_img_tag
+	# => "<img src='http://chart.apis.google.com/chart?cht=lc&chs=400x250&chd=t:4,5,10,6,2,9%7C2,2,12,9,11,1&chdl=Series%201%7CSeries%202&chdlp=b&chtt=Test%20chart&chco=a&chds=a&chxt=x,ycht=lc&chs=400x250&chd=t:4,5,10,6,2,9%7C2,2,12,9,11,1&chdl=Series%201%7CSeries%202&chdlp=b&chtt=Test%20chart&chco=a&chds=a&chxt=x,y' alt='Test chart' height='250' width='400' />"
+	
+	# Make it prettier
+	lineGraph.chartColors = ["5CB8E6","E68A00"]
+
+### Result
+<div align="center"><img src='http://chart.apis.google.com/chart?cht=lc&chs=400x250&chd=t:4,5,10,6,2,9%7C2,2,12,9,11,1&chdl=Series%201%7CSeries%202&chdlp=b&chtt=Test%20chart&chco=a&chds=a&chxt=x,ycht=lc&chs=400x250&chd=t:4,5,10,6,2,9%7C2,2,12,9,11,1&chdl=Series%201%7CSeries%202&chdlp=b&chtt=Test%20chart&chco=5CB8E6,E68A00&chds=a&chxt=x,y' alt='Test chart' height='250' width='400' /></div>
+
+## Pie Chart Example
+### Code Sample
+	# Load the library
+	require 'google-image-charts.rb'
+	
+	# Populate the chart details
+	chartDetails = {
+		:title 	=> "Pie Chart Test",
+		:height => 200,
+		:width 	=> 200,
+		:data	=> [15, 85], 
+		:labels	=> ["This Stinks!", "This is awesome!"],
+		:colors => ["5CB8E6","E68A00"]
+	}
+	
+	# Create the chart
+	pieChart = GoogleImageCharts::PieChart.new(chartDetails)
+	
+	# Use it!
+	chartUrl = pieChart.chart_url
+	# => "http://chart.apis.google.com/chart?cht=p&chs=200x200&chd=t:15,85&chdl=This%20Stinks!%7CThis%20is%20awesome!&chdlp=b&chtt=Pie%20Chart%20Test&chco=5CB8E6,E68A00&chds=a"
+	
+	imageTag = pieChart.html_img_tag
+	# => "<img src='http://chart.apis.google.com/chart?cht=p&chs=200x200&chd=t:15,85&chdl=This%20Stinks!%7CThis%20is%20awesome!&chdlp=b&chtt=Pie%20Chart%20Test&chco=5CB8E6,E68A00&chds=acht=p&chs=200x200&chd=t:15,85&chdl=This%20Stinks!%7CThis%20is%20awesome!&chdlp=b&chtt=Pie%20Chart%20Test&chco=5CB8E6,E68A00&chds=a' alt='Pie Chart Test' height='200' width='200' />"
+
+### Result
+<div align="center"><img src='http://chart.apis.google.com/chart?cht=p&chs=200x200&chd=t:15,85&chdl=This%20Stinks!%7CThis%20is%20awesome!&chdlp=b&chtt=Pie%20Chart%20Test&chco=5CB8E6,E68A00&chds=acht=p&chs=200x200&chd=t:15,85&chdl=This%20Stinks!%7CThis%20is%20awesome!&chdlp=b&chtt=Pie%20Chart%20Test&chco=5CB8E6,E68A00&chds=a' alt='Pie Chart Test' height='200' width='200' /></div>
+
+## Additional Options
+
+### Larger Charts
+As of 0.4 there is support for Google's POST method allowing up to 16K of data to be graphed. Simply set `:usePost = true` in your chartOptions hash and call `get_chart`. Be sure to set your content return type to PNG for this to work in a browser.
+
+### Additional Options
+There are plenty of features that this library does not yet make available. If you'd like to use the simplicity of the library, but pass in one of the additional features documented on [https://developers.google.com/chart/image/docs/chart_params](Google's Chart Feature List) you can now pass those as a string into your :additionalOptions element in the chartOptions hash.
+
+Each additional line element should be separated by an '&'
+
+	chartDetails = {
+		:title 	=> "Pie Chart Test",
+		:height => 200,
+		:width 	=> 200,
+		:data	=> [15, 85], 
+		:labels	=> ["This Stinks!", "This is awesome!"],
+		:colors => ["5CB8E6","E68A00"],
+		:additionalOptions => "&chls=5" #Makes the line bolder
+	}
+   

data/lib/GoogleImageCharts/line-graph.rb

@@ -0,0 +1,21 @@
+
+module GoogleImageCharts
+  class LineGraph < ChartBase
+    
+    def initialize(chartOptionsHash)
+      super(chartOptionsHash)
+      
+      @chartType = "lc" #Line chart
+      
+      @chartSpecificOptions += "&chds=a"      # Chart Scale (automatic scaling by Google)
+      @chartSpecificOptions += "&chxt=x,y"    # Scale labels for the X and Y axis'
+      
+    end
+    
+    def chartDataFlattened
+      # Line graphs are series arrays seperated by pipes
+      @chartData.join("|")
+    end
+
+  end
+end

data/lib/GoogleImageCharts/pie-chart.rb

@@ -0,0 +1,21 @@
+# Ref: http://code.google.com/apis/chart/image/docs/gallery/pie_charts.html
+
+module GoogleImageCharts
+  class PieChart < ChartBase
+    
+    def initialize(chartOptionsHash)
+      super(chartOptionsHash)
+      
+      @chartType = "p" # Pie chart
+      
+      @chartSpecificOptions << "&chds=a"      # Chart Scale (automatic scaling by Google)
+      
+    end
+    
+    def chartDataFlattened
+      # Pie Charts are simple data numbers seperated by commas
+      @chartData.join(",")
+    end
+
+  end
+end

data/lib/google-image-charts.rb

@@ -0,0 +1,132 @@
+require 'uri'
+
+module GoogleImageCharts  
+  
+  class ChartBase
+    attr_accessor :chartTitle, :chartWidth, :chartHeight, :chartLabels, :chartColors, :additionalChartOptions, :usePost
+    
+    CHART_URI_BASE = "http://chart.apis.google.com/chart?"
+    
+    def initialize(chartOptionsHash)
+      @chartSpecificOptions = ""  # Should be overridden by child-classes
+      
+      @chartWidth   = chartOptionsHash[:width]
+      @chartHeight  = chartOptionsHash[:height]
+      @chartTitle   = chartOptionsHash[:title]
+      self.chartData=(chartOptionsHash[:data])  # Should be an array of data arrays
+      
+      @chartLabels  = chartOptionsHash[:labels]  # Should be an array of labels
+      @chartLabelPosition  = "b" if chartOptionsHash[:labels].nil? == false
+      
+      @chartColors = chartOptionsHash[:colors]
+      
+      # These might be set by someone who knows what they are doing, perhaps after reading:
+      # https://developers.google.com/chart/image/docs/chart_params
+      @additionalChartOptions = chartOptionsHash[:additionalOptions]
+      
+      # Support the Google Image Charts POST method which allows up to 16K of chart data
+      # https://developers.google.com/chart/image/docs/post_requests
+      @usePost = chartOptionsHash[:usePost] #((chartOptionsHash[:usePost].nil? == true) || (@usePost != true)) ? false : true
+         
+    end
+    
+    def chartDataFlattened
+      # Override in subclasses
+      @chartData
+    end
+    
+    def chartData=(data)
+      # Take array of arrays and flatten to array of strings
+      
+      @chartData = Array.new
+      data.each_index do |index|
+        # Join the data only if it contains an array
+        if data[index].class == Array
+          @chartData.push data[index].join(",").to_s 
+        else
+          @chartData.push data[index]
+        end
+      end
+      
+    end
+    
+    def set_chart_label_position(position)
+      @chartLabelPosition = case
+                          when position == :top then "t"
+                          when position == :left then "l"
+                          when position == :right then "r"
+                          when position == :bottom then "b"
+                          else "b"
+                          end
+                            
+    end
+    
+    def get_chart
+      # returns a URL if usePost = false,
+      # returns a PNG if usePost = true. Pass your encoding to the browser as appropriate.
+      return @usePost == false ? chart_url : post_chart_data
+    end
+    
+    def chart_url
+      # Standard GET request
+      chartURL = CHART_URI_BASE
+      chartURL = chartURL + "cht="    + @chartType
+      chartURL = chartURL + "&chs="   + @chartWidth.to_s + "x" + @chartHeight.to_s 
+      chartURL = chartURL + "&chd=t:" + chartDataFlattened if @chartData.nil? == false # Simple text for now
+      chartURL = chartURL + "&chdl="  + @chartLabels.join("|")  if @chartLabels.nil? == false
+      chartURL = chartURL + "&chdlp="  + @chartLabelPosition    if @chartLabels.nil? == false
+      chartURL = chartURL + "&chtt="  + @chartTitle             if @chartTitle.nil? == false
+      chartURL = chartURL + "&chco="  + @chartColors.join(",")  if @chartColors.nil? == false
+      
+      chartURL = chartURL + @chartSpecificOptions + @additionalChartOptions
+      
+      return URI.escape(chartURL)
+    end
+    
+    def post_chart_data
+      # Used when you need to send more than 2K (up to 16K) of data to Google.
+      require 'net/https'
+      
+      uri = URI.parse("https://chart.googleapis.com/chart")
+
+      dataHash = {
+        "cht" => @chartType,
+        "chs" => @chartWidth.to_s + "x" + @chartHeight.to_s
+      }
+      
+      dataHash.merge!( (@chartData.nil? == false) ? {"chd" => "t:#{chartDataFlattened.to_s}" } : {} )
+      dataHash.merge!( (@chartLabels.nil? == false) ? {"chdl" => @chartLabels.join("|").to_s } : {} )
+      dataHash.merge!( (@chartLabels.nil? == false) ? {"chdlp" => @chartLabelPosition } : {}        )
+      dataHash.merge!( (@chartTitle.nil? == false) ? {"chtt" => @chartTitle } : {}                 )
+      dataHash.merge!( (@chartColors.nil? == false) ? {"chco" => @chartColors.join(",").to_s } : {} )
+      
+      #For the remainder of these, we need to split on '&', then k,v on '='
+      (@chartSpecificOptions.to_s + @additionalChartOptions.to_s).split('&').each do |option|
+        pair = option.split('=')
+        newElement = { pair[0].to_s => pair[1].to_s }
+        dataHash.merge!( newElement )
+      end
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data(dataHash)
+
+      response = http.request(request)
+      return response.body
+      
+    end
+    
+    def html_img_tag
+      return "<img src='#{chart_url}' alt='#{@chartTitle}' height='#{@chartHeight}' width='#{@chartWidth}' />"
+    end
+    
+  end
+  
+  # Load all the chart types
+  require 'GoogleImageCharts/line-graph.rb'
+  require 'GoogleImageCharts/pie-chart.rb'
+  
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: google-image-charts
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 3
+  version: 0.4.3
+platform: ruby
+authors: 
+- Christopher Brito
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-24 00:00:00 Z
+dependencies: []
+
+description: Simple Ruby library for interfacing with Google's Visualization API, specifically their Image Chart capability.
+email: cbrito@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/google-image-charts.rb
+- lib/GoogleImageCharts/line-graph.rb
+- lib/GoogleImageCharts/pie-chart.rb
+homepage: http://github.com/cbrito/google-image-charts
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby Library for interfacing with Google's Visualization API
+test_files: []
+