google-cells 0.3.0

data/lib/google_cells/util.rb

@@ -0,0 +1,17 @@
+module GoogleCells
+  module Util
+
+    def e(str)
+      CGI.escapeHTML(str.to_s()).gsub(/\n/, '
')
+    end
+
+    def concat_url(url, piece)
+      (url_base, url_query) = url.split(/\?/, 2)
+      (piece_base, piece_query) = piece.split(/\?/, 2)
+      result_query = [url_query, piece_query].select(){ |s| s && !s.empty? }.join("&")
+      return (url_base || "") +
+          (piece_base || "") +
+          (result_query.empty? ? "" : "?#{result_query}")
+    end
+  end
+end

data/lib/google_cells/version.rb

@@ -0,0 +1,3 @@
+module GoogleCells
+  VERSION = "0.3.0"
+end

data/lib/google_cells/worksheet.rb

@@ -0,0 +1,63 @@
+require 'cgi'
+
+module GoogleCells
+  class Worksheet < GoogleCells::GoogleObject
+    include Fetcher
+    include Util
+
+    @permanent_attributes = [ :etag, :title, :updated_at, :cells_uri,
+      :lists_uri, :spreadsheet, :row_count, :col_count ]
+    define_accessors
+
+    def rows
+      GoogleCells::CellSelector::RowSelector.new(self)
+    end
+
+    class UpdateError < StandardError ; end
+
+    def save!
+      return if @changed_cells.nil? || @changed_cells.empty?
+      batch_url = concat_url(cells_uri, "/batch")
+      response = request(:post, batch_url, body: to_xml, headers:{
+        "Content-Type" => "application/atom+xml", "If-Match" => "*"})
+      doc = Nokogiri.parse(response.body)
+
+      for entry in doc.css("atom|entry")
+        interrupted = entry.css("batch|interrupted")[0]
+        if interrupted
+          raise(UpdateError, "Update failed: %s" % interrupted["reason"])
+        end
+        if !(entry.css("batch|status").first["code"] =~ /^2/)
+          raise(UpdateError, "Update failed for cell %s: %s" %
+            [entry.css("atom|id").text, entry.css("batch|status")[0]["reason"]])
+        end
+      end
+      @changed_cells = {}
+      true
+    end
+
+    def track_changes(cell)
+      @changed_cells ||= {}
+      @changed_cells[cell.title] = cell # track only most recent change
+      nil
+    end
+
+    private
+
+    def to_xml
+      xml = <<-EOS
+  <feed xmlns="http://www.w3.org/2005/Atom"
+        xmlns:batch="http://schemas.google.com/gdata/batch"
+        xmlns:gs="http://schemas.google.com/spreadsheets/2006">
+    <id>#{e(self.cells_uri)}</id>
+EOS
+      @changed_cells.each do |title, cell|        
+        xml << cell.to_xml
+      end
+      xml << <<-"EOS"
+  </feed>
+EOS
+    end
+  end
+end
+

data/spec/google_cells/cell_selector/row_selector_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe GoogleCells::CellSelector::RowSelector do
+
+  let(:subject) do 
+    w = nil
+    VCR.use_cassette('google_cells/spreadsheet/cell_selector/worksheet') do
+      s = GoogleCells::Spreadsheet.list.first
+      w = s.worksheets.first
+    end
+    GoogleCells::CellSelector::RowSelector.new(w)
+  end
+
+  describe "#find_each" do
+    
+    it "iterates over all the rows" do
+      count = 0
+
+      VCR.use_cassette('google_cells/cell_selector/find_each') do
+        subject.find_each do |r|
+          count += 1
+          r.class.should eq GoogleCells::Row
+        end
+      end
+      count.should eq 100
+    end
+
+    it "iterates over rows specified in cell selector" do
+      count = 0
+
+      VCR.use_cassette('google_cells/cell_selector/find_each/selection') do
+        s = GoogleCells::Spreadsheet.list.first
+        w = s.worksheets.first
+        rs = subject.from(5).to(10)
+        rs.find_each do |r|
+          count += 1
+          r.class.should eq GoogleCells::Row
+        end
+      end
+      count.should eq 6
+    end
+
+    context "optional batch sizes" do
+      it "fetches in batches 10" do
+        batch = 10
+        subject.should_receive(:get_cells).exactly(10).times.and_return((1..batch).to_a)
+        subject.find_each(batch_size:batch){|r| r}
+      end
+      it "fetches in batches 3" do
+        batch = 3
+        subject.should_receive(:get_cells).exactly(34).times.and_return((1..batch).to_a)
+        subject.find_each(batch_size:batch){|r| r}
+      end
+    end
+  end
+
+  describe "#each" do
+
+    it "iterates over rows specified in cell selector" do
+      count = 0
+
+      VCR.use_cassette('google_cells/cell_selector/each') do
+        subject.each do |r|
+          count += 1
+          r.class.should eq GoogleCells::Row
+        end
+      end
+      count.should eq 100
+    end
+
+    it "fetches in a single request" do
+      subject.should_receive(:get_cells).and_return((1..subject.worksheet.
+        row_count).to_a)
+      subject.each{|r| r}
+    end
+  end
+
+  describe "#from" do
+    it "sets its min row" do
+      subject.from(5)
+      subject.min_row.should eq 5
+      subject.from(10)
+      subject.min_row.should eq 10
+    end
+
+    it "returns itself" do
+      subject.from(subject.min_row).should eq subject
+    end
+  end
+
+  describe "#to" do
+    it "sets its max row" do
+      subject.to(5)
+      subject.max_row.should eq 5
+      subject.to(10)
+      subject.max_row.should eq 10
+    end
+
+    it "returns itself" do
+      subject.from(subject.max_row).should eq subject
+    end
+  end
+end
+

data/spec/google_cells/cell_selector_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe GoogleCells::CellSelector do
+
+  let(:subject) do 
+    w = nil
+    VCR.use_cassette('google_cells/spreadsheet/list') do
+      s = GoogleCells::Spreadsheet.list.first
+      w = s.worksheets.first
+    end
+    GoogleCells::CellSelector.new(w)
+  end
+
+  it { should respond_to(:min_row) }
+  it { should respond_to(:max_row) }
+  it { should respond_to(:min_col) }
+  it { should respond_to(:max_col) }
+  it { should respond_to(:worksheet) }
+
+  context "default values should be derived from worksheet" do
+    its(:min_row){ should eq 1 }
+    its(:max_row){ should eq 100 }
+    its(:min_col){ should eq 1 }
+    its(:max_col){ should eq 18 }
+  end
+end

data/spec/google_cells/fetcher_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GoogleCells::Fetcher do
+
+  let(:object) do
+    obj = Object.new
+    obj.extend(GoogleCells::Fetcher)
+    obj
+  end
+
+  describe "#raw" do
+    
+    it "returns the raw xml body of an http GET response" do
+      VCR.use_cassette('google_cells/fetcher') do |c|
+        doc = object.raw
+        doc.should_not be_empty
+        Nokogiri::XML(doc).errors.should be_empty
+      end
+    end
+  end
+end

data/spec/google_cells/google_object_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe GoogleCells::GoogleObject do
+
+  context "subclass declaration" do
+
+    class TestObject < GoogleCells::GoogleObject
+      @permanent_attributes = %w{ name email }
+      define_accessors
+    end
+    
+    it "automatically generates accessors for perm attribs" do
+      o = TestObject.new
+      o.should respond_to :name
+      o.should respond_to :email
+    end
+  end
+end

data/spec/google_cells/reader_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe GoogleCells::Reader do
+
+  let(:object) do
+    obj = Object.new
+    obj.extend(GoogleCells::Reader)
+    obj
+  end
+
+  describe "#each_entry" do
+    
+    it "iterates over raw xml entries" do
+      VCR.use_cassette('google_cells/reader') do |c|
+        count = 0
+        object.each_entry do |e|
+          e.class.should eq Nokogiri::XML::Document
+          count +=1
+        end
+        count.should eq 3
+      end
+    end
+  end
+end

data/spec/google_cells/spreadsheet_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe GoogleCells::Spreadsheet do
+  
+  let(:klass){GoogleCells::Spreadsheet}
+
+  it { should respond_to(:title) }
+  it { should respond_to(:key) }
+  it { should respond_to(:updated_at) }
+  it { should respond_to(:author) }
+
+  describe ".share" do
+
+    let(:body){{role:'owner',type:'user',value:'me@me.com'}}
+
+    it "creates a new permission for the passed args" do
+      klass.should_receive(:request).with(:post, "https://www.googleapis.com" + 
+        "/drive/v2/files/0AsfWTr-e4bf1dFVFRWtuSFJWTm1XeWhRdUt2MWwtQnc/"+
+        "permissions", {:body=>"{\"role\":\"" + "owner\",\"type\":\"user\"" + 
+        ",\"value\":\"me@me.com\"}", :url_params=>{},
+        :headers=>{"Content-Type"=>"application/json"}})
+      klass.share('0AsfWTr-e4bf1dFVFRWtuSFJWTm1XeWhRdUt2MWwtQnc', body)
+    end
+  end
+
+  describe ".copy" do
+
+    before(:each) do
+      @s, @c = nil
+      VCR.use_cassette('google_cells/spreadsheet/copy') do
+        @s = GoogleCells::Spreadsheet.list.first
+        @c = klass.copy(s.key)
+      end
+    end
+    let(:s){ @s }
+
+    context "new copy" do
+      subject{ @c }
+
+      its(:key){ should_not eq s.key }
+      its(:title){ should eq s.title }
+
+      it "should have same content" do
+        VCR.use_cassette('google_cells/spreadsheet/copy/content') do
+          svals = s.worksheets[0].rows.first.cells.map(&:value)
+          cvals = @c.worksheets[0].rows.first.cells.map(&:value)
+          svals.should eq cvals
+        end
+      end
+    end
+  end
+
+  describe ".list" do
+
+    before(:each) do
+      @list = []
+      VCR.use_cassette('google_cells/spreadsheet/list') do |c|
+        @list = klass.list
+      end
+    end
+    let(:list){ @list }
+
+    it "returns a list" do
+      list.count.should eq 3
+    end
+
+    it "returns spreadsheet objects" do
+      list.each{|s| s.class.should eq subject.class }
+    end
+
+    context "loading new spreadsheets correcty" do
+      subject {list.first}
+
+      its(:title){ should eq "My Spreadsheet" }
+      its(:updated_at){ should eq '2014-02-23T04:52:51.908Z' }
+      its(:key){ should eq '0ApTxW-6l0Ch_dHFyNHNwX0NjTHVIVk9ZS2duQ2ptUlE' }
+
+      context "author" do
+        subject {list.first.author}
+
+        its(:name){ should eq '194578754295' }
+        its(:email){ should eq '194578754295@developer.gserviceaccount.com' }
+      end
+    end
+  end
+
+  describe ".get" do
+
+    before(:each) do
+      @s = nil
+      VCR.use_cassette('google_cells/spreadsheet/get') do
+        @s = klass.get('0AsfWTr-e4bf1dFVFRWtuSFJWTm1XeWhRdUt2MWwtQnc')
+      end
+    end
+    subject{ @s }
+
+    its(:class){ should eq klass }
+    its(:title){ should eq 'My Spreadsheet' }
+    its(:updated_at){ should eq '2014-02-23T02:25:18.152Z' }
+
+    context "author" do
+      subject{ @s.author }
+      its(:name){ should eq '194578754295' }
+#      its(:email){ should eq '194578754295@developer.gserviceaccount.com' }
+    end
+  end
+
+  describe "#enfold" do
+
+    before(:each) do
+      @s = nil
+      VCR.use_cassette('google_cells/spreadsheet/enfold') do
+        @s = GoogleCells::Spreadsheet.list.first
+        @s.instance_variable_set(:@folders, [])
+        @s.enfold('0B5TxW-6l0Ch_elJwQlVMaGcwTjA')
+      end
+    end
+    
+    context "folders" do
+      subject{ @s.instance_variable_get(:@folders) }
+      its(:count){ should eq 1 }
+
+      it "sets key" do
+        subject.first.key.should eq '0B5TxW-6l0Ch_elJwQlVMaGcwTjA'
+      end
+    end
+  end
+
+  describe "#folders" do
+
+    before(:each) do
+      @s = nil
+      VCR.use_cassette('google_cells/spreadsheet/folders') do
+        @s = GoogleCells::Spreadsheet.list.first
+        @s.folders
+      end
+    end
+    it{ @s.folders.count.should eq 1 }
+
+    context "folders" do
+      subject{ @s.folders.first }
+
+      its(:class){ should eq GoogleCells::Folder }
+      its(:key){ should eq '0AJTxW-6l0Ch_Uk9PVA' }
+    end
+  end
+
+  describe "#worksheets" do
+
+    before(:each) do
+      @s = nil
+      VCR.use_cassette('google_cells/spreadsheet/worksheets') do
+        @s = klass.list.first
+        @s.worksheets.count.should eq 1
+      end
+    end
+    context "worksheets" do
+      subject{ @s.worksheets.first }
+      
+      its(:title){ should eq 'Sheet1' }
+      its(:updated_at){ should eq '2014-02-23T02:25:18.152Z' }
+      its(:cells_uri){ should eq 'https://spreadsheets.google.com/feeds/'+
+        'cells/0ApTxW-6l0Ch_dHFyNHNwX0NjTHVIVk9ZS2duQ2ptUlE/od6/private/full' }
+      its(:lists_uri){ should eq 'https://spreadsheets.google.com/feeds/'+
+        'list/0ApTxW-6l0Ch_dHFyNHNwX0NjTHVIVk9ZS2duQ2ptUlE/od6/private/full' }
+      its(:row_count){ should eq 100 }
+      its(:col_count){ should eq 18 }
+      its(:spreadsheet){ should eq @s }
+    end
+  end
+end