couchrest_model_cloudant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e4487cd66c2c929e8d1757784b097c8bd82ad49
+  data.tar.gz: 1b70f2dd182d0685de13fcda256dc8b08354d981
+SHA512:
+  metadata.gz: b98173c6222298b4708eb93028e28e5be2874a521614d9735765bb5d3691b6574eebbd0ca67f8ec42d2e97d646dd305edd7d5cc0b5bf36a1b2c5d165e62a51b5
+  data.tar.gz: 73109439d3cd69694e2391a1f9f81423805dd2f63b66f9f1d269078dd349430b3b47e6a79524599a13f2d59d7538a24e6fea7c2055d36c79d658b2be496e979f

data/Gemfile

@@ -0,0 +1,5 @@
+
+source "https://rubygems.org"
+gem 'couchrest_model'
+gem 'shoulda'
+

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,72 @@
+couchrest_model_cloudant
+========================
+
+Extends couchrest_model adding support for the Cloudant Search API
+
+https://cloudant.com/for-developers/search/
+
+## Install
+
+### Gem
+
+    $ sudo gem install couchrest_model_cloudant
+
+### Bundler
+
+If you're using bundler, define a line similar to the following in your project's Gemfile:
+
+    gem 'couchrest_model_cloudant'
+
+
+### General Usage
+
+Define an index
+
+    require 'couchrest_model_cloudant'
+
+    class User < CouchRest::Model::Base
+      property :email,                String
+      property :gender,              String, :default => 'f'
+
+      design do
+        index :users, :index => 'function(doc){
+           index("email", doc.email, {"store": "yes"});
+           index("gender", doc.gender);
+          }'
+       end
+     end
+
+Query an index getting back casted models
+
+    @users = User.search('users', 'gender:Female', :limit => 20, :sort => 'email<string>', :include_docs => true)
+
+    @users.size => 20
+    @users.total_rows => 99 
+    @users.bookmark => 'loripepsomdkjdfkdfjdfjkdfjkdfj'
+    @users.first.class => User
+
+It's also possible to query an index getting back raw results parsed directly from the JSON without casting
+
+    res = User.database.search("User", "users", "gender:Female", :limit => 20)
+    res['total_rows'] => 99
+
+
+## Development
+
+
+### Testing
+
+couchrest_model_cloudant comes with a Gemfile to help with development. If you want to make changes to the code, download a copy then run:
+
+    bundle install
+
+That should set everything up for `rake` to be run correctly which will launch the test suite.  
+
+
+
+## Contact
+
+Please post bugs, suggestions and patches to the bug tracker at [http://github.com/gxbe/couchrest_model_cloudant/issues](http://github.com/gxbe/couchrest_model_cloudant/issues).
+
+
+

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "couchrest_model_cloudant #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/couchrest_model_cloudant.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = %q{couchrest_model_cloudant}
+  s.version = '0.1.0'
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe Malicki"]
+  s.date = '2013-10-10'
+  s.description = %q{Extends couchrest_model to provide support for creating and querying Cloudant Search indexes.}
+  s.email = %q{triumph@hushmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.license = 'Apache'
+  s.homepage = %q{http://github.com/gxbe/couchrest_model_cloudant}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Extends couchrest_model adding support for the Cloudant Search API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency(%q<couchrest_model>, ">= 2.0.0")
+end

data/lib/couchrest_model_cloudant.rb

@@ -0,0 +1,64 @@
+require 'couchrest_model'
+
+######## CLOUDANT INDEX HANDLING ########
+class CouchRest::Model::Design
+  def create_index(name, function)
+    indexes = (self['indexes'] ||= {})
+    indexes[name.to_s] = function
+  end
+end
+
+class CouchRest::Model::Designs::DesignMapper
+  def index(name, function)
+    design_doc.create_index(name, function)
+  end
+end
+
+######## CLOUDANT SEARCH QUERYING ######
+class CouchRest::Database
+  def search(design, index, query, options={})
+    CouchRest.get CouchRest.paramify_url("#{@root}/_design/#{design}/_search/#{index}", options.merge(:q => query))
+  end
+end
+
+class CouchRest::Model::SearchResults
+  include Enumerable
+
+  attr_accessor :total_rows, :bookmark
+
+  def initialize(total_rows, bookmark, objects)
+    @total_rows = total_rows
+    @bookmark = bookmark
+    @objects = objects
+  end
+
+  def each
+    @objects.each do |member|
+      yield member
+    end
+  end
+end
+
+# 
+# Execute a cloudant search query.
+# if you are not using the :include_docs option then your indexes must be named to
+# match document properties otherwise they cannot be casted into document models.  
+#
+class CouchRest::Model::Base
+  def self.search(index, query, options={})
+    if options[:sort]
+      options[:sort] = '"' + options[:sort] + '"'
+    end
+    if options['sort']
+      options['sort'] = '"' + options['sort'] + '"'
+    end
+    ret = self.database.search(self.to_s, index, query, options)
+    rows = ret['rows']
+     if options[:include_docs] == true || options['include_docs'] == true
+      objects = rows.map {|r| obj = self.new(r['doc']) }
+    else
+      objects = rows.map {|r| obj = self.new(r['fields']); obj.id = r['id']; obj }
+    end
+    CouchRest::Model::SearchResults.new(ret['total_rows'], ret['bookmark'], objects)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'couchrest_model_cloudant'
+
+class Test::Unit::TestCase
+end

data/test/test_couchrest_model_cloudant.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+# fixture
+class DesignModel < CouchRest::Model::Base
+  property :email
+end
+
+class TestCouchrestModelCloudant < Test::Unit::TestCase
+
+  should "should add the #index method to a design document" do
+    @klass = CouchRest::Model::Designs::DesignMapper
+    @object = @klass.new(DesignModel)
+    @object.index(:important, 'function(doc){ index("email", doc._id); }')
+    assert_not_nil DesignModel.design_doc['indexes']
+    assert_not_equal DesignModel.design_doc['indexes'], []
+    assert_not_equal DesignModel.design_doc['indexes'], ''
+  end
+
+  should "add the search method to a model class" do
+    assert_respond_to DesignModel, :search
+  end
+
+  should "add the search method to the model's database class" do
+    assert_respond_to DesignModel.database, :search
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: couchrest_model_cloudant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabe Malicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Extends couchrest_model to provide support for creating and querying
+  Cloudant Search indexes.
+email: triumph@hushmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- couchrest_model_cloudant.gemspec
+- lib/couchrest_model_cloudant.rb
+- test/helper.rb
+- test/test_couchrest_model_cloudant.rb
+homepage: http://github.com/gxbe/couchrest_model_cloudant
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Extends couchrest_model adding support for the Cloudant Search API
+test_files:
+- test/helper.rb
+- test/test_couchrest_model_cloudant.rb