gdata-backup 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+/bin/stubs
+/.bundle
+/Gemfile.lock
+/pkg/
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/README.md

@@ -0,0 +1,53 @@
+gdata-backup
+============
+Make a local copy of Google Docs via the command line.
+
+This program makes it easy to download your Google Docs for backup, e.g. via a cron job.
+
+Installation
+============
+
+```
+bundle
+```
+
+Configuration
+=============
+This gem uses the imap-backup gem's command line inetrface to configure the GMail
+accounts that you want to back up. imap-backup is installed when you run bundle (above).
+
+```shell
+$ imap-backup setup
+```
+
+See the imap-backup README for fuller instructions.
+
+Usage
+=====
+
+```
+gdata-backup EMAIL DIRECTORY
+```
+
+Alternatives
+============
+
+There are various other applications available which download Google Docs:
+
+* You can download a zipped bundle from the Google Docs web interface,
+* There are some Open Source,
+* There are various commercial products.
+
+Open Source:
+
+* http://gdocs-backup.com/source
+* http://gs.fhtino.it/gdocbackup - .net/mono
+* http://1st-soft.net/gdd/ - greasemonkey
+
+Commercial:
+
+* http://www.backupgoo.com/en/index.html
+* http://www.workflow.ae/Google-Docs-Backup-Utility/
+* http://www.gladinet.com/
+* http://www.syncdocs.com/
+

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+

data/bin/gdata-backup

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path('../..', __FILE__)
+$: << File.join(root, 'lib')
+
+require 'gdata/backup'
+
+def usage
+  puts <<EOT
+Usage:
+  $ #{__FILE__} email@gmail.com destination_directory
+EOT
+end
+
+if ARGV.size < 2
+  usage
+  exit
+end
+
+@user, @path = ARGV
+
+Gdata::Backup.new(@user, @path).run
+

data/gdata-backup.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+load File.expand_path('lib/gdata/backup/version.rb', File.dirname(__FILE__))
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Joe Yates']
+  gem.email         = ['joe.g.yates@gmail.com']
+  gem.description   = 'Google Drive backup'
+  gem.summary       = <<-EOT
+Backup Google Drive documents as Open Document Format files.
+  EOT
+  gem.homepage      = 'https://github.com/joeyates/gdata-backup'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = 'gdata-backup'
+  gem.require_paths = ['lib']
+  gem.version       = Gdata::Backup::VERSION
+
+  gem.add_runtime_dependency 'gdata'
+  gem.add_runtime_dependency 'imap-backup'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-doc'
+  gem.add_development_dependency 'rspec'
+end
+

data/lib/gdata/backup.rb

@@ -0,0 +1,91 @@
+require 'gdata/client'
+require 'gdata/http'
+require 'gdata/auth'
+require 'logger'
+
+require 'imap/backup'
+
+module Gdata
+  class Backup
+    def initialize(account_username, path)
+      @path      = path
+      store      = Imap::Backup::Configuration::Store.new
+      @config    = store.data
+      @account   = @config[:accounts].find { |a| a[:username] == account_username }
+      raise 'account unknown' if @account.nil?
+      @log       = Logger.new(STDOUT)
+      @log.level = Logger::INFO
+    end
+
+    def run
+      raise "The supplied path '#{@path}' does not exist" unless File.directory?(@path) 
+      documents.each do |document|
+        @log.info document[:file_name]
+        begin
+          response = spreadsheet_client.get(document[:url])
+        rescue => e
+          @log.error "Download of #{document[:file_name]} failed: #{e}"
+          next
+        end
+        File.open(File.join(@path, document[:file_name]), 'wb' ) do |file|
+          file.write response.body
+        end
+      end
+    end
+
+    private
+
+    def documents
+      return @documents if @documents
+
+      doc = doc_list_client.get('https://docs.google.com/feeds/documents/private/full')
+      list = doc.to_xml
+
+      @documents = []
+      list.elements.each( 'entry' ) do | entry |
+        src    = entry.elements[ 'content' ].attributes[ 'src' ]
+        title  = entry.elements[ 'title' ].text
+        format = download_format( src, title )
+        if format == ''
+          @log.info "Skipping '#{title}'"
+          next
+        end
+        url         = src + '&exportFormat=' + format
+        clean_title = title.gsub(/[^a-z0-9\s\-\_]/i, '_')
+        file_name   = clean_title + '.' + format
+        @documents  << { :file_name => file_name,
+                         :url       => url }
+      end
+
+      @documents
+    end
+
+    def doc_list_client
+      return @doc_list_client if @doc_list_client
+      @doc_list_client = GData::Client::DocList.new
+      @doc_list_client.clientlogin(@account[:username], @account[:password])
+      @doc_list_client
+    end
+
+    def spreadsheet_client
+      return @spreadsheet_client if @spreadsheet_client
+      @spreadsheet_client = GData::Client::Spreadsheets.new
+      @spreadsheet_client.clientlogin(@account[:username], @account[:password])
+      @spreadsheet_client
+    end
+
+    def download_format( url, title )
+      case
+      when title =~ %r(\.pdf$)
+        ''
+      when url =~ %r(feeds/download/presentations)
+        ''
+      when url =~ /spreadsheets/
+        'ods'
+      else
+        'odt'
+      end
+    end
+  end
+end
+

data/lib/gdata/backup/version.rb

@@ -0,0 +1,9 @@
+module Gdata
+  class Backup
+    MAJOR    = 0
+    MINOR    = 0
+    REVISION = 1
+    VERSION  = [MAJOR, MINOR, REVISION].map(&:to_s).join('.')
+  end
+end
+

data/spec/download_spec.rb

@@ -0,0 +1,91 @@
+$: << '../lib'
+
+require 'gdata/download'
+require "rexml/document"
+
+describe Gdata::Download do
+  
+  def canned_doc_list_response
+    s = <<EOT
+<feed xmlns='http://www.w3.org/2005/Atom'>
+  <entry>
+     <title>Doc1</title>
+     <content src='https://docs.google.com/feeds/download/documents/export/Export?id=XXXXXXXX' type='text/html'/>
+  </entry>
+  <entry>
+     <title>Doc2</title>
+     <content src='https://docs.google.com/feeds/download/documents/export/Export?id=YYYYYYYY' type='text/html'/>
+  </entry>
+</feed>
+EOT
+    @rexml = REXML::Document.new(s)
+    stub('GData_HTTP_Response', :to_xml => @rexml.root)
+  end
+
+  context '#initialize' do
+    before :each do
+      @config = stub('Imap::Backup::Configuration::Store')
+      Imap::Backup::Configuration::Store.stub!(:new).and_return(@config)
+      @data = {:accounts => [{:username => 'account_username'}]}
+      @config.stub!(:data).and_return(@data)
+    end
+
+    it 'should load config' do
+      Imap::Backup::Configuration::Store.should_receive(:new).and_return(@config)
+      @config.should_receive(:data).and_return(@data)
+
+      Gdata::Download.new('account_username', '/a/path')
+    end
+
+    it 'should fail if the account is not configured' do
+      expect do
+        Gdata::Download.new('unknown_username', '/a/path')
+      end.to raise_error(/unknown/)
+    end
+
+  end
+
+  context '#documents' do
+
+    before :each do
+      @data = {:accounts => [{:username => 'jdoe@example.com', :password => 'secret'}]}
+      @config = stub('Imap::Backup::Configuration::Store', :data => @data)
+      Imap::Backup::Configuration::Store.stub!(:new).and_return(@config)
+      @doc_list_client = stub('GData::Client::DocList')
+      @doc_list_client.stub!(:clientlogin => true)
+      GData::Client::DocList.stub!(:new => @doc_list_client)
+      @doc_list_client.stub!(:get).
+                       with('https://docs.google.com/feeds/documents/private/full').
+                       and_return(canned_doc_list_response)
+    end
+
+    subject { Gdata::Download.new('jdoe@example.com', '/a/path') }
+
+    it 'should log in' do
+      @doc_list_client.           should_receive(:clientlogin).
+                                  with('jdoe@example.com', 'secret').
+                                  and_return(true)
+
+      subject.documents
+    end
+
+    it 'should list documents' do
+      @doc_list_client.           should_receive(:get).
+                                  and_return(canned_doc_list_response)
+
+      subject.documents
+    end
+
+    it 'should return document information' do
+      documents = subject.documents
+
+      documents.                  should == [{:file_name => 'Doc1.odt',
+                                              :url       => 'https://docs.google.com/feeds/download/documents/export/Export?id=XXXXXXXX&exportFormat=odt'},
+                                             {:file_name => 'Doc2.odt',
+                                              :url       => 'https://docs.google.com/feeds/download/documents/export/Export?id=YYYYYYYY&exportFormat=odt'}]
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: gdata-backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gdata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: imap-backup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Drive backup
+email:
+- joe.g.yates@gmail.com
+executables:
+- gdata-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/gdata-backup
+- gdata-backup.gemspec
+- lib/gdata/backup.rb
+- lib/gdata/backup/version.rb
+- spec/download_spec.rb
+homepage: https://github.com/joeyates/gdata-backup
+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'
+      segments:
+      - 0
+      hash: -2792609340228659123
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2792609340228659123
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Backup Google Drive documents as Open Document Format files.
+test_files:
+- spec/download_spec.rb
+has_rdoc: