cloudant 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a87df45b55aa852bb16fbfaf68bb0846a3171f7
-  data.tar.gz: ea5973b00b7892677d321898c28cf5b8bde56ad8
+  metadata.gz: 617903591a37ae1748f18b5eae04fa09b888e1c9
+  data.tar.gz: f63d86f9d26940307786fcd17cb4bdf55c0c3ac5
 SHA512:
-  metadata.gz: e31e0d97dec43099293c76f4e24f83026be30aed88c12250ccbae1e41c2a09f9ce6b40d5a72f48e384210bb821cf778eee32c0cb2e070816c4509decc2783bde
-  data.tar.gz: 3f5c0abb9ccd099505256e0a03c20fd9fc6beff6902f7fe2ba5162f3ee5b60c7b65d94129aa40646fa634e02114dedadf26b9a56ee96d4e259247516d1b79b8a
+  metadata.gz: 24f9c643c868ec3cbc735640bc226b8ff92e5325bad4093c7c71b05743faa5f6be9100533841890fe7ddc9244b9261d90b322b015d69b1c2385bffae32edc844
+  data.tar.gz: d73ed0447c65737c12f60c0793edc85eff2c77185e917196c126be47ba3b23a6b8203092b6512ef35dd7d8fc94e6189eac129a9234c1b772c98b63f31c349694

data/README.md

@@ -6,7 +6,7 @@
 
 Ruby Cloudant is a simple Ruby interface for [IBM Cloudant's](https://cloudant.com/) API. Cloudant is a NoSQL database built on [CouchDB](http://couchdb.apache.org/).
 
-This gem is still in [development](##Contributing) and is a work in progress. 
+This gem is still in [development](#contributing) and is a work in progress. 
 
 ## Installation
 
@@ -102,7 +102,7 @@ client.update_docs(docs)
 # Deleting multiple docs
 client.delete_docs(docs)
 ```
-`:delete_docs` is a convenience method; deleting multiple documents at once is best performed by adding `['_deleted']` to each document and performing an update. [Bulk operations](https://docs.cloudant.com/document.html#bulk-operations)
+`:delete_docs` is a convenience method; this performs an update, adding `['_deleted']` to each document. [Bulk operations](https://docs.cloudant.com/document.html#bulk-operations)
 
 **Indices, Design Docs**
 ```ruby
@@ -147,6 +147,7 @@ client.view(database,view_to_query, :reduce => false, :include_docs => true)
 ```
 
 ## To Do
+
 - Add database replication functionality - `/_replicator`
 - Allow new user creation - `/_security`
 - Add more robust options handling for various queries (expanding the `QueryBuilder` module, as used in view querying)

data/lib/cloudant/client.rb

@@ -14,17 +14,19 @@ module Cloudant
     end
 
     # Retrieve all docs from the database
-    # Returns an array of hashes including ids, keys, and revs, unless :include_docs is passed
-    def all_docs(*include_docs)
+    def all_docs(*opts)
       q = "#{database}/_all_docs"
-      q << "?include_docs=true" if include_docs && include_docs.any? && include_docs.first == :include_docs
+      q << QueryBuilder.build(opts.first,"all_docs") if opts && opts.any? && opts.first.is_a?(Hash)
 
       @conn.query({url_path: q, method: :get})
     end
 
     # Accepts a single document id and returns it if found
-    def get_doc(id)
-      @conn.query({url_path: "#{database}/#{id}", method: :get})
+    def get_doc(id,*opts)
+      q = "#{database}/#{id}"
+      q << QueryBuilder.build(opts.first,"doc") if opts && opts.any? && opts.first.is_a?(Hash)
+
+      @conn.query({url_path: q, method: :get})
     end
     alias_method :get, :get_doc
     alias_method :doc, :get_doc
@@ -90,8 +92,11 @@ module Cloudant
     end
 
     # Get a hash {"results" => []}, containing a hash of seq, id, changes
-    def changes
-      @conn.query({url_path: "#{database}/_changes", method: :get})
+    def changes(*opts)
+      q = "#{database}/_changes"
+      q << QueryBuilder.build(opts.first,"changes") if opts && opts.any? && opts.first.is_a?(Hash)
+
+      @conn.query({url_path: q, method: :get})
     end
 
     # Returns all database for the current instance of Cloudant
@@ -184,7 +189,7 @@ module Cloudant
     end
 
     # Paginate query results - best for large volume.
-    # TODO: add feature that allows users to view previous pages and generall move into own class.
+    # TODO: add feature that allows users to view previous pages and generally move into own class.
     def bookmark_query(q,&blk)
       response = query(q)
       bookmark = response["bookmark"]

data/lib/cloudant/query_builder.rb

@@ -21,8 +21,15 @@ module Cloudant
 
       # TODO: This will be expanded to calls other than /_view.
       def get_fields(type)
-        if type == "view"
-          return [:reduce,:include_docs,:descending,:endkey,:endkey_docid,:group,:group_level,:inclusive_end,:key,:keys,:limit,:skip,:stale,:startkey,:startkey_docid]
+        case type
+          when "view"
+            return [:reduce,:include_docs,:descending,:endkey,:endkey_docid,:group,:group_level,:inclusive_end,:key,:keys,:limit,:skip,:stale,:startkey,:startkey_docid]  
+          when "all_docs"
+            return [:include_docs,:descending,:endkey,:conflicts,:inclusive_end,:key,:limit,:skip,:startkey,:keys]  
+          when "changes"
+            return [:include_docs,:descending,:feed,:filter,:heartbeat,:conflicts,:limit,:since,:style,:timeout,:doc_ids]  
+          when "doc"
+            return [:local_seq,:attachments,:att_encoding_info,:atts_since,:conflicts,:deleted_conflicts,:latest,:meta,:open_revs,:rev,:revs,:revs_info]  
         end
       end
     end

data/lib/cloudant/version.rb

@@ -1,3 +1,3 @@
 module Cloudant
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Yanai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler