riagent 0.0.1

data/test/unit/persistence_riak_json_test.rb

@@ -0,0 +1,118 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 that persists to RiakJson" do
+  it "saves via collection.insert()" do
+    user = User.new
+    User.collection = MiniTest::Mock.new
+    User.collection.expect :insert, nil, [user]
+    
+    # Calling model.save() should result in a collection.insert() call
+    user.save({:validate => false})
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+
+  it "updates via collection.update()" do
+    user = User.new username: 'TestUserInitial'
+    User.collection = MiniTest::Mock.new
+    User.collection.expect :insert, nil, [user]
+    
+    # model.update() is implemented as a save() call (with updated attributes)
+    user.update({ username: 'TestUserNewName'} )
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+  
+  it "destroys via collection.remove()" do
+    user = User.new
+    User.collection = MiniTest::Mock.new
+    User.collection.expect :remove, nil, [user]
+    
+    # Calling model.destroy() should result in a collection.remove() call
+    user.destroy
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+  
+  it "returns nil when doing a find() for nil or empty key" do
+    User.find(nil).must_be_nil
+    User.find('').must_be_nil
+  end
+  
+  it "performs a find() via collection.find_by_key()" do
+    test_key = 'user123'
+    User.collection = MiniTest::Mock.new
+    User.collection.expect :find_by_key, nil, [test_key]
+    
+    # Calling Model class find() should result in a collection.find_by_key()
+    User.find(test_key)
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+  
+  it "performs a where() via collection.find_all()" do
+    User.collection = MiniTest::Mock.new
+    query = { country: 'USA' }
+    User.collection.expect :find_all, [], [query.to_json]
+    
+    # Calling Model class where() should result in a collection.find_all()
+    User.where(query)
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+  
+  it "performs a find_one() via collection.find_one()" do
+    User.collection = MiniTest::Mock.new
+    query = { username: 'TestUser' }
+    User.collection.expect :find_one, [], [query.to_json]
+    
+    # Calling Model class find_one() should result in a collection.find_one()
+    User.find_one(query)
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+  
+  it "performs an all_for_field() via collection.find_all()" do
+    User.collection = MiniTest::Mock.new
+    User.collection.expect :find_all, [], [String]
+    
+    # Calling Model class all_for_field() should result in a collection.find_all()
+    User.all_for_field(:username)
+    User.collection.verify
+    
+    # Reset
+    User.collection = nil
+  end
+end

data/test/unit/persistence_test.rb

@@ -0,0 +1,57 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 has Persistence options" do
+  context "via collection_type :riak_json" do
+    it "#model class methods" do
+      # Adding the line +collection_type :riak_json+ to a model 
+      # means that it will be persisted to a RiakJson::Collection
+      User.get_collection_type.must_equal :riak_json
+      User.persistence_strategy.must_equal :riak_json
+      
+      # It also grants access to a RiakJson::Client instance, to the model class
+      User.client.must_be_kind_of RiakJson::Client
+      
+      User.collection.must_be_kind_of RiakJson::Collection
+      User.collection_name.must_equal 'users'
+    end
+    
+    it "#model persistence instance methods" do
+      user = User.new
+      
+      # Adding the line +collection_type :riak_json+ to a model 
+      # exposes the usual array of persistence methods
+      user.must_respond_to :save
+      user.must_respond_to :save!
+      user.must_respond_to :update
+      user.must_respond_to :update_attributes  # alias for update()
+      user.must_respond_to :update!
+      user.must_respond_to :destroy
+    end
+    
+    it "#model persistence class methods" do
+      User.must_respond_to :find
+      User.must_respond_to :find_one
+      User.must_respond_to :where
+    end
+  end
+end

data/test/unit/search_schema_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+describe "an Active Document" do
+  it "can build a RiakJson schema from the annotated attributes" do
+    schema = User.schema
+    schema.must_be_kind_of RiakJson::CollectionSchema
+    schema.fields.wont_be_empty
+    schema.fields.count.must_equal 2
+    schema.fields[0][:name].to_s.must_equal 'username'
+    schema.fields[0][:type].must_equal 'text'
+    schema.fields[0][:require].must_equal true
+    schema.fields[1][:name].to_s.must_equal 'email'
+    schema.fields[1][:type].must_equal 'string'
+    schema.fields[1][:require].must_equal true
+  end
+  
+  it "can save the Solr indexing schema to RiakJson" do
+    schema = User.schema
+    User.collection = MiniTest::Mock.new
+
+    # Ensure that calling User.save_solr_schema() results in a call to collection.set_schema()
+    User.collection.expect :set_schema, nil, [RiakJson::CollectionSchema]
+    User.save_solr_schema
+    User.collection.verify
+  end
+end

data/test/unit/validation_test.rb

@@ -0,0 +1,39 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "supports ActiveModel validations" do
+    @new_user = User.new
+    refute @new_user.valid?, "User requires a username to be present"
+    assert @new_user.errors.messages.include?(:username), "Missing username validation error when saving"
+    
+    @new_user.username = "TestUser"
+    assert @new_user.valid?, "User should now be valid, after setting a username"
+  end
+  
+  it "raises InvalidDocumentError on save!()" do
+    @new_user = User.new
+    refute @new_user.valid?, "User requires a username to be present"
+    refute @new_user.save, "User requires a username, save should fail"
+    lambda { @new_user.save! }.must_raise Riagent::InvalidDocumentError  # save!  should raise an exception
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: riagent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitri Zagidulin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riak_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: riagent-document
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides Ruby on Rails integration for RiakJson (Riak + Solr document
+  store API)
+email:
+- dzagidulin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails/generators/riagent/install/install_generator.rb
+- lib/rails/generators/riagent/install/templates/riak.yml
+- lib/riagent.rb
+- lib/riagent/active_document.rb
+- lib/riagent/associations.rb
+- lib/riagent/configuration.rb
+- lib/riagent/conversion.rb
+- lib/riagent/errors.rb
+- lib/riagent/persistence.rb
+- lib/riagent/persistence/riak_json_strategy.rb
+- lib/riagent/railtie.rb
+- lib/riagent/search_schema.rb
+- lib/riagent/version.rb
+- riagent.gemspec
+- test/config/riak.yml.example
+- test/examples/models/address_book.rb
+- test/examples/models/blog_post.rb
+- test/examples/models/contact.rb
+- test/examples/models/user.rb
+- test/integration/persistence_integration_test.rb
+- test/seeds.rb
+- test/test_helper.rb
+- test/unit/active_document_test.rb
+- test/unit/active_model_lint_test.rb
+- test/unit/associations_has_many_test.rb
+- test/unit/associations_has_one_test.rb
+- test/unit/config_test.rb
+- test/unit/embedded_test.rb
+- test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_test.rb
+- test/unit/search_schema_test.rb
+- test/unit/validation_test.rb
+homepage: https://github.com/dmitrizagidulin/riagent
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Rails integration for RiakJson document store
+test_files:
+- test/config/riak.yml.example
+- test/examples/models/address_book.rb
+- test/examples/models/blog_post.rb
+- test/examples/models/contact.rb
+- test/examples/models/user.rb
+- test/integration/persistence_integration_test.rb
+- test/seeds.rb
+- test/test_helper.rb
+- test/unit/active_document_test.rb
+- test/unit/active_model_lint_test.rb
+- test/unit/associations_has_many_test.rb
+- test/unit/associations_has_one_test.rb
+- test/unit/config_test.rb
+- test/unit/embedded_test.rb
+- test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_test.rb
+- test/unit/search_schema_test.rb
+- test/unit/validation_test.rb