flipper 0.12.2 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 965343e60248399aab50206cf8f7186575780659
-  data.tar.gz: 6cdcc01506fc5513c8cd29ac27665aaa298afa78
+SHA256:
+  metadata.gz: a73ea66b4ab3342f5cf63a162bf8b0482fdc644dc0fff38fcb2d3fa2b39015be
+  data.tar.gz: a680008dad6bc0affee30e0d150aab5cc869d46d37ac2ae3ce8b7b2f57de9e9b
 SHA512:
-  metadata.gz: f8bdbd7c2357b312d0ba05308319b02ef49e200fa051e349f632122da85b17f655bbdb8138c48bf2c605838bc6fcfd92c86870b17d29615213a850ace1238d5a
-  data.tar.gz: 1fee068e18c2a5f1a328abc1c80cc0d6eb29ddb1eb89499958eb6938be87cb088b9e00f4919fef1b5d11d562634862d1b83fbcc75ff0834393b9350deb216aea
+  metadata.gz: 50d1ff58301b4040e2ac0ed6590c057952f3c926aa88371858cec083be2d5fcdb17920fa120f6c59f9a5625ad2260aa0cdf40c26dfa64239a4790f247287c720
+  data.tar.gz: 40d68ac75fde3051cece778aa09145891ca3cf289abb795c66695f3e3fac569c28e81864d3be386d7ab03d0fd9c1b9c303fca6f5865ef6a2cd4eb9edbdc12eee

data/.codeclimate.yml

@@ -1,2 +1,3 @@
 exclude_patterns:
   - "lib/flipper/ui/public"
+  - "spec/"

data/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby }} and rails ${{ matrix.rails }}
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports: ['6379:6379']
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+        rails: ['5.2', '6.0.0', '6.1.0', '7.0.0']
+        exclude:
+          - ruby: "2.6"
+            rails: "7.0.0"
+          - ruby: "3.0"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "6.0.0"
+    env:
+      SQLITE3_VERSION: 1.4.1
+      REDIS_URL: redis://localhost:6379/0
+      CI: true
+    steps:
+      - name: Setup memcached
+        uses: KeisukeYamashita/memcached-actions@v1
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: 4.0
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Do some action caching
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
+      - name: Install bundler
+        run: gem install bundler
+      - name: Run Rake with Rails ${{ matrix.rails }}
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.github/workflows/examples.yml

@@ -0,0 +1,67 @@
+name: Examples
+on: [push, pull_request]
+jobs:
+  test:
+    if: github.repository_owner == 'jnunemaker'
+    name: Test on ruby ${{ matrix.ruby }} and rails ${{ matrix.rails }}
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports: ['6379:6379']
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+        rails: ['5.2', '6.0.0', '6.1.0', '7.0.0']
+        exclude:
+          - ruby: "2.6"
+            rails: "7.0.0"
+          - ruby: "3.0"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "6.0.0"
+
+    env:
+      SQLITE3_VERSION: 1.4.1
+      REDIS_URL: redis://localhost:6379/0
+      CI: true
+    steps:
+      - name: Setup memcached
+        uses: KeisukeYamashita/memcached-actions@v1
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: 4.0
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Do some action caching
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
+      - name: Install bundler
+        run: gem install bundler
+      - name: Bundle install with Rails ${{ matrix.rails }}
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: bundle install --jobs 4 --retry 3
+      - name: Run Examples with Rails ${{ matrix.rails }}
+        env:
+          FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: script/examples

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Changelog.md

@@ -1,3 +1,263 @@
+## 0.24.1
+
+### Additions/Changes
+
+* flipper-api: `exclude_gates` parameter to exclude gate data in GETs (https://github.com/jnunemaker/flipper/pull/572).
+* Make it possible to disable internal memoization (https://github.com/jnunemaker/flipper/pull/612).
+* Add Flipper::Actor#hash so actors can be hash keys (https://github.com/jnunemaker/flipper/pull/616).
+* Pretty Up `rails routes` again and make rack-protection dependency less strict (https://github.com/jnunemaker/flipper/pull/619).
+* Add kwargs for method_missing using ruby 3.0 (https://github.com/jnunemaker/flipper/pull/620).
+
+## 0.24.0
+
+### Additions/Changes
+
+* Add Ruby 3.0 and 3.1 to the CI matrix and fix groups block arity check for ruby 3 (https://github.com/jnunemaker/flipper/pull/601)
+* Removed support for Ruby 2.5 (which was end of line 9 months ago)
+* Add (alpha) client side instrumentation of events to cloud (https://github.com/jnunemaker/flipper/pull/602)
+* Fix deprecated uses of Redis#pipelined (https://github.com/jnunemaker/flipper/pull/603). redis-rb >= 3 now required.
+* Fix Flipper UI Rack application when `Rack::Session::Pool` is used to build it (https://github.com/jnunemaker/flipper/pull/606).
+
+## 0.23.1
+
+### Additions/Changes
+
+* Relax dalli version constraint (https://github.com/jnunemaker/flipper/pull/596)
+
+### Bug Fixes
+
+* Fix railtie initialization to mount middleware after config/intializers/* (https://github.com/jnunemaker/flipper/pull/586)
+
+## 0.23.0
+
+### Additions/Changes
+
+* Allow some HTML in banner and descriptions (https://github.com/jnunemaker/flipper/pull/570).
+* Moved some cloud headers to http client (https://github.com/jnunemaker/flipper/pull/567).
+* Update flipper-ui jquery and bootstrap versions (https://github.com/jnunemaker/flipper/issues/565 and https://github.com/jnunemaker/flipper/pull/566).
+* Moved docs to www.flippercloud.io/docs (https://github.com/jnunemaker/flipper/pull/574).
+* PStore adapter now defaults to thread safe and no longer supports `.thread_safe` (https://github.com/jnunemaker/flipper/commit/4048704fefe41b716015294a19a0b94546637630).
+* Add failover adapter (https://github.com/jnunemaker/flipper/pull/584).
+* Improve http adapter error message (https://github.com/jnunemaker/flipper/pull/587).
+* Rails 7 support (mostly in https://github.com/jnunemaker/flipper/pull/592).
+
+## 0.22.2
+
+### Additions/Changes
+
+* Allow adding multiple actors at once in flipper-ui via comma separation (configurable via `Flipper::UI.configuration.actors_separator`) (https://github.com/jnunemaker/flipper/pull/556)
+
+### Bug Fixes
+
+* Fix railtie initialization to avoid altering middleware order (https://github.com/jnunemaker/flipper/pull/563)
+
+## 0.22.1
+
+### Additions/Changes
+
+* Remove Octicons and replace with a pure CSS status circle (https://github.com/jnunemaker/flipper/pull/547)
+* Rescue unique errors in AR and Sequel when setting value (https://github.com/jnunemaker/flipper/commit/87f5a98bce7baad7a27b75b5bce3256967769f27)
+* Add a Content-Security-Policy to flipper-ui (https://github.com/jnunemaker/flipper/pull/552)
+* Fix Synchronizer issue that occurs for ActiveRecord adapter (https://github.com/jnunemaker/flipper/pull/554)
+
+## 0.22.0
+
+### Additions/Changes
+
+* Enable log subscriber by default in Rails (https://github.com/jnunemaker/flipper/pull/525)
+* Remove memoizer from API and UI (https://github.com/jnunemaker/flipper/pull/527). If you are using the UI or API without configuring the default instance of Flipper, you'll need to enable memoization if you want it. For examples, see the examples/ui and examples/api directories.
+* Fix SQL reserved word use in get_all for ActiveRecord and Sequel (https://github.com/jnunemaker/flipper/pull/536).
+* Handle spaces in names gracefully in UI (https://github.com/jnunemaker/flipper/pull/541).
+
+## 0.21.0
+
+### Additions/Changes
+
+* Default to using memory adapter (https://github.com/jnunemaker/flipper/pull/501)
+* Adapters now configured on require when possible (https://github.com/jnunemaker/flipper/pull/502)
+* Added cloud recommendation to flipper-ui. Can be disabled with `Flipper::UI.configure { |config| config.cloud_recommendation = false }`. Just want to raise awareness that more is available if people want it (https://github.com/jnunemaker/flipper/pull/504)
+* Added default `flipper_id` implementation via `Flipper::Identifier` and automatically included it in ActiveRecord and Sequel models (https://github.com/jnunemaker/flipper/pull/505)
+* Deprecate superflous sync_method setting (https://github.com/jnunemaker/flipper/pull/511)
+* Flipper is now pre-configured when used with Rails. By default, it will [memoize and preload all features for each request](https://flippercloud.io/docs/optimization#memoization). (https://github.com/jnunemaker/flipper/pull/506)
+
+### Upgrading
+
+You should be able to upgrade to 0.21 without any breaking changes. However, if you want to simplify your setup, you can remove some configuration that is now handled automatically:
+
+1. Adapters are configured when on require, so unless you are using caching or other customizations, you can remove adapter configuration.
+
+    ```diff
+    # config/initializers/flipper.rb
+    - Flipper.configure do |config|
+    -   config.default { Flipper.new(Flipper::Adapters::ActiveRecord.new) }
+    - end
+    ```
+
+2. `Flipper::Middleware::Memoizer` will be enabled by default -- including preloading. **Note**: You may want to disable preloading (see below) if you have > 100 features.
+
+    ```diff
+    # config/initializers/flipper.rb
+    - Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
+    -   preload: [:stats, :search, :some_feature]
+    + Rails.application.configure do
+    +   # Uncomment to configure which features to preload on all requests
+    +   # config.flipper.preload = [:stats, :search, :some_feature]
+    +   #
+    +   # Or, you may want to disable preloading entirely:
+    +   # config.flipper.preload = false
+    + end
+    ```
+
+3. `#flipper_id`, which is used to enable features for specific actors, is now defined by [Flipper::Identifier](lib/flipper/identifier.rb) on all ActiveRecord and Sequel models. You can remove your implementation if it is in the form of `ModelName;id`.
+
+4. When using `flipper-cloud`, The `Flipper::Cloud.app` webhook receiver is now mounted at `/_flipper` by default.
+
+    ```diff
+    # config/routes.rb
+    - mount Flipper::Cloud.app, at: "/_flipper"
+    ```
+
+## 0.20.4
+
+### Additions/Changes
+
+* Allow actors and time gates to deal with decimal percentages (https://github.com/jnunemaker/flipper/pull/492)
+* Change Flipper::Cloud::Middleware to receive webhooks at / in addition to /webhooks.
+* Add `write_through` option to ActiveSupportCacheStore adapter to support write-through caching (https://github.com/jnunemaker/flipper/pull/512)
+
+## 0.20.3
+
+### Additions/Changes
+
+* Changed the internal structure of how the memory adapter stores things.
+
+## 0.20.2
+
+### Additions/Changes
+
+* Http adapter now raises error when enable/disable/add/remove/clear fail.
+* Cloud adapter sends some extra info like hostname, ruby version, etc. for debugging and decision making.
+
+## 0.20.1
+
+### Additions/Changes
+
+* Just a minor tweak to cloud webhook middleware to provide more debugging information about why a hook wasn't successful.
+
+## 0.20.0
+
+### Additions/Changes
+
+* Add support for webhooks to `Flipper::Cloud` (https://github.com/jnunemaker/flipper/pull/489).
+
+## 0.19.1
+
+### Additions/Changes
+
+* Bump rack-protection version to < 2.2 (https://github.com/jnunemaker/flipper/pull/487)
+* Add memoizer_options to Flipper::Api.app (https://github.com/jnunemaker/flipper/commit/174ad4bb94046a25c432d3c53fe1ff9f5a76d838)
+
+## 0.19.0
+
+### Additions/Changes
+
+* 100% of actors is now considered conditional. Feature#on?, Feature#conditional?, Feature#state would all be affected. See https://github.com/jnunemaker/flipper/issues/463 for more.
+* Several doc updates.
+
+## 0.18.0
+
+### Additions/Changes
+
+* Add support for feature descriptions to flipper-ui (https://github.com/jnunemaker/flipper/pull/461).
+* Remove rubocop (https://github.com/jnunemaker/flipper/pull/469).
+* flipper-ui redesign (https://github.com/jnunemaker/flipper/pull/470).
+* Removed support for ruby 2.4.
+* Added support for ruby 2.7.
+* Removed support for Rails 4.x.x.
+* Removed support for customizing actors, groups, % of actors and % of time text in flipper-ui in favor of automatic and more descriptive text.
+
+## 0.17.2
+
+### Additions/Changes
+
+* Avoid errors on import when there are no features and shared specs/tests for get all with no features (https://github.com/jnunemaker/flipper/pull/441 and https://github.com/jnunemaker/flipper/pull/442)
+* ::ActiveRecord::RecordNotUnique > ActiveRecord::RecordNotUnique (https://github.com/jnunemaker/flipper/pull/444)
+* Clear gate values on enable (https://github.com/jnunemaker/flipper/pull/454)
+* Remove use of multi from redis adapter (https://github.com/jnunemaker/flipper/pull/451)
+
+## 0.17.1
+
+* Fix require in flipper-active_record (https://github.com/jnunemaker/flipper/pull/437)
+
+## 0.17.0
+
+### Additions/Changes
+
+* Allow shorthand block notation on group types (https://github.com/jnunemaker/flipper/pull/406)
+* Relax active record/support constraints to support Rails 6 (https://github.com/jnunemaker/flipper/pull/409)
+* Allow disabling fun (https://github.com/jnunemaker/flipper/pull/413)
+* Include thing_value in payload of Instrumented#enable and #disable (https://github.com/jnunemaker/flipper/pull/417)
+* Replace Erubis with Erubi (https://github.com/jnunemaker/flipper/pull/407)
+* Allow customizing Rack::Protection middleware list (https://github.com/jnunemaker/flipper/pull/385)
+* Allow setting write_timeout for ruby 2.6+ (https://github.com/jnunemaker/flipper/pull/433)
+* Drop support for Ruby 2.1, 2.2, and 2.3 (https://github.com/jnunemaker/flipper/commit/cf58982e70de5e6963b018ceced4f36a275f5b5d)
+* Add support for Ruby 2.6 (https://github.com/jnunemaker/flipper/commit/57888311449ec81184d3d47ba9ae5cb1ad4a2f45)
+* Remove support for Rails 3.2 (https://github.com/jnunemaker/flipper/commit/177c48c4edf51d4e411e7c673e30e06d1c66fb40)
+* Add write_timeout for flipper http adapter for ruby 2.6+ (https://github.com/jnunemaker/flipper/pull/433)
+* Relax moneta version to allow for < 1.2 (https://github.com/jnunemaker/flipper/pull/434).
+* Improve active record idempotency (https://github.com/jnunemaker/flipper/pull/436).
+* Allow customizing add actor placeholder text (https://github.com/jnunemaker/flipper/commit/5faa1e9cf66b68f8227d2f8408fb448a14676c45)
+
+## 0.16.2
+
+### Additions/Changes
+
+* Bump rollout redis dependency to < 5 (https://github.com/jnunemaker/flipper/pull/403)
+* Bump redis dependency to < 5 (https://github.com/jnunemaker/flipper/pull/401)
+* Bump sequel dependency to < 6 (https://github.com/jnunemaker/flipper/pull/399 and https://github.com/jnunemaker/flipper/commit/edc767e69b4ce8daead9801f38e0e8bf6b238765)
+
+## 0.16.1
+
+### Additions/Changes
+
+* Add actors API endpoint (https://github.com/jnunemaker/flipper/pull/372).
+* Fix rack body proxy require for those using flipper without rack  (https://github.com/jnunemaker/flipper/pull/376).
+* Unescapes feature_name in FeatureNameFromRoute (https://github.com/jnunemaker/flipper/pull/377).
+* Replace delete_all with destroy_all in ActiveRecord adapter (https://github.com/jnunemaker/flipper/pull/395)
+* Target correct bootstrap breakpoints in flipper UI (https://github.com/jnunemaker/flipper/pull/396)
+
+## 0.16.0
+
+### Bug Fixes
+
+* Support slashes in feature names (https://github.com/jnunemaker/flipper/pull/362).
+
+### Additions/Changes
+
+* Re-order gates for improved performance in some cases (https://github.com/jnunemaker/flipper/pull/370).
+* Add Feature#exist?, DSL#exist? and Flipper#exist? (https://github.com/jnunemaker/flipper/pull/371).
+
+## 0.15.0
+
+* Move Flipper::UI configuration options to Flipper::UI::Configuration (https://github.com/jnunemaker/flipper/pull/345).
+* Bug fix in adapter synchronizing and switched DSL#import to use Synchronizer (https://github.com/jnunemaker/flipper/pull/347).
+* Fix AR adapter table name prefix/suffix bug (https://github.com/jnunemaker/flipper/pull/350).
+* Allow feature names to end with "features" in UI (https://github.com/jnunemaker/flipper/pull/353).
+
+## 0.14.0
+
+* Changed sync_interval to be seconds instead of milliseconds.
+
+## 0.13.0
+
+### Additions/Changes
+
+* Update PStore adapter to allow setting thread_safe option (https://github.com/jnunemaker/flipper/pull/334).
+* Update Flipper::UI to Bootstrap 4 (https://github.com/jnunemaker/flipper/pull/336).
+* Add Flipper::UI configuration to add a banner with customizeable text and background color (https://github.com/jnunemaker/flipper/pull/337).
+* Add sync adapter (https://github.com/jnunemaker/flipper/pull/341).
+* Make cloud use sync adapter (https://github.com/jnunemaker/flipper/pull/342). This makes local flipper operations resilient to cloud failures.
+
 ## 0.12.2
 
 ### Additions/Changes
@@ -8,7 +268,7 @@
 
 ### Additions/Changes
 
-* Added rollout adapter documentation (https://github.com/jnunemaker/flipper/pull/328).  
+* Added rollout adapter documentation (https://github.com/jnunemaker/flipper/pull/328).
 
 ### Bug Fixes
 
@@ -142,8 +402,8 @@
 
 * Added Flipper.groups and Flipper.group_names
 * Changed percentage_of_random to percentage_of_time
-* Added enable/disable convenience methods for all gates (ie: enable_group, enable_actor, enable_percentage_of_actors, enable_percentage_of_time)
-* Added value convenience methods (ie: boolean_value, groups_value, actors_value, etc.)
+* Added enable/disable convenience methods for all gates (enable_group, enable_actor, enable_percentage_of_actors, enable_percentage_of_time)
+* Added value convenience methods (boolean_value, groups_value, actors_value, etc.)
 * Added Feature#gate_values for getting typecast adapter gate values
 * Added Feature#enabled_gates and #disabled_gates for getting the gates that are enabled/disabled for the feature
 * Remove Feature#description

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.2.5
+FROM ruby:3.0
 
 RUN apt-get update && apt-get install -y \
   # build-essential \

data/Gemfile

@@ -7,26 +7,23 @@ Dir['flipper-*.gemspec'].each do |gemspec|
 end
 
 gem 'pry'
-gem 'rake', '~> 10.4.2'
+gem 'rake', '~> 12.3.3'
 gem 'shotgun', '~> 0.9'
 gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
-gem 'sqlite3', '~> 1.3.11'
-gem 'rails', "~> #{ENV['RAILS_VERSION'] || '5.1.4'}"
-gem 'minitest', '~> 5.8.0'
-gem 'rubocop', '~> 0.45.0'
-gem 'rubocop-rspec', '= 1.5.1'
-gem 'webmock', '~> 2.0'
-
-# for active support tests in test/ and only needed for ruby 2.2.x
-gem 'test-unit', '~> 3.0'
+gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.0'}"
+gem 'minitest', '~> 5.8'
+gem 'minitest-documentation'
+gem 'webmock', '~> 3.0'
+gem 'ice_age'
+gem 'redis-namespace'
+gem 'webrick'
 
 group(:guard) do
-  gem 'guard', '~> 2.12.5'
-  gem 'guard-rspec', '~> 4.5.0'
-  gem 'guard-bundler', '~> 2.1.0'
-  gem 'guard-coffeescript', '~> 2.0.1'
-  gem 'guard-sass', '~> 1.6.0'
-  gem 'rb-fsevent', '~> 0.9.4'
+  gem 'guard', '~> 2.15'
+  gem 'guard-rspec', '~> 4.5'
+  gem 'guard-bundler', '~> 2.2'
+  gem 'rb-fsevent', '~> 0.9'
 end

data/README.md

@@ -1,25 +1,19 @@
-![flipper logo](https://raw.githubusercontent.com/jnunemaker/flipper/master/lib/flipper/ui/public/images/logo.png)
-
-<pre>
-                                   __
-                               _.-~  )
-                    _..--~~~~,'   ,-/     _
-                 .-'. . . .'   ,-','    ,' )
-               ,'. . . _   ,--~,-'__..-'  ,'
-             ,'. . .  (@)' ---~~~~      ,'
-            /. . . . '~~             ,-'
-           /. . . . .             ,-'
-          ; . . . .  - .        ,'
-         : . . . .       _     /
-        . . . . .          `-.:
-       . . . ./  - .          )
-      .  . . |  _____..---.._/ _____
-~---~~~~----~~~~             ~~
-</pre>
-
-Feature flipping is the act of enabling or disabling features or parts of your application, ideally without re-deploying or changing anything in your code base.
-
-The goal of this gem is to make turning features on or off so easy that everyone does it. Whatever your data store, throughput, or experience, feature flipping should be easy and have minimal impact on your application.
+[![Flipper Mark](docs/images/banner.jpg)](https://www.flippercloud.io)
+
+[Website](https://flippercloud.io) | [Documentation](https://flippercloud.io/docs) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud)
+
+# Flipper
+
+> Beautiful, performant feature flags for Ruby.
+
+Flipper gives you control over who has access to features in your app.
+
+* Enable or disable features for everyone, specific actors, groups of actors, a percentage of actors, or a percentage of time.
+* Configure your feature flags from the console or a web UI.
+* Regardless of what data store you are using, Flipper can performantly store your feature flags.
+* Use [Flipper Cloud](#flipper-cloud) to cascade features from multiple environments, share settings with your team, control permissions, keep an audit history, and rollback.
+
+Control your software &mdash; don't let it control you.
 
 ## Installation
 
@@ -27,6 +21,10 @@ Add this line to your application's Gemfile:
 
     gem 'flipper'
 
+You'll also want to pick a storage [adapter](https://flippercloud.io/docs/adapters), for example:
+
+    gem 'flipper-active_record'
+
 And then execute:
 
     $ bundle
@@ -35,60 +33,62 @@ Or install it yourself with:
 
     $ gem install flipper
 
-## Examples
-
-The goal of the API for flipper was to have everything revolve around features and what ways they can be enabled. Start with top level and dig into a feature, then dig in further and enable that feature for a given type of access, as opposed to thinking about how the feature will be accessed first (ie: `stats.enable` vs `activate_group(:stats, ...)`).
+## Subscribe &amp; Ship
 
-```ruby
-require 'flipper'
-require 'flipper/adapters/memory'
+[💌 &nbsp;Subscribe](https://buttondown.email/flipper) - I'll send you short and sweet emails when we release new versions.
 
-Flipper.configure do |config|
-  config.default do
-    # pick an adapter, this uses memory, any will do
-    adapter = Flipper::Adapters::Memory.new
+## Getting Started
 
-    # pass adapter to handy DSL instance
-    Flipper.new(adapter)
-  end
-end
+Use `Flipper#enabled?` in your app to check if a feature is enabled.
 
+```ruby
 # check if search is enabled
-if Flipper.enabled?(:search)
+if Flipper.enabled? :search, current_user
   puts 'Search away!'
 else
   puts 'No search for you!'
 end
+```
 
-puts 'Enabling Search...'
-Flipper.enable(:search)
+All features are disabled by default, so you'll need to explicitly enable them.
 
-# check if search is enabled
-if Flipper.enabled?(:search)
-  puts 'Search away!'
-else
-  puts 'No search for you!'
-end
+```ruby
+# Enable a feature for everyone
+Flipper.enable :search
+
+# Enable a feature for a specific actor
+Flipper.enable_actor :search, current_user
+
+# Enable a feature for a group of actors
+Flipper.enable_group :search, :admin
+
+# Enable a feature for a percentage of actors
+Flipper.enable_percentage_of_actors :search, 2
 ```
 
-Of course there are more [examples for you to peruse](examples/). You could also check out the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.
+Read more about [getting started with Flipper](https://flippercloud.io/docs) and [enabling features](https://flippercloud.io/docs/features).
+
+## Flipper Cloud
+
+Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io), which comes with:
+
+* **everything in one place** &mdash; no need to bounce around from different application UIs or IRB consoles.
+* **permissions** &mdash; grant access to everyone in your organization or lockdown each project to particular people.
+* **multiple environments** &mdash; production, staging, enterprise, by continent, whatever you need.
+* **personal environments** &mdash; no more rake scripts or manual enable/disable to get your laptop to look like production. Every developer gets a personal environment that inherits from production that they can override as they please ([read more](https://www.johnnunemaker.com/flipper-cloud-environments/)).
+* **no maintenance** &mdash; we'll keep the lights on for you. We also have handy webhooks for keeping your app in sync with Cloud, so **our availability won't affect yours**. All your feature flag reads are local to your app.
+* **audit history** &mdash; every feature change and who made it.
+* **rollbacks** &mdash; enable or disable a feature accidentally? No problem. You can roll back to any point in the audit history with a single click.
 
-## Docs
+[![Flipper Cloud Screenshot](docs/images/flipper_cloud.png)](https://www.flippercloud.io)
 
-* [Gates](docs/Gates.md) - Boolean, Groups, Actors, % of Actors, and % of Time
-* [Adapters](docs/Adapters.md) - Mongo, Redis, Cassandra, Active Record...
-* [Instrumentation](docs/Instrumentation.md) - ActiveSupport::Notifications and Statsd
-* [Optimization](docs/Optimization.md) - Memoization middleware and Cache adapters
-* [Web Interface](docs/ui/README.md) - Point and click...
-* [API](docs/api/README.md) - HTTP API interface
-* [Caveats](docs/Caveats.md) - Flipper beware! (see what I did there)
-* [Docker-Compose](docs/DockerCompose.md) - Using docker-compose in contributing
+Cloud is super simple to integrate with Rails ([demo app](https://github.com/fewerandfaster/flipper-rails-demo)), Sinatra or any other framework.
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Check your changes with Rubocop tests (`script/rubocop`)
+3. Run the tests (`bundle exec rake`). Check out [Docker-Compose](docs/DockerCompose.md) if you need help getting all the adapters running.
 4. Commit your changes (`git commit -am 'Added some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
@@ -104,5 +104,8 @@ Of course there are more [examples for you to peruse](examples/). You could also
 | pic | @mention | area |
 |---|---|---|
 | ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) | most things |
+| ![@bkeepers](https://avatars3.githubusercontent.com/u/173?s=64) | [@bkeepers](https://github.com/bkeepers) | most things |
+| ![@dpep](https://avatars3.githubusercontent.com/u/918804?s=64) | [@dpep](https://github.com/dpep) | tbd |
 | ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api |
+| ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64) | [@thetimbanks](https://github.com/thetimbanks) | ui |
 | ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64) | [@lazebny](https://github.com/lazebny) | docker |