riagent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eadd9aec51f179844d1ac1a5ff54826ba59ad35
+  data.tar.gz: 4cbaed26f3b6f06e43c0405f401b69835f10ca81
+SHA512:
+  metadata.gz: b31c273dbcc22ad47467ce2f7d5875ce6b04be513124b38973695130266341ed4e8440bc786d34f7e9d044271b0f77a46abc50b05f4f0155086765cfbe852bac
+  data.tar.gz: e59f9bdd5a8e332de5e56c49e3565c772e485fbff10e19ae3f96fd1ac79e0d6ad0e4436d1c041290c471fe95ffe50c4216710d6bc8f86a187fa5e743966e0acf

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/config/riak.yml
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,24 @@
+## ------------------------------------------------------------------- 
+## 
+## 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.
+##
+## -------------------------------------------------------------------
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in riagent.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    riagent (0.0.1)
+      activemodel (~> 4.0)
+      activesupport (~> 4.0)
+      riagent-document
+      riak-client
+      riak_json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    axiom-types (0.0.5)
+      descendants_tracker (~> 0.0.1)
+      ice_nine (~> 0.9)
+    beefcake (0.3.7)
+    builder (3.1.4)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.3)
+    equalizer (0.0.9)
+    i18n (0.6.9)
+    ice_nine (0.11.0)
+    innertube (1.0.2)
+    json (1.8.1)
+    mime-types (2.1)
+    minitest (4.7.5)
+    minitest-spec-context (0.0.3)
+    multi_json (1.8.4)
+    rake (10.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    riagent-document (0.0.1)
+      activesupport (~> 4.0)
+      virtus
+    riak-client (1.4.3)
+      beefcake (~> 0.3.7)
+      builder (>= 2.1.2)
+      i18n (>= 0.4.0)
+      innertube (~> 1.0.2)
+      multi_json (~> 1.0)
+    riak_json (0.0.2)
+      json
+      rest-client
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    virtus (1.0.1)
+      axiom-types (~> 0.0.5)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest (~> 4.2)
+  minitest-spec-context
+  rake
+  riagent!

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

@@ -0,0 +1,230 @@
+# riagent
+
+Object Document Mapper for RiakJson (Riak + Solr), for use with Ruby on Rails 4 and Sinatra.
+
+## Requirements
+ - Ruby 1.9+
+ - Riak build with [Riak Json](https://github.com/basho-labs/riak_json) and Solr/Yokozuna enabled 
+   (see [Setup](https://github.com/basho-labs/riak_json#setup) section for instructions)
+ - [RiakJson](https://github.com/basho-labs/riak_json_ruby_client) Ruby Client gem installed locally
+ - [riagent-document](https://github.com/dmitrizagidulin/riagent-document) gem installed locally
+
+## Motivation
+*a.k.a. Why not just use a plain [riak_json client](https://github.com/basho-labs/riak_json_ruby_client) or a 
+[riak-ruby-client](https://github.com/basho/riak-ruby-client)?*
+
+A RiakJson or Riak client just answers the question "How do I store stuff in Riak?". 
+In order to develop any non-toy application using Riak as a persistence layer, a developer must answer further questions:
+
+ - How do I define my model objects, and how do I serialize them so I can store them in Riak?
+ - What will my access patterns be? Plain Key/Value reads and writes, or will I need to perform queries?
+ - How do I integrate painlessly with my framework of choice? (Ruby on Rails, Sinatra)
+
+Riagent attempts to provide answers to those questions, to encode recommended best-practice Riak query patterns,
+and in general to aid rapid application development by working with Riak's strenghts while respecting its limitations. 
+It is intended as a spiritual successor to [Ripple](https://github.com/basho-labs/ripple).
+
+#### Model Definition and Serialization
+Riagent provides a model definition language that will be familiar to most Rails developers, via 
+the [riagent-document](https://github.com/dmitrizagidulin/riagent-document) gem.
+
+```ruby
+include 'riagent-document'
+
+class User
+  include Riagent::ActiveDocument
+  
+  attribute :username, String
+  attribute :email, String
+  attribute :country, String, default: 'USA'
+end
+```
+
+Riagent::ActiveDocument instances provide a rich set of functionality including attribute defaults, type coercions, 
+conversion to and from JSON, search schema creation, easy persistence to Riak,
+document embedding, and more. See the [riagent-document README](https://github.com/dmitrizagidulin/riagent-document)
+for more details.
+
+#### Advanced Riak K/V and Query Support
+Reads and writes of single objects into Riak are easy (and have the benefit of being massively scalable, highly concurrent, and fault-tolerant).
+But what about listing and querying? Every developer that gets past a Hello World get/put tutorial on Riak is soon faced with questions
+about more advanced access patterns. How do I implement collections, and list things? How do I search or query on various attributes?
+Should I use Secondary Indexes? What about Search/Solr integration? 
+
+Riagent provides a set of high-level notations and functionality that allows developers create collections and associations on Riak,
+either via plain K/V operations when possible, or via advanced mechanisms such as Solr/[RiakJson](https://github.com/basho-labs/riak_json)
+queries when necessary.
+
+```ruby
+class User
+  include Riagent::ActiveDocument
+  
+  collection_type :riak_json  # Persist to a RiakJson::Collection
+  
+  attribute :username, String, search_index: { as: :text }
+  attribute :email, String, search_index: { as: :string }
+  attribute :language, String, default: 'en'
+  
+  # Associations
+  has_one :email_preference, :class => EmailPreference
+  has_many :posts, :class => BlogPost, :using => :solr
+  
+  # Validations
+  validates_presence_of :username
+end
+```
+
+#### Rails and Sinatra integration
+Riagent and ActiveDocuments are integrated into the usual Rails workflow. 
+
+ - Riagent provides client configuration and initialization, via the ```config/riak.yml``` file
+ - Provides a simple Key/Value persistence layer with ```save()```, ```find()```, ```update()``` and ```destroy()``` methods.
+ - ActiveDocument implements the ActiveModel API.
+   (Specifically, passes the [ActiveModel Lint Test suite](http://api.rubyonrails.org/classes/ActiveModel/Lint/Tests.html))
+ - Provides a full range of validations for each attribute.
+ - Provides ```before_save``` / ```after_save``` type Callback functionality
+ - Provides a custom Query capability (to Riak/Solr), for searches, range queries, aggregations and more
+ - Derives RiakJson/Solr search schemas from annotated document attributes (see Schemas below)
+
+## Usage
+### Adding Riagent to a Rails App
+Add it to the Gemfile of your Rails app:
+
+```ruby
+gem 'riagent'
+```
+
+Run the install generator:
+```bash
+rails generate riagent:install
+```
+
+This creates a ```config/riak.yml``` file. Edit it to point to your running Riak instance.
+
+### Controller and View helpers
+Since they implement the ActiveModel API, when you use ActiveDocuments in 
+a Rails model, the usual ```link_to```/route-based helpers work:
+```erb
+# In a user view file
+<%= link_to @user.username, @user %> # => <a href="/users/EmuVX4kFHxxvlUVJj5TmPGgGPjP">HieronymusBosch</a>
+<%= link_to 'Edit', edit_user_path(@user) %>  # => <a href="/users/EmuVX4kFHxxvlUVJj5TmPGgGPjP/edit">Edit</a>
+# In a controller
+redirect_to users_url
+```
+
+### Validations
+ActiveDocument supports the full range of [ActiveModel validations](http://api.rubyonrails.org/classes/ActiveModel/Validations.html)
+
+```ruby
+# Try saving an invalid document
+new_user = User.new
+new_user.valid?  # => false
+puts user.errors.messages  # => {:username=>["can't be blank"]}
+new_user.save  # => false (does not actually save, since document not valid)
+new_user.save!  # => raises Riagent::InvalidDocumentError exception
+
+# Now make it valid
+new_user.username = 'HieronymusBosch'
+new_user.valid?  # => true
+new_user.save  # => saves and loads the generated key into document
+new_user.key  # => 'EmuVX4kFHxxvlUVJj5TmPGgGPjP'
+```
+
+### Key/Value Persistence
+The usual array of CRUD type k/v operations is available to an ActiveDocument model.
+
+Create documents via ```save()``` and ```save!()```
+```ruby
+user = User.new({username: 'John', email: 'john@doe.com'})
+# If you save without specifying a key, RiakJson generates a UUID type key automatically
+user.save  # => 'EmuVX4kFHxxvlUVJj5TmPGgGPjP'
+```
+
+To load a document by key, use ```find()```:
+
+```ruby
+user = User.find('EmuVX4kFHxxvlUVJj5TmPGgGPjP')
+```
+
+Update and Delete work in a similar fashion
+```ruby
+user.username = 'New Name'
+user.update  # update!() is also available
+user.destroy  # deletes the document
+```
+
+### Callbacks
+ActiveDocument currently supports ```before_*``` and ```after_*``` [callbacks](http://api.rubyonrails.org/classes/ActiveSupport/Callbacks.html) 
+for the following events:
+```[:create, :update, :save, :destroy]```
+
+### Search and Querying
+See the Querying sections of [RJ Ruby Client](https://github.com/basho-labs/riak_json_ruby_client#querying-riakjson---find_one-and-find)
+and [RiakJson itself](https://github.com/basho-labs/riak_json/blob/master/docs/query.md)
+```ruby
+# All matching instances
+us_users = User.where({ country: 'USA' })   # => array of US user instances
+# One instance (the first)
+user = User.find_one({ username: 'HieronymusBosch' })
+```
+
+## Search Schema Definition
+RiakJson uses Solr/Yokozuna to provide indexing and search capability for its collections. 
+If you do not specify a collection schema explicitly, RiakJson creates one when you insert the first document to that collection 
+(it [infers the schema](https://github.com/basho-labs/riak_json/blob/master/docs/architecture.md#inferred-schemas) 
+based on the basic data types of the field values in the JSON).
+However, if you do not want to use this default schema behavior (for example, because RJ tries to index all of the fields), 
+you can define and set a collection schema yourself, using RJ Ruby Client's [schema administration](https://github.com/basho-labs/riak_json_ruby_client#schema-administration) 
+API.
+
+To make the process of schema definition even easier for developers, ActiveDocument provides the ```search_index``` attribute
+option. This annotation allows you to specify which document fields you want added to your search schema, as well as the 
+Solr field type that will be used to index it.
+
+For example, the following model:
+```ruby
+class User
+  include Riagent::ActiveDocument
+  
+  attribute :username, String, required: true, search_index: { :as => :text }
+  attribute :email, String, search_index: { :as => :string }
+  attribute :country, String, default: 'USA'
+end
+```
+will enable you to construct the following schema:
+```ruby
+User.schema   # =>
+#   [{
+#     :name => "username",
+#     :type => "text",
+#     :require => true
+#    }, {
+#     :name => "email",
+#     :type => "string",
+#     :require => false
+#    }
+# ]
+#   # Note that 'country' is not included in this schema, and so will not be indexed.
+```
+
+### Schema Administration
+Note that if you use the ```search_index``` attribute annotations above, you will have to explicitly 
+notify RiakJson of your intent to save the schema. You will have to call the ```set_schema()``` collection
+method before you start inserting documents (for example, in a ```db:setup``` Rake task).
+
+```ruby
+User.collection.set_schema(User.schema)
+```
+
+## Testing the Riagent gem
+First, set up the Riak config file for (and make sure it's pointing to a running Riak instance)
+
+```
+cp test/config/riak.yml.example test/config/riak.yml
+```
+
+To run the tests:
+
+```
+bundle exec rake test
+```

data/Rakefile

@@ -0,0 +1,47 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "bundler/gem_tasks"
+require "rake"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new :test do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+Rake::TestTask.new :itest do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/integration/*_test.rb'
+end
+
+Rake::TestTask.new :unittest do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/unit/*_test.rb'
+end
+
+namespace :db do
+  task :seed do
+    seed_file = File.join('test', 'seeds.rb')
+    load(seed_file) if File.exist?(seed_file)
+  end
+end

data/lib/rails/generators/riagent/install/install_generator.rb

@@ -0,0 +1,35 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 'rails/generators'
+
+module Riagent
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def create_config_file
+        template 'riak.yml', File.join('config', 'riak.yml')
+      end
+    end
+  end
+end

data/lib/rails/generators/riagent/install/templates/riak.yml

@@ -0,0 +1,16 @@
+# 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