grendel-ruby 0.1.1

data/spec/grendel/link_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Grendel::Link" do
+  # before do
+  #   @client = Grendel::Client.new("http://grendel")
+  #   @user_id = "alice"
+  #   @password = "s3kret"
+  #   @user = Grendel::User.new(@client, :id => @user_id, :password => @password)
+  #   @document = Grendel::Document.new(@user, :name => "document1.txt")
+  #   @uri = "#{@user_id}:#{@password}@grendel/users/#{@user_id}/documents/#{@document.name}/links"
+  # end
+end

data/spec/grendel/linked_document_manager_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+# - get a list of documents a user has linked to them
+# docs = user.linked_documents.list
+# - retrieve a linked document
+# doc = user.linked_documents.find("owner_user_id", "document.txt")
+# - delete a linked document
+# user.linked_documents.delete("owner_user_id", "document.txt")
+
+describe "Grendel::LinkedDocumentManager" do
+  before do
+    @client = Grendel::Client.new("http://grendel")
+    @user_id = "alice"
+    @password = "s3kret"
+    @user = Grendel::User.new(@client, :id => @user_id, :password => @password)
+    @document = Grendel::Document.new(@user, :name => "document1.txt")
+    @base_uri = "#{@user_id}:#{@password}@grendel/users/#{@user_id}/linked-documents"
+  end
+
+  describe "list" do
+    before do
+      stub_json_request(:get, @base_uri, %{{
+        "linked-documents":[
+          {
+            "name":"document1.txt",
+            "uri":"http://grendel/users/alice/linked-documents/bob/document1.txt",
+            "owner":{
+              "id": "bob",
+              "uri": "http://grendel/users/bob"
+            }
+          },
+          {
+            "name":"document2.txt",
+            "uri":"http://grendel/users/alice/linked-documents/carol/document2.txt",
+            "owner":{
+              "id": "carol",
+              "uri": "http://grendel/users/carol"
+            }
+          }
+          
+        ]
+      }})
+    end
+    
+    it "should return an array of all linked documents" do
+      docs = @user.linked_documents.list
+      docs.length.should == 2
+      docs[0].name.should == "document1.txt"
+      docs[0].uri.should == "/users/alice/linked-documents/bob/document1.txt"
+      docs[0].owner.id.should == "bob"
+      docs[0].owner.uri.should == "/users/bob"
+      docs[1].name.should == "document2.txt"
+      docs[1].uri.should == "/users/alice/linked-documents/carol/document2.txt"
+      docs[1].owner.id.should == "carol"
+      docs[1].owner.uri.should == "/users/carol"
+    end
+  end
+  
+  describe "find" do
+    before do
+      stub_json_request(:get, @base_uri + "/bob/document1.txt", "yay for me", :content_type => "text/plain")
+      stub_json_request(:get, @base_uri + "/carol/notfound.txt", "", :status => "404 Not Found")
+    end
+    
+    it "should return the document" do
+      doc = @user.linked_documents.find("bob", "document1.txt")
+      doc.name.should == "document1.txt"
+      doc.content_type.should == "text/plain"
+      doc.data.should == "yay for me"
+      doc.owner.id.should == "bob"
+    end
+    
+    it "should raise an exception if the document is not found" do
+      lambda {
+        @user.linked_documents.find("carol", "notfound.txt")
+      }.should raise_error(Grendel::Client::HTTPException) {|error| error.message.should match("404")} # change to should == "404 Not Found" once WebMock supports status messages
+    end
+  end
+  
+  describe "delete" do
+    before do
+      stub_json_request(:delete, @base_uri + "/bob/document.txt", "", :status => "204 No Content")
+      @linked_document = Grendel::LinkedDocument.new(@user, :name => "document.txt", :owner => {:id => "bob"})
+    end
+
+    it "should send a properly-formatted request" do
+      @user.linked_documents.delete("bob", "document.txt")
+      request(:delete, @base_uri + "/bob/document.txt").should have_been_made.once
+    end
+  end
+end

data/spec/grendel/linked_document_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Grendel::LinkedDocument" do
+  before do
+    @client = Grendel::Client.new("http://grendel")
+    @user_id = "alice"
+    @password = "s3kret"
+    @user = Grendel::User.new(@client, :id => @user_id, :password => @password)
+    @base_uri = "#{@user_id}:#{@password}@grendel/users/#{@user_id}/linked-documents"
+  end
+
+  describe "delete" do
+    before do
+      stub_json_request(:delete, @base_uri + "/bob/document.txt", "", :status => "204 No Content")
+      @linked_document = Grendel::LinkedDocument.new(@user, :name => "document.txt", :owner => {:id => "bob"})
+    end
+
+    it "should send a properly-formatted request" do
+      @linked_document.delete
+      request(:delete, @base_uri + "/bob/document.txt").should have_been_made.once
+    end
+  end
+end

data/spec/grendel/user_manager_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Grendel::User" do
+  before do
+    @client = Grendel::Client.new("http://grendel")
+  end
+  
+  describe "list" do
+    before do
+      stub_json_request(:get, "grendel/users", %{{
+        "users":[
+          {"id":"alice", "uri":"http://grendel/users/alice"},
+          {"id":"bob",   "uri":"http://grendel/users/bob"}          
+        ]
+      }})
+    end
+    
+    it "should return an array of all users" do
+      users = @client.users.list
+      users.length.should == 2
+      users[0].id.should == "alice"
+      users[0].uri.should == "/users/alice"
+      users[1].id.should == "bob"
+      users[1].uri.should ==  "/users/bob"
+    end
+  end
+
+  describe "find" do
+    before do
+      stub_json_request(:get, "grendel/users/alice", %{{
+        "id":"alice",
+        "modified-at":"20091227T211121Z",
+        "created-at":"20091227T211120Z",
+        "keys":['2048-RSA/0A895A19', '2048-RSA/39D1621B']
+      }})
+      stub_json_request(:get, "grendel/users/nobody", "", :status => "404 Not Found")
+    end
+    
+    it "should return the user" do
+      user = @client.users.find("alice")
+      user.id.should == "alice"
+      user.modified_at.should == DateTime.parse("20091227T211121Z")
+      user.created_at.should == DateTime.parse("20091227T211120Z")
+      user.keys.length.should == 2
+    end
+    
+    it "should raise an exception if the user is not found" do
+      lambda {
+        @client.users.find("nobody")
+      }.should raise_error(Grendel::Client::HTTPException) {|error| error.message.should match("404")} # change to should == "404 Not Found" once WebMock supports status messages
+    end
+  end
+  
+  describe "create" do
+    describe "a successful request" do
+      before do
+        @user_id = "bob"
+        @password = "s3kret"
+        @uri = "http://grendel/users/#{@user_id}"
+        stub_json_request(:post, "grendel/users", "", :status => "201 Created", "Location" => @uri)
+      end
+    
+      it "should send a properly-formatted request" do
+        @client.users.create(@user_id, @password)
+        params = { :id => @user_id, :password => @password }
+        request(:post, "grendel/users").with(:body => params.to_json).should have_been_made.once
+      end
+    
+      it "should return a user" do
+        user = @client.users.create(@user_id, @password)
+        user.id.should == @user_id
+        user.password.should == @password
+        user.uri.should == "/users/bob"
+      end
+    end
+    
+    describe "an unsuccessful request" do
+      before do
+        stub_json_request(:post, "grendel/users", "", :status => "422 Unprocessable Entity")
+      end
+      
+      it "should raise an exception if the user already exists" do
+        lambda {
+          @client.users.create("joe","exists")
+        }.should raise_error(Grendel::Client::HTTPException) {|error| error.message.should match("422")}
+      end
+    end
+  end
+end

data/spec/grendel/user_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Grendel::User" do
+  before do
+    @client = Grendel::Client.new("http://grendel")
+  end
+  
+  describe "new" do
+    it "should strip the protocol and host from the uri" do
+      user = Grendel::User.new(@client, :id => "alice", :uri => "http://grendel/users/alice")
+      user.uri.should == "/users/alice"
+    end
+  end
+    
+  describe "change_password" do
+    before do
+      @old_password = "s3kret"
+      @new_password = "newpass"
+      @user = Grendel::User.new(@client, :id => "alice", :password => @old_password)
+      @url = "#{@user.id}:#{@user.password}@grendel/users/#{@user.id}"
+      stub_json_request(:put, @url, "", :status => "204 No Content")
+    end
+    
+    it "should send a properly-formatted request" do
+      @user.change_password(@new_password)
+      params = { "password" => @new_password }
+      request(:put, @url).with(:body => params.to_json).should have_been_made.once
+    end
+    
+    it "should return a User with the new password" do
+      lambda {
+        @user.change_password(@new_password)
+      }.should change(@user, :password).from(@old_password).to(@new_password)
+    end
+  end
+  
+  describe "delete" do
+    before do
+      @user = Grendel::User.new(@client, :id => "alice", :password => "s3kret")
+      @url = "#{@user.id}:#{@user.password}@grendel/users/#{@user.id}"
+      stub_json_request(:delete, @url, "", :status => "204 No Content")
+    end
+    
+    it "should send a properly-formatted request" do
+      @user.delete
+      request(:delete, @url).should have_been_made.once
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'grendel'
+require 'spec'
+require 'spec/autorun'
+require 'webmock/rspec'
+
+include WebMock
+
+Spec::Runner.configure do |config|
+  WebMock.disable_net_connect!
+  
+  # helper to add Content-Type: application/json to each request
+  def stub_json_request(method, uri, body, headers = {})
+    headers = headers.update("Content-Type" => "application/json")
+    status = headers.delete(:status) || "200 OK"
+    stub_request(method, uri).
+      to_return(:body => body, :status => status, :headers => headers)
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: grendel-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Brad Greenlee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: |-
+  Grendel is a RESTful web service which allows for the secure storage of users'
+      documents. Grendel-Ruby provides a Ruby API for Grendel.
+email: brad@wesabe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+- README.md
+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
+has_rdoc: true
+homepage: http://github.com/wesabe/grendel-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby interface to Wesabe's Grendel
+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