bellbro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f5c30f13ccf46c9dd3ab5f9cf072da6fcbfb37e
+  data.tar.gz: 44a25b8367eaa4b1e5a32a9f6546784e96dd9b79
+SHA512:
+  metadata.gz: ee77afd18e299eded56c87e06209d3b34eb9e2984c96c7ee0e00de4ecb98fd35836e0da04bee7f9b45596bbf38640b1744963f86d04e1c7028b89218849cb783
+  data.tar.gz: cf0a2c25af94a25d6e7ed6e0ec8fb992b7577adeb6674d0293c378278a688e9c306b81caa295476e96c986c94a954fe50ff5a134b4ad27f9c969ea4e728e5ed9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+/.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bellbro.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jon Stokes
+
+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.md

@@ -0,0 +1,2 @@
+# bellbro
+A collection of utils that I use in my apps when working the sidekiq. You may or may not find them useful.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bellbro.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bellbro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bellbro"
+  spec.version       = Bellbro::VERSION
+  spec.authors       = ["Jon Stokes"]
+  spec.email         = ["jon@jonstokes.com"]
+  spec.summary       = %q{Helps with sidekiq.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq"
+  spec.add_dependency "redis"
+
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/bellbro/notifier.rb

@@ -0,0 +1,14 @@
+module Bellbro
+  module Notifier
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    def notify(logline, opts={})
+      domain_insert = @domain ? "[#{@domain}]": ""
+      error_insert = (opts[:type] == :error) ? "##ERROR## " : ""
+      complete_logline = "[#{self.class}](#{Thread.current.object_id})#{domain_insert}: #{error_insert}#{logline}"
+      $log.info complete_logline
+    end
+  end
+end

data/lib/bellbro/retryable.rb

@@ -0,0 +1,67 @@
+module Bellbro
+  module Retryable
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    # Options:
+    # * :tries - Number of retries to perform. Defaults to 1.
+    # * :on - The Exception on which a retry will be performed. Defaults to Exception, which retries on any Exception.
+    #
+    # Example
+    # =======
+    #   retryable(:tries => 1, :on => OpenURI::HTTPError) do
+    #     # your code here
+    #   end
+    #
+
+    def retryable(options = {}, &block)
+      opts = { :tries => 5, :on => Exception, :sleep => 1 }.merge(options)
+      retry_exception, retries, interval = opts[:on], opts[:tries], opts[:sleep]
+
+      begin
+        return yield
+      rescue retry_exception
+        sleep interval
+        retry unless (retries -= 1).zero?
+      end
+      yield
+    end
+
+    def retryable_with_success(options = {}, &block)
+      opts = { :tries => 5, :on => Exception, :sleep => 1 }.merge(options)
+      retry_exception, retries, interval = opts[:on], opts[:tries], opts[:sleep]
+
+      success = false
+      begin
+        yield
+        success = true
+      rescue retry_exception
+        sleep interval
+        retry unless (retries -= 1).zero?
+      end
+      success
+    end
+
+    def retryable_with_aws(options = {}, &block)
+      # This is for use with AWS-based models. I find I get a lot of these timeouts and
+      # OpenSSL errors, and sometimes the connection dies and I need to create a new
+      # connection object. I put this in a method called aws_connect!.
+      #
+      opts = { :tries => 10, :on => Exception, :sleep => 1 }.merge(options)
+      retry_exception, retries, interval = opts[:on], opts[:tries], opts[:sleep]
+
+      begin
+        return yield
+      rescue OpenSSL::SSL::SSLError, Timeout::Error
+        sleep interval
+        aws_connect!
+        retry unless (retries -= 1).zero?
+      rescue retry_exception
+        sleep interval
+        retry unless (retries -= 1).zero?
+      end
+      yield
+    end
+  end
+end

data/lib/bellbro/sidekiq_utils.rb

@@ -0,0 +1,74 @@
+module Bellbro
+  module SidekiqUtils
+
+    def workers
+      Sidekiq::Workers.new.map do |process_id, thread_id, worker|
+        worker
+      end
+    end
+
+    def workers_for_queue(q)
+      workers.select do |worker|
+        worker_queue(worker) == q
+      end
+    end
+
+    def workers_for_class(klass)
+      workers.select do |worker|
+        worker_class(worker) == klass
+      end
+    end
+
+    def worker_jid(worker)
+      worker["payload"]["jid"] if worker["payload"]
+    end
+
+    def worker_domain(worker)
+      worker["payload"]["args"].first["domain"] if worker["payload"] && worker["payload"]["args"].try(:any?)
+    end
+
+    def worker_time(worker)
+      worker["run_at"]
+    end
+
+    def worker_class(worker)
+      worker["payload"]["class"] if worker["payload"]
+    end
+
+    def worker_queue(worker)
+      worker["queue"]
+    end
+
+    def jobs_for_queue(q)
+      Sidekiq::Queue.new(q)
+    end
+
+    def jobs_for_class(klass)
+      queues.map do |q|
+        jobs_for_queue(q).select { |job| job.klass == klass }
+      end.flatten
+    end
+
+    def job_domain(job)
+      job.args.first["domain"] if job.args.any?
+    end
+
+    def job_jid(job)
+      job.jid
+    end
+
+    def number_of_active_workers(q_name)
+      workers_for_queue(q_name).count
+    end
+
+    def queues
+      Sidekiq::Stats::Queues.new.lengths.keys
+    end
+
+    def clear_all_queues
+      queues.each do |q|
+        clear_queue(q)
+      end
+    end
+  end
+end

data/lib/bellbro/trackable.rb

@@ -0,0 +1,82 @@
+module Bellbro
+  module Trackable
+    include Bellbro::Retryable
+    attr_reader :record
+
+    def track(opts={})
+      return if @log_record_schema # Ignore repeated calls to #track, as in RefreshLinksWorker
+      opts.symbolize_keys!
+      @log_record_schema = self.class::LOG_RECORD_SCHEMA
+      @write_interval = opts[:write_interval] || 500
+      @count = 0
+      @tracking = true
+      initialize_log_record
+      status_update(true)
+    end
+
+    def status_update(force = false)
+      return unless force || ((@count += 1) % @write_interval) == 0
+      retryable { $log.info(@record.to_json) }
+    end
+
+    def record_set(attr, value)
+      attr = attr.to_sym
+      validate(attr => value)
+      @record[:data][attr] = value
+    end
+
+    def record_incr(attr)
+      attr = attr.to_sym
+      validate(attr => 1)
+      @record[:data][attr] += 1
+    end
+
+    def stop_tracking
+      @record[:complete] = true
+      @record[:stopped] = Time.now.utc.iso8601
+      @tracking = false
+      status_update(true)
+    end
+
+    def tracking?
+      !!@tracking
+    end
+
+    private
+
+    def initialize_log_record
+      @record = {
+          host:   Socket.gethostname,
+          agent: {
+              name:   "#{self.class.name}",
+              thread: "#{Thread.current.object_id}",
+              jid:    self.jid,
+          },
+          domain: @site.try(:domain) || @domain,
+          complete: false,
+          started: Time.now.utc.iso8601,
+          data: {}
+      }
+
+      self.class::LOG_RECORD_SCHEMA.each do |k, v|
+        if v == Integer
+          @record[:data][k] = 0
+        else
+          @record[:data][k] = v.new
+        end
+      end
+    end
+
+    def log_record_attributes
+      @log_record_schema.keys + [:jid, :agent, :archived]
+    end
+
+    def validate(attrs)
+      attrs.each do |attr, value|
+        raise "Invalid attribute #{attr}" unless log_record_attributes.include?(attr)
+        raise "Invalid type for #{attr}" unless [value.class, value.class.superclass].include?(self.class::LOG_RECORD_SCHEMA[attr])
+      end
+    end
+
+  end
+end

data/lib/bellbro/validator_redis_pool.rb

@@ -0,0 +1,22 @@
+module Bellbro
+  module RedisPool
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    def with_redis(&block)
+      retryable(sleep: 0.5) do
+        redis_pool.with &block
+      end
+    end
+
+    def redis_pool
+      @redis_pool
+    end
+
+    def redis_pool=(pool)
+      @redis_pool = pool
+    end
+  end
+
+end

data/lib/bellbro/version.rb

@@ -0,0 +1,3 @@
+module Bellbro
+  VERSION = "0.0.1"
+end

data/lib/bellbro.rb

@@ -0,0 +1,5 @@
+require "bellbro/version"
+
+module Bellbro
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bellbro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Stokes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: sidekiq
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: redis
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+- jon@jonstokes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bellbro.gemspec
+- lib/bellbro.rb
+- lib/bellbro/notifier.rb
+- lib/bellbro/retryable.rb
+- lib/bellbro/sidekiq_utils.rb
+- lib/bellbro/trackable.rb
+- lib/bellbro/validator_redis_pool.rb
+- lib/bellbro/version.rb
+homepage: ''
+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.4.5
+signing_key:
+specification_version: 4
+summary: Helps with sidekiq.
+test_files: []