flipper 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2d0c40eaed262ab192fa672996ccdee0cc43aaa
-  data.tar.gz: 2c5117b307da9a9da90d85c820ce640494a8d865
+  metadata.gz: 47f1ba89a0c1968fcc2a07f210260f48df2c86e0
+  data.tar.gz: 0287caf882d254acb16259e617b73c663b01f64c
 SHA512:
-  metadata.gz: 0ffdb49402a659f33ab147f24450440afda3a08afefe7459dd5cb045e9fe4ff607015c277b9d4697603ac7190607e2d34181a8f44cdb44ba74642efe040a52fe
-  data.tar.gz: eef4104468dc78f364595081b77c27b17837383d916c7cb91486e4db42dd87449319d8eb38f4f611cddfdbbab463e0a60cc0290e303e2a03e5a766a582a2a46b
+  metadata.gz: be454d3e836cfc89e75767a56f0c460d31be2c6c7dfd0155943f732e14355c15ad6e5dc35b929231716b6316305aac9c58e82ea83adcc0053ba5aa5829f28a70
+  data.tar.gz: 88b93a792b1458b54c819e0d021ce2427c31079e5a3e9c926c6d74cf8702b1058a9e0a56dc203864ce3885b86114abc6dd6a44dbc120533fcf29d9b3d9f77c49

data/Changelog.md

@@ -1,3 +1,15 @@
+## 0.10.0
+
+* Added feature check context (https://github.com/jnunemaker/flipper/pull/158)
+* Do not use mass assignment for active record adapter (https://github.com/jnunemaker/flipper/pull/171)
+* Several documentation improvements
+* Make Flipper::UI.app.inspect return a String (https://github.com/jnunemaker/flipper/pull/176)
+* changes boolean gate route to api/v1/features/boolean (https://github.com/jnunemaker/flipper/pull/175)
+* add api v1 percentage_of_actors endpoint (https://github.com/jnunemaker/flipper/pull/179)
+* add api v1 percentage_of_time endpoint (https://github.com/jnunemaker/flipper/pull/180)
+* add api v1 actors gate endpoint  (https://github.com/jnunemaker/flipper/pull/181)
+* wait for activesupport to tell us when active record is loaded for active record adapter (https://github.com/jnunemaker/flipper/pull/192)
+
 ## 0.9.2
 
 * GET /api/v1/features

data/README.md

@@ -72,6 +72,7 @@ Of course there are more [examples for you to peruse](examples/). You could also
 * [Instrumentation](docs/Instrumentation.md) - ActiveSupport::Notifications, Statsd and Metriks
 * [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)
 
 ## Contributing
@@ -87,3 +88,10 @@ Of course there are more [examples for you to peruse](examples/). You could also
 1. Update the version to be whatever it should be and commit.
 2. `script/release`
 3. Profit.
+
+## Brought To You By
+
+| pic | @mention |
+|---|---|
+| ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) |
+| ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) |

data/docs/Adapters.md

@@ -8,7 +8,7 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 * [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
 * [Mongo adapter](https://github.com/jnunemaker/flipper/blob/master/docs/mongo)
 * [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
-* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3 and 4.
+* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
 * [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
 
 ## Community Supported

data/docs/api/README.md

@@ -0,0 +1,775 @@
+# Flipper::Api
+
+API for the [Flipper](https://github.com/jnunemaker/flipper) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-api
+
+## Usage
+
+`Flipper::Api` is a mountable application that can be included in your Rails/Ruby apps. In a Rails application, you can mount `Flipper::Api` to a route of your choice:
+
+```ruby
+# config/routes.rb
+YourRailsApp::Application.routes.draw do
+  mount Flipper::Api.app(flipper) => '/flipper-api'
+end
+```
+
+For more advanced mounting techniques and for suggestions on how to mount in a non-Rails application, it is recommend that you review the [`Flipper::UI` usage documentation](https://github.com/jnunemaker/flipper/blob/master/docs/ui/README.md#usage) as the same approaches apply to `Flipper::Api`.
+
+## Endpoints
+
+**Note:** Example CURL requests below assume a mount point of `/flipper-api`.
+
+### Get all features
+
+**URL**
+
+`GET /api/v1/features`
+
+**Request**
+
+```
+curl http://example.com/flipper-api/api/v1/features
+```
+
+**Response**
+
+Returns an array of feature objects:
+
+```json
+{
+  "features": [
+    {
+      "key": "search",
+      "state": "on",
+      "gates": [
+        {
+          "key": "boolean",
+          "name": "boolean",
+          "value": false
+        },
+        {
+          "key": "groups",
+          "name": "group",
+          "value": []
+        },
+        {
+          "key": "actors",
+          "name": "actor",
+          "value": []
+        },
+        {
+          "key": "percentage_of_actors",
+          "name": "percentage_of_actors",
+          "value": 0
+        },
+        {
+          "key": "percentage_of_time",
+          "name": "percentage_of_time",
+          "value": 0
+        }
+      ]
+    },
+    {
+      "key": "history",
+      "state": "off",
+      "gates": [
+        {
+          "key": "boolean",
+          "name": "boolean",
+          "value": false
+        },
+        {
+          "key": "groups",
+          "name": "group",
+          "value": []
+        },
+        {
+          "key": "actors",
+          "name": "actor",
+          "value": []
+        },
+        {
+          "key": "percentage_of_actors",
+          "name": "percentage_of_actors",
+          "value": 0
+        },
+        {
+          "key": "percentage_of_time",
+          "name": "percentage_of_time",
+          "value": 0
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Create a new feature
+
+**URL**
+
+`POST /api/v1/features`
+
+**Parameters**
+
+* `name` - The name of the feature (Recommended naming conventions: lower case, snake case, underscores over dashes. Good: foo_bar, foo. Bad: FooBar, Foo Bar, foo bar, foo-bar.)
+
+**Request**
+
+```
+curl -X POST -d "name=reports" http://example.com/flipper-api/api/v1/features
+```
+
+**Response**
+
+On successful creation, the API will respond with an empty JSON response.
+
+### Retrieve a feature
+
+**URL**
+
+`GET /api/v1/features/{feature_name}`
+
+**Parameters**
+
+* `feature_name` - The name of the feature to retrieve
+
+**Request**
+
+```
+curl http://example.com/flipper-api/api/v1/features/reports
+```
+
+**Response**
+
+Returns an individual feature object:
+
+```json
+{
+  "key": "search",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+
+### Delete a feature
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}`
+
+**Parameters**
+
+* `feature_name` - The name of the feature to delete
+
+**Request**
+
+```
+curl -X DELETE http://example.com/flipper-api/api/v1/features/reports
+```
+
+**Response**
+
+Successful deletion of a feature will return a 204 No Content response.
+
+## Gates
+
+The API supports enabling / disabling any of the Flipper [gates](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md). Gate endpoints follow the url convention:
+
+**enable**
+
+`POST /api/v1/{feature_name}/{gate_name}`
+
+**disable**
+
+`DELETE /api/v1/{feature_name}/{gate_name}`
+
+and on a succesful request return a 200 HTTP status and the feature object as the response body.
+
+### Boolean enable a feature
+
+**URL**
+
+`POST /api/v1/features/{feature_name}/boolean`
+
+**Parameters**
+
+* `feature_name` - The name of the feature to enable
+
+**Request**
+
+```
+curl -X POST http://example.com/flipper-api/api/v1/features/reports/boolean
+```
+
+**Response**
+
+Successful enabling of the boolean gate will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "on",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": true
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+
+
+### Boolean disable a feature
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}/boolean`
+
+**Parameters**
+
+* `feature_name` - The name of the feature to disable
+
+**Request**
+
+```
+curl -X DELETE http://example.com/flipper-api/api/v1/features/reports/boolean
+```
+
+**Response**
+
+Successful disabling of the boolean gate will return a 200 HTTP status and the feature object.
+
+```json
+{
+  "key": "reports",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+
+### Enable Group
+
+**URL**
+
+`POST /api/v1/features/{feature_name}/groups`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `name` - The name of a registered group to enable
+
+**Request**
+
+```
+curl -X POST -d "name=admins" http://example.com/flipper-api/api/v1/features/reports/groups
+```
+
+**Response**
+
+Successful enabling of the group will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "conditional",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": ["admins"]
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+
+### Disable Group
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}/groups`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `name` - The name of a registered group to disable
+
+**Request**
+
+```
+curl -X DELETE -d "name=admins" http://example.com/flipper-api/api/v1/features/reports/groups
+```
+
+**Response**
+
+Successful disabling of the group will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+### Enable Actor
+
+**URL**
+
+`POST /api/v1/features/{feature_name}/actors`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `flipper_id` - The flipper_id of actor to enable
+
+**Request**
+
+```
+curl -X POST -d "flipper_id=User:1" http://example.com/flipper-api/api/v1/features/reports/actors
+```
+
+**Response**
+
+Successful enabling of the actor will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "conditional",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": ["User:1"]
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+### Disable Actor
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}/actors`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `flipper_id` - The flipper_id of actor to disable
+
+**Request**
+
+```
+curl -X DELETE -d "flipper_id=User:1" http://example.com/flipper-api/api/v1/features/reports/actors
+```
+
+**Response**
+
+Successful disabling of the actor will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+
+### Enable Percentage of Actors
+
+**URL**
+
+`POST /api/v1/features/{feature_name}/percentage_of_actors`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `percentage` - The percentage of actors to enable
+
+**Request**
+
+```
+curl -X POST -d "percentage=20" http://example.com/flipper-api/api/v1/features/reports/percentage_of_actors
+```
+
+**Response**
+
+Successful enabling of a percentage of actors will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "conditional",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 20
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+### Disable Percentage of Actors
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}/percentage_of_actors`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+**Request**
+
+```
+curl -X DELETE http://example.com/flipper-api/api/v1/features/reports/percentage_of_actors
+```
+
+**Response**
+
+Successful disabling of a percentage of actors will set the percentage to 0 and return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```
+### Enable Percentage of Time
+
+**URL**
+
+`POST /api/v1/features/{feature_name}/percentage_of_time`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+* `percentage` - The percentage of time to enable
+
+**Request**
+
+```
+curl -X POST -d "percentage=20" http://example.com/flipper-api/api/v1/features/reports/percentage_of_time
+```
+
+**Response**
+
+Successful enabling of a percentage of time will return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "conditional",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 20
+    }
+  ]
+}
+```
+### Disable Percentage of Time
+
+**URL**
+
+`DELETE /api/v1/features/{feature_name}/percentage_of_time`
+
+**Parameters**
+
+* `feature_name` - The name of the feature
+
+**Request**
+
+```
+curl -X DELETE http://example.com/flipper-api/api/v1/features/reports/percentage_of_time
+```
+
+**Response**
+
+Successful disabling of a percentage of time will set the percentage to 0 and return a 200 HTTP status and the feature object as the response body.
+
+```json
+{
+  "key": "reports",
+  "state": "off",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": false
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": 0
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": 0
+    }
+  ]
+}
+```