akdubya-cushion 0.5.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +176 -0
- data/README.rdoc +226 -0
- data/Rakefile +65 -0
- data/lib/cushion.rb +97 -0
- data/lib/cushion/core_ext.rb +27 -0
- data/lib/cushion/database.rb +310 -0
- data/lib/cushion/design.rb +33 -0
- data/lib/cushion/document.rb +117 -0
- data/lib/cushion/server.rb +208 -0
- data/spec/cushion_spec.rb +9 -0
- data/spec/database_spec.rb +223 -0
- data/spec/helpers.rb +2 -0
- data/spec/server_spec.rb +119 -0
- metadata +75 -0
data/LICENSE
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
data/README.rdoc
ADDED
@@ -0,0 +1,226 @@
|
|
1
|
+
= Cushion: A slim CouchDB client
|
2
|
+
|
3
|
+
Cushion is a minimalist Ruby client for accessing CouchDB servers. Originally
|
4
|
+
extracted from CouchRest (http://github.com/jchrist/couchrest), Cushion strips
|
5
|
+
out the extras while supporting more native CouchDB commands.
|
6
|
+
|
7
|
+
== Getting Started
|
8
|
+
|
9
|
+
# myapp.rb
|
10
|
+
require 'cushion'
|
11
|
+
|
12
|
+
db = Cushion.db!('http://127.0.0.1:5984/mydb')
|
13
|
+
db.save_doc("_id" => "abc", "foo" => "bar")
|
14
|
+
db.open_doc("abc")
|
15
|
+
|
16
|
+
== Servers
|
17
|
+
|
18
|
+
The server location defaults to http://127.0.0.1:5984, so you may omit the host
|
19
|
+
when initializing a server if you are satisfied with the default.
|
20
|
+
|
21
|
+
Cushion.server
|
22
|
+
Cushion.server('http://myhost:6969')
|
23
|
+
|
24
|
+
Display the server welcome message:
|
25
|
+
|
26
|
+
server.info
|
27
|
+
|
28
|
+
Get a list of all databases on the server:
|
29
|
+
|
30
|
+
server.all_dbs
|
31
|
+
|
32
|
+
Display any running tasks (such as replication):
|
33
|
+
|
34
|
+
server.active_tasks
|
35
|
+
|
36
|
+
Get the server configuration hash:
|
37
|
+
|
38
|
+
server.config
|
39
|
+
|
40
|
+
Set a configuration option:
|
41
|
+
|
42
|
+
server.set_config("mysection", "myoption", "myvalue")
|
43
|
+
|
44
|
+
Restart the server:
|
45
|
+
|
46
|
+
server.restart
|
47
|
+
|
48
|
+
Obtain server stats:
|
49
|
+
|
50
|
+
server.stats
|
51
|
+
|
52
|
+
Replicate from a source database to a target database:
|
53
|
+
|
54
|
+
server.replicate("db1", "db2")
|
55
|
+
server.replicate("db1", "http://host2:5984/bar")
|
56
|
+
|
57
|
+
Return a <tt>Cushion::Database</tt> without first creating it:
|
58
|
+
|
59
|
+
server.db("mydb")
|
60
|
+
server[:mydb]
|
61
|
+
|
62
|
+
Create a database and return a <tt>Cushion::Database</tt>:
|
63
|
+
|
64
|
+
server.db!("mydb")
|
65
|
+
|
66
|
+
== Databases
|
67
|
+
|
68
|
+
Create a database directly from a url, or just return the database instance if
|
69
|
+
it already exists:
|
70
|
+
|
71
|
+
Cushion.db!('http://127.0.0.1:5984/mydb')
|
72
|
+
|
73
|
+
Compact a database, eliminating old document revisions:
|
74
|
+
|
75
|
+
db.compact
|
76
|
+
|
77
|
+
Create and delete a database from an instance of <tt>Cushion::Database</tt>
|
78
|
+
|
79
|
+
db.create
|
80
|
+
db.delete
|
81
|
+
|
82
|
+
Open a document:
|
83
|
+
|
84
|
+
db.open_doc("mydoc")
|
85
|
+
|
86
|
+
Fetch all documents from a database:
|
87
|
+
|
88
|
+
db.all_docs
|
89
|
+
|
90
|
+
Save a document. The +_id+ may be omitted on document creation:
|
91
|
+
|
92
|
+
db.save_doc("_id" => "abc", .. attributes ..)
|
93
|
+
db.save_doc(.. attributes ..)
|
94
|
+
ab.save_doc("_id" => "exists", "_rev" => "1234", .. attributes ..)
|
95
|
+
|
96
|
+
Delete a document. Must include both an +id+ and a +rev+:
|
97
|
+
|
98
|
+
db.delete_doc("mydoc", "1234")
|
99
|
+
|
100
|
+
Perform a bulk save/update/delete operation:
|
101
|
+
|
102
|
+
docs = [
|
103
|
+
{ "_id" => "0", "_rev" => "123456", "_deleted" => true }, #=> Delete this doc
|
104
|
+
{ "_id" => "1", "_rev" => "32486671", "foo" => "bar" }, #=> Update this doc
|
105
|
+
{ "_id" => "2", "baz" => "bat" } #=> Create this doc
|
106
|
+
]
|
107
|
+
|
108
|
+
db.bulk_docs(docs)
|
109
|
+
|
110
|
+
Perform a bulk delete operation. This is a convenience method:
|
111
|
+
|
112
|
+
db.bulk_delete(some_docs)
|
113
|
+
|
114
|
+
Purge document revisions from the database, effectively erasing history:
|
115
|
+
|
116
|
+
doc_revs = {
|
117
|
+
"1" => ["12345", "42836"],
|
118
|
+
"2" => ["572654"],
|
119
|
+
"3" => ["34462"]
|
120
|
+
}
|
121
|
+
|
122
|
+
db.purge(doc_revs)
|
123
|
+
|
124
|
+
Copy or move a document to a new +id+. Specify a +dest_rev+ to overwrite an existing
|
125
|
+
document:
|
126
|
+
|
127
|
+
db.copy_doc("doc1", "doc2")
|
128
|
+
db.copy_doc("doc1", "doc2", :dest_rev => "36452")
|
129
|
+
db.move_doc("doc1", "1234", "doc2")
|
130
|
+
db.move_doc("doc1", "1234", "doc2", :dest_rev => "37462")
|
131
|
+
|
132
|
+
CouchDB can attach multiple files directly to documents, either as inline Base64
|
133
|
+
encoded data or via a standalone attachment API.
|
134
|
+
|
135
|
+
Open a document attachment. This will return an <tt>IO</tt> object:
|
136
|
+
|
137
|
+
temp = db.open_attachment("mydoc", "foo.txt")
|
138
|
+
temp.read
|
139
|
+
|
140
|
+
Save an inline attachment to a document:
|
141
|
+
|
142
|
+
db.save_doc("_id" => "mydoc", "_attachments" => {
|
143
|
+
"foo.txt" => {
|
144
|
+
"content_type" => "text/plain",
|
145
|
+
"data" => "Hello World!"
|
146
|
+
}
|
147
|
+
})
|
148
|
+
|
149
|
+
Save a standalone attachment to a saved document. Content type defaults to
|
150
|
+
"application/octet-stream":
|
151
|
+
|
152
|
+
db.save_attachment("mydoc", "1234", "bar.txt", "somedata", :content_type => "text/plain")
|
153
|
+
|
154
|
+
Delete a document attachment:
|
155
|
+
|
156
|
+
db.delete_attachment("mydoc", "1234", "foo.txt")
|
157
|
+
|
158
|
+
Rename an attachment:
|
159
|
+
|
160
|
+
db.rename_attachment("mydoc", "1234", "baz.txt", "bat.txt")
|
161
|
+
|
162
|
+
== Views
|
163
|
+
|
164
|
+
Create a temporary view and run a query against it:
|
165
|
+
|
166
|
+
temp_view = { :map => "function(doc){emit(doc.status,null)}" }
|
167
|
+
db.temp_view(temp_view, :key => "verified")
|
168
|
+
|
169
|
+
Run a query against a saved view:
|
170
|
+
|
171
|
+
db.view("people/by_first_name", :key => "gomer")
|
172
|
+
|
173
|
+
Show and list functions:
|
174
|
+
|
175
|
+
db.show("examples", "people", "mydoc", :format => "xml")
|
176
|
+
db.list("examples", "browse-people", "people-by-name", :startkey => ["a"], :limit => 10)
|
177
|
+
|
178
|
+
See http://wiki.apache.org/couchdb/Formatting_with_Show_and_List
|
179
|
+
|
180
|
+
== External Processes
|
181
|
+
|
182
|
+
Issue a request to a CouchDB external process, such as a full text indexing
|
183
|
+
engine:
|
184
|
+
|
185
|
+
db.external(:get, 'search/foo', :query => { 'foo' => 'bar' })
|
186
|
+
|
187
|
+
== Content Negotiation
|
188
|
+
|
189
|
+
All commands except for +show+ and +list+ return parsed JSON by default, but in some
|
190
|
+
cases it is useful to return the raw response from CouchDB. Simply set the correct
|
191
|
+
HTTP headers to request an alternate format:
|
192
|
+
|
193
|
+
db.all_docs :headers => { :accept => "text/plain" }
|
194
|
+
|
195
|
+
Some commands accept a headers hash as the last parameter, allowing you to omit
|
196
|
+
the explicit headers key like so:
|
197
|
+
|
198
|
+
db.info :accept => "text/plain"
|
199
|
+
|
200
|
+
== Cushion::Document
|
201
|
+
|
202
|
+
<tt>Cushion::Document</tt> provides a light wrapper for working directly with
|
203
|
+
individual documents.
|
204
|
+
|
205
|
+
Create a document:
|
206
|
+
|
207
|
+
Cushion::Document.use_database(db)
|
208
|
+
doc = Cushion::Document.new("foo" => "bar")
|
209
|
+
doc.save
|
210
|
+
|
211
|
+
Open a document and return an instance of <tt>Cushion::Document</tt>:
|
212
|
+
|
213
|
+
db.doc("mydoc")
|
214
|
+
doc["_foo"] = "bar"
|
215
|
+
doc.save
|
216
|
+
|
217
|
+
Copy a document:
|
218
|
+
|
219
|
+
doc.copy("mydoc2")
|
220
|
+
|
221
|
+
Work with document attachments:
|
222
|
+
|
223
|
+
doc.open_attachment("foo.txt")
|
224
|
+
doc.save_attachment("bar.txt", "somedata", :content_type => "text/plain")
|
225
|
+
doc.delete_attachment("bar.txt")
|
226
|
+
doc.rename_attachment("foo.txt", "newfoo.txt")
|
data/Rakefile
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
require 'rake'
|
2
|
+
require 'rake/testtask'
|
3
|
+
require 'rake/clean'
|
4
|
+
require 'rake/gempackagetask'
|
5
|
+
require 'rake/rdoctask'
|
6
|
+
require 'fileutils'
|
7
|
+
require File.join(File.expand_path(File.dirname(__FILE__)),'lib','cushion')
|
8
|
+
|
9
|
+
task :default => [:test]
|
10
|
+
task :spec => :test
|
11
|
+
|
12
|
+
name = 'cushion'
|
13
|
+
version = Cushion::VERSION
|
14
|
+
|
15
|
+
spec = Gem::Specification.new do |s|
|
16
|
+
s.name = name
|
17
|
+
s.version = version
|
18
|
+
s.summary = "A slim CouchDB client."
|
19
|
+
s.description = "A slim CouchDB client."
|
20
|
+
s.author = "Aleksander Williams"
|
21
|
+
s.email = "alekswilliams@earthlink.net"
|
22
|
+
s.homepage = "http://github.com/akdubya/cushion"
|
23
|
+
s.platform = Gem::Platform::RUBY
|
24
|
+
s.has_rdoc = true
|
25
|
+
s.files = %w(Rakefile README.rdoc LICENSE) + Dir.glob("{lib,spec}/**/*")
|
26
|
+
s.require_path = "lib"
|
27
|
+
s.add_dependency("rest-client", ">= 0.9")
|
28
|
+
end
|
29
|
+
|
30
|
+
Rake::GemPackageTask.new(spec) do |p|
|
31
|
+
p.need_tar = true if RUBY_PLATFORM !~ /mswin/
|
32
|
+
end
|
33
|
+
|
34
|
+
desc "Install as a system gem"
|
35
|
+
task :install => [ :package ] do
|
36
|
+
sh %{sudo gem install pkg/#{name}-#{version}.gem}
|
37
|
+
end
|
38
|
+
|
39
|
+
desc "Uninstall as a system gem"
|
40
|
+
task :uninstall => [ :clean ] do
|
41
|
+
sh %{sudo gem uninstall #{name}}
|
42
|
+
end
|
43
|
+
|
44
|
+
desc "Create a gemspec file"
|
45
|
+
task :make_spec do
|
46
|
+
File.open("#{name}.gemspec", "w") do |file|
|
47
|
+
file.puts spec.to_ruby
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
Rake::TestTask.new(:test) do |t|
|
52
|
+
t.libs << "spec"
|
53
|
+
t.test_files = FileList['spec/*_spec.rb']
|
54
|
+
t.verbose = true
|
55
|
+
end
|
56
|
+
|
57
|
+
Rake::RDocTask.new do |t|
|
58
|
+
t.rdoc_dir = 'rdoc'
|
59
|
+
t.title = "Cushion: A slim CouchDB client"
|
60
|
+
t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
|
61
|
+
t.options << '--charset' << 'utf-8'
|
62
|
+
t.rdoc_files.include('README.rdoc')
|
63
|
+
t.rdoc_files.include('lib/cushion.rb')
|
64
|
+
t.rdoc_files.include('lib/cushion/*.rb')
|
65
|
+
end
|