riak_json 0.0.2

data/test/unit/client_test.rb

@@ -0,0 +1,163 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a RiakJson Client" do
+  context "when created" do
+    it "has an empty collection cache" do
+      rj_test_client.collection_cache.must_be_empty
+    end
+    
+    it "has a riak host and port" do
+      client = rj_test_client
+      client.host.must_equal @rj_client.host
+      client.port.must_equal @rj_client.port
+    end
+    
+    it "initializes a transport object" do
+      client = rj_test_client
+      client.transport.must_be_kind_of RiakJson::ClientTransport
+    end
+  end
+
+  context "knows the URLs to Riak and RiakJSON API endpoints" do
+    it "knows riak cluster and riakjson urls" do
+      client = rj_test_client
+      client.base_riak_url.wont_be_empty
+      client.base_riak_json_url.wont_be_empty
+    end
+    it "knows riakjson collection url" do
+      client = rj_test_client
+      client.base_collection_url.wont_be_empty
+    end
+  end
+  
+  it "uses its collection cache when instantiating collections" do
+    client = rj_test_client
+    collection1 = client.collection('ruby_test_collection')
+    collection2 = client.collection('ruby_test_collection')
+    collection1.must_be_same_as collection2, "Client uses collection cache, collection1 and collection2 should be identical"
+  end
+  
+  it "reads JSON objects from collections" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    test_key = 'document-key-123'
+    client.transport = MiniTest::Mock.new
+    
+    # Test that a client.get_json_object call results in an HTTP GET request to /collection_name/key
+    client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/document-key-123", :get]
+    client.get_json_object(collection_name, test_key)
+    client.transport.verify
+  end
+  
+  it "writes a new JSON object to a collection with a specified key" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    test_key = 'document-key-123'
+    test_json = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+    client.transport = MiniTest::Mock.new
+    
+    # Test that a client.insert_json_object call results in an HTTP PUT request to /collection_name/key
+    client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/document-key-123", :put, test_json]
+    client.insert_json_object(collection_name, test_key, test_json)
+    client.transport.verify
+  end
+  
+  it "updates an existing JSON object in a collection" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    test_key = 'document-key-123'
+    test_json = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+    client.transport = MiniTest::Mock.new
+    
+    # Test that a client.update_json_object call results in an HTTP PUT request to /collection_name/key
+    client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/document-key-123", :put, test_json]
+    client.update_json_object(collection_name, test_key, test_json)
+    client.transport.verify
+  end
+
+  it "raises an exception if updating a JSON object with no key" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    nil_key = nil
+    test_json = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+    
+    lambda { client.update_json_object(collection_name, nil, test_json) }.must_raise Exception
+  end
+  
+  it "deletes an existing JSON object in a collection" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    test_key = 'document-key-123'
+    client.transport = MiniTest::Mock.new
+    
+    # Test that a client.delete_json_object call results in an HTTP DELETE request to /collection_name/key
+    client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/document-key-123", :delete]
+    client.delete_json_object(collection_name, test_key)
+    client.transport.verify
+  end
+  
+  context "performs document Schema administration" do
+    it "sets a schema json object into a collection's schema api endpoint" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      client.transport = MiniTest::Mock.new
+      schema_json = [{
+        :name => "field_one",
+        :type => "string",
+        :require => true
+        }, {
+        :name => "field_two",
+        :type => "text",
+        :require => false
+        }].to_json
+      
+      client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/schema", :put, schema_json]
+      client.set_schema_json(collection_name, schema_json)
+      client.transport.verify
+    end
+  end
+  
+  context "sends JSON queries to retrieve documents" do
+    it "sends requests to /query/one" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      client.transport = MiniTest::Mock.new
+      query_json = {:company_name => 'Basho Technologies'}.to_json
+      
+      client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/query/one", :put, query_json]
+      client.get_query_one(collection_name, query_json)
+      client.transport.verify
+    end
+    
+    it "sends requests to /query/all" do
+      client = rj_test_client
+      collection_name = 'cities'
+      client.transport = MiniTest::Mock.new
+      query_json = {:country => 'USA'}.to_json
+      
+      client.transport.expect :send_request, nil, ["#{client.base_collection_url}/#{collection_name}/query/all", :put, query_json]
+      client.get_query_all(collection_name, query_json)
+      client.transport.verify
+    end
+  end
+end

data/test/unit/client_transport_test.rb

@@ -0,0 +1,27 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a RiakJson ClientTransport" do
+  it "is instantiated to enable the Client to make REST calls" do
+    transport = RiakJson::ClientTransport.new
+  end
+end

data/test/unit/collection_schema_test.rb

@@ -0,0 +1,111 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a RiakJson Collection Schema" do
+  context "builds a schema definition by adding fields" do
+    it "initializes to an empty fields list" do
+      schema = RiakJson::CollectionSchema.new
+      schema.fields.must_be_empty
+      schema.fields.count.must_equal 0
+    end
+    
+    it "can add field definitions with type passed in" do
+      schema = RiakJson::CollectionSchema.new
+      schema.add_field(:text, :city, true)
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'city'
+      schema.fields[0][:type].must_equal 'text'
+      schema.fields[0][:require].must_equal true
+      
+      lambda { schema.add_field(:invalid_type, :state) }.must_raise Exception, "Invalid field type"
+    end
+    
+    it "can add a text field to the schema definition" do
+      # schema = [{
+      #    :name => "city",
+      #    :type => "text",
+      #    :require => true
+      # }]
+      schema = RiakJson::CollectionSchema.new
+      schema.add_text_field(name='city', required=true)
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'city'
+      schema.fields[0][:type].must_equal 'text'
+      schema.fields[0][:require].must_equal true
+    end
+    
+    it "can add a string field to the schema definition" do
+      # schema = [{
+      #    :name => "state",
+      #    :type => "string",
+      #    :require => false
+      # }]
+      schema = RiakJson::CollectionSchema.new
+      schema.add_string_field(name='state')  # required: false by default
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'state'
+      schema.fields[0][:type].must_equal 'string'
+      schema.fields[0][:require].must_equal false
+    end
+    
+    it "can add a multi_string field to the schema definition" do
+      # schema = [{
+      #    :name => "zip_codes",
+      #    :type => "multi_string",
+      #    :require => true
+      # }]
+      schema = RiakJson::CollectionSchema.new
+      schema.add_multi_string_field(name='zip_codes', required=true)
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'zip_codes'
+      schema.fields[0][:type].must_equal 'multi_string'
+      schema.fields[0][:require].must_equal true
+    end
+
+    it "can add an integer field to the schema definition" do
+      # schema = [{
+      #    :name => "population",
+      #    :type => "integer",
+      #    :require => false
+      # }]
+      schema = RiakJson::CollectionSchema.new
+      schema.add_integer_field(name='population', required=false)
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'population'
+      schema.fields[0][:type].must_equal 'integer'
+      schema.fields[0][:require].must_equal false
+    end
+    
+    it "builds a json object representation" do
+      schema = RiakJson::CollectionSchema.new
+      schema.add_text_field(name='city', required=true)
+      schema.add_string_field(name='state')
+      
+      # This can be stored via collection.set_schema
+      schema_json = schema.build
+      
+      fields_array = JSON.parse(schema_json)
+      fields_array.count.must_equal 2
+      fields_array[0]['name'].must_equal 'city'
+    end
+  end
+end

data/test/unit/collection_test.rb

@@ -0,0 +1,281 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a RiakJson Collection" do
+  context "when created" do
+    it "has a name" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      collection.name.must_equal collection_name
+    end
+
+    it "requires a name" do
+      client = rj_test_client  # in helper.rb
+      lambda { client.collection() }.must_raise ArgumentError
+    end
+
+    it "cannot have an empty or nil name" do
+      client = rj_test_client  # in helper.rb
+      lambda { client.collection(nil) }.must_raise ArgumentError, "A collection cannot have a nil string name"
+      lambda { client.collection('') }.must_raise ArgumentError, "A collection cannot have an empty string name"
+    end
+    
+    it "has a client/connection" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      collection.client.must_be_kind_of(RiakJson::Client)
+    end
+  end
+  
+  context "uses the Client to read and write raw JSON objects to a collection" do
+    it "gets a raw JSON object for a collection/key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      test_key = 'document-key-123'
+
+      # Test that a collection.insert_raw_json(doc) results in a call to client.insert_json_object
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :get_json_object, nil, [collection_name, test_key]
+      collection.get_raw_json(test_key)
+      collection.client.verify
+    end
+    
+    it "inserts a raw JSON object into a collection/key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+
+      test_key = 'document-key-123'
+      json_obj = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+
+      # Test that a collection.insert_raw_json(doc) results in a call to client.insert_json_object
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :insert_json_object, nil, [collection_name, test_key, json_obj]
+      collection.insert_raw_json(test_key, json_obj)
+      collection.client.verify
+    end
+    
+    it "updates a raw JSON object into a collection/key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+    
+      test_key = 'document-key-123'
+      json_obj = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+    
+      # Test that a collection.update_raw_json(doc) results in a call to client.update_json_object
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :update_json_object, nil, [collection_name, test_key, json_obj]
+      collection.update_raw_json(test_key, json_obj)
+      collection.client.verify
+    end
+    
+    it "deletes a raw JSON object for a collection/key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      test_key = 'document-key-123'
+    
+      # Test that a collection.delete_raw_json(doc) results in a call to client.delete_json_object
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :delete_json_object, nil, [collection_name, test_key]
+      collection.delete_raw_json(test_key)
+      collection.client.verify
+    end
+  end
+  
+  context "administers Schemas for collections" do
+    it "sets a schema object for a collection" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection-new'
+      collection = client.collection(collection_name)
+      collection.has_schema?.must_equal false
+      schema_json = [{
+        :name => "field_one",
+        :type => "string",
+        :require => true
+        }, {
+        :name => "field_two",
+        :type => "text",
+        :require => false
+        }].to_json
+      
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :set_schema_json, nil, [collection_name, schema_json]
+      collection.set_schema(schema_json)
+      collection.client.verify
+    end
+    
+    it "gets a schema object for a collection" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+      
+      collection.client = MiniTest::Mock.new
+      collection.client.expect :get_schema, nil, [collection_name]
+      collection.get_schema
+      collection.client.verify
+    end
+  end
+  
+  context "can write and delete Documents, and load them by key" do
+    it "can load a document by its key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      test_key = 'key-123'
+      returned_json = '{"field_one": "abc"}' # Value mock-loaded from RiakJson
+      
+      client = MiniTest::Mock.new
+      client.expect :get_json_object, returned_json, [collection_name, test_key]
+      collection.client = client
+      
+      document = collection.find_by_key(test_key)
+      client.verify
+      document.must_be_kind_of RiakJson::Document
+      document.key.must_equal test_key
+    end
+    
+    it "can insert a Document" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      # A Collection performs an insert by invoking doc.key and doc.to_json
+      # and then sending along the raw json object to its client
+      test_key = 'key-123'
+      test_json = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_json)
+      
+      client = MiniTest::Mock.new
+      client.expect :insert_json_object, nil, [collection_name, test_key, String]
+      collection.client = client
+      
+      collection.insert(doc)
+      client.verify
+    end
+    
+    it "can update a Document" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+    
+      # A Collection performs an update by invoking doc.key and doc.to_json
+      # and then sending along the raw json object to its client
+      test_key = 'key-123'
+      test_json = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_json)
+      
+      client = MiniTest::Mock.new
+      client.expect :update_json_object, nil, [collection_name, test_key, String]
+      collection.client = client
+      
+      collection.update(doc)
+      client.verify
+    end
+    
+    it "can remove a Document" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+    
+      # A Collection performs a remove by invoking doc.key
+      # and then sending along the key to its client
+      test_key = 'key-123'
+      doc = RiakJson::Document.new(test_key)
+      
+      client = MiniTest::Mock.new
+      client.expect :delete_json_object, nil, [collection_name, test_key]
+      collection.client = client
+      
+      collection.remove(doc)
+      client.verify
+    end
+  end
+  
+  context "can query to find one or more documents" do
+    it "can query for one document via an exact field match" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      query_json = {:company_name => 'Basho Technologies'}.to_json
+
+      returned_json = '{"company_name": "Basho Technologies", "_id": "basho"}' # Value mock-loaded from RiakJson
+        
+      client = MiniTest::Mock.new
+      client.expect :get_query_one, returned_json, [collection_name, query_json]
+      collection.client = client
+      
+      document = collection.find_one(query_json)
+      collection.client.verify
+      
+      document.must_be_kind_of RiakJson::Document
+      document.key.must_equal "basho"
+      document['company_name'].must_equal 'Basho Technologies'
+    end
+    
+    it "returns an empty QueryResult if a find_all() call returns no documents" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+      
+      query = {:company_name => 'nonexistent'}.to_json
+      returned_json = '[]'
+      
+      client = MiniTest::Mock.new
+      client.expect :get_query_all, returned_json, [collection_name, query]
+      collection.client = client
+      document = collection.find_all(query)
+      collection.client.verify
+      
+      # Now verify the same behavior when the json string returned from server is nil
+      returned_json = nil
+      client = MiniTest::Mock.new
+      client.expect :get_query_all, returned_json, [collection_name, query]
+      collection.client = client
+      document = collection.find_all(query)
+      collection.client.verify
+    end
+  end
+  
+  it "returns nil if a query_one() call finds no results" do
+    client = rj_test_client
+    collection_name = 'ruby_test_collection'
+    collection = client.collection(collection_name)
+    
+    query_json = {:company_name => 'Basho Technologies'}.to_json
+    empty_results_json = [].to_json  
+    
+    client = MiniTest::Mock.new
+    client.expect :get_query_one, empty_results_json, [collection_name, query_json]
+    collection.client = client
+    
+    doc = collection.find_one(query_json)
+    collection.client.verify
+    doc.must_be_nil
+  end
+end

data/test/unit/document_test.rb

@@ -0,0 +1,67 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a RiakJson Document" do
+  context "when initialized" do
+    it "has a key" do
+      test_key = 'key-123'
+      doc = RiakJson::Document.new(test_key)
+      doc.key.must_equal test_key
+    end
+    
+    it "if created without a body parameter, initializes it to an empty hash" do
+      doc = RiakJson::Document.new
+      doc.body.must_be_kind_of Hash
+      doc.body.must_be_empty
+    end
+    
+    it "has a body" do
+      test_key = 'key-123'
+      test_body = { 'field_one' => '123', 'field_two' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_body)
+      doc.body.must_equal test_body
+    end
+    
+    it "implements a .to_json_document method" do
+      test_key = 'key-123'
+      test_body = { 'field_one' => '123', 'field_two' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_body)
+      doc.to_json.must_be_kind_of String
+      json_str = doc.to_json_document
+      
+      parsed_doc_body = JSON.parse(json_str)
+      # Note - a parsed JSON document has keys as strings, not symbols
+      parsed_doc_body['field_one'].must_equal '123'
+    end
+  end
+  
+  it "implements hash style getters and setters for its body" do
+    test_key = 'key-123'
+    test_body = { 'field_one' => '123', 'field_two' => 'abc' }
+    doc = RiakJson::Document.new(test_key, test_body)
+    
+    doc['field_one'].must_equal '123'
+      
+    doc['field_two'] = 'xyz'
+    doc.body['field_two'].must_equal 'xyz'
+  end
+end

data/test/unit/query_test.rb

@@ -0,0 +1,30 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2013" Basho Technologies, Inc.
+##
+## This file is provided to you 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.
+##
+## -------------------------------------------------------------------
+
+require 'helper'
+
+describe "a Query" do
+  it "can be created manually, from a json object" do
+    json = {'country' => 'USA'}.to_json
+    query = RiakJson::Query.from_json(json)
+    query.must_be_kind_of RiakJson::Query
+    query.body = json
+  end
+end