gsmetrics 0.0.4 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## 0.0.1 (July 10, 2010)
+## 0.1.0 (April 22, 2012)
 
 Features:
 
-  - initial import of this dummy gem
+  - Using google-spreadsheet-ruby gem for uploading user data

data/Gemfile

@@ -1,7 +1 @@
-gemspec
-
-gem 'httparty'
-gem 'builder'
-gem 'thor'
-gem 'launchy'
-gem 'crack'
+gemspec

data/Gemfile.lock

@@ -1,32 +1,33 @@
 PATH
   remote: .
   specs:
-    gsmetrics (0.0.4)
-      builder
-      crack
-      httparty
+    gsmetrics (0.1.0)
+      google-spreadsheet-ruby (~> 0.2.1)
 
 GEM
   specs:
-    addressable (2.2.6)
-    builder (3.0.0)
-    crack (0.1.8)
-    httparty (0.8.1)
-      multi_json
-      multi_xml
-    launchy (2.0.5)
-      addressable (~> 2.2.6)
-    multi_json (1.0.4)
-    multi_xml (0.4.1)
-    thor (0.14.6)
+    addressable (2.2.7)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    google-spreadsheet-ruby (0.2.1)
+      nokogiri (>= 1.4.4, != 1.5.2, != 1.5.1)
+      oauth (>= 0.3.6)
+      oauth2 (>= 0.5.0)
+    httpauth (0.1)
+    multi_json (1.3.2)
+    multipart-post (1.1.5)
+    nokogiri (1.5.0)
+    oauth (0.4.6)
+    oauth2 (0.6.0)
+      faraday (~> 0.7)
+      httpauth (~> 0.1)
+      multi_json (~> 1.0)
+    rack (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  builder
-  crack
   gsmetrics!
-  httparty
-  launchy
-  thor

data/README.md

@@ -6,58 +6,38 @@ You can install it by calling
 
 Development was started so we could run a cron job in regular intervals and push metrics data about Railsonfire to a Google Spreadsheet.
 
-To start using it simply run
-
-``` gsmetrics ```
-
-and follow the instructions given. You will have to create a new google API Project and after
-finishing all steps get code you can simply paste into your codebase.
-
 ## Usage
 
-Create a new GSMetrics Session and a worksheet, then append to it and save the row:
+Create a new GSMetrics Session and a worksheet, then append to it and create as many rows as you like:
 
 ```ruby
-session = GSMetrics::Session.new(client_id, client_secret, refresh_token)
-worksheet = session.worksheet document_id, worksheet_id
+session = GSMetrics::Session.new("YOUR_GOOGLE_USERNAME, "YOUR_GOOGLE_PASSWORD")
+session.worksheet "SPREADSHEET_TITLE, "WORKSHEET_TITLE"
 worksheet << 1
 worksheet.append(5)
-worksheet.save_row
+worksheet.next_row
+worksheet.append(10)
+worksheet.save
 ```
 
-Every row is added in one batch call, so only one HTTP request is sent for every row.
+You simply add to the current row with either ***<<*** or ***.append()***. When calling ***next_row*** the current data is stored away for later saving and you can start adding new items again.
 
-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 whole worksheet is updated in one batch call, so only one HTTP request is sent.
 
-The following example saves the worksheet to row nr 1. The rows start with 1 in Googledocs.
-
-```ruby
-worksheet.save_row 5
-```
+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 completely.
 
-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.
+The following example saves all rows you added starting with the row id of 5. So if you added 2 rows to the worksheet the rows 5 and 6 will be added/overwritten in the spreadsheet.
 
 ```ruby
-set_worksheet_size 5
-worksheet.check_worksheet_size = false
-worksheet << 1
-worksheet.save_row
+worksheet.save 5
 ```
+When you do not specify any row it will be automatically added to the end.
 
 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.
-
-
-### Worksheet ID
-
-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. 
-The executable will give you a list of all worksheets for your document at the end of the setup process.
+###Authentication
+GSMetrics doesn't suppot OAUTH login with Google any more, as it was painful to implement and not worthwile for us. If you are interrested in having this we gladly accept a pull request.
 
 Copyright (c) 2011-2012 Florian Motlik, licensed under MIT License
 

data/gsmetrics.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "gsmetrics"
-  s.version           = "0.0.4"
+  s.version           = "0.1.0"
   s.platform          = Gem::Platform::RUBY
   s.authors           = ["Florian Motlik"]
   s.email             = ["flo@railsonfire.com"]
@@ -11,12 +11,8 @@ 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(%q<httparty>, [">= 0"])
-  s.add_runtime_dependency(%q<builder>, [">= 0"])
-  s.add_runtime_dependency(%q<crack>, [">= 0"])
+  s.add_dependency("google-spreadsheet-ruby", "~> 0.2.1")
 
   # If you have development dependencies, add them here
   # s.add_development_dependency "another", "= 0.9"

data/lib/gsmetrics/gsmetrics.rb

@@ -1,107 +1,56 @@
-require 'builder'
-require 'httparty'
-require 'json'
-require 'crack'
+require 'google_spreadsheet'
 
 module GSMetrics
   class Session
-    def initialize client_id, client_secret, refresh_token
-      refresh_request = {
-        :client_id => client_id,
-        :client_secret => client_secret,
-        :refresh_token => refresh_token,
-        :grant_type => "refresh_token"
-      }
-      response = HTTParty.post("https://accounts.google.com/o/oauth2/token", :body => refresh_request)
-      parsed = JSON.parse(response.body)
-      @access_token = parsed["access_token"]
+    def initialize email, password
+      @email = email
+      @password = password
     end
 
-    def worksheet doc_id, worksheet_id
-      Worksheet.new doc_id, worksheet_id, @access_token
+    def worksheet doc_title, worksheet_id
+      Worksheet.new doc_title, worksheet_id, GoogleSpreadsheet.login(@email, @password)
     end
   end
 
 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
+    def initialize doc_title, worksheet_title, session
+      @worksheet = session.spreadsheet_by_title(doc_title).worksheet_by_title(worksheet_title)
       @items = []
-      @worksheet_cell_href = "https://spreadsheets.google.com/feeds/cells/#{@doc_id}/#{@worksheet_id}/private/full"
-      @worksheet_href= "https://spreadsheets.google.com/feeds/list/#{@doc_id}/#{@worksheet_id}/private/full"
-
-      @query = {"access_token" => @access_token, :v => "3.0"}
-      @headers = {"Content-Type" => "application/atom+xml", "If-Match" => "*"}
+      @rows = []
     end
 
     def append item
-      @items << item
+      @items << (item.nil? ? "" : item)
     end
 
     def << item
       append item
     end
 
-    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
-
-      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
+    def next_row
+      @rows << @items unless @items.empty?
       @items = []
     end
 
-    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
+    def save row_id = nil
+      next_row
+      row_id ||= @worksheet.num_rows + 1
 
-      update_href = worksheet["entry"]["link"].last["href"]
+      @worksheet.max_rows = row_id + @rows.size
 
-      add = builder.entry(:xmlns => "http://www.w3.org/2005/Atom", "xmlns:gs" => "http://schemas.google.com/spreadsheets/2006"){|e|
-        e.send("gs:rowCount", row_id)
-        e.send("gs:colCount", worksheet["entry"]["gs:colCount"].to_i)
-        e.title(worksheet["entry"]["title"])
-      }
-      HTTParty.put(update_href, :query => @query, :headers => @headers, :body => add) if row_count < row_id
-    end
-
-    def parse content
-      Crack::XML.parse(content)
-    end
-
-    def alphabet
-      ("A".."ZZ").to_a
+      @rows.each_with_index do |items, row_index|
+        items.each_with_index do |item, item_index|
+          @worksheet[row_id + row_index, item_index + 1] = item
+        end
+      end
+      put "Save failed" unless @worksheet.save
+      @items = []
     end
 
-    def builder
-      Builder::XmlMarkup.new
+    def set_worksheet_size size
+      @worksheet.max_rows = size
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gsmetrics
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,48 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000Z
+date: 2012-04-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &21137520 !ruby/object:Gem::Requirement
+  name: google-spreadsheet-ruby
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *21137520
-- !ruby/object:Gem::Dependency
-  name: builder
-  requirement: &21137020 !ruby/object:Gem::Requirement
+  version_requirements: !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
+        version: 0.2.1
 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.
 email:
 - flo@railsonfire.com
-executables:
-- gsmetrics
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -61,7 +43,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/gsmetrics
 - gsmetrics.gemspec
 - lib/gsmetrics.rb
 - lib/gsmetrics/gsmetrics.rb
@@ -79,18 +60,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 577015747898279807
+      hash: 2891853343761736090
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
-requirements:
-- Thor and launchy gem need to be installed for the executable. Not adding them as
-  a dependency for the whole library
+requirements: []
 rubyforge_project: gsmetrics
-rubygems_version: 1.8.10
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Gem for pushing data to Google Docs

data/bin/gsmetrics

@@ -1,65 +0,0 @@
-#!/usr/bin/env ruby
-require "thor"
-require 'launchy'
-require 'httparty'
-require 'json'
-require 'crack'
-
-class GSMetrics < Thor
-  desc "setup", "Helps in Setting up a google Oauth Token"
-  def setup
-    say "Google Code API Console will open shortly."
-    say "Please create a new API Project and then go to API Access and create a new \"Installed Application\" Client ID"
-    sleep 5
-    Launchy.open("https://code.google.com/apis/console")
-    sleep 2
-    client_id = ask "Paste your new Client ID:"
-    client_secret = ask "Paste your new Client Secret:"
-    auth_query = {
-      :response_type => "code",
-      :client_id => client_id,
-      :redirect_uri => "urn:ietf:wg:oauth:2.0:oob",
-      :scope => "https://spreadsheets.google.com/feeds/"
-    }
-    Launchy.open("https://accounts.google.com/o/oauth2/auth?" + auth_query.map{|e| e.join("=")}.join("&"))
-
-    sleep 2
-
-    code = ask "Paste your new Code:"
-
-    token_query = {
-      :code => code,
-      :client_id => client_id,
-      :client_secret => client_secret,
-      :redirect_uri => "urn:ietf:wg:oauth:2.0:oob",
-      :grant_type => "authorization_code"
-    }
-
-    response = HTTParty.post("https://accounts.google.com/o/oauth2/token", :body => token_query)
-
-    tokens = JSON.parse(response.body)
-
-    refresh_token = tokens["refresh_token"]
-
-    say "Following is the code to create your GSMetrics Session. The last parameter is your Refresh Token"
-
-    say "GSMetrics::Session.new("
-    say "  \"#{client_id}\","
-    say "  \"#{client_secret}\","
-    say "  \"#{refresh_token}\""
-    say ")"
-
-    say "\n\n"
-
-    document = ask "Id of Document you want to access:"
-
-    response = HTTParty.get("https://spreadsheets.google.com/feeds/worksheets/#{document}/private/full", :query => {"access_token" => tokens["access_token"], :v => "3.0"})
-    worksheets = Crack::XML.parse(response.body)
-    say "Code for creating a Worksheet"
-    worksheets["feed"]["entry"].each_with_index do |entry, index|
-      say "#{index}. #{entry["title"]} - session.worksheet(\"#{document}\", \"#{entry["id"].split("/").last}\")"
-    end
-  end
-end
-
-GSMetrics.start [:setup]