couch_crud 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +202 -0
- data/README.md +41 -0
- data/Rakefile +7 -0
- data/couch_crud.gemspec +26 -0
- data/lib/couch_crud.rb +106 -0
- data/lib/couch_crud/errors.rb +25 -0
- data/lib/couch_crud/version.rb +3 -0
- data/test/couch_crud_test.rb +103 -0
- data/test/test_helper.rb +22 -0
- metadata +119 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c49d66d6d6fc6986264b1259ffd7415dd34478b2
|
4
|
+
data.tar.gz: ecb1a60b7a8a7ab1099d04330c61dbd26e1b06fd
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ab9c0fa0876ce4cf4894825c1ec9399db4d45d5556e071f8a7a5220e1af9984d4345a79b46bc67aed2e55a5d1df01218c482dbeea4bd7f0b8dd4669457aedbe2
|
7
|
+
data.tar.gz: d9cba200208963d0c53449a3e93f50b45ef3c7829b51b16487f64240d28fae7d332762faecea91ee8ba3276f6b1956ed97723273e073a3558ef60cec35a014d2
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright 2015 Quantdeck Systems Ltd.
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# couch_crud
|
2
|
+
|
3
|
+
couch_crud is a mixin which provides minimal, simple CRUD operations for CouchDB
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'couch_crud'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install couch_crud
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
1. `require couch_crud` then `include CouchCrud` in your class
|
24
|
+
2. set `@couchdb_url` to be your couchdDB database access url
|
25
|
+
3. Then use the CRUD functions:
|
26
|
+
- `create_document(document Hash)` to create
|
27
|
+
- `read_document(document id)` to to read
|
28
|
+
- `update_document(document Hash)` to update
|
29
|
+
- `delete_document(document id)` to delete
|
30
|
+
- `document.exists?(document id)` to check if a doc exists
|
31
|
+
4. Features like attachments, versions etc. aren't currently supported, but may be later on
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
1. Fork it ( https://github.com/iaingray/couch_crud/fork )
|
36
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
37
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
38
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
39
|
+
5. Create a new Pull Request
|
40
|
+
|
41
|
+
Note that testing requires a running CouchDB server "http://127.0.0.1:5984/", or a url specified in ENV['CLOUDANT_TEST_URL']
|
data/Rakefile
ADDED
data/couch_crud.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'couch_crud/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "couch_crud"
|
8
|
+
spec.version = CouchCrud::VERSION
|
9
|
+
spec.authors = ["Iain Gray"]
|
10
|
+
spec.email = ["support@quantdeck.com"]
|
11
|
+
spec.summary = %q{Mixin to provide basic CRUD operations for CouchDB}
|
12
|
+
spec.description = %q{couch_crud provides a minimal, simple Couchdb CRUD layer using couchrest}
|
13
|
+
spec.homepage = "https://github.com/quantdeck/couch_crud"
|
14
|
+
spec.license = "Apache"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
22
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
23
|
+
spec.add_runtime_dependency "contracts", "~> 0.6"
|
24
|
+
spec.add_runtime_dependency "couchrest", "~> 1.2", ">= 1.2.0"
|
25
|
+
|
26
|
+
end
|
data/lib/couch_crud.rb
ADDED
@@ -0,0 +1,106 @@
|
|
1
|
+
# Copyright (c) 2015 Quantdeck Systems Ltd. All rights reserved.
|
2
|
+
#
|
3
|
+
# This program is licensed to you under the Apache License Version 2.0,
|
4
|
+
# and you may not use this file except in compliance with the Apache License Version 2.0.
|
5
|
+
# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
|
6
|
+
#
|
7
|
+
# Unless required by applicable law or agreed to in writing,
|
8
|
+
# software distributed under the Apache License Version 2.0 is distributed on an
|
9
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
10
|
+
# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
|
11
|
+
|
12
|
+
# Author:: Iain Gray (mailto:support@quantdeck.com)
|
13
|
+
# Copyright:: Copyright (c) 2015 Quantdeck Systems Ltd
|
14
|
+
# License:: Apache License Version 2.0
|
15
|
+
|
16
|
+
|
17
|
+
require "couch_crud/version"
|
18
|
+
require "couch_crud/errors"
|
19
|
+
require "couchrest"
|
20
|
+
require "contracts"
|
21
|
+
|
22
|
+
include Contracts
|
23
|
+
|
24
|
+
module CouchCrud
|
25
|
+
|
26
|
+
# Creates a new document with the supplied Hash
|
27
|
+
#
|
28
|
+
# Returns an Object with ID and operation result
|
29
|
+
# Raises a DocConflictError if a document already exists with supplied ID
|
30
|
+
#
|
31
|
+
# Parameters:
|
32
|
+
# +doc+:: Hash with document contents (including optional _id)
|
33
|
+
Contract Hash => Object
|
34
|
+
def create_document(doc)
|
35
|
+
if !doc['_id'].nil? && document_exists?(doc['_id']) then
|
36
|
+
raise DocConflictError
|
37
|
+
else
|
38
|
+
res = connection.save_doc(doc)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
# Retrieves the document for a specific ID
|
43
|
+
#
|
44
|
+
# Returns the Couchrest Document if successful
|
45
|
+
# Raises a DocNotFoundError if the doc doesn't exist
|
46
|
+
#
|
47
|
+
# Parameters :
|
48
|
+
# +id+:: id of the document to retrieve
|
49
|
+
Contract String => Object
|
50
|
+
def read_document(id)
|
51
|
+
begin
|
52
|
+
doc = connection.get(id)
|
53
|
+
rescue RestClient::ResourceNotFound
|
54
|
+
raise DocNotFoundError
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
# Updates a document when passed a Hash containing an _id
|
59
|
+
#
|
60
|
+
# Returns an Object with ID and operation result
|
61
|
+
# Raises a DocNotFoundError if the doc doesn't exist
|
62
|
+
#
|
63
|
+
# Parameters :
|
64
|
+
# +doc+:: Hash with document contents (including optional _id)
|
65
|
+
Contract ({'_id' => String}) => Object
|
66
|
+
def update_document(doc)
|
67
|
+
raise DocNotFoundError unless document_exists?(doc['_id'])
|
68
|
+
connection.save_doc(doc)
|
69
|
+
end
|
70
|
+
|
71
|
+
# Deletes a document if it exists
|
72
|
+
# Returns true on success
|
73
|
+
# Raises a DocNotFoundError if the doc doesn't exist
|
74
|
+
#
|
75
|
+
# Parameters :
|
76
|
+
# +id+:: id of the document to delete
|
77
|
+
Contract String => Object
|
78
|
+
def delete_document(id)
|
79
|
+
begin
|
80
|
+
connection.get(id).destroy
|
81
|
+
rescue RestClient::ResourceNotFound
|
82
|
+
raise DocNotFoundError
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# Checks if document exists for given ID
|
87
|
+
# Returns true or false
|
88
|
+
# Parameters :
|
89
|
+
# +id+:: id of the document to check
|
90
|
+
Contract String => Or.new(true, false)
|
91
|
+
def document_exists?(id)
|
92
|
+
begin
|
93
|
+
connection.get(id)
|
94
|
+
rescue RestClient::ResourceNotFound
|
95
|
+
return false
|
96
|
+
end
|
97
|
+
true
|
98
|
+
end
|
99
|
+
|
100
|
+
private
|
101
|
+
|
102
|
+
def connection
|
103
|
+
CouchRest.database(@couchdb_url)
|
104
|
+
end
|
105
|
+
|
106
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Copyright (c) 2015 Quantdeck Systems Ltd. All rights reserved.
|
2
|
+
#
|
3
|
+
# This program is licensed to you under the Apache License Version 2.0,
|
4
|
+
# and you may not use this file except in compliance with the Apache License Version 2.0.
|
5
|
+
# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
|
6
|
+
#
|
7
|
+
# Unless required by applicable law or agreed to in writing,
|
8
|
+
# software distributed under the Apache License Version 2.0 is distributed on an
|
9
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
10
|
+
# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
|
11
|
+
|
12
|
+
# Author:: Iain Gray (mailto:support@quantdeck.com)
|
13
|
+
# Copyright:: Copyright (c) 2015 Quantdeck Systems Ltd
|
14
|
+
# License:: Apache License Version 2.0
|
15
|
+
|
16
|
+
module CouchCrud
|
17
|
+
|
18
|
+
# The base error class for all <tt>couch_crud</tt> error classes.
|
19
|
+
class Error < StandardError; end
|
20
|
+
# If a document conflicts with an existing document in the DB
|
21
|
+
class DocConflictError < Error; end
|
22
|
+
# If a document requested doesn't exist
|
23
|
+
class DocNotFoundError < Error; end
|
24
|
+
|
25
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# Copyright (c) 2015 Quantdeck Systems Ltd. All rights reserved.
|
2
|
+
#
|
3
|
+
# This program is licensed to you under the Apache License Version 2.0,
|
4
|
+
# and you may not use this file except in compliance with the Apache License Version 2.0.
|
5
|
+
# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
|
6
|
+
#
|
7
|
+
# Unless required by applicable law or agreed to in writing,
|
8
|
+
# software distributed under the Apache License Version 2.0 is distributed on an
|
9
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
10
|
+
# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
|
11
|
+
|
12
|
+
# Author:: Iain Gray (mailto:support@quantdeck.com)
|
13
|
+
# Copyright:: Copyright (c) 2015 Quantdeck Systems Ltd
|
14
|
+
# License:: Apache License Version 2.0
|
15
|
+
|
16
|
+
|
17
|
+
require 'test_helper'
|
18
|
+
|
19
|
+
class CrudTest
|
20
|
+
include CouchCrud
|
21
|
+
|
22
|
+
def initialize
|
23
|
+
@couchdb_url = COUCHDB_URL
|
24
|
+
end
|
25
|
+
|
26
|
+
end
|
27
|
+
|
28
|
+
describe CouchCrud do
|
29
|
+
|
30
|
+
before do
|
31
|
+
@ct = CrudTest.new
|
32
|
+
@delete_ids = Array.new
|
33
|
+
db = CouchRest.database!(COUCHDB_URL)
|
34
|
+
db.save_doc({'_id' => 'horse', :food => 'hay'})
|
35
|
+
db.save_doc({'_id' => 'dolphin', :food => 'fish'})
|
36
|
+
end
|
37
|
+
|
38
|
+
after do
|
39
|
+
CouchRest.database(COUCHDB_URL).delete!
|
40
|
+
end
|
41
|
+
|
42
|
+
describe "when creating a document" do
|
43
|
+
it "must check for an existing document" do
|
44
|
+
Proc.new{@ct.create_document({'_id'=> 'horse', :food => 'sardines'})}.must_raise CouchCrud::DocConflictError
|
45
|
+
end
|
46
|
+
|
47
|
+
it "must save a new document with an id" do
|
48
|
+
res = @ct.create_document({'_id' => 'cow', :food => 'grass'})
|
49
|
+
res['id'].must_equal 'cow'
|
50
|
+
end
|
51
|
+
|
52
|
+
it "must save a new document without an id" do
|
53
|
+
res = @ct.create_document({'type' => 'grey goo', :food => 'everything'})
|
54
|
+
res['ok'].must_equal true
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
describe "when reading a document" do
|
59
|
+
it "must throw an error if document not found" do
|
60
|
+
Proc.new{@ct.read_document('donkey')}.must_raise CouchCrud::DocNotFoundError
|
61
|
+
end
|
62
|
+
|
63
|
+
it "must return the document contents if key exists" do
|
64
|
+
@ct.read_document('dolphin')[:food].must_equal 'fish'
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
describe "when updating a document" do
|
69
|
+
it "must throw an error if document not found" do
|
70
|
+
Proc.new{@ct.update_document({'_id' => 'donkey'})}.must_raise CouchCrud::DocNotFoundError
|
71
|
+
end
|
72
|
+
|
73
|
+
it "must update an existing document" do
|
74
|
+
doc = @ct.read_document('dolphin')
|
75
|
+
doc['dislikes'] = 'tuna nets'
|
76
|
+
@ct.update_document(doc)['ok'].must_equal true
|
77
|
+
@ct.read_document('dolphin')['dislikes'].must_equal 'tuna nets'
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
describe "when deleting a document" do
|
82
|
+
it "must throw an error if the document does not exist" do
|
83
|
+
Proc.new{@ct.delete_document('zebra')}.must_raise CouchCrud::DocNotFoundError
|
84
|
+
end
|
85
|
+
|
86
|
+
it "must delete an existing document" do
|
87
|
+
@ct.create_document({'_id' => 'chicken', :food => 'corn'})
|
88
|
+
@ct.delete_document('chicken').must_equal true
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
describe "when checking if a document exists" do
|
93
|
+
it "must return true if doc exists" do
|
94
|
+
@ct.create_document({'_id' => 'chicken', :food => 'corn'})
|
95
|
+
@ct.document_exists?('chicken').must_equal true
|
96
|
+
end
|
97
|
+
|
98
|
+
it "must return false if doc does not exist" do
|
99
|
+
@ct.document_exists?('turkey').must_equal false
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
end
|
data/test/test_helper.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Copyright (c) 2015 Quantdeck Systems Ltd. All rights reserved.
|
2
|
+
#
|
3
|
+
# This program is licensed to you under the Apache License Version 2.0,
|
4
|
+
# and you may not use this file except in compliance with the Apache License Version 2.0.
|
5
|
+
# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
|
6
|
+
#
|
7
|
+
# Unless required by applicable law or agreed to in writing,
|
8
|
+
# software distributed under the Apache License Version 2.0 is distributed on an
|
9
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
10
|
+
# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
|
11
|
+
|
12
|
+
# Author:: Iain Gray (mailto:support@quantdeck.com)
|
13
|
+
# Copyright:: Copyright (c) 2015 Quantdeck Systems Ltd
|
14
|
+
# License:: Apache License Version 2.0
|
15
|
+
|
16
|
+
|
17
|
+
require 'minitest/spec'
|
18
|
+
require 'minitest/autorun'
|
19
|
+
require 'minitest/pride'
|
20
|
+
require 'couch_crud'
|
21
|
+
|
22
|
+
COUCHDB_URL = ENV['CLOUDANT_TEST_URL'] || "http://127.0.0.1:5984/couch-crud-test"
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: couch_crud
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Iain Gray
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-02-15 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: contracts
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0.6'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0.6'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: couchrest
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.2'
|
62
|
+
- - ">="
|
63
|
+
- !ruby/object:Gem::Version
|
64
|
+
version: 1.2.0
|
65
|
+
type: :runtime
|
66
|
+
prerelease: false
|
67
|
+
version_requirements: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - "~>"
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: '1.2'
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 1.2.0
|
75
|
+
description: couch_crud provides a minimal, simple Couchdb CRUD layer using couchrest
|
76
|
+
email:
|
77
|
+
- support@quantdeck.com
|
78
|
+
executables: []
|
79
|
+
extensions: []
|
80
|
+
extra_rdoc_files: []
|
81
|
+
files:
|
82
|
+
- ".gitignore"
|
83
|
+
- Gemfile
|
84
|
+
- LICENSE.txt
|
85
|
+
- README.md
|
86
|
+
- Rakefile
|
87
|
+
- couch_crud.gemspec
|
88
|
+
- lib/couch_crud.rb
|
89
|
+
- lib/couch_crud/errors.rb
|
90
|
+
- lib/couch_crud/version.rb
|
91
|
+
- test/couch_crud_test.rb
|
92
|
+
- test/test_helper.rb
|
93
|
+
homepage: https://github.com/quantdeck/couch_crud
|
94
|
+
licenses:
|
95
|
+
- Apache
|
96
|
+
metadata: {}
|
97
|
+
post_install_message:
|
98
|
+
rdoc_options: []
|
99
|
+
require_paths:
|
100
|
+
- lib
|
101
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
requirements: []
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 2.2.2
|
114
|
+
signing_key:
|
115
|
+
specification_version: 4
|
116
|
+
summary: Mixin to provide basic CRUD operations for CouchDB
|
117
|
+
test_files:
|
118
|
+
- test/couch_crud_test.rb
|
119
|
+
- test/test_helper.rb
|