upperkut 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86cdd27d527086fd910ae6065716239959e2948b
-  data.tar.gz: 2556072af6d5b2ba93dffdcccb3c2c8f7dd7da22
+  metadata.gz: 837693381be84b252c08cf7078f1cf5b6d7b54db
+  data.tar.gz: 9a6d1e0240d2d26d7c44b1b997c8b8808e043c0a
 SHA512:
-  metadata.gz: 2d758d766b00c8a094d1a83a97a1632abfdbc6406867c47379e54876a837232c526be01bb4e1aea723852c6e0af8f248afae584f3ad053dbd8311f7bd1aec019
-  data.tar.gz: ced16ccf12783e7a23f4cb13405da13a9c1a860b6e0b607a1822ac9feb6f3545fb2cada50a930c9df04fe8e973cbef4962d5e7f773feb2457848565138cdc90d
+  metadata.gz: e9bcf4d0f46b33feddb133cac352861148e6db064d3c714447ce8b25f03eeb766f4c88516d1a6a522f93af4e51a85bfb55effa7db0e56e6204e4e9102a76ed5b
+  data.tar.gz: cfcacc14f495f5121a3d86d3f57752eab98a8010cd26fe4fcef6d7b4c1552a5077d2d8ad2e3c8f11e4d7f81340a2d3617cc8dc0f7227ecdcb95c8c7993c9d70f

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.4
+        environment:
+          CC_TEST_REPORTER_ID: 03ab83a772148a577d29d4acf438d7ebdc95c632224122d0ba8dbb291eedebe6
+          COVERAGE: true
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+            ./cc-test-reporter before-build
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+      - run:
+          name: Submit coverage
+          command: |
+            ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile

@@ -6,4 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem 'fakeredis'
+gem 'fivemat'
 gem 'pry'
+gem 'rspec_junit_formatter'
+gem 'simplecov', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    upperkut (0.3.0)
+    upperkut (0.1.4)
       redis (>= 3.3.5, < 5)
 
 GEM
@@ -9,8 +9,11 @@ GEM
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     fakeredis (0.7.0)
       redis (>= 3.2, < 5.0)
+    fivemat (1.3.6)
+    json (2.1.0)
     method_source (0.9.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -30,6 +33,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
 
 PLATFORMS
   ruby
@@ -37,9 +47,12 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   fakeredis
+  fivemat
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter
+  simplecov
   upperkut!
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,9 @@
 # Upperkut
 
+[![CircleCI](https://circleci.com/gh/ResultadosDigitais/upperkut/tree/master.svg?style=svg&circle-token=693e512de6985be3b3db12279ba6ed508fb5c6f6)](https://circleci.com/gh/ResultadosDigitais/upperkut/tree/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ece40319b0db03af891d/maintainability)](https://codeclimate.com/repos/5b318a7c6d37b70272008676/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ece40319b0db03af891d/test_coverage)](https://codeclimate.com/repos/5b318a7c6d37b70272008676/test_coverage)
+
 Batch background processing tool.
 
 ## Installation
@@ -72,7 +76,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/upperkut. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ResultadosDigitais/upperkut. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -80,4 +84,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Upperkut project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/upperkut/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Upperkut project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ResultadosDigitais/upperkut/blob/master/CODE_OF_CONDUCT.md).

data/examples/basic.rb

@@ -5,7 +5,7 @@ class MyWorker
 
   def perform(items)
     puts 'starting performing'
-    exec_time = rand(90..500)
+    exec_time = rand(9000..50000)
     sleep (exec_time.to_f / 1000.to_f)
     puts "performed #{items.size} items in #{exec_time.to_f / 1000.to_f} ms"
   end

data/examples/with_middlewares.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/upperkut/worker'
+
+class MyMiddleware
+  def call(worker, items)
+    logger = Upperkut::Logging.logger
+
+    logger.info("performing worker=#{worker} items=#{items.count}")
+    yield
+    logger.info("performed worker=#{worker} items=#{items.count}")
+  end
+end
+
+class WithMiddlewares
+  include Upperkut::Worker
+
+  setup_upperkut do |config|
+    config.middlewares do |chain|
+      chain.add MyMiddleware
+    end
+  end
+
+  def perform(items)
+    puts "executing........."
+    exec_time = rand(80..200)
+    sleep (exec_time.to_f / 1000.to_f)
+  end
+end

data/lib/upperkut/batch_execution.rb

@@ -9,18 +9,23 @@ module Upperkut
 
     def execute
       worker_instance = @worker.new
-      items  = @worker.fetch_items.collect! do |item|
+      items = @worker.fetch_items.freeze
+
+      items_body = items.collect do |item|
         item['body']
       end
 
-      worker_instance.perform(items.dup)
+      @worker.middlewares.invoke(@worker, items) do
+        worker_instance.perform(items_body.dup)
+      end
+
     rescue Exception => ex
-      @worker.push_items(items)
+      @worker.push_items(items_body)
 
       @logger.info(
         action: :requeue,
         ex: ex,
-        item_size: items.size
+        item_size: items_body.size
       )
 
       raise ex

data/lib/upperkut/middleware.rb

@@ -0,0 +1,34 @@
+module Upperkut
+  module Middleware
+    class Chain
+      attr_reader :items
+
+      def initialize
+        @items = []
+      end
+
+      def add(item)
+        return @items if @items.include?(item)
+        @items << item
+      end
+
+      def remove(item)
+        @items.delete(item)
+      end
+
+      def invoke(*args)
+        chain = @items.map(&:new)
+
+        traverse_chain = lambda do
+          if chain.empty?
+            yield
+          else
+            chain.shift.call(*args, &traverse_chain)
+          end
+        end
+
+        traverse_chain.call
+      end
+    end
+  end
+end

data/lib/upperkut/middlewares/new_relic.rb

@@ -0,0 +1,23 @@
+module Upperkut
+  module Middlewares
+    class NewRelic
+      include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+      def call(worker, _items)
+        perform_action_with_newrelic_trace(trace_args(worker)) do
+          yield
+        end
+      end
+
+      private
+
+      def trace_args(worker)
+        {
+          'name'       => 'perform',
+          'class_name' => worker.class.name,
+          'category'   => 'OtherTransaction/UpperkutWorker'
+        }
+      end
+    end
+  end
+end

data/lib/upperkut/version.rb

@@ -1,3 +1,3 @@
 module Upperkut
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/upperkut/worker.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require_relative 'strategy'
+require_relative 'middleware'
 require_relative './util'
 require_relative '../upperkut'
 
@@ -12,7 +13,7 @@ module Upperkut
     module ClassMethods
       extend Forwardable
 
-      def_delegators :setup, :strategy
+      def_delegators :setup, :strategy, :middlewares
       def_delegators :strategy, :push_items, :size, :latency, :clear
 
       def push_items(items)

data/lib/upperkut.rb

@@ -61,6 +61,26 @@ module Upperkut
         config.polling_interval = Integer(ENV['UPPERKUT_POLLING_INTERVAL'] || 5)
       end
     end
+
+    def middlewares
+      @middlewares ||= init_middleware_chain
+      yield @middlewares if block_given?
+      @middlewares
+    end
+
+    private
+
+    def init_middleware_chain
+      chain = Middleware::Chain.new
+      if defined?(NewRelic::Agent)
+        require_relative 'upperkut/middlewares/new_relic'
+
+        chain.add(Upperkut::Middlewares::NewRelic)
+      end
+
+      chain
+    end
+
   end
 
   # Error class responsible to signal the shutdown process

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upperkut
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -80,9 +80,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -91,12 +91,15 @@ files:
 - Rakefile
 - bin/upperkut
 - examples/basic.rb
+- examples/with_middlewares.rb
 - lib/upperkut.rb
 - lib/upperkut/batch_execution.rb
 - lib/upperkut/cli.rb
 - lib/upperkut/core_ext.rb
 - lib/upperkut/logging.rb
 - lib/upperkut/manager.rb
+- lib/upperkut/middleware.rb
+- lib/upperkut/middlewares/new_relic.rb
 - lib/upperkut/processor.rb
 - lib/upperkut/strategy.rb
 - lib/upperkut/util.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.1