fakeit 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b596171f4bdda96b6782f7292abbadee787e56f045d75449792f64c86b370abf
-  data.tar.gz: f9d429ed7328142a0b7f53e3352d782bf5b096ce449e88ada902b6205b916010
+  metadata.gz: 12f260511e656b09583cd6c2d2dba67d5b7f947c3242eca95c7b3cf2cec34c0a
+  data.tar.gz: 48625a13975517595721666508dbaa4f151a421ed24bae0e8a6c053e94e995c3
 SHA512:
-  metadata.gz: 9ee0a08eae71abb26ee679615022fe3eb363e90233714f0eb34bccca973a1d68dbc16badcd0520456a30fc7e0966df7405bb551e27664c101fea8482ce3d78d6
-  data.tar.gz: de08d3b1e0f0118c85bc61d8e22d812ac591a439dace0a7dc5279a9801d21a50cdf1f6f8baf6378e35487ac9ba565e30630e949e179ec2e10f8f3092e4df1840
+  metadata.gz: 82d5e751a1591754f540d4fad85caffc8d697d4a81cb92a0d0ce000c4571a08613565aef6e43919db5712579162f96b676541129b071acaf95c55c3da4ffb200
+  data.tar.gz: f480f86e2f9fda5944ee31996b641f1bc0fb3384cab6df126ce2b238cb3759aeb6b2d53dee7d881239369a2f3d8233b315ad3a6e7a592c8f2eb39509b63cd3d9

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## [v0.9.2](https://github.com/JustinFeng/fakeit/tree/v0.9.2) (2021-08-14)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.9.1...v0.9.2)
+
+**Closed issues:**
+
+- "Tried to load unspecified class: Date" error is given when spec contains a text that resembles a date [\#25](https://github.com/JustinFeng/fakeit/issues/25)
+
+**Merged pull requests:**
+
+- Bump rexml from 3.2.4 to 3.2.5 [\#24](https://github.com/JustinFeng/fakeit/pull/24) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.9.1](https://github.com/JustinFeng/fakeit/tree/v0.9.1) (2021-04-18)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.9.0...v0.9.1)
+
+**Fixed bugs:**
+
+- Query parameter array [\#23](https://github.com/JustinFeng/fakeit/issues/23)
+
+## [v0.9.0](https://github.com/JustinFeng/fakeit/tree/v0.9.0) (2021-03-18)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.8.1...v0.9.0)
+
+**Implemented enhancements:**
+
+- Experimental feature to support plain text and binary response, e.g. application/pdf
+
+## [v0.8.1](https://github.com/JustinFeng/fakeit/tree/v0.8.1) (2021-03-01)
+
+[Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.8.0...v0.8.1)
+
+**Fixed bugs:**
+
+- Cannot load spec file from url [\#21](https://github.com/JustinFeng/fakeit/issues/21)
+
 ## [v0.8.0](https://github.com/JustinFeng/fakeit/tree/v0.8.0) (2021-02-27)
 
 [Full Changelog](https://github.com/JustinFeng/fakeit/compare/v0.7.1...v0.8.0)

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    fakeit (0.8.1)
-      faker (= 2.13.0)
-      openapi_parser (= 0.12.1)
+    fakeit (0.10.0)
+      faker (= 2.18.0)
+      openapi_parser (= 0.14.1)
       rack (~> 2.0)
       rack-cors (~> 1.0)
       rainbow (~> 3.0)
@@ -16,16 +16,16 @@ GEM
   specs:
     ast (2.4.2)
     byebug (11.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    docile (1.3.5)
-    faker (2.13.0)
+    docile (1.4.0)
+    faker (2.18.0)
       i18n (>= 1.6, < 2)
-    i18n (1.8.9)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    openapi_parser (0.12.1)
+    openapi_parser (0.14.1)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rack-cors (1.1.1)
@@ -33,10 +33,10 @@ GEM
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp-examples (1.5.1)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -50,27 +50,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.10.0)
+    rubocop (1.19.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    slop (4.8.2)
+    simplecov_json_formatter (0.1.3)
+    slop (4.9.1)
     unicode-display_width (2.0.0)
     webrick (1.7.0)
 
@@ -89,4 +89,4 @@ DEPENDENCIES
   simplecov (~> 0.18)
 
 BUNDLED WITH
-   2.2.11
+   2.2.15

data/README.md

@@ -35,6 +35,7 @@ After tried several existing options, we cannot find a best solution to meet all
 * Load specification from local or remote
 * Support hot reload local specification
 * Support specification in yaml or json format
+* [Experimental] Support plain text and binary response, e.g. `application/pdf`
 
 ## Installation
 
@@ -61,11 +62,18 @@ Or use the [docker image](https://hub.docker.com/r/realfengjia/fakeit)
         --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-properties id,uuid
+        --base-path          mounts the mock server at the given path, e.g. --base-path /api
 
     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.
+
 ### Configuration endpoint
 
 Mock server behaviour can be changed on the fly
@@ -89,16 +97,11 @@ Request and response:
   ],
   "static_properties": [
     "id"
-  ]
+  ],
+  "base_path": "/"
 }
 ```
 
-**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
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake` to run the tests.

data/bin/fakeit

@@ -16,6 +16,7 @@ begin
     o.bool '--static', 'generate static response'
     o.array '--static-types', 'generate static value for specified types, e.g. --static-types integer,string'
     o.array '--static-properties', 'generate static value for specified properties, e.g. --static-properties id,uuid'
+    o.string '--base-path', 'mounts the mock server at the given path, e.g. --base-path /api'
     o.separator ''
     o.separator 'other options:'
     o.on '-v', '--version' do
@@ -50,7 +51,8 @@ options = Fakeit::App::Options.new(
   use_example: opts.use_example?,
   static: opts.static?,
   static_types: opts[:static_types],
-  static_properties: opts[:static_properties]
+  static_properties: opts[:static_properties],
+  base_path: opts[:base_path]
 )
 app = Fakeit.build(opts[:spec], options)
 

data/fakeit.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0.5'
   spec.add_development_dependency 'simplecov', '~> 0.18'
 
-  spec.add_dependency 'faker', '2.13.0'
-  spec.add_dependency 'openapi_parser', '0.12.1'
+  spec.add_dependency 'faker', '2.18.0'
+  spec.add_dependency 'openapi_parser', '0.14.1'
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'rack-cors', '~> 1.0'
   spec.add_dependency 'rainbow', '~> 3.0'

data/lib/fakeit/app/app_builder.rb

@@ -2,6 +2,7 @@ module Fakeit
   module App
     class AppBuilder
       def initialize(spec_file, options)
+        @options = options
         @config_route = Routes::ConfigRoute.new(options)
         @openapi_route = Routes::OpenapiRoute.new(spec_file)
       end
@@ -14,10 +15,21 @@ module Fakeit
           when '/__fakeit_config__'
             @config_route.call(request)
           else
+            request.path_info = trim_base_from_path(request.path_info)
             @openapi_route.call(request, @config_route.options)
           end
         end
       end
+
+      private
+
+      def trim_base_from_path(path)
+        return path if @options.base_path == '/'
+
+        return path unless path.start_with?(@options.base_path)
+
+        path[@options.base_path.length-1..]
+      end
     end
   end
 end

data/lib/fakeit/app/options.rb

@@ -1,14 +1,17 @@
 module Fakeit
   module App
     class Options
-      attr_reader :permissive, :use_example
+      attr_reader :permissive, :use_example, :base_path
 
-      def initialize(permissive: false, use_example: false, static: false, static_types: [], static_properties: [])
+      def initialize(permissive: false, use_example: false, static: false, static_types: [], static_properties: [], base_path: "/")
         @permissive = permissive
         @use_example = use_example
         @static = static
         @static_types = static_types
         @static_properties = static_properties
+        # Standardize the base path to include trailing slash
+        # so that `/base` matches `/base/path` but doesn't match `/basement/path`
+        @base_path = base_path[-1] == '/' ? base_path : "#{base_path}/"
       end
 
       def use_static?(type: nil, property: nil)
@@ -21,7 +24,8 @@ module Fakeit
           use_example: @use_example,
           static: @static,
           static_types: @static_types,
-          static_properties: @static_properties
+          static_properties: @static_properties,
+          base_path: @base_path
         }
       end
     end

data/lib/fakeit/core_extensions/array_validator.rb

@@ -0,0 +1,12 @@
+module OpenAPIParser
+  class SchemaValidator
+    class ArrayValidator
+      alias old_impl coerce_and_validate
+
+      def coerce_and_validate(value, schema, **keyword_args)
+        coerced_value = schema.parent.is_a?(OpenAPIParser::Schemas::Parameter) ? [*value] : value
+        old_impl(coerced_value, schema, **keyword_args)
+      end
+    end
+  end
+end

data/lib/fakeit/openapi/loader.rb

@@ -2,22 +2,20 @@ module Fakeit
   module Openapi
     class << self
       def load(src)
-        parse_method = parse_method(src)
-
         URI
           .open(src, &:read)
-          .then(&parse_method)
+          .then { parse(src, _1) }
           .then(&OpenAPIParser.method(:parse))
       end
 
       private
 
-      def parse_method(src)
+      def parse(src, content)
         case File.extname(src)
         when '.json'
-          JSON.method(:parse)
+          JSON.parse(content)
         when '.yml', '.yaml'
-          YAML.method(:safe_load)
+          YAML.safe_load(content, [Date, Time])
         else
           raise 'Invalid openapi specification file'
         end

data/lib/fakeit/openapi/operation.rb

@@ -20,7 +20,7 @@ module Fakeit
         response_schema
           &.schema
           &.to_example(example_options)
-          &.then(&JSON.method(:generate))
+          &.then(&method(:serialise))
           .to_s
       end
 
@@ -28,11 +28,15 @@ module Fakeit
 
       private
 
+      def serialise(body) = body.is_a?(String) ? body : JSON.generate(body)
+
       def example_options
         { use_example: @app_options.use_example, use_static: @app_options.method(:use_static?), depth: 0 }
       end
 
-      def response_content = response.last.content&.find { |k, _| k =~ %r{^application/.*json} }
+      def response_content
+        response.last.content&.find { |k, _| k =~ %r{^application/.*json} || k == 'application/pdf' }
+      end
 
       def response_schema = response_content&.last
 

data/lib/fakeit/version.rb

@@ -1,3 +1,3 @@
 module Fakeit
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Justin Feng
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: openapi_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -263,6 +263,7 @@ files:
 - lib/fakeit/app/options.rb
 - lib/fakeit/app/routes/config_route.rb
 - lib/fakeit/app/routes/openapi_route.rb
+- lib/fakeit/core_extensions/array_validator.rb
 - lib/fakeit/core_extensions/reference.rb
 - lib/fakeit/core_extensions/schema.rb
 - lib/fakeit/logger.rb