https://github.com/fiverr/rollout_service

A Grape service that expose rollout gem via RESTful endpoints
https://github.com/fiverr/rollout_service

feature-revealer fiverr grape-service rollout rollout-gem rollout-service

Last synced: 9 days ago
JSON representation

A Grape service that expose rollout gem via RESTful endpoints

• Host: GitHub
• URL: https://github.com/fiverr/rollout_service
• Owner: fiverr
• Created: 2017-01-19T14:02:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-21T23:07:14.000Z (over 1 year ago)
• Last Synced: 2024-10-03T11:37:59.928Z (about 2 months ago)
• Topics: feature-revealer, fiverr, grape-service, rollout, rollout-gem, rollout-service
• Language: Ruby
• Homepage:
• Size: 60.5 KB
• Stars: 22
• Watchers: 78
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rollout-Service

**Rack app that exposes rollout gem API via RESTful endpoints**

This Rack app expose RESTfull endpoints that allows you to perform CRUD operation on [rollout](https://github.com/fetlife/rollout) gem.

This service works great with [Rollout-Dashboard](https://github.com/fiverr/rollout_dashboard) - a beautiful user interface for rollout gem) 

## How to use this app?

1. Pass a redis instance to the app

```ruby

redis = Redis.new

RolloutService::Config::configure do |config|

  config.redis = redis

end

```

2. Map an a route to the app:

```ruby

map '/api/v1' do

  run RolloutService::Service

end

```

## I want to run this service a stand alone service, how do I do that?

1. Include the gem 'rack-app' & 'rollout_service' in your project.

2. create a file named `config.ru`

```ruby

# Add here system configuration and initializations  

# Create a redis instance 

redis = Redis.new

# Pass the instance to rollout service

RolloutService::Config::configure do |config|

  config.redis = redis

end

# Map a route to the app

map '/api/v1' do

  run RolloutService::Service

end

```

## End-Points Documentation:

| Description   | END POINT     |

| ------------- | ------------- |

| Get all features  | GET /api/v1/features  |

| Get specific feature by name  | GET /api/v1/features/:feature_name  |

| Get specific feature by name  | GET /api/v1/features/:feature_name  |

| Check if feature is active  | GET /api/v1/features/:feature_name/:user_id/active  |

| Create a new feature  | POST /api/v1/features/:feature_name  |

| Partially update existing feature  | PATCH /api/v1/features/:feature_name  |

| Delete a feature  | DELETE /api/v1/features/:feature_name  |