topfunky-couchrest 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. data/LICENSE +176 -0
  2. data/README.rdoc +51 -0
  3. data/Rakefile +87 -0
  4. data/THANKS +15 -0
  5. data/bin/couchdir +20 -0
  6. data/bin/couchview +48 -0
  7. data/examples/word_count/markov +38 -0
  8. data/examples/word_count/views/books/chunked-map.js +3 -0
  9. data/examples/word_count/views/books/united-map.js +1 -0
  10. data/examples/word_count/views/markov/chain-map.js +6 -0
  11. data/examples/word_count/views/markov/chain-reduce.js +7 -0
  12. data/examples/word_count/views/word_count/count-map.js +6 -0
  13. data/examples/word_count/views/word_count/count-reduce.js +3 -0
  14. data/examples/word_count/word_count.rb +67 -0
  15. data/examples/word_count/word_count_query.rb +39 -0
  16. data/lib/couchrest.rb +92 -0
  17. data/lib/couchrest/commands/generate.rb +71 -0
  18. data/lib/couchrest/commands/push.rb +99 -0
  19. data/lib/couchrest/core/database.rb +105 -0
  20. data/lib/couchrest/core/server.rb +49 -0
  21. data/lib/couchrest/helper/file_manager.rb +223 -0
  22. data/lib/couchrest/helper/pager.rb +103 -0
  23. data/lib/couchrest/helper/streamer.rb +29 -0
  24. data/lib/couchrest/monkeypatches.rb +22 -0
  25. data/spec/couchrest_spec.rb +92 -0
  26. data/spec/database_spec.rb +429 -0
  27. data/spec/file_manager_spec.rb +116 -0
  28. data/spec/fixtures/attachments/test.html +11 -0
  29. data/spec/fixtures/views/lib.js +3 -0
  30. data/spec/fixtures/views/test_view/lib.js +3 -0
  31. data/spec/fixtures/views/test_view/only-map.js +4 -0
  32. data/spec/fixtures/views/test_view/test-map.js +3 -0
  33. data/spec/fixtures/views/test_view/test-reduce.js +3 -0
  34. data/spec/pager_spec.rb +122 -0
  35. data/spec/spec.opts +6 -0
  36. data/spec/spec_helper.rb +4 -0
  37. data/spec/streamer_spec.rb +23 -0
  38. data/utils/remap.rb +27 -0
  39. data/utils/subset.rb +30 -0
  40. metadata +124 -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,51 @@
1
+ == CouchRest - CouchDB, close to the metal
2
+
3
+ CouchRest is based on [CouchDB's couch.js test library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js), which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.
4
+
5
+ CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
6
+
7
+ === Easy Install
8
+
9
+ sudo gem install jchris-couchrest -s http://gems.github.com
10
+
11
+ === Relax, it's RESTful
12
+
13
+ The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined web service.
14
+
15
+ === Running the Specs
16
+
17
+ The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `rake`, or `autotest` (requires RSpec and optionally ZenTest for autotest support).
18
+
19
+ === Examples
20
+
21
+ Quick Start:
22
+
23
+ # with !, it creates the database if it doesn't already exist
24
+ @db = CouchRest.database!("http://localhost:5984/couchrest-test")
25
+ response = @db.save({:key => 'value', 'another key' => 'another value'})
26
+ doc = @db.get(response['id'])
27
+ puts doc.inspect
28
+
29
+ Bulk Save:
30
+
31
+ @db.bulk_save([
32
+ {"wild" => "and random"},
33
+ {"mild" => "yet local"},
34
+ {"another" => ["set","of","keys"]}
35
+ ])
36
+ # returns ids and revs of the current docs
37
+ puts @db.documents.inspect
38
+
39
+ Creating and Querying Views:
40
+
41
+ @db.save({
42
+ "_id" => "_design/first",
43
+ :views => {
44
+ :test => {
45
+ :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
46
+ }
47
+ }
48
+ })
49
+ puts @db.view('first/test')['rows'].inspect
50
+
51
+
data/Rakefile ADDED
@@ -0,0 +1,87 @@
1
+ require 'rake'
2
+ require "rake/rdoctask"
3
+ require 'spec/rake/spectask'
4
+
5
+
6
+ spec = Gem::Specification.new do |s|
7
+ s.name = "couchrest"
8
+ s.version = "0.9.4"
9
+ s.date = "2008-09-11"
10
+ s.summary = "Lean and RESTful interface to CouchDB."
11
+ s.email = "jchris@grabb.it"
12
+ s.homepage = "http://github.com/jchris/couchrest"
13
+ s.description = "CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments."
14
+ s.has_rdoc = true
15
+ s.authors = ["J. Chris Anderson"]
16
+ s.files = %w( LICENSE README.rdoc Rakefile THANKS ) + Dir["{bin,examples,lib,spec,utils}/**/*"]
17
+ s.extra_rdoc_files = %w( README.rdoc LICENSE THANKS )
18
+ s.require_path = "lib"
19
+ s.bindir = 'bin'
20
+ s.executables << 'couchview'
21
+ s.executables << 'couchdir'
22
+ s.add_dependency("json", ">= 1.1.2")
23
+ s.add_dependency("rest-client", ">= 0.5")
24
+ end
25
+
26
+ namespace :github do # thanks merb!
27
+ desc "Update Github Gemspec"
28
+ task :update_gemspec do
29
+ skip_fields = %w(new_platform original_platform)
30
+ integer_fields = %w(specification_version)
31
+
32
+ result = "Gem::Specification.new do |s|\n"
33
+ spec.instance_variables.each do |ivar|
34
+ value = spec.instance_variable_get(ivar)
35
+ name = ivar.split("@").last
36
+ next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
37
+ if name == "dependencies"
38
+ value.each do |d|
39
+ puts d.to_s
40
+ dep, *ver = d.to_s.split(" ")
41
+ result << " s.add_dependency #{dep.inspect}, [#{ /\(([^\,]*)/ . match(ver.join(" "))[1].inspect}]\n"
42
+ end
43
+ else
44
+ case value
45
+ when Array
46
+ value = name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
47
+ when Fixnum
48
+ # leave as-is
49
+ when String
50
+ value = value.to_i if integer_fields.include?(name)
51
+ value = value.inspect
52
+ else
53
+ value = value.to_s.inspect
54
+ end
55
+ result << " s.#{name} = #{value}\n"
56
+ end
57
+ end
58
+ result << "end"
59
+ File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
60
+ end
61
+ end
62
+
63
+ desc "Run all specs"
64
+ Spec::Rake::SpecTask.new('spec') do |t|
65
+ t.spec_files = FileList['spec/*_spec.rb']
66
+ end
67
+
68
+ desc "Print specdocs"
69
+ Spec::Rake::SpecTask.new(:doc) do |t|
70
+ t.spec_opts = ["--format", "specdoc", "--dry-run"]
71
+ t.spec_files = FileList['spec/*_spec.rb']
72
+ end
73
+
74
+ desc "Generate the rdoc"
75
+ Rake::RDocTask.new do |rdoc|
76
+ files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
77
+ rdoc.rdoc_files.add(files)
78
+ rdoc.main = "README.rdoc"
79
+ rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
80
+ end
81
+
82
+ desc "Generate the gemspec"
83
+
84
+
85
+
86
+
87
+ task :default => :spec
data/THANKS ADDED
@@ -0,0 +1,15 @@
1
+ CouchRest THANKS
2
+ =====================
3
+
4
+ CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
5
+ and a number of other contributors. Many people further contributed to
6
+ CouchRest by reporting problems, suggesting various improvements or submitting
7
+ changes. A list of these people is included below.
8
+
9
+ * Greg Borenstein <http://ideasfordozens.com>
10
+ * Geoffrey Grosenbach <http://nubyonrails.com/>
11
+ * Simon Rozet <simon /at/ rozet /dot/ name>
12
+
13
+ Patches are welcome. The primary source for this software project is:
14
+
15
+ http://github.com/jchris/couchrest/tree/master
data/bin/couchdir ADDED
@@ -0,0 +1,20 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ unless ARGV.length >= 2
4
+ puts "usage: couchdir path/to/directory db-name [docid]"
5
+ exit
6
+ end
7
+
8
+ require 'rubygems'
9
+ require 'couchrest'
10
+
11
+ dirname = ARGV[0]
12
+ dbname = ARGV[1]
13
+ docid = ARGV[2]
14
+
15
+ puts "Create attachments for the files in #{dirname} in database #{dbname}."
16
+
17
+ fm = CouchRest::FileManager.new(dbname)
18
+ fm.loud = true
19
+ puts "Pushing views from directory #{dirname} to database #{fm.db}"
20
+ fm.push_directory(dirname, docid)
data/bin/couchview ADDED
@@ -0,0 +1,48 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'optparse'
4
+ require 'couchrest'
5
+
6
+ %w(generate push).each do |file|
7
+ require File.dirname(__FILE__) + "/../lib/couchrest/commands/#{file}"
8
+ end
9
+
10
+ # Set defaults
11
+ options = {
12
+ :loud => true,
13
+ }
14
+
15
+ opts = OptionParser.new do |opts|
16
+ opts.banner = "Usage: #$0 [options] (push|generate) directory database"
17
+ opts.on('-q', '--quiet', "Omit extra debug info") do
18
+ options[:loud] = false
19
+ end
20
+ opts.on_tail('-h', '--help [push|generate]', "Display detailed help and exit") do |help_command|
21
+ puts opts
22
+ case help_command
23
+ when "push"
24
+ puts CouchRest::Commands::Push.help
25
+ when "generate"
26
+ puts CouchRest::Commands::Generate.help
27
+ end
28
+ exit
29
+ end
30
+ end
31
+ opts.parse!(ARGV)
32
+
33
+ options[:command] = ARGV.shift
34
+ options[:directory] = ARGV.shift
35
+ options[:trailing_args] = ARGV
36
+
37
+ # There must be a better way to check for extra required args
38
+ unless (["push", "generate"].include?(options[:command]) && options[:directory] && options[:trailing_args])
39
+ puts(opts)
40
+ exit
41
+ end
42
+
43
+ case options[:command]
44
+ when "push"
45
+ CouchRest::Commands::Push.run(options)
46
+ when "generate"
47
+ CouchRest::Commands::Generate.run(options)
48
+ end
@@ -0,0 +1,38 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require File.expand_path(File.dirname(__FILE__)) + '/../../couchrest'
4
+
5
+ cr = CouchRest.new("http://localhost:5984")
6
+ @db = cr.database('word-count-example')
7
+ @word_memoizer = {}
8
+
9
+ def probable_follower_for(word)
10
+ @word_memoizer[word] ||= @db.view('markov/chain-reduce', :startkey => [word,nil], :endkey => [word,{}],:group_level => 2)
11
+
12
+ # puts
13
+ # puts "search #{word} #{wprobs[word]['rows'].length}"
14
+ # @word_memoizer[word]['rows'].sort_by{|r|r['value']}.each{|r|puts [r['value'],r['key']].inspect}
15
+
16
+ rows = @word_memoizer[word]['rows'].select{|r|(r['key'][1]!='')}.sort_by{|r|r['value']}
17
+ row = rows[(-1*[rows.length,5].min)..-1].sort_by{rand}[0]
18
+ row ? row['key'][1] : nil
19
+ end
20
+
21
+
22
+ word = ARGV[0]
23
+ words = [word]
24
+
25
+ while word
26
+ $stdout.print ' ' if words.length > 1
27
+ $stdout.print word
28
+ $stdout.flush
29
+ word = probable_follower_for(word)
30
+ words << word
31
+ end
32
+
33
+ $stdout.print '.'
34
+ $stdout.flush
35
+ puts
36
+
37
+ # `say #{words.join(' ')}`
38
+
@@ -0,0 +1,3 @@
1
+ function(doc) {
2
+ doc.title && doc.chunk && emit([doc.title, doc.chunk],null);
3
+ }