active_datastore 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3b916ae69eb1d47e3734ab3d833766118a1ceea4
-  data.tar.gz: 52c7af6d7bb4ef3be9f768adc8eab5187a5799ea
-SHA512:
-  metadata.gz: 287950a37eec281f80d0b22d0582115c8ac759a6015f8e31bda56f78eb9fa6d03de522c2af15a7f7333b8a724c3372330f789f3cef225f1defcfec1a7d738817
-  data.tar.gz: 9e899419c16fb4483ca76f9a2797ddd4b47c1e4071a950e5f7b82e136b468ce174d6436372dcd48478de49f1013bf201379894983723920fde83397fd5ccaef2
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGQ0ZDdhOTg2MjdkNDM1ZjEwYzc5NzE4NzU0YzMyMGNmNTU4NjcxOA==
+  data.tar.gz: !binary |-
+    NzQxYzljYjdiM2I3YWVmYWIwMDliMTEzM2ViYTQzY2UxZmVlMDM3Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGIwOTdmM2VjNGRmNjk5YmM3YjE5ZGMyY2UzNTk4ZWJmODhiNGM5NTczM2Vh
+    OTJjMTEzZmJmYjJjOWE2NGIzM2I3ZWE2ZmE0NTEyMzMzMDViOWE3NTg2N2U2
+    MDgzYWEzZDljNmY1OTIyZmUwOGZlNTdjYmRkODRkZTk5MmNmMDg=
+  data.tar.gz: !binary |-
+    ODE5MTlmYTdjNjU1MjdhMjIwMjUxMDU1MmM2MzY2MDc0M2U5YmQwZDI1MGJk
+    ZDFjNzViOGQzYWZmYjRjNzdiNmY5MjZhNGViYzExNDdmMmZkNGI3NTIwN2Ey
+    YTY2YTY3NWQ2NDgyY2EzMjk5MTFiMWE2ZWEyOTNlZjQxNjE4OGQ=

data/.gitignore

@@ -15,3 +15,9 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+*.p12
+
+spec/credentials.yml
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

@@ -1,4 +1,12 @@
 source 'https://rubygems.org'
+ruby '1.9.3'
 
-# Specify your gem's dependencies in active_datastore.gemspec
+gem 'google-api-client'
+gem 'json'
+gem 'oj'
+gem 'active_support'
+gem 'i18n'
 gemspec
+
+gem 'rspec'
+gem 'pry'

data/README.md

@@ -1,6 +1,13 @@
 # ActiveDatastore
 
-TODO: Write a gem description
+With the release of the [Google Cloud Datastore API](https://developers.google.com/datastore/), it's finally possible to leverage the datastore in pretty much any stack. Since Google seems to be supporting NodeJS, Python and Java right of the bat, it makes sense to bridge the Ruby gap. 
+
+ActiveDatastore is (eventually) meant to be comparable to [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord) in terms of API, features and ease of use. It will rely heavily on [ActiveModel](https://github.com/rails/rails/tree/master/activemodel), but will continue to be framework agnostic and usable with or without [Rails](http://rubyonrails.org/).
+
+## Current Status
+I've built a wrapper over the GCD API (`ActiveDatastore::Dataset`) that's fully functional and can be used for pretty much all the examples given in the documentation. The wrapper's API is very similar to what you see in the NodeJS examples. 
+
+Right now, ActiveDatastore is very much a work in progress. Please evaluate it before production use, and do remember that the API will undergo breaking changes until we hit v1.0.
 
 ## Installation
 
@@ -18,12 +25,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Follow the instructions [here](https://developers.google.com/datastore/docs/activate#google_cloud_datastore_from_other_platforms) to get your **service account** (`AUTH_EMAIL`), **private key** (`AUTH_KEY`) and **dataset id** (`DATASET_ID`).
+
+In your initializer (if you're on Rails you could create `config/initializers/datastore.rb`):
+	
+	require 'active_datastore'
+	
+	AUTH_EMAIL = "something@developer.gserviceaccount.com"
+	AUTH_KEY = File.open("path/to/my/secret.key.p12").read
+	DATASET_ID = "my-dataset"
+	
+	client = ActiveDatastore::Client.new AUTH_EMAIL, AUTH_KEY
+	$dataset = ActiveDatastore::Dataset.new DATASET_ID, client
+
+The initialization of the client seems be performance / network intensive, so it might make sense to do it once and hold the `$dataset` for the lifetime of the application. `ActiveDatastore::Dataset` is stateless and should support this.
+
+To make calls to the datastore, use the methods documented on the [JSON API Reference](https://developers.google.com/datastore/docs/apis/v1beta1/datasets) (but remember use the underscore equivalent names.)
+
+	start_response = $dataset.begin_transaction({
+	  isolationLevel: "snapshot"
+	})
+	
+	start_response.data.kind    # Should be "datastore#beginTransactionResponse"
+	transaction_id = start_response.data.transaction
+
+	rollback_response = $dataset.rollback({
+	  transaction: transaction_id
+	})
+	
+	rollback_response.data.kind    # Should be "datastore#rollbackResponse"  
+
+Remeber that both the request body and the `response.data` are hashes with camel case keys, as shown in the [docs](https://developers.google.com/datastore/docs/apis/v1beta1/datasets/lookup#response). I know it's a little inconsistent that way, but an effort to deeply walk through each hash and convert keys will probably be more trouble than it's worth.
+
 
 ## Contributing
 
-1. Fork it
+1. Fork the repo
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. **WRITE GOOD AND CLEAR TESTS**. Do remember that this gem may be used in production to serve millions of requests. Bugs can be catastrophic. Also, I can't merge and maintain code I don't fully understand.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/active_datastore.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = ActiveDatastore::VERSION
   spec.authors       = ["Sudhir Jonathan"]
   spec.email         = ["sudhir.j@gmail.com"]
-  spec.description   = "Active Wrapper for GCD"
-  spec.summary       = "Wrapper for Google Cloud datastore"
-  spec.homepage      = ""
+  spec.description   = "With the release of the Google Cloud Datastore API, its now possible to use the full power of Google's datastore in Ruby apps. ActiveDatastore is right now a clean wrapper over the API, and I'd like to take to a point where it's camparable and similar to ActiveRecord."
+  spec.summary       = "ODM (Object-Document-Mapper) for the Google Cloud Datastore."
+  spec.homepage      = "https://github.com/sudhirj/active_datastore"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/active_datastore.rb

@@ -1,4 +1,8 @@
+require 'active_support/all'
+
 require "active_datastore/version"
+require "active_datastore/client"
+require "active_datastore/dataset"
 
 module ActiveDatastore
   # Your code goes here...

data/lib/active_datastore/client.rb

@@ -0,0 +1,32 @@
+require 'google/api_client'
+
+module ActiveDatastore
+  class Client
+    def initialize email, secret
+      @client = Google::APIClient.new
+      key = Google::APIClient::KeyUtils.load_from_pkcs12(secret, 'notasecret')
+      service_account = Google::APIClient::JWTAsserter.new(
+        email,
+        ['https://www.googleapis.com/auth/datastore', 'https://www.googleapis.com/auth/userinfo.email'],
+      	key)
+      @client.authorization = service_account.authorize
+
+    end
+
+    def valid?
+    	not @client.authorization.expired?
+    end
+
+    def api
+    	@api ||= @client.discovered_api('datastore', 'v1beta1').datasets
+    end
+
+    def execute opts
+    	@client.execute({
+    		api_method: api.send(opts[:method]),
+    		body_object: opts[:body],
+    		parameters: opts[:params]
+    	})
+    end
+  end
+end

data/lib/active_datastore/dataset.rb

@@ -0,0 +1,15 @@
+module ActiveDatastore
+	class Dataset
+		METHODS = [:allocate_ids, :begin_transaction, :blind_write, :commit, :lookup, :rollback, :run_query]
+		def initialize dataset_id, client
+			@client = client
+			@dataset_id = dataset_id
+		end
+
+		METHODS.each do |method|
+			define_method method do |body={}|
+				@client.execute method: method, body: body, params: {datasetId: @dataset_id}
+			end
+		end
+	end
+end

data/lib/active_datastore/version.rb

@@ -1,3 +1,3 @@
 module ActiveDatastore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/client_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'pry'
+describe ActiveDatastore::Client do
+
+	let (:client) { ActiveDatastore::Client.new AUTH_EMAIL, AUTH_KEY }
+
+  it 'should connect to the GCD, given credentials' do
+  	client.valid?.should be_true
+  end
+
+  it 'should discover the datastore api' do
+  	client.api.lookup.generate_uri(datasetId: 'abc').to_s.should == "https://www.googleapis.com/datastore/v1beta1/datasets/abc/lookup"
+  end
+
+  it 'should execute calls made using the google client' do
+  	response = client.execute method: :begin_transaction, body: {"isolationLevel" => "snapshot"}, params: {datasetId: 'active-datastore-test'}
+  	response.data.transaction.should_not be_nil
+  	response.data.kind.should == 'datastore#beginTransactionResponse'
+  end
+end

data/spec/credentials.yml.example

@@ -0,0 +1,2 @@
+EMAIL: "something@developer.gserviceaccount.com"
+KEY_PATH: "key.p12 (the path from the top level gem directory)"

data/spec/dataset_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ActiveDatastore::Dataset do
+  let (:client) { ActiveDatastore::Client.new AUTH_EMAIL, AUTH_KEY }
+  let (:dataset) { ActiveDatastore::Dataset.new 'active-datastore-test', client }
+
+  it "should have all the datastore api methods" do
+  	discovered_methods = client.api.discovered_methods.map(&:id).map{|n| n.split('.')[2]}.map(&:underscore).map(&:to_sym)
+  	ActiveDatastore::Dataset::METHODS.sort.should == discovered_methods.sort
+
+    ActiveDatastore::Dataset::METHODS.each do |method|
+      dataset.respond_to?(method).should be_true
+    end
+  end
+
+  it "should execute corresponding methods on the client with the given parameters, always including the dataset id" do
+  	ActiveDatastore::Dataset::METHODS.each do |method|
+      client.should_receive(:execute).with(method: method, body: {abc: 42}, params: {datasetId: 'active-datastore-test'} )
+  		dataset.send(method, {abc: 42})
+    end
+  end
+
+  context "transactions" do
+  	it 'should start and rollback a transaction' do
+  		start_response = dataset.begin_transaction
+  		start_response.data.kind.should == "datastore#beginTransactionResponse"
+  		start_response.data.transaction.should_not be_nil
+
+  		rollback_response = dataset.rollback({transaction: start_response.data.transaction})
+  		rollback_response.data.kind.should == "datastore#rollbackResponse"
+  	end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_datastore'
+
+credentials = YAML.load File.open 'spec/credentials.yml'
+
+AUTH_EMAIL = credentials["EMAIL"]
+AUTH_KEY = File.open(credentials["KEY_PATH"]).read
+
+RSpec.configure do |config|
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_datastore
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sudhir Jonathan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,17 +28,20 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Active Wrapper for GCD
+description: With the release of the Google Cloud Datastore API, its now possible
+  to use the full power of Google's datastore in Ruby apps. ActiveDatastore is right
+  now a clean wrapper over the API, and I'd like to take to a point where it's camparable
+  and similar to ActiveRecord.
 email:
 - sudhir.j@gmail.com
 executables: []
@@ -46,14 +49,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_datastore.gemspec
 - lib/active_datastore.rb
+- lib/active_datastore/client.rb
+- lib/active_datastore/dataset.rb
 - lib/active_datastore/version.rb
-homepage: ''
+- spec/client_spec.rb
+- spec/credentials.yml.example
+- spec/dataset_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sudhirj/active_datastore
 licenses:
 - MIT
 metadata: {}
@@ -63,12 +74,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -76,5 +87,9 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Wrapper for Google Cloud datastore
-test_files: []
+summary: ODM (Object-Document-Mapper) for the Google Cloud Datastore.
+test_files:
+- spec/client_spec.rb
+- spec/credentials.yml.example
+- spec/dataset_spec.rb
+- spec/spec_helper.rb