datomic-client 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,2 +1,7 @@
+## 0.2.0
+* Added EDN support
+* 2 pending specs fixed
+* Introduced our own Response object
+
 ## 0.1.0
 * Initial release that works with datomic 0.8.3488!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -16,21 +16,35 @@ and then `bundle`.
 
 ## Usage
 
-```sh
+```ruby
 # In another shell in datomic's directory
 $ bin/rest 9000 socrates datomic:mem://
 
+# Assuming you have a schema with a :"community/name" attribute
 # In project's directory
 $ irb -rdatomic/client
 >> dbname = 'cosas'
 >> datomic = Datomic::Client.new 'http://localhost:9000', 'socrates'
->> datomic.create_database(dbname)
+>> resp = datomic.create_database(dbname)
+=> #<Datomic::Client::Response:0x0000010157bc58 @body="", @args={:method=>:put,
+:url=>"http://localhost:9000/db/socrates/test-1347638297", :payload=>{}, :headers=>{}},
+@net_http=#<Net::HTTPCreated 201 Created readbody=true>, @rest_client_response="">
+>> resp.code
+=> 201
+>> resp.body
+=> ''
+
+# Most responses are in edn and thus can be accessed natively
+>> resp = datomic.query(dbname, '[:find ?c :where [?c :community/name]]')
+>> resp.data
+=> [[1]]
+
+# additional endpoints
 >> datomic.database_info(dbname)
->> datomic.transact(dbname, "TODO")
+>> datomic.transact(dbname, [[:"db/add", 1, :"community/name", "Some Community"]])
 >> datomic.datoms(dbname, 'aevt')
 >> datomic.range(dbname, :a => "db/ident")
->> datomic.entity(1)
->> datomic.query("TODO")
+>> datomic.entity(dbname, 1)
 >> datomic.monitor(dbname)
 >> datomic.events(dbname) {|r| puts "Received: #{r.inspect}" }
 ```
@@ -43,13 +57,16 @@ Please report them [on github](http://github.com/cldwalker/datomic-client/issues
 
 ## Credits
 
+* @crnixon for adding edn support
 * @flyingmachine for starting this with me
 
 ##Todo
 
+* Allow entity endpoint to take an e param
 * Fix pending specs
 
 ## Links
 
-* [API documentation](http://docs.datomic.com/rest.html)
+* [API documentation](http://docs.datomic.com/rest.html) - Actual documentation now resides on root
+  url of datomic endpoint
 * [Initial announcement](http://blog.datomic.com/2012/09/rest-api.html)

data/Rakefile

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

data/datomic-client.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "datomic/client"
+require File.expand_path('../lib/datomic/client/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "datomic-client"
@@ -17,7 +16,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 2.11'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
-  s.add_dependency 'rest-client'
+  s.add_dependency 'rest-client', '~> 1.6.7'
+  s.add_dependency 'edn', '~> 0.9.1'
 end

data/lib/datomic/client.rb

@@ -1,8 +1,14 @@
+require 'datomic/client/version'
+require 'datomic/client/response'
 require 'rest-client'
+require 'set' # Remove when fixed upstream
+require 'edn'
 
 module Datomic
   class Client
-    VERSION = '0.1.0'
+    HANDLE_RESPONSE = lambda do |body, request, response|
+      Response.new body, response, request
+    end
 
     def initialize(url, storage = nil)
       @url = url
@@ -10,47 +16,58 @@ module Datomic
     end
 
     def create_database(dbname)
-      RestClient.put db_url(dbname), {}
+      RestClient.put db_url(dbname), {}, &HANDLE_RESPONSE
     end
 
     def database_info(dbname)
-      RestClient.get db_url(dbname)
+      get db_url(dbname)
     end
 
+    # Data can be a ruby data structure or a string representing clojure data
     def transact(dbname, data)
-      RestClient.post db_url(dbname), data
+      data = transmute_data(data)
+      RestClient.post(db_url(dbname), data, :content_type => 'application/x-edn', &HANDLE_RESPONSE)
     end
 
+    # Index only has certain valid types. See datomic's docs for details.
     def datoms(dbname, index, params = {})
-      RestClient.get db_url(dbname, "datoms/#{index}"), :params => params
+      get db_url(dbname, "datoms/#{index}"), :params => params
     end
 
     def range(dbname, params = {})
-      RestClient.get db_url(dbname, 'range'), :params => params
+      get db_url(dbname, 'range'), :params => params
     end
 
     def entity(dbname, id, params = {})
-      RestClient.get db_url(dbname, 'entity', id), :params => params
+      get db_url(dbname, 'entity', id), :params => params
     end
 
-    def query(query, params = {})
-      RestClient.get root_url("api/query"), :params => params.merge(:q => query)
+    # Query can be a ruby data structure or a string representing clojure data
+    def query(dbname, query, params = {})
+      query = transmute_data(query)
+      args = [{:"db/alias" => [@storage, dbname].join('/')}].to_edn
+      get root_url("api/query"), :params => params.merge(:q => query, :args => args)
     end
 
     def monitor(dbname)
-      RestClient.get root_url('monitor', @storage, dbname)
+      get root_url('monitor', @storage, dbname)
     end
 
     # Given block is called with Net::HTTPOK response from event
     def events(dbname, &block)
+      # can't use RestClient.get b/c of :block_response
       RestClient::Request.execute(:method => :get,
         :url => root_url('events', @storage, dbname),
         :headers => {:accept => "text/event-stream"},
-        :block_response => block)
+        :block_response => block, &HANDLE_RESPONSE)
     end
 
     private
 
+    def get(*args)
+      RestClient.get(*args, &HANDLE_RESPONSE)
+    end
+
     def root_url(*parts)
       [@url].concat(parts).join('/')
     end
@@ -58,5 +75,9 @@ module Datomic
     def db_url(dbname, *parts)
       root_url 'db', @storage, dbname, *parts
     end
+
+    def transmute_data(data)
+      data.is_a?(String) ? data : data.to_edn
+    end
   end
 end

data/lib/datomic/client/response.rb

@@ -0,0 +1,29 @@
+module Datomic
+  class Client
+    class Response
+      # Response body as a string
+      attr_reader :body
+      # Underlying Net:HTTP response
+      attr_reader :net_http
+
+      def initialize(body, response, request)
+        @body = body
+        @args = request.args
+        @net_http = response
+        # used to parse response cookies and headers
+        @rest_client_response = RestClient::Response.create(body, response, @args)
+      end
+
+      # converts an EDN body to a data structure i.e. array, hash
+      def data
+        @data ||= EDN.read @body
+      end
+
+      [:code, :headers, :cookies, :raw_headers].each do |meth|
+        define_method(meth) do
+          @rest_client_response.public_send(meth)
+        end
+      end
+    end
+  end
+end

data/lib/datomic/client/version.rb

@@ -0,0 +1,5 @@
+module Datomic
+  class Client
+    VERSION = '0.2.0'
+  end
+end

data/spec/datomic_client_spec.rb

@@ -1,15 +1,13 @@
 require 'datomic/client'
 
+# datomic's `rest` needs to run for these tests to pass i.e.
+#   bin/rest 9000 socrates datomic:mem://
 describe Datomic::Client do
   let(:datomic_uri) { ENV['DATOMIC_URI'] || 'http://localhost:9000' }
-  # datomic's `rest` needs to run for these tests to pass i.e.
-  #   bin/rest 9000 socrates datomic:mem://
   let(:client) do
     Datomic::Client.new datomic_uri, ENV['DATOMIC_STORAGE'] || 'socrates'
   end
-
-  VEC = /^\[.*\]$/
-  MAP = /^\{.*\}$/
+  let(:schema) { File.read(File.expand_path('../fixtures/seattle-schema.dtm', __FILE__)) }
 
   describe "#create_database" do
     it "returns 201 when creating a new database" do
@@ -31,14 +29,14 @@ describe Datomic::Client do
     it "returns 200 for existing database" do
       resp = client.database_info('test-database_info')
       resp.code.should == 200
-      resp.body.should include(':basis-t')
-      resp.body.should include(':db/alias')
+      resp.data.should have_key(:"basis-t")
+      resp.data.should have_key(:"db/alias")
     end
 
     it "returns database info for existing database" do
       resp = client.database_info('test-database_info')
-      resp.body.should include(':basis-t')
-      resp.body.should include(':db/alias')
+      resp.data.should have_key(:"basis-t")
+      resp.data.should have_key(:"db/alias")
     end
 
     it "returns 404 for nonexistent database" do
@@ -51,11 +49,18 @@ describe Datomic::Client do
   describe "#transact" do
     before { client.create_database('test-transact') }
 
-    it "returns correct response" do
-      pending "til valid transaction data given"
-      resp = client.transact('test-transact', "[:db/add 1 :some :value]")
+    it "returns correct response with string of data" do
+      resp = client.transact('test-transact', schema)
+      resp.code.should == 200
+      resp.data.should be_a(Hash)
+      resp.data.keys.sort.should == [:"db-after", :"db-before", :tempids, :"tx-data"]
+    end
+
+    it "returns correct response with array of data" do
+      resp = client.transact('test-transact', [[:"db/add", 1, :"community/name", "Some Community"]])
       resp.code.should == 200
-      resp.body.should match MAP
+      resp.data.should be_a(Hash)
+      resp.data.keys.sort.should == [:"db-after", :"db-before", :tempids, :"tx-data"]
     end
   end
 
@@ -67,19 +72,19 @@ describe Datomic::Client do
         pending "possible bug" if index == 'vaet'
         resp = client.datoms('test-datoms', index)
         resp.code.should == 200
-        resp.body.should match VEC
+        resp.data.should be_a(Array)
       end
     end
 
-    it "raises 500 error for invalid index" do
-       expect { client.datoms('test-datoms', 'blarg') }.
-         to raise_error(RestClient::InternalServerError, /500 Internal Server Error/)
+    it "returns 500 for invalid index" do
+       resp = client.datoms('test-datoms', 'blarg')
+       resp.code.should == 500
     end
 
     it "returns correct response with limit param" do
       resp = client.datoms('test-datoms', "eavt", :limit => 0)
       resp.code.should == 200
-      resp.body.should == "[]"
+      resp.data.should == []
     end
   end
 
@@ -89,12 +94,12 @@ describe Datomic::Client do
     it "returns correct response with required attribute" do
       resp = client.range('test-range', :a => "db/ident")
       resp.code.should == 200
-      resp.body.should match VEC
+      resp.data.should be_a(Array)
     end
 
-    it "raises 400 without required attribute" do
-      expect { client.range('test-range') }.
-        to raise_error(RestClient::BadRequest, /400 Bad Request/)
+    it "returns 400 without required attribute" do
+      resp = client.range('test-range')
+      resp.code.should == 400
     end
   end
 
@@ -104,25 +109,45 @@ describe Datomic::Client do
     it "returns correct response" do
       resp = client.entity('test-entity', 1)
       resp.code.should == 200
-      resp.body.should match MAP
+      resp.data.should be_a(Hash)
     end
 
     it "returns correct response with valid param" do
       resp = client.entity('test-entity', 1, :since => 0)
       resp.code.should == 200
-      resp.body.should match MAP
+      resp.data.should be_a(Hash)
     end
   end
 
   describe "#query" do
-    let(:client) { Datomic::Client.new datomic_uri }
+    before {
+      client.create_database('test-query')
+      client.transact('test-query', schema)
+      client.transact('test-query', [[:"db/add", 1, :"community/name", "Some Community"]])
+    }
+
+    it "returns a correct response with a string query" do
+      resp = client.query('test-query', '[:find ?c :where [?c :community/name]]')
+      resp.code.should == 200
+      resp.data.should be_a(Array)
+      resp.data.should == [[1]]
+    end
 
-    it "returns a correct response" do
-      pending "til valid query given"
-      resp = client.query("[:find ?e :where [?e :id 1]]")
+    it "returns a correct response with limit param" do
+      resp = client.query('test-query', '[:find ?c :where [?c :community/name]]', :limit => 0)
+      resp.code.should == 200
+      resp.data.should be_a(Array)
+      resp.data.should == []
+    end
+
+    it "returns a correct response with a data query" do
+      resp = client.query('test-query',
+                    [:find, EDN::Type::Symbol.new('?c'), :where,
+                          [EDN::Type::Symbol.new('?c'), :"community/name"]])
       resp.code.should == 200
-      resp.body.should match VEC
+      resp.data.should be_a(Array)
     end
+
   end
 
   describe "#monitor" do
@@ -150,8 +175,8 @@ describe Datomic::Client do
     end
 
     it "returns a 503 for nonexistent db" do
-      expect { client.events('zzzz') }.
-        to raise_error(RestClient::ServiceUnavailable, /503 Service Unavailable/)
+      resp = client.events('zzzz')
+      resp.code.should == 503
     end
   end
 end

data/spec/datomic_response_spec.rb

@@ -0,0 +1,32 @@
+require 'datomic/client'
+
+describe Datomic::Client::Response do
+  let(:datomic_uri) { ENV['DATOMIC_URI'] || 'http://localhost:9000' }
+  let(:client) do
+    Datomic::Client.new datomic_uri, ENV['DATOMIC_STORAGE'] || 'socrates'
+  end
+
+  describe '.new' do
+    let(:resp) { client.create_database("test-#{Time.now.to_i}") }
+
+    it "returns a valid code" do
+      resp.code.should be_a Integer
+    end
+
+    it "returns a valid string" do
+      resp.body.should be_a String
+    end
+
+    it "returns valid headers" do
+      resp.headers.should be_a Hash
+    end
+
+    it "returns valid cookies" do
+      resp.cookies.should be_a Hash
+    end
+
+    it "returns valid raw headers" do
+      resp.raw_headers.should be_a Hash
+    end
+  end
+end

data/spec/fixtures/seattle-schema.dtm

@@ -0,0 +1,9 @@
+[
+ {:db/id #db/id[:db.part/db]
+  :db/ident :community/name
+  :db/valueType :db.type/string
+  :db/cardinality :db.cardinality/one
+  :db/fulltext true
+  :db/doc "A community's name"
+  :db.install/_attribute :db.part/db}
+ ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datomic-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,30 +64,52 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: edn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: This gem provides a simple way to use datomic's http API - http://docs.datomic.com/rest.html.
 email: gabriel.horner@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - datomic-client.gemspec
 - lib/datomic/client.rb
+- lib/datomic/client/response.rb
+- lib/datomic/client/version.rb
 - spec/datomic_client_spec.rb
+- spec/datomic_response_spec.rb
+- spec/fixtures/seattle-schema.dtm
 homepage: http://github.com/cldwalker/datomic-client
 licenses: []
 post_install_message: 
@@ -100,12 +122,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1359618081440399035
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1359618081440399035
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -114,3 +142,5 @@ specification_version: 3
 summary: http client for datomic's API
 test_files:
 - spec/datomic_client_spec.rb
+- spec/datomic_response_spec.rb
+- spec/fixtures/seattle-schema.dtm