model_to_googlesheet 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c153b7c2f6b311f25757ffcc28274b96fa8a5ff1
-  data.tar.gz: 54c810e9e834270f737a7581bff1773e7bbcee2b
+  metadata.gz: ee372e20acc02c7b47bc25a06bcc5838976c4ff6
+  data.tar.gz: e1b392f32d8b8a570a2538f8dcfcfa5b20ff5137
 SHA512:
-  metadata.gz: 90bab47ac2e13357273686ee38cf27b49e96ef99cebb990bf146baef739dc71498adb8bf2308a5af8ef033286228b5302e926fe8e359c756b4bbe6e7d95b5327
-  data.tar.gz: 9263823d000b920b56250085a960e4105190fa36daf0b931d51315e621c780d3ad8ca05829256a8ae8435525fd96d23a2c7915f5a9bcaf78f22e2fde705862eb
+  metadata.gz: af76b355337279b44539817326c2eb033d274bbe59f0849770a438a2fd83a7dd022197d4b2e2d0b4035b9d3e107c47e7eda5b9d21bddd3e56b835ee9103a1e3b
+  data.tar.gz: 6d69ca4d58d15ba4011147d6a8117d653ee4e6030857e230ad2b83c107857f4575cbe4fb30d9036f04291e19afc68d4d2ec39b70df18ac7416dc0acb32c9f7f1

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    model_to_googlesheet (1.0.0)
-      activerecord
+    model_to_googlesheet (2.0.0)
       google_drive (~> 1.0)
       rails (~> 4.2)
 
@@ -104,7 +103,7 @@ GEM
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.7)
+    nokogiri (1.6.7.1)
       mini_portile2 (~> 2.0.0.rc2)
     oauth (0.4.7)
     oauth2 (1.0.0)
@@ -192,4 +191,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -19,12 +19,14 @@ Once you get **client_id** and **session_id**, you can get a **refresh_token** w
 Once you get your **client_id**, **client_secret** and **refresh_token**, you can set them either globally, permodel, or permethod. 
 Available options are include:
 
-		client_id      
-		client_secret 
-		refresh_token 
-		spreadsheet   - title of the spreadheet you'd like to export your data in.
-		worksheet     - title of the worksheet you'd like to export your data in. if either worksheet or spreadsheet with such titles don't exit, they will be created.
-		convert_with  - (optional) either symbol of method name in your model or Proc that will return hash (columns and values to include in a worksheet created).
+`client_id`    
+`client_secret`
+`refresh_token`
+`spreadsheet`   - title of the spreadheet you'd like to export your data in.
+`worksheet`     - title of the worksheet you'd like to export your data in. if either worksheet or spreadsheet with such titles don't exit, they will be created.
+`convert_with`  - (optional) either symbol of method name in your model or Proc that will return hash (== columns and values to include in a worksheet created).
+`update`        - (optional, only works for separate records) true or false, whether to update rows found by :find_by option. that is, if you have googlesheet rows with unique :name values, you may want to update to set `update: true, find_by: :name`, so that on `user.export_to_googlesheet` gem will try to find a row with a name equal to user's name, and, if successful, update it (or append a new one if row wasn't found). default behavious is to append any record.
+`find_by`       - (optional, only works for separate records, necessary if `update: true`)
 
 
 ##You can put your configuration in */config/initializers*:
@@ -62,6 +64,10 @@ in your model. You can also avoid creating new method with proc or lambda:
 If you export a collection of users, gem will recreate your worksheet and export it all to a clean one. If you export one user, gem will add it to the worksheet if it was already created and create a new one (with a spreadsheet if needed) if it couldn't find one, adding record to a newly created one.
 
 
+##How to delete a record?
+You can clear a record with `record.delete_from_googlesheet` method. It requires `:find_by` option to be able to find a record to delete. If spreadsheet or worksheet or record were not found, just returns.
 
+---------
+Now works with Mongoid too.
 
 

data/lib/model_to_googlesheet/export.rb

@@ -17,29 +17,56 @@ module ModelToGooglesheet
 
 		def export_to_googlesheet permethod_options={}
 			options = Configuration.merge_configs permethod_options, model_to_googlesheet_configuration
+
 			session = GoogleDrive::Session.new_for_gs({
 				client_id: options[:client_id], 
 				client_secret: options[:client_secret], 
 				refresh_token: options[:refresh_token]
 			})
-
-			ws = session.get_or_create_ss(options[:spreadsheet]).get_or_create_ws(options[:worksheet])
+			ss = session.get_or_create_ss options[:spreadsheet]
+			ws = ss.get_or_create_ws options[:worksheet]
 
 			record_hash = self.get_exportable_hash options[:convert_with]
-			ws.export_hash record_hash
 
+			ws.export_hash record_hash, 
+				update: options[:update], find_by: options[:find_by]
+
+			ws.save
+		end
+
+		def delete_from_googlesheet permethod_options={}
+			options = Configuration.merge_configs permethod_options, model_to_googlesheet_configuration
+
+			session = GoogleDrive::Session.new_for_gs({
+				client_id: options[:client_id], 
+				client_secret: options[:client_secret], 
+				refresh_token: options[:refresh_token]
+			})
+			ss = session.exact_ss options[:spreadsheet]
+			return unless ss
+			ws = ss.worksheet_by_title options[:worksheet]
+			return unless ws
+
+			record_hash = get_exportable_hash options[:convert_with]
+
+			row = ws.row_with_hash record_hash, find_by: options[:find_by]
+			return unless row
+
+			row.clear 
 			ws.save
 		end
 
 		def get_exportable_hash convert_with
-			case convert_with 
-			when nil 
-				attributes
-			when Symbol 
-				self.send convert_with
-			when Proc
-				convert_with.call self
-			end
+			ActiveSupport::HashWithIndifferentAccess.new(
+				case convert_with 
+				when nil 
+					attributes
+				when Symbol 
+					self.send convert_with
+				when Proc
+					convert_with.call self
+				end
+			)
 		end
 
 
@@ -50,13 +77,12 @@ module ModelToGooglesheet
 
 			def export_to_googlesheet permethod_options={}
 				options = Configuration.merge_configs permethod_options, model_to_googlesheet_configuration
-
+				
 				session = GoogleDrive::Session.new_for_gs({
 					client_id: options[:client_id], 
 					client_secret: options[:client_secret], 
 					refresh_token: options[:refresh_token]
 				})
-
 				ss = session.get_or_create_ss options[:spreadsheet]
 				ws = ss.create_or_recreate_ws options[:worksheet]
 
@@ -64,18 +90,22 @@ module ModelToGooglesheet
 				(0..amount_of_batches_to_skip).each do |skip_n_batches|
 					records = limit(BATCH_SIZE).offset(skip_n_batches*BATCH_SIZE)
 
-					records.each do |record|
-						record_hash = record.get_exportable_hash options[:convert_with]
-						ws.export_hash record_hash
-					end
+					-> {
+						records.each do |record|
+							record_hash = record.get_exportable_hash options[:convert_with]
+							ws.export_hash record_hash, update: false, find_by: false
+						end
+						ws.save
+					}.rescue(2)
+
 
-					ws.save
 				end
 
 
 			end
 
 
+
 		end
 
 

data/lib/model_to_googlesheet/google_drive/worksheet.rb

@@ -1,21 +1,38 @@
 module GoogleDrive
 	class Worksheet
 
-		def export_hash hash
-			begin
-				self.list.push hash #will raise error if unfamiliar key. faster than making a request everytime asking for present keys.
-			rescue GoogleDrive::Error => error #GoogleDrive::Error: Column doesn't exist: "hi"
-				if error.message.include? "Column doesn't exist:" 
-					old_keys = self.list.keys # then update all keys, because it'll take same amount of time as updating specific keys
-					new_keys = (old_keys + hash.keys).uniq 
-					self.list.keys = new_keys #we are updating the first row.
-					retry
-				end
-				raise
+		def export_hash hash, update:, find_by:
+			update_keys(hash)
+
+			if update #find by :id/:whatever and update if found, else append
+
+				row = row_with_hash hash, find_by: find_by
+				row ? row.update(hash) : list.push(hash)
+
+			else #append
+				list.push(hash)
 			end
-			
+
 		end
 
+		#either returns first row with given condition true, or nil
+		def row_with_hash hash, find_by:
+			row = list.find do |row| #GoogleDrive::ListRow
+				row[find_by] == hash[find_by].to_s
+			end
+		end
+
+		private
+
+
+			#merge existing keys with the new ones. 
+			#(doesn't take additional request, since this request will preload other rows)
+			def update_keys hash
+				old_keys = self.list.keys 
+				new_keys = (old_keys + hash.keys.map(&:to_s)).uniq 
+				self.list.keys = new_keys #we are updating the first row.
+			end
+
 		
 
 	end

data/lib/model_to_googlesheet/helpers.rb

@@ -0,0 +1,15 @@
+# -> { raise 'hi' }.rescue(3) { |m| puts m.backtrace[0] }
+# -> { raise 'hi' }.rescue(3) { |m, n| puts "number_of_attempts left: #{n}" }
+# p -> { 6 }.rescue(10)
+Proc.class_eval do
+	def rescue number_of_attempts=0
+		@n = number_of_attempts
+		begin
+			self.call 
+		rescue => message
+			yield message, @n if block_given?
+			@n -= 1
+			@n > 0 ? retry : raise
+		end
+	end
+end

data/lib/model_to_googlesheet/railtie.rb

@@ -6,8 +6,11 @@ module ModelToGooglesheet
 			load 'model_to_googlesheet/tasks/get_refresh_token.rake'
 		end
 
-		initializer 'model_to_googlesheet.extend_activerecord' do
-			ActiveRecord::Base.extend ModelToGooglesheet::ClassMethods
+		initializer 'model_to_googlesheet.extend_db_mapper' do
+			# we may use ActiveRecord::Base.extend ModelToGooglesheet::ClassMethods, but
+			# let's extend Object
+			# for Mongoid eg, and maybe some other db mappers
+			Object.extend ModelToGooglesheet::ClassMethods 
 		end
 
 		config.before_configuration do

data/lib/model_to_googlesheet/version.rb

@@ -1,3 +1,3 @@
 module ModelToGooglesheet
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/model_to_googlesheet.rb

@@ -1,4 +1,3 @@
-require 'active_record'
 require 'rails/railtie'
 require 'google/api_client'
 require 'google_drive'
@@ -8,8 +7,6 @@ require 'model_to_googlesheet/google_drive/session'
 require 'model_to_googlesheet/google_drive/spreadsheet'
 require 'model_to_googlesheet/google_drive/worksheet'
 
-require 'model_to_googlesheet/export'
-require 'model_to_googlesheet/railtie'
 
 module ModelToGooglesheet
 
@@ -38,20 +35,26 @@ module ModelToGooglesheet
 	class Configuration
 		OPTIONS = [ 
 			:client_id, :client_secret, :refresh_token,
-			:worksheet, :spreadsheet, 
-			:convert_with 
+			:spreadsheet, :worksheet, 
+			:convert_with, 
+			:update, :find_by
 		]
 
+
 		attr_accessor *OPTIONS
 
 		# defaults
 		def initialize
-			@client_id      = nil
-			@client_secret  = nil
-			@refresh_token  = nil
-			@worksheet      = nil
-			@spreadsheet    = nil
-			@convert_with   = nil #optional
+			@client_id     = nil
+			@client_secret = nil
+			@refresh_token = nil
+			@spreadsheet   = nil
+			@worksheet     = nil
+			@convert_with  = nil   #optional
+			@update        = false #optional, will only be applied to separate records. 
+				#if set to true, finds a record in a sheet by :id and updates it. 
+				#if set to :symbol, finds a record in a sheet by :symbol and updates it
+			@find_by       = :id
 		end
 
 		def self.merge_configs permethod_options, permodel_configuration
@@ -67,6 +70,8 @@ module ModelToGooglesheet
 end
 
 
-
+require 'model_to_googlesheet/helpers'
+require 'model_to_googlesheet/export'
+require 'model_to_googlesheet/railtie'
 
 

data/model_to_googlesheet.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n") - ['.gitignore']
   s.require_paths = ['lib']
 
-  s.add_dependency             'activerecord'
   s.add_dependency             'rails',        '~>4.2'
   s.add_dependency             'google_drive', '~>1.0'
 

data/spec/support/create_session.rb

@@ -1,8 +1,8 @@
 
 shared_context :create_session do
-	let(:client_id) { '274709489501-ekvsdc8cpuh9nrps73h55m29i1kbgtgk.apps.googleusercontent.com' }
-	let(:client_secret) { 'hbSi0Q7VWArzLQZ2maJoagdx' }
-	let(:refresh_token) { '1/iNO0L49Mnn1EOmhnc5Rn_AEF-6SYlGbAt9cmITdhD4hIgOrJDtdun6zK6XiATCKT' }
+	let(:client_id) { 'inset yours' }
+	let(:client_secret) { 'inset yours' }
+	let(:refresh_token) { 'inset yours' }
 	let(:session) {
 		GoogleDrive::Session.new_for_gs({
 			client_id: client_id, 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: model_to_googlesheet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Helga Karunus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2015-12-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +115,7 @@ files:
 - lib/model_to_googlesheet/google_drive/session.rb
 - lib/model_to_googlesheet/google_drive/spreadsheet.rb
 - lib/model_to_googlesheet/google_drive/worksheet.rb
+- lib/model_to_googlesheet/helpers.rb
 - lib/model_to_googlesheet/railtie.rb
 - lib/model_to_googlesheet/tasks/get_refresh_token.rake
 - lib/model_to_googlesheet/version.rb