bellbro 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120efff8ea0e78fb3d66c956710c992b334f7b2c
-  data.tar.gz: 4b60e315848cac0223753b75cdf272cea8faaa73
+  metadata.gz: 68c58a1bb724a51d658a0d973c83c361360c8d86
+  data.tar.gz: 45a769183a5357bd3bcfcbf63bcb0c8ae16c33b6
 SHA512:
-  metadata.gz: 85942bd6428e156b6dc0491817a04a2a14f01d52c756679eefdea32595b399123c893f0e46b30cfb5ba2d7f91411ff83b1f1ffdbee91eaade4f1994503674caa
-  data.tar.gz: bbbac39c8e0006e740bd495c70d1147a07a37ee1a72b0263df63eccdf9d85d9a0c5b18bcf05934d9b3670e8edf41175b6512e7513d7f813353d73f339416b8c8
+  metadata.gz: 2bfaa5bd73233a5a3a6324cad5f9f8683e05164ee71789e90a0a63ae30130ac5ae5d84423d3369ca8d9caac4580b5c0a17b3eedbace79b903a99d8aa93fd70f7
+  data.tar.gz: 51bd64416a5555b91974b44698273304073401e1eb4379e621ee7749c74d0f2ee135f4b5dfbef4b23b929ee56f28efcb5ffd7ae8367326d14655335fc7348e5b

data/.gitignore

@@ -11,6 +11,7 @@
 *.so
 *.o
 *.a
-mkmf.log
+*.log
 *.gem
 /.idea/
+.rspec

data/bellbro.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "sidekiq"
   spec.add_dependency "redis"
   spec.add_dependency "airbrake"
@@ -24,4 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yell"
 end

data/lib/bellbro/bell.rb

@@ -1,7 +1,7 @@
 module Bellbro
   class Bell
     include Bellbro::Retryable
-    include Bellbro::Ringer
+    include Bellbro::Ringable
   end
 end
 

data/lib/bellbro/{ringer.rb → ringable.rb}

@@ -1,5 +1,5 @@
 module Bellbro
-  module Ringer
+  module Ringable
     def self.included(klass)
       klass.extend(self)
     end

data/lib/bellbro/service.rb

@@ -5,7 +5,7 @@ module Bellbro
     include Bellbro::SidekiqUtils
     include Bellbro::Trackable
 
-    SLEEP_INTERVAL = Rails.env.test? ? 1 : 3600
+    SLEEP_INTERVAL = defined?(Rails) && Rails.env.test? ? 1 : 3600
     LOG_RECORD_SCHEMA = { jobs_started: Integer }
 
     attr_reader :thread, :thread_error, :jid

data/lib/bellbro/trackable.rb

@@ -1,12 +1,27 @@
 module Bellbro
   module Trackable
     include Bellbro::Retryable
+
     attr_reader :record
 
+    def self.included(klass)
+      class << klass
+        def track_with_schema(hash)
+          self.class_eval do
+            @log_record_schema = hash
+          end
+        end
+
+        def log_record_schema
+          @log_record_schema
+        end
+      end
+    end
+
     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
+      @log_record_schema = self.class.log_record_schema
       @write_interval = opts[:write_interval] || 500
       @count = 0
       @tracking = true
@@ -16,7 +31,11 @@ module Bellbro
 
     def status_update(force = false)
       return unless force || ((@count += 1) % @write_interval) == 0
-      retryable { $log.info(@record.to_json) }
+      retryable { write_log(@record.to_json) }
+    end
+
+    def write_log(line)
+      Bellbro.logger.info line
     end
 
     def record_set(attr, value)
@@ -50,7 +69,7 @@ module Bellbro
           agent: {
               name:   "#{self.class.name}",
               thread: "#{Thread.current.object_id}",
-              jid:    self.jid,
+              jid:    jid,
           },
           domain: @site.try(:domain) || @domain,
           complete: false,
@@ -58,7 +77,7 @@ module Bellbro
           data: {}
       }
 
-      self.class::LOG_RECORD_SCHEMA.each do |k, v|
+      @log_record_schema.each do |k, v|
         if v == Integer
           @record[:data][k] = 0
         else
@@ -74,7 +93,7 @@ module Bellbro
     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])
+        raise "Invalid type for #{attr}" unless [value.class, value.class.superclass].include?(@log_record_schema[attr])
       end
     end
 

data/lib/bellbro/version.rb

@@ -1,3 +1,3 @@
 module Bellbro
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/bellbro/worker.rb

@@ -1,6 +1,7 @@
 module Bellbro
   class Worker < Bellbro::Bell
     include Sidekiq::Worker
+    include Bellbro::Trackable
     extend Bellbro::SidekiqUtils
 
     attr_reader :domain

data/lib/bellbro.rb

@@ -1,7 +1,28 @@
 require "bellbro/version"
+require 'connection_pool'
+require 'active_support/all'
+require 'redis'
+require 'yaml'
+require 'digest'
+require 'sidekiq'
+require 'airbrake'
 
 module Bellbro
   def self.logger
     Bellbro::Settings.logger
   end
 end
+
+%w(
+    bellbro/settings.rb
+    bellbro/retryable.rb
+    bellbro/ringable.rb
+    bellbro/trackable.rb
+    bellbro/redis_pool.rb
+    bellbro/sidekiq_utils.rb
+    bellbro/bell.rb
+    bellbro/service.rb
+    bellbro/worker.rb
+).each do |path|
+  require File.join(File.dirname(__FILE__),path)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_support'
+require 'bellbro'
+require 'rspec'
+require 'yell'
+
+Dir[File.join(File.dirname(__FILE__),'../spec/support/**/*.rb')].each { |f| require f }
+#Dir[File.join(File.dirname(__FILE__),'../spec/factories/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = 'random'
+  #config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/bellbro.rb

@@ -0,0 +1,7 @@
+logger = Yell.new do |l|
+  l.level = [:debug, :info, :warn, :error]
+end
+
+Bellbro::Settings.configure do |config|
+  config.logger = logger
+end

data/spec/support/sidekiq.rb

@@ -0,0 +1,7 @@
+require 'sidekiq/api'
+def clear_sidekiq
+  Sidekiq::Worker.clear_all
+  %w(db_fast_high db_fast_low db_slow_high db_slow_low crawls crawl_images stretched).each do |q|
+    Sidekiq::Queue.new(q).clear
+  end
+end

data/spec/trackable_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'sidekiq/testing'
+Sidekiq::Testing.fake!
+
+class TrackWorker < Bellbro::Worker
+  track_with_schema(
+    links_created:    Integer,
+    listings_updated: Integer,
+    errors:           Array,
+    status:           String
+  )
+
+  def initialize(domain)
+    @domain = domain
+  end
+
+  def jid
+    "abc123"
+  end
+end
+
+describe Bellbro::Trackable do
+  before :each do
+    @worker = TrackWorker.new('www.retailer.com')
+    Sidekiq::Worker.clear_all
+  end
+
+  describe "#track" do
+    it "should properly initialize the log record" do
+      @worker.track
+      expect(@worker.record[:host]).to eq(Socket.gethostname)
+      expect(@worker.record[:agent][:name]).to eq('TrackWorker')
+      expect(@worker.record[:agent][:jid]).to eq('abc123')
+      expect(@worker.record[:data][:links_created]).to eq(0)
+      expect(@worker.record[:data][:listings_updated]).to eq(0)
+      expect(@worker.record[:data][:errors]).to be_empty
+    end
+  end
+
+  describe "#record_set" do
+    it "sets a record" do
+      @worker.track
+      @worker.record_set(:status, "Update")
+      expect(@worker.record[:data][:status]).to eq("Update")
+    end
+  end
+
+  describe "#record_incr" do
+    it "increments an integer record" do
+      @worker.track
+      5.times { @worker.record_incr(:links_created) }
+      expect(@worker.record[:data][:links_created]).to eq(5)
+    end
+  end
+
+  describe "#status_update" do
+    it "writes to the standard logger to update status" do
+      @worker.track(write_interval: 1)
+      @worker.record_incr(:links_created)
+      expect(@worker).to receive(:write_log)
+      @worker.status_update
+    end
+
+    it "does not reset the record data after each status update" do
+      @worker.track(write_interval: 1)
+      5.times { @worker.record_incr(:links_created) }
+      expect(@worker.record[:data][:links_created]).to eq(5)
+      2.times { @worker.status_update }
+      expect(@worker.record[:data][:links_created]).to eq(5)
+      expect(@worker.record.to_param).to include('links_created%5D=5')
+    end
+  end
+
+  describe "#validate" do
+    it "raises an error if an attribute is invalid" do
+      @worker.track
+      expect {
+        @worker.send(:validate, {foo: "bar"})
+      }.to raise_error(RuntimeError)
+    end
+
+    it "raises an error if a value is invalid" do
+      @worker.track
+      expect {
+        @worker.send(:validate, {links_created: "bar"})
+      }.to raise_error(RuntimeError)
+    end
+  end
+end

data/spec/worker_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'sidekiq/testing'
+
+describe Bellbro::Worker do
+  before :each do
+    Sidekiq::Testing.disable!
+    clear_sidekiq
+  end
+
+  after :each do
+    clear_sidekiq
+    Sidekiq::Testing.fake!
+  end
+
+  describe "#jobs_in_flight_with_domain" do
+    it "counts the number of enqueued jobs and active workers for a domain" do
+      domain = "www.retailer.com"
+      5.times { Bellbro::Worker.perform_async(domain: domain) }
+      expect(Bellbro::Worker.jobs_in_flight_with_domain(domain).count).to eq(5)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bellbro
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jon Stokes
@@ -10,6 +10,20 @@ 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: activesupport
+  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:
@@ -80,6 +94,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  prerelease: false
+  type: :development
+  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: yell
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - jon@jonstokes.com
@@ -97,13 +139,18 @@ files:
 - lib/bellbro/bell.rb
 - lib/bellbro/redis_pool.rb
 - lib/bellbro/retryable.rb
-- lib/bellbro/ringer.rb
+- lib/bellbro/ringable.rb
 - lib/bellbro/service.rb
 - lib/bellbro/settings.rb
 - lib/bellbro/sidekiq_utils.rb
 - lib/bellbro/trackable.rb
 - lib/bellbro/version.rb
 - lib/bellbro/worker.rb
+- spec/spec_helper.rb
+- spec/support/bellbro.rb
+- spec/support/sidekiq.rb
+- spec/trackable_spec.rb
+- spec/worker_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -128,4 +175,9 @@ rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: Helps with sidekiq.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/support/bellbro.rb
+- spec/support/sidekiq.rb
+- spec/trackable_spec.rb
+- spec/worker_spec.rb