riagent 0.0.1

data/lib/riagent/version.rb

@@ -0,0 +1,23 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 Riagent
+  VERSION = "0.0.1"
+end

data/lib/riagent.rb

@@ -0,0 +1,29 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 "riagent/version"
+require "riagent/errors"
+require "riagent/configuration"
+require "riagent/active_document"
+require "riagent/railtie" if defined?(Rails)
+
+module Riagent
+  extend Riagent::Configuration
+end

data/riagent.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'riagent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "riagent"
+  spec.version       = Riagent::VERSION
+  spec.authors       = ["Dmitri Zagidulin"]
+  spec.email         = ["dzagidulin@gmail.com"]
+  spec.summary       = %q{Rails integration for RiakJson document store}
+  spec.description   = %q{Provides Ruby on Rails integration for RiakJson (Riak + Solr document store API)}
+  spec.homepage      = "https://github.com/dmitrizagidulin/riagent"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "riak_json"
+  spec.add_runtime_dependency "riak-client"
+  spec.add_runtime_dependency "riagent-document"
+  spec.add_runtime_dependency "activemodel", "~> 4.0"
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "minitest-spec-context"
+end

data/test/config/riak.yml.example

@@ -0,0 +1,19 @@
+# Sample riak.yml config file for running integration tests
+# Be sure to 'cp riak.yml.example riak.yml' before testing
+
+# Configure Riak and RiakJson connections for the client, by environment
+development:
+  http_port: 8098
+  pb_port: 8097   # Protocol Buffer port
+  host: 127.0.0.1
+
+# You should spin up another Riak instance to use as a test server
+test:
+  http_port: 8098
+  pb_port: 8097
+  host: 127.0.0.1
+
+production:
+  http_port: 8098
+  pb_port: 8097
+  host: 127.0.0.1

data/test/examples/models/address_book.rb

@@ -0,0 +1,32 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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_relative 'contact'
+
+# Sample model demonstrating embedding of other ActiveDocuments
+# See test/examples/models/contact.rb (the model that's being embedded)
+# See also test/unit/embedded_test.rb
+class AddressBook
+  include Riagent::ActiveDocument
+
+  collection_type :riak_json  # Persist to a RiakJson::Collection
+  
+  attribute :contacts, Set[Contact]
+end

data/test/examples/models/blog_post.rb

@@ -0,0 +1,31 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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.
+##
+## -------------------------------------------------------------------
+
+class BlogPost
+  include Riagent::ActiveDocument
+  
+  collection_type :riak_json  # Persist to a RiakJson::Collection
+  
+  # Explicit attributes
+  # key is an implied attribute, present in all ActiveDocument instances
+  attribute :title, String, search_index: { as: :text }
+  attribute :description, String, search_index: { as: :text }
+  attribute :body, String, search_index: { as: :text }
+end

data/test/examples/models/contact.rb

@@ -0,0 +1,29 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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.
+##
+## -------------------------------------------------------------------
+
+# Sample model to be embedded in another ActiveDocument
+# See test/examples/models/address_book.rb
+# See also test/unit/embedded_test.rb
+class Contact
+  include Riagent::ActiveDocument
+  
+  attribute :contact_name, String
+  attribute :contact_email, String
+end

data/test/examples/models/user.rb

@@ -0,0 +1,41 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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_relative 'address_book'
+require_relative 'blog_post'
+
+class User
+  include Riagent::ActiveDocument
+  
+  collection_type :riak_json  # Persist to a RiakJson::Collection
+  
+  # Explicit attributes
+  # key is an implied attribute, present in all ActiveDocument instances
+  attribute :username, String, search_index: { as: :text }
+  attribute :email, String, search_index: { as: :string }, default: ''
+  attribute :language, String, default: 'en'
+  
+  # Associations
+  has_one :address_book, :class => AddressBook
+  has_many :posts, :class => BlogPost, :using => :solr
+  
+  # Validations
+  validates_presence_of :username
+end

data/test/integration/persistence_integration_test.rb

@@ -0,0 +1,76 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+TEST_USERNAME = 'earl'
+TEST_USERNAME_2 = 'count'
+
+def test_user(test_key='earl-123')
+  user = User.new username: TEST_USERNAME, email: 'earl@desandwich.com'
+  user.key = test_key
+  user
+end
+
+describe "a Riagent::ActiveDocument's Persistence Layer" do  
+  it "can save a document and generate a key" do
+    user = User.new username: TEST_USERNAME
+    generated_key = user.save
+    
+    generated_key.wont_be_nil "Key not generated from document.save"
+    generated_key.wont_be_empty "Key not generated from document.save"
+    generated_key.must_be_kind_of String
+    user.key.must_equal generated_key
+    
+    refute user.new_record?, "Document should not be marked as new after saving"
+    assert user.persisted?, "Document should be marked as persisted after saving"
+    
+    # Clean up
+    user.destroy
+  end
+  
+  it "can read, update and delete a document" do
+    test_key = 'george-123'
+    new_user = User.new username: 'george', email: 'george@washington.com'
+    new_user.key = test_key
+    new_user.save
+    
+    found_user = User.find(test_key) # Load User by key
+    found_user.must_be_kind_of User
+    found_user.key.must_equal test_key
+    refute found_user.new_record?, "A loaded by key user object is not new"
+    assert found_user.persisted?, "A loaded by key user object should be markes as persisted"
+    
+    new_attributes = {username: 'henry', email: 'henry@gmail.com' }
+    found_user.update(new_attributes)  # Also saves
+    
+    updated_user = User.find(test_key)
+    updated_user.username.must_equal 'henry'
+    
+    found_user.destroy
+    assert found_user.destroyed?
+  end
+  
+  it "returns an empty array for queries that return no results" do
+    query = { username: 'nonexistent' }
+    result = User.where(query)
+    result.must_be_empty
+  end
+end

data/test/seeds.rb

@@ -0,0 +1,30 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'riagent'
+require './test/examples/models/user'
+
+puts "Seeding..."
+# Load config file and set up the relevant clients for seeding test data
+Riagent.load_config_file('test/config/riak.yml')
+Riagent.init_clients(:test)  # Set up the client for the test environment
+
+# Store the Solr indexing schema for the User model
+User.save_solr_schema()

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'riagent'
+require 'examples/models/address_book'
+require 'examples/models/contact'
+require 'examples/models/user'
+
+# Set this to silence "[deprecated] I18n.enforce_available_locales will default to true in the future." warnings
+I18n.config.enforce_available_locales = true
+
+# Load config file and set up the relevant clients for integration testing
+Riagent.load_config_file('test/config/riak.yml')
+Riagent.init_clients(:test)  # Set up the client for the test environment

data/test/unit/active_document_test.rb

@@ -0,0 +1,41 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+describe "a Riagent::ActiveDocument" do
+  # an instance of Riagent::ActiveDocument
+  # see test/models/user.rb
+  let(:user_model) { User.new }
+  
+  it "extends Riagent::Document" do
+    user_model.must_be_kind_of Riagent::Document
+  end
+  
+  it "should know its collection name" do
+    # a document's collection name is used in ActiveModel::Conversion compatibility
+    User.collection_name.must_equal 'users'
+  end
+  
+  it "uses its collection name to help form URLs" do
+    user_model.key = 'test-user-123'
+    user_model.to_partial_path.must_equal 'users/test-user-123'
+  end
+end

data/test/unit/active_model_lint_test.rb

@@ -0,0 +1,33 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+require 'active_model/lint'
+
+# Runs the ActiveModel::Lint test suite, to make sure a model fits the ActiveModel API
+# See http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/
+class ActiveModelLintTest < MiniTest::Test
+  include ActiveModel::Lint::Tests
+  
+  def setup
+    # Sample Riagent::ActiveDocument instance, implementing the ActiveModel API. See test/examples/models/user.rb
+    @model = User.new
+  end
+end

data/test/unit/associations_has_many_test.rb

@@ -0,0 +1,32 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+describe "Riagent::Document has_many association" do
+  # If User has_many :posts,
+  # Then user is source, posts is a target collection
+  
+  it "adds getter and setter methods for the target collection" do
+    user = User.new
+    user.must_respond_to :posts
+    user.must_respond_to :posts=
+  end
+end

data/test/unit/associations_has_one_test.rb

@@ -0,0 +1,85 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+describe "Riagent::Document has_one association" do
+  # If User has_one :address_book,
+  # Then user is source, and address_book is target
+  
+  it "adds a <target>_key attribute" do
+    # a User model includes a 'has_one :address_book' association
+    User.attribute_set[:address_book_key].wont_be_nil
+    user = User.new
+    user.must_respond_to :address_book_key
+  end
+  
+  it "adds getter and setter methods for the target" do
+    user = User.new
+    user.must_respond_to :address_book
+    user.must_respond_to :address_book=
+  end
+
+  it "assigning a target object sets corresponding <target>_key and <target> attribute values" do
+    user = User.new
+    address_book = AddressBook.new
+    address_book.key = 'test-book-123'
+
+    user.address_book = address_book
+
+    user.address_book_key.must_equal 'test-book-123'
+
+    user.address_book.must_be_kind_of AddressBook
+  end
+  
+  it "should check type when assigning to a target attribute" do
+    user = User.new
+    lambda { user.address_book = User.new }.must_raise ArgumentError
+  end
+
+  it "lazy loads the target object, if key is present" do
+    user = User.new
+    user.address_book_key = 'test-book-123'  # Set the target key manually
+    user.address_book_cache.must_be_nil "Setting the target key should not load the target object instance"
+    
+    # Create a mock object that'll be loaded from db
+    mock_loaded_address_book = AddressBook.new
+    mock_loaded_address_book.key = 'test-book-123'
+    
+    AddressBook.collection = MiniTest::Mock.new
+    AddressBook.collection.expect :find_by_key, mock_loaded_address_book, ['test-book-123']
+      
+    # Calling user.address_book should lazy-load via the target collection.find_by_key()
+    user.address_book
+    AddressBook.collection.verify
+    
+    # Reset
+    AddressBook.collection = nil
+  end
+  
+  it "adds a build_<target> method" do
+    user = User.new
+    user.key = 'test-user-123'
+    
+    user.build_address_book(attributes={})
+    # Target object gets source object's key by default, via build_<target>()
+    user.address_book.key.must_equal 'test-user-123'
+  end
+end

data/test/unit/config_test.rb

@@ -0,0 +1,37 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+describe "Riagent" do
+  it "provides a configuration hash" do
+    Riagent.config.must_be_kind_of Hash
+    Riagent.config.wont_be_empty  # The config file was initialized by test_helper.rb
+    Riagent.must_respond_to :load_config_file
+    Riagent.must_respond_to :init_clients
+    Riagent.must_respond_to :init_riak_json_client
+    Riagent.must_respond_to :riak_json_client
+  end
+  
+  it "initializes a RiakJson client" do
+    # This should have been initialized from config file in test_helper.rb
+    Riagent.riak_json_client.must_be_kind_of RiakJson::Client
+  end
+end

data/test/unit/embedded_test.rb

@@ -0,0 +1,38 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and 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 'test_helper'
+
+describe "a Riagent::ActiveDocument" do
+  it "can be composed of other embedded ActiveDocuments" do
+    address_book = AddressBook.new user_key: 'earl-123'
+    c1 = Contact.new contact_name: 'Joe', contact_email: 'joe@test.net'
+    c2 = Contact.new contact_name: 'Jane', contact_email: 'jane@test.net'
+    address_book.contacts << c1
+    address_book.contacts << c2
+    json_str = address_book.to_json_document
+    
+    new_book = AddressBook.from_json json_str
+    new_book.contacts.count.must_equal 2
+    contact = new_book.contacts.first
+    contact.contact_name.must_equal 'Joe'
+    contact.must_be_kind_of Contact
+  end
+end