fakeit 0.5.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ea4d2aa93efde5e87605835f598e5f73de921fd00d2fd4f15b1784dbc44c87
-  data.tar.gz: e10dc92c54c9463a7a75c9caf0391d1a563445d99ded2e0d02038cde2f7c9886
+  metadata.gz: 35c58ad2d52ce6f2ba2375738faaed686b7945ce0d3e438d0d5e3e78f7d32d71
+  data.tar.gz: 4c9a1566b7256b2b5b8fb7772daf1329810644b646f2ac0c939d5a3fd824a8db
 SHA512:
-  metadata.gz: fdca80c0d4597949df629c3691bac048ed915bbe7fc69ea684c28d36bb21ecf6aa469910e107a9e8264fc93d11db6e23ded0d97a42b19e8bc613e63b2f0d0df2
-  data.tar.gz: 12b14f11d000f28bc18534f3ceb20f6ccc2cb1fac8ced1e9b28e74c2a6886b302e0106f504229ac8becac342632c6df3fcbd133d8d77694a23d8aaec196c34f1
+  metadata.gz: 0c3b0375ac956484083b108bb3284ccd33adda44e002b310b7e44fdb2ce151f1b62729a095f9caa02d2953d7dd809e4144fa33612756aa3189cee358e279ae18
+  data.tar.gz: 71e3391f4570e12b3c940476e0657e700088ef72f122ccf6e354e71e43ed47ef3d082e7d7f972fc5b35c3fb111aba38110b00d36725eaaafbaeb18750d6ebc96

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
 Style/Documentation:
   Enabled: false
@@ -18,11 +19,5 @@ Metrics/BlockLength:
 Security/Open:
   Enabled: false
 
-Style/HashEachMethods:
-  Enabled: true
-
 Style/HashTransformKeys:
   Enabled: false
-
-Style/HashTransformValues:
-  Enabled: true

data/Gemfile.lock

@@ -1,67 +1,72 @@
 PATH
   remote: .
   specs:
-    fakeit (0.5.2)
-      faker (~> 2.2)
-      openapi_parser (= 0.8.0)
+    fakeit (0.6.3)
+      faker (= 2.13.0)
+      openapi_parser (= 0.12.1)
       rack (~> 2.0)
       rack-cors (~> 1.0)
       rainbow (~> 3.0)
-      slop (~> 4.6)
+      regexp-examples (= 1.5.1)
+      slop (~> 4.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    byebug (11.1.1)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
+    ast (2.4.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    faker (2.10.2)
+    faker (2.13.0)
       i18n (>= 1.6, < 2)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    openapi_parser (0.8.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    rack (2.2.2)
+    openapi_parser (0.12.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
     rack-cors (1.1.1)
       rack (>= 2.0.0)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp-examples (1.5.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.2)
+    simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.0)
-    slop (4.8.0)
-    unicode-display_width (1.6.1)
+    simplecov-html (0.12.2)
+    slop (4.8.2)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -30,14 +30,12 @@ After tried several existing options, we cannot find a best solution to meet all
 
 ## Features
 
-* Randomly or statically generated response
-* Request validation
+* Randomly or statically generated response (`application/.*json`)
+* Request validation (`application/.*json`, `multipart/form-data`)
 * Load specification from local or remote
 * Support hot reload local specification
 * Support specification in yaml or json format
 
-**Note:** Only support json content type as of now
-
 ## Installation
 
 Install it with:
@@ -61,7 +59,7 @@ Command line options:
         --use-example        use example provided in spec if exists
         --static             generate static response
         --static-types       generate static value for specified types, e.g. --static-types integer,string
-        --static-properties  generate static value for specified properties, e.g. --static-types id,uuid
+        --static-properties  generate static value for specified properties, e.g. --static-properties id,uuid
 
     other options:
         -v, --version

data/docs/random.md

@@ -11,7 +11,7 @@ The following Openapi properties are supported in random response generation
 | |minItems|Default: `1`|
 | |maxItems|Default: `minItems + 2`|
 |string|enum| |
-| |pattern| |
+| |pattern|Random generated once and cached for performance concern|
 | |format=uri| |
 | |format=uuid| |
 | |format=guid| |

data/docs/static.md

@@ -6,8 +6,9 @@ Static value generation rule
 |---|---|---|
 |complex|oneOf|first item|
 | |anyOf|same as allOf|
+|boolean|N/A|`true`|
 |array|N/A|size is `1`|
-| |minItems|size is minItems|
+| |minItems|size is max(minItems,1)|
 |string|N/A|`string`|
 | |enum|first item|
 | |pattern|Generated but always the same|

data/fakeit.gemspec

@@ -32,10 +32,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.80'
   spec.add_development_dependency 'simplecov', '~> 0.18'
 
-  spec.add_dependency 'faker', '~> 2.2'
-  spec.add_dependency 'openapi_parser', '0.8.0'
+  spec.add_dependency 'faker', '2.13.0'
+  spec.add_dependency 'openapi_parser', '0.12.1'
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'rack-cors', '~> 1.0'
   spec.add_dependency 'rainbow', '~> 3.0'
-  spec.add_dependency 'slop', '~> 4.6'
+  spec.add_dependency 'regexp-examples', '1.5.1'
+  spec.add_dependency 'slop', '~> 4.8'
 end

data/lib/fakeit.rb

@@ -4,6 +4,7 @@ require 'open-uri'
 require 'base64'
 require 'openapi_parser'
 require 'faker'
+require 'regexp-examples'
 require 'rack'
 require 'logger'
 require 'rainbow'

data/lib/fakeit/app/app.rb

@@ -36,7 +36,7 @@ module Fakeit
 
       def validate(operation, request)
         operation.validate(
-          body: request.body&.read.to_s,
+          body: BodyParser.parse(request),
           params: parse_query(request.query_string),
           headers: headers(request)
         )

data/lib/fakeit/app/body_parser.rb

@@ -0,0 +1,30 @@
+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

data/lib/fakeit/logger.rb

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

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

@@ -4,7 +4,7 @@ module Fakeit
       def array_example(options)
         example_options = add_depth(options)
         if example_options[:use_static][type: 'array', property: example_options[:property]]
-          generate_array_example(example_options, -> { min_array })
+          generate_array_example(example_options, -> { non_empty_size })
         else
           generate_array_example(example_options, -> { random_array_size(example_options) })
         end
@@ -18,17 +18,17 @@ module Fakeit
       end
 
       def random_array_size(example_options)
-        uniqueItems ? min_array : Faker::Number.between(from: min_array, to: max_array(example_options[:depth]))
+        uniqueItems ? non_empty_size : Faker::Number.between(from: min_array, to: max_array(example_options[:depth]))
       end
 
       def generate_items(size, retries, example_options, result)
-        loop do
+        while result.size < size
           item = items.to_example(example_options)
 
           if need_retry?(item, result, retries)
             retries -= 1
-          elsif (result << item).size >= size
-            break
+          else
+            result << item
           end
         end
       end
@@ -41,6 +41,10 @@ module Fakeit
         uniqueItems && result.include?(item) && retries.positive?
       end
 
+      def non_empty_size
+        [min_array, 1].max
+      end
+
       def min_array
         minItems || 1
       end

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

@@ -27,6 +27,8 @@ module Fakeit
       }.freeze
 
       def string_example(example_options)
+        @string_pattern ||= Regexp.new(pattern) if pattern
+
         if example_options[:use_static][type: 'string', property: example_options[:property]]
           static_string_example
         else
@@ -39,7 +41,7 @@ module Fakeit
       def static_string_example
         fixed_faker do
           if enum then enum.to_a.first
-          elsif pattern then Faker::Base.regexify(pattern)
+          elsif pattern then static_string_pattern
           elsif format then static_string_format
           elsif length_constraint then static_string_with_length
           else 'string'
@@ -56,7 +58,7 @@ module Fakeit
 
       def random_string_example
         if enum then enum.to_a.sample
-        elsif pattern then Faker::Base.regexify(pattern)
+        elsif pattern then random_string_pattern
         elsif format then random_string_format
         elsif length_constraint then string_with_length
         else Faker::Book.title
@@ -71,6 +73,12 @@ module Fakeit
         (STATIC_FORMAT_HANDLERS[format] || method(:unknown_format))[]
       end
 
+      def static_string_pattern
+        @static_string_pattern ||= @string_pattern.examples(
+          max_repeater_variance: 1, max_group_results: 1, max_results_limit: 1
+        ).first
+      end
+
       def length_constraint
         minLength || maxLength
       end
@@ -91,6 +99,10 @@ module Fakeit
         (RANDOM_FORMAT_HANDLERS[format] || method(:unknown_format))[]
       end
 
+      def random_string_pattern
+        @random_string_pattern ||= @string_pattern.random_example(max_repeater_variance: 1)
+      end
+
       def unknown_format
         Fakeit::Logger.info("Unknown string format: #{format}")
         'Unknown string format'

data/lib/fakeit/validation/validator.rb

@@ -5,13 +5,10 @@ module Fakeit
         @operation = operation
       end
 
-      def validate(body: '', params: {}, headers: {})
+      def validate(body: {}, params: {}, headers: {})
         options = OpenAPIParser::SchemaValidator::Options.new(coerce_value: true)
 
-        if request_content_type
-          body_data = parse(body)
-          @operation.validate_request_body(request_content_type, body_data)
-        end
+        validate_body(body) unless request_content_types.empty?
         @operation.validate_path_params(options)
         @operation.validate_request_parameter(params, headers, options)
       rescue StandardError => e
@@ -20,14 +17,21 @@ module Fakeit
 
       private
 
-      def parse(body)
-        JSON.parse(body)
-      rescue StandardError
-        raise ValidationError, 'Invalid json payload'
+      def validate_body(body)
+        if request_content_types.include?(body[:media_type])
+          @operation.validate_request_body(body[:media_type], body[:data]) if can_validate?(body[:media_type])
+        else
+          raise ValidationError, 'Invalid request content type' if body[:media_type]
+          raise ValidationError, 'Request body is required' if request_body.required
+        end
+      end
+
+      def can_validate?(media_type)
+        media_type =~ %r{^application/.*json} || media_type == 'multipart/form-data'
       end
 
-      def request_content_type
-        request_body&.content&.find { |k, _| k =~ %r{^application/.*json} }&.first
+      def request_content_types
+        request_body&.content&.keys.to_a
       end
 
       def request_body

data/lib/fakeit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,30 +112,30 @@ dependencies:
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: openapi_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: regexp-examples
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.8'
 description: Create mock server from Openapi specification
 email:
 - realfengjia@foxmail.com
@@ -215,8 +229,8 @@ files:
 - fakeit.gemspec
 - lib/fakeit.rb
 - lib/fakeit/app/app.rb
+- lib/fakeit/app/body_parser.rb
 - lib/fakeit/app/options.rb
-- lib/fakeit/core_extensions/findable.rb
 - lib/fakeit/core_extensions/schema.rb
 - lib/fakeit/logger.rb
 - lib/fakeit/middleware/recorder.rb

data/lib/fakeit/core_extensions/findable.rb

@@ -1,12 +0,0 @@
-module OpenAPIParser
-  module Findable
-    def purge_object_cache
-      return if @purged
-
-      @find_object_cache = {}
-      @purged = true
-
-      _openapi_all_child_objects.values.each(&:purge_object_cache)
-    end
-  end
-end