arangodb-odm 0.2.0 → 0.3.0

data/Gemfile

@@ -4,7 +4,8 @@ gem 'json'
 
 group :development do
   gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
+  gem "rdoc", "~> 2.4.2"
 end

data/Gemfile.lock

@@ -1,28 +1,50 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
     git (1.2.5)
-    httparty (0.8.1)
-      multi_json
+    hoe (3.3.1)
+      rake (>= 0.8, < 11.0)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
       multi_xml
+    i18n (0.6.1)
     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)
+    json (1.7.5)
+    metaclass (0.0.1)
+    minitest (1.7.2)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.4.0)
+    multi_xml (0.5.1)
+    rake (10.0.2)
     rcov (1.0.0)
-    shoulda (2.11.3)
+    rdoc (2.4.3)
+      hoe (>= 1.12.1)
+      minitest (~> 1.3)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.1.0)
   httparty
   jeweler (~> 1.6.4)
   json
   rcov
+  rdoc (~> 2.4.2)
   shoulda

data/README.md

@@ -13,7 +13,7 @@
 ### Example with dynamic attributes
 
 	class ExampleDocument < ArangoDb::Base
-  		collection :examples
+  	  collection :examples
 	end
 
 ### Example with predefined attributes
@@ -25,6 +25,8 @@
 
 ## Usage
 
+### CRUD
+
 	doc = ExampleDocument.new
 	doc.foo = "bar"
 	_id = doc.save
@@ -38,6 +40,23 @@
 	doc2 = ExampleDocument.create("foo" => "bar")
 
 	all_document_handles = ExampleDocument.keys
+	
+### Simple Queries
+
+#### All
+
+    ExampleDocument.all
+    ExampleDocument.skip(1).limit(2).all
+    
+#### All by example
+    
+    ExampleDocument.where('foo' => 'bar').all
+    ExampleDocument.where('foo' => 'bar').skip(10).limit(10).all
+    ExampleDocument.where('foo' => 'bar').where('a' => 'b').skip(10).limit(10).all
+
+#### First by example
+    
+    ExampleDocument.where('foo' => 'bar', 'a' => 'b').first
 
 ## Callbacks
 

data/Rakefile

@@ -43,7 +43,7 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/arangodb-odm.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 require "httparty"
 require "json"
+require "queries"
 
 module ArangoDb
   class Transport
@@ -108,6 +109,7 @@ module ArangoDb
   # end
   class Base
     include ArangoDb::Properties
+    extend ArangoDb::Queries::ClassMethods
     transport ArangoDb::Transport
     target ArangoDb::Document
     db_attrs []

data/lib/queries.rb

@@ -0,0 +1,96 @@
+module ArangoDb
+  module Queries
+    class QueryResult < Array
+    end
+
+    class Query
+      def initialize(model)
+        @model = model
+      end
+
+      def where(hash)
+        @where ||= {}
+        @where.merge!(hash)
+        self
+      end
+
+      def limit(number)
+        @limit = number
+        self
+      end
+
+      def skip(number)
+        @skip = number
+        self
+      end
+
+      def first
+        @model.first(query_parameters)
+      end
+
+      def all
+        @model.all(query_parameters)
+      end
+      
+      private
+      def query_parameters
+        options = {}
+        options['limit'] = @limit if @limit
+        options['skip'] = @skip if @skip
+        options['example'] = @where if @where
+        options
+      end
+    end
+
+    module ClassMethods
+      # PUT /_api/simple/all
+      # Returns all documents of a collections. The call expects an JSON object as body with the following attributes:
+      # collection: The identifier or name of the collection to query.
+      # skip: The documents to skip in the query. (optional)
+      # limit: The maximal amount of documents to return. The skip is applied before the limit restriction. (optional)
+      #
+      # PUT /_api/simple/by-example
+      # This will find all documents matching a given example.
+      # The call expects a JSON hash array as body with the following attributes:
+      # collection: The identifier or name of the collection to query.
+      # example: The example.
+      # skip: The documents to skip in the query. (optional)
+      # limit: The maximal amount of documents to return. (optional)
+      def all(options = {})
+        query_parameters = {'collection' => collection}; endpoint = '/_api/simple/all'
+        endpoint = '/_api/simple/by-example' if options and options['example'] and options['example'].any?
+        res = transport.put(endpoint, :body => query_parameters.merge(options).to_json)
+        if res.code == 201 and res.parsed_response and res.parsed_response["result"]
+          query_result = QueryResult.new
+          res["result"].each {|json_doc| query_result << self.new.build(json_doc)}
+          query_result
+        end
+      end
+
+      # PUT /_api/simple/first-example
+      # This will return the first document matching a given example.
+      # The call expects a JSON hash array as body with the following attributes:
+      # collection: The identifier or name of the collection to query.
+      # example: The example.
+      def first(options = {})
+        query_parameters = {'collection' => collection}; endpoint = '/_api/simple/first-example'
+        res = transport.put(endpoint, :body => query_parameters.merge(options).to_json)
+        if res.code == 200 and res.parsed_response and (json_doc = res.parsed_response["document"])
+          self.new.build(json_doc)
+        end
+      end
+
+      def where(hash)
+        Query.new(self).where(hash)
+      end
+
+      def limit(number)
+        Query.new(self).limit(number)
+      end
+      
+      def skip(number)
+        Query.new(self).skip(number)
+      end
+    end
+  end
+end

data/test/another_example_document.rb

@@ -0,0 +1,14 @@
+# Example with predefined attributes
+class AnotherExampleDocument < ArangoDb::Base
+  collection :more_examples
+  db_attrs :foo, :bar
+  
+  before_save :change_something
+  after_save :change_something_else
+  
+  def change_something
+    self.foo = 'bar2'
+  end
+  
+  def change_something_else; end
+end

data/test/example_document.rb

@@ -0,0 +1,27 @@
+class ExampleDocument < ArangoDb::Base
+  collection :examples
+  
+  before_create :add_something
+  after_create :do_something_else
+  
+  before_destroy :method1
+  after_destroy :method2
+
+  def validate
+    not self.foo.nil?
+  end
+  
+  def add_something
+    self.something = "other"
+  end
+  
+  def do_something_else; end
+  
+  def method1
+    # puts self._id
+  end
+  
+  def method2
+    # puts self._id
+  end
+end

data/test/helper.rb

@@ -13,6 +13,8 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'arangodb-odm'
+require 'example_document.rb'
+require 'another_example_document.rb'
 
 # Set your ArangoDB host...
 ArangoDb::Transport.base_uri 'http://localhost:8529'

data/test/test_arangodb-odm.rb

@@ -1,49 +1,6 @@
 require 'helper'
 
-class ExampleDocument < ArangoDb::Base
-  collection :examples
-  
-  before_create :add_something
-  after_create :do_something_else
-  
-  before_destroy :method1
-  after_destroy :method2
-
-  def validate
-    not self.foo.nil?
-  end
-  
-  def add_something
-    self.something = "other"
-  end
-  
-  def do_something_else; end
-  
-  def method1
-    # puts self._id
-  end
-  
-  def method2
-    # puts self._id
-  end
-end
-
-# Example with predefined attributes
-class AnotherExampleDocument < ArangoDb::Base
-  collection :more_examples
-  db_attrs :foo, :bar
-  
-  before_save :change_something
-  after_save :change_something_else
-  
-  def change_something
-    self.foo = 'bar2'
-  end
-  
-  def change_something_else; end
-end
-
-class TestArangoDbRb < Test::Unit::TestCase
+class TestArangoDb < Test::Unit::TestCase
   should "class should have a collection" do
     assert_equal ExampleDocument.collection, 'examples'
     assert_equal AnotherExampleDocument.collection, 'more_examples'

data/test/test_queries.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestArangoDbQueries < Test::Unit::TestCase
+  should "get all documents" do
+    example_documents = ExampleDocument.skip(1).limit(2).all
+    assert_not_nil example_documents
+    assert example_documents.is_a?(ArangoDb::Queries::QueryResult)
+    assert example_documents.size > 0
+    assert_equal example_documents.size, 2
+  end
+
+  should "get all documents by example" do
+    example_documents = ExampleDocument.where(:foo => 'bar').where("test" => 1).where("list" => [1, 2, 3]).limit(10).all
+    assert_not_nil example_documents
+    assert example_documents.size > 0
+
+    example_documents = ExampleDocument.where(:something => 'not existant').all
+    assert_not_nil example_documents
+    assert_equal example_documents.size, 0
+  end
+
+  should "get first document by example" do
+    example_document = ExampleDocument.where('foo' => 'bar').first
+    assert_not_nil example_document
+    assert_not_nil example_document._id
+    assert_not_nil example_document._rev
+    assert_equal example_document.foo, 'bar'
+    
+    example_document = ExampleDocument.where(:something => 'not existant').first
+    assert_nil example_document
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arangodb-odm
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Oliver Kiessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-03 00:00:00 Z
+date: 2012-12-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -65,12 +65,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 19
         segments: 
         - 1
+        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: 1.1.0
   version_requirements: *id004
   name: bundler
   prerelease: false
@@ -107,6 +107,22 @@ dependencies:
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 4
+        - 2
+        version: 2.4.2
+  version_requirements: *id007
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -115,12 +131,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
+  version_requirements: *id008
   name: httparty
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -129,7 +145,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id008
+  version_requirements: *id009
   name: json
   prerelease: false
   type: :runtime
@@ -151,8 +167,12 @@ files:
 - Rakefile
 - VERSION
 - lib/arangodb-odm.rb
+- lib/queries.rb
+- test/another_example_document.rb
+- test/example_document.rb
 - test/helper.rb
 - test/test_arangodb-odm.rb
+- test/test_queries.rb
 homepage: http://github.com/okiess/arangodb-odm
 licenses: 
 - MIT