datomic-client 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+* Initial release that works with datomic 0.8.3488!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2012 Gabriel Horner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+## Description
+
+This gem provides a simple way to use datomic's [http API](http://docs.datomic.com/rest.html).
+
+## Install
+
+Install as a gem:
+
+    $ gem install datomic-client
+
+If your application is using a Gemfile, add this to it:
+
+    gem 'datomic-client', :require => 'datomic/client'
+
+and then `bundle`.
+
+## Usage
+
+```sh
+# In another shell in datomic's directory
+$ bin/rest 9000 socrates datomic:mem://
+
+# In project's directory
+$ irb -rdatomic/client
+>> dbname = 'cosas'
+>> datomic = Datomic::Client.new 'http://localhost:9000', 'socrates'
+>> datomic.create_database(dbname)
+>> datomic.database_info(dbname)
+>> datomic.transact(dbname, "TODO")
+>> datomic.datoms(dbname, 'aevt')
+>> datomic.range(dbname, :a => "db/ident")
+>> datomic.entity(1)
+>> datomic.query("TODO")
+>> datomic.monitor(dbname)
+>> datomic.events(dbname) {|r| puts "Received: #{r.inspect}" }
+```
+
+## Issues
+Please report them [on github](http://github.com/cldwalker/datomic-client/issues).
+
+## Contributing
+[See here](http://tagaholic.me/contributing.html) for contribution policies.
+
+## Credits
+
+* @flyingmachine for starting this with me
+
+##Todo
+
+* Fix pending specs
+
+## Links
+
+* [API documentation](http://docs.datomic.com/rest.html)
+* [Initial announcement](http://blog.datomic.com/2012/09/rest-api.html)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/datomic-client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "datomic/client"
+
+Gem::Specification.new do |s|
+  s.name        = "datomic-client"
+  s.version     = Datomic::Client::VERSION
+  s.homepage    = "http://github.com/cldwalker/datomic-client"
+  s.authors     = "Gabriel Horner"
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://github.com/cldwalker/datomic-client"
+  s.summary     = %q{http client for datomic's API}
+  s.description = "This gem provides a simple way to use datomic's http API - http://docs.datomic.com/rest.html."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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 'rake', '~> 0.9.2.2'
+  s.add_dependency 'rest-client'
+end

data/lib/datomic/client.rb

@@ -0,0 +1,62 @@
+require 'rest-client'
+
+module Datomic
+  class Client
+    VERSION = '0.1.0'
+
+    def initialize(url, storage = nil)
+      @url = url
+      @storage = storage
+    end
+
+    def create_database(dbname)
+      RestClient.put db_url(dbname), {}
+    end
+
+    def database_info(dbname)
+      RestClient.get db_url(dbname)
+    end
+
+    def transact(dbname, data)
+      RestClient.post db_url(dbname), data
+    end
+
+    def datoms(dbname, index, params = {})
+      RestClient.get db_url(dbname, "datoms/#{index}"), :params => params
+    end
+
+    def range(dbname, params = {})
+      RestClient.get db_url(dbname, 'range'), :params => params
+    end
+
+    def entity(dbname, id, params = {})
+      RestClient.get db_url(dbname, 'entity', id), :params => params
+    end
+
+    def query(query, params = {})
+      RestClient.get root_url("api/query"), :params => params.merge(:q => query)
+    end
+
+    def monitor(dbname)
+      RestClient.get root_url('monitor', @storage, dbname)
+    end
+
+    # Given block is called with Net::HTTPOK response from event
+    def events(dbname, &block)
+      RestClient::Request.execute(:method => :get,
+        :url => root_url('events', @storage, dbname),
+        :headers => {:accept => "text/event-stream"},
+        :block_response => block)
+    end
+
+    private
+
+    def root_url(*parts)
+      [@url].concat(parts).join('/')
+    end
+
+    def db_url(dbname, *parts)
+      root_url 'db', @storage, dbname, *parts
+    end
+  end
+end

data/spec/datomic_client_spec.rb

@@ -0,0 +1,157 @@
+require 'datomic/client'
+
+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 = /^\{.*\}$/
+
+  describe "#create_database" do
+    it "returns 201 when creating a new database" do
+      resp = client.create_database("test-#{Time.now.to_i}")
+      resp.code.should == 201
+    end
+
+    it "returns 200 when database already exists" do
+      db = "test-#{Time.now.to_i}"
+      client.create_database(db)
+      resp = client.create_database(db)
+      resp.code.should == 200
+    end
+  end
+
+  describe "#database_info" do
+    before { client.create_database('test-database_info') }
+
+    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')
+    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')
+    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
+  end
+
+  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]")
+      resp.code.should == 200
+      resp.body.should match MAP
+    end
+  end
+
+  describe "#datoms" do
+    before { client.create_database('test-datoms') }
+
+    %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.code.should == 200
+        resp.body.should match VEC
+      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/)
+    end
+
+    it "returns correct response with limit param" do
+      resp = client.datoms('test-datoms', "eavt", :limit => 0)
+      resp.code.should == 200
+      resp.body.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")
+      resp.code.should == 200
+      resp.body.should match VEC
+    end
+
+    it "raises 400 without required attribute" do
+      expect { client.range('test-range') }.
+        to raise_error(RestClient::BadRequest, /400 Bad Request/)
+    end
+  end
+
+  describe "#entity" do
+    before { client.create_database('test-entity') }
+
+    it "returns correct response" do
+      resp = client.entity('test-entity', 1)
+      resp.code.should == 200
+      resp.body.should match MAP
+    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
+    end
+  end
+
+  describe "#query" do
+    let(:client) { Datomic::Client.new datomic_uri }
+
+    it "returns a correct response" do
+      pending "til valid query given"
+      resp = client.query("[:find ?e :where [?e :id 1]]")
+      resp.code.should == 200
+      resp.body.should match VEC
+    end
+  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') }
+
+    it "returns correct response" do
+      begin
+        client.events('test-events') do |resp|
+          resp.code.should == "200"
+          # Don't see a cleaner way to quit after testing one event
+          raise Timeout::Error
+        end
+      rescue RestClient::RequestTimeout
+      end
+    end
+
+    it "returns a 503 for nonexistent db" do
+      expect { client.events('zzzz') }.
+        to raise_error(RestClient::ServiceUnavailable, /503 Service Unavailable/)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: datomic-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- datomic-client.gemspec
+- lib/datomic/client.rb
+- spec/datomic_client_spec.rb
+homepage: http://github.com/cldwalker/datomic-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: http client for datomic's API
+test_files:
+- spec/datomic_client_spec.rb