xcflushd 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.ruby-gemset ADDED
@@ -0,0 +1 @@
1
+ xcflushd
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.3.1
data/.simplecov ADDED
@@ -0,0 +1,3 @@
1
+ SimpleCov.start do
2
+ add_filter '/spec/'
3
+ end
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
data/Dockerfile ADDED
@@ -0,0 +1,99 @@
1
+ FROM ubuntu:xenial
2
+ MAINTAINER Alejandro Martinez Ruiz <alex@3scale.net>
3
+
4
+ ENV DEBIAN_FRONTEND=noninteractive
5
+
6
+ # User
7
+ ARG USER_NAME=user
8
+ ARG USER_HOME="/home/${USER_NAME}"
9
+ # Timezone
10
+ ARG TZ="Europe/Madrid"
11
+
12
+ RUN echo "Acquire::http {No-Cache=True;};" > /etc/apt/apt.conf.d/no-cache \
13
+ && echo 'APT {Install-Recommends="false";Install-Suggests="false";};' > /etc/apt/apt.conf.d/no-recommends \
14
+ && rm -f /etc/cron.weekly/fstrim \
15
+ && rm -f /etc/cron.daily/apt \
16
+ && rm -f /etc/cron.daily/dpkg \
17
+ && rm -f /etc/cron.daily/passwd \
18
+ && apt-get update -y -q && apt-get install -y -q apt-utils \
19
+ && apt-get dist-upgrade -y -q \
20
+ && apt-get install -y -q sudo cron logrotate wget curl unzip ca-certificates \
21
+ iputils-arping inetutils-ping inetutils-telnet net-tools nmap iotop tmux vim \
22
+ build-essential git make strace gdb tcpdump autoconf libtool autopoint bison \
23
+ libssl-dev libcurl4-openssl-dev libz-dev bash \
24
+ && adduser --disabled-password --home ${USER_HOME} --shell /bin/bash \
25
+ --gecos "" ${USER_NAME} \
26
+ && echo "${USER_NAME} ALL=(ALL:ALL) NOPASSWD: ALL" > /etc/sudoers.d/${USER_NAME} \
27
+ && chmod 0440 /etc/sudoers.d/${USER_NAME} \
28
+ && passwd -d ${USER_NAME} \
29
+ && ln -snf /usr/share/zoneinfo/${TZ} /etc/localtime \
30
+ && echo ${TZ} > /etc/timezone \
31
+ && dpkg-reconfigure --frontend ${DEBIAN_FRONTEND} tzdata \
32
+ && apt-get -y -q autoremove --purge \
33
+ && chown -R ${USER_NAME}: ${USER_HOME} \
34
+ && apt-get -y -q clean
35
+
36
+ USER ${USER_NAME}
37
+
38
+ ARG RBENV_ROOT="${USER_HOME}/.rbenv"
39
+ ARG RBENV_BINPATH="${RBENV_ROOT}/bin"
40
+ ARG RBENV_PATH="${RBENV_ROOT}/shims:${RBENV_BINPATH}"
41
+
42
+ ARG RBENV_RUBYBUILD_ROOT=${RBENV_ROOT}/plugins/ruby-build
43
+
44
+ RUN git clone --recursive --single-branch https://github.com/rbenv/rbenv.git ${RBENV_ROOT} \
45
+ && git clone --recursive --single-branch https://github.com/rbenv/ruby-build.git ${RBENV_RUBYBUILD_ROOT} \
46
+ && cd ${RBENV_ROOT} \
47
+ && ( \
48
+ git checkout -f $(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
49
+ || git checkout -f v$(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
50
+ ) \
51
+ && git submodule update --checkout \
52
+ && cd ${RBENV_RUBYBUILD_ROOT} \
53
+ && ( \
54
+ git checkout -f $(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
55
+ || git checkout -f v$(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
56
+ ) \
57
+ && cd ${RBENV_ROOT} && src/configure && ( make -C src || true ) \
58
+ && echo -n export PATH=${RBENV_BINPATH} >> ~/.bash_rbenv && echo ':$PATH' >> ~/.bash_rbenv \
59
+ && echo 'eval "$(rbenv init -)"' >> ~/.bash_rbenv \
60
+ && echo 'source ~/.bash_rbenv' >> ~/.profile
61
+
62
+ ARG APP_HOME=${USER_HOME}/app
63
+ ARG BUILD_DEPS="libyaml-dev libreadline-dev libncurses-dev libffi-dev libgdbm3 libgdbm-dev"
64
+
65
+ USER root
66
+ RUN test -z "${BUILD_DEPS}" \
67
+ || ( \
68
+ apt-get update && apt-get install -y -q ${BUILD_DEPS} \
69
+ )
70
+
71
+ WORKDIR ${APP_HOME}
72
+ COPY .ruby-version .ruby-gemset ${APP_HOME}/
73
+
74
+ USER ${USER_NAME}
75
+ ENV PATH="${RBENV_PATH}:${PATH}"
76
+ RUN rbenv install -s \
77
+ && rbenv rehash \
78
+ && echo 'gem: --no-document' >> ~/.gemrc \
79
+ && gem update --system \
80
+ && ( bundler --version || gem install bundler ) \
81
+ && bundle config --global jobs `grep -c processor /proc/cpuinfo` \
82
+ && bundle config --global cache_all true
83
+
84
+ COPY Gemfile Gemfile.lock xcflushd.gemspec ${APP_HOME}/
85
+ COPY lib/xcflushd/version.rb ${APP_HOME}/lib/xcflushd/
86
+ USER root
87
+ RUN chown -R ${USER_NAME}: ${APP_HOME}
88
+
89
+ USER ${USER_NAME}
90
+ RUN bundle install
91
+
92
+ COPY . ${APP_HOME}
93
+ USER root
94
+ RUN chown -R ${USER_NAME}: ${APP_HOME}
95
+
96
+ USER ${USER_NAME}
97
+ RUN bundle install
98
+
99
+ CMD bundle exec exe/xcflushd run
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in xcflushd.gemspec
4
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,78 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ xcflushd (1.0.0.rc2)
5
+ 3scale_client (~> 2.10.0)
6
+ concurrent-ruby (= 1.0.2)
7
+ daemons (= 1.2.4)
8
+ gli (= 2.14.0)
9
+ hiredis (= 0.6.1)
10
+ net-http-persistent (= 2.9.4)
11
+ redis (= 3.3.1)
12
+
13
+ GEM
14
+ remote: https://rubygems.org/
15
+ specs:
16
+ 3scale_client (2.10.0)
17
+ nokogiri
18
+ ast (2.3.0)
19
+ concurrent-ruby (1.0.2)
20
+ daemons (1.2.4)
21
+ diff-lcs (1.2.5)
22
+ docile (1.1.5)
23
+ fakeredis (0.6.0)
24
+ redis (~> 3.2)
25
+ gli (2.14.0)
26
+ hiredis (0.6.1)
27
+ json (2.0.2)
28
+ mini_portile2 (2.1.0)
29
+ net-http-persistent (2.9.4)
30
+ nokogiri (1.6.8.1)
31
+ mini_portile2 (~> 2.1.0)
32
+ parser (2.3.3.1)
33
+ ast (~> 2.2)
34
+ powerpack (0.1.1)
35
+ rainbow (2.1.0)
36
+ rake (11.2.2)
37
+ redis (3.3.1)
38
+ rspec (3.5.0)
39
+ rspec-core (~> 3.5.0)
40
+ rspec-expectations (~> 3.5.0)
41
+ rspec-mocks (~> 3.5.0)
42
+ rspec-core (3.5.2)
43
+ rspec-support (~> 3.5.0)
44
+ rspec-expectations (3.5.0)
45
+ diff-lcs (>= 1.2.0, < 2.0)
46
+ rspec-support (~> 3.5.0)
47
+ rspec-mocks (3.5.0)
48
+ diff-lcs (>= 1.2.0, < 2.0)
49
+ rspec-support (~> 3.5.0)
50
+ rspec-support (3.5.0)
51
+ rubocop (0.46.0)
52
+ parser (>= 2.3.1.1, < 3.0)
53
+ powerpack (~> 0.1)
54
+ rainbow (>= 1.99.1, < 3.0)
55
+ ruby-progressbar (~> 1.7)
56
+ unicode-display_width (~> 1.0, >= 1.0.1)
57
+ ruby-progressbar (1.8.1)
58
+ simplecov (0.12.0)
59
+ docile (~> 1.1.0)
60
+ json (>= 1.8, < 3)
61
+ simplecov-html (~> 0.10.0)
62
+ simplecov-html (0.10.0)
63
+ unicode-display_width (1.1.2)
64
+
65
+ PLATFORMS
66
+ ruby
67
+
68
+ DEPENDENCIES
69
+ bundler (~> 1.12)
70
+ fakeredis (~> 0.6.0)
71
+ rake (~> 11.0)
72
+ rspec (~> 3.0)
73
+ rubocop (~> 0.46.0)
74
+ simplecov (~> 0.12.0)
75
+ xcflushd!
76
+
77
+ BUNDLED WITH
78
+ 1.13.6
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/Makefile ADDED
@@ -0,0 +1,17 @@
1
+ MKFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
2
+ PROJECT_PATH := $(patsubst %/,%,$(dir $(MKFILE_PATH)))
3
+
4
+ DOCKER_USER := user
5
+ DOCKER_APP_HOME := /home/$(DOCKER_USER)
6
+ DOCKER_PROJECT_PATH := $(DOCKER_APP_HOME)/app
7
+
8
+ default: test
9
+
10
+ build:
11
+ docker build -t xcflushd $(PROJECT_PATH)
12
+
13
+ test: build
14
+ docker run --rm -t xcflushd script/test
15
+
16
+ bash: build
17
+ docker run --rm -t -i -v $(PROJECT_PATH):$(DOCKER_PROJECT_PATH) xcflushd /bin/bash
data/NOTICE ADDED
@@ -0,0 +1,14 @@
1
+ 3scale XCFlushd
2
+ Copyright (c) 2016 3scale Inc.
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,118 @@
1
+ # Xcflushd
2
+
3
+ [![Build Status](https://travis-ci.org/3scale/xcflushd.svg?branch=master)](https://travis-ci.org/3scale/xcflushd) [![Code Climate](https://codeclimate.com/repos/585a6e7cd78de855e5002463/badges/7825d2a1491b30a172f7/gpa.svg)](https://codeclimate.com/repos/585a6e7cd78de855e5002463/feed)
4
+
5
+ ## Description
6
+
7
+ This is the daemon that flushes the data that the gateway side of XC like the
8
+ [apicast-xc](https://github.com/3scale/apicast-xc) module running on top of [Apicast](https://github.com/3scale/apicast), stores for reporting and authorizing to 3scale.
9
+
10
+ When you deploy 3scale to a gateway you usually have a request performed to
11
+ 3scale for every request that needs authorization, which introduces latency and
12
+ load in 3scale. The goal of XC is to reduce latency and increase throughput by
13
+ significantly reducing the number of requests made to 3scale's backend. In
14
+ order to achieve that, XC caches authorization statuses and reports.
15
+
16
+ Xcflushd is a daemon that is required to run while using XC. Its responsibility
17
+ consists of flushing the cached reports and renewing the cached authorization
18
+ statuses. All this is done in background, not in request time.
19
+
20
+ Xcflushd can run together with a different gateway as long as it uses the same
21
+ format for the cached authorizations and reports. This format will be
22
+ documented soon.
23
+
24
+ ## Development environment and testing
25
+
26
+ You will need [Docker](https://www.docker.com/) and GNU make.
27
+
28
+ First, clone the project:
29
+ ```
30
+ $ git clone git@github.com:3scale/xcflushd.git
31
+ ```
32
+
33
+ Next, cd into the directory, `cd xcflushd`
34
+
35
+ Run the tests with:
36
+ ```
37
+ $ make test
38
+ ```
39
+
40
+ That will run the unit test suite. It's using [Rspec](https://rspec.info).
41
+
42
+ Develop with:
43
+ ```
44
+ $ make bash
45
+ ```
46
+
47
+ That will create a Docker container and run bash inside it. The project's
48
+ source code will be available in `~/app` and synced with your local xcflushd
49
+ directory. You can edit files in your preferred environment and still be able
50
+ to run whatever you need inside the Docker container.
51
+
52
+
53
+ ## Deployment
54
+
55
+ You will need a Redis server running.
56
+
57
+ ### Docker
58
+
59
+ Build:
60
+ ```
61
+ $ make build
62
+ ```
63
+
64
+ Run:
65
+ ```
66
+ $ docker run --rm xcflushd bundle exec xcflushd help run
67
+ ```
68
+
69
+ You can send the options as params in the `xcflushd` command:
70
+ ```
71
+ $ docker run --rm xcflushd bundle exec xcflushd run --auth-ttl 900 --provider-key my_provider_key --redis 127.0.0.1:6379 --frequency 300 --backend https://su1.3scale.net:443
72
+ ```
73
+
74
+ Please note that the help command will also show you abbreviated flags you can
75
+ use at your convenience.
76
+
77
+ ### Locally
78
+
79
+ Install the dependencies:
80
+ ```
81
+ $ bundle install
82
+ ```
83
+
84
+ Run the program:
85
+ ```
86
+ $ bundle exec xcflushd help
87
+ ```
88
+
89
+ ### Openshift
90
+
91
+ If what you need is deploying Xcflushd together with Apicast and XC, you can
92
+ follow the instructions provided in the [apicast-xc repo](https://github.com/3scale/apicast-xc).
93
+
94
+
95
+ ## How it works
96
+
97
+ Every X minutes (configurable) the flusher does two things:
98
+
99
+ 1. Reports to 3scale all the reports cached in Redis.
100
+ 2. Renews the authorization status (authorized/denied) for all the
101
+ applications affected by the cached reports that have been reported to
102
+ 3scale.
103
+
104
+ For more details, check the [design doc](docs/design.md).
105
+
106
+
107
+ ## Contributing
108
+
109
+ 1. Fork the project
110
+ 2. Create your feature branch: `git checkout -b my-new-feature`
111
+ 3. Commit your changes: `git commit -am 'Add some feature'`
112
+ 4. Push to the branch: `git push origin my-new-feature`
113
+ 5. Create a new Pull Request
114
+
115
+
116
+ ## License
117
+
118
+ [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "xcflushd"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here