action_tracker_client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6552efeec467f77ebcdd5e12f42ea71f604549501d28197693931c7952ab1f5
-  data.tar.gz: 9d59e3d822664351982c2edf20745577cf37442907ce3d0a213815c128f1ce53
+  metadata.gz: faa74a2a231928f025207b06a3f36b057588909ef546807506488f454b3f3865
+  data.tar.gz: 6e5a9554b441d87a7e746eded4d6028fdedf7e370dcc4cda4b675e3de675896e
 SHA512:
-  metadata.gz: 76f7c8f9293b8fe68d012f1a02314f7f3db256f2f8f36b16a48566a8928f6c27df1ec1531dbfc0e34319b3885859ebaa8466d6034590a315fc028c2f58d2de76
-  data.tar.gz: 9aaa18d8ef6fba934d1a3926ca3ccf9556db103430124015fd1e35ff1495e2430f364a9caf4d57a7299643a272677ef24daa496bc0df00231a11845389ae518e
+  metadata.gz: 4330a2055a63d1df6225510ec32105db12ef290144299272a41a34a0c390ec420ee206eacafdbe01598d54a770685478991bf58ac84650038d03ef4901dee2a3
+  data.tar.gz: 8244c43631586b63a06ccea9c469e372ff43c23fd1e6e30fc25f3279284436a857ba5ae693cd1696f0cbb28a496b850efe4e868c01e90791906c6f6ac05d9dfa

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    action_tracker_client (0.0.1)
+    action_tracker_client (0.1.0)
       activemodel (>= 4.0)
       activesupport (>= 4.0)
       api_signature (~> 0.1.5)
       httparty (~> 0.17.0)
-      model_auditor (~> 0.0.1)
+      model_auditor (~> 0.0.2)
       virtus (~> 1.0, >= 1.0.5)
 
 GEM
@@ -72,7 +72,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0331)
     minitest (5.11.3)
-    model_auditor (0.0.1)
+    model_auditor (0.0.2)
     multi_xml (0.6.0)
     nenv (0.3.0)
     notiffany (0.1.1)

data/README.md

@@ -2,8 +2,7 @@
 
 [![Build Status](https://semaphoreci.com/api/v1/ipm/action_tracker/branches/master/badge.svg)](https://semaphoreci.com/ipm/action_tracker)
 [![Maintainability](https://api.codeclimate.com/v1/badges/cfdcabfc3610c6eac895/maintainability)](https://codeclimate.com/github/psyipm/action_tracker/maintainability)
-[![Gem Version](https://badge.fury.io/rb/action_tracker.svg)](https://badge.fury.io/rb/action_tracker)
-
+[![Gem Version](https://badge.fury.io/rb/action_tracker_client.svg)](https://badge.fury.io/rb/action_tracker_client)
 
 ## Installation
 
@@ -34,6 +33,15 @@ ActionTracker.configure do |config|
   config.api_url = ENV['ACTION_TRACKING_API_URL']
   config.api_key = ENV['ACTION_TRACKING_API_KEY']
   config.api_secret = ENV['ACTION_TRACKING_API_SECRET']
+
+  # Avalilable options:
+  #
+  #   :inline (default) -> performs request to external API
+  #   :test             -> stores request parameters, can be accessed via ActionTracker.records
+  #   :custom           -> calls custom labda
+  #
+  config.tracking_method = :custom
+  config.custom_worker_proc = ->(form) { MyCustomActionTrackingJob.perform_later(form.attributes) }
 end
 ```
 
@@ -144,6 +152,46 @@ ActionTracker::Recorder.new(:state_change).call(target)
 ActionTracker::Recorder.new('Orders::SomeCustomEvent').call(target)
 ```
 
+## Testing
+
+Set tracking method to `:test` in application environment config and clear records after each spec
+
+```ruby
+  # config/environments/test.rb
+
+  config.after_initialize do
+    ActionTracker.config.tracking_method = :test
+  end
+
+  # spec/rails_helper.rb
+
+  config.after(:each) do
+    ActionTracker.clear_records
+  end
+```
+
+```ruby
+  ActionTracker.records
+
+  => [{:target_id=>76, :target_type=>"Order", :payload=>{:event=>"Created payment #89", :content=>"amount 100.0", :user=>{:id=>0, :name=>"Anonymous", :type=>"System"}}, :reference_id=>89, :reference_type=>"PaymentTransaction"}]
+
+  ActionTracker.last_event
+
+  => "Created payment #89"
+
+  ActionTracker.records.select_by('payload.user.name', 'Anonymous')
+
+  => [{:target_id=>76, :target_type=>"Order".....
+
+  ActionTracker.records.last_content
+
+  => "amount 100.0"
+
+  ActionTracker.records.select_by('payload.user.name', 'SomeUser')
+
+  => []
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/action_tracker.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.0'
   spec.add_dependency 'api_signature', '~> 0.1.5'
   spec.add_dependency 'httparty', '~> 0.17.0'
-  spec.add_dependency 'model_auditor', '~> 0.0.1'
+  spec.add_dependency 'model_auditor', '~> 0.0.2'
 
   spec.add_dependency 'virtus', '~> 1.0', '>= 1.0.5'
 end

data/lib/action_tracker/config.rb

@@ -2,9 +2,14 @@
 
 module ActionTracker
   class ClientNotConfiguredError < StandardError; end
+  class InvalidTrackingMethodError < StandardError; end
 
   class Config
-    attr_writer :api_url, :api_key, :api_secret
+    VALID_TRACKING_METHODS = [
+      :inline, :custom, :test
+    ].freeze
+
+    attr_writer :api_url, :api_key, :api_secret, :custom_worker_proc
 
     def api_url
       @api_url || raise(ActionTracker::ClientNotConfiguredError, missing_value: :api_url)
@@ -17,5 +22,19 @@ module ActionTracker
     def api_secret
       @api_secret || raise(ActionTracker::ClientNotConfiguredError, missing_value: :api_secret)
     end
+
+    def tracking_method
+      @tracking_method ||= :inline
+    end
+
+    def tracking_method=(value)
+      raise(InvalidTrackingMethodError, value) unless VALID_TRACKING_METHODS.include?(value)
+
+      @tracking_method = value
+    end
+
+    def custom_worker_proc
+      @custom_worker_proc ||= ->(form) { ActionTracker::Workers::Inline.new(form).perform }
+    end
   end
 end

data/lib/action_tracker/models/application_record.rb

@@ -37,6 +37,10 @@ module ActionTracker
       def to_key
         [id]
       end
+
+      def present_attributes
+        attributes.reject { |_key, value| value.blank? }
+      end
     end
   end
 end

data/lib/action_tracker/models/payload.rb

@@ -21,6 +21,10 @@ module ActionTracker
         self
       end
 
+      def user
+        super || ActionTracker::Models::User.default_user
+      end
+
       def for_event(event)
         self[:event] = event.to_s.humanize
         self
@@ -30,6 +34,10 @@ module ActionTracker
         self[:content] = content.to_s.truncate(MAX_CONTENT_LENGTH)
         self
       end
+
+      def attributes
+        super.merge(user: user.attributes)
+      end
     end
   end
 end

data/lib/action_tracker/models/transition_record.rb

@@ -9,18 +9,27 @@ module ActionTracker
       attribute :target_type, String
       attribute :created_at, DateTime
       attribute :payload, ActionTracker::Models::Payload
+      attribute :reference_id, Integer
+      attribute :reference_type, String
 
       delegate :event, :content, :user, to: :payload
 
       validate :check_payload
 
       def with_target(target)
-        self.target_id = target.id
-        self.target_type = target.class.name
+        self.target_id = target.try(:id)
+        self.target_type = target.try(:type) || target.class.name
 
         self
       end
 
+      def reference=(item)
+        return unless item
+
+        self[:reference_id] = item.try(:id)
+        self[:reference_type] = item.try(:type) || item.class.name
+      end
+
       def index(params = {})
         path = [collection_path, params.to_query].reject(&:blank?).compact.join('?')
         @response ||= Connection.new.get(path)

data/lib/action_tracker/recorder.rb

@@ -2,6 +2,7 @@
 
 module ActionTracker
   class UndefinedTemplateError < StandardError; end
+  class EmptyTargetError < StandardError; end
 
   # Usage:
   #   ActionTracker::Recorder.new(:create).call(order)
@@ -21,8 +22,9 @@ module ActionTracker
     def call(target)
       form = template_klass.new(target, options).form
       return unless form.valid?
+      raise EmptyTargetError, inspect unless target
 
-      @response = connection.post form.collection_path, body: form.attributes
+      @response = ActionTracker::Workers::Factory.new(form).instance.perform
       @response.to_h
     end
 
@@ -38,9 +40,5 @@ module ActionTracker
 
       klass
     end
-
-    def connection
-      @connection ||= ActionTracker::Connection.new
-    end
   end
 end

data/lib/action_tracker/templates/base_template.rb

@@ -11,7 +11,10 @@ module ActionTracker
       end
 
       def form
-        @form ||= ActionTracker::Models::TransitionRecord.new(payload: payload).with_target(target)
+        @form ||= ActionTracker::Models::TransitionRecord.new(
+          payload: payload,
+          reference: reference
+        ).with_target(target)
       end
 
       protected
@@ -22,7 +25,11 @@ module ActionTracker
 
       def build_payload
         payload_instance = ActionTracker::Models::Payload.new
-        payload_instance.with_user(user).with_content(content).for_event(event_title)
+
+        payload_instance
+          .with_user(user)
+          .with_content(content)
+          .for_event(event_title)
       end
 
       def user

data/lib/action_tracker/utils/records_collection.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActionTracker
+  class RecordsCollection < Array
+    def select_by(path, value)
+      keys = path.to_s.split('.').map(&:to_sym)
+
+      items = select do |item|
+        item.dig(*keys) == value
+      end
+
+      self.class.new items
+    end
+
+    def last_event
+      last.dig(:payload, :event)
+    end
+
+    def last_content
+      last.dig(:payload, :content)
+    end
+  end
+end

data/lib/action_tracker/version.rb

@@ -1,3 +1,3 @@
 module ActionTracker
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/action_tracker/workers/custom.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActionTracker
+  module Workers
+    class Custom
+      attr_reader :form
+
+      def initialize(form)
+        @form = form
+      end
+
+      def perform
+        custom_worker_proc.call(form)
+      end
+
+      private
+
+      def custom_worker_proc
+        ActionTracker.config.custom_worker_proc
+      end
+    end
+  end
+end

data/lib/action_tracker/workers/factory.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActionTracker
+  module Workers
+    class UndefinedWorkerError < StandardError; end
+
+    class Factory
+      attr_reader :form
+
+      def initialize(form)
+        @form = form
+      end
+
+      def instance
+        raise UndefinedWorkerError, tracking_method unless worker_klass
+
+        worker_klass.new(form)
+      end
+
+      private
+
+      def worker_klass
+        @worker_klass ||= "ActionTracker::Workers::#{tracking_method.classify}".safe_constantize
+      end
+
+      def tracking_method
+        ActionTracker.config.tracking_method.to_s
+      end
+    end
+  end
+end

data/lib/action_tracker/workers/inline.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActionTracker
+  module Workers
+    class Inline
+      attr_reader :form
+
+      def initialize(form)
+        @form = form
+      end
+
+      def perform
+        connection.post form.collection_path, body: form.present_attributes
+      end
+
+      private
+
+      def connection
+        @connection ||= ActionTracker::Connection.new
+      end
+    end
+  end
+end

data/lib/action_tracker/workers/test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActionTracker
+  module Workers
+    class Test
+      attr_reader :form
+
+      def initialize(form)
+        @form = form
+      end
+
+      def perform
+        ActionTracker.records.append(params)
+
+        params
+      end
+
+      private
+
+      def params
+        form.present_attributes
+      end
+    end
+  end
+end

data/lib/action_tracker.rb

@@ -8,11 +8,12 @@ require 'active_support/core_ext/object'
 
 module ActionTracker
   autoload :Config, 'action_tracker/config'
-  autoload :SignedRequest, 'action_tracker/signed_request'
-  autoload :Connection, 'action_tracker/connection'
 
-  autoload :Pagination, 'action_tracker/pagination'
-  autoload :CollectionProxy, 'action_tracker/collection_proxy'
+  autoload :CollectionProxy, 'action_tracker/utils/collection_proxy'
+  autoload :Connection, 'action_tracker/utils/connection'
+  autoload :Pagination, 'action_tracker/utils/pagination'
+  autoload :RecordsCollection, 'action_tracker/utils/records_collection'
+  autoload :SignedRequest, 'action_tracker/utils/signed_request'
 
   autoload :Recorder, 'action_tracker/recorder'
 
@@ -30,6 +31,13 @@ module ActionTracker
     autoload :Destroy, 'action_tracker/templates/destroy'
   end
 
+  module Workers
+    autoload :Factory, 'action_tracker/workers/factory'
+    autoload :Inline, 'action_tracker/workers/inline'
+    autoload :Custom, 'action_tracker/workers/custom'
+    autoload :Test, 'action_tracker/workers/test'
+  end
+
   def self.config
     @config ||= Config.new
   end
@@ -37,4 +45,16 @@ module ActionTracker
   def self.configure
     yield(config)
   end
+
+  def self.last_event
+    records.last_event
+  end
+
+  def self.records
+    @records || clear_records
+  end
+
+  def self.clear_records
+    @records = ActionTracker::RecordsCollection.new
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_tracker_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Igor Malinovskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,14 +168,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -218,21 +218,26 @@ files:
 - bin/console
 - bin/setup
 - lib/action_tracker.rb
-- lib/action_tracker/collection_proxy.rb
 - lib/action_tracker/config.rb
-- lib/action_tracker/connection.rb
 - lib/action_tracker/models/application_record.rb
 - lib/action_tracker/models/payload.rb
 - lib/action_tracker/models/transition_record.rb
 - lib/action_tracker/models/user.rb
-- lib/action_tracker/pagination.rb
 - lib/action_tracker/recorder.rb
-- lib/action_tracker/signed_request.rb
 - lib/action_tracker/templates/base_template.rb
 - lib/action_tracker/templates/create.rb
 - lib/action_tracker/templates/destroy.rb
 - lib/action_tracker/templates/update.rb
+- lib/action_tracker/utils/collection_proxy.rb
+- lib/action_tracker/utils/connection.rb
+- lib/action_tracker/utils/pagination.rb
+- lib/action_tracker/utils/records_collection.rb
+- lib/action_tracker/utils/signed_request.rb
 - lib/action_tracker/version.rb
+- lib/action_tracker/workers/custom.rb
+- lib/action_tracker/workers/factory.rb
+- lib/action_tracker/workers/inline.rb
+- lib/action_tracker/workers/test.rb
 homepage: https://github.com/psyipm/action_tracker
 licenses:
 - MIT