ashikawa-core 0.2.1 → 0.3.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/triAGENS/ashikawa-core.png?branch=master)](http://travis-ci.org/triAGENS/ashikawa-core)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/triAGENS/ashikawa-core)
+[![Dependency Status](https://gemnasium.com/triAGENS/ashikawa-core.png)](https://gemnasium.com/triAGENS/ashikawa-core)
 
 Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and will be used in different ArangoDB ODMs.
 

data/ashikawa-core.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |gem|
 
   # Runtime Dependencies (JRuby only)
   if defined? PLATFORM and PLATFORM == 'java'
-    gem.add_dependency "json", "~> 1.6.6"
-    gem.add_dependency "jruby-openssl", "~> 0.7.6.1"
+    gem.add_dependency "json", "~> 1.7.5"
+    gem.add_dependency "jruby-openssl", "~> 0.7.7"
   else
     # RedCarpet is not compatible with JRuby
     # It is only needed to generate the YARD Documentation

data/lib/ashikawa-core/connection.rb

@@ -29,7 +29,7 @@ module Ashikawa
       # @api public
       # @example Create a new Connection
       #  connection = Connection.new "http://localhost:8529"
-      def initialize(api_string)
+      def initialize(api_string="http://localhost:8529")
         @api_string = api_string
         @ip, @port = @api_string.scan(/(\S+):(\d+)/).first
         @port = @port.to_i

data/lib/ashikawa-core/document.rb

@@ -66,6 +66,14 @@ module Ashikawa
         @content[attribute_name] = value
       end
 
+      # Convert the document into a hash
+      #
+      # @return [Hash]
+      # @api public
+      def to_hash
+        @content
+      end
+
       # Save the changes to the database
       #
       # @api public

data/lib/ashikawa-core/version.rb

@@ -1,6 +1,6 @@
 module Ashikawa
   module Core
     # Current version of Ashikawa::Core
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/spec/integration/basic_spec.rb

@@ -1,7 +1,5 @@
 require 'integration/spec_helper'
 
-ARANGO_HOST = "http://localhost:8529"
-
 describe "Basics" do
   subject { ARANGO_HOST }
 
@@ -80,24 +78,6 @@ describe "Basics" do
       empty_collection.length.should == 0
     end
 
-    it "should return all documents of a collection" do
-      empty_collection = subject["empty_collection"]
-      empty_collection << { name: "testname", age: 27}
-      empty_collection.all.first["name"].should == "testname"
-    end
-
-    it "should be possible to limit and skip results" do
-      empty_collection = subject["empty_collection"]
-      empty_collection.truncate!
-
-      empty_collection << { name: "test1"}
-      empty_collection << { name: "test2"}
-      empty_collection << { name: "test3"}
-
-      empty_collection.all(limit: 2).length.should == 2
-      empty_collection.all(skip: 2).length.should == 1
-    end
-
     it "should be possible to update the attributes of a document" do
       collection = subject["documenttests"]
 
@@ -119,128 +99,33 @@ describe "Basics" do
       collection[document_id] = { name: "Other Dude", bowling: true }
       collection[document_id]["name"].should == "Other Dude"
     end
+  end
 
-    describe "geolocation" do
-      before :each do
-        @places = subject['geo_collection']
-        @places.truncate!
-
-        @places.add_index :geo, on: [:latitude, :longitude]
-        @places << { "name" => "cologne", "latitude" => 50.948045, "longitude" => 6.961212 }
-        @places << { "name" => "san francisco", "latitude" => -122.395899, "longitude" => 37.793621 }
-      end
-
-      it "should be possible to query documents near a certain location" do
-        found_places = @places.near latitude: 50, longitude: 6
-        found_places.first["name"].should == "cologne"
-      end
-
-      it "should be possible to query documents within a certain range" do
-        found_places = @places.within latitude: 50.948040, longitude: 6.961210, radius: 2
-        found_places.length.should == 1
-        found_places.first["name"].should == "cologne"
-      end
-    end
-
-    describe "ranges" do
-      before :each do
-        @people = subject['range_collection']
-        @people.truncate!
-
-        @people.add_index :skiplist, on: [:age]
-        @people << { "name" => "Georg", "age" => 12 }
-        @people << { "name" => "Anne", "age" => 21 }
-        @people << { "name" => "Jens", "age" => 49 }
-      end
-
-      it "should be possible to query documents for numbers in a certain range" do
-        found_people = @people.in_range attribute: "age", left: 20, right: 30, closed: true
-        found_people.length.should == 1
-        found_people.first["name"].should == "Anne"
-      end
-    end
+  describe "created document" do
+    let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+    let(:collection) { database["documenttests"] }
+    subject { collection.create name: "The Dude" }
+    let(:document_id) { subject.id }
 
-    describe "created document" do
-      before :each do
-        @collection = subject["documenttests"]
-        @document = @collection.create name: "The Dude"
-        @document_id = @document.id
-      end
-
-      it "should be possible to manipulate documents and save them" do
-        @document = @collection[@document_id]
-        @document["name"] = "Jeffrey Lebowski"
-        @document["name"].should == "Jeffrey Lebowski"
-        @collection[@document_id]["name"].should == "The Dude"
-        @document.save
-        @collection[@document_id]["name"].should == "Jeffrey Lebowski"
-      end
-
-      it "should be possible to delete a document" do
-        @collection = subject["documenttests"]
-        @document = @collection.create name: "The Dude"
-        @document_id = @document.id
-        @collection[@document_id].delete
-        expect { @collection[@document_id] }.to raise_exception Ashikawa::Core::DocumentNotFoundException
-      end
-
-      it "should not be possible to delete a document that doesn't exist" do
-        @collection = subject["documenttests"]
-        expect { @collection[123].delete }.to raise_exception Ashikawa::Core::DocumentNotFoundException
-      end
+    it "should be possible to manipulate documents and save them" do
+      subject["name"] = "Jeffrey Lebowski"
+      subject["name"].should == "Jeffrey Lebowski"
+      collection[document_id]["name"].should == "The Dude"
+      subject.save
+      collection[document_id]["name"].should == "Jeffrey Lebowski"
     end
 
-    describe "setting and deleting indices" do
-      before :each do
-        @collection = subject["documenttests"]
-      end
-
-      it "should be possible to set indices" do
-        @collection.add_index :geo, on: [:latitude, :longitude]
-        @collection.add_index :skiplist, on: [:identifier]
-        @collection.indices.length.should == 3 # primary index is always set
-        @collection.indices[0].class.should == Ashikawa::Core::Index
-      end
-
-      it "should be possible to get an index by ID" do
-        index = @collection.add_index :skiplist, on: [:identifier]
-        @collection.index(index.id).id.should == index.id
-      end
-
-      it "should be possible to remove indices" do
-        index = @collection.add_index :skiplist, on: [:identifier]
-        index.delete
-        @collection.indices.length.should == 1 # primary index is always set
-      end
+    it "should be possible to delete a document" do
+      collection[document_id].delete
+      expect {
+        collection[document_id]
+      }.to raise_exception Ashikawa::Core::DocumentNotFoundException
     end
 
-    describe "querying for documents" do
-      it "should be possible to query documents by example" do
-        collection = subject["documenttests"]
-
-        collection << { "name" => "Random Collection" }
-        result = collection.by_example example: {"name" => "Random Collection"}
-        result.length.should == 1
-      end
-
-      it "should be possible to query documents with AQL" do
-        collection = subject["aqltest"]
-
-        collection << { "name" => "Jeff Lebowski",    "bowling" => true }
-        collection << { "name" => "Walter Sobchak",   "bowling" => true }
-        collection << { "name" => "Donny Kerabatsos", "bowling" => true }
-        collection << { "name" => "Jeffrey Lebowski", "bowling" => false }
-
-        results = subject.query "FOR u IN aqltest FILTER u.bowling == true RETURN u",
-          batch_size: 2,
-          count: true
-
-        results.length.should == 3
-
-        results = results.map { |person| person["name"] }
-        results.should     include "Jeff Lebowski"
-        results.should_not include "Jeffrey Lebowski"
-      end
+    it "should not be possible to delete a document that doesn't exist" do
+      expect {
+        collection[123].delete
+      }.to raise_exception Ashikawa::Core::DocumentNotFoundException
     end
   end
 end

data/spec/integration/index_spec.rb

@@ -0,0 +1,26 @@
+require 'integration/spec_helper'
+
+describe "Indices" do
+  let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+  subject { database["documenttest"] }
+  let(:index) { subject.add_index :skiplist, on: [:identifier] }
+
+  it "should be possible to set indices" do
+    index.delete
+
+    expect {
+      subject.add_index :skiplist, on: [:identifier]
+    }.to change { subject.indices.length }.by(1)
+  end
+
+  it "should be possible to get an index by ID" do
+    subject.index(index.id).id.should == index.id
+    subject.indices[0].class.should == Ashikawa::Core::Index
+  end
+
+  it "should be possible to remove indices" do
+    expect {
+      index.delete
+    }.to change { subject.indices.length }.by(-1)
+  end
+end

data/spec/integration/query_spec.rb

@@ -0,0 +1,78 @@
+require 'integration/spec_helper'
+
+describe "Simple Queries" do
+  let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+  subject { database["my_collection"] }
+  before(:each) { subject.truncate! }
+
+  it "should return all documents of a collection" do
+    subject << { name: "testname", age: 27}
+    subject.all.first["name"].should == "testname"
+  end
+
+  it "should be possible to limit and skip results" do
+    subject << { name: "test1"}
+    subject << { name: "test2"}
+    subject << { name: "test3"}
+
+    subject.all(limit: 2).length.should == 2
+    subject.all(skip: 2).length.should == 1
+  end
+
+  it "should be possible to query documents by example" do
+    subject << { "name" => "Random Document" }
+    result = subject.by_example example: {"name" => "Random Document"}
+    result.length.should == 1
+  end
+
+  it "should be possible to query documents with AQL" do
+    subject << { "name" => "Jeff Lebowski",    "bowling" => true }
+    subject << { "name" => "Walter Sobchak",   "bowling" => true }
+    subject << { "name" => "Donny Kerabatsos", "bowling" => true }
+    subject << { "name" => "Jeffrey Lebowski", "bowling" => false }
+
+    results = database.query "FOR u IN my_collection FILTER u.bowling == true RETURN u",
+      batch_size: 2,
+      count: true
+
+    results.length.should == 3
+
+    results = results.map { |person| person["name"] }
+    results.should     include "Jeff Lebowski"
+    results.should_not include "Jeffrey Lebowski"
+  end
+
+  describe "geolocation" do
+    before :each do
+      subject.add_index :geo, on: [:latitude, :longitude]
+      subject << { "name" => "cologne", "latitude" => 50.948045, "longitude" => 6.961212 }
+      subject << { "name" => "san francisco", "latitude" => -122.395899, "longitude" => 37.793621 }
+    end
+
+    it "should be possible to query documents near a certain location" do
+      found_places = subject.near latitude: 50, longitude: 6
+      found_places.first["name"].should == "cologne"
+    end
+
+    it "should be possible to query documents within a certain range" do
+      found_places = subject.within latitude: 50.948040, longitude: 6.961210, radius: 2
+      found_places.length.should == 1
+      found_places.first["name"].should == "cologne"
+    end
+  end
+
+  describe "ranges" do
+    before :each do
+      subject.add_index :skiplist, on: [:age]
+      subject << { "name" => "Georg", "age" => 12 }
+      subject << { "name" => "Anne", "age" => 21 }
+      subject << { "name" => "Jens", "age" => 49 }
+    end
+
+    it "should be possible to query documents for numbers in a certain range" do
+      found_people = subject.in_range attribute: "age", left: 20, right: 30, closed: true
+      found_people.length.should == 1
+      found_people.first["name"].should == "Anne"
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -4,3 +4,5 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require "rest-client"
 require "json"
 require "ashikawa-core"
+
+ARANGO_HOST = "http://localhost:8529"

data/spec/unit/connection_spec.rb

@@ -11,6 +11,12 @@ describe Ashikawa::Core::Connection do
     connection.port.should == 8529
   end
 
+  it "should default to localhost and ArangoDB port" do
+    connection = subject.new
+    connection.ip.should == "http://localhost"
+    connection.port.should == 8529
+  end
+
   describe "initialized connection" do
     subject { Ashikawa::Core::Connection.new "http://localhost:8529" }
 

data/spec/unit/document_spec.rb

@@ -58,6 +58,12 @@ describe Ashikawa::Core::Document do
       subject["last_name"] = "Other"
       subject.save
     end
+
+    it "should be convertable to a hash" do
+      hash = subject.to_hash
+      hash.should be_instance_of Hash
+      hash["first_name"].should == subject["first_name"]
+    end
   end
 
   describe "initialized document without ID" do

data/spec/unit/index_spec.rb

@@ -16,7 +16,7 @@ describe Ashikawa::Core::Index do
       "error" => false
     }
   }
-  subject { Ashikawa::Core::Index}
+  subject { Ashikawa::Core::Index }
 
   it "should initialize an Index" do
     index = subject.new collection, raw_data

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ashikawa-core
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -186,6 +186,7 @@ files:
 - .travis.yml
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - ashikawa-core.gemspec
@@ -222,6 +223,8 @@ files:
 - spec/fixtures/simple-queries/within.json
 - spec/integration/arango_helper.rb
 - spec/integration/basic_spec.rb
+- spec/integration/index_spec.rb
+- spec/integration/query_spec.rb
 - spec/integration/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb
@@ -280,6 +283,8 @@ test_files:
 - spec/fixtures/simple-queries/within.json
 - spec/integration/arango_helper.rb
 - spec/integration/basic_spec.rb
+- spec/integration/index_spec.rb
+- spec/integration/query_spec.rb
 - spec/integration/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb