gsmetrics 0.0.3 → 0.0.4

data/Gemfile

@@ -4,5 +4,4 @@ gem 'httparty'
 gem 'builder'
 gem 'thor'
 gem 'launchy'
-gem 'httparty'
 gem 'crack'

data/Gemfile.lock

@@ -1,7 +1,10 @@
 PATH
   remote: .
   specs:
-    gsmetrics (0.0.3)
+    gsmetrics (0.0.4)
+      builder
+      crack
+      httparty
 
 GEM
   specs:
@@ -13,7 +16,7 @@ GEM
       multi_xml
     launchy (2.0.5)
       addressable (~> 2.2.6)
-    multi_json (1.0.3)
+    multi_json (1.0.4)
     multi_xml (0.4.1)
     thor (0.14.6)
 

data/README.md

@@ -25,7 +25,28 @@ worksheet.append(5)
 worksheet.save_row
 ```
 
-After saving a row all appended data is removed and you can start with a new row. 
+Every row is added in one batch call, so only one HTTP request is sent for every row.
+
+You can also set the exact row in the worksheet the data should be saved into. This is very handy if you have a worksheet that you need to update repeatedly.
+
+The following example saves the worksheet to row nr 1. The rows start with 1 in Googledocs.
+
+```ruby
+worksheet.save_row 5
+```
+
+The following example sets the number of rows in the worksheet beforehand and then disables the check if there is still a free row. By default gsmetrics checks
+if there is a free row at the end of the worksheet and if not adds one. If you know beforehand the number of rows you need (e.g. daily updated list of users) you can
+set the worksheet size and disable the check. This makes the upload process much faster, as the check doesn't have to be made before every new row is added.
+
+```ruby
+set_worksheet_size 5
+worksheet.check_worksheet_size = false
+worksheet << 1
+worksheet.save_row
+```
+
+After saving a row all appended data is removed and you can start with a new row.
 Please make sure there are only empty lines at the end of the spreadsheet as the first empty line is used to write the data.
 
 
@@ -35,8 +56,9 @@ You can find out what your worksheet_id is by going to
 
 https://spreadsheets.google.com/feeds/worksheets/#{your_document_id}/private/full
 
-For every worksheet there will be an <entry> element which has an id. The last part of the id (something like od6) is the worksheet_id you have to provide.
-If you find a better way to get that information or would implement an extension to the executable to go over the api and get that information you are very welcome.
+For every worksheet there will be an <entry> element which has an id. The last part of the id (something like od6) is the worksheet_id you have to provide. 
+The executable will give you a list of all worksheets for your document at the end of the setup process.
+
+Copyright (c) 2011-2012 Florian Motlik, licensed under MIT License
 
-Copyright (c) 2011 Florian Motlik
 Based on the gem template by https://github.com/goncalossilva/gem_template

data/gsmetrics.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "gsmetrics"
-  s.version           = "0.0.3"
+  s.version           = "0.0.4"
   s.platform          = Gem::Platform::RUBY
   s.authors           = ["Florian Motlik"]
   s.email             = ["flo@railsonfire.com"]
@@ -11,8 +11,12 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
+  s.requirements << 'Thor and launchy gem need to be installed for the executable. Not adding them as a dependency for the whole library'
+
   # If you have runtime dependencies, add them here
-  # s.add_runtime_dependency "other", "~> 1.2"
+  s.add_runtime_dependency(%q<httparty>, [">= 0"])
+  s.add_runtime_dependency(%q<builder>, [">= 0"])
+  s.add_runtime_dependency(%q<crack>, [">= 0"])
 
   # If you have development dependencies, add them here
   # s.add_development_dependency "another", "= 0.9"
@@ -20,10 +24,7 @@ Gem::Specification.new do |s|
   # The list of files to be contained in the gem
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  # s.extensions    = `git ls-files ext/extconf.rb`.split("\n")
 
   s.require_path = 'lib'
 
-  # For C extensions
-  # s.extensions = "ext/extconf.rb"
 end

data/lib/gsmetrics/gsmetrics.rb

@@ -24,7 +24,9 @@ module GSMetrics
 
 private
   class Worksheet
+    attr_accessor :check_worksheet_size
     def initialize doc_id, worksheet_id, access_token
+      @check_worksheet_size = true
       @doc_id = doc_id
       @worksheet_id = worksheet_id
       @access_token = access_token
@@ -44,33 +46,38 @@ private
       append item
     end
 
-    def save_row
+    def save_row row_id = nil
       xmlns = {:xmlns => "http://www.w3.org/2005/Atom",
+          "xmlns:batch" => "http://schemas.google.com/gdata/batch",
           "xmlns:gs" => "http://schemas.google.com/spreadsheets/2006"}
 
       response = HTTParty.get(@worksheet_href, :query => @query)
 
-      row_id = parse(response.body)["feed"]["openSearch:totalResults"].to_i + 2
-
-      create_row row_id
-
-      @items.each_with_index{|item, index|
-        col_index = index+1
-        col_id = "R#{row_id}C#{col_index}"
-        col_href="#{@worksheet_cell_href}/#{col_id}"
-        xml = builder.entry(xmlns
-          ) { |b|
-            b.id(col_href)
-            b.link(:rel => "edit", :type => "application/atom+xml", :href => col_href)
-            b.send("gs:cell", :row => row_id, :col => col_index, :inputValue => item)
-          }
-        HTTParty.put(col_href, :headers => @headers, :query => @query, :body => xml)
-      }
+      row_id ||= parse(response.body)["feed"]["openSearch:totalResults"].to_i + 2
+
+      set_worksheet_size row_id if @check_worksheet_size
+
+      xml = builder.feed(xmlns) do |build|
+        build.id("#{@worksheet_cell_href}")
+        @items.each_with_index{|item, index|
+          col_index = index+1
+          col_id = "R#{row_id}C#{col_index}"
+          col_href="#{@worksheet_cell_href}/#{col_id}"
+          build.entry { |b|
+              b.send("batch:id", "A#{index}")
+              b.send("batch:operation", :type => "update")
+              b.id(col_href)
+              b.link(:rel => "edit", :type => "application/atom+xml", :href => col_href)
+              b.send("gs:cell", :row => row_id, :col => col_index, :inputValue => item)
+            }
+        }
+      end
+      response = HTTParty.post("#{@worksheet_cell_href}/batch", :headers => @headers, :query => @query, :body => xml)
+      raise Exception if response.code != 200
       @items = []
     end
 
-    private
-    def create_row row_id
+    def set_worksheet_size row_id
       href = "https://spreadsheets.google.com/feeds/worksheets/#{@doc_id}/private/full/#{@worksheet_id}"
       worksheet = parse(HTTParty.get(href, :query => @query))
       row_count = worksheet["entry"]["gs:rowCount"].to_i
@@ -78,7 +85,7 @@ private
       update_href = worksheet["entry"]["link"].last["href"]
 
       add = builder.entry(:xmlns => "http://www.w3.org/2005/Atom", "xmlns:gs" => "http://schemas.google.com/spreadsheets/2006"){|e|
-        e.send("gs:rowCount", row_count + 1)
+        e.send("gs:rowCount", row_id)
         e.send("gs:colCount", worksheet["entry"]["gs:colCount"].to_i)
         e.title(worksheet["entry"]["title"])
       }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gsmetrics
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000Z
-dependencies: []
+date: 2012-01-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &21137520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21137520
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &21137020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21137020
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: &21136540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21136540
 description: Simple Way to open a Session with Google Docs and push data into a Google
   Spreadsheet Worksheet. We use it primarily for metrics, but it can be used for basically
   anything regarding google spreadsheets.
@@ -46,14 +79,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1752480396697101011
+      hash: 577015747898279807
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
-requirements: []
+requirements:
+- Thor and launchy gem need to be installed for the executable. Not adding them as
+  a dependency for the whole library
 rubyforge_project: gsmetrics
 rubygems_version: 1.8.10
 signing_key: