rosebud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da9a1f5d401c5384749f7052be48eb0e95838e25
+  data.tar.gz: c79edafc75c00b50454731397d8ccdaa0a4605ac
+SHA512:
+  metadata.gz: 079c027c7bec034a23c64d4fc3c10ddbae749da9bfd16ebd792a369047984e0668086b11e1685b22977e9eb54fe8f23cd7bf3c91552a6189a79428e371c16045
+  data.tar.gz: 7666244fa192a67323daaf7d8fe02d56c2a4f16effde25be2c6785ef3785bc9caa2a4ab23beddfece452e9ae0f1d48bdd5e12023c32b355b65623e68ef13b8dd

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv*
+.rvmrc
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx

data/Gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rosebud.gemspec
+gemspec
+
+rails_version = case ENV['RAILS_VERSION'] || 'default'
+when 'master'
+  { git: 'https://github.com/rails/rails.git' }
+when 'default'
+  '~> 4.0'
+else
+  "~> #{ENV['RAILS_VERSION']}"
+end
+
+gem 'rails', rails_version
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubinius-coverage', github: 'rubinius/rubinius-coverage'
+  gem 'rubysl'
+end
+
+group :development do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anthony Smith
+
+MIT License
+
+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,145 @@
+# Rosebud
+
+Rails API parameter validation
+
+[![Build Status](https://travis-ci.org/anthonator/rosebud.png?branch=master)](https://travis-ci.org/anthonator/rosebud) [![Coverage Status](https://coveralls.io/repos/anthonator/rosebud/badge.png?branch=master)](https://coveralls.io/r/anthonator/rosebud?branch=master) [![Code Climate](https://codeclimate.com/github/anthonator/rosebud.png)](https://codeclimate.com/github/anthonator/rosebud)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rosebud'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rosebud
+
+## Usage
+
+### Getting Started
+
+Just include ```Rosebud``` in your Rails controller.
+
+```ruby
+class Api::V1::SomeController < Api::V1::ApplicationController
+  include Rosebud
+end
+```
+
+### Validating Parameters
+
+To validate parameters specify a ```params``` block and choose whether the params are required or optional.
+
+```ruby
+class Api::V1::SomeController < Api::V1::ApplicationController
+  include Rosebud
+  
+  params do
+    requires :name
+    optional :phone_number, regex: /\d{10}/, default: '5555555555'
+  end
+  
+  ...
+  
+end
+```
+
+It's also possible to define validations for a specific action.
+
+```ruby
+class Api::V1::SomeController < Api::V1::ApplicationController
+  include Rosebud
+  
+  params :create do
+    ...
+  end
+  
+  def create
+    ...
+  end
+end
+```
+
+### Rendering Errors
+
+When a parameter error is raised a JSON response will be rendered.
+
+```ruby
+{
+  "error":       "missing_parameter",
+  "description": "missing parameter: name"
+}
+```
+
+### Custom Validators
+
+Currently the only validators that ship with Rosebud are ```presence```, ```regex``` and ```type```. If you need other validators you can create your own.
+
+```ruby
+class MyLengthValidator < Rosebud::Validator
+  def validate_param(name, value, options)
+    if value.length <= options
+      error!(:length, param: name, length: value.length, max_length: options)
+    end
+  end
+end
+
+Rosebud::Validations.register_validator!(:length, MyLengthValidator)
+```
+
+Rosebud uses the [Errawr::Rails](http://www.github.com/anthonator/errawr-rails) gem to raise and render localised errors. Add your custom error message to your locale file.
+
+```yaml
+en:
+  errawr:
+    length:
+      message: %{length} characters is too long for %{param}, should be less than or equal to %{max_length}
+      http_status: 400
+      metadata:
+        additional_info: Kick him in the shins!
+```
+
+Add a validation using your custom validator:
+
+```ruby
+class Api::V1::SomeController < Api::V1::ApplicationController
+  include Rosebud
+  
+  params :create do
+    requires :name, length: 2
+  end
+  
+  def create
+    ...
+  end
+end
+```
+
+The following error will be rendered for the ```name``` parameter when provided with a value of ```abc```:
+
+```json
+{
+  "error":       "length",
+  "description": "3 characters is too long for name, should be less than or equal to 2",
+  "additional_info": "Kcik him in the shins!"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+[![Sticksnleaves](http://sticksnleaves-wordpress.herokuapp.com/wp-content/themes/sticksnleaves/images/snl-logo-116x116.png)](http://www.sticksnleaves.com)
+
+Rosebud is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
+
+Thanks to all of our [contributors](https://github.com/anthonator/rosebud/graphs/contributors)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/lib/rosebud.rb

@@ -0,0 +1,33 @@
+require 'errawr'
+require 'errawr/rails'
+require 'virtus'
+
+require 'rosebud/params_scope'
+require 'rosebud/validations'
+require 'rosebud/validator'
+require 'rosebud/version'
+
+I18n.load_path << "#{File.dirname(__FILE__)}/rosebud/locale/en.yml"
+I18n.reload!
+
+Dir[File.expand_path('../rosebud/validations/*.rb', __FILE__)].each do |path|
+  require(path)
+end
+
+module Rosebud
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send(:include, Errawr::Rails::Renderable.render_with(Errawr::Rails::Renderers::JSON))
+  end
+  
+  module ClassMethods
+    def params(action = :all, &block)
+      action = action.to_s
+      before_filter do
+        if action == 'all' || params[:action] == action
+          ParamsScope.new(self, params, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rosebud/locale/en.yml

@@ -0,0 +1,14 @@
+en:
+  errawr:
+    presence:
+      message: "missing parameter: %{param}"
+      name: "missing_parameter"
+      http_status: 400
+    type:
+      message: "invalid parameter: %{param}"
+      name: "invalid_parameter"
+      http_status: 400
+    regex:
+      message: "invalid parameter: %{param}"
+      name: "invalid_parameter"
+      http_status: 400

data/lib/rosebud/params_scope.rb

@@ -0,0 +1,35 @@
+module Rosebud
+  class ParamsScope
+    def initialize(controller, params, &block)
+      @controller = controller
+      @params = params
+      @declared_params = []
+      
+      instance_eval(&block)
+    end
+    
+    def requires(name, validations = {})
+      name = name.to_sym
+      validations.merge!({ presence: true })
+      
+      validate(name, @params[name], validations)
+    end
+    
+    def optional(name, options = {})
+      name = name.to_sym
+      if (@params[name].nil? || @params[name] == '') && options.has_key?(:default)
+        @params[name] = options.delete(:default)
+      end
+      validate(name, @params[name], options)
+    end
+    
+    private
+    def validate(attribute, value, validations)
+      validations.each do |type, options|
+        validator_class = Validations.validators[type]
+        raise("Validator #{type} is not registered...") unless validator_class
+        validator_class.new.validate_param(attribute, value, options)
+      end
+    end
+  end
+end

data/lib/rosebud/validations.rb

@@ -0,0 +1,17 @@
+module Rosebud
+  module Validations
+    @validators = {}
+    
+    class << self
+      attr_reader :validators
+    end
+    
+    def self.register_validator!(name, klass)
+      raise(ArgumentError, 'Validation class type expected to be a subclass of Rosebud::Validator...') unless klass.ancestors.include?(Validator)
+      raise(NotImplementedError, 'Validator expected validate_param to be implemented...') unless klass.instance_methods.include?(:validate_param)
+      name = name.to_sym
+      Errawr.register!(name)
+      @validators[name] = klass
+    end
+  end
+end

data/lib/rosebud/validations/presence_validator.rb

@@ -0,0 +1,11 @@
+module Rosebud
+  module Validations
+    class PresenceValidator < Validator
+      def validate_param(name, value, options)
+        error!(:presence, param: name) if value.nil? || value.strip == ''
+      end
+    end
+    
+    Validations.register_validator!(:presence, PresenceValidator)
+  end
+end

data/lib/rosebud/validations/regex_validator.rb

@@ -0,0 +1,11 @@
+module Rosebud
+  module Validations
+    class RegexValidator < Validator
+      def validate_param(name, value, pattern)
+        error!(:regex, param: name) if value && (value.to_s =~ pattern).nil?
+      end
+    end
+    
+    Validations.register_validator!(:regex, RegexValidator)
+  end
+end

data/lib/rosebud/validations/type_validator.rb

@@ -0,0 +1,29 @@
+module Rosebud
+  module Validations
+    class TypeValidator < Validator
+      def validate_param(name, value, type)
+        coerced_value = coerce_value(type, value)
+        error!(:type, param: name) unless valid_type?(type, coerced_value)
+      end
+      
+      private
+      def coerce_value(type, value)
+        coercer = Virtus::Attribute.build(type)
+        coercer.coerce(value)
+      end
+      
+      def valid_type?(type, value)
+        return true if value.nil?
+        if type == Virtus::Attribute::Boolean
+          value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        elsif type == Rack::Multipart::UploadedFile
+          value.key?(:tempfile)
+        else
+          value.is_a?(type)
+        end
+      end
+    end
+    
+    Validations.register_validator!(:type, TypeValidator)
+  end
+end

data/lib/rosebud/validator.rb

@@ -0,0 +1,9 @@
+module Rosebud
+  class Validator
+    include Errawr::ClassMethods
+    
+    def validate!(param)
+      validate_param(param)
+    end
+  end
+end

data/lib/rosebud/version.rb

@@ -0,0 +1,3 @@
+module Rosebud
+  VERSION = "0.1.0"
+end

data/rosebud.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rosebud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rosebud'
+  spec.version       = Rosebud::VERSION
+  spec.authors       = ['Anthony Smith']
+  spec.email         = ['anthony@sticksnleaves.com']
+  spec.description   = %q{Rails API parameter validation}
+  spec.summary       = %q{Finally! An easy way to validate your Rails API parameters.}
+  spec.homepage      = 'http://www.github.com/anthonator/rosebud'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'virtus',       '~> 1.0.0'
+  spec.add_runtime_dependency 'errawr',       '~> 1.1.5'
+  spec.add_runtime_dependency 'errawr-rails', '~> 1.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+end