transaction 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a526c5d4b3f377cb0058172dba2ec28cfc4c992034f2e67d3d27e58363f1d3bc
-  data.tar.gz: 6930f32bea0063cbc6dcae24a78793a11fb74034cc6f292a6ea53b8724566b1d
+  metadata.gz: b67f5a6260713f92024cc80f578c76ae953116972133664e12716eb52ce2cc28
+  data.tar.gz: d2c60611c7a5ed2d4f9f3e7b5565bcb1582f27985f7fa6e669569ad3320f3be5
 SHA512:
-  metadata.gz: 45e2043fcb38a0379a6e3edebddaa162ebbb4d010936a22b32e70bc2c0cee889505f4cfb165a0bb03cca65c239af63bef7439154984afdee80a4c9cd5386bf6a
-  data.tar.gz: 833df05c837c87133e7a292cad3741f84a1cb8f01226715736e61ae73f404e6189daeb96ef7df729d9e601019fdd1a5e8d5ed41c4eb002426ed9f82a8d4c3c90
+  metadata.gz: ea91a9508404c5408e8896b4810bdd428e60e71a94eba03dc41aa2158fa0429ac9672ae35370af55d1a42d6e7f41319c6ff7d5969baa5d76ec3bb82565e38b6f
+  data.tar.gz: 4c1953a76f3c4895068a9126bd1f2f084769090c4bb5ba0b9f4f3d909f8e06477cbcbc0a1f90ab887287d7e770b03f0e99211f1e09891feba5e899a8e7f483d5

data/.gitignore

@@ -1,11 +1,24 @@
-/.bundle/
-/.yardoc
+# Ignore bundler config.
+/.bundle
+
+# Ignore Mac of tempfiles
+.DS_Store
+._.DS_Store
+
+# Ignore yard docs
+doc
+.yardoc/*
 /_yardoc/
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
-/tmp/
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.MD

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2019-09-11
+
+### Added
+  - Support for PubSub.
+  - Setter/getter for pubsub client.
+  - `trigger_event!` to push messages to pubsub client.
+  - Unit tests for pubsub integration.
+
+### Changed
+  - `finish!` params. (Takes status, clear and data)
+
 ## [0.1.7] - 2019-07-19
 
 ### Added

data/Gemfile

@@ -4,3 +4,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in transaction.gemspec
 gemspec
+
+group :development, :test do
+  gem 'pry'
+end
+
+group :test do
+  gem 'pusher', '1.3.2'
+end

data/Gemfile.lock

@@ -1,16 +1,28 @@
 PATH
   remote: .
   specs:
-    transaction (0.1.7)
+    transaction (1.0.0)
       redis (>= 4.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.2)
+    httpclient (2.8.3)
     json (2.2.0)
-    rake (12.3.2)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pusher (1.3.2)
+      httpclient (~> 2.7)
+      multi_json (~> 1.0)
+      pusher-signature (~> 0.1.8)
+    pusher-signature (0.1.8)
+    rake (12.3.3)
     redis (4.1.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -36,6 +48,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  pry
+  pusher (= 1.3.2)
   rake (~> 12.3)
   rspec (~> 3.0)
   simplecov

data/README.md

@@ -7,10 +7,18 @@
 
 # Transaction
 
-Transaction is a small library which helps track status of running/upcoming tasks. These tasks can be a cron job, background jobs or a simple method. Any task can be plugged into a transaction block. Transaction uses redis to store the current status along with the additional attributes(provided during the initialization or transaction updation.)
+Transaction is a small library which helps track the status of running/upcoming tasks. These tasks can be a cron job, background jobs or a simple method. Any task can be plugged into a transaction block.
 
-To experiment with that code, run `bin/console` for an interactive prompt.
+Transaction uses ***Redis*** to store the current status along with the additional attributes(provided during the initialization or transaction update.)
 
+The events within the transaction block can be published via ***Pubsub client(ex. Pusher, PubNub or any valid pubsub client)***. These events can be subscribed in the client app for the live status of the transaction.
+
+
+## Requirements
+
+Redis(>=3.0)
+
+Valid Pubsub client if messages need to be published.
 
 ## Installation
 
@@ -32,20 +40,43 @@ Or install it yourself as:
 
 ### Initializing Transaction gem -
 
-Connecting to redis via initializer (Rails app)
+In your rails app - create `config/transaction.rb`
 ```ruby
+
+  # Ex. pusher looks like | any pubsub client can be used.
+  require 'pusher'
+  PubsubClient = Pusher::Client.new(
+    app_id:"app_id",
+    key: "app_key",
+    secret: "app_secret",
+    cluster: "cluster_info",
+    use_tls: true
+  )
+
   Transaction.configure do |config|
-    config.redis = Redis.new(url: 'redis://redis_url:6379') # defaults to localhost
+    config.redis = Redis.new # defaults to localhost
+    config.pubsub_client = {client: PubsubClient, trigger: 'trigger'}
   end
 ```
 
-Connecting to redis directly
+There's an option to directly connect as well.
 ```ruby
   Transaction.redis = Redis.new(url: 'redis://redis_url:6379')
+  Transaction.pubsub_client = {client: PubsubClient, trigger: 'trigger'}
 ```
 
+The pubsub client accepts the following options -
+
+param | description
+|:-:|---
+client  | Any valid pubsub client. Ex. Pusher, PubNub.
+trigger | The method name which sends a message to a pubsub client. Ex. `'trigger'` for Pusher. `'publish'` for PubNub.
+channel_name | (Optional) Channel in which the message be published. Defaults to the value of `transaction_id`.
+event | (Optional) Event for which message will be published. Defaults to `'status'`
+
+
 ### Initializing a transaction
-A transaction can be newly initialized or be found with the given transaction_id. If no transaction is found then a new transaction in created.
+A transaction can be newly initialized or be found with the given transaction_id. If no transaction is found then a new transaction is created.
 ```ruby
   attributes = {created_at: Time.now, count: 0 }
   transaction = Transaction::Client.new(options: attributes) # creates a new instance of transaction
@@ -58,12 +89,13 @@ Accepted statuses: **['queued', 'processing', 'success', 'error']**. Any transac
 
 method | params | description
 |:-:|---|---
-start!  | - | moves to status `processing` from `queued`.
-finish! | (status='success', clear=false) | moves to the passed status (default: `success`). `clear = true` destroys the entry from redis cache.
-clear!  | - | destroys the current entry from redis cache.
-refresh! | - | sync current instance transaction with latest cache (Other instance of transaction initiated with same transaction id can update the attributes. Hence `refresh!` is required.).
-update_status | status | moves to the passed status. Raises `'Invalid Status'` error if status is not in one of the **Accepted statuses** defined above.
-update_attributes | options = {} | merges the passed options hash to the current attributes object. Raises `ArgumentError` if invalid type is passed in options.
+start!  | - | moves to status `processing` from `queued`. Publishes `{message: Processing}` to pubsub client if enabled.
+finish! | (status: 'success', clear: false, data: {}) | moves to the passed status (default: `success`). Any additional data passed is merged with default `{message: 'Done}'`. `clear = true` destroy the transaction entry from Redis cache.
+clear!  | - | destroys the current entry from Redis cache.
+refresh! | - | sync current instance transaction with the latest cache (Other instance of a transaction initiated with same transaction id can update the attributes. Hence `refresh!` is required.).
+update_status | status | moves to the passed status. Raises `'Invalid Status'` error if the status is not in one of the **Accepted statuses** defined above.
+update_attributes | options = {} | merges the passed options hash to the current attributes object.
+trigger_event! | data = {} | publishes the data via pubsub. Current `status` along with-param data is published(Note: Pubsub client needs to be configured.)
 
 
 ### Ex 1: Simple transaction
@@ -111,7 +143,7 @@ update_attributes | options = {} | merges the passed options hash to the current
 ```
 
 ### Keeping transactions in sync.
-Let's say we have 2 transactions `t1` and `t2` both initialized with same transaction id. If `t2` updates the transaction, then `t1` can simple refresh the transaction to get in sync with `t2`. Note: the transaction will be refreshed with the most recent values. (Versioning transaction updates ??? => Woah that's a nice PR idea.)
+Let's say we have 2 transactions `t1` and `t2` both initialized with the same transaction id. If `t2` updates the transaction, then `t1` can simply refresh the transaction to get in sync with `t2`. Note: the transaction will be refreshed with the most recent values. (Versioning transaction updates ??? => Woah that's a nice PR idea.)
 ```ruby
   def task1
     transaction = Transaction::Client.new
@@ -130,6 +162,26 @@ Let's say we have 2 transactions `t1` and `t2` both initialized with same transa
   end
 ```
 
+### Pushing messages to client via pubsub
+If a task is running in the background and the client needs to know the status. PubSub can be configured to do so.
+```ruby
+   # configure pubsub client as defined above in Initializing Transaction gem
+
+   def long_task
+    transaction = Transaction::Client.new
+    transaction.start!
+
+    items = (0..10_000).to_a
+
+    items.each do |index|
+      transaction.trigger_event!(count: index, total: items.count)
+      # do something
+    end
+
+    transaction.finish!(data: {count: items.count, total: items.count})
+   end
+```
+
 ## 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.
@@ -142,7 +194,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/t2013a
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 

data/lib/transaction.rb

@@ -4,6 +4,7 @@ require 'transaction/version'
 require 'securerandom'
 require 'redis'
 require 'json'
+require 'transaction/helper'
 
 module Transaction
   STATUSES = %i[queued processing success error].freeze
@@ -29,6 +30,24 @@ module Transaction
     @redis ||= Redis.new
   end
 
+  def self.pubsub_client=(client:, trigger:, channel_name: nil, event: 'status')
+    @client = client
+    @trigger = trigger
+    @event = event
+    @channel_name = channel_name
+  end
+
+  def self.pubsub_client
+    return if @client.nil? || @trigger.nil?
+
+    {
+      client: @client,
+      trigger: @trigger,
+      event: @event,
+      channel_name: @channel_name
+    }
+  end
+
   class Client
     attr_reader :transaction_id, :status, :attributes
 
@@ -36,6 +55,7 @@ module Transaction
       @transaction_id = transaction_id ||
                         "transact-#{SecureRandom.urlsafe_base64(16)}"
       @redis_client = Transaction.redis
+      @pubsub_client = Transaction.pubsub_client
 
       options = DEFAULT_ATTRIBUTES.merge(options)
 
@@ -64,11 +84,12 @@ module Transaction
 
     def start!
       update_status(:processing)
+      trigger_event!(message: 'Processing')
     end
 
-    def finish!(status = 'success', clear = false)
+    def finish!(status: 'success', clear: false, data: {})
       update_status(status)
-
+      trigger_event!({ message: 'Done' }.merge(data))
       redis_delete if clear
     end
 
@@ -84,6 +105,18 @@ module Transaction
       @status = @attributes[:status].to_s
     end
 
+    def trigger_event!(data = {})
+      return if @pubsub_client.nil?
+
+      data[:status] = @status
+      channel_name = @pubsub_client[:channel_name] || @transaction_id
+      client = @pubsub_client[:client]
+      trigger = @pubsub_client[:trigger]
+      event = @pubsub_client[:event]
+
+      client.send(trigger, channel_name, event, data)
+    end
+
     private
 
     def parsed_attributes
@@ -102,18 +135,6 @@ module Transaction
       response
     end
 
-    def symbolize_keys!(response = @attributes)
-      response.keys.each do |key|
-        response[(begin
-                    key.to_sym
-                  rescue StandardError
-                    key
-                  end) || key] = response.delete(key)
-      end
-
-      response
-    end
-
     # redis methods
     def redis_get
       @redis_client.get(@transaction_id)

data/lib/transaction/helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+def symbolize_keys!(response = {})
+  response.keys.each do |key|
+    response[(begin
+                key.to_sym
+              rescue StandardError
+                key
+              end) || key] = response.delete(key)
+  end
+
+  response
+end

data/lib/transaction/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Transaction
-  VERSION = '0.1.7'
+  VERSION = '1.0.0'
 end

data/transaction.gemspec

@@ -10,8 +10,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Anurag Tiwari']
   spec.email         = ['tiwari.anurag126@gmail.com']
 
-  spec.summary       = 'Record status along with other relevant information of transactions/tasks.'
-  spec.description   = 'Record status along with other relevant information of transactions/tasks.'
+  spec.summary       = 'Manage any task | transaction efficiently'
+  spec.description   = 'Record status along with other relevant information of
+  transactions or tasks. These tasks can be a cron job, large background jobs or
+  a simple method. Any task can be plugged into a transaction block. Transaction
+  uses Redis to store the current status along with other information.
+  The events within the transaction block can be published via Pubsub client
+  (ex. Pusher, PubNub or any valid pubsub client).These events can be
+  subscribed in the client app for the live status of the transaction.'
+
   spec.homepage      = 'https://github.com/t2013anurag/transaction'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transaction
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Anurag Tiwari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -80,7 +80,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Record status along with other relevant information of transactions/tasks.
+description: |-
+  Record status along with other relevant information of
+    transactions or tasks. These tasks can be a cron job, large background jobs or
+    a simple method. Any task can be plugged into a transaction block. Transaction
+    uses Redis to store the current status along with other information.
+    The events within the transaction block can be published via Pubsub client
+    (ex. Pusher, PubNub or any valid pubsub client).These events can be
+    subscribed in the client app for the live status of the transaction.
 email:
 - tiwari.anurag126@gmail.com
 executables: []
@@ -103,6 +110,7 @@ files:
 - bin/console
 - bin/setup
 - lib/transaction.rb
+- lib/transaction/helper.rb
 - lib/transaction/version.rb
 - transaction.gemspec
 homepage: https://github.com/t2013anurag/transaction
@@ -128,5 +136,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Record status along with other relevant information of transactions/tasks.
+summary: Manage any task | transaction efficiently
 test_files: []