riak_json 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4829b641aa58acf10a0b5f6b8bb465a2dda3ae7
-  data.tar.gz: bfe725495387a621908a165cac547cfc282bd0e2
+  metadata.gz: d41e9a70c0803cf7d5ff1c6b4002866fe6650b22
+  data.tar.gz: 907d211669ba6c4e9f20d83a60d72c0e5ce24170
 SHA512:
-  metadata.gz: 82ff9f6dc5beba9b516ec396c0ab1fb12604f3ad922d45d09db5c426016654c692b14197f7411748ef27e542570460905ed8fe34400ae4672c7fc5044a0f32b0
-  data.tar.gz: c17cd830fc7dc717b138f0621016afecfbc8e2eebeb22956163f1be4b79b9797c4cf24e8a259f1782b0b6da5026b77553de045a2a5517253817ba809cb2fddc7
+  metadata.gz: 3152be4a674d854a099b61887d021abf7f657663de4040500dbfdd48b90a20da5d11ade833042a2f107d1f8bcab54978298b381145f474ef9a0cbc8ee0dc09a9
+  data.tar.gz: 3643ab72d5f7b865e7c8405904e5387425f07f89fc4ecc0d683239f339b4c1d7e752c0e69ace4d4004c7e602d0e01fb47b871911d2267e17fa80ddb49df19c40

data/README.md

@@ -1,11 +1,19 @@
 # Riak Json Ruby Client
 
 A Ruby client for [Riak Json](https://github.com/basho-labs/riak_json/).
-For ActiveModel integration for RiakJson, see [riak_json-active_model](https://github.com/dmitrizagidulin/rj-activemodel) gem.
+For ActiveModel and Rails integration for RiakJson, see the [riagent](https://github.com/dmitrizagidulin/riagent) gem.
+
+For a sample Rails 4 application using RiakJson, see [Riak Threaded Forum](https://github.com/dmitrizagidulin/riak-threaded-forum)
+
+See also [](RELEASE_NOTES.md) for a version/feature log.
 
 ## Installation
-Since this gem is not released to the public yet, build it locally:
+To install from Ruby Gems:
+```
+gem install riak_json
+```
 
+To build locally, from source:
 ```bash
 git clone git@github.com:basho/riak_json_ruby_client.git
 cd riak_json_ruby_client
@@ -17,25 +25,36 @@ Use bundler to install dev dependencies:
 ```
 bundle install
 ```
-To run both unit and integration tests:
-```
-bundle exec rake test
-```
-Note: By default, integration tests assume that Riak is listening on ```127.0.0.1:8098```
-(the result of ```make rel```).
 
-To specify alternate host and port, use the ```RIAK_HOST``` and ```RIAK_PORT``` env variables:
-```
-RIAK_HOST=127.0.0.1 RIAK_PORT=10018 bundle exec rake
-```
-To run just the unit tests:
+To run just the unit tests (no db connection necessary):
 ```
 bundle exec rake unittest
 ```
+
+To run both unit and integration tests:
+
+1. Make sure Riak with RiakJson is up and running. Note: By default, integration tests assume that Riak 
+    is listening on ```127.0.0.1:8098``` (the result of ```make rel```).
+    To specify alternate host and port, use the ```RIAK_HOST``` and ```RIAK_PORT``` env variables:
+    ```
+    RIAK_HOST=127.0.0.1 RIAK_PORT=10018 bundle exec rake
+    ```
+    
+2. Seed the db (required for several of the integration tests)
+    ```
+    rake db:seed
+    ```
+    
+3. Run the tests:
+    ```
+    bundle exec rake test
+    ```
+
 To run just the integration tests:
 ```
 bundle exec rake itest
 ```
+
 ## Usage
 ### Loading the Client Config File
 ```ruby
@@ -64,12 +83,14 @@ collection = client.collection("cities")
 #   - text (spaces allowed)
 #   - multi_string (an array of strings, no spaces)
 #   - integer
+#   - geo (Solr 'location'/LatLonType type field)
 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)
+schema.add_geo_field('coordinates')
 
 # Store the schema
 collection.set_schema(schema)
@@ -96,6 +117,10 @@ schema_result = collection.get_schema()
 #      :type => "integer",
 #      :require => false
 #    }, {
+#      :name => "coordinates",
+#      :type => "geo",
+#      :require => false
+#    }, {
 #      :name => "country",
 #      :type => "string",
 #      :require => true
@@ -107,6 +132,15 @@ schema_result = collection.get_schema()
 collection.delete_schema
 ```
 
+### List All RiakJson Collections
+This returns an array of ```RiakJson::Collection``` instances. 
+Unlike the Riak 'List Buckets' call, this does not iterate through all of the keys, but gets the
+custom RJ collection types from the ring metadata.
+
+```ruby
+client.collections()
+```
+
 ### Reading and Writing Documents
 ```ruby
 # You can insert a document with no key

data/Rakefile

@@ -37,4 +37,11 @@ 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', 'seeds.rb')
+    load(seed_file) if File.exist?(seed_file)
+  end
 end

data/lib/riak_json/client.rb

@@ -61,6 +61,22 @@ module RiakJson
       self.collection_cache[name] ||= RiakJson::Collection.new(name, self)
     end
 
+    # List all of the RiakJson collections on the riak cluster
+    # This is different from a Riak 'list buckets' command. 
+    # Instead of iterating over all the keys on the cluster, 'list collections'
+    # only lists the custom RJ bucket types on the cluster (from the ring metadata)
+    # Raw JSON that's returned by RJ:
+    # 
+    # <code>{"collections":[{"name":"collection1"},{"name":"collection2"}]}</code>
+    # 
+    # This is then mapped to a list of RiakJsonCollection instances.
+    # @return [Array] List of +RiakJson::Collection+ instances that exist in the cluster.
+    def collections
+      result = self.transport.send_request("#{self.base_collection_url}", :get)
+      collection_list = JSON.parse(result)['collections']
+      collection_list.map { |ea| self.collection(ea['name'])}
+    end
+    
     def delete_json_object(collection_name, key)
       self.transport.send_request("#{self.base_collection_url}/#{collection_name}/#{key}", :delete)
     end

data/lib/riak_json/collection_schema.rb

@@ -34,6 +34,10 @@ module RiakJson
       self.fields << { name: field_name.to_s, type: field_type.to_s, require: required }
     end
     
+    def add_geo_field(field_name, required=false)
+      self.add_field(:geo, field_name, required)
+    end
+    
     def add_integer_field(field_name, required=false)
       self.add_field(:integer, field_name, required)
     end
@@ -55,7 +59,7 @@ module RiakJson
     end
     
     def self.valid_field_types
-      [:text, :string, :multi_string, :integer]
+      [:text, :string, :multi_string, :integer, :geo]
     end
   end
 end

data/lib/riak_json/version.rb

@@ -19,5 +19,5 @@
 ## -------------------------------------------------------------------
 
 module RiakJson
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/integration/client_integration_test.rb

@@ -48,4 +48,10 @@ describe "RiakJson Ruby Client" do
       lambda { rj_test_client.get_schema(collection_name) }.must_raise RestClient::ResourceNotFound  # 404
     end
   end
+  
+  it "can list all collections in the cluster" do
+    result = rj_test_client.collections()
+    result.wont_be_empty
+    result.first.must_be_kind_of RiakJson::Collection
+  end
 end

data/test/integration/collection_integration_test.rb

@@ -168,14 +168,9 @@ describe "a RiakJson Collection" do
     
     it "can delete (unset) a schema for a collection" do
       client = rj_test_client
+      # schema created via 'rake db:seed' (See test/seeds/seed.rb)
       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

data/test/seeds/seeds.rb

@@ -0,0 +1,32 @@
+## ------------------------------------------------------------------- 
+## 
+## 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'
+
+# Create a client pointed to test instance
+host = ENV['RIAK_HOST'] ? ENV['RIAK_HOST'] : RiakJson::RIAK_TEST_HOST
+port = ENV['RIAK_PORT'] ? ENV['RIAK_PORT'] : RiakJson::RIAK_TEST_PORT
+client = RiakJson::Client.new(host, port)
+
+# Ensure a collection has an existing schema for the Delete Schema test
+collection = client.collection('cities-delete-schema')
+schema = RiakJson::CollectionSchema.new
+schema.add_text_field(name='city', required=true)
+collection.set_schema(schema)

data/test/unit/collection_schema_test.rb

@@ -80,7 +80,7 @@ describe "a RiakJson Collection Schema" do
       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",
@@ -95,6 +95,20 @@ describe "a RiakJson Collection Schema" do
       schema.fields[0][:require].must_equal false
     end
     
+    it "can add a geo type field to the schema definition" do
+      # schema = [{
+      #    :name => "coordinates",
+      #    :type => "geo",
+      #    :require => false
+      # }]
+      schema = RiakJson::CollectionSchema.new
+      schema.add_geo_field(name='coordinates', required=false)
+      schema.fields.count.must_equal 1
+      schema.fields[0][:name].must_equal 'coordinates'
+      schema.fields[0][:type].must_equal 'geo'
+      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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak_json
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dmitri Zagidulin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -165,6 +165,7 @@ files:
 - test/helper.rb
 - test/integration/client_integration_test.rb
 - test/integration/collection_integration_test.rb
+- test/seeds/seeds.rb
 - test/unit/client_test.rb
 - test/unit/client_transport_test.rb
 - test/unit/collection_schema_test.rb
@@ -201,6 +202,7 @@ test_files:
 - test/helper.rb
 - test/integration/client_integration_test.rb
 - test/integration/collection_integration_test.rb
+- test/seeds/seeds.rb
 - test/unit/client_test.rb
 - test/unit/client_transport_test.rb
 - test/unit/collection_schema_test.rb