swalidate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe97d384e09f73d2de99aa29853d792656a67e1
-  data.tar.gz: 450d059e60539ad1930f3065522cce1443605e12
+  metadata.gz: c3459b3c0c2f919ba4c550703f8398277a7b3869
+  data.tar.gz: 1d4bc1e86843aaf3f69874f97df329c4519b0785
 SHA512:
-  metadata.gz: d124d24c33f76db15a62c2ee6cc9104d8bfeedfea39cd4fead045caab74fbe567abe14bc53b69750dee62b0749e6c6147990fba00d4f394dc5f802ff42da2224
-  data.tar.gz: 19aaacc3e0fe2a4ce13f286f7ab1b838a996b8ab69b66a224b5de4e0b40eac6f360092245706de7aa8da6a7f1a1af541ef498ad328de563a755040d34bca832d
+  metadata.gz: cd7b44bf8a7ad42527403122cb12cbe38c9340a433e5ba92efbad604b606e38d458b89e11f5fa243e014c83a04a43fa18c3b221f8c663800e294df7777333134
+  data.tar.gz: aa91c4ad4bf33c4c220c000202f774c23fe6c46a3919954e6fd0cdc6d933551a34b2002a13d0e2f5d594378f502ff4060beeef06347c366165c2e2d9d0e84bc1

data/.rubocop.yml

@@ -0,0 +1,7 @@
+# require: rubocop-rspec
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -3,3 +3,5 @@ language: ruby
 rvm:
   - 2.2.1
 before_install: gem install bundler -v 1.14.3
+script:
+  rake spec rubocop

data/README.md

@@ -22,7 +22,14 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+swalidate_config = {
+  file_path:  'path.yaml', # swagger config file. example of app root
+  subdomain:  'api', # validation applies only to this subdomain
+  path_prefix: '/v1' # validation applies only to the paths starting with path_prefix
+}
+config.middleware.insert_after ActionDispatch::ParamsParser, Swalidate::Middleware, swalidate_config
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "swalidate"
+require 'bundler/setup'
+require 'swalidate'
 
 # 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.
@@ -10,5 +10,5 @@ require "swalidate"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/swalidate/endpoint.rb

@@ -0,0 +1,13 @@
+module Swalidate
+  class Endpoint
+    attr_reader :parameters
+
+    def initialize(detail)
+      @parameters = Array(detail && detail['parameters'])
+    end
+
+    def should_validate?
+      @parameters.any?
+    end
+  end
+end

data/lib/swalidate/middleware.rb

@@ -0,0 +1,51 @@
+module Swalidate
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @schema = Swalidate::Schema.new(options[:file_path])
+      # TODO: puts a log message when not found and dont try to validate
+
+      @subdomain   = options[:subdomain]
+      @path_prefix = options[:path_prefix]
+    end
+
+    def call(env)
+      @request  = ActionDispatch::Request.new(env)
+      @endpoint = @schema.endpoint(@request.method, @request.path.gsub(@path_prefix.to_s, '').sub(/\.[^.]+\z/, ''))
+
+      if should_validate?
+        validator = Swalidate::Validator::Main.new(@endpoint, @request.params)
+        validator.call
+        return error_response(validator.errors) unless validator.valid?
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def error_response(errors)
+      [
+        400,
+        { 'Content-Type' => 'application/vnd.api+json' },
+        [{ errors: errors }.to_json]
+      ]
+    end
+
+    def should_validate?
+      valid_subdomain? && valid_path_prefix? && valid_path?
+    end
+
+    def valid_subdomain?
+      @subdomain.to_s == @request.subdomain.to_s
+    end
+
+    def valid_path_prefix?
+      @request.path =~ Regexp.new(@path_prefix.to_s)
+    end
+
+    def valid_path?
+      @endpoint.should_validate?
+    end
+  end
+end

data/lib/swalidate/schema.rb

@@ -0,0 +1,17 @@
+module Swalidate
+  class Schema
+    attr_reader :paths, :definitions
+
+    def initialize(file_path)
+      swagger      = Swagger.load(file_path)
+      # TODO: error handling for files
+
+      @paths       = swagger.paths
+      @definitions = swagger.definitions
+    end
+
+    def endpoint(method, path)
+      Swalidate::Endpoint.new(paths[path] && paths[path][method.downcase])
+    end
+  end
+end

data/lib/swalidate/types/main.rb

@@ -0,0 +1,94 @@
+# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
+# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields-8
+
+require 'date'
+
+module Swalidate
+  module Types
+    class Main
+      attr_reader :param, :casted_value, :errors
+
+      def initialize(param, value)
+        @param        = param
+        @errors       = []
+        @casted_value = cast_value(value)
+      end
+
+      def valid?
+        return true if casted_value == 'NilObject.new'
+
+        # TODO:
+        # errors << {
+        #   parameter: param['name'],
+        #   message:   "'#{param['name']}' can be minimum #{param['minimum']}"
+        # }
+
+        case casted_value
+        when Numeric
+          if param['minimum'] && casted_value < param['minimum']
+            @errors << {
+              'message' => "'#{param['name']}' can be minimum #{param['minimum']}"
+            }
+          end
+          if param['maximum'] && casted_value > param['maximum']
+            @errors << {
+              'message' => "'#{param['name']}' can be maximum #{param['maximum']}"
+            }
+          end
+        when String
+          if param['minLength'] && casted_value.length < param['minLength']
+            @errors << {
+              'message' => "Length of '#{param['name']}' can be minimum #{param['minLength']}"
+            }
+          end
+          if param['maxLength'] && casted_value.length > param['maxLength']
+            @errors << {
+              'message' => "Length of '#{param['name']}' can be maximum #{param['maxLength']}"
+            }
+          end
+          if param['pattern'] && !(casted_value =~ Regexp.new(param['pattern']))
+            @errors << {
+              'message' => "'#{param['name']}' is not fit to pattern #{param['pattern']}"
+            }
+          end
+        end
+
+        errors.empty?
+      end
+
+      private
+
+      def cast_value(value)
+        return 'NilObject.new' unless value # TODO: create a NilObject class
+
+        begin
+          case param['type']
+          when 'integer' then Integer(value)
+          when 'number' then Float(value)
+          when 'string'
+            case param['format']
+            # TODO: date parsing: https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14
+            # 2015-02-01T00:00:00+00:00
+            # Date.rfc3339(value)
+            # DateTime.rfc3339(value)
+            when 'date' then Date.parse(value)
+            when 'date-time' then DateTime.parse(value)
+            else String(value)
+            end
+          when 'boolean' then %w(true false).include?(value.to_s) ? value : raise(ArgumentError)
+          else fail 'type is not valid' # TODO: handle this
+          end
+        rescue ArgumentError, TypeError => error
+          @errors << {
+            'message' => "'#{value}' is not a valid #{param['type']}"
+          }
+          nil
+        rescue StandardError => error
+          fail error
+          nil
+          # TODO: handle
+        end
+      end
+    end
+  end
+end

data/lib/swalidate/validator/main.rb

@@ -0,0 +1,31 @@
+module Swalidate
+  module Validator
+    class Main
+      attr_reader :endpoint_params, :request_params, :errors
+
+      def initialize(endpoint, request_params)
+        @endpoint_params = endpoint.parameters
+        @request_params  = request_params
+        @errors          = []
+      end
+
+      def call
+        # TODO: allow extra parameters?
+        endpoint_params.each do |param|
+          parameter = Swalidate::Validator::Parameter.new(param, request_params[param['name']])
+          if parameter.invalid?
+            @errors += parameter.errors
+          end
+        end
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def invalid?
+        !valid?
+      end
+    end
+  end
+end

data/lib/swalidate/validator/parameter.rb

@@ -0,0 +1,43 @@
+module Swalidate
+  module Validator
+    class Parameter
+      attr_reader :param, :value, :type
+
+      def initialize(param, value)
+        @param = param
+        @value = value
+        @type  = Swalidate::Types::Main.new(param, value)
+      end
+
+      def valid?
+        return false if required? && !exists?
+
+        if exists?
+          type.valid?
+        else
+          !required?
+        end
+      end
+
+      def errors
+        if exists?
+          type.errors
+        else
+          required? ? ["'#{param['name']}' can't be blank."] : []
+        end
+      end
+
+      def invalid?
+        !valid?
+      end
+
+      def required?
+        param['required']
+      end
+
+      def exists?
+        !!value
+      end
+    end
+  end
+end

data/lib/swalidate/version.rb

@@ -1,3 +1,3 @@
 module Swalidate
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

data/lib/swalidate.rb

@@ -1,4 +1,13 @@
-require "swalidate/version"
+require 'forwardable'
+require 'swagger'
+require 'action_dispatch'
+require 'swalidate/version'
+require 'swalidate/schema'
+require 'swalidate/endpoint'
+require 'swalidate/types/main'
+require 'swalidate/validator/parameter'
+require 'swalidate/validator/main'
+require 'swalidate/middleware'
 
 module Swalidate
   # Your code goes here...

data/swalidate.gemspec

@@ -4,15 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'swalidate/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "swalidate"
+  spec.name          = 'swalidate'
   spec.version       = Swalidate::VERSION
-  spec.authors       = ["Furkan Ayhan"]
-  spec.email         = ["furkanayhn@gmail.com"]
+  spec.authors       = ['Furkan Ayhan']
+  spec.email         = ['furkanayhn@gmail.com']
 
-  spec.summary       = "Rack validation middleware using Swagger"
-  spec.description   = "Rack validation middleware using Swagger"
-  spec.homepage      = "https://github.com/furkanayhan/swalidate"
-  spec.license       = "MIT"
+  spec.summary       = 'Rack validation middleware using Swagger'
+  spec.description   = 'Rack validation middleware using Swagger'
+  spec.homepage      = 'https://github.com/furkanayhan/swalidate'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -26,11 +26,16 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'actionpack'
+  spec.add_dependency 'swagger-core'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: swalidate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Furkan Ayhan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: swagger-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Rack validation middleware using Swagger
 email:
 - furkanayhn@gmail.com
@@ -61,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -69,7 +126,14 @@ files:
 - bin/console
 - bin/setup
 - lib/swalidate.rb
+- lib/swalidate/endpoint.rb
+- lib/swalidate/middleware.rb
+- lib/swalidate/schema.rb
+- lib/swalidate/types/main.rb
+- lib/swalidate/validator/main.rb
+- lib/swalidate/validator/parameter.rb
 - lib/swalidate/version.rb
+- swalidate-0.1.0.gem
 - swalidate.gemspec
 homepage: https://github.com/furkanayhan/swalidate
 licenses: