snaky_camel 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77d8a7e3a539175d2ccc689e219828cc966ba7cd
+  data.tar.gz: b88c6e39cd8ce56955a1e030015e99ee25ddf62a
+SHA512:
+  metadata.gz: 92edb808282d9915202a7bab3579afe740e2387cb42a6d9e1f2ac64a08414a819bb3bc3341c10ab430f84188143b84a6c87c4344130fb844931671d2fd9542b2
+  data.tar.gz: f0d9cd972c214e20e4c74851d20e550771fc8d7ad219292f70329d0f031f14bbb007fb154ab9b58350e20825c350cc5b3ead213b77e574e5024ab567fb4efcd5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snaky_camel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pavel Metelev
+
+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 @@
+# SnakyCamel
+
+SnakyCamel is Rack middleware for Rails that automatically converts request parameter keys to snake_case and response keys to camelCase. 
+
+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_camel'
+```
+
+2. Add this line **as the last config** to `config/application.rb`:
+
+```ruby
+config.middleware.use "SnakyCamel::Middleware"
+```
+
+## Usage
+
+Conversion is automatic. All parameter keys in RESTful requests to your Rails application are converted to snake_case. All JSON response keys from your Rails application are converted to camelCase. 
+
+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`.
+- You render JSON with your controller with this code: `render json: { search_results: ['dromedary'] }, status: :ok`. The actual response is converted to `{ searchResults: ['dromedary'] }`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/p4sh4/snaky_camel.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snaky_camel"
+
+# 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

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_camel.rb

@@ -0,0 +1,5 @@
+require "snaky_camel/version"
+
+module SnakyCamel
+  require "snaky_camel/middleware"
+end

data/lib/snaky_camel/exception.rb

@@ -0,0 +1,17 @@
+module SnakyCamel
+  module Exception
+    class BadResponseFormat < StandardError
+      def initialize(message = nil)
+        if message
+          @message = "Badly formed JSON response: #{message}"
+        else
+          @message = "Badly formed JSON response, check its format"
+        end
+      end
+
+      def to_s
+        @message
+      end
+    end
+  end
+end

data/lib/snaky_camel/middleware.rb

@@ -0,0 +1,37 @@
+module SnakyCamel
+  require 'snaky_camel/exception'
+
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      # Transforming request
+      request = Rack::Request.new(env)
+
+      request.GET.deep_transform_keys!{ |k| k.is_a?(String) ? k.underscore : k }
+      request.POST.deep_transform_keys!{ |k| k.is_a?(String) ? k.underscore : k }
+
+      # Transforming response
+      @app.call(env).tap do |status, headers, response|
+        if headers['Content-Type'] =~ /application\/json/
+          response.each do |res|
+            begin
+              new_response = JSON.parse(res)
+            rescue JSON::ParserError => e
+              message = e.to_s.gsub(/^\d+:\s/, '') # trim numeric code at the beginning of string
+              raise Exception::BadResponseFormat.new(message)
+            end
+            if new_response.is_a?(Array)
+              new_response.map!{ |h| h.deep_transform_keys! { |k| k.camelize(:lower) } }
+            else
+              new_response.deep_transform_keys! { |k| k.camelize(:lower) }
+            end
+            res.replace(new_response.to_json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snaky_camel/version.rb

@@ -0,0 +1,3 @@
+module SnakyCamel
+  VERSION = "0.0.2"
+end

data/snaky_camel.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_camel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snaky_camel"
+  spec.version       = SnakyCamel::VERSION
+  spec.authors       = ["Pavel Metelev"]
+  spec.email         = ["pavelmetelev@gmail.com"]
+
+  spec.summary       = %q{Automatically convert request param keys to snake_case and response keys to camelCase for Rails}
+  spec.description   = %q{Rack middleware for Rails that automatically converts request param keys to snake_case and response keys to camelCase helping you maintain a consistent code style in your Ruby and JavaScript code}
+  spec.homepage      = "https://github.com/p4sh4/snaky_camel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: snaky_camel
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pavel Metelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-11 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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rack middleware for Rails that automatically converts request param keys
+  to snake_case and response keys to camelCase helping you maintain a consistent code
+  style in your Ruby and JavaScript code
+email:
+- pavelmetelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/snaky_camel.rb
+- lib/snaky_camel/exception.rb
+- lib/snaky_camel/middleware.rb
+- lib/snaky_camel/version.rb
+- snaky_camel.gemspec
+homepage: https://github.com/p4sh4/snaky_camel
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automatically convert request param keys to snake_case and response keys
+  to camelCase for Rails
+test_files: []