fakeit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981cca99f9c406f1d950151ec99a59c8301f35be503a1d987419561bab0bc431
-  data.tar.gz: fdafe0dc21b053068bb3f0abbc8556ecc8ebf73593b7fc3001fc5cd7774d97ef
+  metadata.gz: 37c7f01bd53d8fccce9dc5d1411a9917fca097614a2dafe8bd1498cf2f8bd255
+  data.tar.gz: b35468a6e2daf5749fbedb971026c264e23fe34b6d6a49c322c88cbe48a587de
 SHA512:
-  metadata.gz: 7a5d23a302090b85a6e86f3e07da55c39bb2ce5f6cd18d10d0513046f19102c99c72dc21a6b5fccd924b4e6af12c2ab0685d2d708507a5798f6211f1b46be028
-  data.tar.gz: 97ee27c6dff7b3452b97713058ba5a6891f1d82fe852e12e1fe39e59d17b32052ef1b5493ef94dbf9609b687b89fd2fe9fe685ec1ebbd8f9b4a3830ae75863b5
+  metadata.gz: 929e9c035ee1ebce9b5ad833f2b846c1835242d67534a9bec5456369685273cfcb3a7554c89f8802f1592fb66a6098d1e123f9ec90764e0ffba3f1924523e89c
+  data.tar.gz: eb310158c2228e0ecca7ece315dc12b1e52cad915ef68472c88884d555c05bd42d9b3351a9133d1aa0e52f80c899d4ef759ba9e893eeb5ffd6cce3975eacaf51

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    fakeit (0.1.1)
+    fakeit (0.1.2)
       faker (~> 1.9)
-      openapi_parser (= 0.2.4)
+      openapi_parser (= 0.3.0)
       rack (~> 2.0)
       slop (~> 4.6)
 
@@ -21,7 +21,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     json (2.2.0)
-    openapi_parser (0.2.4)
+    openapi_parser (0.3.0)
     parallel (1.17.0)
     parser (2.6.2.1)
       ast (~> 2.4.0)

data/README.md

@@ -15,23 +15,15 @@ Create mock server from Openapi specification
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'fakeit'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Install it with:
 
     $ gem install fakeit
 
+Or use the [docker image](https://hub.docker.com/r/realfengjia/fakeit)
+
 ## Usage
 
-    $ fakeit --spec http://url/to/spec
+    $ fakeit --spec <Local file or remote url>
 
 Command line options:
 
@@ -40,6 +32,8 @@ Command line options:
         --spec         spec file uri (required)
         -p, --port     custom port
         -q, --quiet    mute request and response log
+        --permissive   log validation error as warning instead of deny request
+        --use-example  use example provided in spec
 
     other options:
         -v, --version

data/bin/fakeit

@@ -9,6 +9,8 @@ begin
     o.string '--spec', 'spec file uri (required)', required: true
     o.integer '-p', '--port', 'custom port'
     o.bool '-q', '--quiet', 'mute request and response log'
+    o.bool '--permissive', 'log validation error as warning instead of deny request'
+    o.bool '--use-example', 'use example provided in spec'
     o.separator ''
     o.separator 'other options:'
     o.on '-v', '--version' do
@@ -38,6 +40,7 @@ trap(:INT) do
   end
 end
 
-app = Fakeit.build(opts[:spec])
-app.use(Fakeit::Middleware::Logger) unless opts[:quiet]
+options = Fakeit::App::Options.new(permissive: opts.permissive?, use_example: opts.use_example?)
+app = Fakeit.build(opts[:spec], options)
+app.use(Fakeit::Middleware::Recorder) unless opts.quiet?
 server.run(app, Port: opts[:port], Host: '0.0.0.0')

data/fakeit.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.16'
 
   spec.add_dependency 'faker', '~> 1.9'
-  spec.add_dependency 'openapi_parser', '0.2.4'
+  spec.add_dependency 'openapi_parser', '0.3.0'
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'slop', '~> 4.6'
 end

data/lib/fakeit.rb

@@ -4,14 +4,15 @@ require 'open-uri'
 require 'openapi_parser'
 require 'faker'
 require 'rack'
+require 'logger'
 
-Dir.glob(File.join(File.dirname(__FILE__), 'fakeit', '/**/*.rb')).each { |file| require file }
+Dir.glob(File.join(File.dirname(__FILE__), 'fakeit', '**/*.rb')).each { |file| require file }
 
 module Fakeit
   class << self
-    def build(spec_file)
+    def build(spec_file, options)
       Rack::Builder.new do
-        run App.create(spec_file)
+        run App.create(spec_file, options)
       end
     end
   end

data/lib/fakeit/app/app.rb

@@ -1,36 +1,43 @@
 module Fakeit
   module App
     class << self
-      def create(spec_file)
+      def create(spec_file, options)
         specification = Fakeit::Openapi.load(spec_file)
 
         proc do |env|
           request = Rack::Request.new(env)
           specification
-            .operation(request.request_method.downcase.to_sym, request.path_info)
-            &.tap { |operation| validate(operation, request) }
-            .then(&method(:rack_response))
-        rescue Fakeit::Validation::ValidationError => e
-          error_response(e)
+            .operation(request.request_method.downcase.to_sym, request.path_info, options)
+            .then { |operation| operation ? handle(operation, request, options) : not_found }
         end
       end
 
       private
 
-      def error_response(err)
-        { message: err.message }
-          .to_json
-          .then { |message| [418, { 'Content-Type' => 'application/json' }, [message]] }
-      end
-
-      def rack_response(operation)
-        if operation
-          [operation.status, operation.headers, [operation.body]]
+      def handle(operation, request, options)
+        validate(operation, request)
+        response(operation)
+      rescue Fakeit::Validation::ValidationError => e
+        if options.permissive
+          Fakeit::Logger.warn(e.message)
+          response(operation)
         else
-          [404, {}, ['Not Found']]
+          error(e)
         end
       end
 
+      def error(err)
+        [418, { 'Content-Type' => 'application/json' }, [{ message: err.message }.to_json]]
+      end
+
+      def not_found
+        [404, {}, ['Not Found']]
+      end
+
+      def response(operation)
+        [operation.status, operation.headers, [operation.body]]
+      end
+
       def validate(operation, request)
         operation.validate(
           body: request.body&.read.to_s,

data/lib/fakeit/app/options.rb

@@ -0,0 +1,12 @@
+module Fakeit
+  module App
+    class Options
+      attr_reader :permissive, :use_example
+
+      def initialize(permissive: false, use_example: false)
+        @permissive = permissive
+        @use_example = use_example
+      end
+    end
+  end
+end

data/lib/fakeit/core_extensions/schema.rb

@@ -1,37 +1,23 @@
+require 'fakeit/openapi/schema'
+
 module OpenAPIParser
   module Schemas
     class Schema
-      BIG_INT = 2**32
+      include Fakeit::Openapi::Schema
 
-      def to_example
-        case type
-        when 'string' then string_example
-        when 'integer' then integer_example
-        when 'number' then Faker::Number.decimal.to_f
-        when 'boolean' then Faker::Boolean.boolean
-        when 'array' then [items.to_example]
-        else # object
-          properties.each_with_object({}) { |(name, schema), obj| obj[name] = schema.to_example }
-        end
+      alias old_type type
+
+      def type
+        old_type || inferred_type
       end
 
       private
 
-      def integer_example
-        if enum
-          enum.to_a.sample
-        else
-          Faker::Number.between(minimum || 1, maximum || BIG_INT)
-        end
-      end
-
-      def string_example
-        if enum
-          enum.to_a.sample
-        elsif pattern
-          Faker::Base.regexify(pattern)
-        else
-          Faker::Book.title
+      def inferred_type
+        if properties
+          'object'
+        elsif items
+          'array'
         end
       end
     end

data/lib/fakeit/logger.rb

@@ -0,0 +1,4 @@
+module Fakeit
+  STDOUT.sync = true
+  Logger = ::Logger.new(STDOUT)
+end

data/lib/fakeit/middleware/{logger.rb → recorder.rb}

@@ -1,6 +1,6 @@
 module Fakeit
   module Middleware
-    class Logger
+    class Recorder
       def initialize(app)
         @app = app
       end
@@ -16,12 +16,12 @@ module Fakeit
 
       def log_request(env)
         env['rack.input']
-          &.tap { |body| puts "Request body: #{body.read}" }
+          &.tap { |body| Logger.info("Request body: #{body.read}") }
           &.tap { |body| body.rewind }
       end
 
       def log_response(response)
-        puts "Response body: #{response[2].first}"
+        Logger.info("Response body: #{response[2].first}")
       end
     end
   end

data/lib/fakeit/openapi/example/array_example.rb

@@ -0,0 +1,13 @@
+module Fakeit
+  module Openapi
+    module Example
+      MAX_SIZE = 50
+
+      def array_example(use_example)
+        Array.new(Faker::Number.between(minItems || 1, maxItems || MAX_SIZE)) do
+          items.to_example(use_example)
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/example/boolean_example.rb

@@ -0,0 +1,9 @@
+module Fakeit
+  module Openapi
+    module Example
+      def boolean_example
+        Faker::Boolean.boolean
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/example/integer_example.rb

@@ -0,0 +1,33 @@
+module Fakeit
+  module Openapi
+    module Example
+      BIG_INT = 2**32
+
+      def integer_example
+        if enum
+          enum.to_a.sample
+        else
+          Faker::Number.between(min_int, max_int)
+        end
+      end
+
+      private
+
+      def min_int
+        if minimum
+          exclusiveMinimum ? minimum + 1 : minimum
+        else
+          1
+        end
+      end
+
+      def max_int
+        if maximum
+          exclusiveMaximum ? maximum - 1 : maximum
+        else
+          BIG_INT
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/example/number_example.rb

@@ -0,0 +1,21 @@
+module Fakeit
+  module Openapi
+    module Example
+      BIG_NUM = 2**32
+
+      def number_example
+        Faker::Number.between(min_num, max_num).round(2)
+      end
+
+      private
+
+      def min_num
+        (minimum || 0).to_f.ceil(2)
+      end
+
+      def max_num
+        (maximum || BIG_NUM).to_f.floor(2)
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/example/object_example.rb

@@ -0,0 +1,9 @@
+module Fakeit
+  module Openapi
+    module Example
+      def object_example(use_example)
+        properties.each_with_object({}) { |(name, schema), obj| obj[name] = schema.to_example(use_example) }
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/example/string_example.rb

@@ -0,0 +1,45 @@
+module Fakeit
+  module Openapi
+    module Example
+      FORMAT_HANDLERS = {
+        'uri' => -> { Faker::Internet.url },
+        'uuid' => -> { SecureRandom.uuid },
+        'email' => -> { Faker::Internet.email },
+        'date' => -> { Faker::Date.backward(100).iso8601 },
+        'date-time' => -> { Faker::Time.backward(100).iso8601 }
+      }.freeze
+
+      def string_example
+        if enum then enum.to_a.sample
+        elsif pattern then Faker::Base.regexify(pattern)
+        elsif format then string_format
+        elsif minLength || maxLength then string_with_length
+        else Faker::Book.title
+        end
+      end
+
+      private
+
+      def string_with_length
+        Faker::Internet.user_name(min_string_length..max_string_length)
+      end
+
+      def min_string_length
+        minLength || 0
+      end
+
+      def max_string_length
+        maxLength || min_string_length + 10
+      end
+
+      def string_format
+        (FORMAT_HANDLERS[format] || method(:unknown_format))[]
+      end
+
+      def unknown_format
+        Fakeit::Logger.warn("Unknown string format: #{format}")
+        'Unknown string format'
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/operation.rb

@@ -1,24 +1,29 @@
 module Fakeit
   module Openapi
     class Operation
-      def initialize(request_operation)
+      def initialize(request_operation, options)
         @request_operation = request_operation
         @validator = Fakeit::Validation::Validator.new(request_operation)
+        @options = options
       end
 
       def status
-        openapi_response.first.to_i
+        response.first.to_i
       end
 
       def headers
-        openapi_headers
-          &.map { |k, v| [k, v.schema.to_example] }
-          &.push(['Content-Type', openapi_content_type])
+        response_headers
+          &.map { |k, v| [k, v.schema.to_example(@options.use_example)] }
+          &.tap { |headers| headers.push(['Content-Type', response_content_type]) if response_content_type }
           .to_h
       end
 
       def body
-        openapi_schema&.schema&.to_example&.then(&JSON.method(:generate)).to_s
+        response_schema
+          &.schema
+          &.to_example(@options.use_example)
+          &.then(&JSON.method(:generate))
+          .to_s
       end
 
       def validate(**request_parts)
@@ -27,23 +32,23 @@ module Fakeit
 
       private
 
-      def openapi_content
-        openapi_response.last.content&.find { |k, _| k =~ %r{^application/.*json} }
+      def response_content
+        response.last.content&.find { |k, _| k =~ %r{^application/.*json} }
       end
 
-      def openapi_schema
-        openapi_content&.last
+      def response_schema
+        response_content&.last
       end
 
-      def openapi_content_type
-        openapi_content&.first
+      def response_content_type
+        response_content&.first
       end
 
-      def openapi_headers
-        openapi_response.last.headers
+      def response_headers
+        response.last.headers
       end
 
-      def openapi_response
+      def response
         @request_operation.operation_object.responses.response.min
       end
     end

data/lib/fakeit/openapi/schema.rb

@@ -0,0 +1,23 @@
+require 'fakeit/openapi/example/array_example'
+require 'fakeit/openapi/example/boolean_example'
+require 'fakeit/openapi/example/integer_example'
+require 'fakeit/openapi/example/number_example'
+require 'fakeit/openapi/example/object_example'
+require 'fakeit/openapi/example/string_example'
+
+module Fakeit
+  module Openapi
+    module Schema
+      include Fakeit::Openapi::Example
+
+      def to_example(use_example = false)
+        return example if use_example && example
+
+        case type
+        when 'string', 'integer', 'number', 'boolean' then send("#{type}_example")
+        when 'array', 'object' then send("#{type}_example", use_example)
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/specification.rb

@@ -5,8 +5,10 @@ module Fakeit
         @doc = doc
       end
 
-      def operation(method, path)
-        @doc.request_operation(method, path)&.then(&Operation.method(:new))
+      def operation(method, path, options)
+        @doc
+          .request_operation(method, path)
+          &.then { |operation| Operation.new(operation, options) }
       end
     end
   end

data/lib/fakeit/validation/validator.rb

@@ -7,13 +7,34 @@ module Fakeit
 
       def validate(body: '', params: {}, headers: {})
         options = OpenAPIParser::SchemaValidator::Options.new(coerce_value: true)
+        body_data = parse(body)
 
-        @operation.validate_request_body('application/json', JSON.parse(body)) unless body.empty?
+        @operation.validate_request_body(request_content_type, body_data) if need_validate?(body_data)
         @operation.validate_path_params(options)
         @operation.validate_request_parameter(params, headers, options)
       rescue StandardError => e
         raise ValidationError, e.message
       end
+
+      private
+
+      def need_validate?(body_data)
+        request_content_type && body_data
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      rescue StandardError
+        nil
+      end
+
+      def request_content_type
+        request_body&.content&.find { |k, _| k =~ %r{^application/.*json} }&.first
+      end
+
+      def request_body
+        @operation.operation_object.request_body
+      end
     end
   end
 end

data/lib/fakeit/version.rb

@@ -1,3 +1,3 @@
 module Fakeit
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-26 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -185,10 +185,19 @@ files:
 - fakeit.gemspec
 - lib/fakeit.rb
 - lib/fakeit/app/app.rb
+- lib/fakeit/app/options.rb
 - lib/fakeit/core_extensions/schema.rb
-- lib/fakeit/middleware/logger.rb
+- lib/fakeit/logger.rb
+- lib/fakeit/middleware/recorder.rb
+- lib/fakeit/openapi/example/array_example.rb
+- lib/fakeit/openapi/example/boolean_example.rb
+- lib/fakeit/openapi/example/integer_example.rb
+- lib/fakeit/openapi/example/number_example.rb
+- lib/fakeit/openapi/example/object_example.rb
+- lib/fakeit/openapi/example/string_example.rb
 - lib/fakeit/openapi/loader.rb
 - lib/fakeit/openapi/operation.rb
+- lib/fakeit/openapi/schema.rb
 - lib/fakeit/openapi/specification.rb
 - lib/fakeit/validation/validation_error.rb
 - lib/fakeit/validation/validator.rb