couchrest 2.0.0.beta2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56c6ad538f2b4fce792fe1e86f397af9c9fd02e1
-  data.tar.gz: 5fc268898ee98554d7810dc0ce1bae37ee9953aa
+  metadata.gz: 12c93fb012d1d27b5ca89ab37547b0f00ad65f8e
+  data.tar.gz: d0a51beddbe852ac9e69374bbb9370e7a6bf296c
 SHA512:
-  metadata.gz: a04bacd2673fa3782fc91218dff8e54fd777b086a1aea409210b16756c0fd4904a045fc792f10101568df92f243bea717ead2719671ae3f1de9991d374718a11
-  data.tar.gz: 52fc7bb62a48eaff3f848eea5b13fe8c9d79be1a68c74603e55d24d3c7972354c8a9d390f2544eeb02576f622047386b9d96127779fdb662e2180b2a77fac447
+  metadata.gz: 2bc6d4a7f0c928d9da0e11237e41c62c6d9c0ddc15b0d06b5107664b59bf76c9ebc5fa6f040ee1fc2be77b67aedfa9738ad4a0c48e0219bb6a3a8ce76cf0ec03
+  data.tar.gz: a552470d47f04d65e62333f9af5d8f27af4779ce3612a5f0757ebd737caa4a91fdccc27e6d890e8289d92aa05668fa14ac59405956e9f1196aad12156a77e650

data/README.md

@@ -2,10 +2,11 @@
 
 [![Build Status](https://travis-ci.org/couchrest/couchrest.png)](https://travis-ci.org/couchrest/couchrest)
 
-CouchRest wraps CouchDB's HTTP API using persistent connections with the [HTTPClient gem](https://github.com/nahi/httpclient), managing JSON serialization, and remembering the URI-paths
-to CouchDB's API endpoints so you don't have to.
+CouchRest wraps CouchDB's HTTP API using persistent connections with the [HTTPClient gem](https://github.com/nahi/httpclient) managing servers, databases, and JSON document serialization using CouchDB's API endpoints so you don't have to.
 
-CouchRest is designed to make a simple base for application and framework-specific object oriented APIs. CouchRest is Object-Mapper agnostic, the parsed JSON it returns from CouchDB shows up as subclasses of Ruby's Hash. Naked JSON, just as it was mean to be.
+CouchRest is designed to provide a simple base for application and framework-specific object oriented APIs. CouchRest is Object-Mapper agnostic, the JSON objects provided by CouchDB are parsed and returned as Document objects providing a simple Hash-like interface.
+
+For more complete modelling support based on ActiveModel, please checkout CouchRest's sister project: [CouchRest Model](https://github.com/couchrest/couchrest_model).
 
 ## CouchDB Version
 
@@ -15,9 +16,30 @@ Tested on latest stable release (1.6.X), but should work on older versions above
 
     $ sudo gem install couchrest
 
-## Modelling
+## Basic Usage
 
-For more complete modelling support based on ActiveModel, please checkout CouchRest's sister project: [CouchRest Model](https://github.com/couchrest/couchrest_model).
+Getting started with CouchRest is easy. You can send requests directly to a URL using a [RestClient](https://github.com/rest-client/rest-client)-like interface:
+
+```ruby
+CouchRest.put("http://localhost:5984/testdb/doc", 'name' => 'test', 'date' => Date.current)
+```
+
+Or use the lean server and database orientated API to take advantage of persistent and reusable connections:
+
+```ruby
+server = CouchRest.new           # assumes localhost by default!
+db = server.database!('testdb')  # create db if it doesn't already exist
+
+# Save a document, with ID
+db.save_doc('_id' => 'doc', 'name' => 'test', 'date' => Date.current)
+
+# Fetch doc
+doc = db.get('doc')
+doc.inspect # #<CouchRest::Document _id: "doc", _rev: "1-defa304b36f9b3ef3ed606cc45d02fe2", name: "test", date: "2015-07-13">
+
+# Delete
+db.delete_doc(doc)
+```
 
 ## Running the Specs
 

data/VERSION

@@ -1 +1 @@
-2.0.0.beta2
+2.0.0.rc1

data/history.txt

@@ -1,10 +1,11 @@
-== 2.0.0.beta1
+== 2.0.0.rc1
 
 * Major Changes
   * Refactoring to support persisitent HTTP connections with HTTPClient gem (@samlown)
   * Using Ruby's URI object consistently. (@samlown)
   * Removing concepts of `Server#available_databases` and `Server#default_databases` (@samlown)
   * Removing the `Streamer` class, added support for built-in streamer (@samlown)
+  * Fixing inline attachment Base64 re-encoding issue (@samlown) Issue#37
 
 == 1.2.1 - 2015-06-25
 

data/lib/couchrest.rb

@@ -20,6 +20,7 @@ $:.unshift File.dirname(__FILE__) unless
  $:.include?(File.dirname(__FILE__)) ||
  $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'couchrest/version'
 require 'couchrest/exceptions'
 require 'couchrest/connection'
 require 'couchrest/rest_api'

data/lib/couchrest/database.rb

@@ -379,8 +379,8 @@ module CouchRest
 
     def encode_attachments(attachments)
       attachments.each do |k,v|
-        next if v['stub']
-        v['data'] = base64(v['data'])
+        next if v['stub'] || v['data'].frozen?
+        v['data'] = base64(v['data']).freeze
       end
       attachments
     end
@@ -392,7 +392,7 @@ module CouchRest
     # Convert a simplified view name into a complete view path. If
     # the name already starts with a "_" no alterations will be made.
     def name_to_view_path(name)
-      name =~ /^([^_].+?)\/(.*)$/ ? "_design/#{$1}/_view/#{$2}" : name
+      name =~ /^([^_].*?)\/(.*)$/ ? "_design/#{$1}/_view/#{$2}" : name
     end
   end
 end

data/lib/couchrest/version.rb

@@ -0,0 +1,5 @@
+module CouchRest
+
+  VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).strip
+
+end

data/spec/couchrest/couchrest_spec.rb

@@ -16,8 +16,10 @@ describe CouchRest do
     end
   end
 
-  let :mock_server do
-    CouchRest.new("http://mock")
+  describe "version" do
+    it "should be there" do
+      expect(CouchRest::VERSION).to_not be_empty
+    end
   end
 
   describe "getting info" do
@@ -30,17 +32,6 @@ describe CouchRest do
     end
   end
 
-  it "should restart" do
-    # we really do not need to perform a proper restart!
-    stub_request(:post, "http://mock/_restart")
-      .to_return(:body => "{\"ok\":true}")
-    mock_server.restart!
-  end
-
-  it "should provide one-time access to uuids" do
-    expect(@cr.next_uuid).not_to be_nil
-  end
-
   describe "initializing a database" do
     it "should return a db" do
       db = @cr.database(TESTDB)

data/spec/couchrest/database_spec.rb

@@ -8,14 +8,16 @@ describe CouchRest::Database do
     @db = @cr.create_db(TESTDB) # rescue nil
   end
 
-  describe "database name including slash" do
-    it "should escape the name in the URI" do
-      db = @cr.database("foo/bar")
-      expect(db.name).to eq "foo/bar"
-      expect(db.root).to eq URI("#{COUCHHOST}/foo%2Fbar")
-      expect(db.uri).to eq URI("#{COUCHHOST}/foo%2Fbar")
-      expect(db.to_s).to eq "#{COUCHHOST}/foo%2Fbar"
-      expect(db.path).to  eq "/foo%2Fbar"
+  describe "#initialize" do
+    describe "database name including slash" do
+      it "should escape the name in the URI" do
+        db = @cr.database("foo/bar")
+        expect(db.name).to eq "foo/bar"
+        expect(db.root).to eq URI("#{COUCHHOST}/foo%2Fbar")
+        expect(db.uri).to eq URI("#{COUCHHOST}/foo%2Fbar")
+        expect(db.to_s).to eq "#{COUCHHOST}/foo%2Fbar"
+        expect(db.path).to  eq "/foo%2Fbar"
+      end
     end
   end
 
@@ -172,6 +174,13 @@ describe CouchRest::Database do
       expect(rows.length).to eq 2
       expect(rows.first['doc']['another']).not_to be_empty
     end
+    it "should accept a short design doc name" do
+      res = { 'rows' => [] }
+      db = CouchRest.new("http://mock").database('db')
+      stub_request(:get, "http://mock/db/_design/a/_view/test")
+        .to_return(:body => res.to_json)
+      expect(db.view('a/test')).to eql(res)
+    end
   end
 
   describe "#changes" do
@@ -398,7 +407,7 @@ describe CouchRest::Database do
     it 'should be there' do
       doc = @db.get('mydocwithattachment')
       attachment = @db.fetch_attachment(doc, 'test.html')
-      expect(Base64.decode64(attachment)).to eq @attach
+      expect(attachment).to eq @attach
     end
   end
 
@@ -406,7 +415,7 @@ describe CouchRest::Database do
     before(:each) do
       @attach = "<html><head><title>My Doc</title></head><body><p>Has words.</p></body></html>"
       @attach2 = "<html><head><title>Other Doc</title></head><body><p>Has more words.</p></body></html>"
-      @doc = {
+      @data = {
         "_id" => "mydocwithattachment",
         "field" => ["some value"],
         "_attachments" => {
@@ -420,7 +429,7 @@ describe CouchRest::Database do
           }
         }
       }
-      @db.save_doc(@doc)
+      @db.save_doc(@data)
       @doc = @db.get("mydocwithattachment")
     end
     it "should save and be indicated" do
@@ -435,6 +444,11 @@ describe CouchRest::Database do
       attachment = @db.fetch_attachment(@doc,"other.html")
       expect(attachment).to eq @attach2
     end
+    it "should not re-encode document" do
+      @db.save_doc(@data)
+      attachment = @db.fetch_attachment(@data,"test.html")
+      expect(attachment).to eq @attach
+    end
   end
   
   describe "DELETE an attachment directly from the database" do

data/spec/couchrest/server_spec.rb

@@ -2,5 +2,101 @@ require File.expand_path("../../spec_helper", __FILE__)
 
 describe CouchRest::Server do
   
-  
+  let :server do
+    CouchRest::Server.new(COUCHHOST)
+  end
+
+  let :mock_server do
+    CouchRest::Server.new("http://mock")
+  end
+
+  describe "#initialize" do
+    it "should prepare frozen URI object" do
+      expect(server.uri).to be_a(URI)
+      expect(server.uri).to be_frozen
+      expect(server.uri.to_s).to eql(COUCHHOST)
+    end
+
+    it "should clean URI" do
+      server = CouchRest::Server.new(COUCHHOST + "/some/path?q=1#fragment")
+      expect(server.uri.to_s).to eql(COUCHHOST)
+    end
+  end
+
+  describe :connection do
+
+    it "should be provided" do
+      expect(server.connection).to be_a(CouchRest::Connection)
+    end
+
+    it "should cache connection in current thread" do
+      server.connection # instantiate
+      conns = Thread.current['couchrest.connections']
+      expect(server.connection).to eql(conns[COUCHHOST])
+    end
+
+  end
+
+  describe :databases do
+
+    it "should provide list of databse names" do
+      expect(server.databases).to include(TESTDB)
+    end
+
+  end
+
+  describe :database do
+
+    it "should instantiate a new database object" do
+      db = server.database(TESTDB)
+      expect(db).to be_a(CouchRest::Database)
+      expect(db.name).to eql(TESTDB)
+    end
+
+  end
+
+  describe :database! do
+
+    let :db_name do
+      TESTDB + '_create'
+    end
+
+    it "should instantiate and create database if it doesn't exist" do
+      db = server.database!(db_name)
+      expect(server.databases).to include(db_name)
+      db.delete!
+    end
+
+  end
+
+  describe :info do
+
+    it "should provide server info" do
+      expect(server.info).to be_a(Hash)
+      expect(server.info).to include('couchdb')
+      expect(server.info['couchdb']).to eql('Welcome')
+    end
+
+  end
+
+  describe :restart do
+    it "should send restart request" do
+      # we really do not need to perform a proper restart!
+      stub_request(:post, "http://mock/_restart")
+        .to_return(:body => "{\"ok\":true}")
+      mock_server.restart!
+    end
+  end
+
+  describe :next_uuid do
+    it "should provide one-time access to uuids" do
+      expect(server.next_uuid).not_to be_nil
+    end
+
+    it "should support providing batch count" do
+      server.next_uuid(10)
+      expect(server.uuids.length).to eql(9)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchrest
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - J. Chris Anderson
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -161,6 +161,7 @@ files:
 - lib/couchrest/rest_api.rb
 - lib/couchrest/server.rb
 - lib/couchrest/support/inheritable_attributes.rb
+- lib/couchrest/version.rb
 - spec/.gitignore
 - spec/couchrest/connection_spec.rb
 - spec/couchrest/couchrest_spec.rb