appengine-apis 0.0.1

data/lib/appengine-apis/testing.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/ruby1.8 -w
+#
+# Copyright:: Copyright 2007 Google Inc.
+# Original Author:: Ryan Brown (mailto:ribrdb@google.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+# Helpers for installing stub apis in unit tests.
+
+require 'appengine-apis/apiproxy'
+
+module AppEngine
+  module Testing
+    import com.google.appengine.tools.development.ApiProxyLocalFactory
+    import com.google.appengine.api.datastore.dev.LocalDatastoreService
+
+    class TestEnv  # :nodoc:
+      include AppEngine::ApiProxy::Environment
+      
+      attr_writer :appid, :version, :email, :admin, :logged_in
+      attr_writer :auth_domain, :request_namespace, :default_namespace
+      
+      def initialize
+        @appid = "test"
+        @version = "1.0"
+        @auth_domain = "gmail.com"
+      end
+      
+      def getAppId
+        @appid
+      end
+      
+      def getVersionId
+        @version
+      end
+      
+      def getEmail
+        @email
+      end
+      
+      def isLoggedIn
+        @logged_in
+      end
+      
+      def isAdmin
+        @admin
+      end
+      
+      def getAuthDomain
+        @auth_domain
+      end
+      
+      def getRequestNamespace
+        @request_namespace
+      end
+      
+      def getDefaultNamespace
+        @default_namespace
+      end
+      
+      def setDefaultNamespace(s)
+        @default_namespace = s
+      end      
+    end
+    
+    class << self
+      def install_test_env
+        env = TestEnv.new
+        ApiProxy::setEnvironmentForCurrentThread(env)
+        env
+      end
+      
+      def factory
+        @factory ||= ApiProxyLocalFactory.new
+      end
+      
+      def app_dir
+        file = factory.getApplicationDirectory
+        file && file.path
+      end
+      
+      def app_dir=(dir)
+        factory.setApplicationDirectory(java.io.File.new(dir))
+      end
+      
+      # Force all datastore operations to use an in-memory datastore.
+      def install_test_datastore
+        self.app_dir = '.' if app_dir.nil?
+        delegate = factory.create
+        delegate.set_property(
+            LocalDatastoreService::NO_STORAGE_PROPERTY, "true")
+        delegate.set_property(
+            LocalDatastoreService::MAX_QUERY_LIFETIME_PROPERTY,
+            java.lang.Integer::MAX_VALUE.to_s)
+        delegate.set_property(
+            LocalDatastoreService::MAX_TRANSACTION_LIFETIME_PROPERTY,
+            java.lang.Integer::MAX_VALUE.to_s)
+        ApiProxy::setDelegate(delegate)
+        delegate
+      end
+      
+      def install_api_stubs
+        self.app_dir = '.' if app_dir.nil?
+        delegate = factory.create
+        ApiProxy::setDelegate(delegate)
+        delegate
+      end
+      
+    end
+
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/appengine-apis.rb'}"
+puts "Loading appengine-apis gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/datastore_spec.rb

@@ -0,0 +1,150 @@
+# Copyright:: Copyright 2009 Google Inc.
+# Original Author:: Ryan Brown (mailto:ribrdb@google.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'appengine-apis/datastore'
+
+describe AppEngine::Datastore do
+  Datastore = AppEngine::Datastore
+  
+  before :each do
+    AppEngine::Testing.install_test_datastore
+  end
+  
+  it "should support get/put" do
+    entity = Datastore::Entity.new("Test")
+    entity[:a] = "a"
+    entity[:b] = "b"
+    key = Datastore.put(entity)
+    entity.key.should == key
+    stored = Datastore.get(key)
+    stored.should == entity
+    stored[:a].should == "a"
+    stored[:b].should == "b"
+  end
+  
+  it "should put many" do
+    a = Datastore::Entity.new("A")
+    b = Datastore::Entity.new("B")
+    keys = Datastore.put(a, b)
+    keys.size.should == 2
+    keys[0].kind.should == "A"
+    keys[1].kind.should == "B"
+    got = Datastore.get(keys)
+    got.size.should == 2
+    got[0].should == a
+    got[1].should == b
+  end
+
+  it "should support failed transactions" do
+    pending("Real local transactions") do
+      a = Datastore::Entity.new("A")
+      a[:a] = 0
+      Datastore.put(a)
+      p = lambda do
+        Datastore.transaction do
+          a2 = Datastore.get(a.key)
+          a[:a] += 1
+          Datastore.put(nil, a)
+          Datastore.put(a2)
+        end
+      end
+      p.should raise_error Datastore::TransactionFailed
+    end
+  end
+
+  it "should retry transactions" do
+    pending("Real local transactions") do
+      a = Datastore::Entity.new("A")
+      a[:a] = 0
+      Datastore.put(a)
+      Datastore.transaction(3) do
+        a2 = Datastore.get(a.key)
+        a[:a] += 1
+        Datastore.put(nil, a) if a[:a] < 3
+        a2[:a] = "2: #{a2[:a]}"
+        Datastore.put(a2)
+      end
+  
+      Datastore.get(a.key)[:a].should == '2: 2'
+    end
+  end
+  
+  it "should close transactions" do
+    lambda {Datastore.transaction{ raise "Foo"}}.should raise_error "Foo"
+    Datastore.active_transactions.to_a.should == []
+  end
+end
+
+describe AppEngine::Datastore::Query do
+  Datastore = AppEngine::Datastore
+  Query = AppEngine::Datastore::Query
+  
+  before :all do
+    AppEngine::Testing.install_test_datastore
+    @a = Datastore::Entity.new("A")
+    @a['name'] = 'a'
+    Datastore.put(@a)
+    
+    @aa = Datastore::Entity.new("A", @a.key)
+    @aa['name'] = 'aa'
+    
+    @b = Datastore::Entity.new("B")
+    @b['name'] = 'b'
+    
+    @ab = Datastore::Entity.new("B", @a.key)
+    @ab['name'] = 'ab'
+    Datastore.put(@aa, @ab, @b)
+  end
+
+  it "should support chaining" do
+    q = Query.new("Foo")
+    q.set_ancestor(@a.key).sort('name').filter(
+        'name', Query::EQUAL, 'Bob').should == q
+  end
+  
+  it "should support ancestor" do
+    a = @a.key
+    q = Query.new("A", a)
+    q.java_query.ancestor.should == a
+    q.fetch.to_a.should == [@a, @aa]
+    
+    q = Query.new("A")
+    q.set_ancestor(a)
+    q.java_query.ancestor.should == a
+    q.fetch.to_a.should == [@a, @aa]
+    
+    q = Query.new("A")
+    q.ancestor = a
+    q.java_query.ancestor.should == a
+    q.fetch.to_a.should == [@a, @aa]
+  end
+  
+  it "should support ancestor only" do
+    a = @a.key
+    q = Query.new(a)
+    q.java_query.ancestor.should == a
+    pending("Local ancestory only queries") do
+      q.fetch.to_a.should == [@a, @aa, @ab]
+    end
+  end
+  
+  it "should support sort" do
+    q = Query.new("A")
+    q.sort('name', Query::DESCENDING)
+    q.fetch.to_a.should == [@aa, @a]
+  end
+
+end

data/spec/datastore_types_spec.rb

@@ -0,0 +1,198 @@
+# Copyright:: Copyright 2009 Google Inc.
+# Original Author:: Ryan Brown (mailto:ribrdb@google.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'appengine-apis/datastore_types'
+
+describe AppEngine::Datastore::Key do
+  Key = AppEngine::Datastore::Key
+  
+  it "should support ==" do
+    a1 = Key.from_path("A", 1)
+    a2 = Key.from_path("A", 1)
+    a1.should == a2
+    a2.should.eql? a1
+    a1.hash.should == a2.hash
+    pending("Key.compareTo") do
+      (a1 <=> a2).should == 0
+    end
+  end
+
+  it "should support <=>" do
+    pending("Key.compareTo") do
+      a1 = Key.from_path("A", 1)
+      a2 = Key.from_path("A", 2)
+      a1.should < a2
+      a2.should > a1
+      (a1 <=> a2).should == -1
+      (a2 <=> a1).should == 1
+    end
+  end
+  
+  it "should create from id" do
+    key = Key.from_path("Foo", 27)
+    key.kind.should == 'Foo'
+    key.id.should == 27
+    key.id_or_name.should == 27
+  end
+  
+  it "should create from name" do
+    key = Key.from_path("Bar", 'baz')
+    key.kind.should == 'Bar'
+    key.name.should == 'baz'
+    key.id_or_name.should == 'baz'
+  end
+  
+  it "should create with parent" do
+    parent = Key.from_path("Foo", 1)
+    key = Key.from_path(parent, "Bar", 2)
+    key.kind.should == 'Bar'
+    key.id.should == 2
+    key.parent.should == parent
+  end
+  
+  it "should support long paths" do
+    key = Key.from_path('A', 1, 'B', 2, 'C', 3)
+    key.kind.should == 'C'
+    key.id.should == 3
+    key.parent.kind.should == 'B'
+    key.parent.id.should == 2
+    key.parent.parent.kind.should == 'A'
+    key.parent.parent.id.should == 1
+  end
+  
+  it "should encode" do
+    key = Key.from_path('Foo', 'bar')
+    key.to_s.should == 'agR0ZXN0cgwLEgNGb28iA2Jhcgw'
+  end
+  
+  it "should create from encoded" do
+    decoded = Key.new('agR0ZXN0cgwLEgNGb28iA2Jhcgw')
+    key = Key.from_path('Foo', 'bar')
+    decoded.should == key
+  end
+  
+end
+
+describe AppEngine::Datastore::Entity do
+
+  before :each do
+    @entity = AppEngine::Datastore::Entity.new('Test')
+  end
+  
+  it "should support nil" do
+    @entity['nil'] = nil
+    @entity.has_property?('nil').should == true
+    @entity['nil'].should == nil
+  end
+  
+  it "should support true" do
+    @entity['true'] = true
+    @entity['true'].should == true
+  end
+  
+  it "should support false" do
+    @entity['false'] = false
+    @entity['false'].should == false
+  end
+    
+  it "should support Strings" do
+    @entity['string'] = 'a string'
+    @entity['string'].should == 'a string'
+  end
+  
+  it "should support Integers" do
+    @entity['int'] = 42
+    @entity['int'].should == 42
+  end
+  
+  it "should support Floats" do
+    @entity['float'] = 3.1415
+    @entity['float'].should == 3.1415
+  end
+  
+  it "should support Symbol for name" do
+    @entity[:foo] = 'bar'
+    @entity[:foo].should == 'bar'
+    @entity['foo'].should == 'bar'
+  end
+  
+  it "should support Text" do
+    text = 'Some text. ' * 1000
+    @entity['text'] = AppEngine::Datastore::Text.new(text)
+    @entity['text'].should == text
+    @entity['text'].class.should == AppEngine::Datastore::Text
+  end
+  
+  it "should support Blob" do
+    blob = "\0\1\2" * 1000
+    @entity['blob'] = AppEngine::Datastore::Blob.new(blob)
+    @entity['blob'].should == blob
+    @entity['blob'].class.should == AppEngine::Datastore::Blob
+  end
+  
+  it "should support ByteString" do
+    blob = "\0\1\2"
+    @entity['blob'] = AppEngine::Datastore::ByteString.new(blob)
+    @entity['blob'].should == blob
+    @entity['blob'].class.should == AppEngine::Datastore::ByteString
+  end
+  
+  it "should support Link" do
+    link = "http://example.com/" + "0" * 1000
+    @entity['link'] = AppEngine::Datastore::Link.new(link)
+    @entity['link'].should == link
+    @entity['link'].class.should == AppEngine::Datastore::Link
+  end
+  
+  it "should support Time" do
+    time = Time.now - 3600
+    @entity['time'] = time
+    @entity['time'].to_s.should == time.to_s
+    @entity['time'].class.should == Time
+  end
+  
+  it "should support multiple values" do
+    list = [1, 2, 3]
+    @entity['list'] = list
+    @entity['list'].should == list
+  end
+  
+  it "should not support random types" do
+      lambda{@entity['foo'] = Kernel}.should raise_error(ArgumentError)
+  end
+  
+  it "should support delete" do
+    @entity['foo'] = 'bar'
+    @entity.delete('foo')
+    @entity.has_property?('foo').should == false
+  end
+    
+  it "should support delete symbol" do
+    @entity['foo'] = 'bar'
+    @entity.delete(:foo)
+    @entity.has_property?('foo').should == false
+  end
+  
+  it "should support each" do
+    props = {'foo' => 'bar', 'count' => 3}
+    props.each {|name, value| @entity[name] = value}
+    @entity.each do |name, value|
+      props.delete(name).should == value
+    end
+    props.should == {}
+  end
+    
+end