middleman-google_drive 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2857e937b68c10de7780fa28220f3d70e6953f29
-  data.tar.gz: a4c19ba124ac231e4795d86047d6c8a5aafd7786
+  metadata.gz: c005b79314b36975007d1318e3d641d97447b3b2
+  data.tar.gz: a5c1ba67e4685638dd57f619c06d3aaa7c562c5c
 SHA512:
-  metadata.gz: 27ebca38276d76f625c781204b68fed14ed387a204d1c7a9543b58bb35d020548dde02cb6d04198e90bd37d5f2dc0292ae56b4fc92008d5098cc555d52d46509
-  data.tar.gz: 4822b82da85d3ddc9e20d963170c5802267f54e81749acb185d0d1eb31bf8ccb5965200a3410b381e8acb4bc3cdd43884fca6fbbd1b9a048f297f34d5ec109c0
+  metadata.gz: e4b75a88d830e8ba1f7605367da9427f2e5b2bdc2f754ba7c8b364a48e62774b9c4b1b4704e88bcb548dd5d409f3c54db903db87e44b36c52d0e9f3359f1c831
+  data.tar.gz: 376ab37406c05421ac306b2ea81980ad133101063fb5c43366f0ae61d0c948c43f1d90fdc9e251e3c17eab05ea695b8afcfea65d08ca4985948a6312d0f76ee7

data/README.md

@@ -21,19 +21,78 @@ Or install it yourself as:
 
 The extension will get loaded in automatically, you'll just need to activate it.
 
-    activate :google_drive, load_sheets: {
-        mysheet: google_spreadsheet_key,
-        moresheet: another_key
-    }
+```ruby
+activate :google_drive, load_sheets: {
+    mysheet: google_spreadsheet_key,
+    moresheet: another_key
+}
+```
 
 Then you can use the data in your templates:
 
-    <h1>My spreadsheet is called: <%= data.mysheet['title'] %></h1>
-    <% data.mysheet['Sheet1'].each do [row] %>
-        Column one header: <%= row['Column one header'] %>
-        Column two header: <%= row['Column two header'] %>
-        My column name: <%= row['My column name'] %>
-    <% end %>
+```erb
+<h1>My spreadsheet is called: <%= data.mysheet['title'] %></h1>
+<% data.mysheet['Sheet1'].each do [row] %>
+    Column one header: <%= row['Column one header'] %>
+    Column two header: <%= row['Column two header'] %>
+    My column name: <%= row['My column name'] %>
+<% end %>
+```
+
+You can also use a simplified Google Drive interface from inside your project, via the `drive`
+variable.
+
+```ruby
+# get metadata for a document
+doc_info = drive.find('google_document_key')
+
+# get the same spreadsheet data without using the load_sheets param above
+mysheet = drive.prepared_spreadsheet('google_document_key')
+
+# get a fancy spreadsheet object
+spreadsheet = drive.spreadsheet('google_document_key')
+```
+
+The fancy spreadsheet object comes from the [roo gem](https://github.com/Empact/roo). Unfortunately documentation is slim. Here is an example from the `roo` readme:
+
+```ruby
+spreadsheet.sheet('Info').row(1)
+spreadsheet.sheet(0).row(1)
+
+# use this to find the sheet with the most data to parse
+
+spreadsheet.longest_sheet
+
+# this file has multiple worksheets, let's iterate through each of them and process
+
+spreadsheet.each_with_pagename do |name, sheet|
+  p sheet.row(1)
+end
+
+# pull out a hash of exclusive column data (get rid of useless columns and save memory)
+
+spreadsheet.each(:id => 'UPC',:qty => 'ATS') {|hash| arr << hash}
+#=> hash will appear like {:upc=>727880013358, :qty => 12}
+
+# NOTE: .parse does the same as .each, except it returns an array (similar to each vs. map)
+
+# not sure exactly what a column will be named? try a wildcard search with the character *
+# regex characters are allowed ('^price\s')
+# case insensitive
+
+spreadsheet.parse(:id => 'UPC*SKU',:qty => 'ATS*\sATP\s*QTY$')
+
+# if you need to locate the header row and assign the header names themselves,
+# use the :header_search option
+
+spreadsheet.parse(:header_search => ['UPC*SKU','ATS*\sATP\s*QTY$'])
+#=> each element will appear in this fashion:
+#=> {"UPC" => 123456789012, "STYLE" => "987B0", "COLOR" => "blue", "QTY" => 78}
+
+# want to strip out annoying unicode characters and surrounding white space?
+
+spreadsheet.parse(:clean => true)
+```
 
 ## Setup
 

data/lib/google_drive.rb

@@ -151,9 +151,8 @@ class GoogleDrive
   end
   alias_method :copy_doc, :copy
 
-  def redo_auth
+  def clear_auth
     File.delete @credentials if @key.nil?
-    do_auth
   end
 
   def do_auth

data/lib/middleman-google_drive/extension.rb

@@ -5,32 +5,39 @@ module Middleman
   module GoogleDrive
     # Middle man extension that loads the google doc data
     class Extension < Middleman::Extension
-      option :load_sheets, {}, 'Hash of google spreadsheets to load. Hash value is the id or slug of the entry to load, hash key is the data attribute to load the sheet data into.'
+      option :load_sheets, {}, 'Key for a google spreadsheet or a hash of google spreadsheets to load. Hash value is the id or slug of the spreadsheet to load, hash key is the data attribute to load the sheet data into.'
 
       def initialize(klass, options_hash = {}, &block)
         super
 
-        drive = ::GoogleDrive.new
+        @drive = ::GoogleDrive.new
 
         app = klass.inst
-        app.set :drive, drive # so you can access the drive api directly
-        options.load_sheets.each do |k, v|
-          loop do
-            begin
-              app.data.store(k, drive.prepared_spreadsheet(v))
-              doc = drive.find(v)
-              puts <<-MSG
-== Loaded data.#{k} from Google Doc "#{doc['title']}"
-==   #{doc['alternateLink']}
-              MSG
-              break
-            rescue ::GoogleDrive::GoogleDriveError => exc
-              if drive.server?
-                puts "== FAILED to load Google Doc \"#{exc.message}\""
-                break
-              end
+        app.set :drive, @drive # so you can access the drive api directly
+        if options.load_sheets.is_a? String
+          load_doc(options.load_sheets).each do |name, sheet|
+            app.data.store(name, sheet)
+          end
+        else
+          options.load_sheets.each do |name, key|
+            app.data.store(name, load_doc(key))
+          end
+        end
+      end
 
-              puts <<-MSG
+      def load_doc(key)
+        data = @drive.prepared_spreadsheet(key)
+        doc = @drive.find(key)
+        puts <<-MSG
+== Loaded data from Google Doc "#{doc['title']}"
+==   #{doc['alternateLink']}
+        MSG
+        data
+      rescue ::GoogleDrive::GoogleDriveError => exc
+        if @drive.server?
+          puts "== FAILED to load Google Doc \"#{exc.message}\""
+        else
+          puts <<-MSG
 
 Could not load the Google Doc.
 
@@ -40,17 +47,11 @@ Things to check:
 - Make sure you have access to the document
 
 Google said "#{exc.message}." It might be a lie.
-
-Would you like to try again? [Y/n]
-              MSG
-              resp = $stdin.read 1
-              break unless resp.strip.empty? || resp =~ /[Yy]/
-
-              drive.redo_auth
-            end
-          end
+          MSG
+          @drive.clear_auth
         end
       end
+
     end
   end
 end

data/lib/middleman-google_drive/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module GoogleDrive
-    VERSION = '0.2.2'
+    VERSION = '0.2.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryan Mark
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core