fakeit 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35c58ad2d52ce6f2ba2375738faaed686b7945ce0d3e438d0d5e3e78f7d32d71
-  data.tar.gz: 4c9a1566b7256b2b5b8fb7772daf1329810644b646f2ac0c939d5a3fd824a8db
+  metadata.gz: 60b523cb9a2c8cea3454b35cace650d51f2bf8e2ed8e53e07b0f35ffe45c9288
+  data.tar.gz: a3340dafc8607d5de8e9cb7f00c9b60679e7f84bdd2161f8d8607dad2e6089b3
 SHA512:
-  metadata.gz: 0c3b0375ac956484083b108bb3284ccd33adda44e002b310b7e44fdb2ce151f1b62729a095f9caa02d2953d7dd809e4144fa33612756aa3189cee358e279ae18
-  data.tar.gz: 71e3391f4570e12b3c940476e0657e700088ef72f122ccf6e354e71e43ed47ef3d082e7d7f972fc5b35c3fb111aba38110b00d36725eaaafbaeb18750d6ebc96
+  metadata.gz: cfab31deab5494ae69b2adeecec85efff46d69104ad71ce0d637e4809a492bb7ac45062d8a73e5cd4adb34ad347ac798fecd05f4a1b3b00bab37a3b44adab511
+  data.tar.gz: c4ef907db3d2df3de0fed6bf5a54b904969b080f312951665b6cfe863c4c10ecf2f3d1e7bf5b712d668878aa2b9b3b1dda7539da927ac9cabea005fec2528509

data/CHANGELOG.md

@@ -0,0 +1,151 @@
+# Changelog
+
+## [v0.6.3](https://github.com/JustinFeng/fakeit/tree/v0.6.3) (2020-09-11)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.6.2...v0.6.3)
+
+**Implemented enhancements:**
+
+- Enhanced regex example generation
+
+## [v0.6.2](https://github.com/JustinFeng/fakeit/tree/v0.6.2) (2020-07-12)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.6.1...v0.6.2)
+
+## [v0.6.1](https://github.com/JustinFeng/fakeit/tree/v0.6.1) (2020-05-02)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.6.0...v0.6.1)
+
+## [v0.6.0](https://github.com/JustinFeng/fakeit/tree/v0.6.0) (2020-05-02)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.5.3...v0.6.0)
+
+**Implemented enhancements:**
+
+- Added support for multipart/form-data validation
+
+**Fixed bugs:**
+
+- Multipart request contain special character will respond 500 [\#16](https://github.com/JustinFeng/fakeit/issues/16)
+
+## [v0.5.3](https://github.com/JustinFeng/fakeit/tree/v0.5.3) (2020-04-05)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.5.2...v0.5.3)
+
+## [v0.5.2](https://github.com/JustinFeng/fakeit/tree/v0.5.2) (2020-04-03)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.5.1...v0.5.2)
+
+## [v0.5.1](https://github.com/JustinFeng/fakeit/tree/v0.5.1) (2020-04-03)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.5.0...v0.5.1)
+
+## [v0.5.0](https://github.com/JustinFeng/fakeit/tree/v0.5.0) (2020-04-03)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.4.2...v0.5.0)
+
+**Merged pull requests:**
+
+- Bump rack from 2.0.7 to 2.0.8 [\#18](https://github.com/JustinFeng/fakeit/pull/18) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.4.2](https://github.com/JustinFeng/fakeit/tree/v0.4.2) (2019-11-22)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.4.1...v0.4.2)
+
+## [v0.4.1](https://github.com/JustinFeng/fakeit/tree/v0.4.1) (2019-11-21)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.4.0...v0.4.1)
+
+**Merged pull requests:**
+
+- Bump rack-cors from 1.0.3 to 1.0.6 [\#17](https://github.com/JustinFeng/fakeit/pull/17) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.4.0](https://github.com/JustinFeng/fakeit/tree/v0.4.0) (2019-10-09)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.3.1...v0.4.0)
+
+**Implemented enhancements:**
+
+- Implement support for watching for changes in spec/yaml file. [\#15](https://github.com/JustinFeng/fakeit/issues/15)
+
+## [v0.3.1](https://github.com/JustinFeng/fakeit/tree/v0.3.1) (2019-09-01)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.3.0...v0.3.1)
+
+## [v0.3.0](https://github.com/JustinFeng/fakeit/tree/v0.3.0) (2019-08-27)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.2.1...v0.3.0)
+
+**Closed issues:**
+
+- Missing "motivation" section in readme [\#14](https://github.com/JustinFeng/fakeit/issues/14)
+
+## [v0.2.1](https://github.com/JustinFeng/fakeit/tree/v0.2.1) (2019-08-04)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.2.0...v0.2.1)
+
+**Implemented enhancements:**
+
+- Support .yaml files [\#9](https://github.com/JustinFeng/fakeit/issues/9)
+
+**Fixed bugs:**
+
+- Adjust integer generation bounds [\#12](https://github.com/JustinFeng/fakeit/issues/12)
+
+**Closed issues:**
+
+- End to End Tests [\#8](https://github.com/JustinFeng/fakeit/issues/8)
+
+**Merged pull requests:**
+
+- support .yaml files [\#10](https://github.com/JustinFeng/fakeit/pull/10) ([monsterkrampe](https://github.com/monsterkrampe))
+
+## [v0.2.0](https://github.com/JustinFeng/fakeit/tree/v0.2.0) (2019-07-17)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.1.5...v0.2.0)
+
+**Implemented enhancements:**
+
+- Generate more array elements with performance considered [\#7](https://github.com/JustinFeng/fakeit/issues/7)
+- Non random response [\#5](https://github.com/JustinFeng/fakeit/issues/5)
+
+**Fixed bugs:**
+
+- Invalid example for number type with more than 2 decimal places 'multipleOf' [\#6](https://github.com/JustinFeng/fakeit/issues/6)
+
+## [v0.1.5](https://github.com/JustinFeng/fakeit/tree/v0.1.5) (2019-06-28)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.1.4...v0.1.5)
+
+**Implemented enhancements:**
+
+- Allow CORS [\#4](https://github.com/JustinFeng/fakeit/pull/4) ([monsterkrampe](https://github.com/monsterkrampe))
+
+## [v0.1.4](https://github.com/JustinFeng/fakeit/tree/v0.1.4) (2019-06-25)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.1.3...v0.1.4)
+
+**Implemented enhancements:**
+
+- W, \[2019-06-25T03:00:29.635993 \#1\]  WARN -- : Unknown string format: guid [\#2](https://github.com/JustinFeng/fakeit/issues/2)
+
+**Fixed bugs:**
+
+- Request not completing [\#3](https://github.com/JustinFeng/fakeit/issues/3)
+- Stack level too deep in docker container [\#1](https://github.com/JustinFeng/fakeit/issues/1)
+
+## [v0.1.3](https://github.com/JustinFeng/fakeit/tree/v0.1.3) (2019-06-16)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.1.2...v0.1.3)
+
+## [v0.1.2](https://github.com/JustinFeng/fakeit/tree/v0.1.2) (2019-06-05)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.1.1...v0.1.2)
+
+## [v0.1.1](https://github.com/JustinFeng/fakeit/tree/v0.1.1) (2019-05-26)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/4f94874eaf87300496e9de632cd659a031cb3ce2...v0.1.1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fakeit (0.6.3)
+    fakeit (0.7.0)
       faker (= 2.13.0)
       openapi_parser (= 0.12.1)
       rack (~> 2.0)
@@ -82,4 +82,4 @@ DEPENDENCIES
   simplecov (~> 0.18)
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -48,13 +48,14 @@ Or use the [docker image](https://hub.docker.com/r/realfengjia/fakeit)
 
     $ fakeit --spec <Local file or remote url>
 
-Command line options:
+### Command line options
 
     $ fakeit --help
     usage:
         --spec               spec file uri (required)
         -p, --port           custom port
         -q, --quiet          mute request and response log
+        -l, --log-file       redirect log to a file
         --permissive         log validation error as warning instead of denying request
         --use-example        use example provided in spec if exists
         --static             generate static response
@@ -65,6 +66,29 @@ Command line options:
         -v, --version
         -h, --help
 
+### Configuration endpoint
+
+Mock server behaviour can be changed on the fly
+
+Retrieve current config:
+
+    GET /__fakeit_config__
+
+Update config:
+
+    PUT /__fakeit_config__
+
+Request and response:
+```json
+{
+  'permissive' => false,
+  'use_example' => true,
+  'static' => false,
+  'static_types' => ['integer'],
+  'static_properties' => ['id']
+}
+```
+
 **Notes:**
 * See [here](docs/random.md) for Openapi properties supported in random response generation
 * See [here](docs/static.md) for default value in static response generation

data/bin/fakeit

@@ -10,6 +10,7 @@ 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.string '-l', '--log-file', 'redirect log to a file'
     o.bool '--permissive', 'log validation error as warning instead of denying request'
     o.bool '--use-example', 'use example provided in spec if exists'
     o.bool '--static', 'generate static response'
@@ -53,6 +54,9 @@ options = Fakeit::App::Options.new(
 )
 app = Fakeit.build(opts[:spec], options)
 
+$stderr.reopen(File.new(opts[:log_file], File::WRONLY | File::TRUNC | File::CREAT)) if opts[:log_file]
+$stderr.sync = true
+
 app.use Rack::Cors do
   allow do
     origins '*'

data/lib/fakeit.rb

@@ -15,7 +15,7 @@ module Fakeit
   class << self
     def build(spec_file, options)
       Rack::Builder.new do
-        run App.create(spec_file, options)
+        run App::AppBuilder.new(spec_file, options).build
       end
     end
   end

data/lib/fakeit/app/app_builder.rb

@@ -0,0 +1,23 @@
+module Fakeit
+  module App
+    class AppBuilder
+      def initialize(spec_file, options)
+        @config_route = Routes::ConfigRoute.new(options)
+        @openapi_route = Routes::OpenapiRoute.new(spec_file)
+      end
+
+      def build
+        proc do |env|
+          request = Rack::Request.new(env)
+
+          case request.path_info
+          when '/__fakeit_config__'
+            @config_route.call(request)
+          else
+            @openapi_route.call(request, @config_route.options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/app/helpers/body_parser.rb

@@ -0,0 +1,32 @@
+module Fakeit
+  module App
+    module Helpers
+      class BodyParser
+        class << self
+          def parse(request)
+            case request.media_type
+            when %r{^application/.*json}
+              { media_type: request.media_type, data: parse_json(request.body.read) }
+            when 'multipart/form-data'
+              { media_type: request.media_type, data: parse_form_data(request.params) }
+            else
+              { media_type: request.media_type, data: request.body.read }
+            end
+          end
+
+          private
+
+          def parse_json(body)
+            body.empty? ? {} : JSON.parse(body)
+          rescue StandardError
+            raise Fakeit::Validation::ValidationError, 'Invalid json payload'
+          end
+
+          def parse_form_data(params)
+            params.transform_values { |v| v.class == Hash && v[:tempfile] ? v[:tempfile].read : v }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/app/helpers/response_builder.rb

@@ -0,0 +1,29 @@
+module Fakeit
+  module App
+    module Helpers
+      class ResponseBuilder
+        class << self
+          def error(code, err)
+            [code, { 'Content-Type' => 'application/json' }, [{ message: err.message }.to_json]]
+          end
+
+          def not_found
+            [404, {}, ['Not Found']]
+          end
+
+          def method_not_allowed
+            [405, {}, ['Method Not Allowed']]
+          end
+
+          def unsupported_media_type
+            [415, {}, ['Unsupported Media Type']]
+          end
+
+          def ok(body)
+            [200, { 'Content-Type' => 'application/json' }, [body.to_json]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/app/options.rb

@@ -14,6 +14,16 @@ module Fakeit
       def use_static?(type: nil, property: nil)
         @static || @static_types.include?(type) || @static_properties.include?(property)
       end
+
+      def to_hash
+        {
+          permissive: @permissive,
+          use_example: @use_example,
+          static: @static,
+          static_types: @static_types,
+          static_properties: @static_properties
+        }
+      end
     end
   end
 end

data/lib/fakeit/app/routes/config_route.rb

@@ -0,0 +1,38 @@
+module Fakeit
+  module App
+    module Routes
+      class ConfigRoute
+        attr_reader :options
+
+        def initialize(options)
+          @options = options
+        end
+
+        def call(request)
+          case [request.request_method, request.media_type]
+          in ['GET', _]
+            Fakeit::App::Helpers::ResponseBuilder.ok(@options.to_hash)
+          in ['PUT', 'application/json']
+            update(request)
+          in ['PUT', _]
+            Fakeit::App::Helpers::ResponseBuilder.unsupported_media_type
+          else
+            Fakeit::App::Helpers::ResponseBuilder.method_not_allowed
+          end
+        end
+
+        private
+
+        def update(request)
+          body = Fakeit::App::Helpers::BodyParser.parse(request)[:data]
+          @options = Fakeit::App::Options.new(**body.transform_keys(&:to_sym))
+
+          Fakeit::App::Helpers::ResponseBuilder.ok(@options.to_hash)
+        rescue ArgumentError => e
+          Logger.warn(Rainbow(e.message).red)
+          Fakeit::App::Helpers::ResponseBuilder.error(422, e)
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/app/routes/openapi_route.rb

@@ -0,0 +1,56 @@
+module Fakeit
+  module App
+    module Routes
+      class OpenapiRoute
+        def initialize(spec_file)
+          @specification = Fakeit::Openapi::Specification.new(spec_file)
+        end
+
+        def call(request, options)
+          @specification
+            .operation(request.request_method.downcase.to_sym, request.path_info, options)
+            .then { _1 ? handle(_1, request, options) : Fakeit::App::Helpers::ResponseBuilder.not_found }
+        end
+
+        private
+
+        def handle(operation, request, options)
+          validate(operation, request)
+          response(operation)
+        rescue Fakeit::Validation::ValidationError => e
+          Logger.warn(Rainbow(e.message).red)
+          options.permissive ? response(operation) : Fakeit::App::Helpers::ResponseBuilder.error(418, e)
+        end
+
+        def response(operation)
+          [operation.status, operation.headers, [operation.body]]
+        end
+
+        def validate(operation, request)
+          operation.validate(
+            body: Helpers::BodyParser.parse(request),
+            params: parse_query(request.query_string),
+            headers: headers(request)
+          )
+        end
+
+        def headers(request)
+          request
+            .each_header
+            .select { |k, _| k.start_with? 'HTTP_' }
+            .map { |k, v| [k.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-'), v] }
+            .to_h
+        end
+
+        def parse_query(query_string)
+          rack_query = Rack::Utils.parse_nested_query(query_string)
+          cgi_query = CGI.parse(query_string)
+
+          rack_query.merge(cgi_query.slice(*rack_query.keys)) do |_, oldval, newval|
+            newval.is_a?(Array) && newval.size > 1 ? newval : oldval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fakeit/logger.rb

@@ -1,4 +1,3 @@
 module Fakeit
-  $stdout.sync = true
-  Logger = ::Logger.new($stdout)
+  Logger = ::Logger.new($stderr)
 end

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

@@ -104,7 +104,7 @@ module Fakeit
       end
 
       def unknown_format
-        Fakeit::Logger.info("Unknown string format: #{format}")
+        Logger.info("Unknown string format: #{format}")
         'Unknown string format'
       end
     end

data/lib/fakeit/openapi/specification.rb

@@ -25,7 +25,7 @@ module Fakeit
         @mtime = new_mtime
         @doc = Fakeit::Openapi.load(@spec_file)
       rescue StandardError => _e
-        Fakeit::Logger.warn(Rainbow('Invalid spec file, use previous snapshot instead').red)
+        Logger.warn(Rainbow('Invalid spec file, use previous snapshot instead').red)
       end
     end
   end

data/lib/fakeit/version.rb

@@ -1,3 +1,3 @@
 module Fakeit
-  VERSION = '0.6.3'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -218,6 +218,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -228,9 +229,12 @@ files:
 - docs/static.md
 - fakeit.gemspec
 - lib/fakeit.rb
-- lib/fakeit/app/app.rb
-- lib/fakeit/app/body_parser.rb
+- lib/fakeit/app/app_builder.rb
+- lib/fakeit/app/helpers/body_parser.rb
+- lib/fakeit/app/helpers/response_builder.rb
 - lib/fakeit/app/options.rb
+- lib/fakeit/app/routes/config_route.rb
+- lib/fakeit/app/routes/openapi_route.rb
 - lib/fakeit/core_extensions/schema.rb
 - lib/fakeit/logger.rb
 - lib/fakeit/middleware/recorder.rb
@@ -266,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Create mock server from Openapi specification

data/lib/fakeit/app/app.rb

@@ -1,63 +0,0 @@
-module Fakeit
-  module App
-    class << self
-      def create(spec_file, options)
-        specification = Fakeit::Openapi::Specification.new(spec_file)
-
-        proc do |env|
-          request = Rack::Request.new(env)
-          specification
-            .operation(request.request_method.downcase.to_sym, request.path_info, options)
-            .then { _1 ? handle(_1, request, options) : not_found }
-        end
-      end
-
-      private
-
-      def handle(operation, request, options)
-        validate(operation, request)
-        response(operation)
-      rescue Fakeit::Validation::ValidationError => e
-        Fakeit::Logger.warn(Rainbow(e.message).red)
-        options.permissive ? response(operation) : error(e)
-      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: BodyParser.parse(request),
-          params: parse_query(request.query_string),
-          headers: headers(request)
-        )
-      end
-
-      def headers(request)
-        request
-          .each_header
-          .select { |k, _| k.start_with? 'HTTP_' }
-          .map { |k, v| [k.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-'), v] }
-          .to_h
-      end
-
-      def parse_query(query_string)
-        rack_query = Rack::Utils.parse_nested_query(query_string)
-        cgi_query = CGI.parse(query_string)
-
-        rack_query.merge(cgi_query.slice(*rack_query.keys)) do |_, oldval, newval|
-          newval.is_a?(Array) && newval.size > 1 ? newval : oldval
-        end
-      end
-    end
-  end
-end

data/lib/fakeit/app/body_parser.rb

@@ -1,30 +0,0 @@
-module Fakeit
-  module App
-    class BodyParser
-      class << self
-        def parse(request)
-          case request.media_type
-          when %r{^application/.*json}
-            { media_type: request.media_type, data: parse_json(request.body.read) }
-          when 'multipart/form-data'
-            { media_type: request.media_type, data: parse_form_data(request.params) }
-          else
-            { media_type: request.media_type, data: request.body.read }
-          end
-        end
-
-        private
-
-        def parse_json(body)
-          body.empty? ? {} : JSON.parse(body)
-        rescue StandardError
-          raise Fakeit::Validation::ValidationError, 'Invalid json payload'
-        end
-
-        def parse_form_data(params)
-          params.transform_values { |v| v.class == Hash && v[:tempfile] ? v[:tempfile].read : v }
-        end
-      end
-    end
-  end
-end