Module: CouchRest

Extended by:
RestAPI
Defined in:
lib/couchrest.rb,
lib/couchrest/core/view.rb,
lib/couchrest/core/server.rb,
lib/couchrest/core/design.rb,
lib/couchrest/mixins/views.rb,
lib/couchrest/helper/pager.rb,
lib/couchrest/more/property.rb,
lib/couchrest/commands/push.rb,
lib/couchrest/core/document.rb,
lib/couchrest/core/database.rb,
lib/couchrest/core/response.rb,
lib/couchrest/more/typecast.rb,
lib/couchrest/helper/upgrade.rb,
lib/couchrest/helper/streamer.rb,
lib/couchrest/mixins/callbacks.rb,
lib/couchrest/mixins/validation.rb,
lib/couchrest/mixins/design_doc.rb,
lib/couchrest/commands/generate.rb,
lib/couchrest/more/casted_model.rb,
lib/couchrest/mixins/properties.rb,
lib/couchrest/mixins/collection.rb,
lib/couchrest/middlewares/logger.rb,
lib/couchrest/mixins/class_proxy.rb,
lib/couchrest/mixins/attachments.rb,
lib/couchrest/more/extended_document.rb,
lib/couchrest/mixins/document_queries.rb,
lib/couchrest/validation/auto_validate.rb,
lib/couchrest/mixins/attribute_protection.rb,
lib/couchrest/mixins/extended_attachments.rb,
lib/couchrest/validation/validation_errors.rb,
lib/couchrest/validation/contextual_validators.rb,
lib/couchrest/validation/validators/formats/url.rb,
lib/couchrest/validation/validators/formats/email.rb,
lib/couchrest/validation/validators/format_validator.rb,
lib/couchrest/validation/validators/method_validator.rb,
lib/couchrest/validation/validators/length_validator.rb,
lib/couchrest/validation/validators/numeric_validator.rb,
lib/couchrest/validation/validators/generic_validator.rb,
lib/couchrest/validation/validators/confirmation_validator.rb,
lib/couchrest/validation/validators/absent_field_validator.rb,
lib/couchrest/validation/validators/required_field_validator.rb

Overview

Extracted from dm-validations 0.9.10

Copyright (c) 2007 Guy van den Berg

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.

Defined Under Namespace

Modules: Callbacks, CastedModel, Commands, Mixins, More, Validation Classes: Database, Design, Document, ExtendedDocument, Logger, Pager, Property, Response, Server, Streamer, Upgrade, View

Constant Summary

VERSION = 
'0.37'

Class Method Summary (collapse)

Methods included from RestAPI

copy, delete, get, post, put

Class Method Details

+ (Object) constantize(camel_cased_word)

extracted from Extlib

Constantize tries to find a declared constant with the name specified in the string. It raises a NameError when the name is not in CamelCase or is not initialized.

"Module".constantize #=> Module "Class".constantize #=> Class



71
72
73
74
75
76
77
 
# File 'lib/couchrest.rb', line 71

def constantize(camel_cased_word)
  unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
    raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
  end

  Object.module_eval("::#{$1}", __FILE__, __LINE__)
end

+ (Object) database(url) 



145
146
147
148
149
 
# File 'lib/couchrest.rb', line 145

def database url
  parsed = parse url
  cr = CouchRest.new(parsed[:host])
  cr.database(parsed[:database])
end

+ (Object) database!(url)

ensure that a database exists creates it if it isn't already there returns it after it's been created



139
140
141
142
143
 
# File 'lib/couchrest.rb', line 139

def database! url
  parsed = parse url
  cr = CouchRest.new(parsed[:host])
  cr.database!(parsed[:database])
end

+ (Object) humanize(lower_case_and_underscored_word)

extracted from Extlib

Capitalizes the first word and turns underscores into spaces and strips _id. Like titleize, this is meant for creating pretty output.

Examples:

"employee_salary" #=> "Employee salary"
"author_id" #=> "Author"


87
88
89
 
# File 'lib/couchrest.rb', line 87

def humanize(lower_case_and_underscored_word)
  lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
end

+ (Object) new(*opts)

todo, make this parse the url and instantiate a Server or Database instance depending on the specificity.



93
94
95
 
# File 'lib/couchrest.rb', line 93

def new(*opts)
  Server.new(*opts)
end

+ (Object) paramify_url(url, params = {}) 



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/couchrest.rb', line 151

def paramify_url url, params = {}
  if params && !params.empty?
    query = params.collect do |k,v|
      v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
      "#{k}=#{CGI.escape(v.to_s)}"
    end.join("&")
    url = "#{url}?#{query}"
  end
  url
end

+ (Object) parse(url) 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/couchrest.rb', line 97

def parse url
  case url
  when /^(https?:\/\/)(.*)\/(.*)\/(.*)/
    scheme = $1
    host = $2
    db = $3
    docid = $4
  when /^(https?:\/\/)(.*)\/(.*)/
    scheme = $1
    host = $2
    db = $3
  when /^(https?:\/\/)(.*)/
    scheme = $1
    host = $2
  when /(.*)\/(.*)\/(.*)/
    host = $1
    db = $2
    docid = $3
  when /(.*)\/(.*)/
    host = $1
    db = $2
  else
    db = url
  end

  db = nil if db && db.empty?
  
  {
    :host => (scheme || "http://") + (host || "127.0.0.1:5984"),
    :database => db,
    :doc => docid
  }
end

+ (Object) proxy(url)

set proxy to use



132
133
134
 
# File 'lib/couchrest.rb', line 132

def proxy url
  HttpAbstraction.proxy = url
end