datomic-client 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+* Update to work for 0.8.3520 - makes breaking changes for previous APIs
+* Remove monitor method
+* Add Response#args
+
 ## 0.2.0
 * Added EDN support
 * 2 pending specs fixed

data/README.md

@@ -45,7 +45,6 @@ $ irb -rdatomic/client
 >> datomic.datoms(dbname, 'aevt')
 >> datomic.range(dbname, :a => "db/ident")
 >> datomic.entity(dbname, 1)
->> datomic.monitor(dbname)
 >> datomic.events(dbname) {|r| puts "Received: #{r.inspect}" }
 ```
 
@@ -60,11 +59,6 @@ Please report them [on github](http://github.com/cldwalker/datomic-client/issues
 * @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) - Actual documentation now resides on root

data/lib/datomic/client.rb

@@ -16,44 +16,52 @@ module Datomic
     end
 
     def create_database(dbname)
-      RestClient.put db_url(dbname), {}, &HANDLE_RESPONSE
+      RestClient.post root_url('data', @storage) + "/", {"db-name" => dbname},
+        :content_type => 'application/x-www-form-urlencoded', &HANDLE_RESPONSE
     end
 
-    def database_info(dbname)
-      get db_url(dbname)
+    # Options:
+    # * :t - Specifies version/time of db. Defaults to latest version
+    def database_info(dbname, options = {})
+      version = options.fetch(:t, '-')
+      get db_url(dbname, version) + "/", :Accept => 'application/edn'
     end
 
     # Data can be a ruby data structure or a string representing clojure data
     def transact(dbname, data)
       data = transmute_data(data)
-      RestClient.post(db_url(dbname), data, :content_type => 'application/x-edn', &HANDLE_RESPONSE)
+      RestClient.post(db_url(dbname) + "/", {"tx-data" => data},
+                      :Accept => 'application/edn', &HANDLE_RESPONSE)
     end
 
-    # Index only has certain valid types. See datomic's docs for details.
-    def datoms(dbname, index, params = {})
-      get db_url(dbname, "datoms/#{index}"), :params => params
-    end
-
-    def range(dbname, params = {})
-      get db_url(dbname, 'range'), :params => params
+    # This endpoint hits both datoms and index-range APIs.
+    # params take any param in addition to following options:
+    #
+    # Options:
+    # * :t - Specifies version/time of db. Defaults to latest version
+    def datoms(dbname, params = {})
+      version = params.fetch(:t, '-')
+      get db_url(dbname, version, "datoms"), params
     end
 
+    # params take any param in addition to following options:
+    #
+    # Options:
+    # * :t - Specifies version/time of db. Defaults to latest version
     def entity(dbname, id, params = {})
-      get db_url(dbname, 'entity', id), :params => params
+      version = params.fetch(:t, '-')
+      get db_url(dbname, version, 'entity'), params.merge(:e => id)
     end
 
     # 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)
-      get root_url('monitor', @storage, dbname)
+      get root_url("api/query"), params.merge(:q => query, :args => args)
     end
 
-    # Given block is called with Net::HTTPOK response from event
+    # Streams events. For each event, given block is called with Net::HTTP
+    # response from event
     def events(dbname, &block)
       # can't use RestClient.get b/c of :block_response
       RestClient::Request.execute(:method => :get,
@@ -64,8 +72,9 @@ module Datomic
 
     private
 
-    def get(*args)
-      RestClient.get(*args, &HANDLE_RESPONSE)
+    def get(url, params = {})
+      RestClient.get(url, :params => params, :Accept => 'application/edn',
+                     &HANDLE_RESPONSE)
     end
 
     def root_url(*parts)
@@ -73,7 +82,7 @@ module Datomic
     end
 
     def db_url(dbname, *parts)
-      root_url 'db', @storage, dbname, *parts
+      root_url 'data', @storage, dbname, *parts
     end
 
     def transmute_data(data)

data/lib/datomic/client/response.rb

@@ -5,6 +5,8 @@ module Datomic
       attr_reader :body
       # Underlying Net:HTTP response
       attr_reader :net_http
+      # Args used to make request
+      attr_reader :args
 
       def initialize(body, response, request)
         @body = body

data/lib/datomic/client/version.rb

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

data/spec/datomic_client_spec.rb

@@ -29,8 +29,6 @@ describe Datomic::Client do
     it "returns 200 for existing database" do
       resp = client.database_info('test-database_info')
       resp.code.should == 200
-      resp.data.should have_key(:"basis-t")
-      resp.data.should have_key(:"db/alias")
     end
 
     it "returns database info for existing database" do
@@ -39,8 +37,13 @@ describe Datomic::Client do
       resp.data.should have_key(:"db/alias")
     end
 
+    it "returns 200 for different version" do
+      resp = client.database_info('test-database_info', :t => 1)
+      resp.code.should == 200
+      resp.args[:url].should match(%r{/1/$})
+    end
+
     it "returns 404 for nonexistent database" do
-      pending "docs say 404 but seeing 500"
       resp = client.database_info('zxvf')
       resp.code.should == 404
     end
@@ -51,14 +54,14 @@ describe Datomic::Client do
 
     it "returns correct response with string of data" do
       resp = client.transact('test-transact', schema)
-      resp.code.should == 200
+      resp.code.should == 201
       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.code.should == 201
       resp.data.should be_a(Hash)
       resp.data.keys.sort.should == [:"db-after", :"db-before", :tempids, :"tx-data"]
     end
@@ -69,37 +72,33 @@ describe Datomic::Client do
 
     %w{eavt aevt avet vaet}.each do |index|
       it "returns correct response for index '#{index}'" do
-        pending "possible bug" if index == 'vaet'
-        resp = client.datoms('test-datoms', index)
+        resp = client.datoms('test-datoms', :index => index)
         resp.code.should == 200
         resp.data.should be_a(Array)
       end
     end
 
     it "returns 500 for invalid index" do
-       resp = client.datoms('test-datoms', 'blarg')
+       resp = client.datoms('test-datoms', :index => 'blarg')
        resp.code.should == 500
     end
 
     it "returns correct response with limit param" do
-      resp = client.datoms('test-datoms', "eavt", :limit => 0)
+      resp = client.datoms('test-datoms', :index => "eavt", :limit => 0)
       resp.code.should == 200
       resp.data.should == []
     end
-  end
 
-  describe "#range" do
-    before { client.create_database('test-range') }
-
-    it "returns correct response with required attribute" do
-      resp = client.range('test-range', :a => "db/ident")
+    it "returns correct response for range usage" do
+      resp = client.datoms('test-datoms', :index => 'avet', :a => 'db/ident')
       resp.code.should == 200
       resp.data.should be_a(Array)
     end
 
-    it "returns 400 without required attribute" do
-      resp = client.range('test-range')
-      resp.code.should == 400
+    it "returns correct response for different version" do
+      resp = client.datoms('test-datoms', :t => 2)
+      resp.code.should == 200
+      resp.args[:url].should match(%r{2/datoms$})
     end
   end
 
@@ -117,6 +116,12 @@ describe Datomic::Client do
       resp.code.should == 200
       resp.data.should be_a(Hash)
     end
+
+    it "returns correct response for different version" do
+      resp = client.entity('test-entity', 1, :t => 2)
+      resp.code.should == 200
+      resp.args[:url].should match(%r{2/entity$})
+    end
   end
 
   describe "#query" do
@@ -150,16 +155,6 @@ describe Datomic::Client do
 
   end
 
-  describe "#monitor" do
-    before { client.create_database('test-monitor') }
-
-    it "returns a correct response" do
-      resp = client.monitor('test-monitor')
-      resp.code.should == 200
-      resp.body.should match(/\<script\>/)
-    end
-  end
-
   describe "#events" do
     before { client.create_database('test-events') }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datomic-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1359618081440399035
+      hash: 2191169239501310737
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1359618081440399035
+      hash: 2191169239501310737
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24