cloudant 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad5b5cd110b37dca3817af668014ebb8744b1562
-  data.tar.gz: 79fc72e582dc8bf1e087b2e0e79e757e95a4015e
+  metadata.gz: 99609d3fa61ccfd3fa8046ea0af2610f81ee7c79
+  data.tar.gz: 16d69b0453ef9949469bbdb88c1e9b69799ba5e8
 SHA512:
-  metadata.gz: 2cd186a5327fc5c86a79cc983babbbb14d6c4e4a101888ba9119acbab8574c1c3e574e6a0f04800a0322f6048543b6d553fd4cc1338b4ef89f36a448f133ce7e
-  data.tar.gz: 120d73762c1aed47893600a6241f3708a4f478adeef3de15fe7fc87522651f523dcc0fbe2a9b9abab4fcb894e995b6f16cf2c125c8f4d75a678c703c29528f7b
+  metadata.gz: 04511a9264ea1ccdbd53b417c8d09be5d8484552f5bb00a3c9da86a3464b3fe87b17d3b24df8f262b4ffce2b0a7497b1581cdf531d45f75babfd322231e416d6
+  data.tar.gz: 4b911e228bfcb476c949de5d2f1c632022bd7bac3080bdd9e4ff0cd319941e109cd747662ee48a7bce1745280496f9c3a2b129f805a7c45e5961383424339a17

data/README.md

@@ -169,7 +169,7 @@ username = "test_user"
 client.delete_user(username)
 ```
 
-**Database Replication and Sync)**
+**Database Replication and Sync**
 ```ruby
 # View Active tasks (including replications)
 client.active_tasks
@@ -177,22 +177,49 @@ client.active_tasks
 # Replicate a database
 # The default options are {:create_target => true, :continuous => false}, meaning that
 # the first argument provided will be the name of the target database, and it will be
-# newly created. If the database already exists, set :continuous => false
+# newly created. If the database already exists, set :create_target => false
 client.replicate_db("test_2")
 
 # More options can be passed, for example: 
 client.replicate_db("test_2", {:continuous => true, :user_ctx => {"name" => "test_user", "roles" => ["admin"]}})
 
+# Replication defualts to the datbase initially set; a different source can be used by calling :replicate_dbs
+client.replicate_dbs("test_2", "test_3", {:continuous => true, :user_ctx => {"name" => "test_user", "roles" => ["admin"]}})
+
 # Sync a database (replicate a database with :continuous => true)
 client.sync("test_2")
+
+# To stop a replication, delete the replication doc as you would any other document
+client.delete_doc(doc_id)
+```
+
+**Attachments**
+```ruby
+# Type refers to the MIME type of the attachment.
+args = {
+  :id   => "test_doc",
+  :name => "test_attachment",
+  :type => "text/html",
+  :rev  => "1-f53050cbc4e66a4dcf6db59a9e0bc6b",
+  :path => "./test.html"
+}
+
+# Create an attachment on an existing document. If no rev is given, a call will be made to get the document and extract the rev.
+client.create_attachment(args)
+client.update_attachment(args) # Alias of :create_attachment
+
+# Get the attachments associated with a document. The :name field is the name of the attachment to be retrieved.
+client.read_attachment(:id => "test_doc", :name => "test_attachment")
+
+# Delete an attachment. The current rev is required.
+client.delete_attachment(:id => "test_doc", :name => "test_attachment", :rev => "2-b52037c9456d75e05f718c1286d63bf6")
 ```
 
 ## To Do
 
-- Add support for `attachments`
-- Expand database replication functionality - `/_replicator`
 - Add more robust options handling for various queries (expanding the `QueryBuilder` module, as used in view querying)
-    -   Currently, options have to be added to a query string by the user.
+  - Currently, options have to be added to a query string by the user.
+- Expand the `Replication` module.
 
 ## Contributing
 

data/lib/cloudant.rb

@@ -8,6 +8,7 @@ require "cloudant/utility"
 require "cloudant/query_builder"
 require "cloudant/security"
 require "cloudant/replicator"
+require "cloudant/attachment"
 require "cloudant/api"
 require "cloudant/client"
 require "cloudant/connection"

data/lib/cloudant/api.rb

@@ -4,5 +4,6 @@ module Cloudant
     include Cloudant::QueryBuilder
     include Cloudant::Security
     include Cloudant::Replicator
+    include Cloudant::Attachment
   end
 end

data/lib/cloudant/attachment.rb

@@ -0,0 +1,64 @@
+module Cloudant
+  module Attachment
+    # The Attachment Module contains methods to interact with document attachments.
+    #
+    # Add an attachment to an existing document. 
+    # Accepts the document id, the MIME type (ie: image/jpg), and the name for the attachment
+    # a rev field is also required (and suggested), but if not, the document is searched and rev extracted
+    def create_attachment(args)
+      if args[:id]
+        args[:rev] = get_current_rev(args[:id]) unless args[:rev]
+        attachment = Cloudant::Attachment.make_attachment(args)
+        query_str  = build_attachment_query(args)
+
+        @conn.query({url_path: query_str, opts: attachment, method: :put})
+      end
+    end
+    alias_method :update_attachment, :create_attachment
+
+    # Read a document's attachments.
+    # Accepts a document id and the name of an attachment associated with that doc.
+    def read_attachment(args)
+      query_str = build_attachment_query(args)
+      
+      @conn.query({url_path: query_str, method: :get})
+    end
+
+    # Delete a document's attachment.
+    # Accepts a document id, the rev in question, and the name of an attachment associated with that doc.
+    def delete_attachment(args)
+      query_str = build_attachment_query(args)
+      
+      @conn.query({url_path: query_str, method: :delete})
+    end
+
+    # Accepts a Hash including :doc => the name of the doc to which the attachment will be attached,
+    # file_name, the name to be given to the attachment, the doc's content type, and the attachment's
+    # file type.
+    # Returns attachment to be uploaded
+    def self.make_attachment(args)
+      doc_name  = args[:id]
+      file_name = args[:name]
+      file_type = args[:type]
+      file_path = args[:path]
+
+      attachment = {
+        "_id" => doc_name,
+        "_attachments" => {
+          file_name => {
+            "content_type" => file_type
+          }
+        }
+      }
+
+      if File.exists?(file_path)
+        data = File.open(file_path,'rb').read
+        attachment["_attachments"][file_name]["data"] = data
+      else
+        raise Errno::ENOENT.new('file does not exist')
+      end
+
+      attachment
+    end
+  end
+end

data/lib/cloudant/client.rb

@@ -32,6 +32,11 @@ module Cloudant
     alias_method :get, :get_doc
     alias_method :doc, :get_doc
 
+    def get_current_rev(doc)
+      retrieved = get_doc(doc)
+      retrieved["_rev"]
+    end
+
     # A valid doc must be provided. The doc must be a hash that can.
     # Use create_docs to create multiple documents at once.
     def create_doc(doc)
@@ -140,8 +145,8 @@ module Cloudant
       
       args[:index] ? new_index["index"] = args[:index] : new_index["index"] = {}
       
-      new_index["name"]  = args[:name] if args[:name]
-      new_index["ddoc"]  = args[:ddoc] if args[:ddoc]
+      new_index["name"] = args[:name] if args[:name]
+      new_index["ddoc"] = args[:ddoc] if args[:ddoc]
 
       args[:type] ? new_index["type"] = args[:type] : new_index["type"] = "text"
 

data/lib/cloudant/query_builder.rb

@@ -29,5 +29,15 @@ module Cloudant
           return [:local_seq,:attachments,:att_encoding_info,:atts_since,:conflicts,:deleted_conflicts,:latest,:meta,:open_revs,:rev,:revs,:revs_info]  
       end
     end
+
+    # Built the query string for attachments
+    def build_attachment_query(args)
+      q = ""
+      q << "#{database}"
+      q << "/#{args[:id]}"
+      q << "/#{args[:name]}"
+      q << "?rev=#{args[:rev]}" if args[:rev]
+      q
+    end
   end
 end

data/lib/cloudant/replicator.rb

@@ -7,27 +7,48 @@ module Cloudant
       @conn.query({url_path: "_active_tasks", opts: {"type" => type}, method: :get})
     end
 
+    # Accepts a string, the name of a database towards which to replicate the database. and 
+    # optionally a hash of options for creating the replication doc.
     def replicate_db(target,*opts)
       opts && opts[0] ? options = opts[0] : options = {}
+      options[:source] = database
+      options[:target] = target
+      
+      replication(options)
+    end
 
+    # Allows database replication between 2 databses instead of defaulting to the set database.
+    def replicate_dbs(source,target,*opts)
+      opts && opts[0] ? options = opts[0] : options = {}
+      options[:source] = source
       options[:target] = target
-      replication_doc  = build_doc(options)
-      doc_name = Cloudant::Utility.generate_doc_name(database,target)
-      @conn.query({url_path: "_replicator/#{doc_name}", opts: replication_doc, method: :put})
+      
+      replication(options)
     end
 
+    # Sets the database to repliacte the 2 databases continuously.
     def sync(target)
       replicate_db(target,{:continuous => true, :create_target => true})
     end
 
+    # Method accepts options for replication document and builds query
+    def replication(args)
+      replication_doc = build_doc(args)
+
+      doc_name = Cloudant::Utility.generate_doc_name(args[:source],args[:target])
+      @conn.query({url_path: "_replicator/#{doc_name}", opts: replication_doc, method: :put})
+    end
+
+    # The default options assume that the target database does not exist and the replication
+    # will be one-time only.
     def build_doc(opts)
       fields = [:continuous,:create_target,:doc_ids,:filter,:proxy,:selector,:since_seq,:use_checkpoints,:user_ctx]
 
       replication_doc = {
-        :source => "https://#{username}:#{password}@#{username}.cloudant.com/#{database}",
-        :target => "https://#{username}:#{password}@#{username}.cloudant.com/#{opts[:target]}",
+        :source        => "https://#{username}:#{password}@#{username}.cloudant.com/#{opts[:source]}",
+        :target        => "https://#{username}:#{password}@#{username}.cloudant.com/#{opts[:target]}",
         :create_target => true,
-        :continuous => false
+        :continuous    => false
       }  
 
       fields.each do |field|

data/lib/cloudant/version.rb

@@ -1,3 +1,3 @@
 module Cloudant
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudant
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alex Yanai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-22 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,7 @@ files:
 - cloudant.gemspec
 - lib/cloudant.rb
 - lib/cloudant/api.rb
+- lib/cloudant/attachment.rb
 - lib/cloudant/client.rb
 - lib/cloudant/connection.rb
 - lib/cloudant/query_builder.rb