gdata_spreadsheet 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Trike Apps
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= GData Spreadsheet
+
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Trike Apps. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gdata_spreadsheet"
+    gem.summary = %Q{Simple wrapper to access a google spreadsheet using the GData gem}
+    gem.description = %Q{}
+    gem.email = "tom@trike.com.au"
+    gem.homepage = "http://github.com/tricycle/gdata_spreadsheet"
+    gem.authors = ["Tom"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :build
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gdata_spreadsheet #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/gdata_spreadsheet.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gdata_spreadsheet}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom"]
+  s.date = %q{2010-08-30}
+  s.description = %q{}
+  s.email = %q{tom@trike.com.au}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gdata_spreadsheet.gemspec",
+     "lib/gdata_spreadsheet.rb",
+     "lib/google/base.rb",
+     "lib/google/config.rb",
+     "lib/google/log.rb",
+     "lib/google/spreadsheet.rb",
+     "spec/google/base_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tricycle/gdata_spreadsheet}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple wrapper to access a google spreadsheet using the GData gem}
+  s.test_files = [
+    "spec/google/base_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/gdata_spreadsheet.rb

@@ -0,0 +1,5 @@
+require 'gdata'
+require 'nokogiri'
+
+require 'google/base'
+require 'google/spreadsheet'

data/lib/google/base.rb

@@ -0,0 +1,104 @@
+module Google
+  class Base
+    attr_reader :doc
+
+    def initialize(doc_id, row_id = nil)
+      raise Google::MissingDocumentError unless doc_id
+
+      @sheet = Spreadsheet.new(doc_id)
+      @worksheet_id = @sheet.worksheet_id_for(worksheet_name)
+
+      initialize_row row_id
+    end
+
+    def initialize_row(id)
+      if id_column && id && @doc = @sheet.row_data(id_column, id.downcase, @worksheet_id)
+        initialize_doc
+      else
+        new_row
+      end
+    end
+
+    def new_row
+      @doc = Nokogiri::XML.parse("<entry xmlns=\"http://www.w3.org/2005/Atom\"></entry>").css("entry").first
+      @doc.add_namespace_definition "gsx", "http://schemas.google.com/spreadsheets/2006/extended"
+      @doc.add_namespace_definition "gd", "http://schemas.google.com/g/2005"
+    end
+
+    def initialize_doc
+      @doc["xmlns"] = "http://www.w3.org/2005/Atom"
+      @doc["xmlns:gsx"] = "http://schemas.google.com/spreadsheets/2006/extended"
+      @doc["xmlns:gd"] = "http://schemas.google.com/g/2005"
+    end
+
+    def save
+      if new_record?
+        @sheet.add_row @doc, @worksheet_id
+      else
+        @sheet.update_row @doc, @worksheet_id
+      end
+    end
+
+    def new_record?
+      !@doc.css("id").first
+    end
+
+    def worksheet_name
+      raise "Abstract! Overwrite this method in your subclass"
+    end
+
+    def id_column
+      raise "Abstract! Overwrite this method in your subclass"
+      # return nil in your subclass, if you want a push only model
+    end
+
+    def sync_attributes
+      { }
+    end
+
+    def sync
+      sync_attributes.each do |field, value|
+        set field, value
+      end
+    end
+
+    def sync!
+      sync
+      save
+    end
+
+    def method_missing(method, *args, &block)
+      method = method.to_s
+
+      if method[-1, 1] == "=" && args.size == 1
+        set method[0..-2], *args
+      elsif args.empty?
+        get method
+      else
+        raise NoMethodError
+      end
+    end
+
+  private
+
+    def attribute(field)
+      @doc.xpath(".//gsx:#{field}").first
+    end
+
+    def get(field)
+      attribute(field) && attribute(field).text
+    end
+
+    def set(field, value)
+      @doc << build_new_attribute(field) unless attribute(field)
+      attribute(field).content = value
+    end
+
+    def build_new_attribute(field)
+      new_attribute = Nokogiri::XML::Node.new(field.to_s, @doc)
+      new_attribute.add_namespace_definition "gsx", "http://schemas.google.com/spreadsheets/2006/extended"
+      new_attribute.namespace = new_attribute.namespace_definitions.first
+      new_attribute
+    end
+  end
+end

data/lib/google/config.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+
+module Google
+  class Config
+    def self.file=(path)
+      @@file = path
+    end
+
+    def self.setting(name)
+      @@yaml ||= YAML.load_file(@@file)
+      @@yaml[name]
+    end
+  end
+end

data/lib/google/log.rb

@@ -0,0 +1,25 @@
+module Google
+  class Log < Base
+
+    def initialize(doc_id, message)
+      super doc_id
+
+      @message = message
+    end
+
+    def worksheet_name
+      "sync log"
+    end
+
+    def id_column
+      nil
+    end
+
+    def sync_attributes
+      {
+        :timestamp  => Time.now.to_s(:db),
+        :message    => @message
+      }
+    end
+  end
+end

data/lib/google/spreadsheet.rb

@@ -0,0 +1,65 @@
+require 'google/config'
+
+module Google
+  WORKSHEET_BASE_URL = "https://spreadsheets.google.com/feeds/worksheets"
+  LIST_BASE_URL = "https://spreadsheets.google.com/feeds/list"
+
+  class MissingDocumentError < ::Exception
+  end
+
+  class FatalError < ::Exception
+  end
+
+  class Spreadsheet
+
+    def initialize(key)
+      @key = key
+    end
+
+    def row_data(field, value, worksheet_id = 1)
+      request_with_error_handling(:get, :list, "#{LIST_BASE_URL}/#{@key}/#{worksheet_id}/private/full?sq=#{CGI.escape(field)}=#{CGI.escape(value)}") do |response|
+        xml = Nokogiri::XML.parse(response.body)
+        xml.css('entry').first
+      end
+    end
+
+    def update_row(xml, worksheet_id = 1)
+      request_with_error_handling :put, :list, xml.css("link[rel = edit]").first["href"], xml.to_xml
+    end
+
+    def add_row(xml, worksheet_id = 1)
+      request_with_error_handling :post, :list, "#{LIST_BASE_URL}/#{@key}/#{worksheet_id}/private/full", xml.to_xml
+    end
+
+    def worksheet_id_for(name)
+      request_with_error_handling(:get, :worksheet, "#{WORKSHEET_BASE_URL}/#{@key}/private/full") do |response|
+        xml = Nokogiri::XML.parse(response.body)
+
+        # translate converts the attribute's content to lower case,
+        # therefore allowing us to match case-insensitive
+        xml.xpath(".//atom:entry[translate(
+            atom:title,
+            'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+            'abcdefghijklmnopqrstuvwxyz'
+          ) = '#{name.downcase}']/atom:id",
+          "atom" => "http://www.w3.org/2005/Atom"
+        ).text.split("/").last
+      end
+    end
+
+  protected
+
+    def client(type)
+      client = GData::Client::Spreadsheets.new(:version => '3', :source => 'PlanDeliver')
+      client.authsub_token = Config.setting("#{type}_token")
+      client
+    end
+
+    def request_with_error_handling(method, token_type = "list", *args)
+      response = client(token_type).send(method, *args)
+      yield(response) if block_given?
+    rescue GData::Client::RequestError => e
+      raise Google::FatalError.new(e.message)
+    end
+  end
+end

data/spec/google/base_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class TestOrder < Google::Base
+
+  def worksheet_name
+    "sync log"
+  end
+
+  def id_column
+    "id"
+  end
+end
+
+describe Google::Base do
+
+  before do
+    Google::Spreadsheet.stub! :new => @sheet = mock("Spreadsheet")
+
+    @sheet.stub! :worksheet_id_for => "test",
+                 :row_data => Nokogiri::XML.parse("<entry><id>1</id></entry>").css("entry").first
+  end
+
+  describe "initialize" do
+    it "should return a new document, if we didn't specify a id_column" do
+      class TestOrder
+        def id_column; nil end
+      end
+
+      TestOrder.new(1, 2).should be_new_record
+    end
+
+    it "should return a new document if we cant find a matching row in the spreadsheet" do
+      @sheet.stub! :row_data => nil
+      TestOrder.new(1, 2).should be_new_record
+    end
+
+    it "should initialize the returned doc if a matching row in the spreadsheet has been found" do
+      order = TestOrder.new(1, 2)
+      order.should_not be_new_record
+      order.doc["xmlns"].should == "http://www.w3.org/2005/Atom"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "gdata_spreadsheet"))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  #
+  # == Notes
+  #
+  # For more information take a look at Spec::Runner::Configuration and Spec::Runner
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: gdata_spreadsheet
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-30 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: tom@trike.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- gdata_spreadsheet.gemspec
+- lib/gdata_spreadsheet.rb
+- lib/google/base.rb
+- lib/google/config.rb
+- lib/google/log.rb
+- lib/google/spreadsheet.rb
+- spec/google/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tricycle/gdata_spreadsheet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple wrapper to access a google spreadsheet using the GData gem
+test_files: 
+- spec/google/base_spec.rb
+- spec/spec_helper.rb