transaction 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4675dda1fefb98498db0d38281ab7a1507266cb0143007152fe38c2855c7d5b
-  data.tar.gz: d92d587dfb5916d70a0f23d464201f1171dc70fb26bdc7abad3cf1fb9d6a6a53
+  metadata.gz: 4b71218d59c5b76ff4673eeca6a60a22089ecf528f95eb9d659ad6e5abc657a1
+  data.tar.gz: 8746fa1b44166fc7e32293025a49b368935a20ca8b5d9bc95ede47e28bb29dda
 SHA512:
-  metadata.gz: 33227c6f7ccc54c6e4fc83067246b3c73b66ecc8d339b1ab43325e1ed4e710136478a1d61dc0ebef0143c91bcfc4fe5172736153091246f2e366d855a0a96f0d
-  data.tar.gz: 445d685de0a0addbf28a2df35ef225ad8ed3b2c29d2296c37edee5ca3145417b9efb762a88b908c5cca8d215dfb83c60437e71001037d723527ba1a9b20290db
+  metadata.gz: 6f063c2251390d281fa403e59f286458c8384e91ebf5a6ec9f05b191f3e543d8e3aa45be97f746ec7cd351bc1d2401380394a2d24fe456cda0f8d2016abb5de0
+  data.tar.gz: c47ede5976c6586746364bb48c9417d3100210fe7995a994ff8edc8bc37a20e660f13118f226fa0636f0d230ebdbf03cc67e6da8b9657909eb546cd212332c2d

data/.rubocop.yml

@@ -1 +1,5 @@
 inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisabledByDefault: false
+  TargetRubyVersion: 2.4.0

data/CHANGELOG.MD

@@ -4,7 +4,15 @@ 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).
 
-## [0.1.4] - 2019-07-19
+## [0.1.5] - 2019-07-18
+
+### Added
+  - Readme examples
+
+### Changed
+  - Transaction finished with default status `success`
+
+## [0.1.4] - 2019-07-18
 
 ### Added
   - Support for ruby >= 2.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in transaction.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transaction (0.1.4)
+    transaction (0.1.5)
       redis (>= 4.0.2)
 
 GEM

data/README.md

@@ -7,7 +7,8 @@
 
 # Transaction
 
-Transaction is a small library to help you out with tracking the progress of your long running tasks.
+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.)
+
 To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem
@@ -30,7 +31,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Ex 1: Simple transaction
+```ruby
+    def sum_numbers
+      arr = (0...10_000).to_a
+      options = { created_at: Time.now, total: arr.count  }
+      transaction = Transaction::Client.new(options: options)
+
+      transaction.start!
+      puts transaction.status # Status moves from `queued` to `processing`
+
+      count = 0
+      (1..10_000).each do |i|
+        # do some other stuff
+        transaction.update_attributes(count: count += 1)
+        # do some other stuff
+      end
+
+      transaction.finish! # By default moves to status 'success'.
+
+      puts transaction.status # 'success'
+      puts transaction.attributes # {:status=>:success, :created_at=>2019-07-19 06:06:43 +0530, :total=>10000, :count=>10000}
+    end
+```
+
+### Ex 2: Initialize or find a transaction with a transaction id.
+```ruby
+    def task1
+      transaction = Transaction::Client.new
+      SomeWorkerJob.perform_later(transaction.transaction_id) # sidekiq or resque
+    end
+
+    class SomeWorkerJob < ApplicationJob
+      queue_as :default
+
+      def perform transaction_id
+        tr = Transaction::Client.new(transaction_id: transaction_id) # intialize with given transaction_id
+        tr.start!
+
+        # do a bunch of stuff
+        tr.finish!
+      end
+    end
+```
+
+### 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.)
+```ruby
+  def task1
+    transaction = Transaction::Client.new
+    transaction.start!
+    task2(transaction.transaction_id)
+    sleep(5) # just letting task 2 finish.
+
+    puts transaction.status # 'processing'
+    transaction.refresh!
+    puts transaction.status # 'error'
+  end
+
+  def task2 transaction_id # in some other context altogether. Task 2 is not at all related to task 1.
+    transaction = Transaction::Client.new(transaction_id: transaction_id)
+    # do some stuff
+    transaction.finish!('error')
+  end
+```
 
 ## Development
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'transaction'

data/lib/transaction/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transaction
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'
 end

data/lib/transaction.rb

@@ -60,7 +60,7 @@ module Transaction
       update_status(:processing)
     end
 
-    def finish!(status, clear = false)
+    def finish!(status = 'success', clear = false)
       update_status(status)
 
       redis_delete if clear

data/transaction.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'transaction/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transaction
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Anurag Tiwari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis