xcflushd 1.0.0.rc2

data/.ruby-gemset

@@ -0,0 +1 @@
+xcflushd

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Dockerfile

@@ -0,0 +1,99 @@
+FROM ubuntu:xenial
+MAINTAINER Alejandro Martinez Ruiz <alex@3scale.net>
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# User
+ARG USER_NAME=user
+ARG USER_HOME="/home/${USER_NAME}"
+# Timezone
+ARG TZ="Europe/Madrid"
+
+RUN echo "Acquire::http {No-Cache=True;};" > /etc/apt/apt.conf.d/no-cache \
+ && echo 'APT {Install-Recommends="false";Install-Suggests="false";};' > /etc/apt/apt.conf.d/no-recommends \
+ && rm -f /etc/cron.weekly/fstrim \
+ && rm -f /etc/cron.daily/apt \
+ && rm -f /etc/cron.daily/dpkg \
+ && rm -f /etc/cron.daily/passwd \
+ && apt-get update -y -q && apt-get install -y -q apt-utils \
+ && apt-get dist-upgrade -y -q \
+ && apt-get install -y -q sudo cron logrotate wget curl unzip ca-certificates \
+    iputils-arping inetutils-ping inetutils-telnet net-tools nmap iotop tmux vim \
+    build-essential git make strace gdb tcpdump autoconf libtool autopoint bison \
+    libssl-dev libcurl4-openssl-dev libz-dev bash \
+ && adduser --disabled-password --home ${USER_HOME} --shell /bin/bash \
+      --gecos "" ${USER_NAME} \
+ && echo "${USER_NAME} ALL=(ALL:ALL) NOPASSWD: ALL" > /etc/sudoers.d/${USER_NAME} \
+ && chmod 0440 /etc/sudoers.d/${USER_NAME} \
+ && passwd -d ${USER_NAME} \
+ && ln -snf /usr/share/zoneinfo/${TZ} /etc/localtime \
+ && echo ${TZ} > /etc/timezone \
+ && dpkg-reconfigure --frontend ${DEBIAN_FRONTEND} tzdata \
+ && apt-get -y -q autoremove --purge \
+ && chown -R ${USER_NAME}: ${USER_HOME} \
+ && apt-get -y -q clean
+
+USER ${USER_NAME}
+
+ARG RBENV_ROOT="${USER_HOME}/.rbenv"
+ARG RBENV_BINPATH="${RBENV_ROOT}/bin"
+ARG RBENV_PATH="${RBENV_ROOT}/shims:${RBENV_BINPATH}"
+
+ARG RBENV_RUBYBUILD_ROOT=${RBENV_ROOT}/plugins/ruby-build
+
+RUN git clone --recursive --single-branch https://github.com/rbenv/rbenv.git ${RBENV_ROOT} \
+ && git clone --recursive --single-branch https://github.com/rbenv/ruby-build.git ${RBENV_RUBYBUILD_ROOT} \
+ && cd ${RBENV_ROOT} \
+ && ( \
+      git checkout -f $(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
+       || git checkout -f v$(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
+    ) \
+ && git submodule update --checkout \
+ && cd ${RBENV_RUBYBUILD_ROOT} \
+ && ( \
+      git checkout -f $(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
+       || git checkout -f v$(git tag | grep -P "^v?\d[\d.]*$" | sed -e "s/^v//g" | sort -V | tail -n 1) \
+    ) \
+ && cd ${RBENV_ROOT} && src/configure && ( make -C src || true ) \
+ && echo -n export PATH=${RBENV_BINPATH} >> ~/.bash_rbenv && echo ':$PATH' >> ~/.bash_rbenv \
+ && echo 'eval "$(rbenv init -)"' >> ~/.bash_rbenv \
+ && echo 'source ~/.bash_rbenv' >> ~/.profile
+
+ARG APP_HOME=${USER_HOME}/app
+ARG BUILD_DEPS="libyaml-dev libreadline-dev libncurses-dev libffi-dev libgdbm3 libgdbm-dev"
+
+USER root
+RUN test -z "${BUILD_DEPS}" \
+ || ( \
+      apt-get update && apt-get install -y -q ${BUILD_DEPS} \
+    )
+
+WORKDIR ${APP_HOME}
+COPY .ruby-version .ruby-gemset ${APP_HOME}/
+
+USER ${USER_NAME}
+ENV PATH="${RBENV_PATH}:${PATH}"
+RUN rbenv install -s \
+ && rbenv rehash \
+ && echo 'gem: --no-document' >> ~/.gemrc \
+ && gem update --system  \
+ && ( bundler --version || gem install bundler ) \
+ && bundle config --global jobs `grep -c processor /proc/cpuinfo` \
+ && bundle config --global cache_all true
+
+COPY Gemfile Gemfile.lock xcflushd.gemspec ${APP_HOME}/
+COPY lib/xcflushd/version.rb ${APP_HOME}/lib/xcflushd/
+USER root
+RUN chown -R ${USER_NAME}: ${APP_HOME}
+
+USER ${USER_NAME}
+RUN bundle install
+
+COPY . ${APP_HOME}
+USER root
+RUN chown -R ${USER_NAME}: ${APP_HOME}
+
+USER ${USER_NAME}
+RUN bundle install
+
+CMD bundle exec exe/xcflushd run

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcflushd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    xcflushd (1.0.0.rc2)
+      3scale_client (~> 2.10.0)
+      concurrent-ruby (= 1.0.2)
+      daemons (= 1.2.4)
+      gli (= 2.14.0)
+      hiredis (= 0.6.1)
+      net-http-persistent (= 2.9.4)
+      redis (= 3.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    3scale_client (2.10.0)
+      nokogiri
+    ast (2.3.0)
+    concurrent-ruby (1.0.2)
+    daemons (1.2.4)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    fakeredis (0.6.0)
+      redis (~> 3.2)
+    gli (2.14.0)
+    hiredis (0.6.1)
+    json (2.0.2)
+    mini_portile2 (2.1.0)
+    net-http-persistent (2.9.4)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    redis (3.3.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unicode-display_width (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  fakeredis (~> 0.6.0)
+  rake (~> 11.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.46.0)
+  simplecov (~> 0.12.0)
+  xcflushd!
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,17 @@
+MKFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
+PROJECT_PATH := $(patsubst %/,%,$(dir $(MKFILE_PATH)))
+
+DOCKER_USER := user
+DOCKER_APP_HOME := /home/$(DOCKER_USER)
+DOCKER_PROJECT_PATH := $(DOCKER_APP_HOME)/app
+
+default: test
+
+build:
+	docker build -t xcflushd $(PROJECT_PATH)
+
+test: build
+	docker run --rm -t xcflushd script/test
+
+bash: build
+	docker run --rm -t -i -v $(PROJECT_PATH):$(DOCKER_PROJECT_PATH) xcflushd /bin/bash

data/NOTICE

@@ -0,0 +1,14 @@
+   3scale XCFlushd
+   Copyright (c) 2016 3scale Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,118 @@
+# Xcflushd
+
+[![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)
+
+## Description
+
+This is the daemon that flushes the data that the gateway side of XC like the
+[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.
+
+When you deploy 3scale to a gateway you usually have a request performed to
+3scale for every request that needs authorization, which introduces latency and
+load in 3scale. The goal of XC is to reduce latency and increase throughput by
+significantly reducing the number of requests made to 3scale's backend. In
+order to achieve that, XC caches authorization statuses and reports.
+
+Xcflushd is a daemon that is required to run while using XC. Its responsibility
+consists of flushing the cached reports and renewing the cached authorization
+statuses. All this is done in background, not in request time.
+
+Xcflushd can run together with a different gateway as long as it uses the same
+format for the cached authorizations and reports. This format will be
+documented soon.
+
+## Development environment and testing
+
+You will need [Docker](https://www.docker.com/) and GNU make.
+
+First, clone the project:
+```
+$ git clone git@github.com:3scale/xcflushd.git
+```
+
+Next, cd into the directory, `cd xcflushd`
+
+Run the tests with:
+```
+$ make test
+```
+
+That will run the unit test suite. It's using [Rspec](https://rspec.info).
+
+Develop with:
+```
+$ make bash
+```
+
+That will create a Docker container and run bash inside it. The project's
+source code will be available in `~/app` and synced with your local xcflushd
+directory. You can edit files in your preferred environment and still be able
+to run whatever you need inside the Docker container.
+
+
+## Deployment
+
+You will need a Redis server running.
+
+### Docker
+
+Build:
+```
+$ make build
+```
+
+Run:
+```
+$ docker run --rm xcflushd bundle exec xcflushd help run
+```
+
+You can send the options as params in the `xcflushd` command:
+```
+$ 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
+```
+
+Please note that the help command will also show you abbreviated flags you can
+use at your convenience.
+
+### Locally
+
+Install the dependencies:
+```
+$ bundle install
+```
+
+Run the program:
+```
+$ bundle exec xcflushd help
+```
+
+### Openshift
+
+If what you need is deploying Xcflushd together with Apicast and XC, you can
+follow the instructions provided in the [apicast-xc repo](https://github.com/3scale/apicast-xc).
+
+
+## How it works
+
+Every X minutes (configurable) the flusher does two things:
+
+1. Reports to 3scale all the reports cached in Redis.
+2. Renews the authorization status (authorized/denied) for all the
+   applications affected by the cached reports that have been reported to
+   3scale.
+
+For more details, check the [design doc](docs/design.md).
+
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create a new Pull Request
+
+
+## License
+
+[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xcflushd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here