userlist-rails 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4d61b0a03998803da600145d3fdd0f20417356a
-  data.tar.gz: 3eab7385e90e78907ae75ef7c3f65d839e9c4f89
+SHA256:
+  metadata.gz: f4ac0764bfdecbc381ea029d3fa9e8e2b04aa7f668eff35f7f54d14b7e20d1e9
+  data.tar.gz: 31e4be6a0b8fe3b5a7cf172b9a07af9e6e5dac7a9edd38751b39416ddee8ad9e
 SHA512:
-  metadata.gz: 7493478a9e99f7db583786b4e1c3e0171590b6cf9c4c899ca577042a0874cff0ff5387cffc79184b2523d7197ce213b9be6c7aab900fd56d79b197619b401d4a
-  data.tar.gz: 78941e76d2a252abdebb9a39d813064e814ea4e739409e1cba682ff8b2f902671f54255989ba14f6266865a657658405fc5cd2c6a9b1368273075cd32e38a095
+  metadata.gz: 3053ce85e9cc0d218dec274d0a11b5e0fb9caac714b999a2e3a0995946b17ae5f0180159fd978ecc91c890230cf8c744d3e9ddcfe67f1b035eb19c610ce49bbd
+  data.tar.gz: 0a426f64b71938dfea7112c62d96b97e568a47db3a8f1780571ad3612d0f7f39e8cc8c6f2511a5344b95785ad4efe18e8a5f9e912c886a9f2587601716bf2b46

data/.travis.yml

@@ -1,7 +1,7 @@
----
-sudo: false
 language: ruby
-cache: bundler
 rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.17.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6

data/README.md

@@ -1,4 +1,4 @@
-# Userlist::Rails
+# Userlist::Rails [![Build Status](https://travis-ci.com/userlistio/userlist-rails.svg?branch=master)](https://travis-ci.com/userlistio/userlist-rails)
 
 This gem helps with integrating [Userlist.io](http://userlist.io) into Ruby on Rails applications.
 
@@ -57,7 +57,7 @@ end
 
 #### Sending user data automatically
 
-By default, this gem will automatically detect your `User` model and create and update the corresponding user inside of Userlist. To customize the `identifier`, `email`, or `properties` transmitted for a user, you can overwrite the according methods in your `User` model.
+By default, this gem will automatically detect your `User` model and create, update, and delete the corresponding user inside of Userlist. To customize the `identifier`, `email`, or `properties` transmitted for a user, you can overwrite the according methods in your `User` model.
 
 ```ruby
 class User < ApplicationRecord
@@ -77,18 +77,24 @@ end
 
 #### Sending user data manually
 
-To manually send user data into Userlist, use the `Userlist::Push.user` method.
+To manually send user data into Userlist, use the `Userlist::Push.users.push` method.
 
 ```ruby
-Userlist::Push.user(identifier: user.id, email: user.email, properties: { first_name: user.first_name, last_name: user.last_name })
+Userlist::Push.users.push(identifier: user.id, email: user.email, properties: { first_name: user.first_name, last_name: user.last_name })
+```
+
+It's also possible to delete a user from Userlist, using the `Userlist::Push.users.delete` method.
+
+```ruby
+Userlist::Push.users.delete(user.id)
 ```
 
 ### Tracking Events
 
-To track custom events use the `Userlist::Push.event` method.
+To track custom events use the `Userlist::Push.events.push` method.
 
 ```ruby
-Userlist::Push.event(name: 'project_created', user: current_user, properties: { project_name: project.name })
+Userlist::Push.events.push(name: 'project_created', user: current_user, properties: { project_name: project.name })
 ```
 
 It is possible to make the `user` property optional by setting it for the entire request using an `around_action` callback in your `ApplicationController`.
@@ -106,7 +112,7 @@ end
 This simplifies the tracking call for the current request.
 
 ```ruby
-Userlist::Push.event(name: 'project_created', properties: { project_name: project.name })
+Userlist::Push.events.push(name: 'project_created', properties: { project_name: project.name })
 ```
 
 ### Batch importing

data/lib/userlist/rails/company.rb

@@ -7,8 +7,10 @@ module Userlist
       extend ActiveSupport::Concern
 
       included do
-        method = [:after_commit, :after_save].find { |m| respond_to?(m) }
-        public_send(method, :userlist_push) if method
+        if method = [:after_commit, :after_save].find { |m| respond_to?(m) }
+          public_send(method, :userlist_push, on: [:create, :update])
+          public_send(method, :userlist_delete, on: [:destroy])
+        end
       end
 
       def userlist_identifier
@@ -32,7 +34,11 @@ module Userlist
       end
 
       def userlist_push
-        Userlist::Push.company(userlist_payload)
+        Userlist::Push.companies.push(userlist_payload)
+      end
+
+      def userlist_delete
+        Userlist::Push.companies.delete(userlist_identifier)
       end
     end
   end

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

@@ -0,0 +1,13 @@
+module Userlist
+  module Rails
+    module Extensions
+      module Event
+        def initialize(payload)
+          payload[:user] ||= Userlist::Rails.current_user
+
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/hash/transform_values' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5.0')
+
+module Userlist
+  module Rails
+    module Extensions
+      module Resource
+        def initialize(payload = {})
+          super(transform_payload(payload))
+        end
+
+      private
+
+        def transform_payload(payload)
+          payload = transform_value(payload)
+
+          return payload unless payload.is_a?(Hash)
+
+          payload.transform_values do |value|
+            result = transform_value(value)
+            result = transform_payload(result) if result.is_a?(Hash)
+            result
+          end
+        end
+
+        def transform_value(value)
+          if value.respond_to?(:userlist_payload)
+            value.send(:userlist_payload)
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/railtie.rb

@@ -3,10 +3,12 @@ require 'rails/railtie'
 require 'userlist'
 require 'userlist/config'
 require 'userlist/rails/logger'
-require 'userlist/rails/push'
 require 'userlist/rails/user'
 require 'userlist/rails/company'
 
+require 'userlist/rails/extensions/resource'
+require 'userlist/rails/extensions/event'
+
 module Userlist
   module Rails
     class Railtie < ::Rails::Railtie
@@ -25,7 +27,8 @@ module Userlist
       end
 
       initializer 'userlist.extensions' do
-        Userlist::Push.send(:prepend, Userlist::Rails::Push)
+        Userlist::Push::Resource.send(:prepend, Userlist::Rails::Extensions::Resource)
+        Userlist::Push::Event.send(:prepend, Userlist::Rails::Extensions::Event)
       end
 
       initializer 'userlist.models' do

data/lib/userlist/rails/user.rb

@@ -7,8 +7,10 @@ module Userlist
       extend ActiveSupport::Concern
 
       included do
-        method = [:after_commit, :after_save].find { |m| respond_to?(m) }
-        public_send(method, :userlist_push) if method
+        if method = [:after_commit, :after_save].find { |m| respond_to?(m) }
+          public_send(method, :userlist_push, on: [:create, :update])
+          public_send(method, :userlist_delete, on: [:destroy])
+        end
       end
 
       def userlist_identifier
@@ -38,7 +40,11 @@ module Userlist
       end
 
       def userlist_push
-        Userlist::Push.user(userlist_payload)
+        Userlist::Push.users.push(userlist_payload)
+      end
+
+      def userlist_delete
+        Userlist::Push.users.delete(userlist_identifier)
       end
     end
   end

data/lib/userlist/rails/version.rb

@@ -1,5 +1,5 @@
 module Userlist
   module Rails
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/userlist/rails.rb

@@ -1,6 +1,9 @@
 require 'userlist/rails/config'
 require 'userlist/rails/railtie'
 
+require 'userlist/rails/extensions/resource'
+require 'userlist/rails/extensions/event'
+
 module Userlist
   module Rails
     def self.with_current_user(user)

data/userlist-rails.gemspec

@@ -21,11 +21,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 3.0'
   spec.add_dependency 'railties', '>= 3.0'
-  spec.add_dependency 'userlist', '~> 0.2', '>= 0.2.2'
+  spec.add_dependency 'userlist', '~> 0.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '>= 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'webmock', '~> 1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,32 +44,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0.3'
 - !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
@@ -100,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -152,9 +132,10 @@ files:
 - lib/userlist/rails.rb
 - lib/userlist/rails/company.rb
 - lib/userlist/rails/config.rb
+- lib/userlist/rails/extensions/event.rb
+- lib/userlist/rails/extensions/resource.rb
 - lib/userlist/rails/importer.rb
 - lib/userlist/rails/logger.rb
-- lib/userlist/rails/push.rb
 - lib/userlist/rails/railtie.rb
 - lib/userlist/rails/user.rb
 - lib/userlist/rails/version.rb
@@ -178,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails integration for Userlist.io

data/lib/userlist/rails/push.rb

@@ -1,41 +0,0 @@
-require 'active_support/core_ext/hash/transform_values'
-
-module Userlist
-  module Rails
-    module Push
-      def event(payload = {})
-        payload[:user] ||= Userlist::Rails.current_user
-
-        super(transform_payload(payload))
-      end
-      alias track event
-
-      def user(payload = {})
-        super(transform_payload(payload))
-      end
-      alias identify user
-
-    private
-
-      def transform_payload(payload)
-        payload = transform_value(payload)
-
-        return payload unless payload.is_a?(Hash)
-
-        payload.transform_values do |value|
-          result = transform_value(value)
-          result = transform_payload(result) if result.is_a?(Hash)
-          result
-        end
-      end
-
-      def transform_value(value)
-        if value.respond_to?(:userlist_payload)
-          value.send(:userlist_payload)
-        else
-          value
-        end
-      end
-    end
-  end
-end