cloudant 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 323e21dbdef047f55e8659ab87b86849773f33bd
-  data.tar.gz: de9591fe10e75a28b093a6650ab3e82f2c6c854f
+  metadata.gz: ad5b5cd110b37dca3817af668014ebb8744b1562
+  data.tar.gz: 79fc72e582dc8bf1e087b2e0e79e757e95a4015e
 SHA512:
-  metadata.gz: d7965e9c118e21a7dc576b6bdee230ef47503b76fe434eb9b90068f8c9aa00bb756fbc6828874a5c507ade1ca86f276852a00aebf990c105f55248b7c4dc8857
-  data.tar.gz: 8306676a225c5d36ffff93a7c230d80f78f2425fe2e1f2de80c09908b3c7aa7aec32459f0dd33714827e1ee2c3814f64392b35ad77d21a876b5fa753f1b4a8ec
+  metadata.gz: 2cd186a5327fc5c86a79cc983babbbb14d6c4e4a101888ba9119acbab8574c1c3e574e6a0f04800a0322f6048543b6d553fd4cc1338b4ef89f36a448f133ce7e
+  data.tar.gz: 120d73762c1aed47893600a6241f3708a4f478adeef3de15fe7fc87522651f523dcc0fbe2a9b9abab4fcb894e995b6f16cf2c125c8f4d75a678c703c29528f7b

data/README.md

@@ -119,7 +119,7 @@ ddoc = {'language' => 'javascript', 'views' => {} }
 client.create_design_doc('test',ddoc)
 ```
 
-**[Querying](https://docs.cloudant.com/cloudant_query.html#finding-documents-using-an-index)**
+**[Querying](https://docs.cloudant.com/cloudant_query.html#finding-documents-using-an-index)** a database
 ```ruby
 # Perform a single query
 q = {'selector': {'test_field': {'$exists': true}},'fields': ['_id', '_rev'],'limit': 1,'skip': 0}
@@ -132,19 +132,19 @@ client.bookmark_query(q) do |docs|
 end
 ```
 
-**[Views](https://docs.cloudant.com/creating_views.html#using-views)**
+**[Views (MapReduce)](https://docs.cloudant.com/creating_views.html#using-views)**
 ```ruby
 # Creating a view
-client.create_view('test',{"current"=>{"reduce"=>"_count","map"=>"function (doc) {\n  if (doc.status === \"name\") {\n    emit(doc._id,1);\n  }\n}"}})
+client.create_view('test',{"current"=>{"reduce"=>"_count","map"=>"function (doc) {\n  if (doc.field_type === \"name\") {\n    emit(doc._id,1);\n  }\n}"}})
 
 # Querying an existing view
 database = 'test'
-view_to_query = 'current'
+view_name = 'current'
 
-client.view(database,view_to_query) # If a reduce function is given will return a 'rows' array with a single record, the value of the reduce
+client.view(database,view_name) # If a reduce function is given will return a 'rows' array with a single record, the value of the reduce
 # => {"rows"=>[{"key"=>nil, "value"=>2}]} 
 
-client.view(database,view_to_query, :reduce => false, :include_docs => true)
+client.view(database,view_name, :reduce => false, :include_docs => true)
 # => {"total_rows"=>2, "offset"=>0, "rows"=>[{"id"=>"5d8e6c99198dfdde8accd8e019ba052", "key"=>"5d8e6c99198dfdde8accd8e019ba052", "value"=>1, "doc"=>{"_id"=>"5d8e6c99198dfdde8accd8e019ba052", "_rev"=>"1-7ebdb5b82e1cc4eaf2e27a711e9857c6", "a"=>10, "b"=>92, "c"=>31}}, {"id"=>"5d8e6c99898dcdd08accd8e019badab", "key"=>"5d8e6c99898dcdd0daccd8e019badab", "value"=>1, "doc"=>{"_id"=>"5d8e6c99898dcdd8daccd8e019badab", "_rev"=>"1-d36298f4391da575df61e170af2efa34", "b"=>12, "c"=>33}}]}
 ```
 
@@ -160,15 +160,39 @@ client.roles
 client.create_api_keys
 
 # Create a new user and assign it one or more permissions
-client.new_user(["reader", "writer"])
+# Will return the credentials of the newly created user as well
+client.new_user(["reader", "writer"]) 
+# => {"password" => "str", "key" => "str", "ok" => true, "roles": ["_reader","_writer"]}
+
+# Delete an existing user
+username = "test_user"
+client.delete_user(username)
+```
+
+**Database Replication and Sync)**
+```ruby
+# View Active tasks (including replications)
+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
+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"]}})
+
+# Sync a database (replicate a database with :continuous => true)
+client.sync("test_2")
 ```
 
 ## To Do
 
-- Add database replication functionality - `/_replicator`
+- 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.
-- Add support for `attachments`   
 
 ## Contributing
 

data/lib/cloudant.rb

@@ -4,8 +4,10 @@ require 'uri'
 require 'rest-client'
 
 require "cloudant/version"
+require "cloudant/utility"
 require "cloudant/query_builder"
 require "cloudant/security"
+require "cloudant/replicator"
 require "cloudant/api"
 require "cloudant/client"
 require "cloudant/connection"

data/lib/cloudant/api.rb

@@ -1,6 +1,8 @@
 module Cloudant
   module API
+    include Cloudant::Utility
     include Cloudant::QueryBuilder
     include Cloudant::Security
+    include Cloudant::Replicator
   end
 end

data/lib/cloudant/query_builder.rb

@@ -7,10 +7,9 @@ module Cloudant
       fields    = get_fields(type)
 
       fields.each do |field|
-        key = field
         val = opts[field].to_s
 
-        current = "#{key}=#{val}"   if val != ""
+        current = "#{field}=#{val}" if val != ""
         query_str << "&" << current if (query_str != "" && current)
         query_str << "?" << current if (query_str == "" && current)
       end
@@ -18,7 +17,6 @@ module Cloudant
       query_str
     end
 
-    # TODO: This will be expanded to calls other than /_view.
     def get_fields(type)
       case type
         when "view"

data/lib/cloudant/replicator.rb

@@ -0,0 +1,41 @@
+module Cloudant
+  module Replicator
+    # The Replicator Module contains methods to replicate a database
+    #
+    # Allows you to monitor a replication 
+    def active_tasks(type="replication")
+      @conn.query({url_path: "_active_tasks", opts: {"type" => type}, method: :get})
+    end
+
+    def replicate_db(target,*opts)
+      opts && opts[0] ? options = opts[0] : options = {}
+
+      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})
+    end
+
+    def sync(target)
+      replicate_db(target,{:continuous => true, :create_target => true})
+    end
+
+    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]}",
+        :create_target => true,
+        :continuous => false
+      }  
+
+      fields.each do |field|
+        current = field.to_sym
+        replication_doc[current] = opts[current] if !opts[current].nil?
+      end    
+
+      replication_doc
+    end
+  end
+end

data/lib/cloudant/utility.rb

@@ -0,0 +1,8 @@
+module Cloudant
+  module Utility
+    def self.generate_doc_name(source,target)
+      time_now = Time.now.strftime('%F-%T').gsub(/(:|-)/,"_")
+      "#{source}_to_#{target}_#{time_now}"
+    end
+  end
+end

data/lib/cloudant/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudant
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alex Yanai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,9 @@ files:
 - lib/cloudant/client.rb
 - lib/cloudant/connection.rb
 - lib/cloudant/query_builder.rb
+- lib/cloudant/replicator.rb
 - lib/cloudant/security.rb
+- lib/cloudant/utility.rb
 - lib/cloudant/version.rb
 homepage: https://github.com/AlexYanai/cloudant
 licenses: