snaky_params 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90fd08630e3dd80d107f27ab601e0ced1e730772
+  data.tar.gz: 357d8d26c1be9b8778844315664861449118abc6
+SHA512:
+  metadata.gz: c9c42058528894b19d1e9647fb652cce4bf5322cb5e0b43c10b7ad696e3cbe9047522a5520d2bbd01670e53c8974443e776cec390eb6d82611d99c6745724ba8
+  data.tar.gz: 53234e1067650e8b40f44b4d1b4285e2365c5cb1e3e543ea689f473b8091e79ff628394d1518f3ea252053cd03dac8946cb9ee550da249ac76cc4b5e38f211c4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in snaky_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Usman Sherwani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# SnakyParams
+
+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 JavaScript frontend. 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 and camelCase in JavaScript 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 parameter keys in requests to your Rails application are converted to snake_case.
+
+Example: 
+
+- Your application receives a request to `yourapp.com/search?searchQuery=cobra`. In the `params` hash in your Rails controller, the param key name will be `search_query`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uxman-sherwani/snake_params.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snaky_params"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/snaky_params.rb

@@ -0,0 +1,5 @@
+require "snaky_params/version"
+
+module SnakyParams
+  require "snaky_params/middleware"
+end

data/lib/snaky_params/middleware.rb

@@ -0,0 +1,17 @@
+module SnakyParams
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      # Transforming request
+      request = Rack::Request.new(env)
+      
+      request.GET.deep_transform_keys!(&:underscore)
+      request.POST.deep_transform_keys!(&:underscore)
+
+      @app.call(env)
+    end
+  end
+end

data/lib/snaky_params/version.rb

@@ -0,0 +1,3 @@
+module SnakyParams
+  VERSION = "2.2.0"
+end

data/snaky_params.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "snaky_params/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "snaky_params"
+  spec.version       = SnakyParams::VERSION
+  spec.authors       = ["Usman Sherwani"]
+  spec.email         = ["uxman.sherwani@gmail.com"]
+
+  spec.summary       = %q{Middleware to convert params to snake_case}
+  spec.description   = %q{Middleware to convert params to snake_case. Useful for APIs}
+  spec.homepage      = "https://github.com/uxman-sherwani/snake_params"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: snaky_params
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Usman Sherwani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Middleware to convert params to snake_case. Useful for APIs
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/snaky_params.rb
+- lib/snaky_params/middleware.rb
+- lib/snaky_params/version.rb
+- snaky_params.gemspec
+homepage: https://github.com/uxman-sherwani/snake_params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Middleware to convert params to snake_case
+test_files: []