phobos_db_checkpoint 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5b26c404a1ef381a22acb11321da68ff796a07
-  data.tar.gz: f70ffacba27f60a03be78c40caef88af565d61b0
+  metadata.gz: bf7c86a517c50d731d343b8cbf72f7fcacd413a4
+  data.tar.gz: ca87a4ce8ce804edcfdbc6cbc991404730bc8524
 SHA512:
-  metadata.gz: e06985bb11ffc04fb94e00dcbedb158aa423643958e50cef89645e9dbf80c03bc7af391323c1483e32f9770deec18e27b1ba48a10fd1ac4537edcd4995c68a54
-  data.tar.gz: f152ff0bc835ee77cb10f9ba5c238eaaef7d33abea0556ded954ed30ea65fe8fe54a727a4672aadf4084ac868c14866894c47ad541a4ba6a09633a1272bcebf5
+  metadata.gz: dab2ad650f6fe21d495ac3a6d2f8645907d17e39299c509c48f95f7f0005af4d88887b63b1a2a41f959f213626de8550159d6a8b1b14a04b043f7e0a95dfde0e
+  data.tar.gz: 6ac30e2f38f7d54e9ec1dd44266f113872deadd8f53aedfcded766a60096ce9aff0c7ef527aea866ba479f71dd697a8e96a762c7e9b72ab969574bc29bf903e0

data/.gitignore

@@ -13,3 +13,5 @@ spec/examples.txt
 spec/setup/
 spec/tmp/
 .byebug_history
+log/
+spec/log/

data/CHANGELOG.md

@@ -4,12 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.0 (2016-10-10)
+
+- [feature] Built-in sinatra APP with events API
+
 ## 0.2.0 (2016-09-06)
+
 - [feature] New CLI command to generate migrations #6
 - [feature] Automatically sets database pool size based on listeners max_concurrency #2
 
 ## 0.1.1 (2016-09-02)
+
 - [bugfix] Handler is not injecting start and stop methods #4
 
 ## 0.1.0 (2016-08-29)
+
 - Published on Github

data/README.md

@@ -15,6 +15,7 @@ Phobos DB Checkpoint is a plugin to [Phobos](https://github.com/klarna/phobos) a
   1. [Setup](#setup)
   1. [Handler](#handler)
   1. [Accessing the events](#accessing-the-events)
+  1. [Events API](#events-api)
   1. [Instrumentation](#instrumentation)
 1. [Development](#development)
 
@@ -122,6 +123,46 @@ Note that the `PhobosDBCheckpoint::Handler` will automatically skip already hand
 
 `PhobosDBCheckpoint::Event` is a plain `ActiveRecord::Base` model, feel free to play with it.
 
+### <a name="events-api"></a> Events API
+
+Phobos DB Checkpoint comes with a sinatra app which makes the event manipulation easy through its JSON API.
+
+The __init_events_api__ command will generate a `config.ru` ready to use:
+
+```sh
+$ phobos_db_checkpoint init_events_api
+   create  config.ru
+   Start the API with: `rackup config.ru`
+```
+
+```sh
+$ curl "http://localhost:9292/v1/events/1"
+# {
+#   "id": 1,
+#   "topic": "test-partitions",
+#   "group_id": "test-checkpoint-1",
+#   "entity_id": "1",
+#   "event_time": "2016-09-19T19:35:26.854Z",
+#   "event_type": "create",
+#   "event_version": "v1",
+#   "checksum": "188773471ec0f898fd81d272760a027f",
+#   "payload": "{\"a\":\"b\"}"
+# }
+```
+
+The available routes are:
+
+* GET `/ping`
+* GET `/v1/events/:id`
+* GET `/v1/events` This route accepts the following params:
+  * `limit`, default: 20
+  * `offset`, default: 0
+  * `entity_id`
+  * `topic`
+  * `group_id`
+  * `event_type`
+* POST `/v1/events/:id/retry`
+
 ### <a name="instrumentation"></a> Instrumentation
 
 Some operations are instrumented using [Phobos::Instrumentation](https://github.com/klarna/phobos#usage-instrumentation)

data/lib/phobos_db_checkpoint.rb

@@ -12,13 +12,14 @@ module PhobosDBCheckpoint
   DEFAULT_DB_DIR = 'db'.freeze
   DEFAULT_MIGRATION_PATH = File.join(DEFAULT_DB_DIR, 'migrate').freeze
   DEFAULT_DB_CONFIG_PATH = 'config/database.yml'.freeze
+  DEFAULT_POOL_SIZE = 5.freeze
 
   class << self
     attr_reader :db_config
     attr_accessor :db_config_path, :db_dir, :migration_path
 
-    def configure
-      load_db_config
+    def configure(pool_size: nil)
+      load_db_config(pool_size: pool_size)
       at_exit { PhobosDBCheckpoint.close_db_connection }
       ActiveRecord::Base.establish_connection(db_config)
     end
@@ -27,15 +28,16 @@ module PhobosDBCheckpoint
       ENV['RAILS_ENV'] ||= ENV['RACK_ENV'] ||= 'development'
     end
 
-    def load_db_config
+    def load_db_config(pool_size: nil)
       @db_config_path ||= DEFAULT_DB_CONFIG_PATH
       configs = YAML.load_file(File.expand_path(@db_config_path))
       @db_config = configs[env]
 
-      if Phobos.config
+      if pool_size.nil? && Phobos.config
         pool_size = Phobos.config.listeners.map { |listener| listener.max_concurrency || 1 }.inject(&:+)
-        @db_config.merge!('pool' => pool_size)
       end
+
+      @db_config.merge!('pool' => pool_size || DEFAULT_POOL_SIZE)
     end
 
     def close_db_connection

data/lib/phobos_db_checkpoint/cli.rb

@@ -66,6 +66,12 @@ module PhobosDBCheckpoint
         template(new_migration_template, destination_fullpath)
       end
 
+      desc 'init-events-api', 'Initialize your project with events API'
+      def init_events_api
+        copy_file 'templates/config.ru', 'config.ru'
+        say '   Start the API with: `rackup config.ru`'
+      end
+
       def self.source_root
         File.expand_path(File.join(File.dirname(__FILE__), '../..'))
       end

data/lib/phobos_db_checkpoint/event.rb

@@ -14,6 +14,14 @@ module PhobosDBCheckpoint
       save!
     end
 
+    def configured_handler
+      Phobos
+        .config
+        .listeners
+        .find { |listener| listener.group_id == self.group_id }
+        &.handler
+    end
+
     private
 
     def assign_checksum

data/lib/phobos_db_checkpoint/events_api.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'rack'
+require 'sinatra/base'
+
+require 'phobos_db_checkpoint/middleware/logger'
+require 'phobos_db_checkpoint/middleware/database'
+
+module PhobosDBCheckpoint
+  class EventsAPI < Sinatra::Base
+    VERSION = :v1
+    set :logging, nil
+
+    not_found do
+      content_type :json
+      { error: true, message: 'not found' }.to_json
+    end
+
+    error ActiveRecord::RecordNotFound do
+      content_type :json
+      status 404
+      { error: true, message: 'event not found' }.to_json
+    end
+
+    error StandardError do
+      content_type :json
+      error = env['sinatra.error']
+      { error: true, message: error.message }.to_json
+    end
+
+    get '/ping' do
+      'PONG'
+    end
+
+    get "/#{VERSION}/events/:id" do
+      content_type :json
+      PhobosDBCheckpoint::Event
+        .find(params['id'])
+        .to_json
+    end
+
+    post "/#{VERSION}/events/:id/retry" do
+      content_type :json
+      event = PhobosDBCheckpoint::Event.find(params['id'])
+      handler_name = event.configured_handler
+
+      unless handler_name
+        status 422
+        return { error: true, message: 'no handler configured for this event' }.to_json
+      end
+
+      handler_class = handler_name.constantize
+      metadata = { listener_id: 'events_api/retry', group_id: event.group_id, topic: event.topic, retry_count: 0 }
+      event_action = handler_class.new.consume(event.payload, metadata)
+
+      { acknowledged: event_action.is_a?(PhobosDBCheckpoint::Ack) }.to_json
+    end
+
+    get "/#{VERSION}/events" do
+      content_type :json
+      limit = (params['limit'] || 20).to_i
+      offset = (params['offset'] || 0).to_i
+
+      query = PhobosDBCheckpoint::Event
+      query = query.where(topic: params['topic']) if params['topic']
+      query = query.where(group_id: params['group_id']) if params['group_id']
+      query = query.where(entity_id: params['entity_id']) if params['entity_id']
+      query = query.where(event_type: params['event_type']) if params['event_type']
+
+      query
+        .order(event_time: :desc)
+        .limit(limit)
+        .offset(offset)
+        .to_json
+    end
+  end
+end

data/lib/phobos_db_checkpoint/middleware/database.rb

@@ -0,0 +1,20 @@
+module PhobosDBCheckpoint
+  module Middleware
+    class Database
+
+      def initialize(app, options = {})
+        @app = app
+        pool_size = options.fetch(:pool_size, PhobosDBCheckpoint::DEFAULT_POOL_SIZE)
+        PhobosDBCheckpoint.configure(pool_size: pool_size)
+      end
+
+      def call(request_env)
+        ActiveRecord::Base.connection_pool.with_connection do
+          @app.call(request_env)
+        end
+      ensure
+        ActiveRecord::Base.clear_active_connections!
+      end
+    end
+  end
+end

data/lib/phobos_db_checkpoint/middleware/logger.rb

@@ -0,0 +1,68 @@
+require 'rack'
+
+module PhobosDBCheckpoint
+  module Middleware
+    class Logger
+      RACK_LOGGER    = 'rack.logger'.freeze
+      SINATRA_ERROR  = 'sinatra.error'.freeze
+      HTTP_VERSION   = 'HTTP_VERSION'.freeze
+      PATH_INFO      = 'PATH_INFO'.freeze
+      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+      QUERY_STRING   = 'QUERY_STRING'.freeze
+      CONTENT_LENGTH = 'Content-Length'.freeze
+
+      def initialize(app, options = {})
+        @app = app
+        Phobos.configure(options.fetch(:config, 'config/phobos.yml'))
+        Phobos.config.logger.file = options.fetch(:log_file, 'log/api.log')
+        Phobos.configure_logger
+        ActiveRecord::Base.logger = Phobos.logger
+      end
+
+      def call(request_env)
+        began_at = Time.now
+        request_env[RACK_LOGGER] = Phobos.logger
+        status, header, body = @app.call(request_env)
+        header = Rack::Utils::HeaderHash.new(header)
+        body = Rack::BodyProxy.new(body) do
+          log(request_env, status, header, began_at)
+        end
+        [status, header, body]
+      end
+
+      private
+
+      def log(request_env, status, header, began_at)
+        error = request_env[SINATRA_ERROR]
+        message = {
+          remote_address: request_env['HTTP_X_FORWARDED_FOR'] || request_env['REMOTE_ADDR'],
+          remote_user: request_env['REMOTE_USER'],
+          request_method: request_env[REQUEST_METHOD],
+          path: extract_path(request_env),
+          status: status.to_s[0..3],
+          content_length: extract_content_length(header),
+          request_time: "#{Time.now - began_at}s"
+        }
+
+        if error
+          Phobos.logger.error(message.merge(
+            exception_class: error.class.to_s,
+            exception_message: error.message,
+            backtrace: error.backtrace
+          ))
+        else
+          Phobos.logger.info(message)
+        end
+      end
+
+      def extract_path(request_env)
+        "#{request_env[PATH_INFO]}#{request_env[QUERY_STRING].empty? ? "" : "?#{request_env[QUERY_STRING]}"} #{request_env[HTTP_VERSION]}"
+      end
+
+      def extract_content_length(headers)
+        value = headers[CONTENT_LENGTH] or return
+        value.to_s == '0' ? nil : value
+      end
+    end
+  end
+end

data/lib/phobos_db_checkpoint/version.rb

@@ -1,3 +1,3 @@
 module PhobosDBCheckpoint
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/phobos_db_checkpoint.gemspec

@@ -51,9 +51,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'rspec_junit_formatter', '0.2.2'
+  spec.add_development_dependency 'rack-test'
 
   spec.add_dependency 'thor'
   spec.add_dependency 'rake'
   spec.add_dependency 'activerecord', '>= 4.0.0'
   spec.add_dependency 'phobos', '>= 1.0.0'
+  spec.add_dependency 'sinatra'
 end

data/templates/config.ru

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'phobos_db_checkpoint'
+require 'phobos_db_checkpoint/events_api'
+require_relative './phobos_boot.rb'
+
+logger_config = {
+  # config: 'config/phobos.yml'
+  # log_file: 'log/api.log'
+}
+
+database_config = {
+  # pool_size: PhobosDBCheckpoint::DEFAULT_POOL_SIZE # 5
+}
+
+use PhobosDBCheckpoint::Middleware::Logger, logger_config
+use PhobosDBCheckpoint::Middleware::Database, database_config
+run PhobosDBCheckpoint::EventsAPI

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos_db_checkpoint
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +211,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in
   replacement to Phobos::Handler
 email:
@@ -226,10 +254,14 @@ files:
 - lib/phobos_db_checkpoint/cli.rb
 - lib/phobos_db_checkpoint/event.rb
 - lib/phobos_db_checkpoint/event_actions.rb
+- lib/phobos_db_checkpoint/events_api.rb
 - lib/phobos_db_checkpoint/handler.rb
+- lib/phobos_db_checkpoint/middleware/database.rb
+- lib/phobos_db_checkpoint/middleware/logger.rb
 - lib/phobos_db_checkpoint/tasks.rb
 - lib/phobos_db_checkpoint/version.rb
 - phobos_db_checkpoint.gemspec
+- templates/config.ru
 - templates/database.yml.example
 - templates/migrate/phobos_01_create_events.rb.erb
 - templates/new_migration.rb.erb