to_google_spreadsheet 0.0.6 → 0.1.0

data/README.md

@@ -28,36 +28,40 @@ Account.all.to_google_spreadsheet("Accounts")
 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
+GoogleSpreadsheet.config do |c|
+  c.email               = "user@company.com"
+  c.password            = "seekrit"
+
+  # optional, see note below on how to obtain a spreadsheet key
+  c.default_spreadsheet = "spreadsheet_key"
 end
 ```
 
+### Obtaining your spreadsheet key
+
 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:
+`#to_google_spreadsheet` is simply a method defined on Enumerable, thus any subclasses hereof should work with `to_google_spreadsheet` as expected (e.g. Arrays). `Enumerable#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
+module Enumerable
+  def to_google_spreadsheet(worksheet, spreadsheet = GoogleSpreadsheet::Config.default_spreadsheet)
+    session = GoogleSpreadsheet.login(GoogleSpreadsheet::Config.email, 
+                                      GoogleSpreadsheet::Config.password)
+    spreadsheet = session.spreadsheet_by_key(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.
+The first argument being 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 (see Obtaining your spreadsheet key above), if it is not supplied, the default spreadsheet, defined by in the configuration will be used.
 
 ## Supported objects
 

data/lib/to_google_spreadsheet/version.rb

@@ -1,3 +1,3 @@
 module ToGoogleSpreadsheet
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/to_google_spreadsheet.rb

@@ -10,6 +10,16 @@ class OpenStruct
 end
 
 module GoogleSpreadsheet
+  def self.config
+    yield GoogleSpreadsheet::Config
+  end
+
+  module Config
+    extend self
+
+    attr_accessor :email, :password, :default_spreadsheet
+  end
+
   class Spreadsheet
     def find_or_create_worksheet_by_name(name)
       ws = worksheets.find {|ws| ws.title == name}
@@ -51,11 +61,10 @@ module GoogleSpreadsheet
 end
 
 module Enumerable
-  include ToGoogleSpreadsheet
-
-  def to_google_spreadsheet(worksheet, spreadsheet = nil)
-    session = GoogleSpreadsheet.login(*CREDENTIALS)
-    spreadsheet = session.spreadsheet_by_key(spreadsheet || DEFAULT_SPREADSHEET)
+  def to_google_spreadsheet(worksheet, spreadsheet = GoogleSpreadsheet::Config.default_spreadsheet)
+    session = GoogleSpreadsheet.login(GoogleSpreadsheet::Config.email, 
+                                      GoogleSpreadsheet::Config.password)
+    spreadsheet = session.spreadsheet_by_key(spreadsheet)
     ws = spreadsheet.find_or_create_worksheet_by_name(worksheet)
     ws.set_header_columns(self.first)
     ws.populate(self)

data/test/test.rb

@@ -18,11 +18,14 @@ require 'to_google_spreadsheet'
 #   }
 # ]
 
-module ToGoogleSpreadsheet
-  CREDENTIALS = ["system-docs@firmafon.dk", "pinkpony42"]
-  DEFAULT_SPREADSHEET = "tA6lV1NLsBsDNuP_y8sISIw"
+GoogleSpreadsheet.config do |c|
+  c.email               = "dummy"
+  c.password            = "seekrit"
+  c.default_spreadsheet = "0Agovhaw3pUnDdERZT3oyemlQY2JUaGJjQWNhb0Q3b2c"
 end
 
+p GoogleSpreadsheet::Config.email
+
 [{:name => "Bob", :age => 26}, {:name => "John", :age => 28}].to_google_spreadsheet("Employees")
 
 #data.to_google_spreadsheet("Employees")

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: to_google_spreadsheet
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Simon H. Eskildsen
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 +02:00
+date: 2011-07-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -40,9 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -79,23 +68,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: to_google_spreadsheet
-rubygems_version: 1.5.2
+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