dpla-analysand 3.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43f7060645db528706131e0bb8c6feaa5311cb45
+  data.tar.gz: a9d1a3d8e8434f3039d7b0f441a4053000b1bca4
+SHA512:
+  metadata.gz: 510cc920abf5f1fa85b82ed86e7d0f8fb4276761a424626122bfa79025c6795b4692481706a57208dde8b5916b0ff3afd4e151a7b496935dfbf84bd384688f29
+  data.tar.gz: 1b247083c79d19ec91aa958712f6e7e7d3d80d33546914b3a7776b62ede70745d71ddea5c5f2e1142f5cb3ffe8ade9e7f8e191df6f4e851b3e0d9c2cd02f3a7d

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.sw?
+.rbx
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - rbx-2.3.0
+  - 2.0.0
+before_script:
+  - "./script/setup_database.rb"
+services:
+  - couchdb

data/CHANGELOG

@@ -0,0 +1,67 @@
+Issue numbers refer to issues on Analysand's Github tracker:
+https://github.com/yipdw/analysand/issues
+
+3.0.2 (2014-12-01)
+-----------------
+
+* Change Celluloid dependency to ~> 0.16.0.
+
+3.0.1 (2014-01-14)
+------------------
+
+* Change Celluloid dependency to ~> 0.15.0.
+
+3.0.0 (2013-07-08)
+------------------
+
+* Change Celluloid dependency to 0.14.
+
+3.0.0.pre2 (2013-04-15)
+-----------------------
+
+* Change Celluloid dependency to 0.13.
+  Please note: Analysand does not require celluloid/autostart.  It's up to you
+  to decide whether or not you need that for your application.
+
+3.0.0.pre (2013-02-26)
+----------------------
+
+* Instance#set_config renamed to Instance#put_config
+* Instance#put_admin, Instance#delete_admin for db admin setup
+* JSON encoding/decoding removed from Instance#*_config methods: all values are
+  sent to/received from CouchDB verbatim.  This means that you'll have to quote all values,
+  e.g.
+
+     instance.set_config("stats/rate", 1200)
+
+  becomes
+
+     instance.put_config("stats/rate", '"1200"')
+
+
+x.y.z (2012-12-31)
+------------------
+
+* Analysand::Writing#bulk_docs! now raises BulkOperationFailed on 401 responses
+
+2.0.0 (2012-11-29)
+------------------
+
+* Instance#establish_session and Instance#renew_session now return a (session,
+  Analysand::Response pair)
+* Share HTTP code between Database and Instance
+* Session handling on Instance rewritten: #post_session, #get_session
+* New response methods: #cookies, #session_cookie
+
+1.1.0 (2012-11-03)
+------------------
+
+* View streaming (#3)
+* ChangeWatchers now pass credentials when checking CouchDB status (#4)
+* Some code organization cleanups
+* require "analysand" now loads the Database and Instance classes
+
+1.0.1 (2012-10-01)
+------------------
+
+* Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in analysand.gemspec
+gemspec
+
+platform :rbx do
+  gem 'rubysl'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Yip
+
+MIT License
+
+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

@@ -0,0 +1,48 @@
+1. Analysand
+
+Analysand is a CouchDB client library of dubious worth.  It was extracted from
+the a-m-v.org catalog application:
+https://code.ninjawedding.org/git/amvorg-underground/catalog.git.
+
+Analysand was written for Ruby 1.9.  It is known to work on Ruby 1.9.3-p194 and
+Rubinius 2.0.0.
+
+2. Features
+
+* GET, PUT, DELETE on databases
+* GET, PUT, DELETE, HEAD, COPY on documents
+* GET, PUT on document attachments
+* GET, POST on views
+* GET, PUT on server configuration
+* GET, PUT, POST on arbitrary service handlers
+* POST /_session
+* POST /_bulk_docs
+* View streaming
+* Celluloid::IO-based change feed watchers
+* Cookie and HTTP Basic authentication for all of the above
+* Database objects can be safely shared across threads
+
+3. Development
+
+You'll need a CouchDB >= 1.1.0 instance.  I recommend not using a CouchDB
+instance that you're using for anything else; Analysand requires the presence
+of specific admin and non-admin users for its test suite.
+
+See spec/support/test_parameters.rb for usernames, passwords, and connection
+information.
+
+Naturally, we hang with all the cool kids:
+
+* Travis CI: https://travis-ci.org/#!/yipdw/analysand
+* Code Climate: https://codeclimate.com/github/yipdw/analysand
+* Gemnasium: https://gemnasium.com/yipdw/analysand
+
+4. License
+
+Copyright 2012 David Yip; made available under the MIT license.
+
+5. Special thanks
+
+Fear of Tigers, 3LAU, Ellie Goulding, TeddyLoid, Susumu Hirasawa.
+
+# vim:ts=2:sw=2:et:tw=78

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+namespace :git do
+  desc 'Strip trailing whitespace from tracked source files'
+  task :strip_spaces do
+    `git ls-files`.split("\n").each do |file|
+      puts file
+
+      if `file '#{file}'` =~ /text/
+        sh "git stripspace < '#{file}' > '#{file}.out'"
+        mv "#{file}.out", file
+      end
+    end
+  end
+end
+
+task :default => :spec

data/analysand.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/analysand/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Yip"]
+  gem.email         = ["yipdw@member.fsf.org"]
+  gem.description   = %q{A terrible burden for a couch}
+  gem.summary       = %q{A CouchDB client of dubious worth}
+  gem.homepage      = "https://github.com/yipdw/analysand"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dpla-analysand"
+  gem.require_paths = ["lib"]
+  gem.version       = Analysand::VERSION
+
+  gem.required_ruby_version = '>= 1.9'
+
+  gem.add_dependency 'celluloid', '~> 0.16.0'
+  gem.add_dependency 'celluloid-io'
+  gem.add_dependency 'http_parser.rb'
+  gem.add_dependency 'json'
+  gem.add_dependency 'json-stream'
+  gem.add_dependency 'net-http-persistent'
+  gem.add_dependency 'rack'
+  gem.add_dependency 'yajl-ruby'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+end

data/bin/analysand

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'analysand'
+require 'irb'
+require 'uri'
+
+$URI = URI('http://localhost:5984/analysand_test')
+
+def make_db(uri = $URI)
+  Analysand::Database.new(uri)
+end
+
+puts <<-END
+------------------------------------------------------------------------------
+Type make_db to make an Analysand::Database object.  The default URI is
+
+    #{$URI}
+
+To point at different databases, supply a URI object to make_db, e.g.
+
+    make_db(URI('https://couchdb.example.org:6984/supersekrit'))
+------------------------------------------------------------------------------
+END
+
+IRB.start

data/lib/analysand.rb

@@ -0,0 +1,3 @@
+require 'analysand/database'
+require 'analysand/instance'
+require 'analysand/version'

data/lib/analysand/bulk_response.rb

@@ -0,0 +1,14 @@
+require 'analysand/response'
+
+module Analysand
+  ##
+  # A subclass of Response that adjusts success? to check for individual error
+  # records.
+  class BulkResponse < Response
+    def success?
+      super && body.none? { |r| r.has_key?('error') }
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et:tw=78

data/lib/analysand/change_watcher.rb

@@ -0,0 +1,280 @@
+require 'celluloid'
+require 'celluloid/io'
+require 'analysand/connection_testing'
+require 'http/parser'
+require 'net/http'
+require 'rack/utils'
+require 'uri'
+require 'yajl'
+
+module Analysand
+  ##
+  # A Celluloid::IO actor that watches the changes feed of a CouchDB database.
+  # When a change is received, it passes the change to a #process method.
+  #
+  # ChangeWatchers monitor changes using continuous mode and set up a heartbeat
+  # to fire approximately every 10 seconds.
+  #
+  # ChangeWatchers begin watching for changes as soon as they are initialized.
+  # To send a shutdown message:
+  #
+  #     a.stop
+  #
+  # The watcher will terminate on the next heartbeat.
+  #
+  #
+  # Failure modes
+  # =============
+  #
+  # ChangeWatcher deals with the following failures in the following ways:
+  #
+  # * If Errno::ECONNREFUSED is raised whilst connecting to CouchDB, it will
+  #   retry the connection in 30 seconds.
+  # * If the connection to CouchDB's changes feed is abruptly terminated, it
+  #   dies.
+  # * If an exception is raised during HTTP or JSON parsing, it dies.
+  #
+  # Situations where the actor dies should be handled by a supervisor.
+  #
+  #
+  # Example usage
+  # =============
+  #
+  #     class Accumulator < Analysand::ChangeWatcher
+  #       attr_accessor :results
+  #
+  #       def initialize(database)
+  #         super(database)
+  #
+  #         self.results = []
+  #       end
+  #
+  #       def process(change)
+  #         results << change
+  #
+  #         # Once a ChangeWatcher has successfully processed a change, it
+  #         # SHOULD invoke #change_processed.
+  #         change_processed(change)
+  #       end
+  #     end
+  #
+  #     a = Accumulator.new('http://localhost:5984/mydb')
+  #
+  #     # or with supervision:
+  #     a = Accumulator.supervise('http://localhost:5984/mydb')
+  class ChangeWatcher
+    include Celluloid::IO
+    include Celluloid::Logger
+    include ConnectionTesting
+    include Rack::Utils
+
+    # Read at most this many bytes off the socket at a time.
+    QUANTUM = 4096
+
+    ##
+    # Checks services.  If all services pass muster, enters a read loop.
+    #
+    # The database parameter may be either a URL-as-string or a
+    # Analysand::Database.
+    #
+    # If overriding the initializer, you MUST call super.
+    def initialize(database)
+      @db = database
+      @waiting = {}
+      @http_parser = ::Http::Parser.new(self)
+      @json_parser = Yajl::Parser.new
+      @json_parser.on_parse_complete = lambda { |doc| process(doc) }
+
+      async.start
+    end
+
+    # The URI of the changes feed.  This URI incorporates any changes
+    # made by customize_query.
+    def changes_feed_uri
+      query = {
+        'feed' => 'continuous',
+        'heartbeat' => '10000'
+      }
+
+      customize_query(query)
+
+      uri = (@db.respond_to?(:uri) ? @db.uri : URI(@db)).dup
+      uri.path += '/_changes'
+      uri.query = build_query(query)
+      uri
+    end
+
+    # The connection_ok method is called before connecting to the changes feed.
+    # By default, it checks that there's an HTTP service listening on the
+    # changes feed.
+    #
+    # If the method returns true, then we connect to the changes feed and begin
+    # processing.  If it returns false, a warning message is logged and the
+    # connection check will be retried in 30 seconds.
+    #
+    # This method can be overridden if you need to check additional services.
+    # When you override the method, make sure that you don't discard the return
+    # value of the original definition:
+    #
+    #     # Wrong
+    #     def connection_ok
+    #       super
+    #       ...
+    #     end
+    #
+    #     # Right
+    #     def connection_ok
+    #       ok = super
+    #
+    #       ok && my_other_test
+    #     end
+    def connection_ok
+      test_http_connection(changes_feed_uri) do |req|
+        customize_request(req)
+      end
+    end
+
+    def start
+      return if @started
+
+      @started = true
+
+      while !connection_ok
+        error "Some services used by #{self.class.name} did not check out ok; will retry in 30 seconds"
+        sleep 30
+      end
+
+      connect
+
+      info "#{self.class} entering read loop"
+
+      @running = true
+
+      while @running
+        @http_parser << @socket.readpartial(QUANTUM)
+      end
+
+      # Once we're done, close things up.
+      @started = false
+      @socket.close
+    end
+
+    def stop
+      @running = false
+    end
+
+    ##
+    # Can be used to set query parameters.  query is a Hash.  The query hash
+    # has two default parameters:
+    #
+    # | Key       | Value      |
+    # | feed      | continuous |
+    # | heartbeat | 10000      |
+    #
+    # It is NOT RECOMMENDED that they be changed.
+    #
+    # By default, this does nothing.  Provide behavior in a subclass.
+    def customize_query(query)
+    end
+
+    ##
+    # Can be used to add headers.  req is a Net::HTTP::Get instance.
+    #
+    # By default, this does nothing.  Provide behavior in a subclass.
+    def customize_request(req)
+    end
+
+    ##
+    # This method should implement your change-processing logic.
+    #
+    # change is a Hash containing keys id, seq, and changes.  See [0] for
+    # more information.
+    #
+    # By default, this does nothing.  Provide behavior in a subclass.
+    #
+    # [0]: http://guide.couchdb.org/draft/notifications.html#continuous
+    def process(change)
+    end
+
+    class Waiter < Celluloid::Future
+      alias_method :wait, :value
+    end
+
+    ##
+    # Returns an object that can be used to block a thread until a document
+    # with the given ID has been processed.
+    #
+    # Intended for testing.
+    def waiter_for(id)
+      @waiting[id] = true
+
+      Waiter.new do
+        loop do
+          break true if !@waiting[id]
+          sleep 0.1
+        end
+      end
+    end
+
+    ##
+    # Notify waiters.
+    def change_processed(change)
+      @waiting.delete(change['id'])
+    end
+
+    ##
+    # Http::Parser callback.
+    #
+    # @private
+    def on_headers_complete(parser)
+      status = @http_parser.status_code.to_i
+
+      raise "Request failed: expected status 200, got #{status}" unless status == 200
+    end
+
+    ##
+    # Http::Parser callback.
+    #
+    # @private
+    def on_body(chunk)
+      @json_parser << chunk
+    end
+
+    ##
+    # @private
+    def connect
+      req = prepare_request
+      uri = changes_feed_uri
+
+      info "#{self.class} connecting to #{req.path}"
+
+      @socket = TCPSocket.new(uri.host, uri.port)
+
+      # Make the request.
+      data = [
+        "GET #{req.path} HTTP/1.1"
+      ]
+
+      req.each_header { |k, v| data << "#{k}: #{v}" }
+
+      @socket.write(data.join("\r\n"))
+      @socket.write("\r\n\r\n")
+    end
+
+    ##
+    # @private
+    def disconnect
+      @socket.close if @socket && !@socket.closed?
+    end
+
+    finalizer :disconnect
+
+    ##
+    # @private
+    def prepare_request
+      Net::HTTP::Get.new(changes_feed_uri.to_s).tap do |req|
+        customize_request(req)
+      end
+    end
+  end
+end