userlist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9534a94215f86a6e4da9add6729d0dfdc04f2d37
-  data.tar.gz: 8d6a8b22aaeca9dc9ab99b4d4f567929c797da47
+SHA256:
+  metadata.gz: e36d328f443fa566c4e77f6d76bf7c3eb279677447d3451a56813868eef365c6
+  data.tar.gz: 42a788537faafae0cc66a8dcfd037c2ef7b2ca3ab78918922738e40e0b7c67b0
 SHA512:
-  metadata.gz: 60533319f67189405db69dc774ea8135408386d4305fdd82d1c0cc9c864a28f4620ab16a62947f571cfdcd52379a3fa3ee9d36c4d5033ce39cb3c0aa5d46fbbd
-  data.tar.gz: 6b9870124cc409d969fbf0a5c374de2956184d7f47a5b8b1c9b79107af0753de8c3dff663c5b697941262f0fc2507c96a7335d77fc24a2a4a1397d453af0ca97
+  metadata.gz: 8ac7634b4f9a6059ee0c4c1c774be2d1b6d4ca2857eeceb4b4c6ef05ff7f070034780991cc196dc6f5ffe8f49f1f844a00f7ac614638f850d3e2e3a78ee644c8
+  data.tar.gz: 5a3154eeb7aa9368802961166c6fa89ab98c485d6c182d9a80d57d51edd0a09170da59237794d482fc5b1f470a19ce90f59ad5e297b864f6f633b028ea28fc3d

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.2
   Exclude:
     - 'bin/*'
     - 'Guardfile'

data/lib/userlist/config.rb

@@ -1,39 +1,79 @@
 module Userlist
   class Config
     DEFAULT_CONFIGURATION = {
-      push_key:           nil,
-      push_endpoint:      'https://push.userlist.io/'
+      push_key: nil,
+      push_endpoint: 'https://push.userlist.io/',
+      push_strategy: :threaded,
+      log_level: :warn
     }.freeze
 
     def initialize(config_from_initialize = {})
-      @config = DEFAULT_CONFIGURATION
+      @config = default_config
         .merge(config_from_initialize)
         .merge(config_from_environment)
     end
 
-  private
+    def self.inherit(parent, config_from_arguments)
+      config = allocate
+      config.instance_variable_set(:@parent, parent)
+      config.instance_variable_set(:@config, config_from_arguments.to_hash)
+      config
+    end
+
+    def merge(other_config)
+      self.class.inherit(self, other_config)
+    end
+
+    def to_hash
+      config
+    end
+
+    def to_h
+      parent ? parent.to_h.merge(config) : to_hash
+    end
+
+    def ==(other)
+      config == other.config && parent == other.parent
+    end
+
+  protected
 
-    attr_reader :config
+    attr_reader :config, :parent
+
+    def default_config
+      DEFAULT_CONFIGURATION
+    end
 
     def config_from_environment
-      DEFAULT_CONFIGURATION.keys.each_with_object({}) do |key, config|
+      default_config.keys.each_with_object({}) do |key, config|
         value = ENV["USERLIST_#{key.to_s.upcase}"]
         config[key] = value if value
       end
     end
 
-    def respond_to_missing?(name)
+    def key?(key)
+      config.key?(key) || parent && parent.key?(key)
+    end
+
+    def [](key)
+      config[key] || parent && parent[key]
+    end
+
+    def []=(key, value)
+      config[key] = value
+    end
+
+    def respond_to_missing?(name, include_private = false)
       name = name.to_s.sub(/=$/, '')
-      config.key?(name.to_sym)
+      key?(name.to_sym) || super
     end
 
     def method_missing(name, *args, &block)
-      name = name.to_s
-
       if respond_to_missing?(name)
+        name = name.to_s
         method = name.match?(/=$/) ? :[]= : :[]
         name = name.sub(/=$/, '').to_sym
-        config.public_send(method, name, *args, &block)
+        send(method, name, *args, &block)
       else
         super
       end

data/lib/userlist/logging.rb

@@ -0,0 +1,11 @@
+module Userlist
+  module Logging
+    def self.included(mod)
+      mod.send(:extend, self)
+    end
+
+    def logger
+      Userlist.logger
+    end
+  end
+end

data/lib/userlist/push/client.rb

@@ -4,10 +4,12 @@ require 'net/http'
 require 'openssl'
 
 module Userlist
-  module Push
+  class Push
     class Client
-      def initialize(config = Userlist.config)
-        @config = config
+      include Userlist::Logging
+
+      def initialize(config = {})
+        @config = Userlist.config.merge(config)
       end
 
       def post(endpoint, payload = {})
@@ -31,13 +33,15 @@ module Userlist
         end
       end
 
-      def request(endpoint, payload = {})
-        request = Net::HTTP::Post.new(endpoint)
+      def request(path, payload = {})
+        request = Net::HTTP::Post.new(path)
         request['Accept'] = 'application/json'
         request['Authorization'] = "Push #{token}"
         request['Content-Type'] = 'application/json; charset=UTF-8'
         request.body = JSON.dump(payload)
 
+        logger.debug "Sending #{request.method} to #{URI.join(endpoint, request.path)} with body #{request.body}"
+
         http.request(request)
       end
 

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

@@ -0,0 +1,23 @@
+module Userlist
+  class Push
+    module Strategies
+      class Direct
+        def initialize(config = {})
+          @config = Userlist.config.merge(config)
+        end
+
+        def call(*args)
+          client.public_send(*args)
+        end
+
+      private
+
+        attr_reader :config
+
+        def client
+          @client ||= Userlist::Push::Client.new(config)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Userlist
+  class Push
+    module Strategies
+      class Null
+        def initialize(*); end
+
+        def call(*); end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Userlist
+  class Push
+    module Strategies
+      class Threaded
+        class Worker
+          include Userlist::Logging
+
+          MAX_WORKER_TIMEOUT = 30
+
+          def initialize(queue, config = {})
+            @queue = queue
+            @config = Userlist.config.merge(config)
+            @thread = Thread.new { run }
+            @thread.abort_on_exception = true
+          end
+
+          def run
+            logger.info 'Starting worker thread...'
+
+            loop do
+              begin
+                method, url, payload = *queue.pop
+                break if method == :stop
+
+                client.public_send(method, url, payload)
+              rescue StandardError => exception
+                logger.error "Failed to deliver payload: [#{exception.class.name}] #{exception.message}"
+              end
+            end
+
+            logger.info "Worker thread exited with #{queue.size} tasks still in the queue..."
+          end
+
+          def stop
+            logger.info 'Stopping worker thread...'
+            queue.push([:stop])
+            thread.join(MAX_WORKER_TIMEOUT)
+          end
+
+        private
+
+          attr_reader :queue, :config, :thread
+
+          def client
+            @client ||= Userlist::Push::Client.new(config)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'userlist/push/strategies/threaded/worker'
+
+module Userlist
+  class Push
+    module Strategies
+      class Threaded
+        def initialize(config = {})
+          @queue = Queue.new
+          @worker = Worker.new(queue, config)
+
+          at_exit { stop_worker }
+        end
+
+        def call(*args)
+          queue.push(args)
+        end
+
+      private
+
+        attr_reader :queue, :worker
+
+        def stop_worker
+          worker && worker.stop
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies.rb

@@ -0,0 +1,17 @@
+require 'userlist/push/strategies/null'
+require 'userlist/push/strategies/direct'
+require 'userlist/push/strategies/threaded'
+
+module Userlist
+  class Push
+    module Strategies
+      def self.strategy_for(strategy, config = {})
+        strategy = Userlist::Push::Strategies.const_get(strategy.to_s.capitalize) if strategy.is_a?(Symbol) || strategy.is_a?(String)
+
+        strategy = strategy.new(config) if strategy.respond_to?(:new)
+
+        strategy
+      end
+    end
+  end
+end

data/lib/userlist/push.rb

@@ -1,6 +1,67 @@
 require 'userlist/push/client'
+require 'userlist/push/strategies'
 
 module Userlist
-  module Push
+  class Push
+    class << self
+      [:event, :track, :user, :identify, :company].each do |method|
+        define_method(method) { |*args| default_push_instance.send(method, *args) }
+      end
+
+    private
+
+      def default_push_instance
+        @default_push_instance ||= new
+      end
+    end
+
+    def initialize(config = {})
+      @config = Userlist.config.merge(config)
+      @mutex = Mutex.new
+    end
+
+    def event(payload = {})
+      with_mutex do
+        raise ArgumentError, 'Missing required payload hash' unless payload
+        raise ArgumentError, 'Missing required parameter :name' unless payload[:name]
+        raise ArgumentError, 'Missing required parameter :user' unless payload[:user]
+
+        payload[:occured_at] ||= Time.now
+
+        strategy.call(:post, '/events', payload)
+      end
+    end
+    alias track event
+
+    def user(payload = {})
+      with_mutex do
+        raise ArgumentError, 'Missing required payload hash' unless payload
+        raise ArgumentError, 'Missing required parameter :identifier' unless payload[:identifier]
+
+        strategy.call(:post, '/users', payload)
+      end
+    end
+    alias identify user
+
+    def company(payload = {})
+      with_mutex do
+        raise ArgumentError, 'Missing required payload hash' unless payload
+        raise ArgumentError, 'Missing required parameter :identifier' unless payload[:identifier]
+
+        strategy.call(:post, '/companies', payload)
+      end
+    end
+
+  private
+
+    attr_reader :config
+
+    def strategy
+      @strategy ||= Userlist::Push::Strategies.strategy_for(config.push_strategy, config)
+    end
+
+    def with_mutex(&block)
+      @mutex.synchronize(&block)
+    end
   end
 end

data/lib/userlist/version.rb

@@ -1,3 +1,3 @@
 module Userlist
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/userlist.rb

@@ -1,5 +1,8 @@
+require 'logger'
+
 require 'userlist/version'
 require 'userlist/config'
+require 'userlist/logging'
 require 'userlist/push'
 
 module Userlist
@@ -7,5 +10,20 @@ module Userlist
     def config
       @config ||= Userlist::Config.new
     end
+
+    def logger
+      @logger ||= begin
+        logger = Logger.new(STDOUT)
+        logger.progname = 'userlist'
+        logger.level = config.log_level
+        logger
+      end
+    end
+
+    def configure
+      yield config
+    end
+
+    attr_writer :logger
   end
 end

data/userlist.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'userlist/version'
 
@@ -20,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.1'
+
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,8 +87,14 @@ files:
 - bin/setup
 - lib/userlist.rb
 - lib/userlist/config.rb
+- lib/userlist/logging.rb
 - lib/userlist/push.rb
 - lib/userlist/push/client.rb
+- lib/userlist/push/strategies.rb
+- lib/userlist/push/strategies/direct.rb
+- lib/userlist/push/strategies/null.rb
+- lib/userlist/push/strategies/threaded.rb
+- lib/userlist/push/strategies/threaded/worker.rb
 - lib/userlist/version.rb
 - userlist.gemspec
 homepage: http://github.com/userlistio/userlist-ruby
@@ -103,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -111,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Userlist.io API