request_response_stats 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d93ef2e0bb7c1e31551811923a3b6393721c46f
-  data.tar.gz: a411d96d3df46bbd8832332d23a8dc469371d65b
+  metadata.gz: 7ec5e280b0e51eea96f32ff6cc394465f2842e47
+  data.tar.gz: e7251233787d35459ca4ca406dbc27f025ce659f
 SHA512:
-  metadata.gz: d407ec5d98944bdc216d91bbb34e1bdf8af27eb56ead08a11f1e45253bb59415bc1b08f3e943c8ca5fff04eead3671dfa9ea968c81ba3bc60aa191508648cde4
-  data.tar.gz: 6723271a4816804f5d4d660a5492b57f3f1bde43e53835f15ef33623adc79af9f9b0292002836591dbdadb85b2176545bdcbfd22f47d0eb946851bca56edb109
+  metadata.gz: e10ffcbf9cd5a480b2d56c2ffa559bd77d901b918a1552137e41062ca90b80f4f5bb3079fb356d5e9e280beb5beee0d11108b1a035e8ca3a934ec61310e3810c
+  data.tar.gz: fda1bb50c99e615b02e3eff343bc66dc49f72affc44c1e53d39bfe0da50bdbbb7b02b47ab96d55098d9e50cb0262817b68acbae46662c97d97667874619d85c0

data/README.md

@@ -1,12 +1,8 @@
 # RequestResponseStats
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/request_response_stats`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add gem to your application's Gemfile:
 
 ```ruby
 gem 'request_response_stats'
@@ -14,15 +10,81 @@ gem 'request_response_stats'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle install
+```
+
+Or install it separately as:
 
-Or install it yourself as:
+```bash
+$ gem install request_response_stats
+```
+
+Add following to the controller whose request response stats are to be captured. For example,
 
-    $ gem install request_response_stats
+```ruby
+class ApplicationController < ActionController::Base
+  include RequestResponseStats::ControllerConcern
+  # rest of the code
+end
+```
+
+Right now there are some manual tasks:
+
+- Copy file `lib/req_res_stat_controller.rb` from gem to `app/controllers/req_res_stat_controller.rb` within Rails app.
+- Copy file `lib/request_response_stats_config.rb` from gem to `config/initializers/request_response_stat_config.rb` within Rails app
+- Copy file `lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake` from gem to `lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake` within Rails app.
+
+TODO: Write rake task for this.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Documentation References
+
+http://www.rubydoc.info/gems/request_response_stats/
+
+You can get better documentation by running tests.
+
+TODO: Include examples for below commands.
+
+### Checking current data in redis
+
+```ruby
+# include RequestResponseStats
+rrs = RequestResponse.new(nil, nil)
+rrs.redis_record.hashify_all_data.size
+rrs.redis_record.hashify_all_data
+```
+
+### Manually moving data from Redis to Mongo
+
+```ruby
+rrs.move_data_from_redis_to_mongo 
+```
+Note: To automate use: lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake
+
+### Deleting data from Redis and Mongo
+
+```ruby
+rrs.redis_record.all_keys.each{|k| rrs.redis_record.del k}
+ReqResStat.all.delete_all
+```
+
+### Getting stats from Mongo
+
+```ruby
+ReqResStat.all.size
+ReqResStat.all.first
+t = Time.now
+ReqResStat.get_max(:max_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
+ReqResStat.get_avg(:avg_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
+ReqResStat.get_max(:min_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
+ReqResStat.get_details(:max_time, t - 2.day, t, nil, 6.hours)
+ReqResStat.get_details(:max_time, t - 2.day, t, :max, 6.hours)
+ReqResStat.get_details(:max_time, t - 2.day, t, :min, 6.hours)
+ReqResStat.get_details(:max_time, t - 2.day, t, :sum, 6.hours)
+ReqResStat.get_details(:max_time, t - 2.day, t, :avg, 6.hours)
+```
 
 ## Development
 
@@ -32,7 +94,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/request_response_stats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/goyalmunish/request_response_stats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +102,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the RequestResponseStats project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/request_response_stats/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RequestResponseStats project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/goyalmunish/request_response_stats/blob/master/CODE_OF_CONDUCT.md).

data/lib/request_response_stats.rb

@@ -21,42 +21,3 @@ module RequestResponseStats
     end
   end
 end
-
-# TODO: The following files should not be required like this, instead they should be extracted into correct
-# place in Rails project using `rake` command
-# require_relative 'req_res_stat_controller'
-# require_relative 'request_response_stats_config'
-
-##### Examples: #####
-
-## Checking current redis data:
-=begin
- # require 'request_response_stats'
- include RequestResponseStats
- rrs = RequestResponse.new(nil, nil)
- ap rrs.redis_record.hashify_all_data
- ap rrs.redis_record.hashify_all_data.size
-=end
-
-## Manually moving data from Redis to Mongo:
-# ap rrs.move_data_from_redis_to_mongo
-
-## Deleting data from Redis and Mongo:
-# rrs.redis_record.all_keys.each{|k| rrs.redis_record.del k}
-# ReqResStat.all.delete_all
-
-## Getting stats from Mongo:
-=begin
- ap ReqResStat.all.size
- ap ReqResStat.all.first
- t = Time.now
- ReqResStat.get_max(:max_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
- ReqResStat.get_avg(:avg_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
- ReqResStat.get_max(:min_time, t - 2.day, t, 6.hours).map{|r| r[:data]}
- ap ReqResStat.get_details(:max_time, t - 2.day, t, nil, 6.hours)
- ap ReqResStat.get_details(:max_time, t - 2.day, t, :max, 6.hours)
- ap ReqResStat.get_details(:max_time, t - 2.day, t, :min, 6.hours)
- ap ReqResStat.get_details(:max_time, t - 2.day, t, :sum, 6.hours)
- ap ReqResStat.get_details(:max_time, t - 2.day, t, :avg, 6.hours)
-=end
-

data/lib/request_response_stats/version.rb

@@ -1,5 +1,5 @@
 # File: lib/request_response_stats/version.rb
 
 module RequestResponseStats
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_response_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Munish Goyal