https://github.com/uxxman/snaky_params

Rack middleware for Rails that automatically converts request parameter keys to snake_case.
https://github.com/uxxman/snaky_params

api rails ruby ruby-on-rails snake-case

Last synced: 13 days ago
JSON representation

Rack middleware for Rails that automatically converts request parameter keys to snake_case.

• Host: GitHub
• URL: https://github.com/uxxman/snaky_params
• Owner: uxxman
• License: mit
• Created: 2017-08-29T12:23:47.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-28T10:43:19.000Z (about 6 years ago)
• Last Synced: 2024-04-20T10:23:24.945Z (7 months ago)
• Topics: api, rails, ruby, ruby-on-rails, snake-case
• Language: Ruby
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# SnakyParams

[![Gem Version](https://badge.fury.io/rb/snaky_params.svg)](https://badge.fury.io/rb/snaky_params)

SnakyParams is Rack middleware for Rails that automatically converts request parameter keys to snake_case. 

This is useful if you Rails app is being used as an API for a front-end application written in any other language (e.g. JavaScript). In Ruby and Rails, the widely adopted naming convention is to use `snake_case` for variables, keys etc. Popular JavaScript style guides (such as the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)) tend to recommend camelCase. This gem allows you to use snake_case in all Ruby/Rails code without having to worry about converting the case of parameter names or having non-conventional names.

## Installation

1. Add this line to your application's Gemfile and execute `bundle install`:

```ruby

gem 'snaky_params'

```

2. Add this line **as the last config** to `config/application.rb`:

```ruby

config.middleware.use SnakyParams::Middleware

```

## Usage

Conversion is automatic. All query, post, put and patch parameter keys in requests to your Rails application are converted to snake_case.

Example:

- `searchQuery` becomes `search_query`

- `FirstName` becomes `first_name`

- `last-name` becomes `last_name`

- `monthlyOrYearlySalary` becomes `monthly_or_yearly_salary`

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/uxman-sherwani/snaky_params.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).