flipper 0.22.1 → 0.28.0

data/docs/http/README.md

@@ -1,36 +0,0 @@
-# Flipper Http
-
-HTTP adapter for use with the [Flipper Api](https://github.com/jnunemaker/flipper/blob/master/docs/api/README.md).
-
-Given you have [mounted](https://github.com/jnunemaker/flipper/blob/master/docs/api/README.md#user-content-usage) the Flipper Api on an application, you can use the HTTP adapter to interact with Flipper just like any other adapter, and internally it will handle all the http requests for you.  This means that you can have the application exposing the API store your Flipper data, but interact with it from other Ruby apps.
-
-Initialize the HTTP adapter with a configuration Hash.
-```ruby
-require 'flipper/adapters/http'
-
-Flipper.configure do |config|
-  config.adapter do
-    Flipper::Adapters::Http.new({
-      url: 'http://app.com/mount-point', # required
-      headers: { 'X-Custom-Header' => 'foo' },
-      basic_auth_username: 'user123',
-      basic_auth_password: 'password123'
-      read_timeout: 5,
-      open_timeout: 2,
-    })
-  end
-end
-```
-
-**Required keys**:
-* url: String url where [Flipper Api](https://github.com/jnunemaker/flipper/blob/master/docs/api/README.md) is mounted.
-
-**Optional keys**:
-*These will affect every request the adapter makes.  For example, send basic auth credentials with every request.*
-
-* headers: HTTP headers.
-* basic_auth_username:  Basic Auth username.
-* basic_auth_password: Basic Auth password.
-* read_timeout: [number in seconds](https://docs.ruby-lang.org/en/2.3.0/Net/HTTP.html#attribute-i-read_timeout).
-* open_timeout: [number in seconds](https://docs.ruby-lang.org/en/2.3.0/Net/HTTP.html#attribute-i-open_timeout).
-* debug_output: Set an output stream for debugging (e.g. `debug_output: $stderr`). The output stream is passed on to [Net::HTTP#set_debug_output](https://ruby-doc.org/stdlib-2.4.1/libdoc/net/http/rdoc/Net/HTTP.html#method-i-set_debug_output).

data/docs/read-only/README.md

@@ -1,24 +0,0 @@
-# Flipper read-only
-
-A [read-only](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/read_only.rb) adapter for [Flipper](https://github.com/jnunemaker/flipper).
-
-Use this adapter to wrap another adapter and raise an exception for any writes.
-
-Any attempted write raises `Flipper::Adapters::ReadOnly::WriteAttempted`  with message  `'write attempted while in read only mode'`
-
-## Usage
-
-```ruby
-# example wrapping memory adapter
-require 'flipper/adapters/read_only'
-
-Flipper.configure do |config|
-  config.adapter do
-    Flipper::Adapters::ReadOnly.new(Flipper::Adapters::Memory.new)
-  end
-end
-
-# Enabling a feature
-> Flipper[:dashboard_panel].enable
-=> Flipper::Adapters::ReadOnly::WriteAttempted: write attempted while in read only mode
-```