cru_lib 0.0.6 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ca87f01a10819552466a88828a6765bfcd4ba8c
-  data.tar.gz: 2e474d95a22698c1d5a2269ea083ed3a99a700bd
+SHA256:
+  metadata.gz: 728c78d6c47945aca14a06d298d49c81980d6dc841dee906fca34d5057765513
+  data.tar.gz: cbc0424afd867582c214f486acea47017c19ea593b4ac2f3bc3144d66646cd02
 SHA512:
-  metadata.gz: ea2d79e896fc7c21e8634082912a4c0956a4d3cf2d487b89f1969da36610e18be47f0646df77d57ca99a5d9314821a0db88a4b205d120f514daf082d06f81f1f
-  data.tar.gz: 7ae0567d3331b5065c7f6e85e93b93e584b2327758ff92f441ad9a26f4f61179632f8861350e12013180f4e5efae6cdf045615e705a00b36e3ca2dc4d1438ddb
+  metadata.gz: 72c7463e6c6df87f0273607c04fe9ffb6fd27353c2fc1617a9610cf95dcc659da78baeb54879f46b9ef32df57ed1985d233154a3e4ba1682ec0f79f034949586
+  data.tar.gz: e1dea8dbc805b803e7889970f7ea1f1d1689e790af86a52ad5278406132403a420ddd7ca6a1ae8e5b1813efd4f06ededc2eabed88139738c6ce70af4633b7801

data/.gitignore

@@ -21,4 +21,4 @@ tmp
 *.a
 mkmf.log
 .idea
-*.iml
+vendor/ruby

data/cru_lib.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cru_lib/version'
@@ -8,19 +10,25 @@ Gem::Specification.new do |spec|
   spec.version       = CruLib::VERSION
   spec.authors       = ['Josh Starcher']
   spec.email         = ['josh.starcher@gmail.com']
-  spec.summary       = %q{Misc libraries for Cru}
-  spec.description   = %q{Collection of common ruby logic used by a number of Cru apps}
-  spec.homepage      = ''
+  spec.summary       = 'Map ActiveRecord to Global Registry'
+  spec.description   = 'Provides a common interface for mapping ActiveRecord ' \
+                       'models to Global Registry entities and relationships.'
+  spec.homepage      = 'https://github.com/CruGlobal/cru_lib'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.add_dependency 'global_registry'
-  spec.add_dependency 'active_model_serializers'
-  spec.add_dependency 'redis'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
+  spec.add_dependency 'global_registry', '~> 1.0'
+
+  spec.add_runtime_dependency 'rails', '>= 6.0'
+  spec.add_runtime_dependency 'activesupport', '>= 6.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'rake', '~> 13'
+
+  spec.add_development_dependency 'rspec-rails', '~> 5'
+  spec.add_development_dependency 'sidekiq', '~> 6'
 end

data/lib/cru_lib/global_registry_master_person_methods.rb

@@ -0,0 +1,40 @@
+module CruLib
+  module GlobalRegistryMasterPersonMethods
+    extend ActiveSupport::Concern
+    include CruLib::GlobalRegistryMethods
+
+    included do
+      after_commit :retrieve_gr_master_person_id, on: [:create, :update]
+    end
+
+    def retrieve_gr_master_person_id
+      return unless respond_to?(:gr_master_person_id)
+      async("async_retrieve_gr_master_person_id")
+    end
+
+    def async_retrieve_gr_master_person_id
+      fail CruLib::NoGlobalRegistryIdError, "Person #{id} has no global_registry_id; will retry" unless global_registry_id
+      begin
+        person_entity = GlobalRegistry::Entity.find(global_registry_id, 'filters[owned_by]' => 'mdm')
+      rescue RestClient::ResourceNotFound
+        Rails.logger.info "GR entity #{global_registry_id} for Person #{id} does not exist; will _not_ retry"
+        return
+      end
+      mdm_entity_id = Array.wrap(person_entity.dig('entity', 'person', 'master_person:relationship'))
+                          .first # although there should not be more than one
+                          .try(:[], 'master_person')
+      fail CruLib::NoGlobalRegistryMasterPersonError, "GR entity #{global_registry_id} for Person #{id} has no master_person; will retry" unless mdm_entity_id
+      update_columns(gr_master_person_id: mdm_entity_id)
+    end
+
+    module ClassMethods
+      def skip_fields_for_gr
+        super + %w(gr_master_person_id)
+      end
+    end
+  end
+
+  class NoGlobalRegistryIdError < StandardError; end
+
+  class NoGlobalRegistryMasterPersonError < StandardError; end
+end

data/lib/cru_lib/global_registry_methods.rb

@@ -6,21 +6,20 @@ module CruLib
     extend ActiveSupport::Concern
     include CruLib::Async
 
-
     included do
-      after_commit :push_to_global_registry
-      after_destroy :delete_from_global_registry
+      after_commit :push_to_global_registry, on: [ :create, :update ]
+      after_commit :delete_from_global_registry, on: :destroy
     end
 
     def delete_from_global_registry
       if global_registry_id
-        Sidekiq::Client.enqueue(self.class, nil, :async_delete_from_global_registry, global_registry_id)
+        Sidekiq::Client.enqueue(self.class, nil, "async_delete_from_global_registry", global_registry_id)
       end
     end
 
     # Define default push method
     def push_to_global_registry
-      async(:async_push_to_global_registry)
+      async("async_push_to_global_registry")
     end
 
     def async_push_to_global_registry(parent_id = nil, parent_type = nil, parent = nil)
@@ -43,7 +42,7 @@ module CruLib
         @attributes_to_push = {}
         attributes_to_push['client_integration_id'] = id unless self.class.skip_fields_for_gr.include?('client_integration_id')
         attributes_to_push['client_updated_at'] = updated_at if respond_to?(:updated_at)
-        attributes.collect {|k, v| @attributes_to_push[k.underscore] = self.class.gr_value(k.underscore, v)}
+        attributes.each {|k, v| @attributes_to_push[k.underscore] = self.class.gr_value(k.underscore, v)}
         @attributes_to_push.select! {|k, v| v.present? && !self.class.skip_fields_for_gr.include?(k)}
       end
       @attributes_to_push
@@ -102,7 +101,7 @@ module CruLib
 
         columns_to_push.each do |column|
           unless existing_fields.include?(column[:name])
-            GlobalRegistry::EntityType.post(entity_type: {name: column[:name], parent_id: entity_type['id'], field_type: column[:type]})
+            GlobalRegistry::EntityType.post(entity_type: {name: column[:name], parent_id: entity_type['id'], field_type: column[:field_type]})
           end
         end
       end

data/lib/cru_lib/global_registry_relationship_methods.rb

@@ -10,7 +10,7 @@ module CruLib
     # TODO - deleting a relationship is different.
     def delete_from_global_registry
       if global_registry_id
-        Sidekiq::Client.enqueue(self.class, nil, :async_delete_from_global_registry, global_registry_id)
+        Sidekiq::Client.enqueue(self.class, nil, "async_delete_from_global_registry", global_registry_id)
       end
     end
 
@@ -46,7 +46,11 @@ module CruLib
 
       global_registry_id = Array.wrap(
         entity[base_object.class.global_registry_entity_type_name]["#{relationship_name}:relationship"]
-      ).detect { |hash| hash['client_integration_id'] == id.to_s }['relationship_entity_id']
+      ).detect do |hash|
+        cid = hash['client_integration_id']
+        cid = cid['value'] if cid.is_a?(Hash)
+        cid == id.to_s
+      end['relationship_entity_id']
 
       update_column(:global_registry_id, global_registry_id)
 

data/lib/cru_lib/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CruLib
+  class Railtie < Rails::Railtie
+    initializer 'crulib_railtie.configure_rollbar' do
+      if Module::const_defined? :Rollbar
+        ::Rollbar.configure do |config|
+          config.exception_level_filters.merge!('CruLib::NoGlobalRegistryIdError' => 'ignore',
+                                                'CruLib::NoGlobalRegistryMasterPersonError' => 'ignore')
+        end
+      end
+    end
+  end
+end

data/lib/cru_lib/version.rb

@@ -1,3 +1,3 @@
 module CruLib
-  VERSION = "0.0.6"
+  VERSION = '0.1.2'
 end

data/lib/cru_lib.rb

@@ -2,35 +2,8 @@ require 'cru_lib/version'
 require 'cru_lib/async'
 require 'cru_lib/global_registry_methods'
 require 'cru_lib/global_registry_relationship_methods'
-require 'cru_lib/access_token'
-require 'cru_lib/access_token_serializer'
-require 'cru_lib/access_token_protected_concern'
-require 'cru_lib/api_error'
-require 'cru_lib/api_error_serializer'
-require 'redis'
+require 'cru_lib/global_registry_master_person_methods'
+require 'cru_lib/railtie'
 
 module CruLib
-  class << self
-    attr_accessor :redis_host, :redis_port, :redis_db, :redis_client
-
-    def configure
-      yield self
-    end
-
-    def redis_host
-      @redis_host ||= 'localhost'
-    end
-
-    def redis_port
-      @redis_port ||= '6379'
-    end
-
-    def redis_db
-      @redis_db ||= 2
-    end
-
-    def redis_client
-      Redis.new(:host => CruLib.redis_host, :port => CruLib.redis_port, :db => CruLib.redis_db)
-    end
-  end
 end

data/spec/support/async_commons.rb

@@ -0,0 +1,19 @@
+
+# Mock ActiveRecord::RecordNotFound
+#
+module ActiveRecord
+  class RecordNotFound < StandardError
+  end
+end
+
+# ActiveRecord-ish - a mocked ActiveRecord that behaves like a model class with id
+#
+class ActiveRecordIsh
+  attr_accessor :id
+
+  def self.find(id)
+    obj = self.new
+    obj.id = id
+    obj
+  end
+end

data/spec/support/async_spec.rb

@@ -0,0 +1,90 @@
+
+require 'cru_lib/async'
+require_relative 'async_commons'
+
+require 'sidekiq/testing'
+Sidekiq::Testing.inline!
+
+# The class includes Sidekiq worker and responds properly to Async calls
+#
+class SidekiqAsync < ActiveRecordIsh
+  include Sidekiq::Worker
+  include CruLib::Async
+end
+
+
+describe CruLib::Async do
+  describe 'when there is no id' do
+    before(:each) do
+      @tested = SidekiqAsync.new
+    end
+
+    it 'calls class method when one argument' do
+      param_1 = SecureRandom.uuid
+
+      # Expect class method get called with just one parameter
+      #
+      expect(SidekiqAsync).to receive(:method_1) do |arg_1, *arg_2|
+        expect(arg_1).to eq(param_1)
+        expect(arg_2.length).to eq(0)
+      end
+
+      @tested.async("method_1", param_1)
+    end
+
+    it 'calls class method when two arguments' do
+      param_1 = SecureRandom.uuid
+      param_2 = SecureRandom.uuid
+
+      # Expect class method get called with two parameters
+      #
+      expect(SidekiqAsync).to receive(:method_2) do |arg_1, arg_2, *arg_3|
+        expect(arg_1).to eq(param_1)
+        expect(arg_2).to eq(param_2)
+        expect(arg_3.length).to eq(0)
+      end
+
+      @tested.async("method_2", param_1, param_2)
+    end
+  end
+
+  describe 'with id' do
+    before(:each) do
+      @tested = SidekiqAsync.new
+      @id = SecureRandom.random_number(100_000)
+      @tested.id = @id
+    end
+
+    it 'calls instance method properly when one argument' do
+      param_1 = SecureRandom.uuid
+
+      # Expect instance method get called with one parameter
+      # The object's attribute id is properly set
+      #
+      expect_any_instance_of(SidekiqAsync).to receive(:inst_method_1) do |object, arg_1, *arg_2|
+        expect(object.id).to eq(@id)
+        expect(arg_1).to eq(param_1)
+        expect(arg_2.length).to eq(0)
+      end
+
+      @tested.async("inst_method_1", param_1)
+    end
+
+    it 'calls instance method properly when two arguments' do
+      param_1 = SecureRandom.uuid
+      param_2 = SecureRandom.uuid
+
+      # Expect instance method get called with two parameters
+      # The object's attribute id is properly set
+      #
+      expect_any_instance_of(SidekiqAsync).to receive(:inst_method_2) do |object, arg_1, arg_2, *arg_3|
+        expect(object.id).to eq(@id)
+        expect(arg_1).to eq(param_1)
+        expect(arg_2).to eq(param_2)
+        expect(arg_3.length).to eq(0)
+      end
+
+      @tested.async("inst_method_2", param_1, param_2)
+    end
+  end
+end

metadata

@@ -1,86 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: cru_lib
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.2
 platform: ruby
 authors:
 - Josh Starcher
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: global_registry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: active_model_serializers
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Collection of common ruby logic used by a number of Cru apps
+        version: '6'
+description: Provides a common interface for mapping ActiveRecord models to Global
+  Registry entities and relationships.
 email:
 - josh.starcher@gmail.com
 executables: []
@@ -94,21 +123,20 @@ files:
 - Rakefile
 - cru_lib.gemspec
 - lib/cru_lib.rb
-- lib/cru_lib/access_token.rb
-- lib/cru_lib/access_token_protected_concern.rb
-- lib/cru_lib/access_token_serializer.rb
-- lib/cru_lib/api_error.rb
-- lib/cru_lib/api_error_serializer.rb
 - lib/cru_lib/async.rb
+- lib/cru_lib/global_registry_master_person_methods.rb
 - lib/cru_lib/global_registry_methods.rb
 - lib/cru_lib/global_registry_relationship_methods.rb
+- lib/cru_lib/railtie.rb
 - lib/cru_lib/version.rb
 - spec/shared_examples_for_global_registry_models.rb
-homepage: ''
+- spec/support/async_commons.rb
+- spec/support/async_spec.rb
+homepage: https://github.com/CruGlobal/cru_lib
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,11 +151,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.3.0
+signing_key:
 specification_version: 4
-summary: Misc libraries for Cru
+summary: Map ActiveRecord to Global Registry
 test_files:
 - spec/shared_examples_for_global_registry_models.rb
-has_rdoc: 
+- spec/support/async_commons.rb
+- spec/support/async_spec.rb

data/lib/cru_lib/access_token.rb

@@ -1,50 +0,0 @@
-require 'securerandom'
-
-module CruLib
-  class AccessToken < ActiveModelSerializers::Model
-    attr_accessor :key_guid, :email, :first_name, :last_name, :token, :pgt
-
-    def initialize(attributes = {})
-      super
-      generate_access_token unless attributes['token']
-      write
-    end
-
-    class << self
-
-      def read(token)
-        json = exist?(token)
-        new(Oj.load(json)) if json
-      end
-
-      def exist?(token)
-        redis_client.get(redis_key(token))
-      end
-
-      def redis_client
-        @redis_client ||= CruLib.redis_client
-      end
-
-      def redis_key(token)
-        ['cru_lib:access_token', token].join(':')
-      end
-
-      def del(token)
-        redis_client.del(redis_key(token))
-      end
-    end
-
-    private
-
-    def generate_access_token
-      loop do
-        attributes[:token] = SecureRandom.uuid.gsub(/\-/, '')
-        break unless self.class.exist?(attributes[:token])
-      end
-    end
-
-    def write
-      self.class.redis_client.setex(self.class.redis_key(attributes[:token]), 30.minutes.to_i, to_json)
-    end
-  end
-end

data/lib/cru_lib/access_token_protected_concern.rb

@@ -1,30 +0,0 @@
-module CruLib
-  module AccessTokenProtectedConcern
-    extend ActiveSupport::Concern
-
-    protected
-
-    def authenticate_request
-      authenticate_token || render_unauthorized
-    end
-
-    def authenticate_token
-      token = oauth_access_token_from_header
-      return unless oauth_access_token_from_header
-      @access_token = AccessToken.read(token)
-    end
-
-    # grabs access_token from header if one is present
-    def oauth_access_token_from_header
-      auth_header = request.env['HTTP_AUTHORIZATION'] || ''
-      match = auth_header.match(/^Bearer\s(.*)/)
-      return match[1] if match.present?
-      false
-    end
-
-    def render_unauthorized
-      headers['WWW-Authenticate'] = %{CAS realm="Application"}
-      render_error('Bad token', status: 401)
-    end
-  end
-end

data/lib/cru_lib/access_token_serializer.rb

@@ -1,13 +0,0 @@
-module CruLib
-  class AccessTokenSerializer < ActiveModel::Serializer
-    attributes :key_guid, :email, :first_name, :last_name, :token
-
-    def _type
-      'access_token'
-    end
-
-    def id
-      token
-    end
-  end
-end

data/lib/cru_lib/api_error.rb

@@ -1,5 +0,0 @@
-module CruLib
-  class ApiError < ActiveModelSerializers::Model
-    attr_accessor :message, :options
-  end
-end

data/lib/cru_lib/api_error_serializer.rb

@@ -1,13 +0,0 @@
-module CruLib
-  class ApiErrorSerializer < ActiveModel::Serializer
-    attributes :message
-
-    def _type
-      'api_error'
-    end
-
-    def id
-      _type
-    end
-  end
-end