userlist 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5f47b48e2bcc0babdbb7bcc85e84e5b197dacefb777eb19764d6f23e78e682
-  data.tar.gz: 53caac6db3e462e9fe280541a7249da39e821a6a8bed7c70373131bebe9a6e19
+  metadata.gz: 4d6e93ef4ff51c272a689c07261fd423941a7244bec1cedf84af7207cd702816
+  data.tar.gz: 6c424b3183ec05af8a620dd39dea582bd097fc1514e800f8cd2b63aab342b90f
 SHA512:
-  metadata.gz: 687b4ff1d89c5c98814fc89fe7cb8097577bd0cea63138f40e194eb47d6d6a2807b624c9dd15f2b64868f0473f1baaf268b6f7cb3945b713c20d00150b71739c
-  data.tar.gz: 0b72bc8a28a6cba596c5afaff369e62b26cc8a84347f0059f68859c02df270562663c9e7faa8ddbb89a7053cf6d811d7dfcafa75f2f9233c27a36aebd72e4b4a
+  metadata.gz: f8ef2403697c2a9369f0b74737a5429cd0f650c4c22f1e09ab18d024dc7750622032077eb1fb392611ee1fa1907ea48b8e2d2aad2afbf6246fe3eb96c7f2fddd
+  data.tar.gz: e2578be25dd0be0db2d721d900f14910f238a72554918319ecad8ba16d3fffaac5da982b6e4c306c4af6bc540f12baeea71c6e7a4e9a0c4418a150028cb38fee

data/.github/workflows/test.yml

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

data/.rubocop.yml

@@ -51,6 +51,9 @@ Style/ClassAndModuleChildren:
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
+Layout/SpaceAroundOperators:
+  EnforcedStyleForExponentOperator: space
+
 Style/SymbolArray:
   Enabled: false
 

data/CHANGELOG.md

@@ -0,0 +1,84 @@
+# Userlist for Ruby Changelog
+
+## v0.8.1 (2023-11-30)
+
+- Fixes issue with customizability of push? and delete? methods on events and relationships
+
+## v0.8.0 (2023-08-02)
+
+- Adds a ActiveJob push strategy
+- Adds support for retries of failed requests
+- Adds response logging to the push client
+- Adds support for payloads on delete requests
+
+## v0.7.2 (2022-10-20)
+
+- Improves connection handling between requests
+- Improves handling of arguments passed to Sidekiq
+
+## v0.7.1 (2022-02-10)
+
+- Fixes issue with Sidekiq payloads (#4)
+
+## v0.7.0 (2022-02-02)
+
+- Allows users without an identifier but with an email address
+
+## v0.6.0 (2021-05-14)
+
+- Automatically manage one side of the relationships
+- Always requires a user and a company on relationships
+
+## v0.5.0 (2021-01-22)
+
+- Adds support for relationships
+- Adds support for company events
+- Adds support for skipping certain operations
+- Adds lazy lookup for push strategies
+- Adds a Sidekiq push strategy
+- Allow numerics as identifiers
+- Improves Userlist::Token to work with more than just strings
+- Improves the way resources are serialized
+- Improves JSON serialization
+- Replaces userlist.io with userlist.com
+- Require at least Ruby 2.4
+
+## v0.4.1 (2020-03-16)
+
+- Fixes a problem when configuring the client (#1)
+
+## v0.4.0 (2020-03-06)
+
+- Adds improved error messages for configuration errors
+- Adds support for user token generation
+- Require at least Ruby 2.3
+
+## v0.3.0 (2019-06-27)
+
+- Adds additional aliases for the create method
+- Adds resource models for User, Company, and Event
+- Adds a more flexible interface to the push client
+- Adds more HTTP methods to the push client
+
+## v0.2.2 (2019-03-18)
+
+- Adds support for Ruby 2.2
+
+## v0.2.1 (2019-03-13)
+
+- Adds support for Ruby 2.3
+
+## v0.2.0 (2018-11-21)
+
+- Adds the ability to adjust the configuration
+- Adds convenience class methods to Userlist::Push
+- Adds track and identify aliases for event and user push methods
+- Adds null strategy that discards everything for testing purposes
+- Adds logging support
+- Adds threaded push strategy to deliver requests without blocking the main thread
+- Adds Userlist::Push as a nicer interface to the push endpoint
+- Require at least Ruby 2.1
+
+## v0.1.0 (2018-01-18)
+
+- Initial release

data/Gemfile

@@ -6,6 +6,8 @@ gemspec
 
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'
-gem 'rubocop', '~> 0.68'
+gem 'rubocop', '~> 1.45'
 
 gem 'sidekiq'
+gem 'activejob'
+gem 'uri'

data/README.md

@@ -44,15 +44,15 @@ end
 
 The possible configuration values are listed in the table below.
 
-| Name                    | Default value                | Description                                                                                                                 |
-| ----------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `push_key`              | `nil`                        | The push key for your account. See [Push API settings](https://app.userlist.com/settings/push).                             |
-| `push_id`               | `nil`                        | The push id for your account. See [Push API settings](https://app.userlist.com/settings/push).                              |
-| `push_endpoint`         | `https://push.userlist.com/` | The HTTP endpoint that the library will send data to.                                                                       |
-| `push_strategy`         | `:threaded`                  | The strategy to use to send data to the HTTP endpoint. Possible values are `:threaded`, `:sidekiq`, `:direct`, and `:null`. |
-| `push_strategy_options` | `{}`                         | Any additional options for the push strategy.                                                                               |
-| `log_level`             | `:warn`                      | The log level for Userlist related log messages. Possible values are `:debug`, `:error`, `:fatal`, `:info`, and `:warn`     |
-| `token_lifetime`        | `3600`                       | The lifetime of generated in-app messages tokens in seconds                                                                 |
+| Name                    | Default value                | Description                                                                                                                                |
+| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `push_key`              | `nil`                        | The push key for your account. See [Push API settings](https://app.userlist.com/settings/push).                                            |
+| `push_id`               | `nil`                        | The push id for your account. See [Push API settings](https://app.userlist.com/settings/push).                                             |
+| `push_endpoint`         | `https://push.userlist.com/` | The HTTP endpoint that the library will send data to.                                                                                      |
+| `push_strategy`         | `:threaded`                  | The strategy to use to send data to the HTTP endpoint. Possible values are `:threaded`, `:sidekiq`, `:active_job`, `:direct`, and `:null`. |
+| `push_strategy_options` | `{}`                         | Any additional options for the push strategy.                                                                                              |
+| `log_level`             | `:warn`                      | The log level for Userlist related log messages. Possible values are `:debug`, `:error`, `:fatal`, `:info`, and `:warn`                    |
+| `token_lifetime`        | `3600`                       | The lifetime of generated in-app messages tokens in seconds                                                                                |
 
 ### Disabling in development and test environments
 

data/lib/userlist/config.rb

@@ -53,7 +53,7 @@ module Userlist
 
     def config_from_environment
       default_config.keys.each_with_object({}) do |key, config|
-        value = ENV["USERLIST_#{key.to_s.upcase}"]
+        value = ENV.fetch("USERLIST_#{key.to_s.upcase}", nil)
         config[key] = value if value
       end
     end

data/lib/userlist/push/client.rb

@@ -27,8 +27,8 @@ module Userlist
         request(Net::HTTP::Put, endpoint, payload)
       end
 
-      def delete(endpoint)
-        request(Net::HTTP::Delete, endpoint)
+      def delete(endpoint, payload = nil)
+        request(Net::HTTP::Delete, endpoint, payload)
       end
 
     private
@@ -58,7 +58,11 @@ module Userlist
         logger.debug "Sending #{request.method} to #{URI.join(endpoint, request.path)} with body #{request.body}"
 
         http.start unless http.started?
-        http.request(request)
+        response = http.request(request)
+
+        logger.debug "Recieved #{response.code} #{response.message} with body #{response.body}"
+
+        response
       end
 
       def endpoint

data/lib/userlist/push/event.rb

@@ -19,7 +19,7 @@ module Userlist
       end
 
       def push?
-        (user.nil? || user.push?) && (company.nil? || company.push?)
+        super && (user.nil? || user.push?) && (company.nil? || company.push?)
       end
     end
   end

data/lib/userlist/push/relationship.rb

@@ -23,7 +23,7 @@ module Userlist
       end
 
       def push?
-        user&.push? && company&.push?
+        super && user&.push? && company&.push?
       end
     end
   end

data/lib/userlist/push/resource.rb

@@ -33,9 +33,9 @@ module Userlist
           relationships[name.to_sym] = { type: type }
 
           generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}
-              #{type}.from_payload(payload[:#{name}], config)
-            end
+            def #{name}                                        # def company
+              #{type}.from_payload(payload[:#{name}], config)  #   Company.from_payload(payload[:company], config)
+            end                                                # end
           RUBY
         end
 
@@ -43,11 +43,11 @@ module Userlist
           relationships[name.to_sym] = options
 
           generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}
-              relationship = self.class.relationships[:#{name}]
-
-              ResourceCollection.new(payload[:#{name}], relationship, self, config)
-            end
+            def #{name}                                                             # def companies
+              relationship = self.class.relationships[:#{name}]                     #   relationship = self.class.relationships[:companies]
+                                                                                    #
+              ResourceCollection.new(payload[:#{name}], relationship, self, config) # ResourceCollection.new(payload[:companies], relationship, self, config)
+            end                                                                     #
           RUBY
         end
 

data/lib/userlist/push/strategies/active_job/worker.rb

@@ -0,0 +1,16 @@
+require 'active_job'
+
+module Userlist
+  class Push
+    module Strategies
+      class ActiveJob
+        class Worker < ::ActiveJob::Base
+          def perform(method, *args)
+            client = Userlist::Push::Client.new
+            client.public_send(method, *args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies/active_job.rb

@@ -0,0 +1,47 @@
+require 'active_job'
+
+require 'userlist/push/strategies/active_job/worker'
+
+module Userlist
+  class Push
+    module Strategies
+      class ActiveJob
+        def initialize(config = {})
+          @config = Userlist.config.merge(config)
+        end
+
+        def call(*args)
+          options = default_options.merge(self.options)
+
+          worker_name = options.delete(:class)
+          worker_class = Object.const_get(worker_name)
+          worker_class
+            .set(options)
+            .perform_later(*normalize(args))
+        end
+
+      private
+
+        attr_reader :config
+
+        def options
+          @options ||= begin
+            options = config.push_strategy_options || {}
+            options.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+          end
+        end
+
+        def default_options
+          {
+            class: 'Userlist::Push::Strategies::ActiveJob::Worker',
+            queue: 'default'
+          }
+        end
+
+        def normalize(args)
+          JSON.parse(JSON.generate(args))
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies/direct.rb

@@ -7,7 +7,7 @@ module Userlist
         end
 
         def call(*args)
-          client.public_send(*args)
+          retryable.attempt { client.public_send(*args) }
         end
 
       private
@@ -17,6 +17,14 @@ module Userlist
         def client
           @client ||= Userlist::Push::Client.new(config)
         end
+
+        def retryable
+          @retryable ||= Userlist::Retryable.new do |response|
+            status = response.code.to_i
+
+            status >= 500 || status == 429
+          end
+        end
       end
     end
   end

data/lib/userlist/push/strategies/threaded/worker.rb

@@ -22,7 +22,7 @@ module Userlist
                 method, *args = *queue.pop
                 break if method == :stop
 
-                client.public_send(method, *args)
+                retryable.attempt { client.public_send(method, *args) }
               rescue StandardError => e
                 logger.error "Failed to deliver payload: [#{e.class.name}] #{e.message}"
               end
@@ -44,6 +44,14 @@ module Userlist
           def client
             @client ||= Userlist::Push::Client.new(config)
           end
+
+          def retryable
+            @retryable ||= Userlist::Retryable.new do |response|
+              status = response.code.to_i
+
+              status >= 500 || status == 429
+            end
+          end
         end
       end
     end

data/lib/userlist/push/strategies.rb

@@ -12,13 +12,16 @@ module Userlist
         return strategy unless strategy.is_a?(Symbol) || strategy.is_a?(String)
 
         require_strategy(strategy)
-        const_get(strategy.to_s.capitalize, false)
+
+        class_name = classify_strategy(strategy)
+        const_get(class_name, false)
       end
 
       def self.strategy_defined?(strategy)
         return true unless strategy.is_a?(Symbol) || strategy.is_a?(String)
 
-        const_defined?(strategy.to_s.capitalize, false)
+        class_name = classify_strategy(strategy)
+        const_defined?(class_name, false)
       end
 
       def self.require_strategy(strategy)
@@ -26,6 +29,11 @@ module Userlist
 
         require("userlist/push/strategies/#{strategy}") unless strategy_defined?(strategy)
       end
+
+      def self.classify_strategy(strategy)
+        strategy.to_s.split('_').map(&:capitalize).join
+      end
+      private_class_method :classify_strategy
     end
   end
 end

data/lib/userlist/retryable.rb

@@ -0,0 +1,49 @@
+module Userlist
+  class Retryable
+    include Userlist::Logging
+
+    RETRIES = 10
+    DELAY = 100
+    MULTIPLIER = 2
+    MAX_DELAY = 10_000
+
+    def initialize(retries: RETRIES, delay: DELAY, max_delay: MAX_DELAY, multiplier: MULTIPLIER, &retry_check)
+      @retries = retries
+      @delay = delay
+      @max_delay = max_delay
+      @multiplier = multiplier
+      @retry_check = retry_check
+    end
+
+    def retry?(value)
+      @retry_check.call(value)
+    end
+
+    def attempt
+      (0..@retries).each do |attempt|
+        if attempt.positive?
+          milliseconds = delay(attempt)
+          logger.debug "Retrying in #{milliseconds}ms, #{@retries - attempt} retries left"
+          sleep(milliseconds / 1000.0)
+        end
+
+        result = yield
+
+        return result unless retry?(result)
+      end
+
+      logger.debug 'Retries exhausted, giving up'
+
+      nil
+    end
+
+  private
+
+    def delay(attempt)
+      [
+        @delay * (@multiplier ** attempt),
+        @max_delay
+      ].min
+    end
+  end
+end

data/lib/userlist/version.rb

@@ -1,3 +1,3 @@
 module Userlist
-  VERSION = '0.7.2'.freeze
+  VERSION = '0.8.1'.freeze
 end

data/lib/userlist.rb

@@ -3,6 +3,7 @@ require 'logger'
 require 'userlist/version'
 require 'userlist/config'
 require 'userlist/logging'
+require 'userlist/retryable'
 require 'userlist/push'
 require 'userlist/token'
 

data/userlist.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.15'
   spec.add_development_dependency 'jwt', '~> 2.2'
-  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,20 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   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
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.18'
 description:
 email:
 - benedikt@userlist.com
@@ -97,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -120,6 +115,8 @@ files:
 - lib/userlist/push/resource_collection.rb
 - lib/userlist/push/serializer.rb
 - lib/userlist/push/strategies.rb
+- lib/userlist/push/strategies/active_job.rb
+- lib/userlist/push/strategies/active_job/worker.rb
 - lib/userlist/push/strategies/direct.rb
 - lib/userlist/push/strategies/null.rb
 - lib/userlist/push/strategies/sidekiq.rb
@@ -127,13 +124,15 @@ files:
 - lib/userlist/push/strategies/threaded.rb
 - lib/userlist/push/strategies/threaded/worker.rb
 - lib/userlist/push/user.rb
+- lib/userlist/retryable.rb
 - lib/userlist/token.rb
 - lib/userlist/version.rb
 - userlist.gemspec
 homepage: http://github.com/userlistio/userlist-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -149,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Userlist API