fakeit 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e532a36b31f1e5ae42a1e424d77f8ef336c54d7519bfa7b3223f27d46c7b1a8d
-  data.tar.gz: dc4e70a6bac2858abc1a251cb2ffe8aff2272ec4926187dd69c19d4ad0be867f
+  metadata.gz: 2f19c0713bc918d394d2bb1c56251b09cf6dae231a0252c5bbb32c3b99fd284d
+  data.tar.gz: abcb565c1179594b5ea2b5c2f707c4c3597fbb74e2833edeb5335661866723a0
 SHA512:
-  metadata.gz: a57970664a9b1e27d0bc8d1a78cea8b4311c0a56b6c3edc252f232728de767c11dea3af0b8419a00e2ce722659f053c2504f8a5432b9cdfe21ab35a77e6c63df
-  data.tar.gz: f36c7175d63d53f35c0b4de54ec07f0129179cc2f2187d7640c5811ae639084f01f1d5cd80ac08e40a713910f6a3d1c5f440a8be3978772565a444467519d66d
+  metadata.gz: 962926947343492b3b37a5e1739d8919cc76ffac8491e033e183f72a8ac2346eb62147aed3e870da9dfc8988422c9f0869255d7957253bb56fc0f35772e8065a
+  data.tar.gz: d471fae5943b4932e07413ee8f67ba484f188efddb0a5d4bf8198f0d791eea07e9744514e7b6ef0890be5dd4932a088bd4f9cc60111f9c72adfadfd96af5fb44

data/.rubocop.yml

@@ -26,3 +26,45 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/Gemfile.lock

@@ -1,67 +1,70 @@
 PATH
   remote: .
   specs:
-    fakeit (0.5.1)
-      faker (~> 2.2)
-      openapi_parser (= 0.8.0)
+    fakeit (0.6.2)
+      faker (= 2.13.0)
+      openapi_parser (= 0.11.2)
       rack (~> 2.0)
       rack-cors (~> 1.0)
       rainbow (~> 3.0)
-      slop (~> 4.6)
+      slop (~> 4.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    byebug (11.1.1)
+    ast (2.4.1)
+    byebug (11.1.3)
     concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
+    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.3)
       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.11.2)
+    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_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.87.1)
       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.1.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.1.0)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.2)
+    simplecov (0.18.5)
       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

@@ -18,7 +18,8 @@ The following Openapi properties are supported in random response generation
 | |format=email| |
 | |format=date|In past 100 days|
 | |format=date-time|In past 100 days|
-| |format=binary|Length is a multiple of `4` between `4` ~ `100`|
+| |format=binary|UTF-8 string|
+| |format=byte|Base64 encoded UTF-8 string|
 | |minLength|Default: `0`|
 | |maxLength|Default: `minLength + 10`|
 |integer|enum| |

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|
@@ -17,7 +18,8 @@ Static value generation rule
 | |format=email|`some@email.com`|
 | |format=date|today|
 | |format=date-time|midnight today|
-| |format=binary|`1111`|
+| |format=binary|`binary`|
+| |format=byte|`Ynl0ZQ==`|
 | |minLength|`1` repeats for (minLength + 10) times if no maxLength specified|
 | |maxLength|`1` repeats for maxLength times|
 |integer|N/A|`2^31 - 1`|

data/fakeit.gemspec

@@ -32,10 +32,10 @@ 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.11.2'
   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 'slop', '~> 4.8'
 end

data/lib/fakeit.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'yaml'
 require 'open-uri'
+require 'base64'
 require 'openapi_parser'
 require 'faker'
 require 'rack'

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/core_extensions/path_item_finder.rb

@@ -0,0 +1,14 @@
+# https://github.com/ota42y/openapi_parser/issues/75
+module OpenAPIParser
+  class PathItemFinder
+    private
+
+    def find_path_and_params(http_method, request_path)
+      return [request_path, {}] if matches_directly?(request_path, http_method)
+
+      matching = matching_paths_with_params(request_path, http_method)
+
+      matching.min_by { |match| match[1].size }
+    end
+  end
+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

@@ -11,7 +11,8 @@ module Fakeit
           now = Time.now
           Time.new(now.year, now.month, now.day, 0, 0, 0, now.utc_offset).iso8601
         end,
-        'binary' => -> { '1111' }
+        'binary' => -> { 'binary' },
+        'byte' => -> { 'Ynl0ZQ==' }
       }.freeze
 
       RANDOM_FORMAT_HANDLERS = {
@@ -21,7 +22,8 @@ module Fakeit
         'email' => -> { Faker::Internet.email },
         'date' => -> { Faker::Date.backward(days: 100).iso8601 },
         'date-time' => -> { Faker::Time.backward(days: 100).iso8601 },
-        'binary' => -> { Faker::String.random(length: (4..100).step(4)) }
+        'binary' => -> { Faker::String.random(length: 1..30) },
+        'byte' => -> { Base64.strict_encode64(Faker::String.random(length: 1..30)) }
       }.freeze
 
       def string_example(example_options)

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.1'.freeze
+  VERSION = '0.6.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-07-12 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.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     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 +215,9 @@ 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/path_item_finder.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