betterplace-bi 0.7.0

data/spec/bi/updater_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe BI::Updater do
+  let :test_object do
+    TestModel.new("foo")
+  end
+
+  let :test_value do
+    BI::TestModelValue.new(test_object)
+  end
+
+  context 'update disabled' do
+    it 'cannot be updated manually' do
+      described_class.bi_commands = double
+      expect(described_class.bi_commands).not_to receive(:add)
+      expect(Log.instance).to receive(:info)
+      TestModel.new('foo').bi_update
+    end
+  end
+
+  context 'update enabled' do
+    before do
+      cc.bi.attributes_update update: true
+      described_class.bi_commands = double(schedule_job?: false)
+    end
+
+    it 'can be updated manually' do
+      expect(described_class.bi_commands).to receive(:add).with(test_object, BI::TestModelValue)
+      test_object.bi_update
+    end
+
+    it 'can be deleted manually' do
+      expect(described_class.bi_commands).to receive(:add).with(test_object, BI::TestModelValue)
+      expect(test_object).to receive(:bi_update).and_call_original
+      test_object.destroy
+    end
+
+    it 'updates if changed' do
+      expect(test_object).to receive(:bi_update).and_call_original
+      expect(described_class.bi_commands).to receive(:add).with(test_object, BI::TestModelValue)
+      test_object.changed = true
+      test_object.save
+    end
+
+    it 'triggers dependent object bi updates' do
+      test_object.dependent = dependent_test_object = TestModel.new("bar")
+      expect(described_class.bi_commands).to receive(:add).with(test_object, BI::TestModelValue)
+      expect(described_class.bi_commands).to receive(:add).with(dependent_test_object, BI::TestModelValue)
+      test_object.bi_update
+    end
+
+    it 'schedules job after all dependent objects where collected' do
+      described_class.bi_commands = BI::Commands::Collector.new
+      test_object.dependent = dependent_test_object = TestModel.new("bar")
+      expect(described_class.bi_commands).to receive(:add).with(test_object, BI::TestModelValue).and_call_original
+      expect(described_class.bi_commands).to receive(:add).with(dependent_test_object, BI::TestModelValue).and_call_original
+      expect(described_class.bi_commands).to receive(:schedule_job).once
+      test_object.bi_update
+    end
+  end
+end

data/spec/config/bi.yml

@@ -0,0 +1,18 @@
+---
+test:
+  event_class: ABEvent
+  requests:
+    user_agents:
+      robot: null
+      mobile: null
+  update: no
+  auth:
+    username: bi
+    password: secret
+  clear: /api/v1/all/:id
+  endpoints:
+    BI::TestModelValue:
+      POST: /api/v1/tests
+      DELETE: /api/v1/tests/:id
+  bime_dir:
+    <%= Pathname.pwd.join('spec/bime_dir') %>

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+if ENV['START_SIMPLECOV'].to_i == 1
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "#{File.basename(File.dirname(__FILE__))}/"
+  end
+end
+require 'rspec'
+begin
+  require 'byebug'
+rescue LoadError
+end
+
+module ActiveJob
+  class Base
+    def self.queue_as(*a)
+      warn "Called #{__method__} with #{a.inspect}"
+    end
+    def self.retry_on(*a)
+      warn "Called #{__method__} with #{a.inspect}"
+    end
+  end
+end
+
+require 'complex_config'
+ComplexConfig::Provider.deep_freeze = false
+ComplexConfig::Provider.env = 'test'
+require 'bi'
+
+ComplexConfig::Provider.config_dir = Pathname.new(__FILE__).dirname + "config"
+
+require_relative 'support/models'

data/spec/support/models.rb

@@ -0,0 +1,106 @@
+class TestModel
+  def self.before_save(*)
+  end
+
+  def self.after_commit(*)
+  end
+
+  def self.before_destroy(*)
+  end
+
+  include BI::Updater
+
+  def logger
+    BI.logger
+  end
+
+  def initialize(id)
+    @id         = id
+    @created_at = Time.now
+    @changed    = false
+    @destroyed = false
+  end
+
+  attr_reader :id
+
+  attr_reader :created_at
+
+  attr_writer :changed
+
+  attr_accessor :dependent
+
+  def trigger_dependent_updates
+    return unless dependent
+    dependent.schedule_bi_update_job(true)
+  end
+
+  def changed?
+    @changed
+  end
+
+  def destroyed?
+    @destroyed
+  end
+
+  def self.find(id)
+    new(id)
+  end
+
+  def save
+    schedule_bi_update_job_on_change if changed?
+    schedule_bi_update_job
+    true
+  end
+
+  def destroy
+    @destroyed = true
+    schedule_bi_update_job_on_change
+    schedule_bi_update_job
+    true
+  end
+end
+
+class BI::TestModelValue
+  include BI::SharedValue
+
+  def self.update_class
+    ::TestModel
+  end
+
+  field type: 'string', db: 'gorm:"type:uuid;primary_key"'
+  def id
+    @object.id
+  end
+
+  field type: '*int64', db: 'gorm:"type:bigint"'
+  def number
+    10 ** 10
+  end
+
+  field type: '*time.Time', db: bp_timestamp # ISO timestamp string, e. g. "2018-11-05T15:40:14.362219+01:00"
+  def created_at
+    iso_timestamp(@object.created_at)
+  end
+
+  field type: 'pq.StringArray', db: 'gorm:"type:varchar[]"'
+  def tags
+    %w[ foo bar ]
+  end
+
+  def ==(other)
+    id == other.id
+  end
+end
+
+class TestPlanning
+  def self.validates(*)
+  end
+
+  include BI::PlanningValueValidations
+
+  def initialize(*) end
+
+  def valid?
+    errors.empty?
+  end
+end

metadata

@@ -0,0 +1,331 @@
+--- !ruby/object:Gem::Specification
+name: betterplace-bi
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Florian Frank
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_hadar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: simplecov
+  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: rspec
+  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: byebug
+  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: json
+  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: tins
+  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: complex_config
+  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: globalid
+  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: excon
+  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: rails
+  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: sinatra
+  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: betterlog
+  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: mize
+  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'
+description: This library contains functionality to send/store BI and AB-testing data
+email: flori@ping.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/betterplace-bi.rb
+- lib/bi.rb
+- lib/bi/ab_test_helper.rb
+- lib/bi/api.rb
+- lib/bi/commands.rb
+- lib/bi/commands/base.rb
+- lib/bi/commands/collector.rb
+- lib/bi/commands/connection.rb
+- lib/bi/commands/delete.rb
+- lib/bi/commands/serializer.rb
+- lib/bi/commands/update.rb
+- lib/bi/commands_job.rb
+- lib/bi/event.rb
+- lib/bi/planning_value_parser.rb
+- lib/bi/planning_value_validations.rb
+- lib/bi/railtie.rb
+- lib/bi/request_analyzer.rb
+- lib/bi/session_id.rb
+- lib/bi/shared_value.rb
+- lib/bi/tracking.rb
+- lib/bi/type_generator.rb
+- lib/bi/update_error.rb
+- lib/bi/updater.rb
+- lib/bi/version.rb
+files:
+- ".gitignore"
+- ".semaphore/semaphore.yml"
+- ".tool-versions"
+- ".utilsrc"
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- betterplace-bi.gemspec
+- lib/betterplace-bi.rb
+- lib/bi.rb
+- lib/bi/ab_test_helper.rb
+- lib/bi/api.rb
+- lib/bi/commands.rb
+- lib/bi/commands/base.rb
+- lib/bi/commands/collector.rb
+- lib/bi/commands/connection.rb
+- lib/bi/commands/delete.rb
+- lib/bi/commands/serializer.rb
+- lib/bi/commands/update.rb
+- lib/bi/commands_job.rb
+- lib/bi/event.rb
+- lib/bi/planning_value_parser.rb
+- lib/bi/planning_value_validations.rb
+- lib/bi/railtie.rb
+- lib/bi/request_analyzer.rb
+- lib/bi/session_id.rb
+- lib/bi/shared_value.rb
+- lib/bi/tracking.rb
+- lib/bi/type_generator.rb
+- lib/bi/update_error.rb
+- lib/bi/updater.rb
+- lib/bi/version.rb
+- lib/tasks/bime.rake
+- spec/bi/ab_test_helper_spec.rb
+- spec/bi/commands/collector_spec.rb
+- spec/bi/commands/connection_spec.rb
+- spec/bi/commands_job_spec.rb
+- spec/bi/commands_spec.rb
+- spec/bi/event_spec.rb
+- spec/bi/planning_value_parser_spec.rb
+- spec/bi/request_analyzer_spec.rb
+- spec/bi/shared_value_spec.rb
+- spec/bi/tracking_spec.rb
+- spec/bi/type_generator_spec.rb
+- spec/bi/updater_spec.rb
+- spec/bime_dir/.keep
+- spec/config/bi.yml
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: https://github.com/betterplace/betterplace-bi
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--title"
+- Betterplace-bi -- BI library
+- "--main"
+- README.md
+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: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Business Intelligence library
+test_files:
+- spec/bi/ab_test_helper_spec.rb
+- spec/bi/commands/collector_spec.rb
+- spec/bi/commands/connection_spec.rb
+- spec/bi/commands_job_spec.rb
+- spec/bi/commands_spec.rb
+- spec/bi/event_spec.rb
+- spec/bi/planning_value_parser_spec.rb
+- spec/bi/request_analyzer_spec.rb
+- spec/bi/shared_value_spec.rb
+- spec/bi/tracking_spec.rb
+- spec/bi/type_generator_spec.rb
+- spec/bi/updater_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb