arangodb-odm 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gem 'httparty'
+gem 'json'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.5)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty
+  jeweler (~> 1.6.4)
+  json
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Oliver Kiessler
+
+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,37 @@
+# arangodb-odm
+
+## Example Code
+
+### Example with dynamic attributes
+
+	class ExampleDocument < ArangoDb::Base
+  		collection :examples
+	end
+
+### Example with predefined attributes
+
+	class AnotherExampleDocument < ArangoDb::Base
+  		collection :more_examples
+  		db_attrs :foo, :bar # only these attributes will be saved
+	end
+
+## Usage
+
+	doc = ExampleDocument.new
+	doc.foo = "bar"
+	_id = doc.save
+
+	doc.foo = "bar2"
+	_rev = doc.save
+
+	success = doc.destroy
+ 
+	doc = ExampleDocument.find(_id)
+	doc2 = ExampleDocument.create("foo" => "bar")
+
+	all_document_handles = ExampleDocument.keys
+
+## Copyright
+
+Copyright (c) 2012 Oliver Kiessler. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "arangodb-odm"
+  gem.homepage = "http://github.com/okiess/arangodb-odm"
+  gem.license = "MIT"
+  gem.summary = "Ruby client for ArangoDB"
+  gem.description = "Ruby client for ArangoDB"
+  gem.email = "kiessler@inceedo.com"
+  gem.authors = ["Oliver Kiessler"]
+  gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'json'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "arangodb-odm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/arangodb-odm.rb

@@ -0,0 +1,162 @@
+require "rubygems"
+require "httparty"
+require "json"
+
+module ArangoDb
+  class Transport
+    include HTTParty
+    base_uri 'http://localhost:8529'
+  end
+
+  class Document
+    attr_accessor :collection, :db_attrs, :location, :_id, :_rev
+    attr_reader :attributes
+
+    def initialize(collection, db_attrs = [])
+      @attributes = {}; @collection = collection; @db_attr_names = db_attrs
+    end
+
+    def is_new?; self._id.nil?; end
+    def to_json
+      if @db_attr_names and @db_attr_names.any?
+        values = {}
+        @db_attr_names.each {|a| values[a] = self.attributes[a.to_s]}
+        values.to_json
+      else
+        self.attributes.to_json
+      end
+    end
+  end
+
+  module Properties
+    def self.included(klass)  
+      klass.extend ClassMethods  
+    end
+
+    module ClassMethods
+      def collection(value)
+        (class << self; self; end).send(:define_method, 'collection') do
+          value.to_s
+        end
+      end
+
+      def transport(value)
+        (class << self; self; end).send(:define_method, 'transport') do
+          value
+        end
+      end
+
+      def target(value)
+        (class << self; self; end).send(:define_method, 'target') do
+          value
+        end
+      end
+
+      def db_attrs(*attrs)
+        @db_attr_names ||= []
+        @db_attr_names << attrs.collect {|a| a.to_s} if attrs.any?
+        (class << self; self; end).send(:define_method, 'db_attributes') do
+          @db_attr_names ? @db_attr_names.first : []
+        end
+      end
+    end
+  end
+
+  # Base class for ArangoDB documents. Subclass it to create your own collection 
+  # specific document representations.
+  #
+  # Example:
+  #
+  # class ExampleDocument < ArangoDb::Base
+  #  collection :examples
+  # end
+  class Base
+    include ArangoDb::Properties
+    transport ArangoDb::Transport
+    target ArangoDb::Document
+    db_attrs []
+    attr_reader :target
+
+    def initialize
+      @transport = self.class.transport
+      @target = self.class.target.new(self.class.collection, self.class.db_attributes)
+    end
+
+    def self.find(document_handle)
+      raise "missing document handle" if document_handle.nil?
+      res = transport.get("/_api/document/#{document_handle}")
+      res.code == 200 ? self.new.build(res.parsed_response) : nil
+    end
+
+    def self.keys
+      res = transport.get("/_api/document?collection=#{collection}")
+      res.code == 200 ? res.parsed_response['documents'] : []
+    end
+
+    def self.create(attributes = {})
+      document = self.new.build(attributes)
+      document.save
+      document
+    end
+
+    def build(attributes = {})
+      attributes.each {|k, v| self.send("#{k}=".to_sym, v) unless ['_id', '_rev'].include?(k)}
+      self.target._id = attributes['_id']
+      self.target._rev = attributes['_rev']
+      self.target.location = "/_api/document/#{self.target._id}"
+      self
+    end
+
+    def save
+      if @target.is_new?
+        res = @transport.post("/_api/document/?collection=#{@target.collection}&createCollection=true", :body => to_json)
+        if res.code == 201 || res.code == 202
+          @target.location = res.headers["location"]
+          @target._id = res.parsed_response["_id"]
+          @target._rev = res.headers["etag"]
+          return @target._id
+        end
+      else
+        res = @transport.put(@target.location, :body => to_json)
+        return (@target._rev = res.parsed_response['_rev'])
+      end
+      nil
+    end
+
+    def changed?
+      unless @target.is_new?
+        res = @transport.head(@target.location)
+        return (self._rev.to_s.gsub("\"", '') != res.headers['etag'].to_s.gsub("\"", ''))
+      end
+      false
+    end
+
+    def destroy
+      unless is_new?
+        res = @transport.delete(@target.location)
+        if res.code == 200
+          @target.location = nil; @target._id = nil; @target._rev = nil
+          return true
+        end
+      end
+      false
+    end
+
+    def to_json
+      @target.to_json
+    end
+
+    protected
+    # Delegates all unknown method invocations to the target.
+    def method_missing(method, *args, &block)
+      method = method.to_s
+      if method[-1, 1] == '='
+        @target.attributes[method.gsub('=', '')] = args.first unless ['_id=', '_rev='].include?(method)
+      else
+        val = @target.attributes[method]
+        val = @target.send(method.to_sym) rescue nil unless val
+        val
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'arangodb-odm'
+
+class Test::Unit::TestCase
+end

data/test/test_arangodb-odm.rb

@@ -0,0 +1,105 @@
+require 'helper'
+
+class ExampleDocument < ArangoDb::Base
+  collection :examples
+end
+
+# Example with predefined attributes
+class AnotherExampleDocument < ArangoDb::Base
+  collection :more_examples
+  db_attrs :foo, :bar
+end
+
+class TestArangoDbRb < Test::Unit::TestCase
+  should "class should have a collection" do
+    assert_equal ExampleDocument.collection, 'examples'
+    assert_equal AnotherExampleDocument.collection, 'more_examples'
+  end
+
+  should "create a new document" do
+    doc = ExampleDocument.new
+    doc.foo = "bar"
+    doc.test = 1
+    doc.list = [1, 2, 3]
+    
+    assert_nil doc._id
+    assert_nil doc._rev
+    assert_nil doc.location
+ 
+    _id = doc.save
+    assert_not_nil _id
+    assert_not_nil doc._id
+    assert_not_nil doc._rev
+    assert_not_nil doc.location
+    
+    doc = ExampleDocument.find(_id)
+    assert_equal doc._id, _id
+    assert_equal doc.foo, "bar"
+    assert_equal doc.test, 1
+    assert_equal doc.list, [1, 2, 3]
+    
+    doc2 = AnotherExampleDocument.new
+    doc2.foo = 'bar'
+    doc2.bar = 'foo'
+    doc2.foo2 = 'bar2' # won't be saved => not in predefined db_attrs
+    _id = doc2.save
+    assert_not_nil _id
+    assert_not_nil doc2._id
+    assert_not_nil doc2._rev
+    assert_not_nil doc2.location
+    
+    doc3 = AnotherExampleDocument.find(_id)
+    assert_nil doc3.foo2
+    assert_equal doc3.foo, 'bar'
+    assert_equal doc3.bar, 'foo'
+  end
+
+  should "create a document on the create class method" do
+    doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
+    assert_not_nil doc._id
+    assert_not_nil doc._rev
+    assert_not_nil doc.location
+    assert_equal doc.foo, "bar"
+    assert_equal doc.test, 1
+    assert_equal doc.list, [1, 2, 3]
+  end
+
+  should "find a document by id" do
+    doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
+    assert_not_nil doc._id
+    doc2 = ExampleDocument.find(doc._id)
+    assert_equal doc._id, doc2._id
+  end
+
+  should "update a document" do
+    doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
+    doc2 = ExampleDocument.find(doc._id)
+
+    assert_not_nil doc._id
+    doc.foo = "bar2"
+    _rev_before = doc._rev
+    _rev = doc.save
+    assert _rev != _rev_before
+    assert_equal doc.foo, 'bar2'
+
+    assert_not_nil doc2
+    assert doc2.changed?
+  end
+
+  should "destroy a document" do
+    doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
+    assert_not_nil doc._id
+    _id = doc._id
+    assert doc.destroy
+    doc2 = ExampleDocument.find(_id)
+    assert_nil doc2
+  end
+
+  should "get all document handles" do
+    doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
+    all_handles = ExampleDocument.keys
+    assert_not_nil all_handles
+    assert all_handles.include?(doc.location)
+    assert doc.destroy
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification 
+name: arangodb-odm
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Oliver Kiessler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: httparty
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id004
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id005
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: rcov
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: httparty
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: json
+  prerelease: false
+  type: :runtime
+description: Ruby client for ArangoDB
+email: kiessler@inceedo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/arangodb-odm.rb
+- test/helper.rb
+- test/test_arangodb-odm.rb
+homepage: http://github.com/okiess/arangodb-odm
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby client for ArangoDB
+test_files: []
+