to_google_spreadsheet 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in to_google_spreadsheet.gemspec
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+# to_google_spreadsheet
+
+to_google_spreadsheet makes it trivial to populate a Google spreadsheet with an Array of Ruby objects.
+
+```ruby
+# Adds the users Bob and John to the default spreadsheet in the worksheet Employees
+[{:name => "Bob", :age => 26}, {:name => "John", :age => 28}].to_google_spreadsheet("Employees")
+```
+
+Results in:
+
+![Image of Google spreadsheets result once running above command](http://f.cl.ly/items/2O3w2k0Y410R3c3r3T1K/Screen%20shot%202011-06-27%20at%209.16.11%20.png)
+
+## Usage
+
+### Installation
+
+    $ gem install to_google_spreadsheet
+
+### Setup
+
+You must provide your Google Docs credentials, optionally you can supply a default spreadsheet to use:
+    
+```ruby
+module ToGoogleSpreadsheet
+  CREDENTIALS = ["account@company.com", "seekrit"]
+  DEFAULT_SPREADSHEET = "spreadsheet_key" # see note below
+end
+```
+
+The spreadsheet key is found in the URL when visiting the spreadsheet:
+
+![Image showing how the key is found in the URL in Google Docs](http://f.cl.ly/items/3j2q0S063j3v1I1P3x1p/Screen%20shot%202011-06-27%20at%209.24.56%20.png)
+
+### Usage
+
+`#to_google_spreadsheet` is simply a method defined on Array, thus any subclasses hereof should work with `to_google_spreadsheet` as expected. `Array#to_google_spreadsheet` takes two arguments:
+
+```ruby
+class Array
+  include ToGoogleSpreadsheet
+
+  def to_google_spreadsheet(worksheet, spreadsheet = nil)
+    session = GoogleSpreadsheet.login(*CREDENTIALS)
+    spreadsheet = session.spreadsheet_by_key(spreadsheet || DEFAULT_SPREADSHEET)
+    @ws = spreadsheet.find_or_create_worksheet_by_name(worksheet)
+    @ws.set_header_columns(self.first)
+    @ws.populate(self)
+    @ws.save
+  end
+end
+```
+
+The first argument is the name of the worksheet within the spreadsheet, e.g. "Accounts", if it doesn't already exist, it will be created. The second, optional, argument is the spreadsheet key, if it is not supplied, the default spreadsheet, defined by `ToGoogleSpreadsheet::DEFAULT_SPREADSHEET`, will be used.
+
+## Supported objects
+
+```ruby
+assert array.all? {|e| [OpenStruct,Hash,ActiveRecord::Base].any? { |type| e.kind_of?(type) }}  to a Google spreadsheet
+```
+
+I.e. anything that is `#kind_of? Hash`, an `OpenStruct` or an ActiveRecord model. It is [easy to add support for additional types][at].
+
+[at]: https://github.com/firmafon/to_google_spreadsheet/blob/master/lib/to_google_spreadsheet.rb#L40-44
+
+# License
+
+to_google_spreadsheet is released under the MIT license.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/to_google_spreadsheet.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'google_spreadsheet'
+require "./lib/to_google_spreadsheet/version"
+
+# get the openstruct attribute hash
+class OpenStruct
+  def _hash
+    @table
+  end
+end
+
+module GoogleSpreadsheet
+  class Spreadsheet
+    def find_or_create_worksheet_by_name(name)
+      worksheets.find {|ws| ws.title == name}
+      ws ||= add_worksheet(name) # create it if it doesn't exists
+      ws
+    end
+  end
+
+  class Worksheet
+    def set_header_columns(row)
+      get_hash_from_row(row).keys.each_with_index do |key, col_nr|
+        self[1, col_nr + 1] = key.to_s.capitalize
+      end
+    end
+
+    def populate(rows)
+      # TODO: Stop looping, put directly into the Google Spreadsheet hash
+      # provided by the Gem
+      # https://github.com/gimite/google-spreadsheet-ruby/blob/master/lib/google_spreadsheet.rb#L693-700
+      rows.each_with_index do |row, row_nr|
+        get_hash_from_row(row).each_with_index do |val, col_nr|
+          self[row_nr + 2, col_nr + 1] = val.last
+        end
+      end
+    end
+
+    private
+    def get_hash_from_row(row)
+      return row.attributes if row.respond_to?(:attributes) # ar
+      return row._hash if row.respond_to?(:_hash) # ostruct
+      row # fallback to handle hashes
+    end
+  end
+end
+
+class Array
+  include ToGoogleSpreadsheet
+
+  def to_google_spreadsheet(worksheet, spreadsheet = nil)
+    session = GoogleSpreadsheet.login(*CREDENTIALS)
+    spreadsheet = session.spreadsheet_by_key(spreadsheet || DEFAULT_SPREADSHEET)
+    @ws = spreadsheet.find_or_create_worksheet_by_name(worksheet)
+    @ws.set_header_columns(self.first)
+    @ws.populate(self)
+    @ws.save
+  end
+end

data/lib/to_google_spreadsheet/version.rb

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

data/test/test.rb

@@ -0,0 +1,28 @@
+require './lib/to_google_spreadsheet'
+
+# data = [
+#   {
+#     :name => "Niklas",
+#     :age => 23,
+#     :job => "Product designer"
+#   },
+#   {
+#     :name => "Simon",
+#     :age => 16,
+#     :job => "Developer"
+#   },
+#   {
+#     :name => "Peter",
+#     :age => 40,
+#     :job => "CEO"
+#   }
+# ]
+
+module ToGoogleSpreadsheet
+  CREDENTIALS = ["system-docs@firmafon.dk", "pinkpony42"]
+  DEFAULT_SPREADSHEET = "tA6lV1NLsBsDNuP_y8sISIw"
+end
+
+[{:name => "Bob", :age => 26}, {:name => "John", :age => 28}].to_google_spreadsheet("Employees")
+
+#data.to_google_spreadsheet("Employees")

data/to_google_spreadsheet.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "to_google_spreadsheet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "to_google_spreadsheet"
+  s.version     = ToGoogleSpreadsheet::VERSION
+  s.authors     = ["Simon H. Eskildsen"]
+  s.email       = ["sirup@sirupsen.com"]
+  s.homepage    = "https://github.com/firmafon/to_google_spreadsheet"
+  s.summary     = %q{Convert an Array where Array.all? {|e| [OpenStruct,Hash,ActiveRecord::Base].any? { |type| e.kind_of?(type) }} to a Google spreadsheet}
+  s.description = %q{Convert an Array where Array.all? {|e| [OpenStruct,Hash,ActiveRecord::Base].any? { |type| e.kind_of?(type) }} to a Google spreadsheet}
+
+  s.rubyforge_project = "to_google_spreadsheet"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_dependency "google-spreadsheet-ruby"
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: to_google_spreadsheet
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon H. Eskildsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: google-spreadsheet-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Convert an Array where Array.all? {|e| [OpenStruct,Hash,ActiveRecord::Base].any? { |type| e.kind_of?(type) }} to a Google spreadsheet
+email: 
+- sirup@sirupsen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/to_google_spreadsheet.rb
+- lib/to_google_spreadsheet/version.rb
+- test/test.rb
+- to_google_spreadsheet.gemspec
+has_rdoc: true
+homepage: https://github.com/firmafon/to_google_spreadsheet
+licenses: []
+
+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: to_google_spreadsheet
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Convert an Array where Array.all? {|e| [OpenStruct,Hash,ActiveRecord::Base].any? { |type| e.kind_of?(type) }} to a Google spreadsheet
+test_files: 
+- test/test.rb