couchrest_changes 0.0.1

data/Rakefile

@@ -0,0 +1,93 @@
+require "rubygems"
+require "highline/import"
+require "pty"
+require "fileutils"
+require 'rake/testtask'
+
+##
+## HELPER
+##
+
+def run(cmd)
+  PTY.spawn(cmd) do |output, input, pid|
+    begin
+      while line = output.gets do
+        puts line
+      end
+    rescue Errno::EIO
+    end
+  end
+rescue PTY::ChildExited
+end
+
+##
+## GEM BUILDING AND INSTALLING
+##
+
+$spec_path = 'couchrest_changes.gemspec'
+$spec      = eval(File.read($spec_path))
+$base_dir  = File.dirname(__FILE__)
+$gem_path  = File.join($base_dir, 'pkg', "#{$spec.name}-#{$spec.version}.gem")
+
+def built_gem_path
+  Dir[File.join($base_dir, "#{$spec.name}-*.gem")].sort_by{|f| File.mtime(f)}.last
+end
+
+desc "Build #{$spec.name}-#{$spec.version}.gem into the pkg directory"
+task 'build' do
+  FileUtils.mkdir_p(File.join($base_dir, 'pkg'))
+  FileUtils.rm($gem_path) if File.exists?($gem_path)
+  run "gem build -V '#{$spec_path}'"
+  file_name = File.basename(built_gem_path)
+  FileUtils.mv(built_gem_path, 'pkg')
+  say "#{$spec.name} #{$spec.version} built to pkg/#{file_name}"
+end
+
+desc "Install #{$spec.name}-#{$spec.version}.gem into either system-wide or user gems"
+task 'install' do
+  if !File.exists?($gem_path)
+    say("Could not file #{$gem_path}. Try running 'rake build'")
+  else
+    if ENV["USER"] == "root"
+      run "gem install '#{$gem_path}'"
+    else
+      home_gem_path = Gem.path.grep(/home/).first
+      say("You are installing as an unprivileged user, which will result in the installation being placed in '#{home_gem_path}'.")
+      if agree("Do you want to continue installing to #{home_gem_path}? ")
+        run "gem install '#{$gem_path}' --user-install"
+      end
+    end
+  end
+end
+
+desc "Uninstall #{$spec.name}-#{$spec.version}.gem from either system-wide or user gems"
+task 'uninstall' do
+  if ENV["USER"] == "root"
+    say("Removing #{$spec.name}-#{$spec.version}.gem from system-wide gems")
+    run "gem uninstall '#{$spec.name}' --version #{$spec.version} --verbose -x -I"
+  else
+    say("Removing #{$spec.name}-#{$spec.version}.gem from user's gems")
+    run "gem uninstall '#{$spec.name}' --version #{$spec.version} --verbose --user-install -x -I"
+  end
+end
+
+##
+## TESTING
+##
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/unit/*_test.rb"
+end
+task :default => :test
+
+##
+## DOCUMENTATION
+##
+
+# require 'rdoc/task'
+
+# Rake::RDocTask.new do |rd|
+#   rd.main = "README.rdoc"
+#   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+#   rd.title = 'Your application title'
+# end

data/Readme.md

@@ -0,0 +1,60 @@
+CouchRest::Changes - keeping track of changes to your couch
+------------------------------------------------------------
+
+``CouchRest::Changes`` let's you observe a couch database for changes and react upon them.
+
+Following the changes of a couch is as easy as
+```ruby
+users = CouchRest::Changes.new('users')
+```
+
+Callbacks can be defined in blocks:
+```ruby
+users.created do |hash|
+  puts "A new user was created with the id: #{hash[:id]}
+end
+```
+
+To start listening just call
+```ruby
+users.listen
+```
+
+This program is written in Ruby and is distributed under the following license:
+
+> GNU Affero General Public License
+> Version 3.0 or higher
+> http://www.gnu.org/licenses/agpl-3.0.html
+
+Installation
+---------------------
+
+Just add couchrest_changes to your gemfile.
+
+Configuration
+---------------------
+
+``couchrest_changes`` can be configured through ``CouchRest::Changes::Config``
+
+The default options are similar to the ones used by CouchRest::Model:
+
+
+```yaml
+# couch connection configuration
+connection:
+  protocol: "http"
+  host: "localhost"
+  port: 5984
+  username: ~
+  password: ~
+  prefix: ""
+  suffix: ""
+
+# file to store the last processed user record in so we can resume after
+# a restart:
+seq_file: "/var/log/couch_changes_users.seq"
+
+# Configure log_file like this if you want to log to a file instead of syslog:
+# log_file: "/var/log/couch_changes.log"
+log_level: debug
+```

data/lib/couchrest/changes/config.rb

@@ -0,0 +1,114 @@
+require 'yaml'
+
+module CouchRest
+  class Changes
+    module Config
+      extend self
+
+      attr_accessor :connection
+      attr_accessor :seq_file
+      attr_accessor :log_file
+      attr_writer :log_level
+      attr_accessor :logger
+      attr_accessor :options
+
+      def load(base_dir, *configs)
+        @base_dir = Pathname.new(base_dir)
+        loaded = configs.collect do |file_path|
+          file = find_file(file_path)
+          load_config(file)
+        end
+        init_logger
+        log_loaded_configs(loaded.compact)
+        logger.info "Observing #{couch_host_without_password}"
+        return self
+      end
+
+      def couch_host(conf = nil)
+        conf ||= connection
+        userinfo = [conf[:username], conf[:password]].compact.join(':')
+        userinfo += '@' unless userinfo.empty?
+        "#{conf[:protocol]}://#{userinfo}#{conf[:host]}:#{conf[:port]}"
+      end
+
+      def couch_host_without_password
+        couch_host connection.merge({:password => nil})
+      end
+
+      def complete_db_name(db_name)
+        [connection[:prefix], db_name, connection[:suffix]].
+         compact.
+         reject{|part| part == ""}.
+         join('_')
+      end
+
+      private
+
+      def init_logger
+        if log_file
+          require 'logger'
+          @logger = Logger.new(log_file)
+        else
+          require 'syslog/logger'
+          @logger = Syslog::Logger.new('leap_key_daemon')
+        end
+        @logger.level = Logger.const_get(log_level.upcase)
+      end
+
+      def load_config(file_path)
+        return unless file_path
+        load_settings YAML.load(File.read(file_path)), file_path
+        return file_path
+      end
+
+      def load_settings(hash, file_path)
+        return unless hash
+        hash.each do |key, value|
+          begin
+            apply_setting(key, value)
+          rescue NoMethodError => exc
+            # log might not have been configured yet correctly
+            # so better also print this
+            STDERR.puts "Error in file #{file_path}"
+            STDERR.puts "'#{key}' is not a valid option"
+            init_logger
+            logger.warn "Error in file #{file_path}"
+            logger.warn "'#{key}' is not a valid option"
+            logger.debug exc
+          end
+        end
+      end
+
+      def apply_setting(key, value)
+        if value.is_a? Hash
+          value = symbolize_keys(value)
+        end
+        self.send("#{key}=", value)
+      end
+
+      def self.symbolize_keys(hsh)
+        newhsh = {}
+        hsh.keys.each do |key|
+          newhsh[key.to_sym] = hsh[key]
+        end
+        newhsh
+      end
+
+      def find_file(file_path)
+        return unless file_path
+        filenames = [Pathname.new(file_path), @base_dir + file_path]
+        filenames.find{|f| f.file?}
+      end
+
+      def log_loaded_configs(files)
+        files.each do |file|
+          logger.info "Loaded config from #{file} ."
+        end
+      end
+
+      def log_level
+        @log_level || 'info'
+      end
+    end
+  end
+end

data/lib/couchrest/changes/version.rb

@@ -0,0 +1,5 @@
+module CouchRest
+  class Changes
+    VERSION = "0.0.1"
+  end
+end

data/lib/couchrest/changes.rb

@@ -0,0 +1,116 @@
+require 'couchrest'
+require 'fileutils'
+require 'pathname'
+
+require 'couchrest/changes/config'
+
+module CouchRest
+  class Changes
+
+    attr_writer :logger
+
+    def initialize(db_name)
+      db_name = Config.complete_db_name(db_name)
+      logger.info "Tracking #{db_name}"
+      @db = CouchRest.new(Config.couch_host).database(db_name)
+      @seq_filename = Config.seq_file
+      read_seq(@seq_filename)
+    end
+
+    # triggered when a document was newly created
+    def created(hash = {}, &block)
+      run_or_define_hook :created, hash, &block
+    end
+
+    # triggered when a document was deleted
+    def deleted(hash = {}, &block)
+      run_or_define_hook :deleted, hash, &block
+    end
+
+    # triggered when an existing document was updated
+    def updated(hash = {}, &block)
+      run_or_define_hook :updated, hash, &block
+    end
+
+    # triggered whenever a document was changed
+    def changed(hash = {}, &block)
+      run_or_define_hook :changed, hash, &block
+    end
+
+    def listen
+      logger.info "listening..."
+      logger.debug "Starting at sequence #{since}"
+      result = db.changes :feed => :continuous, :since => since, :heartbeat => 1000 do |hash|
+        callbacks(hash)
+        store_seq(hash["seq"])
+      end
+      logger.info "couch stream ended unexpectedly."
+      logger.debug result.inspect
+    end
+
+    protected
+
+    def logger
+      logger ||= Config.logger
+    end
+
+    def db
+      @db
+    end
+
+    def since
+      @since ||= 0  # fetch_last_seq
+    end
+
+    def callbacks(hash)
+      # let's not track design document changes
+      return if hash['id'].start_with? '_design/'
+      return unless changes = hash["changes"]
+      changed(hash)
+      return deleted(hash) if hash["deleted"]
+      return created(hash) if changes[0]["rev"].start_with?('1-')
+      updated(hash)
+    end
+
+    def run_or_define_hook(event, hash = {}, &block)
+      @callbacks ||= {}
+      if block_given?
+        @callbacks[event] = block
+      else
+        @callbacks[event] && @callbacks[event].call(hash)
+      end
+    end
+
+    def read_seq(seq_filename)
+      logger.debug "Looking up sequence here: #{seq_filename}"
+      FileUtils.touch(seq_filename)
+      unless File.writable?(seq_filename)
+        raise StandardError.new("Can't access sequence file")
+      end
+      @since = File.read(seq_filename)
+      if @since == ''
+        @since = nil
+        logger.debug "Found no sequence in the file."
+      else
+        logger.debug "Found sequence: #{@since}"
+      end
+    rescue Errno::ENOENT => e
+      logger.warn "No sequence file found. Starting from scratch"
+    end
+
+    def store_seq(seq)
+      File.write @seq_filename, MultiJson.dump(seq)
+    end
+
+    #
+    # UNUSED: this is useful for only following new sequences.
+    # might also require .to_json to work on bigcouch.
+    #
+    def fetch_last_seq
+      hash = db.changes :limit => 1, :descending => true
+      logger.info "starting at seq: " + hash["last_seq"]
+      return hash["last_seq"]
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+BASE_DIR = File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('lib', BASE_DIR)
+
+require 'mocha/setup'
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: couchrest_changes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Azul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syslog_logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Watches the couch database for changes and triggers callbacks defined
+  for creation, deletes and updates.
+email:
+- azul@leap.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/couchrest/changes/config.rb
+- lib/couchrest/changes/version.rb
+- lib/couchrest/changes.rb
+- Rakefile
+- Readme.md
+- test/test_helper.rb
+homepage: https://leap.se
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: CouchRest::Changes - Observe a couch database for changes and react upon
+  them
+test_files:
+- test/test_helper.rb