streamline 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c06209f08a5c47cbef7e4e07932f563c3ff1e968
-  data.tar.gz: b3106d614435e118dad49658fb08007e7af1effa
+  metadata.gz: 96df0fff0c9d69ff55d765607f44313c9cb2e6ea
+  data.tar.gz: 2a139d717a813da7b97865794391ac0f5eab3973
 SHA512:
-  metadata.gz: f8f11ca2e4ba9cb215a3687e0dd5dbaf88aad2b7698a90f289998f13786e25aa3a215817da8d73fc4db13535cfd75afe367c435958740e48756a1e9a7649742b
-  data.tar.gz: fae0281c6a9f6a360884704829ee10bcefadb2ab2f3d0c2aeb352de579849b66cff1c2d89d415320643f29f794daa8d40d9f2dc6f43a87b9fe420e05bda570ff
+  metadata.gz: 17597e0b643b68fe5043711332a46d17df2658283b4d56ef8849286be8c209cca1be942bf16c2f7ea74775635e0340f8aeec41d784bc8e04dbd15f34be5062fa
+  data.tar.gz: 02dd2c67218e9343f0058e9504989481345790fc520fb89d7e34c0dbdb27e2958ef42a325ed33082caaf63e6d50e37134749ba534efd81644c878a3850bcd000

data/README.md

@@ -1,7 +1,73 @@
-# Airplane
+# Streamline
 
-[![Gem Version](https://badge.fury.io/rb/airplane.svg)](https://badge.fury.io/rb/airplane)
-[![Code Climate](https://codeclimate.com/github/atipugin/airplane/badges/gpa.svg)](https://codeclimate.com/github/atipugin/airplane)
-[![Build Status](https://travis-ci.org/atipugin/airplane.svg?branch=master)](https://travis-ci.org/atipugin/airplane)
+**Important! It's still early proof-of-concept. Use it on your own risk ;)**
 
-TODO: Write some meaningful description ;)
+Streamline allows you to organize event-based behavior of your app way more simpler.
+
+[![Gem Version](https://badge.fury.io/rb/streamline.svg)](https://badge.fury.io/rb/streamline)
+[![Code Climate](https://codeclimate.com/github/atipugin/streamline/badges/gpa.svg)](https://codeclimate.com/github/atipugin/streamline)
+[![Build Status](https://travis-ci.org/atipugin/streamline.svg?branch=master)](https://travis-ci.org/atipugin/streamline)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'streamline'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it system-wide:
+
+```
+$ gem install streamline
+```
+
+## Setup
+
+First of all, you have to select a [data store](#data-stores) for your events. Let's take ActiveRecord store for example:
+
+```shell
+$ rails generate streamline:stores:active_record
+```
+
+It will generate all neccessary files (a model and migration file in this case).
+
+Next, you need to configure ActiveJob adapter (if you haven't done it yet). Streamline uses background jobs a lot and usage of ActiveJob allows us to support [as many queuing backends as possible](http://edgeguides.rubyonrails.org/active_job_basics.html#backends).
+
+Imagine your app already uses Sidekiq. Just add the following line to your `application.rb`:
+
+```ruby
+config.active_job.queue_adapter = :sidekiq
+```
+
+Then add `streamline` queue to your `sidekiq.yml`.
+
+You're almost done! It's time to set up handlers and track some events.
+
+## Handlers
+
+...
+
+## Event tracking
+
+...
+
+## Data stores
+
+Streamline supports following event stores:
+
+- ActiveRecord (PostgreSQL, MySQL, SQLite etc)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/lib/generators/streamline/stores/templates/active_record/create_events.rb.tt

@@ -1,14 +1,12 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
-    create_table :streamline_events, id: false do |t|
-      t.uuid :id, primary_key: true
+    create_table :streamline_events do |t|
       t.string :name, null: false
       t.<%= postgresql? ? (jsonb? ? 'jsonb' : 'json') : 'text' %> :properties
       t.datetime :occurred_at, null: false
       t.references :target, polymorphic: true
     end
 
-    add_index :streamline_events, :id
     add_index :streamline_events, [:target_type, :target_id]
   end
 end

data/lib/streamline.rb

@@ -1,6 +1,5 @@
 require 'active_job'
 require 'yaml'
-require 'active_support/core_ext/hash/keys'
 
 require 'streamline/configuration'
 require 'streamline/stores'

data/lib/streamline/stores/active_record_store.rb

@@ -6,11 +6,7 @@ module Streamline
       def_delegators :model, :count
 
       def save_event(attributes)
-        event = model.new(attributes)
-        event.id = generate_event_id
-        event.save!
-
-        event.id
+        model.create!(attributes).id
       end
 
       def find_event(id)

data/lib/streamline/stores/base_store.rb

@@ -19,10 +19,6 @@ module Streamline
         fail NotImplementedError, 'You need to implement this method first'
       end
 
-      def generate_event_id
-        SecureRandom.uuid
-      end
-
       def prepare_event(hsh)
         hsh.deep_stringify_keys
       end

data/lib/streamline/version.rb

@@ -1,3 +1,3 @@
 module Streamline
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/lib/streamline/jobs/handle_event_job_spec.rb

@@ -5,102 +5,17 @@ module Streamline
       include_context 'handler'
 
       let(:handler) { Streamline.registry[event_name].sample }
-      let(:subsequent_events) { Streamline.store.find_subsequent_events(event) }
       let(:params) { { event_id: event_id, handler: handler } }
+      let(:params_dump) { YAML.dump(params) }
 
       before do
-        handler_class.handle event_name, handler_options
+        handler_class.handle(event_name, handler_options)
       end
 
-      describe '#conditions_satisfied?' do
-        it 'returns true' do
-          expect(subject.send(:conditions_satisfied?, handler, event))
-            .to be(true)
-        end
-      end
-
-      describe '#if_satisfied?' do
-        let(:handler_options) { { if: FFaker::Lorem.word } }
-
-        it 'returns false' do
-          expect(subject.send(:if_satisfied?, handler, subsequent_events))
-            .to be(false)
-        end
-
-        context 'when expected event is occurred' do
-          before do
-            Streamline.store.save_event(
-              event_attributes.merge(
-                name: handler_options[:if],
-                occurred_at: 1.minute.from_now
-              )
-            )
-          end
-
-          it 'returns true' do
-            expect(subject.send(:if_satisfied?, handler, subsequent_events))
-              .to be(true)
-          end
-        end
-      end
-
-      describe '#unless_satisfied?' do
-        let(:handler_options) { { unless: FFaker::Lorem.word } }
-
-        it 'returns true' do
-          expect(subject.send(:unless_satisfied?, handler, subsequent_events))
-            .to be(true)
-        end
-
-        context 'when unexpected event is occurred' do
-          before do
-            Streamline.store.save_event(
-              event_attributes.merge(
-                name: handler_options[:unless],
-                occurred_at: 1.minute.from_now
-              )
-            )
-          end
-
-          it 'returns false' do
-            expect(subject.send(:unless_satisfied?, handler, subsequent_events))
-              .to be(false)
-          end
-        end
-      end
-
-      describe '#apply_constraints' do
-        let(:event_properties) { { user_id: rand(1..10) } }
-        let(:handler_options) { { constraints: :user_id } }
-
-        before do
-          Streamline.store.save_event(
-            event_attributes.merge(occurred_at: 1.minute.from_now)
-          )
-        end
-
-        it 'returns suitable events' do
-          expect(
-            subject
-              .send(:apply_constraints, handler, event, subsequent_events)
-              .sample['properties']
-          ).to include('user_id' => event_properties[:user_id])
-        end
-      end
-
-      describe '#enqueue_repeat' do
-        it 'does not enqueue itself again' do
-          expect { subject.send(:enqueue_repeat, handler, params) }
-            .not_to enqueue_a(described_class)
-        end
-
-        context 'when amount of handler repeats is greater than one' do
-          let(:handler_options) { { repeats: 2 } }
-
-          it 'enqueues itself again' do
-            expect { subject.send(:enqueue_repeat, handler, params) }
-              .to enqueue_a(described_class)
-          end
+      describe '#perform' do
+        it 'runs handler' do
+          allow_any_instance_of(handler_class).to receive(:run).with(event)
+          subject.perform(params_dump)
         end
       end
     end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ require 'simplecov'
 require 'database_cleaner'
 
 require 'active_record'
-require 'activeuuid'
 
 SimpleCov.start
 

data/spec/support/models.rb

@@ -1,15 +1,13 @@
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
 
 ActiveRecord::Schema.define do
-  create_table :streamline_events, id: false do |t|
-    t.uuid :id, primary_key: true
+  create_table :streamline_events do |t|
     t.string :name, null: false
     t.text :properties
     t.datetime :occurred_at, null: false
     t.references :target, polymorphic: true
   end
 
-  add_index :streamline_events, :id
   add_index :streamline_events, [:target_type, :target_id]
 end
 

data/spec/support/store_examples.rb

@@ -8,7 +8,7 @@ RSpec.shared_examples_for 'a store' do
     end
 
     it 'returns id of saved event' do
-      expect(subject.save_event(event_attributes)).to be_a(String)
+      expect(subject.save_event(event_attributes)).to be
     end
   end
 

data/streamline.gemspec

@@ -14,10 +14,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'activejob'
-  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'activerecord'
-  spec.add_development_dependency 'activeuuid'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Tipugin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activeuuid
-  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: database_cleaner
   requirement: !ruby/object:Gem::Requirement