request_repeater 0.1.0.1 → 0.1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68a959ff4dd248589c04be2298424b8b970de9d7
-  data.tar.gz: a8ceba00f49e35ab310f2c811cab65a1ed826e2c
+  metadata.gz: f8ea5315f4de43f2af15ac16f4fd2969b72a45c6
+  data.tar.gz: 5ba44c94b23a93438208fa1a8bfcda2f3187699c
 SHA512:
-  metadata.gz: d4f4527470aaa8167ffffcfcd58e7b791b3c738723574c03fb8f1bc3adb2ce0225d5c929c6cc9eef1d7415ec9887a8d7673df5fbd18288a0d489de76499d76a2
-  data.tar.gz: 22d4707c438acd36627c521bdf5ba515c78f0b9e8a24ca8c9bad371717c67b04eed8b1646e2c475ed0d050e3fac0bec773fb5a8b07bb47e95deddc313fce1cad
+  metadata.gz: 6edfdd4ba6e00243ae3f63009c70f1e380a30b83b64e2b8d2d171f2c7a53822eba0c52815ad065179a388d682492730447534dcb1dbe4bf5385be0e3c5b4e657
+  data.tar.gz: c56ff347a10cddfeb88d8932550227577997d3b5502d69f85965a3d2a94f65e347e055139946b8aac1226938328efa3ee5fb8f2dcd8ba793e114fce569489c2d

data/.travis.yml

@@ -6,7 +6,9 @@ rvm:
   - 2.2.3
   - 2.2.4
   - 2.2.5
-  - 2.2.6
   - 2.3.0
   - 2.3.1
 before_install: gem install bundler -v 1.12.5
+addons:
+  code_climate:
+    repo_token: 4415bcfcf6ba75e0dfcc5a3a14277803c8ee9401c84b3dbd65d1aa11004d7321

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "codeclimate-test-reporter", group: :test, require: nil
 # Specify your gem's dependencies in request_repeater.gemspec
 gemspec
+

data/README.md

@@ -1,15 +1,27 @@
 # Request Repeater
 
-Simple [Ruby Gem]() or [Docker image](https://hub.docker.com/) to
+Simple [Ruby Gem](https://rubygems.org/gems/request_repeater)
+or [Docker image](https://hub.docker.com/r/pobble/request_repeater/) to
 execute GET request on an endpoint (Request Repeater).
 
-This is usefull if you cannot do cron jobs in your application settup.
+This is useful if you cannot do cron jobs in your application setup.
 
 Just expose a certain route in your web application to execute the job
-(or to schedule backround job) tell `request_repeeter` to trigger GET requests on it.
+(or to schedule background job) and tell `request_repeeter` to trigger GET requests on it.
+
+**Application can be executed as**:
+
+* :heavy_dollar_sign: [Standalone Ruby gem  application](https://github.com/Pobble/request_repeater#standalone-ruby-gem)
+* :whale: [Docker image application](https://github.com/Pobble/request_repeater#docker-image-application)
 
 ## Standalone Ruby gem
 
+[![Build Status](https://travis-ci.org/Pobble/request_repeater.svg?branch=master)](https://travis-ci.org/Pobble/request_repeater)
+[![Code Climate](https://codeclimate.com/github/Pobble/request_repeater/badges/gpa.svg)](https://codeclimate.com/github/Pobble/request_repeater)
+[![Test Coverage](https://codeclimate.com/github/Pobble/request_repeater/badges/coverage.svg)](https://codeclimate.com/github/Pobble/request_repeater/coverage)
+
+#### Instalation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -28,6 +40,256 @@ Or install it yourself as:
 
     $ gem install request_repeater
 
+#### Usage
+
+**Single endpoint**
+
+Pass enviroment variable `URL` with location
+
+```
+# every second send request to http://localhost:3000/execute-something.html
+$ URL=http://localhost:3000/execute-something.html bundle exec request_repeater
+
+# ...or if you didn't use Bundler
+$ URL=http://localhost:3000/execute-something.html request_repeater
+```
+
+Default timeout is 1000ms (1 second), if you need different timeout pass
+`SLEEPFOR` env variable:
+
+```
+# every two seconds send request to https://localhost:3000/maintenance?token=12345
+$ URL=https://localhost:3000/maintenance?token=12345 SLEEPFOR=2000 bundle exec request_repeater
+```
+
+For authentication we recommend just to pass token as a query param,
+like: `/maintenance?token=12345`
+
+**Multiple endpoints**
+
+You need to pass `URLS` env variable with json in format:
+
+```json
+{
+  "urls": [
+    {"url":"http://myserver/some-endpoint", "sleep":4000},
+    {"url":"http://myserver/another-endpoint", "sleep":1200},
+    {"url":"http://myserver/third-endpoint", "sleep":72000}
+  ]
+}
+```
+
+example:
+
+```
+$ URLS='{"urls": [{"url":"http://localhost/some-endpoint", "sleep":1200}, {"url":"http://localhost/another-endpoint","sleep":3000}]}' bundle exec request_repeater
+```
+
+> `URL` and `SLEEPFOR` env variables are ignored when you provide `URLS` env variable
+
+## Docker Image Application
+
+![Docker Image Stats](http://dockeri.co/image/pobble/request_repeater)
+[![](https://imagelayers.io/badge/pobble/request_repeater:latest.svg)](https://imagelayers.io/?images=pobble/request_repeater:latest 'Get your own badge on imagelayers.io')
+
+#### Usage
+
+```bash
+$ docker pull pobble/request_repeater
+```
+
+**Single Endpoint**
+
+Specify `URL` env variable
+
+
+```bash
+$ docker run -e "URL=http://www.my-app.dot/execute-something.html" pobble/request_repeater
+```
+
+Default timeout is 1000ms (1 second), if you need different timeout pass
+`SLEEPFOR` env variable:
+
+```bash
+# 2 second timeout
+$ docker run -e "SLEEPFOR=2000" -e "URL=http://www.my-app.dot/execute-something.html" pobble/request_repeater
+```
+
+To execute on localhost of image host:
+
+```bash
+$ docker run -e "SLEEPFOR=2000" -e "URL=http://localhost:3000/execute-something.html" --net="host" pobble/request_repeater
+```
+
+You want authentication ? How about passing token param:
+
+```bash
+$ docker run -e "URL=https://www.my-app.dot/execute-something.html?token=1234556"  pobble/request_repeater
+```
+
+**docker-compose.yml example**
+
+```yml
+---
+version: '2'
+services:
+  nginx:
+    image: quay.io/myorg/my-nginx-image
+    ports:
+      - "80:80"
+  request_repeater:
+    image: 'pobble/request_repeater'
+    links:
+      - nginx:nginx
+    environment:
+      URL: 'http://nginx/some-endpoint'
+      SLEEPFOR: 7200
+```
+
+
+**AWS Elastic Beanstalk Dockerrun.aws.json example**
+
+```json
+{
+  "containerDefinitions": [
+    {
+      "name": "nginx",
+      "image": "........",
+      "portMappings": [
+        {
+          "hostPort": 80,
+          "containerPort": 80
+        }
+      ],
+    },
+    {
+      "name": "request_repeater",
+      "image": "pobble/request_repeater",
+      "essential": true,
+      "memory": 150,
+      "links": [ "nginx" ],
+      "environment": [
+        {
+          "name": "URL",
+          "value": "http://nginx/some-endpoint"
+        }
+      ]
+    }
+  ]
+}
+```
+
+**Multiple endpoints**
+
+You need to pass `URLS` env variable with JSON in format:
+
+```json
+{
+  "urls": [
+    {"url":"http://myserver/some-endpoint", "sleep":4000},
+    {"url":"http://myserver/another-endpoint", "sleep":1200},
+    {"url":"http://myserver/third-endpoint", "sleep":72000}
+  ]
+}
+```
+
+```bash
+$ docker run -e 'URLS={"urls": [{"url":"http://localhost/some-endpoint", "sleep":1200}, {"url":"http://localhost/another-endpoint","sleep":3000}]}' --net="host" pobble/request_repeater
+```
+
+> `URL` and `SLEEPFOR` env variables are ignored when you provide `URLS` env variable
+
+#### Docker Composer example
+
+*docker-compose.yml*:
+
+```yml
+---
+version: '2'
+services:
+  nginx:
+    image: quay.io/myorg/my-nginx-image
+    ports:
+      - "80:80"
+  request_repeater:
+    image: 'pobble/request_repeater'
+    links:
+      - nginx:nginx
+    environment:
+      URLS: '{"urls": [{"url":"http://nginx/some-endpoint", "sleep":1200},
+{"url":"http://nginx/another-endpoint","sleep":7200}]}'
+```
+
+#### AWS Elastic Beanstalk Dockerrun.aws.json example usage
+
+*Dockerrun.aws.json*:
+
+```json
+{
+  "containerDefinitions": [
+    {
+      "name": "nginx",
+      "image": "........",
+      "portMappings": [
+        {
+          "hostPort": 80,
+          "containerPort": 80
+        }
+      ],
+    },
+    {
+      "name": "request_repeater",
+      "image": "pobble/request_repeater",
+      "essential": true,
+      "memory": 150,
+      "links": [ "nginx" ],
+      "environment": [
+        {
+          "name": "URLS",
+          "value":"{\"urls\":[{\"url\":\"http://nginx/some-endpoint\",\"sleep\":1300},{\"url\":\"http://nginx/other-endpoint\",\"sleep\":1200000}]}"
+
+        }
+      ]
+    }
+  ]
+}
+```
+
+#### Kill the container
+
+```bash
+$ docker kill $(docker ps | grep request_repeater | awk "{print \$1}")
+
+# sudo version
+$ sudo docker kill $(sudo docker ps | grep request_repeater | awk "{print \$1}")
+```
+
+## Minimum Sleeptime
+
+In order to avoid docker container / gem to use all CPU resources  there is a minimum sleep
+time implementend set to `500 miliseconds`. If you need to use this
+image without this limit provide one more extra enviroment variable `MINIMUMSLEEP`:
+
+```
+$ URL=https://www.my-app.dot/execute-something.html SLEEPFOR=100 MINIMUMSLEEP=0 bundle exec request_repeater
+
+$ docker run -e "SLEEPFOR=300" -e 'MINIMUMSLEEP=300' -e "URL=http://www.my-app.dot/execute-something.html" pobble/request_repeater # 300 ms
+
+$ docker run -e "SLEEPFOR=0" -e 'MINIMUMSLEEP=0' -e "URL=http://www.my-app.dot/execute-something.html" pobble/request_repeater # no limit
+```
+
+## Alternatives
+
+This Ruby Gem (and Docker image) is attempt to rewrite [little_bastard golang Docker image](https://github.com/equivalent/little_bastard)
+which has a issue with memory leak causing eventually docker container to
+restart after several hours of activity, but can handle more requests
+per second. If you need something that does more requests per second
+(e.g.: testing your app against DDOS attack)
+then [Little Bastard](https://hub.docker.com/r/pobble/request_repeater/)
+image is better for you.
+
+`pobble/request_repeater`  aims to provide stable flow of
+repeating requests without crushing over time.
 
 ## License
 

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/request_repeater.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'logger'
 require 'json'
 require 'net/http'
+require 'openssl'
 
 module RequestRepeater
   def self.sleeptime(miliseconds)

data/lib/request_repeater/version.rb

@@ -1,3 +1,3 @@
 module RequestRepeater
-  VERSION = "0.1.0.1"
+  VERSION = "0.1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_repeater
 version: !ruby/object:Gem::Version
-  version: 0.1.0.1
+  version: 0.1.0.2
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - bin/console
 - bin/run
 - bin/setup