couch_replica 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a33e2ca49d0a930882d47845981a1b8354bfe491
4
+ data.tar.gz: a83cd872c0b64aa1fb167aae36075bbee1ed8731
5
+ SHA512:
6
+ metadata.gz: 619e3dd19e5da9e2ba9a3329a1857a98319776ab03bc9fa7bb7a8058a3a92c73ef75c97135b3b486abaf007b9f71003882886787ab8fff07c6740731b5be6f24
7
+ data.tar.gz: 8c50f01418910df491ecd7e0b946e9ee61d5d1c6d5df4dcfcd43d4cb2dc198e48caefd137832194a109f0f2d05bd0a488a1f59206fd35ea08e6c37d879de0999
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.3
4
+ before_install: gem install bundler -v 1.10.3
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in couch_replica.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Gordon L. Hempton
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # CouchReplica
2
+
3
+ Command line utility to set up replication of all databases in a Couchdb server.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'couch_replica'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install couch_replica
20
+
21
+ ## Usage
22
+
23
+ Run `couch_replicat --help` for usage information.
24
+
25
+ ## Development
26
+
27
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
28
+
29
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/couch_replica. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
34
+
35
+
36
+ ## License
37
+
38
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/couch_replica ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'couch_replica'
4
+
5
+ CouchReplica::CLI.start
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'couch_replica/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "couch_replica"
8
+ spec.version = CouchReplica::VERSION
9
+ spec.authors = ["Gordon L. Hempton"]
10
+ spec.email = ["ghempton@gmail.com"]
11
+
12
+ spec.summary = "Utility to replicate *all* databases from a CouchDB server"
13
+ spec.homepage = "https://github.com/getoutreach/couch_replica"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "bin"
18
+ spec.executables = "couch_replica"
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency 'rest-client'
22
+ spec.add_dependency 'thor'
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.10"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec"
27
+ end
@@ -0,0 +1,8 @@
1
+ require "couch_replica/version"
2
+ require "couch_replica/database"
3
+ require "couch_replica/replicator"
4
+ require "couch_replica/cli"
5
+
6
+ module CouchReplica
7
+
8
+ end
@@ -0,0 +1,38 @@
1
+ require 'thor'
2
+
3
+ require_relative './replicator'
4
+
5
+ module CouchReplica
6
+
7
+ class CLI < Thor
8
+
9
+ class_option :"source-host", aliases: "-s", desc: "The host of the couchdb server acting as the source"
10
+ class_option :"source-port", aliases: "-sp", default: 5984, desc: "The port of the couchdb server acting as the source"
11
+ class_option :"target-host", aliases: "-t", desc: "The host of the couchdb server acting as the target"
12
+ class_option :"target-port", aliases: "-tp", default: 5984, desc: "The port of the couchdb server acting as the target"
13
+ class_option :"prefix-filter", aliases: "-f", desc: "Only replicate databases which match this prefix"
14
+
15
+ desc "start", "start replication"
16
+ def start
17
+ instance.start
18
+ end
19
+
20
+ desc "stop", "stop replication"
21
+ def stop
22
+ instance.stop
23
+ end
24
+
25
+ private
26
+
27
+ def instance
28
+ Replicator.new(
29
+ source_endpoint: "http://#{options['source-host']}:#{options['source-port']}",
30
+ target_endpoint: "http://#{options['target-host']}:#{options['target-port']}",
31
+ prefix_filter: options["prefix-filter"]
32
+ )
33
+ end
34
+
35
+
36
+ end
37
+
38
+ end
@@ -0,0 +1,79 @@
1
+ require 'rest-client'
2
+ require 'json'
3
+ require 'logger'
4
+
5
+ module CouchReplica
6
+
7
+ class Database
8
+
9
+ attr_reader :name, :source_endpoint, :target_endpoint, :replicator_url
10
+
11
+ def initialize(name, source_endpoint:, target_endpoint:, replicator_url:)
12
+ @name = name
13
+ @source_endpoint = source_endpoint
14
+ @target_endpoint = target_endpoint
15
+ @replicator_url = replicator_url
16
+ end
17
+
18
+ def start
19
+ doc = status
20
+ if doc
21
+ logger.info "Replication already started from #{source_url} to #{target_url}"
22
+ return
23
+ end
24
+
25
+ res = RestClient.post replicator_url, {
26
+ _id: replicator_id,
27
+ source: source_url,
28
+ target: target_url,
29
+ continuous: true,
30
+ create_target: true
31
+ }.to_json, content_type: :json
32
+
33
+ logger.info "Started push replication from #{source_url} to #{target_url}"
34
+
35
+ res
36
+ end
37
+
38
+ def stop
39
+ doc = status
40
+
41
+ if !doc
42
+ logger.info "No replication found from #{source_url} to #{target_url}"
43
+ return
44
+ end
45
+
46
+ res = RestClient.delete doc_url, params: {rev: doc['_rev']}
47
+ logger.info "Stopped replication from #{source_url} to #{target_url}"
48
+ res
49
+ end
50
+
51
+ def status
52
+ JSON.parse RestClient.get doc_url
53
+ rescue RestClient::ResourceNotFound
54
+ nil
55
+ end
56
+
57
+ def doc_url
58
+ "#{replicator_url}/#{replicator_id}"
59
+ end
60
+
61
+ def replicator_id
62
+ "pull-#{name}"
63
+ end
64
+
65
+ def source_url
66
+ "#{source_endpoint}/#{name}"
67
+ end
68
+
69
+ def target_url
70
+ "#{target_endpoint}/#{name}"
71
+ end
72
+
73
+ def logger
74
+ @logger ||= Logger.new(STDOUT)
75
+ end
76
+
77
+ end
78
+
79
+ end
@@ -0,0 +1,46 @@
1
+ require_relative './database'
2
+
3
+ module CouchReplica
4
+
5
+ class Replicator
6
+
7
+ attr_reader :source_endpoint, :target_endpoint, :prefix_filter
8
+
9
+ def initialize(source_endpoint:, target_endpoint:, prefix_filter: nil)
10
+ @source_endpoint = source_endpoint
11
+ @target_endpoint = target_endpoint
12
+ @prefix_filter = prefix_filter
13
+ end
14
+
15
+ def start
16
+ databases.map(&:start)
17
+ end
18
+
19
+ def stop
20
+ databases.map(&:stop)
21
+ end
22
+
23
+ protected
24
+
25
+ def replicator_url
26
+ # Pull replication
27
+ "#{target_endpoint}/_replicator"
28
+ end
29
+
30
+ def databases
31
+ names = JSON.parse(RestClient.get(source_endpoint + '/_all_dbs'))
32
+ if prefix_filter
33
+ names.select!{|name| name =~ /^#{prefix_filter}/}
34
+ end
35
+ # Never include the replicator itself
36
+ names.select!{|name| name != '_replicator' && name != '_users'}
37
+ names.map{|n| Database.new(n,
38
+ source_endpoint: source_endpoint,
39
+ target_endpoint: target_endpoint,
40
+ replicator_url: replicator_url
41
+ )}
42
+ end
43
+
44
+ end
45
+
46
+ end
@@ -0,0 +1,3 @@
1
+ module CouchReplica
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: couch_replica
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Gordon L. Hempton
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-06-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: thor
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.10'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.10'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description:
84
+ email:
85
+ - ghempton@gmail.com
86
+ executables:
87
+ - couch_replica
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - ".gitignore"
92
+ - ".rspec"
93
+ - ".travis.yml"
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/couch_replica
99
+ - couch_replica.gemspec
100
+ - lib/couch_replica.rb
101
+ - lib/couch_replica/cli.rb
102
+ - lib/couch_replica/database.rb
103
+ - lib/couch_replica/replicator.rb
104
+ - lib/couch_replica/version.rb
105
+ homepage: https://github.com/getoutreach/couch_replica
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.2.2
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Utility to replicate *all* databases from a CouchDB server
129
+ test_files: []