langrove-plugin-google 0.1

data/.rvmrc

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.2" > .rvmrc
+environment_id="ruby-1.9.2-p318@langrove-test"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.12.3 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,15 @@
+source :gemcutter
+source "http://rubygems.org"
+
+group :development do
+  
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'guard'
+  gem 'em-rspec'
+
+end
+
+gem 'google_drive'
+
+gem 'langrove', :git => "git@github.com:cluetechnologies/langrove-enterprise.git", :branch => "master"

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GIT
+  remote: git@github.com:cluetechnologies/langrove-enterprise.git
+  revision: 0ef1dd1e662b80a378d09e1355f5d20c9cf28a4d
+  branch: master
+  specs:
+    langrove (0.0.5.2)
+      awesome_print
+      daemon-kit
+      em-http-request
+      em-websocket
+      eventmachine
+      eventmachine_httpserver
+
+GEM
+  remote: http://rubygems.org/
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    awesome_print (1.0.2)
+    daemon-kit (0.1.8.2)
+      eventmachine (>= 0.12.10)
+      safely (>= 0.3.1)
+    diff-lcs (1.1.3)
+    em-http-request (0.3.0)
+      addressable (>= 2.0.0)
+      escape_utils
+      eventmachine (>= 0.12.9)
+    em-rspec (0.1.1)
+      eventmachine (>= 0.12.10)
+    em-websocket (0.3.8)
+      addressable (>= 2.1.1)
+      eventmachine (>= 0.12.9)
+    escape_utils (0.2.4)
+    eventmachine (0.12.10)
+    eventmachine_httpserver (0.2.1)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    ffi (1.1.1)
+    google_drive (0.3.1)
+      nokogiri (>= 1.4.4, != 1.5.2, != 1.5.1)
+      oauth (>= 0.3.6)
+      oauth2 (>= 0.5.0)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.0)
+      guard (>= 1.1)
+    httpauth (0.1)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    nokogiri (1.5.5)
+    oauth (0.4.6)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    rack (1.4.1)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    safely (0.3.2)
+    thor (0.15.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-rspec
+  google_drive
+  guard
+  guard-rspec
+  langrove!
+  rspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec',
+
+  :cli => "--color",
+  :all_on_start => false,
+  :all_after_pass => false,
+  :spec_paths => ['spec'] do
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+
+end

data/README.md

@@ -0,0 +1,90 @@
+`Plugin::Google`
+=========================
+
+* Intergates GoogleSpreadsheet support into the [LanGrove](https://github.com/cluetechnologies/langrove-enterprise) persistance layer.
+
+`gem install langrove-plugin-google`
+
+
+Implements 
+----------
+
+* [`LanGrove::Plugin::BufferedPersistor`](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin#persistor)
+
+
+Supports
+---------
+
+* [`LanGrove::Behaviour::Persistable`](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour#persistable)
+
+
+Caveats
+-------
+
+* Only performs updates to SpreadSheet at specified intervals.
+* Updates by row number, a sort that reorders rows while an update is in progress may cause perculiarities
+* Done as an experiment (may not function all that terrifically)
+
+Benefits
+--------
+
+* Updates columns by name, additional columns not in the capsule will not be affected.
+
+
+Example
+-------
+
+### Configuring the plugin.
+
+<pre>
+	...
+
+	:plugins:
+		:a_google_doc:
+			#
+			# reality may differ (unimplemented)
+			#
+			:class: GoogleSpreadsheet
+			:google_key: 0Ak66wsrXSMqjdEV
+			:username: can_edit@gmail.com
+			:password: passrod
+
+			#
+			# Buffered: calls to store() accumulate
+			# and a batched update runs at the
+			# specified interval (seconds)
+			#
+			:interval: 600
+
+			#
+			# Column name containing row key
+			#
+			:key: 
+				:key_column_name: :key_column_name
+
+	...
+
+</pre>
+
+### Assigning the plugin to a daemon.
+
+<pre>
+
+	...
+
+	:server:
+		:behavior:
+			:persistable:
+				:plugin: :a_google_doc
+				:at:
+					:handler_after_receive: 
+					#
+					# will default to storing the caspsule 
+					# after the Handler.receive( data )
+					# method returns.
+					#
+
+	...
+
+</pre>
+

data/langrove-google-plugin.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift 'lib'
+
+Gem::Specification.new do |spec|
+  spec.name = %q{langrove-plugin-google}
+  spec.version = '0.1' 
+  spec.date = DateTime.now.strftime( "%Y-%m-%d" )
+  spec.authors = ["","","","","","","","Richard"]
+  spec.email = %q{ops@clue.co.za}
+  spec.summary = %q{GoogleDoc Spreadsheet LanGrove Persistor}
+  spec.homepage = %q{}
+  spec.description = %q{}
+  spec.add_dependency 'langrove'
+  spec.add_dependency 'google_drive'
+  spec.files = `git ls-files`.strip.split("\n")
+end

data/lib/langrove/plugin/google.rb

@@ -0,0 +1,5 @@
+# bundler looks for this by default
+
+require 'langrove' unless defined?( LanGrove::Plugin )
+require 'google_drive'
+require 'plugin/google_sheet'

data/lib/plugin/discovery.rb

@@ -0,0 +1,122 @@
+require 'google_drive'
+require 'awesome_print'
+
+module Plugin
+
+  #
+  # 2000+ rows:
+  # 
+  #      Timeout::Error:
+  #      Timeout::Error
+  #
+
+  #
+  # Impractical for high frequency single row updates
+  # 
+  # Can ony reference cells by column and row number
+  # 
+  # Will need a key column to allow for sorting 
+  # (to not break updates expecting certain records in certain rows) 
+  # 
+  # 
+  # Not ENTIRELY compatable as a LanGrove Persistor...
+  # 
+  # - cannot update one row without fetching the entire sheet
+  # 
+  # 
+  # unless perhaps:
+  # 
+  # - streamline connecting
+  # - initializer to fetch whole sheet
+  # - expensive to update only one row....!!!!
+  # - will need to batch (somehow -- no such thing in persistor atm)
+  # 
+
+  class GoogleSheet
+
+    def initialize( username, password, key )
+
+      @username = username
+      @password = password
+      @key = key
+
+      puts "loging in..."
+      @session = GoogleDrive.login( username, password )
+      
+      puts "getting sheet..."
+      @spreadsheet =  @session.spreadsheet_by_key( @key )
+
+    end
+
+
+    def play_more
+
+      puts "getting worksheet..."
+      sheet = @spreadsheet.worksheet_by_title('Sheet One')
+
+      puts "getting list..."
+      list = sheet.list
+
+      puts "to_hash_array..."
+      ap list.to_hash_array
+      #  
+      #  [
+      #      [0] {
+      #          "key column" => "key1",
+      #             "value 1" => "2",
+      #             "value 2" => "3"
+      #      },
+      #      [1] {
+      #          "key column" => "key2",
+      #             "value 1" => "5",
+      #             "value 2" => "6"
+      #      }
+      #  ]
+      # 
+
+      #puts "get List::Row..."
+      #row = list[ 98 ] # 100th row
+      #ap row.to_hash
+
+
+    end
+
+
+
+    def play_with_it
+
+      puts "getting worksheet..."
+      sheet = @spreadsheet.worksheet_by_title('Sheet One')
+
+      puts "updating rows..."
+      #
+      # Write into call A1
+      #
+      sheet[1,1] = 'key column'
+      sheet[1,2] = 'value 1'
+      sheet[1,3] = 'value 2'
+
+      sheet[2,1] = 'key1'
+      sheet[2,2] = '2'
+      sheet[2,3] = '3'
+      
+      sheet[3,1] = 'key2'
+      sheet[3,2] = '5'
+      sheet[3,3] = '6'
+
+      sheet[100,1] = 'key3'
+      sheet[100,2] = '8'
+      sheet[100,3] = '9'
+
+      puts 'saving...'
+      sheet.save
+
+
+      puts 'done...'
+
+    end
+
+
+  end
+
+end

data/lib/plugin/google_sheet.rb

@@ -0,0 +1,202 @@
+require 'google_drive'
+
+module Plugin
+
+  class GoogleSheet < LanGrove::Plugin::BufferedPersistor
+
+    def validate_config
+
+      super
+
+      raise LanGrove::DaemonConfigException.new(
+
+        "#{self.class} requires :username:, :password: and :google_key:"
+
+      ) if (
+
+        @config[:username].nil? or
+        @config[:password].nil? or
+        @config[:google_key].nil?
+
+      )
+
+      @username   = @config[:username]
+      @password   = @config[:password]
+      @google_key = @config[:google_key]
+
+      connect
+
+    end
+
+    def connect
+
+      #
+      # TODO: restore session (a cookie or something)
+      #
+
+      @logger.debug "Connecting as user:#{@username}"
+
+      @session  = GoogleDrive.login( @username, @password )
+
+      @logger.debug "Getting document: #{@google_key}"
+
+      @document = @session.spreadsheet_by_key( @google_key )
+
+      @document.title = @database
+
+
+    end
+
+    def store_all
+
+      new, sheet = get_sheet
+
+      update( sheet ) unless new
+
+      sheet.save
+
+    end
+
+    def get_sheet
+
+      @logger.debug "Getting sheet #{@table}"
+      
+      sheet = @document.worksheet_by_title( @table )
+
+      if sheet.nil?
+
+        @logger.debug "Creating sheet #{@table}"
+
+        sheet = @document.add_worksheet( @table )
+
+        return true, create_new( sheet )
+
+      end
+
+      index sheet
+
+      return false, sheet
+
+    end
+
+    def index( sheet )
+
+      @logger.debug "Indexing for key: #{@key_column}"
+
+      @sheet_hash_array = sheet.list.to_hash_array
+
+      @row_index = {}
+      @row_count = 1 # first row for headings
+
+      @sheet_hash_array.each do |row|
+
+        @row_index[ row[ @key_column.to_s ] ] = @row_count += 1
+
+      end
+
+
+      @col_index = {}
+      @col_count = 0
+
+      @sheet_hash_array[0].each_key do |key|
+
+        @col_index[ key ] = @col_count += 1
+
+      end
+
+    end
+
+    def update( sheet )
+      
+      @capsules.each do |key, row|
+
+        if @row_index.has_key?( key )
+
+          #
+          # Updates by row number (as indexed)
+          #
+          # Sorting the spreadsheet while this is in
+          # progress will have perculiar effects
+          # 
+
+          update_row( sheet, @row_index[key], row )
+
+        else
+
+          add_row( sheet, row )
+
+        end
+
+      end
+
+    end
+
+    def add_row( sheet, row )
+
+      #
+      # increment and offset for heading
+      #
+
+      next_row = (@row_count += 1)
+
+      @logger.debug "Creating row:#{next_row} with data: #{row.inspect}"
+
+      row.each do |k, value|
+
+        sheet[ next_row, @col_index[k.to_s] ] = value
+
+      end
+
+    end
+
+    def update_row( sheet, row_number, row )
+
+      @logger.debug "Updating row:#{row_number} with data: #{row.inspect}"
+
+      row.each do |k, value|
+
+        sheet[ row_number, @col_index[k.to_s] ] = value
+
+      end
+
+    end
+
+    def create_new( sheet )
+
+      row_number = 0
+
+      @capsules.each do |key, row|
+
+        row_number += 1
+
+        if row_number == 1
+
+          col_number = 0
+
+          row.each_key do |heading|
+
+            sheet[ row_number, col_number += 1 ] = heading
+
+          end
+
+          row_number += 1
+
+        end
+
+        col_number = 0
+
+        row.each do |k, value|
+
+           sheet[ row_number, col_number += 1 ] = value
+
+        end
+
+      end
+
+      return sheet
+
+    end
+
+  end
+
+end

data/spec/plugin/google_sheet_spec.rb

@@ -0,0 +1,75 @@
+require 'langrove'
+require 'plugin/google_sheet'
+require 'em-rspec'
+
+
+ROOT = LanGrove::FakeRoot.new
+
+GOOGLE_PERSISTOR_CONFIG = {
+
+  :username => 'langrove11@gmail.com',
+
+  :password => 'langrove11',
+
+  :google_key => '0Ak66wsrXSMqjdEVnWi1ZNXZIR2Q0Q2E2eDE5TW02V0E',
+
+  :database => 'Spreadsheet Title',
+
+  :table => 'Sheet Name',
+
+  :key => {
+
+    :unique => :unique
+
+  }
+
+}
+
+describe Plugin::GoogleSheet do
+
+  subject {
+
+    LanGrove::ClassLoader.create( { 
+    
+      :module => 'Plugin',
+      :class  => 'GoogleSheet'
+      
+    } ).new( ROOT, GOOGLE_PERSISTOR_CONFIG, nil )
+
+  }
+
+  before :each do
+
+    @handler = LanGrove::Handler::Base.new()
+
+    @handler.capsule = {
+
+      :unique => 'unique thing',
+      :value1 => 'ONE',
+      :value2 => 'two'
+
+    }
+
+  end
+
+  pending 'can store()' do
+
+    subject.store( @handler )
+
+    subject.instance_variable_get( 
+
+      :@capsules ).size.should == 1
+
+  end
+
+  it 'stores all' do
+
+    subject.store( @handler )
+    subject.store_all
+
+  end
+
+
+  it 'can hopefully use a cookie to save on login time'
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: langrove-plugin-google
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- ''
+- ''
+- ''
+- ''
+- ''
+- ''
+- ''
+- Richard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: langrove
+  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: google_drive
+  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'
+description: ''
+email: ops@clue.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- langrove-google-plugin.gemspec
+- lib/langrove/plugin/google.rb
+- lib/plugin/discovery.rb
+- lib/plugin/google_sheet.rb
+- spec/plugin/google_sheet_spec.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: GoogleDoc Spreadsheet LanGrove Persistor
+test_files: []