couchdb_rebuild_view_indices 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c3c9d19b84c77d07c60d136cbf756efee30210e
+  data.tar.gz: fabe310e670c87cbf6149316a6629ff03bf0a77e
+SHA512:
+  metadata.gz: c3a18028a9ecb0e5c90d96d744df62adf8fbb2779b18a87fe07c2cc5558bc3d6e708284e6e3845bc8734fdef29dc4ece2cb537e55141fca5e781193a23131119
+  data.tar.gz: aa870cf195381cfb33862bfd5cb97146845f1ac1e8faab63cec95e16926ee3063bdc8d770b00da25dbf32f4751b17d5412369aa650683fbb1fd352130bf5883e

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+�?c��e�><V�]�Rپ�� ��Y�3#�S��׫
+:�E<��N]6�+�T�~a�5q}O���~����	x�"79��|�v���gG]�2E�/])Μ�4ګ�GBy���P��O�CG��y6`��$�/u7�z�$�\�U�\�������,�z����DEX�Oಜ&_���!��=��L�X&f�E	-k��s2�M�/d�Mǒll�ko�������U����]�M?	u�(�>� 	m}-�|(

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in couchdb_rebuild_view_indices.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Justin Kulesza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Couchdb Rebuild View Indices
+
+This is a simple utilize to initiate the rebuild of indices associated with the views of CouchDB design documents. This is particularly useful after migrating a CouchDB via a restore from a dumped file.
+
+Generally, CouchDB updates the indices of views for design documents when accessed. However, if an entire CouchDB with much data has just been restored, it is difficult to ensure that all indexes are updated prior to running a live system against the new CouchDB.
+
+This utility enumerates and accesses all views for all design documents, which causes CouchDB to initiate a rebuild of all indices.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'couchdb_rebuild_view_indices'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install couchdb_rebuild_view_indices
+
+## Usage
+
+```
+bin/rebuild-view-indices
+
+Usage: rebuild-view-indices [options]
+    -u, --username [USERNAME]        Username for basic auth. (e.g. 'admin')
+    -p, --password [PASSWORD]        Password for basic auth. (e.g. 'secret')
+    -H, --host [HOST]                CouchDB Host. (e.g. '192.168.0.1')
+    -P, --port [PORT]                CouchDB Port. (default: 5984)
+        --protocol [PROTOCOL]        Protocol for HTTP requests. (default: http)
+    -h, --help                       Show this message.
+    -R, --retries [RETRIES]          Number of times to retry a request before timing out. (default: 10)
+    -d, --database DATABASE          CouchDB database. (e.g. 'default')
+    -v, --verbose                    Turn on debug logging.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kuleszaj/couchdb_rebuild_view_indices.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'couchdb_rebuild_view_indices'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/rebuild-view-indices

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'couchdb_rebuild_view_indices'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: rebuild-view-indices [options]'
+
+  opts.on('-u', '--username [USERNAME]', \
+          "Username for basic auth. (e.g. 'admin')") do |u|
+    options[:username] = u
+  end
+
+  opts.on('-p', '--password [PASSWORD]', \
+          "Password for basic auth. (e.g. 'secret')") do |p|
+    options[:password] = p
+  end
+
+  opts.on('-H', '--host [HOST]', \
+          "CouchDB Host. (e.g. '192.168.0.1')") do |h|
+    options[:host] = h
+  end
+
+  opts.on('-P', '--port [PORT]', \
+          'CouchDB Port. (default: 5984)') do |p|
+    options[:port] = p
+  end
+
+  opts.on('--protocol [PROTOCOL]', \
+          'Protocol for HTTP requests. (default: http)') do |p|
+    options[:protocol] = p
+  end
+
+  opts.on('-h', '--help', 'Show this message.') do
+    puts opts
+    exit
+  end
+
+  opts.on('-R', '--retries [RETRIES]', \
+          'Number of times to retry a request ' \
+          'before timing out. (default: 10)') do |r|
+    options[:retries] = r
+  end
+
+  opts.on('-d', '--database DATABASE', \
+          "CouchDB database. (e.g. 'default')") do |d|
+    options[:database] = d
+  end
+
+  opts.on('-v', '--verbose', \
+          "Turn on debug logging.") do |v|
+    options[:log_level] = Logger::DEBUG
+  end
+
+  if ARGV.empty?
+    puts opts
+    exit
+  end
+end.parse!
+
+CouchdbRebuildViewIndices::Indexer.new(options).run!

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/certs/kuleszaj.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBRMQ8wDQYDVQQDDAZqdXN0
+aW4xEzARBgoJkiaJk/IsZAEZFgNrdWwxFDASBgoJkiaJk/IsZAEZFgRlc3phMRMw
+EQYKCZImiZPyLGQBGRYDb3JnMB4XDTE3MDExNTE1MzYwNloXDTE4MDExNTE1MzYw
+NlowUTEPMA0GA1UEAwwGanVzdGluMRMwEQYKCZImiZPyLGQBGRYDa3VsMRQwEgYK
+CZImiZPyLGQBGRYEZXN6YTETMBEGCgmSJomT8ixkARkWA29yZzCCASIwDQYJKoZI
+hvcNAQEBBQADggEPADCCAQoCggEBAMMPoWdgN2VPdt4GlszzSmQhJLA3qGzNqhAm
+DgZ4UE+oUqEjzLggRt7GRDAqo2kIpoAOfKwWvkUtZTzPlmCD9pIi6IcY/h1XjDgG
+PbEbQFPIYwNe2oQRTkasBLUodRPi2/SvJgc/oaIICjf+W3ldOk9etqCAnJpNdWQ5
+xNUuzRPR4SRpllHR9pn7A3bXr1kJWDgtwJuR+nQbBwxkb9DXK9ojMfPXYVQtpRDt
+tflVsOdr2rYtmBCMdLFdnx3AGuHzTRa+m1/LFrDWbZGVBWmtuNVuwnGBA7jzFgnp
+qxrzehdkraULIdtVbByx+SHE8QzI1rHtWtS55Nf7qWgROeP9RdMCAwEAAaN5MHcw
+CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFKl1NM+wk8cJugW4phfc
+qxjiS3JtMB4GA1UdEQQXMBWBE2p1c3RpbkBrdWwuZXN6YS5vcmcwHgYDVR0SBBcw
+FYETanVzdGluQGt1bC5lc3phLm9yZzANBgkqhkiG9w0BAQUFAAOCAQEAl+i/1WvS
+j/WCqO/FBh9JLw9k/vVQkBo+RmRo2otGPLPV4mtdJeVGOmGWNvM65tb+b1H/5MaC
+tDG4mTJDw6Gn0H7cUgksUOGMDn7L1dZ7q/o4e50MGwkA6fEKMy51bZyR+AacUEEJ
+Qx+pjBsNxHISAoUdGyMTVbMb7OLGUWeAnsxI26I0mW96xdvzy9mIOkQuEG/MeHTk
+sC+ikfyYkGZt1Q1B0oqiOIoy4HtmX8iEOf1kWLJse+NOcgoLIawALaaCzCOQvE6a
+s0YPoqenoiIPZrSgLyugysS2vHx1VJ5sdKLvuF15kAYFgMhkrgPiF7cR6xUcexVz
+HQ9Ni70Ad8rXaQ==
+-----END CERTIFICATE-----

data/couchdb_rebuild_view_indices.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'couchdb_rebuild_view_indices/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'couchdb_rebuild_view_indices'
+  spec.version       = CouchdbRebuildViewIndices::VERSION
+  spec.authors       = ['Justin Kulesza']
+  spec.email         = ['justin.kulesza@atomicobject.com']
+
+  spec.summary       = 'Simple utility to initiate the rebuild of indices '
+                       'assocated with views in CouchDB design documents.'
+  spec.description   = 'Simple utility to initiate the rebuild of indices '
+                       'assocated with views in CouchDB design documents.'
+
+  spec.homepage      = 'https://github.com/kuleszaj/couchdb_rebuild_view_indices'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject \
+                       { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{rebuild-view-indices}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.cert_chain    = ['certs/kuleszaj.pem']
+  spec.signing_key   = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.43.0'
+end

data/lib/couchdb_rebuild_view_indices.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require 'couchdb_rebuild_view_indices/version'
+require 'net/http'
+require 'json'
+require 'logger'
+
+module CouchdbRebuildViewIndices
+  # Class for describing an indexer of CouchDB design documents.
+  class Indexer
+
+    attr_writer :options
+
+    @@default_options = {
+      host: '127.0.0.1',
+      retries: 10,
+      port: 5984,
+      protocol: 'http',
+      log_level: Logger::INFO
+    }
+
+    def initialize(options)
+      @options = @@default_options.merge!(options)
+      @logger = Logger.new(STDOUT)
+      @logger.level = @options[:log_level]
+      @logger.debug 'Running with options:'
+      @logger.debug @options
+    end
+
+    def run!
+      docs = get_design_docs(design_docs_uri)
+      docs.each do |doc|
+        next unless doc['doc'].key?('views')
+        iterate_on_views(doc['id'], doc['doc']['views'])
+      end
+    end
+
+    private
+
+    def iterate_on_views(document_id, views)
+      views.each do |view|
+        @logger.info "Requesting view: #{document_id}/_view/#{view[0]}"
+        res = make_request_with_retries(
+          view_uri(document_id, view[0]),
+          @options[:retries]
+        )
+        @logger.info 'OK!' if res.code == '200'
+        @logger.info 'Error!' if res.code != '200'
+      end
+    end
+
+    def get_design_docs(uri)
+      JSON.parse(make_request_with_retries(uri).body)['rows']
+    end
+
+    def design_docs_uri
+      URI::HTTP.build(
+        scheme: @options[:protocol],
+        host: @options[:host],
+        port: @options[:port],
+        path: "/#{@options[:database]}/_all_docs",
+        query: 'startkey=%22_design/%22&endkey=%22_design0%22&include_docs=true'
+      )
+    end
+
+    def view_uri(document_id, view)
+      URI::HTTP.build(
+        scheme: @options[:protocol],
+        host: @options[:host],
+        port: @options[:port],
+        path: "/#{@options[:database]}/#{document_id}/_view/#{view}"
+      )
+    end
+
+    def make_request_with_retries(uri, retries = 1)
+      raise Net::ReadTimeout if retries.negative?
+      req = Net::HTTP::Get.new(uri)
+
+      if @options[:username] && @options[:password]
+        req.basic_auth @options[:username], @options[:password]
+      end
+
+      begin
+        Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(req) }
+      rescue Net::ReadTimeout
+        make_request_with_retries(url, retries - 1)
+      end
+    end
+  end
+end

data/lib/couchdb_rebuild_view_indices/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module CouchdbRebuildViewIndices
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: couchdb_rebuild_view_indices
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Kulesza
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBRMQ8wDQYDVQQDDAZqdXN0
+  aW4xEzARBgoJkiaJk/IsZAEZFgNrdWwxFDASBgoJkiaJk/IsZAEZFgRlc3phMRMw
+  EQYKCZImiZPyLGQBGRYDb3JnMB4XDTE3MDExNTE1MzYwNloXDTE4MDExNTE1MzYw
+  NlowUTEPMA0GA1UEAwwGanVzdGluMRMwEQYKCZImiZPyLGQBGRYDa3VsMRQwEgYK
+  CZImiZPyLGQBGRYEZXN6YTETMBEGCgmSJomT8ixkARkWA29yZzCCASIwDQYJKoZI
+  hvcNAQEBBQADggEPADCCAQoCggEBAMMPoWdgN2VPdt4GlszzSmQhJLA3qGzNqhAm
+  DgZ4UE+oUqEjzLggRt7GRDAqo2kIpoAOfKwWvkUtZTzPlmCD9pIi6IcY/h1XjDgG
+  PbEbQFPIYwNe2oQRTkasBLUodRPi2/SvJgc/oaIICjf+W3ldOk9etqCAnJpNdWQ5
+  xNUuzRPR4SRpllHR9pn7A3bXr1kJWDgtwJuR+nQbBwxkb9DXK9ojMfPXYVQtpRDt
+  tflVsOdr2rYtmBCMdLFdnx3AGuHzTRa+m1/LFrDWbZGVBWmtuNVuwnGBA7jzFgnp
+  qxrzehdkraULIdtVbByx+SHE8QzI1rHtWtS55Nf7qWgROeP9RdMCAwEAAaN5MHcw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFKl1NM+wk8cJugW4phfc
+  qxjiS3JtMB4GA1UdEQQXMBWBE2p1c3RpbkBrdWwuZXN6YS5vcmcwHgYDVR0SBBcw
+  FYETanVzdGluQGt1bC5lc3phLm9yZzANBgkqhkiG9w0BAQUFAAOCAQEAl+i/1WvS
+  j/WCqO/FBh9JLw9k/vVQkBo+RmRo2otGPLPV4mtdJeVGOmGWNvM65tb+b1H/5MaC
+  tDG4mTJDw6Gn0H7cUgksUOGMDn7L1dZ7q/o4e50MGwkA6fEKMy51bZyR+AacUEEJ
+  Qx+pjBsNxHISAoUdGyMTVbMb7OLGUWeAnsxI26I0mW96xdvzy9mIOkQuEG/MeHTk
+  sC+ikfyYkGZt1Q1B0oqiOIoy4HtmX8iEOf1kWLJse+NOcgoLIawALaaCzCOQvE6a
+  s0YPoqenoiIPZrSgLyugysS2vHx1VJ5sdKLvuF15kAYFgMhkrgPiF7cR6xUcexVz
+  HQ9Ni70Ad8rXaQ==
+  -----END CERTIFICATE-----
+date: 2017-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+description: 'Simple utility to initiate the rebuild of indices '
+email:
+- justin.kulesza@atomicobject.com
+executables:
+- rebuild-view-indices
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rebuild-view-indices
+- bin/setup
+- certs/kuleszaj.pem
+- couchdb_rebuild_view_indices.gemspec
+- lib/couchdb_rebuild_view_indices.rb
+- lib/couchdb_rebuild_view_indices/version.rb
+homepage: https://github.com/kuleszaj/couchdb_rebuild_view_indices
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simple utility to initiate the rebuild of indices
+test_files: []