armchair 0.0.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

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Kirsch
+
+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.rdoc

@@ -0,0 +1,30 @@
+= Armchair
+
+Armchair is a <em>very</em> minimal interface to CouchDB. It can only store documents and iterate over all of them.
+
+== Usage
+
+  armchair = Armchair.new 'http://url.to.couch:5984/databasename'
+  armchair << { 'foo' => 'bar' } << { 'foo' => 'baz' }
+  armchair.each do |doc|
+    do_something_useful_with doc
+  end
+  
+Armchair is Enumerable
+
+  armchair.map { |doc| doc['foo'] }.join # => "barbaz"
+  armchair.detect { |doc| doc['foo'] == 'bar' } # => { 'foo' => 'bar' }
+
+== 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) 2010 Daniel Kirsch. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "armchair"
+    gem.version = '0.0.1'
+    gem.summary = %Q{Minimal CouchDB interface}
+    gem.description = %Q{A minimal CouchDB interface that can do nothing but add documents and iterate over documents.}
+    gem.email = "danishkirel@gmail.com"
+    gem.homepage = "http://github.com/kirel/armchair"
+    gem.authors = ["Daniel Kirsch"]
+    gem.add_dependency "rest-client", ">= 1.4.1"
+    gem.add_dependency "json"
+    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
+
+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 = "armchair #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/armchair.gemspec

@@ -0,0 +1,60 @@
+# 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{armchair}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Kirsch"]
+  s.date = %q{2010-03-11}
+  s.description = %q{A minimal CouchDB interface that can do nothing but add documents and iterate over documents.}
+  s.email = %q{danishkirel@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "armchair.gemspec",
+     "lib/armchair.rb",
+     "spec/armchair_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kirel/armchair}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Minimal CouchDB interface}
+  s.test_files = [
+    "spec/armchair_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<rest-client>, [">= 1.4.1"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 1.4.1"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 1.4.1"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/armchair.rb

@@ -0,0 +1,81 @@
+require 'rest_client'
+require 'json'
+
+# An Armchair is <em>very</em> a minimal interface to a CouchDB database. It is Enumarable.
+class Armchair
+  include Enumerable
+  
+  # Pass in the database url and optionally
+  # a <tt>batch_size</tt> which is used when iterating over the armchair in Armchair#each
+  #  couch = Armchair.new 'http://127.0.0.1:5984/mycouch'
+  #
+  def initialize dburl, batch_size = 100
+    @dburl = dburl
+    @batch_size = batch_size
+  end
+  
+  # Create the CouchDB database at <tt>dburl</tt> (see Armchair#new) if it does not exist yet
+  def create!
+    RestClient.get @dburl, :accept => :json do |response|
+      case response.code
+      when 404
+        RestClient.put @dburl, nil, :content_type => :json, :accept => :json
+      else
+        response.return!
+      end
+    end
+  end
+  
+  # Shift a document into the Armchair. <tt>doc</tt> should be a Hash.
+  #  armchair << { 'a' => 'document' } << { 'another' => 'document' }
+  def << doc
+    RestClient.post @dburl, JSON(doc), :content_type => :json, :accept => :json do |response|
+      response.return! unless response.code == 201
+    end
+    self
+  end
+  
+  # Returns the size of the Armchair (the number of documents stored).
+  def size
+    RestClient.get(@dburl + '_all_docs?limit=0', :accept => :json) do |r|
+      case r.code
+      when 200
+        JSON(r.body)['total_rows']
+      else
+        r.return!
+      end
+    end
+  end
+
+  # yields each document
+  def each
+    # iterate in batches of @batch_size
+    # initial query
+    res = RestClient.get(@dburl + "_all_docs?limit=#{@batch_size+1}&include_docs=true", :accept => :json) do |r|
+      case r.code
+      when 200
+        JSON(r.body)
+      else
+        r.return!
+      end
+    end
+    rows = res['rows']
+    last = rows.size > @batch_size ? rows.pop : nil
+    rows.each { |row| doc = row['doc']; yield doc }
+    # subsequent queries
+    while last
+      startkey = last['key']
+      res = RestClient.get(@dburl+"_all_docs?startkey=%22#{startkey}%22&limit=#{@batch_size+1}&include_docs=true", :accept => :json) do |r|
+        case r.code
+        when 200
+          JSON(r.body)
+        else
+          r.return!
+        end
+      end
+      rows = res['rows']
+      last = rows.size > @batch_size ? rows.pop : nil
+      rows.each { |row| yield row['doc'] }
+    end
+  end
+end

data/spec/armchair_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+require 'armchair'
+
+describe Armchair do
+  
+  before(:each) do
+    @dburl = 'http://localhost:5984/test_armchair/'
+    @couch = Armchair.new @dburl
+    @doc = {'some' => 'doc'}
+  end
+  
+  after(:each) do
+    begin
+      RestClient.delete(@dburl)
+    rescue RestClient::ResourceNotFound
+    end
+  end
+  
+  it "should create the database" do
+    @couch.create!
+    lambda { RestClient.get(@dburl) }.should_not raise_error(RestClient::ResourceNotFound)
+  end
+  
+  it "should insert documents" do
+    # just checking if CouchDB API is correctly used
+    RestClient.should_receive(:post).with(@dburl, JSON(@doc), :content_type => :json, :accept => :json)
+    @couch << @doc
+  end
+  
+  describe "with some documents in it" do
+    
+    before(:each) do
+      @num = 42
+      @couch.create!
+      @docs = (1..@num).map { |i| { 'number' => i } }
+      @docs.each { |doc| @couch << doc }
+    end
+    
+    it "should know the numbers" do
+      @couch.size.should == @num
+    end
+        
+    it "should iterate over each document" do
+      docs = @docs.dup
+      @couch.each do |doc|
+        docs.delete(docs.detect { |d| d['number'] == doc['number']})
+      end
+      docs.should be_empty
+    end
+    
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: armchair
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Kirsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  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: A minimal CouchDB interface that can do nothing but add documents and iterate over documents.
+email: danishkirel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- armchair.gemspec
+- lib/armchair.rb
+- spec/armchair_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kirel/armchair
+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: Minimal CouchDB interface
+test_files: 
+- spec/armchair_spec.rb
+- spec/spec_helper.rb