userlist-rails 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca257f164074da93de47984ddd695b818510ab5e671a1e4545eb986663d34335
-  data.tar.gz: 6fb32d37480a4af75a79f82c8ee76e180d0a29eed7b6a86fa09ea12e749544c2
+  metadata.gz: b37f407aa0fafadcfd37cece33e49bb05d04e2891b442717f167e0f0391f1c99
+  data.tar.gz: e69bde3e0e95de200a7196bf10c30abd5f68be569fec68af7ea756b542f36017
 SHA512:
-  metadata.gz: '049815dabf0844173db83e9186e19e1736db9f0c14a9754f14203bcca1129b8be5411127e48212830b7951f6ff4d35cb9e36647c7af7214b607d47932400b96c'
-  data.tar.gz: ab1a3d8c38682a1de52ed54cae85c210a13b037e4fef8e83dc8c1cbc6381fcdad6727813e294e82411ae060169397963f282739722df38007a9e186d4127e4f7
+  metadata.gz: 2b103ab51d54698367fe4d30b115dbc9afbaac61e6a35afa87790892a8f993c205dfc2bea47818c0719a84101743126c24aa1d2facc49fbf35fbc9d362493f49
+  data.tar.gz: c5882c73da7629605644ee62c8562d42fdb5339338020adbcfeec85143c3b98a281fafcfc342eeff16ec25cf317b466341f7fb1fd6749f34cb514e83258de386

data/.github/workflows/test.yml

@@ -5,15 +5,14 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.4
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
           - 3.0
+          - 3.1
+          - 3.2
+          - 3.3
+          - 3.4
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
---color
 --require spec_helper
+--order random
+--color

data/CHANEGLOG.md

@@ -0,0 +1,79 @@
+# Userlist for Ruby on Rails Changelog
+
+## Unreleased (main)
+
+## v1.0.0 (2025-04-08)
+
+- Fix detection of relationships when there are multiple associations between users and companies
+- Register Userlist::DeliveryMethod when it's available
+
+## v0.6.2 (2023-11-30)
+
+- Upgrades dependencies
+
+## v0.6.1 (2021-05-14)
+
+- Upgrades dependencies
+
+## v0.6.0 (2021-05-14)
+
+- Improves handling of relationships across different setups (1:1, 1:n, and n:m)
+- Automatically call userlist\_\* methods on models in transforms
+
+## v0.5.3 (2021-04-15)
+
+- Makes userlist_push? and userlist_delete? methods work as documented
+
+## v0.5.2 (2021-02-12)
+
+- Only detect classes as models
+
+## v0.5.1 (2021-01-22)
+
+- Adds deprecation warnings for user and company models
+- Adds documentation about tracking companies and relationships
+
+## v0.5.0 (2021-01-22)
+
+- Adds support for relationships between users and companies
+- Allows setting of global company for events
+- Improves reliablity of callback initializations
+- Don’t extend the user and company model anymore
+- Log errors when pushing instead of raising them
+- Introduced transforms to wrap models as payloads
+- Replaces userlist.io with userlist.com
+- Require at least Ruby 2.3
+- Upgrades dependencies
+
+## v0.4.0 (2020-03-10)
+
+- Adds helper method for adding the Userlist script tag
+- Require at least Ruby 2.3
+
+## v0.3.0 (2019-06-27)
+
+- Use Userlist::Push::Resources to transform payloads
+- Upgrades dependencies
+
+## v0.2.2 (2019-03-18)
+
+- Adds support for Ruby 2.2
+
+## v0.2.1 (2019-03-13)
+
+- Use an explicit method for callbacks instead of just a block
+- Adds note about test and development environments
+
+## v0.2.0 (2018-11-21)
+
+- Adds basic documentation
+- Adds support for global defintion of current user
+- Use created_at as signed_up_at for users
+- Use global push instance instead of creating one for each model
+- Properly prepare models in rake tasks
+- Properly setup models after reloads
+- Upgrades dependencies
+
+## v0.1.0 (2018-01-18)
+
+- Initial release

data/Gemfile

@@ -6,3 +6,10 @@ gemspec
 
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'
+
+gem 'activerecord', '>= 5.0'
+gem 'actionpack', '>= 5.0'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rspec-rails', '~> 6.0'
+gem 'sqlite3', '>= 1.4'

data/README.md

@@ -265,10 +265,10 @@ end
 
 #### Deleting relationships
 
-It's also possible to delete a relationship from Userlist, using the `Userlist::Push.relationship.delete` method.
+It's also possible to delete a relationship from Userlist, using the `Userlist::Push.relationships.delete` method.
 
 ```ruby
-Userlist::Push.relationship.delete(membership)
+Userlist::Push.relationships.delete(membership)
 ```
 
 ### Tracking Events

data/lib/userlist/rails/extensions/user.rb

@@ -17,6 +17,14 @@ module Userlist
           base.extend(ClassMethods)
         end
 
+        def identifier
+          super if !payload.respond_to?(:destroyed?) || !payload.destroyed?
+        end
+
+        def identifiers
+          super if payload.respond_to?(:destroyed?) && payload.destroyed?
+        end
+
         def push?
           super && (!payload.respond_to?(:push?) || payload.push?)
         end

data/lib/userlist/rails/importer.rb

@@ -8,9 +8,9 @@ module Userlist
 
       def import(model, &block)
         find_each(model) do |record|
-          print "Pushing #{model.name} #{record.id}..."
-          instance_exec(record, &block)
-          print " ✔︎\n"
+          print "Pushing #{model.name} #{record.id}... "
+          result = instance_exec(record, &block)
+          puts status(result)
         end
       end
 
@@ -31,6 +31,13 @@ module Userlist
           raise "Cannot iterate over #{model} because it doesn't implement .find_each, nor .each"
         end
       end
+
+      def status(result)
+        return '⊝' if result.nil?
+        return '✔' if (200..300).cover?(result.code.to_i)
+
+        '✗'
+      end
     end
   end
 end

data/lib/userlist/rails/railtie.rb

@@ -36,7 +36,7 @@ module Userlist
       end
 
       initializer 'userlist.helpers' do
-        ActiveSupport.on_load :action_view do
+        ActiveSupport.on_load(:action_view) do
           include Userlist::Rails::Helpers
         end
       end
@@ -75,6 +75,12 @@ module Userlist
           end
         end
       end
+
+      initializer 'userlist.delivery_method', before: 'action_mailer.set_configs' do
+        ActiveSupport.on_load(:action_mailer) do
+          ActionMailer::Base.add_delivery_method(:userlist, Userlist::DeliveryMethod) if defined?(Userlist::DeliveryMethod)
+        end
+      end
     end
   end
 end

data/lib/userlist/rails/transform.rb

@@ -27,11 +27,15 @@ module Userlist
       end
 
       def push?
-        (!model.respond_to?(:userlist_push?) || model.userlist_push?)
+        !model.respond_to?(:userlist_push?) || model.userlist_push?
       end
 
       def delete?
-        (!model.respond_to?(:userlist_delete?) || model.userlist_delete?)
+        !model.respond_to?(:userlist_delete?) || model.userlist_delete?
+      end
+
+      def destroyed?
+        model.try(:destroyed?)
       end
 
     private

data/lib/userlist/rails/transforms/user.rb

@@ -12,6 +12,7 @@ module Userlist
             :identifier,
             :properties,
             :relationships,
+            :identifiers,
             :email,
             :signed_up_at
           ]
@@ -33,6 +34,10 @@ module Userlist
           model.try(:created_at)
         end
 
+        def default_identifiers
+          [{ scope: 'custom', identifier: self[:identifier] }]
+        end
+
       private
 
         def build_relationship(record)

data/lib/userlist/rails/version.rb

@@ -1,5 +1,5 @@
 module Userlist
   module Rails
-    VERSION = '0.6.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/userlist/rails.rb

@@ -11,6 +11,12 @@ module Userlist
       :userlist_user
     ].freeze
 
+    REFLECTION_PRIORITY = [
+      ActiveRecord::Reflection::ThroughReflection,
+      ActiveRecord::Reflection::HasManyReflection,
+      ActiveRecord::Reflection::HasOneReflection
+    ].freeze
+
     def self.with_current_user(user)
       Thread.current[:userlist_current_user] = user
       yield
@@ -56,7 +62,10 @@ module Userlist
     def self.find_reflection(from, to)
       return unless from && to
 
-      from.reflect_on_all_associations.find { |r| r.class_name == to.to_s }
+      from
+        .reflect_on_all_associations
+        .sort_by { |r| REFLECTION_PRIORITY.index(r.class) || REFLECTION_PRIORITY.length }
+        .find { |r| r.class_name == to.to_s }
     end
 
     def self.find_association_between(from, to)
@@ -75,15 +84,17 @@ module Userlist
       model.instance_variable_set(:@userlist_callbacks_registered, true)
     end
 
-    def self.setup_callback(type, model, scope, method)
+    def self.setup_callback(type, model, scope, default_method)
       return unless callback_method = [:after_commit, :"after_#{type}"].find { |m| model.respond_to?(m) }
 
       callback = lambda do
         begin
+          method = try(:"userlist_#{type}_behavior") || default_method
+
           relation = Userlist::Push.public_send(scope)
           relation.public_send(method, self)
         rescue Userlist::Error => e
-          Userlist.logger.error "Failed to #{method} #{method.to_s.singularize}: #{e.message}"
+          Userlist.logger.error "Failed to #{method} #{scope.to_s.singularize}: #{e.message}"
         end
       end
 

data/userlist-rails.gemspec

@@ -23,13 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 5.0'
   spec.add_dependency 'railties', '>= 5.0'
-  spec.add_dependency 'userlist', '~> 0.6'
+  spec.add_dependency 'userlist', '~> 1.0'
 
-  spec.add_development_dependency 'actionpack', '>= 5.0'
-  spec.add_development_dependency 'activerecord', '>= 5.0'
-  spec.add_development_dependency 'bundler', '>= 1.15'
-  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.0'
-  spec.add_development_dependency 'sqlite3', '>= 1.4'
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: userlist-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,119 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  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'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  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'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-description:
+        version: '1.0'
 email:
 - benedikt@userlist.com
 executables: []
@@ -167,6 +61,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANEGLOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -197,8 +92,8 @@ files:
 homepage: https://github.com/userlistio/userlist-rails
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -213,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Rails integration for Userlist
 test_files: []