transaction 0.1.5 → 0.1.6.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b71218d59c5b76ff4673eeca6a60a22089ecf528f95eb9d659ad6e5abc657a1
-  data.tar.gz: 8746fa1b44166fc7e32293025a49b368935a20ca8b5d9bc95ede47e28bb29dda
+  metadata.gz: 7e3a97b6b934b5b7677f0fa30f41fed6b04f4e4f0d81097fd2661be8fba4c308
+  data.tar.gz: fce86fde3e3927644cb28758c51e544b34b7c29b8916d40133a23854d5a50cd5
 SHA512:
-  metadata.gz: 6f063c2251390d281fa403e59f286458c8384e91ebf5a6ec9f05b191f3e543d8e3aa45be97f746ec7cd351bc1d2401380394a2d24fe456cda0f8d2016abb5de0
-  data.tar.gz: c47ede5976c6586746364bb48c9417d3100210fe7995a994ff8edc8bc37a20e660f13118f226fa0636f0d230ebdbf03cc67e6da8b9657909eb546cd212332c2d
+  metadata.gz: b0e609d2c58f1d8ec03fe5941a8928e5d1e27460be6f3d8b5268f01c3c8c36b26f3c62e2350d02b74d6dc83d1063a2ca67df93a3edf205231cea1fbb9b885a29
+  data.tar.gz: 8a9ca121c4c728eb1937020a587012b08354793f1b06db12d188876d937a22582ae744a30183e93cc39ca3090fe8633e400c702c508e1c53d01ddab8a259941f

data/CHANGELOG.MD

@@ -4,7 +4,18 @@ 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.5] - 2019-07-18
+## [0.1.5] - 2019-07-19
+
+### Added
+  - specs for update_attributes
+
+### Changed
+  - Raise ArgumentError if invalid attributes are passed in `update_attributes`
+  - Raise StandardError if transaction has expired.
+  - specs for `refresh!`
+
+
+## [0.1.5] - 2019-07-19
 
 ### Added
   - Readme examples

data/Gemfile.lock

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

data/README.md

@@ -11,7 +11,6 @@ Transaction is a small library which helps track status of running/upcoming task
 
 To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -31,6 +30,28 @@ Or install it yourself as:
 
 ## Usage
 
+### 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.
+```ruby
+  attributes = {created_at: Time.now, count: 0 }
+  transaction = Transaction::Client.new(options: attributes) # creates a new instance of transaction
+  transaction1 = Transaction::Client.new(transaction_id: transaction.transaction_id) # finds the transaction.
+```
+
+### Accepted methods for a transaction
+The default status of any new transaction is **`queued`**.
+Accepted statuses: **['queued', 'processing', 'success', 'error']**. Any transaction at any point will be in one of the states.
+
+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.
+
+
 ### Ex 1: Simple transaction
 ```ruby
     def sum_numbers

data/lib/transaction/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Transaction
-  VERSION = '0.1.5'
+  VERSION = '0.1.6.beta'
 end

data/lib/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transaction/version'
 require 'securerandom'
 require 'redis'
@@ -44,6 +46,10 @@ module Transaction
     end
 
     def update_attributes(options)
+      unless options.is_a? Hash
+        raise ArgumentError, 'Invalid type. Expected Hash'
+      end
+
       @attributes = symbolize_keys!(@attributes.merge!(options))
       redis_set(@transaction_id, @attributes.to_json)
       @status = @attributes[:status].to_s
@@ -73,7 +79,7 @@ module Transaction
 
     def refresh!
       @attributes = parsed_attributes
-      raise 'Transaction expired' if @attributes.nil?
+      raise StandardError, 'Transaction expired' if @attributes.nil?
 
       @status = @attributes[:status].to_s
     end

data/transaction.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Anurag Tiwari']
   spec.email         = ['tiwari.anurag126@gmail.com']
 
-  spec.summary       = 'Record status of long running transactions.'
-  spec.description   = 'Record status of long running transactions.'
+  spec.summary       = 'Manage transaction lifecycle - save/update status and information about the transaction.'
+  spec.description   = 'A transaction can be a simple method or a long background process. Managing transactions is difficult especially when information about the transaction is of importance. This library helps you manage information relevant to the transaction. Current status and additional info about the task is stored is stored in redis datastore. This information can be retrieved at any point of time until the transaction is expired.'
   spec.homepage      = 'https://github.com/t2013anurag/transaction'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transaction
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6.beta
 platform: ruby
 authors:
 - Anurag Tiwari
@@ -80,7 +80,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Record status of long running transactions.
+description: A transaction can be a simple method or a long background process. Managing
+  transactions is difficult especially when information about the transaction is of
+  importance. This library helps you manage information relevant to the transaction.
+  Current status and additional info about the task is stored is stored in redis datastore.
+  This information can be retrieved at any point of time until the transaction is
+  expired.
 email:
 - tiwari.anurag126@gmail.com
 executables: []
@@ -120,13 +125,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Record status of long running transactions.
+summary: Manage transaction lifecycle - save/update status and information about the
+  transaction.
 test_files: []