https://github.com/faradayio/hangar
Use Rails/FactoryGirl factories from your frontend tests
https://github.com/faradayio/hangar
Last synced: about 1 year ago
JSON representation
Use Rails/FactoryGirl factories from your frontend tests
- Host: GitHub
- URL: https://github.com/faradayio/hangar
- Owner: faradayio
- License: mit
- Created: 2014-05-20T23:53:25.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2019-04-12T13:22:55.000Z (about 7 years ago)
- Last Synced: 2025-05-09T00:09:55.857Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 78.1 KB
- Stars: 55
- Watchers: 9
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Hangar
Hangar is a Rails Engine that exposes your [FactoryBot](https://github.com/thoughtbot/factory_girl) factories with a REST API available in the test environment only
## Install
Add Hangar to your application's Gemfile:
``` ruby
gem 'hangar', group: :test
```
## Requirements
Your application must use FactoryBot to manage its factories. Follow [FactoryBot's documentation](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md) to add factories to your application.
## Configuration
### Protecting tables from deletion
You may have special tables in your test database that should not be cleared by Hangar after a `DELETE /` request (see below in Usage). In this case, create an initializer in your app as follows:
``` ruby
# config/initializers/hangar.rb
Hangar.do_not_delete = %w(very_important_things valuable_bitcoin_keys spatial_ref_sys) if defined?(Hangar)
```
### Specifying DatabaseCleaner deletion strategy
Not all ORMs support the deletion strategy, such as mongoid. You can override the clean strategy being used by the `DELETE /factories` request as follows:
``` ruby
# config/initializers/hangar.rb
Hangar.clean_strategy = :truncation
```
### Namespace Routes
In some instances you may want to namespace the routes auto-generated by Hangar.
``` ruby
# config/initializers/hangar.rb
Hangar.route_namespace = :hangar
```
## Usage
Hangar will create two factory routes for each factory registered with FactoryBot. These routes mimic FactoryBot's `create` and `attributes_for` methods, respectively:
```
POST /posts
GET /posts/new
```
Both will respond with a JSON representation of the object.
Hangar also provides a route to clean the database after each test:
```
DELETE /
```
This returns 204 No Content when successful.
### Overriding Factory Attributes
You may override factory properties on your GET and POST requests using JSON as follows:
```
{ "post": { "title": "Dolor Sit Amet" } }
```
### Specifying Traits
You may specify factory traits on your GET and POST requests using JSON as follows:
To specify traits POST the JSON as follows:
```
{ "traits": ["published"] }
```
### Specifying Returned JSON Attributes
Specifying JSON attributes to return is the same as the ActiveModel::Serializer's as_json() include option. In the below examples, comments is a has_many association of our model.
To include associations POST the JSON as follows:
```
{ "include": "comments" }
```
To specify which attributes to include on associations, POST the JSON as follows:
{ "include": { "comments": { "only": "text" } } }
In this case, text is an attribute on our comments model.
### Headers
You must include the following headers with your requests:
```
Accept: application/json; charset=utf-8
Content-Type: application/json
Factory: hangar
```
## Security
Hangar is designed to run in the *test environment only*. A warning will be displayed if it is loaded in any other environment.
##For Contributors
Clone the github repository:
git clone https://github.com/faradayio/hangar.git
cd hangar
bundle install
Hangar's test suite runs against the included test application. Start that up with
rake spec
## Corporate support
We use `hangar` for [marketing analytics at Faraday](http://faraday.io).
## Copyright
Copyright 2014 Andy Rossmeissl