middleman-google_drive 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bf7956b153e220ffa3c09c0aaa15a06d72683df
-  data.tar.gz: f7b3ccb5e1bd511e070037bef2def79c27935f68
+  metadata.gz: 2857e937b68c10de7780fa28220f3d70e6953f29
+  data.tar.gz: a4c19ba124ac231e4795d86047d6c8a5aafd7786
 SHA512:
-  metadata.gz: 6cabc9eb4a1a5b3eb1b8486df8f5a9d98c4202223efcf74c4ed85e6f93c53bb0a34dad5b0b240a1c45ec2f0bcadf5f12d85c0296d934c8b7406a0ebeba8fda6b
-  data.tar.gz: aa172b233c0582022b8ec4233a69e8f0f4bc3e7066b1033de6632db662a79ad26ec734c1da73962268d038fe894b1c880c3313039871f51f91af3087f91a117a
+  metadata.gz: 27ebca38276d76f625c781204b68fed14ed387a204d1c7a9543b58bb35d020548dde02cb6d04198e90bd37d5f2dc0292ae56b4fc92008d5098cc555d52d46509
+  data.tar.gz: 4822b82da85d3ddc9e20d963170c5802267f54e81749acb185d0d1eb31bf8ccb5965200a3410b381e8acb4bc3cdd43884fca6fbbd1b9a048f297f34d5ec109c0

data/Rakefile

@@ -1,2 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rake/testtask'
+require 'rake/clean'
 
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run tests'
+task default: :test

data/lib/google_drive.rb

@@ -5,94 +5,65 @@ require 'google/api_client/auth/file_storage'
 require 'google/api_client/auth/installed_app'
 
 class GoogleDrive
+  attr_reader :client
   def initialize
-    credentials = ENV['GOOGLE_DRIVE_OAUTH'] || File.expand_path(
+    @credentials = ENV['GOOGLE_DRIVE_OAUTH'] || File.expand_path(
       '~/.google_drive_oauth2.json')
-    client_secrets = ENV['GOOGLE_CLIENT_SECRETS'] || File.expand_path(
+    @client_secrets = ENV['GOOGLE_CLIENT_SECRETS'] || File.expand_path(
       '~/.google_client_secrets.json')
 
-    person = ENV['GOOGLE_OAUTH_PERSON']
-    issuer = ENV['GOOGLE_OAUTH_ISSUER']
-    key_path = ENV['GOOGLE_OAUTH_KEYFILE']
-    private_key = ENV['GOOGLE_OAUTH_PRIVATE_KEY']
+    @person = ENV['GOOGLE_OAUTH_PERSON']
+    @issuer = ENV['GOOGLE_OAUTH_ISSUER']
+    @key_path = ENV['GOOGLE_OAUTH_KEYFILE']
+    @private_key = ENV['GOOGLE_OAUTH_PRIVATE_KEY']
 
     # try to read the file,
     # throw errors if not readable or not found
-    if key_path
-      key = Google::APIClient::KeyUtils.load_from_pkcs12(
-        key_path, 'notasecret')
+    if @key_path
+      @key = Google::APIClient::KeyUtils.load_from_pkcs12(
+        @key_path, 'notasecret')
     elsif @private_key
-      key = OpenSSL::PKey::RSA.new(
-        private_key, 'notasecret')
+      @key = OpenSSL::PKey::RSA.new(
+        @private_key, 'notasecret')
     end
 
-    if key
-      @client = Google::APIClient.new(
-        application_name: 'Middleman',
-        application_version: Middleman::GoogleDrive::VERSION,
-        authorization: Signet::OAuth2::Client.new(
-          token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
-          audience: 'https://accounts.google.com/o/oauth2/token',
-          person: person,
-          issuer: issuer,
-          signing_key: key,
-          scope: ['https://www.googleapis.com/auth/drive']
-        )
-      )
-      @client.authorization.fetch_access_token!
-    else
-      @client = Google::APIClient.new(
-        application_name: 'Middleman',
-        application_version: Middleman::GoogleDrive::VERSION
-      )
-      begin
-        file_storage = Google::APIClient::FileStorage.new(credentials)
-      rescue URI::InvalidURIError
-        File.delete credentials
-        file_storage = Google::APIClient::FileStorage.new(credentials)
-      end
-      if file_storage.authorization.nil?
-        unless File.exist? client_secrets
-          fail ConfigurationError, 'You need to create a client_secrets.json file and save it to ~/.google_client_secrets.json.'
-        end
-        puts 'Please login via your web browser'
-        client_secrets = Google::APIClient::ClientSecrets.load(client_secrets)
-        flow = Google::APIClient::InstalledAppFlow.new(
-          client_id: client_secrets.client_id,
-          client_secret: client_secrets.client_secret,
-          scope: ['https://www.googleapis.com/auth/drive']
-        )
-        @client.authorization = flow.authorize(file_storage)
-      else
-        @client.authorization = file_storage.authorization
-      end
-    end
+    @_files = {}
+    @_spreadsheets = {}
+
+    do_auth
   end
 
-  def get_sheet(key)
-    require 'roo'
-    # setup the hash that we will eventually return
-    data = {}
+  def find(key)
+    return @_files[key] unless @_files[key].nil?
+
     drive = @client.discovered_api('drive', 'v2')
 
     # get the file metadata
-    list_resp = @client.execute(
+    resp = @client.execute(
       api_method: drive.files.get,
       parameters: { fileId: key })
 
     # die if there's an error
-    fail list_resp.error_message if list_resp.error?
+    fail GoogleDriveError, resp.error_message if resp.error?
+
+    @_files[key] = resp.data
+  end
+
+  def spreadsheet(key)
+    require 'roo'
+
+    list_resp = find(key)
 
     # Grab the export url. We're gonna request the spreadsheet
     # in excel format. Because it includes all the worksheets.
-    uri = list_resp.data['exportLinks'][
+    uri = list_resp['exportLinks'][
       'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
 
     # get the export
     get_resp = @client.execute(uri: uri)
 
     # die if there's an error
-    fail get_resp.error_message if get_resp.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
@@ -101,10 +72,17 @@ class GoogleDrive
     fp.write get_resp.body
     fp.close
 
-    # now open the file with Roo. (Roo can't handle an IO
-    # object, it will only take filenames or urls, coulda done this all
-    # in memory, but alas...)
-    xls = Roo::Spreadsheet.open(filename)
+    # now open the file with Roo
+    ret = Roo::Spreadsheet.open(filename)
+
+    fp.unlink # delete our tempfile
+
+    ret
+  end
+
+  def prepared_spreadsheet(key)
+    xls = spreadsheet(key)
+    data = {}
     xls.each_with_pagename do |title, sheet|
       # if the sheet is called microcopy, copy or ends with copy, we assume
       # the first column contains keys and the second contains values.
@@ -126,15 +104,33 @@ class GoogleDrive
         end
       else
         # otherwise parse the sheet into a hash
-        sheet.header_line = 2 # this is stupid. theres a bug in Roo.
+        sheet.header_line = 2 # a bug in Roo.
         data[title] = sheet.parse(headers: true)
       end
     end
-    fp.unlink # delete our tempfile
     data
   end
 
-  def copy_doc(file_id, title=nil)
+  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)
+
+    # die if there's an error
+    fail GoogleDriveError, resp.error_message if resp.error?
+
+    resp.body
+  end
+
+  def copy(file_id, title = nil)
     drive = @client.discovered_api('drive', 'v2')
 
     if title.nil?
@@ -153,7 +149,74 @@ class GoogleDrive
       return { id: cp_resp.data['id'], url: cp_resp.data['alternateLink'] }
     end
   end
+  alias_method :copy_doc, :copy
+
+  def redo_auth
+    File.delete @credentials if @key.nil?
+    do_auth
+  end
+
+  def do_auth
+    if local?
+      @client = Google::APIClient.new(
+        application_name: 'Middleman',
+        application_version: Middleman::GoogleDrive::VERSION
+      )
+      begin
+        file_storage = Google::APIClient::FileStorage.new(@credentials)
+      rescue URI::InvalidURIError
+        File.delete @credentials
+        file_storage = Google::APIClient::FileStorage.new(@credentials)
+      end
+      if file_storage.authorization.nil?
+        unless File.exist? @client_secrets
+          fail ConfigurationError, 'You need to create a client_secrets.json file and save it to ~/.google_client_secrets.json.'
+        end
+        puts <<-MSG
+
+Please login via your web browser. We opened the tab for you...
+
+        MSG
+        client_secrets = Google::APIClient::ClientSecrets.load(@client_secrets)
+        flow = Google::APIClient::InstalledAppFlow.new(
+          client_id: client_secrets.client_id,
+          client_secret: client_secrets.client_secret,
+          scope: ['https://www.googleapis.com/auth/drive']
+        )
+        @client.authorization = flow.authorize(file_storage)
+      else
+        @client.authorization = file_storage.authorization
+      end
+    else
+      @client = Google::APIClient.new(
+        application_name: 'Middleman',
+        application_version: Middleman::GoogleDrive::VERSION,
+        authorization: Signet::OAuth2::Client.new(
+          token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
+          audience: 'https://accounts.google.com/o/oauth2/token',
+          person: @person,
+          issuer: @issuer,
+          signing_key: @key,
+          scope: ['https://www.googleapis.com/auth/drive']
+        )
+      )
+      @client.authorization.fetch_access_token!
+    end
+    nil
+  end
+
+  # Returns true if we're using a private key to autheticate (like on a server).
+  def server?
+    ! @key.nil?
+  end
+
+  # Returns true if we're using local oauth2 (like on your computer).
+  def local?
+    @key.nil?
+  end
 
-  class CreateError < Exception; end
-  class ConfigurationError < Exception; end
+  class GoogleDriveError < StandardError; end
+  class DoesNotExist < GoogleDriveError; end
+  class CreateError < GoogleDriveError; end
+  class ConfigurationError < GoogleDriveError; end
 end

data/lib/middleman-google_drive/extension.rb

@@ -12,9 +12,43 @@ module Middleman
 
         drive = ::GoogleDrive.new
 
-        app = klass.inst # where would you store the app instance?
+        app = klass.inst
+        app.set :drive, drive # so you can access the drive api directly
         options.load_sheets.each do |k, v|
-          app.data.store(k, drive.get_sheet(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
+
+              puts <<-MSG
+
+Could not load the Google Doc.
+
+Things to check:
+- Make sure the Google Doc key is correct
+- 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.
+
+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
         end
       end
     end

data/lib/middleman-google_drive/version.rb

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

data/middleman-google_drive.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'google-api-client', '>= 0.7.1'
   spec.add_runtime_dependency 'roo', '~> 1.13.2'
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '>= 10.3.2'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
 end

data/test/google_drive_test.rb

@@ -0,0 +1,50 @@
+require 'minitest/autorun'
+require 'google_drive'
+
+# Test the client lib!
+class TestChorusApiClient < MiniTest::Test
+  def setup
+    @drive = ::GoogleDrive.new
+  end
+
+  def test_old_find
+    file = @drive.find '0AiOYF21HkoowdEZ4Ukkyc09nb2czQUxUYldidTB4Q1E'
+    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'
+    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'
+  end
+
+  def test_new_doc
+    file = @drive.doc '1lH-Nr_8UBOkvk8OdcdFoDez3OFIJxkawGVkwlMB-BjQ'
+    assert_not_nil file =~ /^<html>/
+
+    file = @drive.doc '1lH-Nr_8UBOkvk8OdcdFoDez3OFIJxkawGVkwlMB-BjQ', 'text'
+    assert_nil file =~ /^<html>/
+  end
+
+  def test_copy_file
+  end
+
+  def assert_has_key(hash, key, msg=nil)
+    assert hash.key?(key), msg || "The key '#{key}' is missing from #{hash}"
+  end
+
+  def assert_not_nil(thing, msg=nil)
+    assert !thing.nil?, msg
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ryan Mark
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -73,14 +73,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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
@@ -100,6 +114,7 @@ files:
 - lib/middleman-google_drive/version.rb
 - lib/middleman_extension.rb
 - middleman-google_drive.gemspec
+- test/google_drive_test.rb
 homepage: https://github.com/voxmedia/middleman-google_drive
 licenses:
 - BSD
@@ -120,8 +135,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Pull content from a google spreadsheet to use in your middleman site.
-test_files: []
+test_files:
+- test/google_drive_test.rb