omnikiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4121b6ebf9f51bd0e9020663ac39cff9cfe1864
+  data.tar.gz: 3a989e94a75d2dc74a511500536569fc91fb4093
+SHA512:
+  metadata.gz: c52418f0c0e1de3d7d46c4baa08838a7cc27a4551798cb28ac8abe7b4234d46bd8a9eed80f0a309cfcc3e108caccafc9947d22b00e47128e02132f8a6e11e920
+  data.tar.gz: eebf1bab2bcfd1716b2e12fdfdea88242e8ba33a0de175775f032bfc6a0e505a474a9042d9b2c4549d6f523dee8b9a3484a6e51f17c7e56acb9043e6ede375b4

data/lib/capistrano/templates/puma.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env puma
+
+directory '/var/www/omnikiq/current'
+rackup '/var/www/omnikiq/current/config.ru'
+environment ENV['RACK_ENV']
+
+pidfile '/var/www/omnikiq/shared/tmp/pids/puma.pid'
+state_path '/var/www/omnikiq/shared/tmp/pids/puma.state'
+stdout_redirect '/var/www/omnikiq/shared/log/puma_access.log', '/var/www/omnikiq/shared/log/puma_error.log', true
+
+threads 0, 2
+
+bind 'unix:/var/www/omnikiq/shared/tmp/sockets/puma.sock'
+workers 2
+
+preload_app!
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV['BUNDLE_GEMFILE'] = '/var/www/omnikiq/current/Gemfile'
+end

data/lib/omnikiq.rb

@@ -0,0 +1,42 @@
+require 'sidekiq'
+require 'mixpanel-ruby'
+
+require 'omnikiq/configuration'
+require 'omnikiq/trackers/base'
+
+module OmniKiq
+  class << self
+    attr_writer :configuration
+  end
+
+  module Trackers
+    autoload :MixpanelAlias, 'omnikiq/trackers/mixpanel_alias'
+    autoload :MixpanelEvents, 'omnikiq/trackers/mixpanel_events'
+    autoload :MixpanelPeople, 'omnikiq/trackers/mixpanel_people'
+  end
+
+  def self.configuration
+    @configuration ||= begin
+                        config = OmniKiq::Configuration.new
+                        config
+                      end
+  end
+
+  def self.configure
+    yield configuration if block_given?
+    configure_client
+  end
+
+  def self.configure_client
+    Sidekiq.configure_client do |config|
+      config.redis = {
+        url: OmniKiq.configuration.redis_url,
+        namespace: OmniKiq.configuration.redis_namespace,
+        size: 10
+      }
+    end
+  end
+
+  # default config for the client
+  configure_client
+end

data/lib/omnikiq/configuration.rb

@@ -0,0 +1,59 @@
+module OmniKiq
+  class Configuration
+    # Module that holds `attr_reader` declarations. It's in a separate
+    # module to allow us to override those methods and use `super`.
+    # @private
+    READERS = Module.new
+    include READERS
+
+    # @private
+    def self.define_reader(name)
+      READERS.class_eval do
+        remove_method name if method_defined?(name)
+        attr_reader name
+      end
+    end
+
+    # @private
+    def self.define_aliases(name, alias_name)
+      alias_method alias_name, name
+      alias_method "#{alias_name}=", "#{name}="
+      define_predicate_for alias_name
+    end
+
+    # @private
+    def self.define_predicate_for(*names)
+      names.each { |name| alias_method "#{name}?", name }
+    end
+    # @private
+    #
+    # Invoked by the `add_setting` instance method. Use that method on a
+    # `Configuration` instance rather than this class method.
+    def self.add_setting(name, opts = {})
+      attr_writer name
+      add_read_only_setting name
+      Array(opts[:alias_with]).each do |alias_name|
+        define_aliases(name, alias_name)
+      end
+    end
+    # @private
+    #
+    # As `add_setting` but only add the reader.
+    def self.add_read_only_setting(name, _opts = {})
+      define_reader name
+      define_predicate_for name
+    end
+
+    add_setting :mixpanel_api_key
+    add_setting :redis_url
+    add_setting :redis_namespace
+    add_setting :test_mode
+
+    def initialize
+      @mixpanel_api_key = ''
+      @redis_url = 'redis://localhost:6379'
+      @redis_namespace = ENV['RACK_ENV'] || 'default'
+      @test_mode = false
+    end
+  end
+end

data/lib/omnikiq/trackers/base.rb

@@ -0,0 +1,13 @@
+module OmniKiq
+  module Trackers
+    class Base
+      include Sidekiq::Worker
+
+      attr_writer :mixpanel_tracker
+
+      def mixpanel_tracker
+        @mixpanel_tracker ||= Mixpanel::Tracker.new(OmniKiq.configuration.mixpanel_api_key)
+      end
+    end
+  end
+end

data/lib/omnikiq/trackers/mixpanel_alias.rb

@@ -0,0 +1,9 @@
+module OmniKiq
+  module Trackers
+    class MixpanelAlias < Base
+      def perform(email, distinct_id)
+        mixpanel_tracker.alias(email, distinct_id)
+      end
+    end
+  end
+end

data/lib/omnikiq/trackers/mixpanel_events.rb

@@ -0,0 +1,12 @@
+require 'sidekiq'
+require 'mixpanel-ruby'
+
+module OmniKiq
+  module Trackers
+    class MixpanelEvents < Base
+      def perform(email, event_name, params, ip = 0)
+        mixpanel_tracker.track(email, event_name, params, ip)
+      end
+    end
+  end
+end

data/lib/omnikiq/trackers/mixpanel_people.rb

@@ -0,0 +1,12 @@
+require 'sidekiq'
+require 'mixpanel-ruby'
+
+module OmniKiq
+  module Trackers
+    class MixpanelPeople < Base
+      def perform(distinct_id, params, ip = 0)
+        mixpanel_tracker.people.set(distinct_id, params, ip)
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe OmniKiq::Configuration do
+  subject { OmniKiq::Configuration.new }
+
+  describe 'sensible defaults' do
+    its(:mixpanel_api_key) { is_expected.to eq '' }
+    its(:redis_url) { is_expected.to eq 'redis://localhost:6379' }
+    its(:redis_namespace) { 'default' }
+  end
+end

data/spec/omnikiq_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe OmniKiq do
+  describe :configure do
+    subject { OmniKiq.configuration }
+
+    before do
+      OmniKiq.configure do |c|
+        c.mixpanel_api_key = 'mixpanel id'
+      end
+    end
+
+    its(:mixpanel_api_key) { is_expected.to eq 'mixpanel id' }
+
+    it 'sets to new config settings to the sidekiq client' do
+      expect(OmniKiq).to receive(:configure_client)
+
+      OmniKiq.configure do |c|
+        c.mixpanel_api_key = 'mixpanel id'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+ENV['RACK_ENV'] ||= 'test'
+
+require 'omnikiq'
+require 'rspec/its'
+
+# Require all of the RSpec Support libraries
+Dir[File.expand_path(File.join('../support/**/*.rb'), __FILE__)].each { |f| require f }
+
+require 'simplecov'
+require 'simplecov-teamcity-summary'
+SimpleCov.start 'teamcity'

data/spec/support/rspec.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec
+end

data/spec/trackers/mixpanel_alias_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe OmniKiq::Trackers::MixpanelAlias do
+  describe :perform do
+    let(:mixpanel_alias) { OmniKiq::Trackers::MixpanelAlias.new }
+    let(:mixpanel_tracker) { double(Mixpanel::Tracker) }
+
+    subject { mixpanel_alias.perform('oh@yeah.com', '42') }
+
+    before do
+      mixpanel_alias.mixpanel_tracker = mixpanel_tracker
+    end
+
+    it 'will call alias with the correct params' do
+      expect(mixpanel_tracker).to receive(:alias).with('oh@yeah.com', '42')
+      subject
+    end
+  end
+end

data/spec/trackers/mixpanel_events_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe OmniKiq::Trackers::MixpanelEvents do
+  describe :perform do
+    let(:mixpanel_events) { OmniKiq::Trackers::MixpanelEvents.new }
+    let(:mixpanel_tracker) { double(Mixpanel::Tracker) }
+
+    subject { mixpanel_events.perform('devil@feel.i', 'find love', {}) }
+
+    before do
+      mixpanel_events.mixpanel_tracker = mixpanel_tracker
+    end
+
+    it 'will call track with correct params' do
+      expect(mixpanel_tracker).to receive(:track).with('devil@feel.i', 'find love',  {}, 0)
+      subject
+    end
+  end
+end

data/spec/trackers/mixpanel_people_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OmniKiq::Trackers::MixpanelPeople do
+  describe :perform do
+    let(:mixpanel_people) { OmniKiq::Trackers::MixpanelPeople.new }
+    let(:mixpanel_tracker) { double(Mixpanel::Tracker) }
+
+    subject { mixpanel_people.perform('42', {}) }
+
+    before do
+      mixpanel_people.mixpanel_tracker = mixpanel_tracker
+    end
+
+    it 'will call set with correct params' do
+      people = double(:people)
+      expect(mixpanel_tracker).to receive(:people).and_return(people)
+      expect(people).to receive(:set).with('42', {}, 0)
+      subject
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: omnikiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Nistor
+- Alexandru Calinoiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A gem used to defer posts to mixpanel in a background worker.
+email: nistor.adrian@agilefreaks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capistrano/templates/puma.rb
+- lib/omnikiq.rb
+- lib/omnikiq/configuration.rb
+- lib/omnikiq/trackers/base.rb
+- lib/omnikiq/trackers/mixpanel_alias.rb
+- lib/omnikiq/trackers/mixpanel_events.rb
+- lib/omnikiq/trackers/mixpanel_people.rb
+- spec/configuration_spec.rb
+- spec/omnikiq_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec.rb
+- spec/trackers/mixpanel_alias_spec.rb
+- spec/trackers/mixpanel_events_spec.rb
+- spec/trackers/mixpanel_people_spec.rb
+homepage: https://github.com/Agilefreaks/OmniKiq
+licenses:
+- "© 2015 Omnipaste"
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.5
+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: Integrate mixpanel and sidekiq in your ruby app
+test_files:
+- spec/configuration_spec.rb
+- spec/omnikiq_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec.rb
+- spec/trackers/mixpanel_alias_spec.rb
+- spec/trackers/mixpanel_events_spec.rb
+- spec/trackers/mixpanel_people_spec.rb