riak_json 0.0.2

data/lib/riak_json/errors.rb

@@ -0,0 +1,25 @@
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+
+module RiakJson
+  # Generic RiakJson exception class
+  class RiakJsonError < StandardError
+  end
+end

data/lib/riak_json/query.rb

@@ -0,0 +1,34 @@
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+
+module RiakJson
+  # Query helper object
+  # Provides a DSL for building json queries to collections
+  class Query
+    attr_accessor :body
+    
+    # Create a Query object instance with a custom-built query
+    def self.from_json(json)
+      query = RiakJson::Query.new
+      query.body = json
+      query
+    end
+  end
+end

data/lib/riak_json/query_result.rb

@@ -0,0 +1,50 @@
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+
+module RiakJson
+  # QueryResult is a helper object that
+  # holds the results of a collection.find_all query
+  class QueryResult
+    attr_reader :documents
+    attr_reader :num_pages
+    attr_reader :page
+    attr_reader :per_page
+    attr_reader :total
+    
+    def initialize(response)
+      if response.nil? or response.empty?
+        result_hash = {}
+      else
+        result_hash = JSON.parse(response)
+        if result_hash.kind_of? Array and result_hash.empty?
+          result_hash = {}
+        end
+      end
+      
+      @num_pages = result_hash.fetch('num_pages', 0)
+      @page = result_hash.fetch('page', 0)
+      @total = result_hash.fetch('total', 0)
+      @per_page = result_hash.fetch('per_page', 0)
+      
+      documents = result_hash.fetch('data', [])
+      @documents = documents.map { | body | RiakJson::Document.new(body['_id'], body) }
+    end
+  end
+end

data/lib/riak_json/version.rb

@@ -0,0 +1,23 @@
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+
+module RiakJson
+  VERSION = "0.0.2"
+end

data/lib/riak_json.rb

@@ -0,0 +1,34 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 'riak_json/client'
+require 'riak_json/client_transport'
+require 'riak_json/collection'
+require 'riak_json/collection_schema'
+require 'riak_json/document'
+require 'riak_json/errors'
+require 'riak_json/query'
+require 'riak_json/query_result'
+require 'riak_json/version'
+
+# RiakJson is a client library for reading and writing
+# documents to the RiakJson document store.
+module RiakJson
+end

data/riak_json.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riak_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "riak_json"
+  spec.version       = RiakJson::VERSION
+  spec.authors       = ["Dmitri Zagidulin", "Drew Kerrigan"]
+  spec.email         = ["dzagidulin@basho.com", "dkerrigan@basho.com"]
+  spec.description   = %q{A Ruby client for Riak Json}
+  spec.summary       = %q{riak_json is a client library for RiakJson, a set of JSON document based endpoints for the Riak database}
+  spec.homepage      = "http://github.com/basho-labs/riak_json_ruby_client"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'json'
+  spec.add_dependency 'rest-client' 
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-spec-context"
+
+  spec.add_development_dependency "ruby-prof"
+  spec.add_development_dependency "debugger", "1.6.5"
+  spec.add_development_dependency "pry"
+end

data/test/examples/riak.yml

@@ -0,0 +1,13 @@
+# Configure Riak Json connections for the client, by environment
+development:
+  http_port: 8098
+  host: 127.0.0.1
+
+# You can spin up another RiakJson instance to use as a test server
+test:
+  http_port: 8098
+  host: 127.0.0.1
+
+production:
+  http_port: 8098
+  host: 127.0.0.1

data/test/helper.rb

@@ -0,0 +1,31 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 'minitest/autorun'
+require 'minitest-spec-context'
+require 'riak_json'
+
+class Minitest::Test
+  def rj_test_client
+    host = ENV['RIAK_HOST'] ? ENV['RIAK_HOST'] : RiakJson::RIAK_TEST_HOST
+    port = ENV['RIAK_PORT'] ? ENV['RIAK_PORT'] : RiakJson::RIAK_TEST_PORT
+    @rj_client ||= RiakJson::Client.new(host, port)
+  end
+end

data/test/integration/client_integration_test.rb

@@ -0,0 +1,51 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "RiakJson Ruby Client" do
+  it "can load configuration from a file" do
+    test_config_path = 'test/examples/riak.yml'
+    config_hash = RiakJson::Client.load_config_file(test_config_path)
+    assert config_hash.include?('development'), "Sample config file should have a 'development' environment section"
+    dev_config = config_hash['development']
+    dev_config['http_port'].wont_be_nil
+    dev_config['host'].wont_be_nil
+    # The loaded config hash can then be used to set up the client
+    client = RiakJson::Client.new(dev_config['host'], dev_config['http_port'])
+  end
+  
+  context "connects to RiakJson" do
+    it "can perform an HTTP /ping to the RiakJson cluster" do
+      response = rj_test_client.ping
+      response.must_equal 'OK'
+      response.code.must_equal 200
+    end
+  end
+  
+  context "performs document Schema administration" do
+    it "receives a 404 Exception when reading a non-existing schema" do
+      # Note: A default schema is auto-created whenever a document is written to a collection
+      # For a schema to not exist, no schemas could have been stored for that collection, and no documents inserted
+      collection_name = 'non-existing-collection'
+      lambda { rj_test_client.get_schema(collection_name) }.must_raise RestClient::ResourceNotFound  # 404
+    end
+  end
+end

data/test/integration/collection_integration_test.rb

@@ -0,0 +1,227 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "uses a RiakJson client to perform CRUD on raw JSON objects" do
+    it "inserts a raw json object with a 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
+      key = collection.insert_raw_json(test_key, json_obj)
+      key.must_equal test_key
+    end
+    
+    it "updates a raw json object" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      test_key = 'document-key-update'
+      # Insert an object first
+      json_obj_initial = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+      collection.insert_raw_json(test_key, json_obj_initial)
+      
+      # Now update the object
+      json_obj_modified = { 'field_one' => '345', 'field_two' => 'efg' }.to_json
+      collection.update_raw_json(test_key, json_obj_modified)
+    end
+    
+    it "deletes a raw json object" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)  # create a new collection object
+      test_key = 'document-key-delete'
+      # Insert an object first
+      json_obj = { 'field_one' => '123', 'field_two' => 'abc' }.to_json
+      collection.insert_raw_json(test_key, json_obj)
+      
+      # Now delete that object
+      collection.delete_raw_json(test_key)
+      
+      # Issue a get to make sure it now returns a 404 / Resource not found exception
+      lambda { collection.get_raw_json(test_key) }.must_raise RestClient::ResourceNotFound
+    end
+  end
+  
+  context "uses a RiakJson client to perform CRUD on RiakJson Documents" do
+    it "inserts a new document with a key" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      test_key = 'key-123'
+      test_body = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_body)
+      key = collection.insert(doc)
+      key.must_equal test_key
+    end
+    
+    it "inserts a new document with no key, receives key from RiakJson" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      test_body = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new
+      doc.body = test_body
+      doc.key.must_be_nil
+      
+      # Insert the document, get key back from db
+      generated_key = collection.insert(doc)
+      # The insert() operation should initialize the document's key field
+      doc.key.must_equal generated_key
+    end
+    
+    it "updates an existing document" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      test_key = 'key-123'
+      test_body = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_body)
+      collection.update(doc)
+    end
+    
+    it "reads an existing document (loads it by key)" do
+      client = rj_test_client
+      collection_name = 'ruby_test_collection'
+      collection = client.collection(collection_name)
+
+      # First, insert the document that's to be read
+      test_key = 'key-123'
+      test_body = { 'field_one' => 'abc' }
+      doc = RiakJson::Document.new(test_key, test_body)
+      collection.update(doc)
+
+      loaded_doc = collection.find_by_key(test_key)
+      loaded_doc.must_be_kind_of RiakJson::Document
+      loaded_doc['field_one'].must_equal 'abc'
+    end
+  end
+  
+  context "can set, read and delete schemas" do
+    it "can use a raw JSON object to set schema" do
+      client = rj_test_client
+      collection = client.collection('cities')
+
+      schema = [{
+           :name => "city",
+           :type => "text",
+           :require => true
+          }, {
+            :name => "state",
+            :type => "string",
+            :require => true
+          }, {
+            :name => "zip_codes",
+            :type => "multi_string",
+            :require => false
+          }, {
+            :name => "population",
+            :type => "integer",
+            :require => false
+          }, {
+            :name => "country",
+            :type => "string",
+            :require => true
+          }].to_json
+      response = collection.set_schema(schema)
+      collection.has_schema?.must_equal true
+      response.code.must_equal 204
+    end
+    
+    it "uses a CollectionSchema object to set schemas" do
+      client = rj_test_client
+      collection = client.collection('cities')
+      
+      schema = RiakJson::CollectionSchema.new
+      schema.add_text_field(name='city', required=true)
+      schema.add_string_field('state', true)
+      schema.add_multi_string_field('zip_codes') # required: false 
+      schema.add_integer_field('population', false)
+      schema.add_string_field('country', true)
+      
+      response = collection.set_schema(schema)
+      response.code.must_equal 204
+    end
+    
+    it "can delete (unset) a schema for a collection" do
+      client = rj_test_client
+      collection = client.collection('cities-delete-schema')
+      
+      # Ensure a collection has an existing schema
+      schema = RiakJson::CollectionSchema.new
+      schema.add_text_field(name='city', required=true)
+      response = collection.set_schema(schema)
+      response.code.must_equal 204
+      
+      # Delete the schema
+      response = collection.delete_schema
+      response.code.must_equal 204
+      
+    end
+  end
+  
+  context "performs queries" do
+    it "retrieves a single document with find_one()" do
+      client = rj_test_client
+      collection = client.collection('cities')
+      key = "nyc"
+      body = { 'city' => "New York", 'state' => "NY", 'country' => "USA" }
+      doc = RiakJson::Document.new(key, body)
+      collection.insert(doc)
+      
+      result_doc = collection.find_one({"city" => "New York"}.to_json)
+      result_doc.key.must_equal "nyc"
+    end
+    
+    it "retrieves many documents with find_all()" do
+      client = rj_test_client
+      collection = client.collection('cities')
+      
+      # Populate the cities collection with data
+      doc = RiakJson::Document.new(
+        key="nyc",
+        body={ 'city'=>"New York", 'state'=>"NY", 'country'=>"USA" })
+      collection.insert(doc)
+      doc = RiakJson::Document.new(
+        key="boston",
+        body={ 'city'=>"Boston", 'state'=>"MA", 'country'=>"USA" })
+      collection.insert(doc)
+      doc = RiakJson::Document.new(
+        key="sf",
+        body={ 'city'=>"San Francisco", 'state'=>"CA", 'country'=>"USA" })
+      collection.insert(doc)
+      
+      results = collection.find_all({'country'=>'USA'}.to_json)
+      results.num_pages.must_equal 1  # Total number of pages in result set
+      results.page.must_equal 0  # Current page, zero-indexed
+      results.total.must_equal 3  # Total number of documents in result set
+      results.per_page.must_be :>, 0  # defaults to 100
+      
+      results.documents.count.must_equal 3
+      results.documents[0].must_be_kind_of RiakJson::Document
+    end
+  end
+end