bg-common 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 32c5b7cf0dbee6773715a5d12a06bbc031e13e39
-  data.tar.gz: 53bac4ac88f1d5af07b4e9da2a1507cad219a1e1
+SHA256:
+  metadata.gz: af8e5e82e86e21e0398d5ce8826558ae66fce078a79b4ec4c5fa0a30ea8fe9c8
+  data.tar.gz: 54a11768cd478ec1ecadc11889b2f41495b4e27df51a668dda922e3a185a48d1
 SHA512:
-  metadata.gz: d3706f3cafd53430cea56bcfe15e40438a98b18bb571651198bf35f3f687a0e8b0434d70b9c43d2de639cf6d801bb40fcd5feaf42478eae75ab97f3e3d5ca472
-  data.tar.gz: ee7ee55d4b56925f1cfe7ffd0e5b9ec04298279b319bbad69df6f8b859a4816594057ea6063672a9afdcc02a0bb05700e784dcef82d82352016c7fd0f7a9195b
+  metadata.gz: f1ecdaab2503247fb753056ce088b06fef9e5c22a407dd7fe1e575e2c44313425627d4c05d10c297d7ae01e3bcbbac841c788dfa333caa9c4930907050f65e8c
+  data.tar.gz: 1733373879f401eb0e90cf57dce3614a815c9daa919597c51f7d48f63d6af7dd928ec2b5ed3100a3881293f5c722af1529331771b88225f891dae13be32b5452

data/README.md

@@ -6,15 +6,11 @@ A Ruby library of common behaviors, especially for Ruby on Rails applications.
 
 <!-- MarkdownTOC depth=4 autolink=true bracket=round -->
 
-- [Installation](#installation)
-- [Usage](#usage)
-  - [I. Basic Auth](#i-basic-auth)
-  - [II. Analytics](#ii-analytics)
-    - [Google Analytics](#google-analytics)
-    - [Intercom](#intercom)
-    - [Keen.io](#keenio)
-- [Development](#development)
-- [Contributing](#contributing)
+- Installation
+- Usage
+  - I. Basic Auth
+- Development
+- Contributing
 
 <!-- /MarkdownTOC -->
 
@@ -52,216 +48,6 @@ BASIC_AUTH_PASSWORD=password
 
 make sure to change `user` and `password` to something a bit more secure!
 
-### II. Analytics
-
-This library provides a common interface for sending events to different analytics/user tracking platforms (eg. Google Analytics, Intercom, Keen.io).
-
-**Caveat:** Although the interface is the same, the data sent to each one is different. Some accept custom attributes, and others don't. So for that reason, you will still need to have knowledge of what each platform accepts as params. Those are explained below for each one of them.
-
-To track an event on all of the supported platforms, all you need to do is call the `Tracker` class, with the proper params.
-
-```ruby
-require 'bg/common/analytics'
-
-user = current_user # or whatever the logged in user object is in your case.
-
-# Track on the various analytics tools:
-tracker_data = {
-  ga: {
-    category: 'Users',
-    action:   'User Logged In',
-    label:    user.email,
-    value:    nil,
-    bounce:   false,
-  },
-  intercom: {
-    event_name: 'user-logged-in',
-    created_at: Time.now.to_i,
-    email:      user.email,
-  },
-  keen: {
-    event: 'user_logged_in',
-    data:  {
-      user_id: user.id,
-      email:   user.email,
-      date:    Time.now.utc.to_i, # Cannot be a time object, so cast as
-                                  # Integer or String because of the following:
-                                  # ActiveJob::SerializationError
-                                  # (Unsupported argument type: Time)
-    }
-  }
-}
-
-BG::Common::Analytics::Tracker.new.call(tracker_data)
-```
-
-The call above detects whether you have background jobs enabled by checking if the `ActiveJob::Base` class is defined. If it is, it will execute the calls to each platform by creating a background job for each one. This is beneficial to make sure that these non critical third party calls do not block the user action.
-
-If `ActiveJob::Base` is not defined, the calls would be perform inline.
-
-**What if I do not want Google to creep on my users???**
-
-Well that's easy, do not enable it. For each supported platform, the gem determines if it's enabled by checking on a couple of things (see the sections below for more detail) and if the checks pass, then that platform is included in the tracker call. Otherwise, that platform is ignored.
-
-**Oh boy! That's a long namespace!**
-
-`BG::Common::Analytics::Tracker` is a lot to type, but we expect that you will setup your class that will inherit from this one, and create your own methods that determine how the data is structured for each event. Something like this:
-
-```ruby
-class MyAnalytics < BG::Common::Analytics::Tracker
-  def track_login user
-    tracker_data = {
-      ga: {
-        category: 'Users',
-        action:   'User Logged In',
-        label:    user.email,
-        value:    nil,
-        bounce:   false,
-      },
-      intercom: {
-        event_name: 'user-logged-in',
-        created_at: Time.now.to_i,
-        email:      user.email,
-      },
-      keen: {
-        event: 'user_logged_in',
-        data:  {
-          user_id: user.id,
-          email:   user.email,
-          date:    Time.now.utc.to_i,
-        }
-      }
-    }
-
-    call tracker_data
-  end
-end
-
-MyAnalytics.new.track_login user
-```
-
-or if you want to build something more extendable:
-
-```ruby
-# lib/my_app/analytics/base.rb
-module MyApp
-  module Analytics
-    class Base < ::BG::Common::Analytics::Tracker
-      def initialize user:, additional_data:
-        super()
-
-        @user            = user
-        @additional_data = additional_data
-      end
-
-      def call
-        default_keen_data = extract_default_keen_data user: @user, additional_data: @additional_data
-        extra_keen_data   = extract_extra_keen_data additional_data: @additional_data
-
-        tracker_data = {
-          ga:       { ... },
-          intercom: { ... },
-          keen:     {
-            event: event_name,
-            data:  default_keen_data.merge(extra_keen_data),
-          },
-        }
-
-        super tracker_data
-      end
-
-      private
-
-      def extract_extra_keen_data additional_data:
-        raise NotImplementedError
-      end
-
-      def event_name
-        raise NotImplementedError
-      end
-
-      def extract_default_keen_data user:, additional_data:
-        {
-          user_id:    user.id,
-          user_email: user.email,
-          datestamp:  Time.now.utc.to_i,
-        }
-      end
-    end
-  end
-end
-
-# lib/my_app/analytics/comment.rb
-module MyApp
-  module Analytics
-    module Comment
-      class Create < Base
-        private
-
-        def extract_extra_keen_data additional_data:
-          {
-            comment_id: additional_data[:comment_id]
-          }
-        end
-
-        def event_name
-          'new_comment'
-        end
-      end
-    end
-  end
-end
-
-# in comments_controller.rb
-MyApp::Analytics::Comment::Create.new(user: current_user, additional_data: {
-  comment_id: @comment.id,
-}).call
-```
-
-#### Google Analytics
-
-All you need to have GA support is to add the `gabba` gem to your `Gemfile`, and the following `ENV` variables:
-
-```ruby
-# Gemfile
-gem 'gabba'
-```
-
-```
-# .env
-GA_TRACKER_CODE=...
-GA_DOMAIN=...
-```
-
-which are required to configure the GA client.
-
-#### Intercom
-
-All you need to have Intercom support is to include the `intercom` gem:
-
-```ruby
-# Gemfile
-gem 'intercom'
-```
-
-**PS:** make sure you configure the gem in the initializer as specified by the Intercom docs.
-
-#### Keen.io
-
-All you need to have GA support is to add the `keen` gem to your `Gemfile`, and the following `ENV` variables:
-
-```ruby
-# Gemfile
-gem 'keen'
-```
-
-```
-# .env
-KEEN_PROJECT_ID=...
-```
-
-which are required to configure the Keen client.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/bg/common/constraints/api_constraint.rb

@@ -0,0 +1,30 @@
+module Bg
+  module Common
+    module Constraints
+      class ApiConstraint
+        def initialize version: 1, default: true
+          @version = version
+          @default = default
+        end
+
+        def matches? request
+          versioned_accept_header?(request) || @default
+        end
+
+        private
+
+        def versioned_accept_header? request
+          accept = request.headers['Accept']
+
+          if accept
+            mime_type, version = accept.gsub(/\s/, "").split(";")
+            return mime_type.match(/vnd\.jbh\+json/) && version == "version=#{@version}"
+          end
+
+          return false
+        end
+      end
+    end
+  end
+end
+

data/lib/bg/common/version.rb

@@ -1,5 +1,5 @@
 module BG
   module Common
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bg-common
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Youssef Chaker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,28 +67,11 @@ files:
 - 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/constraints/api_constraint.rb
 - lib/bg/common/engine.rb
 - lib/bg/common/middlewares/basic_auth.rb
 - lib/bg/common/rails.rb
@@ -112,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby library of common behaviors, especially for Ruby on Rails applications.

data/app/jobs/bg/common/analytics/ga_event_job.rb

@@ -1,15 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class GAEventJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform data
-          BG::Common::Analytics::GA::Client.call data
-        end
-      end
-    end
-  end
-end

data/app/jobs/bg/common/analytics/intercom_create_user_job.rb

@@ -1,17 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class IntercomCreateUserJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform data
-          BG::Common::Analytics::Intercom::Client.new.make_intercom_call do |client|
-            client.users.create data
-          end
-        end
-      end
-    end
-  end
-end

data/app/jobs/bg/common/analytics/intercom_event_job.rb

@@ -1,15 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class IntercomEventJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform data
-          BG::Common::Analytics::Intercom::Client.call data
-        end
-      end
-    end
-  end
-end

data/app/jobs/bg/common/analytics/intercom_export_users_job.rb

@@ -1,17 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class IntercomExportUsersJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform data
-          BG::Common::Analytics::Intercom::Client.new.make_intercom_call do |client|
-            client.users.submit_bulk_job(create_items: data)
-          end
-        end
-      end
-    end
-  end
-end

data/app/jobs/bg/common/analytics/intercom_update_users_job.rb

@@ -1,19 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class IntercomSyncUsersJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform
-          users = User.all
-
-          users.each do |user|
-            BG::Common::Analytics::Intercom.update_user user
-          end unless users.blank?
-        end
-      end
-    end
-  end
-end

data/app/jobs/bg/common/analytics/keen_event_job.rb

@@ -1,15 +0,0 @@
-require 'bg/common/analytics'
-
-module BG
-  module Common
-    module Analytics
-      class KeenEventJob < ::ActiveJob::Base
-        queue_as :analytics
-
-        def perform event, data
-          BG::Common::Analytics::Keen::Client.call event, data
-        end
-      end
-    end
-  end
-end

data/lib/bg/common/analytics.rb

@@ -1,64 +0,0 @@
-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?
-          begin
-            require 'gabba'
-            defined?(::Gabba) && ENV['GA_TRACKER_CODE'] && ENV['GA_DOMAIN']
-          rescue LoadError
-            BG::Common.logger.info 'GA is not loaded'
-
-            return false
-          end
-        end
-
-        def intercom?
-          begin
-            require 'intercom'
-            defined?(::Intercom) && ENV['INTERCOM_ACCESS_TOKEN']
-          rescue LoadError
-            BG::Common.logger.info 'Intercom is not loaded'
-
-            return false
-          end
-        end
-
-        def keen?
-          begin
-            require 'keen'
-            defined?(::Keen) && ENV['KEEN_PROJECT_ID']
-          rescue LoadError
-            BG::Common.logger.info 'Keen is not loaded'
-
-            return false
-          end
-        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/analytics/ga.rb

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

data/lib/bg/common/analytics/google_analytics/client.rb

@@ -1,31 +0,0 @@
-module BG
-  module Common
-    module Analytics
-      module GA
-        class Client
-          def initialize
-            @ga = ::Gabba::Gabba.new(ENV['GA_TRACKER_CODE'], ENV['GA_DOMAIN'])
-          end
-
-          def ga
-            @ga ||= ::Gabba::Gabba.new(ENV['GA_TRACKER_CODE'], ENV['GA_DOMAIN'])
-          end
-
-          def self.call data
-            self.new.call data
-          end
-
-          def call data
-            ga.event(
-              data[:category],
-              data[:action],
-              data[:label],
-              data[:value],
-              data[:bounce] || false
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-#
-# Module that wraps the GA events API to create specific events related
-# to actions from the app.
-#
-module BG
-  module Common
-    module Analytics
-      module GA
-        module Events
-          #
-          # Creates an event in GA
-          #
-          # @param data, Hash
-          #
-          # The data param includes the information for the event to register on GA.
-          # It should have the following attributes:
-          #
-          # category: String
-          # action:   String
-          # label:    String
-          # value:    Integer
-          # bounce:   Boolean
-          #
-          # more info here:
-          # https://support.google.com/analytics/answer/1033068#Anatomy
-          # https://developers.google.com/analytics/devguides/collection/analyticsjs/events
-          #
-          def create_event data
-            if BG::Common.active_job?
-              GAEventJob.perform_later data
-            else
-              BG::Common::Analytics::GA::Client.new.call data
-            end
-          end
-        end
-      end
-    end
-  end
-end
-

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

@@ -1,14 +0,0 @@
-require_relative 'intercom/client'
-require_relative 'intercom/user'
-require_relative 'intercom/events'
-
-module BG
-  module Common
-    module Analytics
-      module Intercom
-        extend User
-        extend Events
-      end
-    end
-  end
-end

data/lib/bg/common/analytics/intercom/client.rb

@@ -1,43 +0,0 @@
-module BG
-  module Common
-    module Analytics
-      module Intercom
-        class Client
-          def initialize
-            @intercom = ::Intercom::Client.new token: ENV['INTERCOM_ACCESS_TOKEN']
-          end
-
-          def intercom
-            @intercom ||= ::Intercom::Client.new token: ENV['INTERCOM_ACCESS_TOKEN']
-          end
-
-          def self.call data
-            self.new.call data
-          end
-
-          def call data
-            make_intercom_call do |client|
-              client.events.create data
-            end
-          end
-
-          def make_intercom_call &block
-            begin
-              yield self.intercom
-            rescue ::Intercom::IntercomError => e
-              # TODO: report this to newrelic so we won't lose any important
-              # errors that we might have to fix.
-              BG::Common.logger.debug "Intercom call failed: #{e.inspect}"
-            end
-          end
-
-          private
-
-          def config
-            ::IntercomRails.config
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-#
-# Module that wraps the Intercom events API to create specific
-# events related to app actions.
-#
-module BG
-  module Common
-    module Analytics
-      module Intercom
-        module Events
-          #
-          # Creates an event in Intercom
-          #
-          # @param data, Hash
-          #
-          # The data param includes the information for the event to register on
-          # Intercom. It should have the following attributes:
-          #
-          # event_name: String
-          # created_at: Timestamp
-          # email:      String
-          # metadata:   Object
-          #
-          # more info here: https://doc.intercom.io/api/#submitting-events
-          #
-          def create_event data
-            if BG::Common.active_job?
-              IntercomEventJob.perform_later data
-            else
-              BG::Common::Analytics::Intercom::Client.new.call data
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bg/common/analytics/intercom/user.rb

@@ -1,67 +0,0 @@
-#
-# Module that wraps the Intercom users API.
-#
-module BG
-  module Common
-    module Analytics
-      module Intercom
-        module User
-          #
-          # Exports users to Intercom.
-          #
-          # @param limit, Integer, Sets the limit of users to export.
-          #
-          def export_users limit=nil
-            users = ::User.all
-
-            if limit
-              users = users.limit(limit)
-            end
-
-            data = users.map { |user| intercom_user_object user }
-
-            IntercomExportUsersJob.perform_later data
-          end
-
-          #
-          # Creates user in Intercom.
-          #
-          # @param user,    User
-          #
-          def create_user user
-            data = intercom_user_object user
-
-            IntercomCreateUserJob.perform_later data
-          end
-
-          #
-          # Updates user in Intercom.
-          #
-          # @param user,    User
-          #
-          def update_user user
-            create_user user
-          end
-
-          private
-
-          def intercom_user_object user
-            {
-              user_id:           user.id,
-              email:             user.username,
-              name:              user.name,
-              signed_up_at:      user.created_at.to_i,
-              custom_attributes: custom_attributes(user)
-            }
-          end
-
-          def custom_attributes user
-            # Override this method in your app to provide custom attributes
-            # specific to your app to be passed on to Intercom.
-            { }
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-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/keen/client.rb

@@ -1,20 +0,0 @@
-module BG
-  module Common
-    module Analytics
-      module Keen
-        class Client
-          def initialize
-          end
-
-          def self.call event, data = {}
-            self.new.call event, data
-          end
-
-          def call event, data = {}
-            ::Keen.publish event.to_sym, data
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-#
-# 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?
-              BG::Common::Analytics::KeenEventJob.perform_later event, data
-            else
-              BG::Common::Analytics::Keen::Client.call event, data
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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