fakeit 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c041ed8f46946a8641f52ae6397b00a5620cf53f813195df6694a1f36c2904
-  data.tar.gz: 71d218c8c8aee2d0a9240785e43949a3fd9b3210f6ce817ba6dc224ccbffddd8
+  metadata.gz: 727b95e51aed4489946200aac98d814fe6132e0fe7857819b85e3f48d2f6ab40
+  data.tar.gz: f3a78ca7afd4782f7003cdd3b888e334e60ea8edfd59b1fec058c822cd72ca6a
 SHA512:
-  metadata.gz: 88fdba5349cfc8f664bf321030c3e2de2446b2f677a249f5801ed00d8b37ca5291c8b5e59670c4bc5e1bb67327ef43a64f22b2fc22105f50e503b41c6d76724e
-  data.tar.gz: 3edc63857c5447b41b8a1e6e8ebeef84ac676216ad0d27531905bcaded11b69da2b468828475d7db43674ac6708d8af800b53e5796f311a281043050b6c1020b
+  metadata.gz: 60bd99ceff20e1ee73843901d6ba5b29955f044092162428736ca093b4f32557c5de755eae435c98d0488fd40997d5c420fac6c067635191b0074cc23a7b09c1
+  data.tar.gz: b549806af5f29b2284023a637bf79f3cb770a9ca449f3079d5be5c997bccaa4d4fc41efe607258f96b7b6d487eeb6f8fd47ef1c383f2aa3a45f82920397fdf3d

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    fakeit (0.1.5)
+    fakeit (0.2.0)
       faker (~> 1.9)
-      openapi_parser (= 0.3.0)
+      openapi_parser (= 0.3.1)
       rack (~> 2.0)
       rack-cors (~> 1.0)
       slop (~> 4.6)
@@ -15,27 +15,17 @@ GEM
     byebug (11.0.1)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    docile (1.3.1)
-    equatable (0.6.1)
-    faker (1.9.4)
+    docile (1.3.2)
+    faker (1.9.6)
       i18n (>= 0.7)
-      pastel (~> 0.7.2)
-      thor (~> 0.20.0)
-      tty-pager (~> 0.12.0)
-      tty-screen (~> 0.6.5)
-      tty-tree (~> 0.3.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.3)
     json (2.2.0)
-    openapi_parser (0.3.0)
+    openapi_parser (0.3.1)
     parallel (1.17.0)
-    parser (2.6.2.1)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    pastel (0.7.3)
-      equatable (~> 0.6)
-      tty-color (~> 0.5)
-    psych (3.1.0)
     rack (2.0.7)
     rack-cors (1.0.3)
     rack-test (1.1.0)
@@ -46,46 +36,30 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.67.2)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    slop (4.6.2)
-    strings (0.1.5)
-      strings-ansi (~> 0.1)
-      unicode-display_width (~> 1.5)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.1.0)
-    thor (0.20.3)
-    tty-color (0.5.0)
-    tty-pager (0.12.1)
-      strings (~> 0.1.4)
-      tty-screen (~> 0.6)
-      tty-which (~> 0.4)
-    tty-screen (0.6.5)
-    tty-tree (0.3.0)
-    tty-which (0.4.1)
-    unicode-display_width (1.5.0)
-    unicode_utils (1.4.0)
+    slop (4.7.0)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -9,9 +9,9 @@
 
 Create mock server from Openapi specification
 
-## Description
+## Features
 
-* Randomly generated response
+* Randomly or statically generated response
 * Request validation
 * Load specification from local or remote
 * Support specification in yaml or json format
@@ -37,14 +37,20 @@ 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
+        --permissive   log validation error as warning instead of denying request
+        --use-example  use example provided in spec if exists
+
+    trial options:
+        --static       generate static response
 
     other options:
         -v, --version
         -h, --help
 
 **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
+* Regarding `--use-example` mode, property without example specified will still be randomly or statically generated
 * Random response generation can not handle recursive schema reference. If you do need it in your spec file, please provide `example` property for the recursive part of schema and specify `--use-example` option.
 
 ## Development

data/bin/fakeit

@@ -10,8 +10,11 @@ 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.bool '--permissive', 'log validation error as warning instead of denying request'
+    o.bool '--use-example', 'use example provided in spec if exists'
+    o.separator ''
+    o.separator 'trial options:'
+    o.bool '--static', 'generate static response'
     o.separator ''
     o.separator 'other options:'
     o.on '-v', '--version' do
@@ -41,7 +44,11 @@ trap(:INT) do
   end
 end
 
-options = Fakeit::App::Options.new(permissive: opts.permissive?, use_example: opts.use_example?)
+options = Fakeit::App::Options.new(
+  permissive: opts.permissive?,
+  use_example: opts.use_example?,
+  static: opts.static?
+)
 app = Fakeit.build(opts[:spec], options)
 
 app.use Rack::Cors do

data/docs/random.md

@@ -0,0 +1,31 @@
+# Random
+
+The following Openapi properties are supported in random response generation
+
+|Type|Property|Notes|
+|---|---|---|
+|complex|oneOf| |
+| |allOf| |
+| |anyOf| |
+|array|uniqueItems|Try to generate unique random items, but will give up after exceeding retry limits|
+| |minItems|Default: `1`|
+| |maxItems|Default: `minItems + 2`|
+|string|enum| |
+| |pattern| |
+| |format=uri| |
+| |format=uuid| |
+| |format=guid| |
+| |format=email| |
+| |format=date|In past 100 days|
+| |format=date-time|In past 100 days|
+| |minLength|Default: `0`|
+| |maxLength|Default: `minLength + 10`|
+|integer|enum| |
+| |minimum|Default: `1`|
+| |maximum|Default: `2^32`|
+| |exclusiveMinimum| |
+| |exclusiveMaximum| |
+| |multipleOf| |
+|number|minimum|Default: `0.0`|
+| |maximum|Default: `2^32`|
+| |multipleOf| |

data/docs/static.md

@@ -0,0 +1,29 @@
+# Static
+
+Static value generation rule
+
+|Type|Property|Rule|
+|---|---|---|
+|complex|oneOf|first item|
+| |anyOf|same as allOf|
+|array|N/A|size is `1`|
+| |minItems|size is minItems|
+|string|N/A|`string`|
+| |enum|first item|
+| |pattern|Generated but always the same|
+| |format=uri|`https://some.uri`|
+| |format=uuid|`11111111-1111-1111-1111-111111111111`|
+| |format=guid|`11111111-1111-1111-1111-111111111111`|
+| |format=email|`some@email.com`|
+| |format=date|today|
+| |format=date-time|midnight today|
+| |minLength|`1` repeats for (minLength + 10) times if no maxLength specified|
+| |maxLength|`1` repeats for maxLength times|
+|integer|N/A|`1`|
+| |enum|first item|
+| |minimum|minimum|
+| |exclusiveMinimum|minimum + 1|
+| |multipleOf|minimum value meets multipleOf condition|
+|number|N/A|0.0|
+| |minimum|minimum rounded to 2 decimal places|
+| |multipleOf|minimum value meets multipleOf condition|

data/fakeit.gemspec

@@ -33,7 +33,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.3.0'
+  spec.add_dependency 'openapi_parser', '0.3.1'
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'rack-cors', '~> 1.0'
   spec.add_dependency 'slop', '~> 4.6'

data/lib/fakeit/app/options.rb

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

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

@@ -1,18 +1,26 @@
 module Fakeit
   module Openapi
     module Example
-      MAX_SIZE = 3
-
-      def array_example(use_example)
-        size = retries = uniqueItems ? min_array : Faker::Number.between(min_array, max_array)
-        [].tap { |result| generate_items(size, retries, use_example, result) }
+      def array_example(options)
+        example_options = add_depth(options)
+        example_options[:static] ? static_array_example(example_options) : random_array_example(example_options)
       end
 
       private
 
-      def generate_items(size, retries, use_example, result)
+      def static_array_example(example_options)
+        size = retries = min_array
+        [].tap { |result| generate_items(size, retries, example_options, result) }
+      end
+
+      def random_array_example(example_options)
+        size = retries = uniqueItems ? min_array : Faker::Number.between(min_array, max_array(example_options[:depth]))
+        [].tap { |result| generate_items(size, retries, example_options, result) }
+      end
+
+      def generate_items(size, retries, example_options, result)
         loop do
-          item = items.to_example(use_example)
+          item = items.to_example(example_options)
 
           if need_retry?(item, result, retries)
             retries -= 1
@@ -22,6 +30,10 @@ module Fakeit
         end
       end
 
+      def add_depth(example_options)
+        example_options.merge(depth: example_options[:depth] + 1)
+      end
+
       def need_retry?(item, result, retries)
         uniqueItems && result.include?(item) && retries.positive?
       end
@@ -30,8 +42,8 @@ module Fakeit
         minItems || 1
       end
 
-      def max_array
-        maxItems || MAX_SIZE
+      def max_array(depth)
+        maxItems || min_array + (depth > 1 ? 2 : 9)
       end
     end
   end

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

@@ -1,8 +1,8 @@
 module Fakeit
   module Openapi
     module Example
-      def boolean_example
-        Faker::Boolean.boolean
+      def boolean_example(example_options)
+        example_options[:static] || Faker::Boolean.boolean
       end
     end
   end

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

@@ -3,7 +3,21 @@ module Fakeit
     module Example
       BIG_INT = 2**32
 
-      def integer_example
+      def integer_example(example_options)
+        example_options[:static] ? static_integer_example : random_integer_example
+      end
+
+      private
+
+      def static_integer_example
+        if enum
+          enum.to_a.first
+        else
+          int_rand_begin * int_multiple
+        end
+      end
+
+      def random_integer_example
         if enum
           enum.to_a.sample
         else
@@ -11,8 +25,6 @@ module Fakeit
         end
       end
 
-      private
-
       def int_rand_begin
         min_int / int_multiple + int_rand_begin_adjust
       end

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

@@ -3,12 +3,22 @@ module Fakeit
     module Example
       BIG_NUM = 2**32
 
-      def number_example
-        (Faker::Number.between(num_rand_begin, num_rand_end) * num_multiple).round(2)
+      def number_example(example_options)
+        example_options[:static] ? static_number_example : random_number_example
       end
 
       private
 
+      def static_number_example
+        (num_rand_begin * num_multiple)
+          .then { |result| multipleOf ? result : result.round(2) }
+      end
+
+      def random_number_example
+        (Faker::Number.between(num_rand_begin, num_rand_end) * num_multiple)
+          .then { |result| multipleOf ? result : result.round(2) }
+      end
+
       def num_rand_begin
         multipleOf ? (min_num / multipleOf).ceil : min_num
       end

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

@@ -1,8 +1,8 @@
 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) }
+      def object_example(example_options)
+        properties.each_with_object({}) { |(name, schema), obj| obj[name] = schema.to_example(example_options) }
       end
     end
   end

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

@@ -1,7 +1,19 @@
 module Fakeit
   module Openapi
     module Example
-      FORMAT_HANDLERS = {
+      STATIC_FORMAT_HANDLERS = {
+        'uri' => -> { 'https://some.uri' },
+        'uuid' => -> { '11111111-1111-1111-1111-111111111111' },
+        'guid' => -> { '11111111-1111-1111-1111-111111111111' },
+        'email' => -> { 'some@email.com' },
+        'date' => -> { Date.today.iso8601 },
+        'date-time' => lambda do
+          now = Time.now
+          Time.new(now.year, now.month, now.day, 0, 0, 0, now.utc_offset).iso8601
+        end
+      }.freeze
+
+      RANDOM_FORMAT_HANDLERS = {
         'uri' => -> { Faker::Internet.url },
         'uuid' => -> { SecureRandom.uuid },
         'guid' => -> { SecureRandom.uuid },
@@ -10,16 +22,39 @@ module Fakeit
         'date-time' => -> { Faker::Time.backward(100).iso8601 }
       }.freeze
 
-      def string_example
+      def string_example(example_options)
+        example_options[:static] ? static_string_example : random_string_example
+      end
+
+      private
+
+      def static_string_example
+        Faker::Config.random = Random.new(1) # Fix seed for faker
+
+        if enum then enum.to_a.first
+        elsif pattern then Faker::Base.regexify(pattern)
+        elsif format then static_string_format
+        elsif length_constraint then static_string_with_length
+        else 'string'
+        end
+      end
+
+      def random_string_example
         if enum then enum.to_a.sample
         elsif pattern then Faker::Base.regexify(pattern)
-        elsif format then string_format
+        elsif format then random_string_format
         elsif length_constraint then string_with_length
         else Faker::Book.title
         end
       end
 
-      private
+      def static_string_with_length
+        '1' * max_string_length
+      end
+
+      def static_string_format
+        (STATIC_FORMAT_HANDLERS[format] || method(:unknown_format))[]
+      end
 
       def length_constraint
         minLength || maxLength
@@ -37,8 +72,8 @@ module Fakeit
         maxLength || min_string_length + 10
       end
 
-      def string_format
-        (FORMAT_HANDLERS[format] || method(:unknown_format))[]
+      def random_string_format
+        (RANDOM_FORMAT_HANDLERS[format] || method(:unknown_format))[]
       end
 
       def unknown_format

data/lib/fakeit/openapi/operation.rb

@@ -1,10 +1,10 @@
 module Fakeit
   module Openapi
     class Operation
-      def initialize(request_operation, options)
+      def initialize(request_operation, app_options)
         @request_operation = request_operation
         @validator = Fakeit::Validation::Validator.new(request_operation)
-        @options = options
+        @app_options = app_options
       end
 
       def status
@@ -13,7 +13,7 @@ module Fakeit
 
       def headers
         response_headers
-          &.map { |k, v| [k, v.schema.to_example(@options.use_example)] }
+          &.map { |k, v| [k, v.schema.to_example(example_options)] }
           .to_h
           .tap { |headers| headers['Content-Type'] = response_content_type if response_content_type }
       end
@@ -21,7 +21,7 @@ module Fakeit
       def body
         response_schema
           &.schema
-          &.to_example(@options.use_example)
+          &.to_example(example_options)
           &.then(&JSON.method(:generate))
           .to_s
       end
@@ -32,6 +32,10 @@ module Fakeit
 
       private
 
+      def example_options
+        { use_example: @app_options.use_example, static: @app_options.static, depth: 0 }
+      end
+
       def response_content
         response.last.content&.find { |k, _| k =~ %r{^application/.*json} }
       end

data/lib/fakeit/openapi/schema.rb

@@ -10,42 +10,39 @@ module Fakeit
     module Schema
       include Fakeit::Openapi::Example
 
-      def to_example(use_example = false)
-        return example if use_example && example
+      def to_example(**example_options)
+        return example if example_options[:use_example] && example
 
-        return one_of_example(use_example) if one_of
-        return all_of_example(use_example) if all_of
-        return any_of_example(use_example) if any_of
+        return one_of_example(example_options) if one_of
+        return all_of_example(example_options) if all_of
+        return any_of_example(example_options) if any_of
 
-        type_based_example(use_example)
+        type_based_example(example_options)
       end
 
       private
 
-      def one_of_example(use_example)
-        one_of.sample.to_example(use_example)
+      def one_of_example(example_options)
+        example_options[:static] ? one_of.first.to_example(example_options) : one_of.sample.to_example(example_options)
       end
 
-      def all_of_example(use_example)
+      def all_of_example(example_options)
         all_of
           .select { |option| option.type == 'object' }
-          .map { |option| option.to_example(use_example) }
+          .map { |option| option.to_example(example_options) }
           .reduce(&:merge)
       end
 
-      def any_of_example(use_example)
+      def any_of_example(example_options)
         any_of
           .select { |option| option.type == 'object' }
-          .sample(Faker::Number.between(1, any_of.size))
-          .map { |option| option.to_example(use_example) }
+          .then { |options| example_options[:static] ? options : options.sample(Faker::Number.between(1, any_of.size)) }
+          .map { |option| option.to_example(example_options) }
           .reduce(&:merge)
       end
 
-      def type_based_example(use_example)
-        case type
-        when 'string', 'integer', 'number', 'boolean' then send("#{type}_example")
-        when 'array', 'object' then send("#{type}_example", use_example)
-        end
+      def type_based_example(example_options)
+        send("#{type}_example", example_options) if %w[string integer number boolean array object].include?(type)
       end
     end
   end

data/lib/fakeit/version.rb

@@ -1,3 +1,3 @@
 module Fakeit
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,8 @@ files:
 - README.md
 - Rakefile
 - bin/fakeit
+- docs/random.md
+- docs/static.md
 - fakeit.gemspec
 - lib/fakeit.rb
 - lib/fakeit/app/app.rb