transaction 0.1.6.beta → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e3a97b6b934b5b7677f0fa30f41fed6b04f4e4f0d81097fd2661be8fba4c308
-  data.tar.gz: fce86fde3e3927644cb28758c51e544b34b7c29b8916d40133a23854d5a50cd5
+  metadata.gz: a526c5d4b3f377cb0058172dba2ec28cfc4c992034f2e67d3d27e58363f1d3bc
+  data.tar.gz: 6930f32bea0063cbc6dcae24a78793a11fb74034cc6f292a6ea53b8724566b1d
 SHA512:
-  metadata.gz: b0e609d2c58f1d8ec03fe5941a8928e5d1e27460be6f3d8b5268f01c3c8c36b26f3c62e2350d02b74d6dc83d1063a2ca67df93a3edf205231cea1fbb9b885a29
-  data.tar.gz: 8a9ca121c4c728eb1937020a587012b08354793f1b06db12d188876d937a22582ae744a30183e93cc39ca3090fe8633e400c702c508e1c53d01ddab8a259941f
+  metadata.gz: 45e2043fcb38a0379a6e3edebddaa162ebbb4d010936a22b32e70bc2c0cee889505f4cfb165a0bb03cca65c239af63bef7439154984afdee80a4c9cd5386bf6a
+  data.tar.gz: 833df05c837c87133e7a292cad3741f84a1cb8f01226715736e61ae73f404e6189daeb96ef7df729d9e601019fdd1a5e8d5ed41c4eb002426ed9f82a8d4c3c90

data/CHANGELOG.MD

@@ -4,7 +4,20 @@ 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-19
+## [0.1.7] - 2019-07-19
+
+### Added
+  - Setter/getter for redis client.
+  - documentation for configuring redis.
+
+### Changed
+  - allow fallback to local redis if no configuration provided.
+
+### Removed
+  - configuration yeilder class.
+
+
+## [0.1.6.beta] - 2019-07-19
 
 ### Added
   - specs for update_attributes

data/Gemfile.lock

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

data/README.md

@@ -30,6 +30,20 @@ Or install it yourself as:
 
 ## Usage
 
+### Initializing Transaction gem -
+
+Connecting to redis via initializer (Rails app)
+```ruby
+  Transaction.configure do |config|
+    config.redis = Redis.new(url: 'redis://redis_url:6379') # defaults to localhost
+  end
+```
+
+Connecting to redis directly
+```ruby
+  Transaction.redis = Redis.new(url: 'redis://redis_url:6379')
+```
+
 ### 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
@@ -103,7 +117,6 @@ Let's say we have 2 transactions `t1` and `t2` both initialized with same transa
     transaction = Transaction::Client.new
     transaction.start!
     task2(transaction.transaction_id)
-    sleep(5) # just letting task 2 finish.
 
     puts transaction.status # 'processing'
     transaction.refresh!

data/lib/transaction/version.rb

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

data/lib/transaction.rb

@@ -6,10 +6,6 @@ require 'redis'
 require 'json'
 
 module Transaction
-  class << self
-    attr_accessor :configuration
-  end
-
   STATUSES = %i[queued processing success error].freeze
 
   DEFAULT_ATTRIBUTES = {
@@ -17,16 +13,20 @@ module Transaction
   }.freeze
 
   def self.configure
-    self.configuration ||= Configuration.new
-    yield(configuration)
+    yield self
   end
 
-  class Configuration
-    attr_accessor :redis_client
+  def self.redis=(hash = {})
+    @redis = if hash.instance_of?(Redis)
+               hash
+             else
+               Redis.new(hash)
+             end
+  end
 
-    def initialize
-      @redis_client = Redis.new
-    end
+  def self.redis
+    # use default redis if not set
+    @redis ||= Redis.new
   end
 
   class Client
@@ -35,7 +35,7 @@ module Transaction
     def initialize(transaction_id: nil, options: {})
       @transaction_id = transaction_id ||
                         "transact-#{SecureRandom.urlsafe_base64(16)}"
-      @config = Configuration.new
+      @redis_client = Transaction.redis
 
       options = DEFAULT_ATTRIBUTES.merge(options)
 
@@ -116,15 +116,15 @@ module Transaction
 
     # redis methods
     def redis_get
-      @config.redis_client.get(@transaction_id)
+      @redis_client.get(@transaction_id)
     end
 
     def redis_set(key, value)
-      @config.redis_client.set(key, value)
+      @redis_client.set(key, value)
     end
 
     def redis_delete
-      @config.redis_client.del(@transaction_id)
+      @redis_client.del(@transaction_id)
     end
   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       = '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.summary       = 'Record status along with other relevant information of transactions/tasks.'
+  spec.description   = 'Record status along with other relevant information of transactions/tasks.'
   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.6.beta
+  version: 0.1.7
 platform: ruby
 authors:
 - Anurag Tiwari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2019-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -80,12 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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.
+description: Record status along with other relevant information of transactions/tasks.
 email:
 - tiwari.anurag126@gmail.com
 executables: []
@@ -125,14 +120,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Manage transaction lifecycle - save/update status and information about the
-  transaction.
+summary: Record status along with other relevant information of transactions/tasks.
 test_files: []