middleman-google_drive 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b55941adf06f492ae066a183856e98b563a03b42
-  data.tar.gz: 20e2056fbdc0114d14c391de431d583fc9d1a88d
+  metadata.gz: f94ae0f5e1dc5cacb9af02dd286d77381b91081d
+  data.tar.gz: 5ee09f46e1fe604ff51319ec939be08a39b4015a
 SHA512:
-  metadata.gz: 310b40a38b5fb3c452b0e261476552b261ea7aa4a11349bb9f0e6716254323ef6fe92385a41205ec51c32b1642d6cd579fb65fd8e7696e065887616452b2acc3
-  data.tar.gz: 2ed85c7be3f9e6c9fb97bc28ea7bb406d4d4f3eeabf625b1c811e1908d6a41bb6634ec5c5f22838b8036429b2f26dc77a3e39ea6634d3fb913534f6589a408ae
+  metadata.gz: cf2289726d7874bbb5be981f93a9be956b2d653e9d1715432746ae1de28c384a0647405f4f7267900a65fcc094e38367e57676c28798bc17a177560e9d83fe8c
+  data.tar.gz: f51bd5d03f94478a74e7ff7dbfb0999f027ca63d66c89f1218cf92fc11ce838a8351978e4333a6ead3f98f6e4c36d9624c0c399a3ccc3f77f95439f8f53d51e2

data/README.md

@@ -1,5 +1,7 @@
 # Middleman::GoogleDrive
 
+[![Gem Version](https://badge.fury.io/rb/middleman-google_drive.svg)](http://badge.fury.io/rb/middleman-google_drive)
+
 This is an extension for Middleman that allows you to load data from a google
 spreadsheet into your template data.
 

data/lib/google_drive.rb

@@ -1,12 +1,25 @@
 require 'middleman-google_drive/version'
+require 'mime/types'
 require 'google/api_client'
 require 'google/api_client/client_secrets'
 require 'google/api_client/auth/file_storage'
 require 'google/api_client/auth/installed_app'
 require 'rubyXL'
 
+# Convience wrapper for Google Drive
+#
+# You can override the location of the client secrets and oauth2 JSON files with
+# the environment variables `GOOGLE_CLIENT_SECRETS` and `GOOGLE_DRIVE_OAUTH`.
+#
+# If you plan to run Middleman on a server, you can use Google's server to server
+# authentication. This will kick in if you define the environment variables
+# `GOOGLE_OAUTH_PERSON`, `GOOGLE_OAUTH_ISSUER` and either `GOOGLE_OAUTH_KEYFILE`
+# or `GOOGLE_OAUTH_PRIVATE_KEY`.
 class GoogleDrive
+  # Google API Client object
   attr_reader :client
+
+  # Constructor. Loads all params from envionment variables.
   def initialize
     @credentials = ENV['GOOGLE_DRIVE_OAUTH'] || File.expand_path(
       '~/.google_drive_oauth2.json')
@@ -34,29 +47,49 @@ class GoogleDrive
     do_auth
   end
 
-  def find(key)
-    return @_files[key] unless @_files[key].nil?
+  ## Friendly Google Drive access
+
+  # Find a Google Drive file
+  # Takes the key of a Google Drive file and returns a hash of meta data. The returned hash is
+  # formatted as a
+  # {Google Drive resource}[https://developers.google.com/drive/v2/reference/files#resource].
+  #
+  # @param file_id [String] file id
+  # @return [Hash] file meta data
+  def find(file_id)
+    return @_files[file_id] unless @_files[file_id].nil?
 
     drive = @client.discovered_api('drive', 'v2')
 
     # get the file metadata
     resp = @client.execute(
       api_method: drive.files.get,
-      parameters: { fileId: key })
+      parameters: { fileId: file_id })
 
     # die if there's an error
     fail GoogleDriveError, resp.error_message if resp.error?
 
-    @_files[key] = resp.data
+    @_files[file_id] = resp.data
   end
 
-  def spreadsheet(key)
-    list_resp = find(key)
+  # Export a file
+  # Returns the file contents
+  #
+  # @param file_id [String] file id
+  # @param type [:excel, :text, :html] export type
+  # @return [String] file contents
+  def export(file_id, type)
+    list_resp = find(file_id)
+
+    # decide which mimetype we want
+    mime = mime_for(type).content_type
 
-    # Grab the export url. We're gonna request the spreadsheet
-    # in excel format. Because it includes all the worksheets.
-    uri = list_resp['exportLinks'][
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
+    # Grab the export url.
+    if list_resp['exportLinks'] && list_resp['exportLinks'][mime]
+      uri = list_resp['exportLinks'][mime]
+    else
+      raise "Google doesn't support exporting file id #{file_id} to #{type}"
+    end
 
     # get the export
     get_resp = @client.execute(uri: uri)
@@ -64,23 +97,79 @@ class GoogleDrive
     # die if there's an error
     fail GoogleDriveError, get_resp.error_message if get_resp.error?
 
-    # get a temporary file. The export is binary, so open the tempfile in
-    # write binary mode
-    fp = Tempfile.new(['gdoc', '.xlsx'], binmode: true)
-    filename = fp.path
-    fp.write get_resp.body
-    fp.close
+    # contents
+    get_resp.body
+  end
 
-    # now open the file with spreadsheet
-    ret = RubyXL::Parser.parse(filename)
+  # Export a file and save to disk
+  # Returns the local path to the file
+  #
+  # @param file_id [String] file id
+  # @param type [:excel, :text, :html] export type
+  # @param filename [String] where to save the spreadsheet
+  # @return [String] path to the excel file
+  def export_to_file(file_id, type, filename = nil)
+    contents = export(file_id, type)
+
+    if filename.nil?
+      # get a temporary file. The export is binary, so open the tempfile in
+      # write binary mode
+      Tempfile.create(
+          ['googledoc', ".#{type}"],
+          binmode: mime_for(type.to_s).binary?) do |fp|
+        filename = fp.path
+        fp.write contents
+      end
+    else
+      open(filename, 'wb') { |fp| fp.write contents }
+    end
+    filename
+  end
 
-    fp.unlink # delete our tempfile
+  # Make a copy of a Google Drive file
+  #
+  # @param file_id [String] file id
+  # @param title [String] title for the newly created file
+  # @return [Hash] hash containing the id/key and url of the new file
+  def copy(file_id, title = nil, visibility = :private)
+    drive = @client.discovered_api('drive', 'v2')
 
-    ret
+    if title.nil?
+      copied_file = drive.files.copy.request_schema.new
+    else
+      copied_file = drive.files.copy.request_schema.new('title' => title)
+    end
+    cp_resp = @client.execute(
+      api_method: drive.files.copy,
+      body_object: copied_file,
+      parameters: { fileId: file_id, visibility: visibility.to_s.upcase })
+
+    if cp_resp.error?
+      fail CreateError, cp_resp.error_message
+    else
+      return { id: cp_resp.data['id'], url: cp_resp.data['alternateLink'] }
+    end
+  end
+  alias_method :copy_doc, :copy
+
+  # Get the mime type from a file extension
+  #
+  # @param extension [String] file ext
+  # @return [String, nil] mime type for the file
+  def mime_for(extension)
+    MIME::Types.of(extension.to_s).first
   end
 
-  def prepared_spreadsheet(key)
-    xls = spreadsheet(key)
+  ## Spreadsheet utilities
+
+  # Parse a spreadsheet
+  # Reduces the spreadsheet to a no-frills hash, suitable for serializing and passing around.
+  #
+  # @param filename [String] path to xls file
+  # @return [Hash] spreadsheet contents
+  def prepare_spreadsheet(filename)
+    # open the file with RubyXL
+    xls = RubyXL::Parser.parse(filename)
     data = {}
     xls.worksheets.each do |sheet|
       title = sheet.sheet_name
@@ -95,13 +184,16 @@ class GoogleDrive
         data[title] = load_table(sheet.extract_data)
       end
     end
-    data
+    return data
   end
 
   # Take a two-dimensional array from a spreadsheet and create a hash. The first
   # column is used as the key, and the second column is the value. If the key
   # occurs more than once, the value becomes an array to hold all the values
   # associated with the key.
+  #
+  # @param table [Array<Array>] 2d array of cell values
+  # @return [Hash] spreadsheet contents
   def load_microcopy(table)
     data = {}
     table.each_with_index do |row, i|
@@ -123,6 +215,9 @@ class GoogleDrive
   end
 
   # Take a two-dimensional array from a spreadsheet and create an array of hashes.
+  #
+  # @param table [Array<Array>] 2d array of cell values
+  # @return [Array<Hash>] spreadsheet contents
   def load_table(table)
     return [] if table.length < 2
     header = table.shift # Get the header row
@@ -132,50 +227,26 @@ class GoogleDrive
     end
   end
 
-  def doc(key, format = 'html')
-    doc = find(key)
-
-    # Grab the export url.
-    if format.to_s == 'html'
-      uri = doc['exportLinks']['text/html']
-    else
-      uri = doc['exportLinks']['text/plain']
-    end
-
-    # get the export
-    resp = @client.execute(uri: uri)
+  ## Authentication
 
-    # die if there's an error
-    fail GoogleDriveError, resp.error_message if resp.error?
-
-    resp.body
+  # Returns true if we're using a private key to autheticate (like on a server).
+  # @return [Boolean]
+  def server?
+    !local?
   end
 
-  def copy(file_id, title = nil)
-    drive = @client.discovered_api('drive', 'v2')
-
-    if title.nil?
-      copied_file = drive.files.copy.request_schema.new
-    else
-      copied_file = drive.files.copy.request_schema.new('title' => title)
-    end
-    cp_resp = @client.execute(
-      api_method: drive.files.copy,
-      body_object: copied_file,
-      parameters: { fileId: file_id, visibility: 'PRIVATE' })
-
-    if cp_resp.error?
-      fail CreateError, cp_resp.error_message
-    else
-      return { id: cp_resp.data['id'], url: cp_resp.data['alternateLink'] }
-    end
+  # Returns true if we're using local oauth2 (like on your computer).
+  # @return [Boolean]
+  def local?
+    @key.nil?
   end
-  alias_method :copy_doc, :copy
 
+  # Delete cached credentials
   def clear_auth
     File.delete @credentials if @key.nil?
   end
 
+  # Authenticate with Google and create the @client object
   def do_auth
     if local?
       @client = Google::APIClient.new(
@@ -225,16 +296,6 @@ Please login via your web browser. We opened the tab for you...
     nil
   end
 
-  # Returns true if we're using a private key to autheticate (like on a server).
-  def server?
-    !local?
-  end
-
-  # Returns true if we're using local oauth2 (like on your computer).
-  def local?
-    @key.nil?
-  end
-
   class GoogleDriveError < StandardError; end
   class DoesNotExist < GoogleDriveError; end
   class CreateError < GoogleDriveError; end

data/lib/middleman-google_drive/extension.rb

@@ -18,10 +18,10 @@ module Middleman
 
         @app = klass.inst
 
-        handle_option(options.load_sheets, 'spreadsheet')
-        handle_option(options.load_docs, 'text')
-        handle_option(options.load_docs_html, 'html')
-        handle_option(options.load_docs_archieml, 'archieml')
+        handle_option(options.load_sheets, :xlsx)
+        handle_option(options.load_docs, :txt)
+        handle_option(options.load_docs_html, :html)
+        handle_option(options.load_docs_archieml, :archieml)
       end
 
       def handle_option(option, type)
@@ -29,25 +29,54 @@ module Middleman
           option.each do |name, key|
             store_data(name, load_doc(key.to_s, type))
           end
-        elsif type == 'spreadsheet'
+        elsif type == :xlsx
           load_doc(option.to_s, type).each do |name, sheet|
             store_data(name, sheet)
           end
         else
           store_data('doc', load_doc(option.to_s, type))
         end
-      rescue ::Faraday::ConnectionFailed => exc
-        if @drive.server?
-          puts "== FAILED to load Google Doc \"#{exc.message}\""
+      end
+
+      def load_doc(key, type)
+        doc = @drive.find(key)
+        puts <<-MSG
+== Loading data from Google Doc "#{doc['title']}"
+==   #{doc['alternateLink']}
+        MSG
+        filename = data_path("#{key}.#{type}")
+
+        case type.to_sym
+        when :xlsx
+          if @drive.server?
+            filename = @drive.export_to_file(key, :xlsx)
+          else
+            @drive.export_to_file(key, :xlsx, filename)
+          end
+          ret = @drive.prepare_spreadsheet(filename)
+          File.unlink(filename) if @drive.server?
+        when :archieml
+          if @drive.server?
+            ret = Archieml.load(@drive.export(key, :txt))
+          else
+            @drive.export_to_file(key, :txt, filename)
+            ret = Archieml.load(File.read(filename))
+          end
         else
-          puts <<-MSG
-== Could not connect to Google Drive. Local data will be used.
-MSG
+          if @drive.server?
+            ret = @drive.export(key, type)
+          else
+            @drive.export_to_file(key, type, filename)
+            ret = File.read(filename)
+          end
         end
+        return ret
+      rescue ::Faraday::ConnectionFailed => exc
+        puts "== FAILED to load Google Doc \"#{exc.message}\""
+        return load_local_copy(filename)
       rescue ::GoogleDrive::GoogleDriveError => exc
-        if @drive.server?
-          puts "== FAILED to load Google Doc \"#{exc.message}\""
-        else
+        puts "== FAILED to load Google Doc \"#{exc.message}\""
+        unless @drive.server?
           puts <<-MSG
 
 Could not load the Google Doc.
@@ -57,36 +86,35 @@ Things to check:
 - Make sure you're logging in with the correct account
 - Make sure you have access to the document
 
-Google said "#{exc.message}." It might be a lie.
           MSG
           @drive.clear_auth
         end
+        return load_local_copy(filename)
       end
 
-      def load_doc(key, type)
-        case type.to_s
-        when 'spreadsheet'
-          data = @drive.prepared_spreadsheet(key)
-        when 'html'
-          data = @drive.doc(key, 'html')
-        when 'archieml'
-          data = Archieml.load(@drive.doc(key, 'text'))
+      def load_local_copy(filename)
+        if File.exist? filename
+          puts '== Loading Google Doc from local cache'
+          type = File.extname(filename).gsub('.','').to_sym
+          case type
+          when :xlsx
+            return @drive.prepare_spreadsheet(filename)
+          when :archieml
+            return Archieml.load(File.read(filename))
+          else
+            return File.read(filename)
+          end
         else
-          data = @drive.doc(key, 'text')
+          puts '== No local copy of Google Doc'
+          return nil
         end
-        doc = @drive.find(key)
-        puts <<-MSG
-== Loaded data from Google Doc "#{doc['title']}"
-==   #{doc['alternateLink']}
-        MSG
-        data
+      end
+
+      def data_path(basename)
+        File.join(@app.root, @app.data_dir, basename)
       end
 
       def store_data(key, data)
-        backup_file = File.join(@app.root, @app.data_dir, "#{key}.json")
-        File.open(backup_file, 'w') do |f|
-          f.write(JSON.pretty_generate(data))
-        end
         @app.data.store(key, data)
       end
     end

data/lib/middleman-google_drive/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module GoogleDrive
-    VERSION = '0.3.4'
+    VERSION = '0.3.5'
   end
 end

data/middleman-google_drive.gemspec

@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'middleman-core', '~> 3'
   spec.add_runtime_dependency 'retriable', '~> 1.4'
   spec.add_runtime_dependency 'google-api-client', '< 0.8'
-  spec.add_runtime_dependency 'rubyXL'
-  spec.add_runtime_dependency 'archieml'
+  spec.add_runtime_dependency 'rubyXL', '~> 3.3.7'
+  spec.add_runtime_dependency 'archieml', '~> 0.1.1'
+  spec.add_runtime_dependency 'mime-types', '~> 2.4.3'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'yard'
 end

data/test/google_drive_test.rb

@@ -1,40 +1,58 @@
 require 'minitest/autorun'
+require 'fileutils'
 require 'google_drive'
 
 # Test the client lib!
-class TestChorusApiClient < MiniTest::Test
+class TestGoogleDrive < MiniTest::Test
   def setup
     @drive = ::GoogleDrive.new
+    @old_sheet_file_id = '0AiOYF21HkoowdEZ4Ukkyc09nb2czQUxUYldidTB4Q1E'
+    @new_sheet_file_id = '1vIICbbfHJ8lYSthiDWTNypZulrMResi9zPRjv4ePJJU'
+    @doc_file_id = '1lH-Nr_8UBOkvk8OdcdFoDez3OFIJxkawGVkwlMB-BjQ'
   end
 
-  def test_old_find
-    file = @drive.find '0AiOYF21HkoowdEZ4Ukkyc09nb2czQUxUYldidTB4Q1E'
+  def test_find
+    file = @drive.find @old_sheet_file_id
     assert_equal file['title'], 'Example Middleman Google Drive worksheet'
-  end
-
-  def test_old_prepared_spreadsheet
-    file = @drive.prepared_spreadsheet '0AiOYF21HkoowdEZ4Ukkyc09nb2czQUxUYldidTB4Q1E'
-    assert_has_key file, 'microcopy'
-    assert_has_key file['microcopy'], 'help'
-  end
 
-  def test_new_find
-    file = @drive.find '1vIICbbfHJ8lYSthiDWTNypZulrMResi9zPRjv4ePJJU'
+    file = @drive.find @new_sheet_file_id
     assert_equal file['title'], 'Example Middleman Google Drive worksheet'
   end
 
-  def test_new_prepared_spreadsheet
-    file = @drive.prepared_spreadsheet '1vIICbbfHJ8lYSthiDWTNypZulrMResi9zPRjv4ePJJU'
-    assert_has_key file, 'microcopy'
-    assert_has_key file['microcopy'], 'help'
+  def test_export
+    content = @drive.export @doc_file_id, :txt
+    assert_nil content =~ /^<html>/
+
+    content = @drive.export @doc_file_id, :html
+    assert_not_nil content =~ /^<html>/
   end
 
-  def test_new_doc
-    file = @drive.doc '1lH-Nr_8UBOkvk8OdcdFoDez3OFIJxkawGVkwlMB-BjQ'
-    assert_not_nil file =~ /^<html>/
+  def test_export_to_file
+    filename = @drive.export_to_file(@doc_file_id, :html)
+    assert_equal '.html', File.extname(filename)
+    assert File.exist?(filename)
+    assert_not_nil File.read(filename) =~ /^<html>/
+    File.unlink(filename)
+
+    [@new_sheet_file_id, @old_sheet_file_id].each do |file_id|
+      filename = @drive.export_to_file(file_id, :xlsx)
+      assert_equal '.xlsx', File.extname(filename)
+      assert File.exist?(filename)
+      File.unlink(filename)
+    end
+  end
 
-    file = @drive.doc '1lH-Nr_8UBOkvk8OdcdFoDez3OFIJxkawGVkwlMB-BjQ', 'text'
-    assert_nil file =~ /^<html>/
+  def test_prepare_spreadsheet
+    [@old_sheet_file_id, @new_sheet_file_id].each do |file_id|
+      #filename = "/tmp/google_drive_#{file_id}.xlsx"
+      filename = @drive.export_to_file(file_id, :xlsx, filename)
+      assert_equal '.xlsx', File.extname(filename)
+      assert File.exist?(filename)
+      data = @drive.prepare_spreadsheet(filename)
+      assert_has_key data, 'microcopy'
+      assert_has_key data['microcopy'], 'help'
+      File.unlink(filename)
+    end
   end
 
   def test_copy_file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ryan Mark
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -57,30 +57,44 @@ dependencies:
   name: rubyXL
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.7
 - !ruby/object:Gem::Dependency
   name: archieml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ryan@mrk.cc