weak_headers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf203e00553108f3d69b3c136d10da5bddd5350
+  data.tar.gz: db00cc1e2285b879f26e9957153472406312048c
+SHA512:
+  metadata.gz: e7f55552553450a498e87baf4bbd8ccf494831acad5b81c7fcc6e5aaa80385df5901eabba3090b6ee084fded12e85fa984bffaecb9590b3b0297f30e929c2c73
+  data.tar.gz: 95fe13d9c138fdaeefdd3abf92ea8e291da8bf64c7ee8b3eb33c871244f4a934b6c7e86157097b2d726e313951d36b59c924e4d17bbf0da995480cd8c0a0916a

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle/
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+log/*.log
+pkg
+pkg/
+rdoc
+spec/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/reports
+tmp

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+- Release the first version

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'pry-rails'
+  gem 'rspec-rails'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tadayuki Onishi
+
+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,51 @@
+# WeakHeaders
+Validates `request.headers` in your controller.
+
+## Notice
+I'm sorry, it is not yet written test.
+I'll add test as soon as possible.
+
+## Installation
+```ruby
+gem "weak_headers"
+```
+
+## Usage
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  rescue_from WeakHeaders::ValidationError do |e|
+    render json: { message: e.message }, status: 400
+  end
+end
+
+# WeakHeaders provides `validates_headers` class method to define validations.
+class AuthController < ApplicationController
+  validates_header :create do
+    requires 'X-App-Client-Id', except: ["token", "123456"]
+    optional :'X-App-Id', only: '1'
+    requires 'X-App-Client-Secret' do |value|
+      value =~ /\A\w{64}\z/
+    end
+  end
+
+  def create
+    auth = Application.authenticate(uid: request.headers['X-App-Client-Id'], secret: request.headers['X-App-Client-Secret'])
+    render json: { token: auth.token }
+  end
+end
+```
+
+### Available validators
+- requires
+- optional
+
+### Available options
+- only
+- except
+- handler
+
+## Inspired By
+- [weak_parameters](https://github.com/r7kamura/weak_parameters)
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/weak_headers.rb

@@ -0,0 +1,45 @@
+require 'action_controller'
+require 'active_support/hash_with_indifferent_access'
+
+require 'weak_headers/base_validator'
+require 'weak_headers/optional_validator'
+require 'weak_headers/requires_validator'
+require 'weak_headers/controller'
+require 'weak_headers/validation_error'
+require 'weak_headers/validator'
+require 'weak_headers/version'
+
+# Provides `validates_header` DSL to controllers to validate request headers.
+#
+# Examples
+#
+#   class AuthController < ApplicationController
+#     rescue_from WeakHeaders::ValidationError do |exception|
+#       render text: exception.message, status: 400
+#     end
+#
+#     validates_header :create do
+#       requires 'X-Test-Token'
+#       optional 'X-Test-Id'
+#     end
+#
+#     def create
+#       respond_with Auth.authenticate(token: request.headers['X-Test-Token'])
+#     end
+#   end
+#
+module WeakHeaders
+  def self.stats
+    @stats ||= ActiveSupport::HashWithIndifferentAccess.new do |hash, key|
+      hash[key] = ActiveSupport::HashWithIndifferentAccess.new
+    end
+  end
+
+  class Railties < ::Rails::Railtie
+    initializer 'weak_headers' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.extend WeakHeaders::Controller
+      end
+    end
+  end
+end

data/lib/weak_headers/base_validator.rb

@@ -0,0 +1,90 @@
+module WeakHeaders
+  class BaseValidator
+    def initialize(controller, key, options = {}, &block)
+      @controller = controller
+      @key        = key.to_s
+      @options    = options
+      @block      = block
+    end
+
+    def validate
+      handle_failure unless valid?
+    end
+
+    def type
+      self.class.name.split("::").last.sub(/Validator\z/, '').underscore.to_sym
+    end
+
+    private
+
+    def valid?
+      case
+      when requires? && blank?
+        false
+      when present? && exceptional?
+        false
+      when requires? && @block && !@block.call(value)
+        false
+      when optional? && present? && @block && !@block.call(value)
+        false
+      else
+        true
+      end
+    end
+
+    def headers
+      @controller.request.headers
+    end
+
+    def value
+      headers[@key]
+    end
+
+    def handle_failure
+      if has_handler?
+        @controller.send(@options[:handler])
+      else
+        raise_error
+      end
+    end
+
+    def blank?
+      headers.nil? || headers[@key].blank?
+    end
+
+    def present?
+      !blank?
+    end
+
+    def requires?
+      type == :requires
+    end
+
+    def optional?
+      type == :optional
+    end
+
+    def exceptional?
+      case
+        when @options[:only].try(:exclude?, value)
+          true
+        when @options[:except].try(:include?, value)
+          true
+        else
+          false
+      end
+    end
+
+    def raise_error
+      raise WeakHeaders::ValidationError, error_message
+    end
+
+    def error_message
+      "request.headers[#{@key.inspect}] must be a valid value"
+    end
+
+    def has_handler?
+      !!@options[:handler]
+    end
+  end
+end

data/lib/weak_headers/controller.rb

@@ -0,0 +1,14 @@
+module WeakHeaders
+  module Controller
+    def validates_header(action_name = nil, &block)
+      filter_option = {}
+      filter_option.merge!(only: action_name) unless action_name.nil?
+
+      before_filter filter_option do
+        validator = WeakHeaders::Validator.new(self, &block)
+        WeakHeaders.stats[params[:controller]][params[:action]] = validator
+        WeakHeaders.stats[params[:controller]][params[:action]].validate
+      end
+    end
+  end
+end

data/lib/weak_headers/optional_validator.rb

@@ -0,0 +1,4 @@
+module WeakHeaders
+  class OptionalValidator < WeakHeaders::BaseValidator
+  end
+end

data/lib/weak_headers/requires_validator.rb

@@ -0,0 +1,4 @@
+module WeakHeaders
+  class RequiresValidator < WeakHeaders::BaseValidator
+  end
+end

data/lib/weak_headers/validation_error.rb

@@ -0,0 +1,4 @@
+module WeakHeaders
+  class ValidationError < StandardError
+  end
+end

data/lib/weak_headers/validator.rb

@@ -0,0 +1,38 @@
+module WeakHeaders
+  class Validator
+    def initialize(controller, &block)
+      @controller = controller
+      instance_eval(&block)
+    end
+
+    def validate
+      validators.each(&:validate)
+    end
+
+    def validators
+      @validators ||= []
+    end
+
+    private
+
+    def with_validators(&block)
+      old_validators = @validators
+
+      begin
+        @validators = []
+        block.call
+        @validators
+      ensure
+        @validators = old_validators
+      end
+    end
+
+    def requires(key, options = {}, &block)
+      validators << WeakHeaders::RequiresValidator.new(@controller, key, options, &block)
+    end
+
+    def optional(key, options = {}, &block)
+      validators << WeakHeaders::OptionalValidator.new(@controller, key, options, &block)
+    end
+  end
+end

data/lib/weak_headers/version.rb

@@ -0,0 +1,3 @@
+module WeakHeaders
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'rails/all'
+require 'rspec/rails'
+
+require 'weak_headers'
+
+RSpec.configure do |config|
+  # If you"re not using ActiveRecord, or you"d prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/weak_headers.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'weak_headers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weak_headers'
+  spec.version       = WeakHeaders::VERSION
+  spec.authors       = ['Tadayuki Onishi']
+  spec.email         = ['tt.tanishi100@gmail.com']
+  spec.summary       = 'Add a validation headers filter to your controller.'
+  spec.homepage      = 'https://github.com/kenchan0103/weak_headers'
+  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_dependency 'rails', '>= 3.2.11'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: weak_headers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tadayuki Onishi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tt.tanishi100@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/weak_headers.rb
+- lib/weak_headers/base_validator.rb
+- lib/weak_headers/controller.rb
+- lib/weak_headers/optional_validator.rb
+- lib/weak_headers/requires_validator.rb
+- lib/weak_headers/validation_error.rb
+- lib/weak_headers/validator.rb
+- lib/weak_headers/version.rb
+- spec/spec_helper.rb
+- weak_headers.gemspec
+homepage: https://github.com/kenchan0103/weak_headers
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Add a validation headers filter to your controller.
+test_files:
+- spec/spec_helper.rb