persevere 0.17.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 Montana State University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,85 @@
+= dm-persevere-adapter
+
+A DataMapper adapter for Persevere (http://www.persvr.org/)
+
+This requires the persevere gem (http://github.com/irjudson/persevere) which provides a ruby interface to Persevere.
+
+== Usage
+
+DM Persevere Adapter is very simple and very similar to the REST
+Adapter, however it has two differences: 1) instead of XML it uses
+JSON, and 2) Persevere supports typing using JSON Schema. These
+differences make it valuable to have a separate DM adapter
+specifically for Persevere so it can leverage richer aspects of
+persevere.
+
+The setup and resource mapping is identical to standard datamapper
+objects, as can be seen below.
+
+DataMapper.setup(:default, {
+                   :adapter => 'persevere',
+                   :host => 'localhost',
+                   :port => '8080'
+                 })
+
+class MyUser
+  include DataMapper::Resource
+
+  property :id,            Serial
+  property :uuid,          String
+  property :name,          String
+  property :first_name,    String
+  property :last_name,     String
+  property :groupid,       Integer
+  property :userid,        Integer
+  property :username,      String
+  property :homedirectory, String
+
+end
+
+To use with Rails, you can put this in your environment.rb:
+  config.gem "dm-core"
+  config.gem "data_objects"
+  config.gem "dm-persevere-adapter", :lib => 'persevere_adapter'
+
+With a database.yml:
+
+development: &defaults
+  :adapter: persevere
+  :host: localhost
+  :port: 8080
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+
+== Code
+
+# Create
+user = MyUser.new(:username => "dmtest", :uuid => UUID.random_create().to_s,
+                  :name => "DataMapper Test", :homedirectory => "/home/dmtest",
+                  :first_name => "DataMapperTest", :last_name => "User",
+                  :userid => 3, :groupid => 500)
+user.save
+
+# Retrieve
+user = MyUser.first(:netid => 'dmtest')
+puts user
+
+# Modify
+if user.update_attributes(:name => 'DM Test')
+  puts user
+else
+  puts "Failed to update attributes."
+end
+
+# Delete
+result = user.destroy
+puts "Result: #{result}"
+
+== To Do:
+
+- Make a do-adapter for persevere.
+- Cleanup Documentation

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'pathname'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = %q{dm-persevere-adapter}
+    gemspec.summary = %q{A DataMapper Adapter for persevere}
+    gemspec.description = %q{A DataMapper Adapter for persevere}
+    gemspec.email = ["irjudson [a] gmail [d] com"]
+    gemspec.homepage = %q{http://github.com/yogo/dm-persevere-adapter}
+    gemspec.authors = ["Ivan R. Judson", "The Yogo Data Management Development Team" ]
+    gemspec.rdoc_options = ["--main", "README.txt"]
+    gemspec.add_dependency(%q<dm-core>, [">= 0.10.1"])
+    gemspec.add_dependency(%q<extlib>)
+  end
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = %q{persevere}
+    gemspec.summary = %q{A ruby wrapper for persevere}
+    gemspec.description = %q{A ruby wrapper for persevere}
+    gemspec.email = ["irjudson [a] gmail [d] com"]
+    gemspec.homepage = %q{http://github.com/yogo/persevere}
+    gemspec.authors = ["Ivan R. Judson", "The Yogo Data Management Development Team" ]
+    gemspec.rdoc_options = ["--main", "persevere/README.txt"]
+    gemspec.files = ["LICENSE.txt", "persevere/History.txt", "persevere/README.txt", "Rakefile", "lib/persevere.rb"]
+    gemspec.test_files = ["spec/persevere_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Pathname.glob(ROOT.join('tasks/**/*.rb').to_s).each { |f| require f }

data/lib/persevere.rb

@@ -0,0 +1,106 @@
+#
+#  Yogo Data Management Toolkit : Persevere Wrapper
+#  (c) 2008-2009 Montana State University
+#  Ivan R. Judson
+#
+# This provides a relatively simple interface to access the Persevere
+# JSON data store. More information about Persevere can be found here:
+# http://www.persvr.org/
+#
+require 'net/http'
+require 'uri'
+
+require 'rubygems'
+require 'json'
+
+class PersevereResult
+  attr_reader :location, :code, :message, :body
+
+  def PersevereResult.make(response)
+    return PersevereResult.new(response["Location"], response.code,
+                               response.msg, response.body)
+  end
+
+  def initialize(location, code, message, body)
+    @location = location
+    @code = code
+    @message = message
+    @body = body
+  end
+
+  def to_s
+    super + " < Location: #{ @location } Code: #{ @code } Message: #{ @message } >"
+  end
+end
+
+class Persevere
+  VERSION = '1.1'
+  HEADERS = { 'Accept' => 'application/json',
+              'Content-Type' => 'application/json'
+            }
+
+  attr_accessor :server_url, :pservr
+
+
+  def initialize(url)
+    @server_url = url
+    server = URI.parse(@server_url)
+    @persevere = Net::HTTP.new(server.host, server.port)
+  end
+
+  # Pass in a resource hash
+  def create(path, resource)
+    json_blob = resource.to_json
+    response = nil
+    while response.nil?
+      begin
+        response = @persevere.send_request('POST', path, json_blob, HEADERS)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        puts "Persevere Create Failed: #{e}, Trying again."
+      end
+    end
+    return PersevereResult.make(response)
+  end
+
+  def retrieve(path)
+    response = nil
+    while response.nil?
+      begin
+        response = @persevere.send_request('GET', path, nil, HEADERS)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        puts "Persevere Create Failed: #{e}, Trying again."
+      end
+    end
+    return PersevereResult.make(response)
+  end
+
+  def update(path, resource)
+    json_blob = resource.to_json
+#    puts "JSON to PERSEVERE: #{json_blob}"
+    response = nil
+    while response.nil?
+      begin
+        response = @persevere.send_request('PUT', path, json_blob, HEADERS)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        puts "Persevere Create Failed: #{e}, Trying again."
+      end
+    end
+    return PersevereResult.make(response)
+  end
+
+  def delete(path)
+    response = nil
+    while response.nil?
+      begin
+        response = @persevere.send_request('DELETE', path, nil, HEADERS)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        puts "Persevere Create Failed: #{e}, Trying again."
+      end
+    end
+    return PersevereResult.make(response)
+  end
+end # class Persevere

data/persevere/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-02-19
+
+* 1 major enhancement
+
+  * Birthday!
+

data/persevere/README.txt

@@ -0,0 +1,90 @@
+= ruby persevere client
+
+* http://github.com/irjudson/persevere
+
+== DESCRIPTION:
+
+This gem provides a simple ruby wrapper around the persevere JSON document data store available from http://www.persvr.org.
+
+== FEATURES/PROBLEMS:
+
+Currently this provides a very simple RESTful interface to persevere. Data to be stored in persevere should be sent as hashes. To make this more robust it should provide some schema/table support, plus validate data against the schema/table. This exists in persevere, but is not exposed by this wrapper.
+
+== SYNOPSIS:
+
+#!/usr/bin/env ruby
+#
+require 'persevere'
+
+#
+# Create an object to interact with Persevere
+#
+p = Persevere.new('http://localhost:8080')
+
+#
+# Test POST to create a new class
+#
+print "\nTesting POST..."
+tstObj = { 'id' => 'tstObj', 'extends' => { '$ref' => 'Object' } }
+result = p.create('/Class/', tstObj)
+print "Response:\n"
+puts result
+
+#
+# Test GET to retrieve the list of classes from Persvr
+#
+print "\nTesting GET..."
+result = p.retrieve('/Class')
+print "Response:\n"
+puts result
+
+#
+# Test PUT to modify an existing class
+#
+print "\nTesting PUT..."
+tstObj['tstAttribute'] = 42
+result = p.update('/Class/tstObj', tstObj)
+print "Response:\n"
+puts result
+
+#
+# Test DELETE to remove the previously created and modified class
+#
+print "\nTesting DELETE..."
+result = p.delete('/Class/tstObj')
+print "Response:\n"
+puts result
+
+== REQUIREMENTS:
+
+* Persevere installed somewhere
+* JSON gem
+
+== INSTALL:
+
+sudo gem install persevere
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Montana State University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/persevere_spec.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/persevere'
+
+describe Persevere do
+  #
+  # Create an object to interact with Persevere
+  #
+  before :all do
+    @p = Persevere.new('http://localhost:8080')
+
+    @blobObj = {
+      'id' => 'Yogo',
+      'properties' => {
+        'cid' => {'type' => 'string' },
+        'parent' => { 'type' => 'string'},
+        'data' => { 'type' => 'string'}
+      }
+    }
+    
+    @corruptObj = {
+      'id' => 'Corrupt',
+      'properties' => {
+        'id' => 1234,
+        'parent' => { 'type' => 'string'},
+        'data' => { 'type' => 'string'}
+      }
+    }
+    
+    @mockObj = {
+      'id' => 'Yogo',
+      'properties' => {
+        'cid' => {'type' => 'string' },
+        'parent' => { 'type' => 'string'},
+        'data' => { 'type' => 'string'}
+      },
+      'prototype' => {}
+    }
+  end
+  
+  #
+  # Test POST to create a new class
+  #
+  describe '#post' do
+    it 'should create a new object in persevere' do
+      result = @p.create('/Class/', @blobObj)
+      result.code.should == "201"
+      JSON.parse(result.body).should == @mockObj
+    end
+    
+    it 'should not allow posting with a bad object' do
+      result = @p.create('/Class/', @corruptObj)
+      result.code.should == "500"
+      result.body.should == "\"Can not modify queries\""
+    end
+    
+    it 'should not allow posting to an existing object/id/path' do
+      result = @p.create('/Class/', @blobObj)
+      result.code.should == "201"
+      JSON.parse(result.body).should == @blobObj
+#      result.body.should == "\"Can not modify queries\""
+      # This shouldn't be a 201, it should say something mean.
+    end
+  end
+
+  #
+  # Test GET to retrieve the list of classes from Persvr
+  #
+  describe '#get' do
+    it 'should retrieve the previously created object from persevere' do
+      result = @p.retrieve('/Class/Yogo')
+      result.code.should == "200"
+      JSON.parse(result.body).should == @blobObj
+    end
+    
+    it 'should 404 on a non-existent object' do
+      result = @p.retrieve('/Class/NotThere')
+      result.code.should == "404"
+      result.message.should == "Not Found"
+    end
+  end
+
+  #
+  # Test PUT to modify an existing class
+  #
+  describe '#put' do
+    it 'should modify the previously created object in persevere' do
+      @blobObj['properties']['tstAttribute'] = { 'type' => 'string' }
+      result = @p.update('/Class/Yogo', @blobObj)
+      result.code.should == "200"
+      JSON.parse(result.body).should == @blobObj
+    end
+    
+    it 'should fail to modify a non-existent item' do
+      result = @p.update('/Class/NotThere', @blobObj)
+      result.code.should == "500"
+      result.body.should == "\"id does not match location\""
+      # This should be a 404 and not throw a persevere server exception
+    end
+  end
+
+  #
+  # Test DELETE to remove the previously created and modified class
+  #
+  describe '#delete' do
+    it 'should remove the previously created and modified object from persevere' do
+      result = @p.delete('/Class/Yogo')
+      result.code.should == "204"
+      @p.retrieve('/Class/Yogo').code.should == "404"
+    end
+    
+    it 'should fail to delete a non-existent item' do
+      result = @p.delete('/Class/NotThere')
+      result.code.should == "204"
+      result.message.should == "No Content"
+      result.body.should be_nil
+      # This should be a 404 and not fail silently with a 204
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# require 'pathname'
+# require 'rubygems'
+#require 'spec'
+
+# DataMapper.setup(:default, {
+#                             :adapter => 'persevere',
+#                             :host => 'localhost',
+#                             :port => '8080',
+#                             :uri => 'http://localhost:8080'
+#                            })
+
+#
+# I need to make the Book class for Books to relate to
+#

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: persevere
+version: !ruby/object:Gem::Version 
+  version: 0.17.0
+platform: ruby
+authors: 
+  - Ivan R. Judson
+  - The Yogo Data Management Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A ruby wrapper for persevere
+email: 
+  - irjudson [a] gmail [d] com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.txt
+files: 
+  - LICENSE.txt
+  - Rakefile
+  - lib/persevere.rb
+  - persevere/History.txt
+  - persevere/README.txt
+  - README.txt
+has_rdoc: true
+homepage: http://github.com/yogo/persevere
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - persevere/README.txt
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for persevere
+test_files: 
+  - spec/persevere_spec.rb
+  - spec/spec.opts
+  - spec/spec_helper.rb