grendel-ruby 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copying Grendel-Ruby
+===============
+
+Grendel-Ruby is MIT licensed.
+
+Copyright © 2010 Wesabe, Inc.
+-----------------------------
+
+    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.md

@@ -0,0 +1,192 @@
+grendel-ruby
+============
+
+Ruby interface to the Grendel secure document storage service (http://github.com/wesabe/grendel). See the Grendel API documentation (http://github.com/wesabe/grendel/blob/master/API.md) for more information.
+
+Installation
+------------
+
+    sudo gem install grendel-ruby
+
+Examples
+--------
+
+The following examples assumes that you have the Grendel server running locally on port 8080.
+
+
+### Establishing a Connection
+
+    client = Grendel::Client.new("http://localhost:8080")
+
+
+### Listing Registered Users
+
+    client.users.list  # returns an array of Grendel::Users    
+
+
+### Creating A New User
+
+    user = client.users.create("alice", "s3kret")  # returns a Grendel::User with id "alice" and password "s3kret"
+    
+If the user `id` is taken, a `Grendel::HTTPException` will be thrown with a message containing `422 Unprocessable Entity` and an explanation.
+
+
+### Viewing A User
+
+    user = client.users.find("alice")  # returns a Grendel::User
+    
+    # return a Grendel::User with the password set to "s3kret". Note that this is merely a convenience
+    # method for future authenticated calls--it does not actually check that the password is correct.
+    user = client.users.find("alice", "s3kret")
+
+The returned `Grendel::User` will contain the following attributes:
+
+    id - user id
+    modified_at - DateTime
+    created_at - DateTime
+    keys - array of key fingerprints
+    
+If the user is not found, a `Grendel::HTTPException` will be thrown with a message containing `404 Not Found`
+
+
+### Changing A User's Password
+
+    user = client.users.find("alice", "s3kret")
+    user.change_password("new-pass")
+    
+
+### Deleting A User
+
+    user = client.users.find("alice", "s3kret")
+    user.delete
+
+
+### Listing A User's Documents
+
+    user = client.users.find("alice", "s3kret")
+    docs = user.documents.list  # returns an array of Grendel::Documents
+
+A `Grendel::Document` contains the following attributes:
+
+    - name
+    - data
+    - content_type
+    - uri
+
+
+### Viewing A User's Document
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.find("document1.txt")  # returns a Grendel::Document
+
+
+### Storing A User's Document
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.store("document1.txt", "i am a super secret")
+
+The content type can be specified as an optional third parameter. If not provided,
+it will be guessed from the file extension of the document name.
+
+    doc = user.documents.store("document1.txt", "i am a super secret", "text/plain")
+
+Note that this method will overwrite the document if it already exists in Grendel.
+
+
+### Deleting A User's Document
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.delete("document1.txt")
+    
+    # or
+    
+    doc = user.documents.find("document1.txt")
+    doc.delete
+
+
+## Linking Documents
+
+A Grendel document can be linked by its owner with other users. Doing so
+provides other users *read-only* access to the document.
+
+
+### Viewing A Document's Linked Users
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.find("document1.txt")
+    links = doc.links.list  # returns an array of Grendel::Links
+    
+A `Grendel::Link` contains the following attributes:
+
+    - document
+    - user # the user the document is linked to
+    - uri # the uri of the linked document
+
+
+### Linking Another User To A Document
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.find("document1.txt")
+    doc.links.add("bob")  # returns a Grendel::Link
+
+User `bob` will now have read-only access to the document.
+
+
+### Unlinking A User From A Document
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.documents.find("document1.txt")
+    doc.links.remove("bob")
+
+User `bob` will no longer have access to the document.
+
+
+## Managing Linked Documents
+
+The documents shared with a user are stored in their own namespace to avoid
+document name collisions. If the document's owner modifies the document, the
+linked users will see the changes. Likewise, if the document's owner deletes the
+document (or the owner is deleted), the documents will be removed from the
+user's linked documents.
+
+
+### Listing A User's Linked Documents
+
+
+    user = client.users.find("alice", "s3kret")
+    linked_docs = user.linked_documents  # returns an array of Grende::LinkedDocuments
+    
+A `Grendel::LinkedDocument` is a subclass of `Grendel::Document` with the following additional attribute:
+
+    - owner # the document owner as a Grendel::User
+
+
+### Viewing A Linked Document
+
+
+    user = client.users.find("alice", "s3kret")
+    doc = user.linked_documents.find("bob", "bobs_secrets.txt")
+    
+
+### Deleting A Linked Document
+
+    user = client.users.find("alice", "s3kret")
+    user.linked_documents.delete("bob", "bobs_secrets.txt")
+    
+    # or
+    
+    doc = user.linked_documents.find("bob", "bobs_secrets.txt")
+    doc.delete
+
+**This will *not* delete the document itself**, it will simply remove the
+document from the user's list of linked documents. It will also **not**
+re-encrypt the document; the next time the document is written to, however, the
+user will be excluded from the recipients.
+
+## Bugs and Issues
+
+Please submit them here [http://github.com/wesabe/grendel-ruby/issues](http://github.com/wesabe/grendel-ruby/issues)
+
+## Copyright
+
+Copyright 2010 Wesabe, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grendel-ruby"
+    gem.summary = %Q{Ruby interface to Wesabe's Grendel}
+    gem.description = %Q{Grendel is a RESTful web service which allows for the secure storage of users'
+    documents. Grendel-Ruby provides a Ruby API for Grendel.}
+    gem.email = "brad@wesabe.com"
+    gem.homepage = "http://github.com/wesabe/grendel-ruby"
+    gem.authors = ["Brad Greenlee"]
+    gem.add_dependency "json"
+    gem.add_dependency "httparty"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grendel-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.md

@@ -0,0 +1,8 @@
+To Do
+========================
+
+* Possible escaping issues with user and document names
+* ETag support
+* Yard/RDocs
+* Full example code
+* Support for adding documents directly from the file system?

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/grendel-ruby.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grendel-ruby}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Greenlee"]
+  s.date = %q{2010-02-24}
+  s.description = %q{Grendel is a RESTful web service which allows for the secure storage of users'
+    documents. Grendel-Ruby provides a Ruby API for Grendel.}
+  s.email = %q{brad@wesabe.com}
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE.md",
+     "README.md",
+     "Rakefile",
+     "TODO.md",
+     "VERSION",
+     "grendel-ruby.gemspec",
+     "lib/core_ext/hash.rb",
+     "lib/grendel.rb",
+     "lib/grendel/client.rb",
+     "lib/grendel/document.rb",
+     "lib/grendel/document_manager.rb",
+     "lib/grendel/link.rb",
+     "lib/grendel/link_manager.rb",
+     "lib/grendel/linked_document.rb",
+     "lib/grendel/linked_document_manager.rb",
+     "lib/grendel/user.rb",
+     "lib/grendel/user_manager.rb",
+     "spec/grendel/client_spec.rb",
+     "spec/grendel/document_manager_spec.rb",
+     "spec/grendel/document_spec.rb",
+     "spec/grendel/link_manager_spec.rb",
+     "spec/grendel/link_spec.rb",
+     "spec/grendel/linked_document_manager_spec.rb",
+     "spec/grendel/linked_document_spec.rb",
+     "spec/grendel/user_manager_spec.rb",
+     "spec/grendel/user_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/wesabe/grendel-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby interface to Wesabe's Grendel}
+  s.test_files = [
+    "spec/grendel/client_spec.rb",
+     "spec/grendel/document_manager_spec.rb",
+     "spec/grendel/document_spec.rb",
+     "spec/grendel/link_manager_spec.rb",
+     "spec/grendel/link_spec.rb",
+     "spec/grendel/linked_document_manager_spec.rb",
+     "spec/grendel/linked_document_spec.rb",
+     "spec/grendel/user_manager_spec.rb",
+     "spec/grendel/user_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/core_ext/hash.rb

@@ -0,0 +1,17 @@
+# stolen^H^H^H^H^H^Hborrowed from Rails' ActiveSupport
+class Hash
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+ 
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+.
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end

data/lib/grendel.rb

@@ -0,0 +1,16 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'core_ext/hash'
+require 'mime/types'
+require 'grendel/client'
+require 'grendel/user_manager'
+require 'grendel/user'
+require 'grendel/document_manager'
+require 'grendel/document'
+require 'grendel/link_manager'
+require 'grendel/link'
+require 'grendel/linked_document_manager'
+require 'grendel/linked_document'

data/lib/grendel/client.rb

@@ -0,0 +1,63 @@
+# Ruby interface to Wesabe's Grendel (http://github.com/wesabe/grendel)
+module Grendel
+  class Client
+    attr_accessor :debug, :debug_output
+    attr_reader :base_uri
+    
+    # Create a new Grendel client instance
+    def initialize(base_uri, options = {})
+      @base_uri = base_uri
+      @debug = options[:debug]
+      @debug_output = options[:debug_output] || $stderr
+    end
+    
+    def get(uri, options = {})
+      options.merge!(:debug_output => @debug_output) if @debug
+      response = HTTParty.get(@base_uri + uri, options)
+      raise HTTPException.new(response) if response.code >= 400
+      return response
+    end
+    
+    def post(uri, data = {}, options = {})
+      data = data.to_json unless options.delete(:raw_data)        
+      options.merge!(
+          :body => data,
+          :headers => {'Content-Type' => 'application/json'}
+      )
+      options.merge!(:debug_output => @debug_output) if @debug
+      response = HTTParty.post(@base_uri + uri, options)
+      raise HTTPException.new(response) if response.code >= 400
+      return response
+    end
+    
+    def put(uri, data = {}, options = {})
+      data = data.to_json unless options.delete(:raw_data)        
+      options = { 
+        :body => data,
+        :headers => {'Content-Type' => 'application/json'}
+      }.update(options)
+      options.merge!(:debug_output => @debug_output) if @debug
+      response = HTTParty.put(@base_uri + uri, options)
+      raise HTTPException.new(response) if response.code >= 400
+      return response
+    end
+    
+    def delete(uri, options = {})
+      options.merge!(:debug_output => @debug_output) if @debug
+      response = HTTParty.delete(@base_uri + uri, options)
+      raise HTTPException.new(response) if response.code >= 400
+    end
+  
+    def users
+      UserManager.new(self)
+    end
+    
+    class HTTPException < Exception
+      def initialize(response)
+        msg = "#{response.code} #{response.message}"
+        msg << "\n#{response.body}" unless response.body.blank?
+        super(msg)
+      end
+    end
+  end
+end