bg-common 0.1.0

data/lib/bg/common/analytics/keen/events.rb

@@ -0,0 +1,31 @@
+#
+# Module that wraps the Keen events API to create specific
+# events related to app actions.
+#
+module BG
+  module Common
+    module Analytics
+      module Keen
+        module Events
+          #
+          # Creates an event in Keen
+          #
+          # @param data, Hash
+          #
+          # The data param includes the information for the event to register on
+          # Keen. It can be any valid Ruby hash.
+          #
+          # more info here: https://github.com/keenlabs/keen-gem#synchronous-publishing
+          #
+          def create_event event, data
+            if BG::Common.active_job?
+              KeenEventJob.perform_later event, data
+            else
+              Client.new.call event, data
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bg/common/analytics/keen.rb

@@ -0,0 +1,12 @@
+require_relative 'keen/client'
+require_relative 'keen/events'
+
+module BG
+  module Common
+    module Analytics
+      module Keen
+        extend Events
+      end
+    end
+  end
+end

data/lib/bg/common/analytics/tracker.rb

@@ -0,0 +1,24 @@
+module BG
+  module Common
+    module Analytics
+      class Tracker
+        def initialize
+        end
+
+        def call data
+          if Analytics.ga? and data[:ga]
+            GA.create_event data[:ga]
+          end
+
+          if Analytics.intercom? and data[:intercom]
+            Intercom.create_event data[:intercom]
+          end
+
+          if Analytics.keen? and data[:keen]
+            Keen.create_event data[:keen][:event], data[:keen][:data]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bg/common/analytics.rb

@@ -0,0 +1,43 @@
+require_relative 'analytics/tracker'
+
+module BG
+  module Common
+    module Analytics
+      class << self
+        def load!
+          load_ga       if ga?
+          load_intercom if intercom?
+          load_keen     if keen?
+        end
+
+        def ga?
+          defined?(::Gabba) && ENV['GA_TRACKER_CODE'] && ENV['GA_DOMAIN']
+        end
+
+        def intercom?
+          defined?(::Intercom)
+        end
+
+        def keen?
+          defined?(::Keen) && ENV['KEEN_PROJECT_ID']
+        end
+
+        private
+
+        def load_ga
+          require_relative 'analytics/ga'
+        end
+
+        def load_intercom
+          require_relative 'analytics/intercom'
+        end
+
+        def load_keen
+          require_relative 'analytics/keen'
+        end
+      end
+    end
+  end
+end
+
+BG::Common::Analytics.load!

data/lib/bg/common/engine.rb

@@ -0,0 +1,8 @@
+module BG
+  module Common
+    module Rails
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/lib/bg/common/middlewares/basic_auth.rb

@@ -0,0 +1,32 @@
+module BG
+  module Common
+    module Middlewares
+      class BasicAuth
+        def initialize app
+          @app = app
+        end
+
+        def call env
+          if ENV['BASIC_AUTH_ENABLED'] == 'true'
+            auth = Rack::Auth::Basic.new(@app) do |u, p|
+              u == username && p == password
+            end
+
+            auth.call env
+          else
+            @status, @headers, @response = @app.call(env)
+            [@status, @headers, @response]
+          end
+        end
+
+        def username
+          ENV['BASIC_AUTH_USERNAME']
+        end
+
+        def password
+          ENV['BASIC_AUTH_PASSWORD']
+        end
+      end
+    end
+  end
+end

data/lib/bg/common/rails.rb

@@ -0,0 +1,9 @@
+module BG
+  module Common
+    class Railtie < ::Rails::Railtie
+      initializer 'bg.common.configure_rails_initialization' do
+        ::Rails.application.middleware.use BG::Common::Middlewares::BasicAuth
+      end
+    end
+  end
+end

data/lib/bg/common/version.rb

@@ -0,0 +1,5 @@
+module BG
+  module Common
+    VERSION = "0.1.0"
+  end
+end

data/lib/bg/common.rb

@@ -0,0 +1,50 @@
+require 'bg/common/version'
+require 'bg/common/middlewares/basic_auth'
+
+module BG
+  module Common
+    class << self
+      def load!
+        if rails?
+          register_railtie
+          register_engine
+        end
+      end
+
+      def logger
+        # TODO: Make this configurable
+        @logger ||= Logging.logger['bg_common']
+        @logger.level = :debug
+
+        @logger.add_appenders \
+          Logging.appenders.stdout,
+          Logging.appenders.file('log/bg_common.log')
+      end
+
+      # Paths
+      def gem_path
+        @gem_path ||= File.expand_path '../..', File.dirname(__FILE__)
+      end
+
+      def active_job?
+        defined?(::ActiveJob::Base)
+      end
+
+      def rails?
+        defined?(::Rails)
+      end
+
+      private
+
+      def register_railtie
+        require 'bg/common/rails'
+      end
+
+      def register_engine
+        require 'bg/common/engine'
+      end
+    end
+  end
+end
+
+BG::Common.load!

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: bg-common
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Youssef Chaker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Ruby library of common behaviors, especially for Ruby on Rails applications.
+email:
+- youssef@bearandgiraffe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/jobs/bg/common/analytics/ga_event_job.rb
+- app/jobs/bg/common/analytics/intercom_create_user_job.rb
+- app/jobs/bg/common/analytics/intercom_event_job.rb
+- app/jobs/bg/common/analytics/intercom_export_users_job.rb
+- app/jobs/bg/common/analytics/intercom_update_users_job.rb
+- app/jobs/bg/common/analytics/keen_event_job.rb
+- bg-common.gemspec
+- bin/console
+- bin/setup
+- lib/bg/common.rb
+- lib/bg/common/analytics.rb
+- lib/bg/common/analytics/ga.rb
+- lib/bg/common/analytics/google_analytics/client.rb
+- lib/bg/common/analytics/google_analytics/events.rb
+- lib/bg/common/analytics/intercom.rb
+- lib/bg/common/analytics/intercom/client.rb
+- lib/bg/common/analytics/intercom/events.rb
+- lib/bg/common/analytics/intercom/user.rb
+- lib/bg/common/analytics/keen.rb
+- lib/bg/common/analytics/keen/client.rb
+- lib/bg/common/analytics/keen/events.rb
+- lib/bg/common/analytics/tracker.rb
+- lib/bg/common/engine.rb
+- lib/bg/common/middlewares/basic_auth.rb
+- lib/bg/common/rails.rb
+- lib/bg/common/version.rb
+homepage: https://github.com/bearandgiraffe/bg-common
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A Ruby library of common behaviors, especially for Ruby on Rails applications.
+test_files: []