throne 0.0.1

data/.document

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

data/.gitignore

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

data/FEATURES

@@ -0,0 +1,5 @@
+* Ability to load views from disk
+* Query these views from an object
+* Map the views to a hash structure, or just an array
+* At the top level retrieved, look for a RubyType field, and cast
+* vague AR methods (Create, save, hooks)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lincoln Stoll
+
+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,71 @@
+# ♚ Throne
+
+The king is here - on his couch, covered in rubies.
+
+Simple library for working with CouchDB
+
+## Basic Usage
+
+Create a database object to work with. Will create the DB if it doesn't exist
+
+    @db = Throne::Database.new('http://localhost:5984/throne-test')
+    # if you don't want to create the DB if it doesn't exist:
+    @db = Throne::Database.new('http://localhost:5984/throne-test', false)
+
+Save a new document
+
+    id = @db.save({:document_title => 'New Document', :documents => 'are just a hash')
+    id_of_document_saved = id
+    revision_of_document_saved = id.revision
+
+Get a document
+
+    doc = @db.get(document_id)
+    # with revision
+    doc = @db.get(document_id, revision)
+
+Save an existing document
+
+    id = @db.save(existing_document_loaded_from_db)
+    new_revision = id.revision
+
+Delete a document
+
+    @db.delete(document_id_or_document_object)
+
+Run a design document
+
+    @db.design('DesignDoc/_view/viewname')
+    => An array of documents
+
+    # with parameters
+    @db.design('DD/_list/listname/viewname', :key => ab..fg, :xyz => 7)
+    => An array of documents
+
+    # Iterator Method
+    @db.design('DesignDoc/_view/viewname') do |doc|
+      #invoked for each document
+      p doc
+    end
+
+Delete the database
+
+    @db.delete_database
+
+Create the database
+  
+    @db.create_database
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+# Copyright
+
+Copyright (c) 2009 Lincoln Stoll, Ben Schwarz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "throne"
+    gem.summary = %Q{Simple CouchDB library}
+    gem.description = %Q{Simple library for working with CouchDB. Avoids magic, keeps it simple.}
+    gem.email = "lstoll@lstoll.net"
+    gem.homepage = "http://github.com/lstoll/throne"
+    gem.authors = ["Lincoln Stoll"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "rest-client", ">= 0"
+    gem.add_dependency "hashie", ">= 0"
+    gem.add_dependency "json", ">= 0"
+    # 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 = "throne #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/throne.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'rest_client'
+require 'hashie'
+
+$:.unshift File.dirname(__FILE__) unless
+  $:.include?(File.dirname(__FILE__)) ||
+  $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Throne
+  autoload :Document, 'throne/document'
+  autoload :Tasks, 'throne/tasks'
+  autoload :Database, 'throne/database'
+end

data/lib/throne/database.rb

@@ -0,0 +1,106 @@
+require 'cgi'
+
+# Represents a connection to the database. Can be used standalone to talk
+# to a couch instance manually, otherwise is used by the mapper.
+class Throne::Database
+  attr_reader :url
+
+  # Create a new instance, with the URL for the database to work with
+  # By default will create the database if it doesn't exist, pass false
+  # as the second parameter to disable this.
+  def initialize(url, autocreate = true)
+    @url = url
+    create_database if autocreate
+  end
+
+  # Creates this database, will not error if the database exists
+  def create_database
+    begin
+      c.put @url, {}
+    rescue RestClient::RequestFailed => e
+      unless e.message =~ /412$/
+        raise e
+      end
+    end
+  end
+
+  # deletes this database.
+  def delete_database
+    begin
+      c.delete @url
+    rescue RestClient::ResourceNotFound
+    end
+  end
+
+  # gets a document by it's ID
+  def get(docid, rev=nil)
+    revurl = rev ? "?rev=#{rev}" : ""
+    JSON.parse(c.get(@url + '/' + docid + revurl))
+  end
+
+  # creates/updates a document from a hash/array structure
+  def save(doc)
+    if id = doc['_id']
+      res = c.put(@url + '/' + id, doc.to_json)
+    else
+      res = c.post(@url, doc.to_json)
+    end
+    res = JSON.parse(res) 
+    return nil unless res['ok']
+    Throne::StringWithRevision.new(res['id'], res['rev'])
+  end
+
+  # deletes a document. Can take an object or id
+  def delete(doc)
+    if doc.kind_of? String
+      rev = get(doc)['_rev']
+    else
+      rev = doc['_rev']
+      doc = doc['_id']
+    end
+
+    c.delete(@url + '/' + doc + '?rev=' + rev)
+  end
+
+  # runs a design by path, with optional params passed in
+  def design(path, params = {}, &block)
+    url = @url + '/_design/' + path
+    res = JSON.parse(c.get(paramify_url(url, params)))
+    if block_given?
+      # TODO - stream properly
+      res.each do |i|
+        yield i
+      end
+      nil
+    else
+      res
+    end
+  end
+
+
+
+  private
+
+  def paramify_url url, params = {}
+    if params && !params.empty?
+      query = params.collect do |k,v|
+        v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
+        "#{k}=#{CGI.escape(v.to_s)}"
+      end.join("&")
+      url = "#{url}?#{query}"
+    end
+    url
+  end
+  
+
+  def c; RestClient; end
+end
+
+class Throne::StringWithRevision < String
+  attr_reader :revision
+
+  def initialize(id, rev)
+    @revision = rev
+    super(id)
+  end
+end

data/lib/throne/document.rb

@@ -0,0 +1,4 @@
+# Represents a Document. Fields are defined here, as well as callbacks and
+# view access:
+class Throne::Document
+end

data/lib/throne/tasks.rb

@@ -0,0 +1,69 @@
+# Defines rake tasks for managing databases and views.
+class Throne::Tasks
+  def self.inject_fixtures_tasks(base_path)
+    namespace :throne do
+      namespace :load_fixtures do
+        dirs_in_path(base_path).each do |dir, fulldir|
+          desc "Loads fixtures for database #{dir}"
+          task dir.to_sym do
+            @db = Throne::Database.new(url(dir))
+            items = []
+            # grab and parse all YML files
+            Dir.glob(fulldir + '/**/*.yml').each do |yml|
+              items << YAML::load(File.open(yml))
+            end
+            # and json
+            Dir.glob(fulldir + '/**/*.json').each do |json|
+              items << JSON.parse(File.open(json).read)
+            end
+            # load em up
+            items.each do |item|
+              if item.kind_of? Array
+                item.each do |doc|
+                  @db.save(doc)
+                end
+              elsif item.kind_of? Hash
+                @db.save(item)
+              else
+                puts "There is something funky with the data for #{dir}"
+              end
+            end
+
+            p items[0]
+          end
+        end
+
+        desc "load all dbs"
+        task :all => dirs_in_path(base_path)
+      end
+    end
+  end
+
+  def self.inject_design_doc_tasks(base_path)
+    namespace :throne do
+      desc "Pushes all design docs into the named db url"
+      task :push_designs do
+      end
+    end
+  end
+
+  private
+
+  def self.dirs_in_path(path)
+    res = {}
+    Dir.glob(path + '/*').each do |fn|
+      res[File.basename(fn)] = fn if File.directory?(fn) 
+    end
+    res
+  end
+
+  def self.url(dbname)
+    if dburl = ENV['DB_URL']
+      return dburl
+    elsif svrurl = ENV['SERVER_URL']
+      return svrurl + '/' + dbname
+    else
+      raise("You must provide a SERVER_URL or DATABASE_URL")
+    end
+  end
+end

data/spec/database_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Throne::Database do
+  before :all do
+    @dburl =  'http://localhost:5984/throne_test'
+    begin
+      RestClient.delete(@dburl)
+    rescue
+    end
+    @db = Throne::Database.new(@dburl)
+    # some kind of fixtures loading?
+  end
+
+  describe "creating/deleting databases" do
+    it "should be able to delete a database" do
+      @db.create_database
+      @db.delete_database
+      lambda {RestClient.get(@dburl)}.
+        should raise_error(RestClient::ResourceNotFound)
+    end
+
+    it "should be able to create a database" do
+      @db.delete_database
+      @db.create_database
+      lambda {RestClient.get(@dburl)}.
+        should_not raise_error(RestClient::ResourceNotFound)
+    end
+
+    it "should not error when creating a database that exists" do
+      @db.delete_database
+      @db.create_database
+      lambda {@db.create_database}.
+        should_not raise_error(Exception)
+    end
+
+    it "shoudld automatically create the database" do
+      @db.delete_database
+      @db = Throne::Database.new(@dburl)
+      lambda {RestClient.get(@dburl)}.
+        should_not raise_error(RestClient::ResourceNotFound)
+    end
+  end
+
+  describe "working with documents" do
+    before :all do
+      @db = Throne::Database.new(@dburl)
+    end
+
+    it "should return a valid ID and rev when creating" do
+      id = @db.save(:testfield => 'true')
+      id.should_not be_empty
+      id.revision.should_not be_empty
+      lambda {RestClient.get(@dburl + '/' + id)}.
+        should_not raise_error(Exception)
+    end
+
+    it "should be able to get a doc by it's ID" do
+      id = @db.save(:testfield => 'true')
+      doc = @db.get(id)
+      doc.should_not be_nil
+      doc['testfield'].should_not be_nil
+    end
+
+    it "should be able to get a doc by it's ID and rev" do
+      id = @db.save(:testfield => 'true')
+      rev = id.revision
+      doc = @db.get(id)
+      doc['testfield2'] = 'bwah'
+      id = @db.save(doc)
+      doc = @db.get(id, rev)
+      doc['_rev'].should_not eql(id.revision)
+    end
+
+    it "should be able to update an existing doc" do
+      id =  @db.save(:testfield => 'true')
+      doc = @db.get(id)
+      doc['testerfield'] = 'false'
+      @db.save(doc)
+      @db.get(id)['testerfield'].should eql('false')
+    end
+
+    it "should be able to delete a document when given a document" do
+      id = @db.save(:testfield => 'true')
+      doc = @db.get(id)
+      @db.delete(doc)
+      lambda {@db.get(id)}.
+        should raise_error(RestClient::ResourceNotFound)
+    end
+
+    it "should be able to delete a document when given a document id" do
+      id = @db.save(:testfield => 'true')
+      @db.delete(id)
+      lambda {@db.get(id)}.
+        should raise_error(RestClient::ResourceNotFound)
+    end
+  end
+
+  describe "Design Access" do
+    it "should be able to call a design with parameters"
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Throne::Document do
+  it "should save when created called"
+  it "should tag its class when saved"
+  describe "View Access" do
+    it "should be able to query a view"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'throne'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/tasks_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Throne::Tasks do
+  it "should be able to create a database"
+  it "should be able to load a view from disk"
+  it "should be able to load fixtures from disk"
+  it "should be able to delete a database"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: throne
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lincoln Stoll
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple library for working with CouchDB. Avoids magic, keeps it simple.
+email: lstoll@lstoll.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- FEATURES
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/throne.rb
+- lib/throne/database.rb
+- lib/throne/document.rb
+- lib/throne/tasks.rb
+- spec/database_spec.rb
+- spec/document_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tasks_spec.rb
+has_rdoc: true
+homepage: http://github.com/lstoll/throne
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Simple CouchDB library
+test_files: 
+- spec/database_spec.rb
+- spec/document_spec.rb
+- spec/spec_helper.rb
+- spec/tasks_spec.rb