remark_analytics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c76a31814603a543b8ded0d7160a91742560ebf3a0fecef0bc3eb9398a83e92
+  data.tar.gz: e5f4c54206f4623f730ca26459212fa90c6785f1ded21849384fa48eab94a6b7
+SHA512:
+  metadata.gz: 9cfb9a742215c299b72d254beb2f36a11bcc1b65a3f1c2d4f04d324ddbe9ab1afa01a8afc1b6e436d8afdec12b3c91aa94c571c5258f01f0cfe504e450836955
+  data.tar.gz: cb957ffc43dec4a9d3d44aff5bc206a9dfe819c620a7bff4afb70c761866da741a7d08d1822a86885f50a658cdb561615520aa31a6f81b5b42e66c9aa909cd2b

data/README.md

@@ -0,0 +1,29 @@
+# README #
+
+This README would normally document whatever steps are necessary to get your application up and running.
+
+### What is this repository for? ###
+
+* Quick summary
+* Version
+* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

data/lib/remark_analytics/event.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RemarkAnalytics
+  class Event
+    def self.emit(event_parameters)
+      event_params = prepare_post_parameters(event_parameters)
+      post_event(event_params)
+    end
+
+    def self.prepare_post_parameters(event_parameters)
+      # mix up the event params with other reuired data
+      result = {}
+      result[:name] = event_parameters[:name].presence
+      result[:resource_type] = event_parameters[:resource_type].presence
+      result[:resource_id] = event_parameters[:resource_id].presence
+      result[:data] = event_parameters[:data].presence || {}
+      result[:application_version] = event_parameters[:application_version].presence ||
+        RemarkAnalytics::VERSION
+      result[:occured_at] = event_parameters[:occured_at].presence || Time.zone.now
+      result[:tenant_name] = event_parameters[:tenant_name].presence ||
+        Rails.application.secrets.try(:REMARK_ANALYTICS_TENANT_NAME) || VP_SETTINGS[:tenant]
+
+      # validate params at the other side (analytics api endoint)
+      result
+    end
+
+    def self.post_event(event_params)
+      if Rails.env.development? || Rails.env.test?
+        RemarkAnalytics::Jobs::PostEventJob.perform_now(event_params)
+        return
+      end
+
+      RemarkAnalytics::Jobs::PostEventJob.perform_later(event_params)
+    end
+  end
+end

data/lib/remark_analytics/jobs/application_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RemarkAnalytics
+  module Jobs
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/lib/remark_analytics/jobs/post_event_job.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RemarkAnalytics
+  module Jobs
+    class PostEventJob < ApplicationJob
+      def perform(event_params)
+        return if connection.blank?
+
+        connection.post(
+            @events_endpoint,
+            { event: event_params }.to_json,
+            'Content-Type' => 'application/json'
+          )
+      end
+
+      protected
+
+      def connection
+        analytics_url = Rails.application.secrets.try(:REMARK_ANALYTICS_URL)
+        username = Rails.application.secrets.try(:REMARK_ANALYTICS_USERNAME)
+        password = Rails.application.secrets.try(:REMARK_ANALYTICS_PASSWORD)
+        @events_endpoint = "#{analytics_url}/api/v1/events"
+
+        if analytics_url.blank?
+          Sentry.capture_message('REMARK_ANALYTICS_URL not set')
+          return
+        end
+
+        if username.blank?
+          Sentry.capture_message('REMARK_ANALYTICS_USERNAME not set')
+          return
+        end
+
+        if password.blank?
+          Sentry.capture_message('REMARK_ANALYTICS_PASSWORD not set')
+          return
+        end
+
+        Faraday.new do |conn|
+          conn.request(:authorization, :basic, username, password)
+        end
+      end
+    end
+  end
+end

data/lib/remark_analytics/railtie.rb

@@ -0,0 +1,4 @@
+module RemarkAnalytics
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/remark_analytics/version.rb

@@ -0,0 +1,3 @@
+module RemarkAnalytics
+  VERSION = '1.0.0'.freeze
+end

data/lib/remark_analytics.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'remark_analytics/railtie'
+require 'remark_analytics/version'
+require 'remark_analytics/event'
+
+require 'remark_analytics/jobs/application_job'
+require 'remark_analytics/jobs/post_event_job'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: remark_analytics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Rockx
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.4.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.4.8
+description: This gem/plugin is used in applications that need to fire events to the
+  ReMark Analytics system
+email:
+- nick.rockx@remarkgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/remark_analytics.rb
+- lib/remark_analytics/event.rb
+- lib/remark_analytics/jobs/application_job.rb
+- lib/remark_analytics/jobs/post_event_job.rb
+- lib/remark_analytics/railtie.rb
+- lib/remark_analytics/version.rb
+homepage: https://bitbucket.org/ivaldi/rubygems-remark-analytics/src/master/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key:
+specification_version: 4
+summary: Gem to fire events to ReMark Analytics API from a client application
+test_files: []