riakrest 0.0.1

data/spec/core/jiak_schema_spec.rb

@@ -0,0 +1,184 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "JiakSchema" do
+  before do
+    @allowed_fields = [:foo,:bar,:baz]
+    @required_fields = [:foo]
+    @read_mask = [:foo,:bar]
+    @write_mask = [:baz]
+    @hash = {
+      :allowed_fields => @allowed_fields,
+      :required_fields => @required_fields,
+      :read_mask => @read_mask,
+      :write_mask => @write_mask
+    }
+    @jiak_schema = JiakSchema.new(@hash)
+  end
+
+  it "should respond to" do
+    JiakSchema.should respond_to(:from_jiak)
+
+    @jiak_schema.should respond_to(:allowed_fields,:allowed_fields=)
+    @jiak_schema.should respond_to(:required_fields,:required_fields=)
+    @jiak_schema.should respond_to(:read_mask,:read_mask=)
+    @jiak_schema.should respond_to(:write_mask,:write_mask=)
+
+    @jiak_schema.should respond_to(:to_jiak)
+    @jiak_schema.should respond_to(:==,:eql?)
+  end
+
+  it "should create using defaults from allowed_fields" do
+    jiak_schema = JiakSchema.new({:allowed_fields => @allowed_fields})
+    jiak_schema.allowed_fields.should eql @allowed_fields
+    jiak_schema.required_fields.should eql []
+    jiak_schema.read_mask.should eql @allowed_fields
+    jiak_schema.write_mask.should eql @allowed_fields
+
+    jiak_schema = JiakSchema.new(@allowed_fields)
+    jiak_schema.allowed_fields.should eql @allowed_fields
+    jiak_schema.required_fields.should eql []
+    jiak_schema.read_mask.should eql @allowed_fields
+    jiak_schema.write_mask.should eql @allowed_fields
+
+    jiak_schema = JiakSchema.new({:allowed_fields => []})
+    jiak_schema.allowed_fields.should eql []
+    jiak_schema.required_fields.should eql []
+    jiak_schema.read_mask.should eql []
+    jiak_schema.write_mask.should eql []
+
+    jiak_schema = JiakSchema.new([])
+    jiak_schema.allowed_fields.should eql []
+    jiak_schema.required_fields.should eql []
+    jiak_schema.read_mask.should eql []
+    jiak_schema.write_mask.should eql []
+  end
+
+  it "should create using specified fields and masks" do
+    @jiak_schema.allowed_fields.should eql @allowed_fields
+    @jiak_schema.required_fields.should eql @required_fields
+    @jiak_schema.read_mask.should eql @read_mask
+    @jiak_schema.write_mask.should eql @write_mask
+  end
+
+  it "should create from a Hash" do
+    jiak_schema = JiakSchema.new(@hash)
+    jiak_schema.allowed_fields.should eql @allowed_fields
+    jiak_schema.required_fields.should eql @required_fields
+    jiak_schema.read_mask.should eql @read_mask
+    jiak_schema.write_mask.should eql @write_mask
+
+    hash = {:schema => @hash}
+    jiak_schema = JiakSchema.new(hash)
+    jiak_schema.should eql @jiak_schema
+    jiak_schema.should ==  @jiak_schema
+
+    @hash['allowed_fields'] = @hash[:allowed_fields]
+    @hash.delete(:allowed_fields)
+    @hash['read_mask'] = @hash[:read_mask]
+    @hash.delete(:read_mask)
+    jiak_schema = JiakSchema.new(@hash)
+    jiak_schema.allowed_fields.should eql @allowed_fields
+    jiak_schema.required_fields.should eql @required_fields
+    jiak_schema.read_mask.should eql @read_mask
+    jiak_schema.write_mask.should eql @write_mask
+  end
+
+  it "should create from json" do
+    schema = JiakSchema.from_jiak(JSON.parse(@hash.to_json))
+    @allowed_fields.same_fields?(schema.allowed_fields).should be true
+    @required_fields.same_fields?(schema.required_fields).should be true
+    @write_mask.same_fields?(schema.write_mask).should be true
+    @read_mask.same_fields?(schema.read_mask).should be true
+  end
+
+  it "should validate create options" do
+    hash = @hash.clone
+    hash.delete(:allowed_fields)
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/allowed_fields.*array/)
+
+    hash = @hash.clone
+    hash[:allowed_fields] = nil
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/allowed_fields.*array/)
+
+    hash[:allowed_fields] = 'a'
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/allowed_fields.*array/)
+
+    hash = @hash.clone
+    hash[:required_fields] = {}
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/required_fields.*array/)
+
+    hash = @hash.clone
+    hash[:read_mask] = [1]
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/read_mask.*strings/)
+
+    hash = @hash.clone
+    hash[:write_mask] = ['a','b',3]
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/write_mask.*strings/)
+
+    hash = @hash.clone
+    hash[:allowed_fields] << @allowed_fields[0].to_s
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/unique/)
+
+    hash = @hash.clone
+    hash[:allowed_fields] << @allowed_fields[0].to_sym
+    bad = lambda {JiakSchema.new(hash)}
+    bad.should raise_error(JiakSchemaException,/unique/)
+  end
+
+  it "should update with validation" do
+    arr = [:f1,'f2']
+    @jiak_schema.allowed_fields = arr
+    @jiak_schema.allowed_fields.should eql arr
+    @jiak_schema.required_fields = arr
+    @jiak_schema.required_fields.should eql arr
+    @jiak_schema.read_mask = arr
+    @jiak_schema.read_mask.should eql arr
+    @jiak_schema.write_mask = arr
+    @jiak_schema.write_mask.should eql arr
+
+    bad = lambda {@jiak_schema.allowed_fields = nil}
+    bad.should raise_error(JiakSchemaException,/allowed_fields.*array/)
+
+    bad = lambda {@jiak_schema.required_fields = 'a'}
+    bad.should raise_error(JiakSchemaException,/required_fields.*array/)
+
+    bad = lambda {@jiak_schema.read_mask = [:f,1]}
+    bad.should raise_error(JiakSchemaException,/read_mask.*symbol/)
+    
+    arr << :f1
+    bad = lambda {@jiak_schema.write_mask = arr}
+    bad.should raise_error(JiakSchemaException,/unique/)
+  end
+
+  it "should convert to json" do
+    @jiak_schema.to_jiak.should eql ({:schema => @hash}.to_json)
+  end
+
+  it "should equal an equal JiakSchema" do
+    jiak_schema = JiakSchema.new(@hash)
+    jiak_schema.should eql @jiak_schema
+
+    strings = JiakSchema.new(['a','bb','CcC'])
+    symbols = JiakSchema.new([:a,:bb,:CcC])
+    strings.should eql symbols
+    symbols.should eql strings
+
+    strings = JiakSchema.new(['a','bb','CcC','d'])
+    symbols = JiakSchema.new([:a,:bb,:CcC])
+    strings.should_not eql symbols
+    symbols.should_not eql strings
+
+    strings = JiakSchema.new(['a','bb','CC'])
+    symbols = JiakSchema.new([:a,:bb,:CcC])
+    strings.should_not eql symbols
+    symbols.should_not eql strings
+  end
+
+end

data/spec/core/query_link_spec.rb

@@ -0,0 +1,128 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "QueryLink" do
+  before do
+    @bucket = 'b'
+    @tag = 't'
+    @acc = 'a'
+    @any = QueryLink::ANY
+    @query_link = QueryLink.new(@bucket,@tag,@acc)
+    @array = [@bucket,@tag,@acc]
+    @query_link_any = QueryLink.new
+  end
+
+  it "should respond to" do
+    @query_link.should respond_to(:bucket,:tag,:acc)
+    @query_link.should respond_to(:bucket=,:tag=,:acc=)
+
+    @query_link.should respond_to(:for_uri)
+
+    @query_link.should respond_to(:eql?,:==)
+  end
+
+  it "should init from specified values" do
+    @query_link.bucket.should eql @bucket
+    @query_link.tag.should eql @tag
+    @query_link.acc.should eql @acc
+
+    query_link = QueryLink.new([@bucket,@tag,@acc])
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @acc
+
+    query_link = QueryLink.new(@query_link)
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @acc
+  end
+
+  it "should fill in missing args with ANY" do
+    query_link = QueryLink.new(@bucket,@tag)
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @any
+
+    query_link = QueryLink.new(@bucket)
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @any
+    query_link.acc.should eql @any
+
+    query_link = QueryLink.new
+    query_link.bucket.should eql @any
+    query_link.tag.should eql @any
+    query_link.acc.should eql @any
+
+    query_link = QueryLink.new([@bucket,@tag])
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @any
+    
+    query_link = QueryLink.new([@bucket])
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @any
+    query_link.acc.should eql @any
+
+    query_link = QueryLink.new []
+    query_link.bucket.should eql @any
+    query_link.tag.should eql @any
+    query_link.acc.should eql @any
+  end
+
+  it "should ignore leading/trailing spaces for opts on init" do
+    bucket = " "+@bucket+" "
+    tag = " "+@tag+" "
+    acc = " "+@acc+" "
+    query_link = QueryLink.new([bucket,tag,acc])
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @acc
+  end
+  
+  it "should treat blank, empty strings, or nil as ANY on init" do
+    jiak_any_link = QueryLink.new
+
+    ["","  ",nil].each do |val|
+      query_link = QueryLink.new([val,val,val])
+      query_link.should eql jiak_any_link
+      query_link.should == jiak_any_link
+    end
+  end
+
+  it "should init from an array" do
+    query_link = QueryLink.new(@array)
+    query_link.bucket.should eql @bucket
+    query_link.tag.should eql @tag
+    query_link.acc.should eql @acc
+  end
+
+  it "should allow field updates" do
+    @query_link.bucket = 'new_bucket'
+    @query_link.bucket.should eql 'new_bucket'
+    @query_link.tag = 'new_tag'
+    @query_link.tag.should eql 'new_tag'
+    @query_link.acc = 'new_acc'
+    @query_link.acc.should eql 'new_acc'
+  end
+
+  it "should convert to a suitable URI string" do
+    @query_link.for_uri.should eql @bucket+','+@tag+','+@acc
+
+    b = 's p a c e'
+    t = '<%>'
+    a = '\\'
+    query_link = QueryLink.new([b,t,a])
+    query_link.for_uri.should eql URI.encode([b,t,a].join(','))
+  end
+
+  it "should compare to another QueryLink via eql?" do
+    query_link_1 = QueryLink.new(['a','b','c'])
+    query_link_2 = QueryLink.new(['a','b','c'])
+    query_link_3 = QueryLink.new(['a','','c'])
+    
+    query_link_1.should eql query_link_2
+    query_link_1.should_not eql query_link_3
+
+    query_link_1.should == query_link_2
+    query_link_1.should_not == query_link_3
+  end
+end

data/spec/data/jiak_data_hash_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "JiakDataHash" do
+  Person = JiakDataHash.create(:name, :age)
+
+  before do
+  end
+
+  it "should create a fully usable JiakData class" do
+    Person.schema.should respond_to(:allowed_fields,:required_fields,
+                                    :read_mask,:write_mask)
+  end
+
+end

data/spec/resource/jiak_resource_spec.rb

@@ -0,0 +1,128 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "JiakResource" do
+  F1F2 = JiakDataHash.create(:f1,:f2)
+  class Rsrc
+    include JiakResource
+    server       'http://localhost:8002/jiak'
+    group        'group'
+    data_class   F1F2
+  end
+
+  before do
+    @server = 'http://localhost:8002/jiak'
+    @group = 'group'
+    @data_class = F1F2
+  end
+
+  describe "class" do
+    it "should respond to" do
+      Rsrc.should respond_to(:server,:group,:data_class)
+      Rsrc.should respond_to(:params,:auto_update,:schema,:keys)
+      Rsrc.should respond_to(:allowed,:required,:readable,:writable,:readwrite)
+      Rsrc.should respond_to(:point_of_view,:pov,:point_of_view?,:pov?)
+      Rsrc.should respond_to(:post,:put,:get,:delete)
+      Rsrc.should respond_to(:refresh,:update)
+      Rsrc.should respond_to(:link,:bi_link,:walk)
+      Rsrc.should respond_to(:new,:copy)
+      Rsrc.should respond_to(:auto_post,:auto_update,:auto_post?,:auto_update?)
+
+      Rsrc.jiak.should respond_to(:server,:uri,:group,:data,:bucket,:auto_update)
+                                  
+                                  
+    end
+    
+    it "shoud have settings from creation" do
+      Rsrc.params.should be_empty
+      Rsrc.auto_update?.should be false
+      Rsrc.schema.should eql F1F2.schema
+      
+      Rsrc.jiak.should be_a Struct
+      Rsrc.jiak.server.should be_a JiakClient
+      Rsrc.jiak.uri.should eql @server
+      Rsrc.jiak.group.should eql @group
+      Rsrc.jiak.data.should include JiakData
+      Rsrc.jiak.data.should == F1F2
+      Rsrc.jiak.bucket.should be_a JiakBucket
+      Rsrc.jiak.bucket.name.should eql @group
+      Rsrc.jiak.bucket.data_class.should == F1F2
+      Rsrc.jiak.auto_update.should be false
+    end
+  end
+
+  describe "instance" do
+    before do
+      @rsrc = Rsrc.new
+    end
+
+    it "should respond to" do
+      @rsrc.should respond_to(:jiak,:jiak=)
+      @rsrc.should respond_to(:auto_update=,:auto_update?)
+      @rsrc.should respond_to(:post,:put,:update,:refresh,:delete)
+      @rsrc.should respond_to(:link,:bi_link,:walk)
+      @rsrc.should respond_to(:eql?,:==)
+    end
+    
+    it "should have default settings" do
+      @rsrc.jiak.should be_a Struct
+      @rsrc.jiak.should respond_to(:obj,:auto_update)
+      
+      @rsrc.jiak.obj.should be_a JiakObject
+      @rsrc.jiak.obj.bucket.should be_a JiakBucket
+      @rsrc.jiak.obj.bucket.name.should eql @group
+      @rsrc.jiak.obj.bucket.data_class.should == F1F2
+      
+      @rsrc.jiak.auto_update.should be_nil
+    end
+  end
+end
+
+describe "JiakResource default class-level auto-post" do
+  PersonData = JiakDataHash.create(:name,:age)
+  PersonData.keygen :name
+  class Person
+    include JiakResource
+    server       'http://localhost:8002/jiak'
+    group        'people'
+    data_class   PersonData
+  end
+
+  it "should create instance without posting" do
+    Person.auto_post?.should be false
+
+    name = 'p'
+    p = Person.new(:name => name, :age => 10)
+
+    no_rsrc = lambda {Person.get(name)}
+    no_rsrc.should raise_error(JiakResourceNotFound)
+
+    p.post
+    Person.get(name).name.should eql p.name
+
+    p.delete
+  end
+end
+
+describe "JiakResource class-level auto-post true" do
+  PersonData = JiakDataHash.create(:name,:age)
+  PersonData.keygen :name
+  class Person
+    include JiakResource
+    server       'http://localhost:8002/jiak'
+    group        'people'
+    data_class   PersonData
+    auto_post    true
+  end
+
+  it "should auto-post a new instance" do
+    Person.auto_post?.should be true
+    
+    name = 'P'
+    p = Person.new(:name => name, :age => 10)
+    Person.get(name).name.should eql name
+    p.delete
+  end
+end
+
+
+# CxINC Many, many more tests to go

data/spec/riakrest_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RiakRest" do
+  it "should declare a version" do
+    RiakRest::VERSION.should_not be nil
+  end
+end
+
+
+
+
+
+
+  
+
+
+

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'riakrest'
+include RiakRest

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+# desc "Run the specs under spec/models"
+# Spec::Rake::SpecTask.new do |t|
+#   t.spec_opts = ['--options', "spec/spec.opts"]
+#   t.spec_files = FileList['spec/**/*_spec.rb']
+# end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: riakrest
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  RiakRest provides structured, RESTful interaction with a Riak document
+  store. In Riak parlance, this JSON data exchange is called Jiak. RiakRest
+  provides two levels of interaction: Core Client and Resource. Core Client
+  interaction works down at the Jiak level and exposes Jiak internals. Resource
+  interaction is an abstraction built on top of the Core Client.
+email: 
+- paul@dingosky.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- examples/auto_update_data.rb
+- examples/auto_update_links.rb
+- examples/basic_client.rb
+- examples/basic_resource.rb
+- examples/json_data_resource.rb
+- examples/linked_resource.rb
+- examples/multiple_resources.rb
+- lib/riakrest.rb
+- lib/riakrest/core/exceptions.rb
+- lib/riakrest/core/jiak_bucket.rb
+- lib/riakrest/core/jiak_client.rb
+- lib/riakrest/core/jiak_data.rb
+- lib/riakrest/core/jiak_link.rb
+- lib/riakrest/core/jiak_object.rb
+- lib/riakrest/core/jiak_schema.rb
+- lib/riakrest/core/query_link.rb
+- lib/riakrest/data/jiak_data_hash.rb
+- lib/riakrest/resource/jiak_resource.rb
+- lib/riakrest/version.rb
+- riakrest.gemspec
+- script/console
+- script/destroy
+- script/generate
+- spec/core/exceptions_spec.rb
+- spec/core/jiak_bucket_spec.rb
+- spec/core/jiak_client_spec.rb
+- spec/core/jiak_link_spec.rb
+- spec/core/jiak_object_spec.rb
+- spec/core/jiak_schema_spec.rb
+- spec/core/query_link_spec.rb
+- spec/data/jiak_data_hash_spec.rb
+- spec/resource/jiak_resource_spec.rb
+- spec/riakrest_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/wcpr/riakrest
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: riakrest
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: RiakRest provides structured, RESTful interaction with a Riak document store
+test_files: []
+