api_sim 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cf6e3d93abfa7755f45ddc06e60609e6a6a7bcd
-  data.tar.gz: e5c2e34b46e497cc7245ccb4bcc3d90310a0c28b
+  metadata.gz: 39744282ba52dd613a6cd9481717892a39482f3b
+  data.tar.gz: 67e3e2d58c0e5e2110521924ddc5c99114a5ce83
 SHA512:
-  metadata.gz: ff1de54e38862120efbd8399d97168df9f8e75aab2222ca1efdd94dbed61ef20c6effd20679f25be36fe0436c2c005c54686fbd8d731c96ad7ad4e8341e4566a
-  data.tar.gz: b6c5a64d7f2a325de35ae9395779b5e8d4cc9c59ab8cb0bd3a8d6b3897f973fb85f62a192530b0d7a7eaed3caf99d1f4aff796d007a1d2105054865e11968643
+  metadata.gz: a88815795d88e7c6f6adc25dfff2b2e7f79c1eda450079d212e7f7fddab4adb20ffc29e2a5b9aa50aee4bbc81c14f67c9ebf92ca1d842740c3ff8394c9dc0348
+  data.tar.gz: 738f62d178070ebebe67302d4762aae8c40c34eb8c74834520a3654e2b9bc3139f67edda7c9ad5a9902f56bff186f25a7674f540875eb89450f3e693bed29a40

data/README.md

@@ -52,6 +52,14 @@ cd examples/basic && bundle check || bundle install && bundle exec rackup -I../.
 
 After which the simulators should be running on port 9292.
 
+## API
+
+The API that these simulators generate can get pretty smart. To help you, the user,
+distinguish between failures and "smarts", we've made up an HTTP status code: 498.
+This code means "we received a request that did not match an expected schema". If you
+provide the simulators with a request schema for an endpoint, all requests must match
+that schema. If they do not, they'll receive our fictional status code.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/api_sim/app_builder.rb

@@ -12,7 +12,7 @@ module ApiSim
       end
     end
 
-    def configure_endpoint(http_method, route, response_body, response_code=200, headers={}, schema_string='')
+    def configure_endpoint(http_method, route, response_body, response_code=200, headers={}, schema_string='', request_schema: nil)
       endpoint_configurations.push(
         Matchers::StaticRequestMatcher.new(
           http_method: http_method,
@@ -21,7 +21,8 @@ module ApiSim
           headers: headers,
           default: true,
           response_body: response_body,
-          schema: schema_string
+          schema: schema_string,
+          request_schema: request_schema
         )
       )
     end

data/lib/api_sim/built_app.rb

@@ -41,7 +41,6 @@ module ApiSim
           return erb :'responses/form.html', layout: :'layout.html'
         end
       end
-
       new_config = create_matcher_override(mimicked_request)
 
       self.class.endpoints.unshift(new_config)
@@ -69,11 +68,10 @@ module ApiSim
       ''
     end
 
-
     get '/requests/*' do
       endpoint_name = parse_endpoint_from_request(request) || halt(404)
-      http_method   = params.fetch('method', 'GET')
-      endpoint      = find_matching_endpoint(endpoint_name, http_method)
+      http_method = params.fetch('method', 'GET')
+      endpoint = find_matching_endpoint(endpoint_name, http_method)
 
       halt(404) unless endpoint
       endpoint.requests.to_json
@@ -82,6 +80,7 @@ module ApiSim
     %i(get post put patch delete options).each do |http_method|
       public_send(http_method, '/*') do
         endpoint = matcher(request)
+        halt(498) unless schema_validates?(endpoint)
         endpoint.record_request(request)
         endpoint.response(request)
       end
@@ -95,12 +94,12 @@ module ApiSim
       end
 
       case matching_endpoints.size
-        when 0
-          nil
-        when 1
-          matching_endpoints.first
-        else
-          matching_endpoints.find { |endpoint| endpoint.http_method =~ /#{http_method}/i }
+      when 0
+        nil
+      when 1
+        matching_endpoints.first
+      else
+        matching_endpoints.find { |endpoint| endpoint.http_method =~ /#{http_method}/i }
       end
     end
 
@@ -121,7 +120,8 @@ module ApiSim
         headers: parsed_body.fetch('headers', old_config[1]),
         response_body: parsed_body.fetch('body', old_config[2]),
         matcher: parsed_body.fetch('match', ''),
-        schema: parsed_body.fetch('schema', '')
+        schema: parsed_body.fetch('schema', ''),
+        request_schema: parsed_body.fetch('request-schema', nil)
       )
     end
 
@@ -172,8 +172,20 @@ module ApiSim
     end
 
     def parse_endpoint_from_request(request)
-      path_matcher  = request.path.match(/\/requests\/([\w\/_-]*)/)
+      path_matcher = request.path.match(/\/requests\/([\w\/_-]*)/)
       path_matcher.size == 2 ? path_matcher[1] : nil
     end
+
+    def schema_validates?(endpoint)
+      if blank?(endpoint.request_schema) || request.env['CONTENT_TYPE'] != 'application/json'
+        true
+      else
+        JSON::Validator.validate_json(JSON.parse(endpoint.request_schema), parsed_body.to_json)
+      end
+    end
+
+    def blank?(item)
+      item.nil? || item.empty?
+    end
   end
 end

data/lib/api_sim/matchers/base_matcher.rb

@@ -5,6 +5,7 @@ module ApiSim
     class BaseMatcher
       DEFAULT_RACK_RESPONSE=[200, {}, '']
       ALWAYS_TRUE_MATCHER = ->(request) { true }
+      attr_reader :request_schema
 
       def custom_matcher?
         matcher != ALWAYS_TRUE_MATCHER

data/lib/api_sim/matchers/static_request_matcher.rb

@@ -6,15 +6,16 @@ module ApiSim
     class StaticRequestMatcher < BaseMatcher
       attr_reader :http_method, :route, :headers, :response_code, :matcher, :response_body, :default, :schema
 
-      def initialize(http_method:, route:, response_code: 200, response_body: '', headers: {}, default: false, matcher: ALWAYS_TRUE_MATCHER, schema: nil)
-        @default = default
-        @matcher = matcher
-        @headers = headers
-        @response_body = response_body
-        @response_code = response_code
-        @route = route
-        @http_method = http_method
-        @schema = schema
+      def initialize(**args)
+        @default = args.fetch(:default, false)
+        @matcher = args.fetch(:matcher, ALWAYS_TRUE_MATCHER)
+        @headers = args.fetch(:headers, {})
+        @response_body = args.fetch(:response_body, '')
+        @response_code = args.fetch(:response_code, 200)
+        @route = args.fetch(:route)
+        @http_method = args.fetch(:http_method)
+        @schema = args.fetch(:schema, nil)
+        @request_schema = args.fetch(:request_schema, nil)
       end
 
       def matches?(request)

data/lib/api_sim/matchers.rb

@@ -18,7 +18,7 @@ module ApiSim
           response_code: overrides.fetch(:response_code),
           headers: overrides.fetch(:headers),
           response_body: overrides.fetch(:response_body),
-          body_matches: overrides.fetch('matcher', old_matcher.matcher)
+          body_matches: overrides.fetch('matcher', old_matcher.matcher),
         )
       else
         Matchers::StaticRequestMatcher.new(
@@ -28,6 +28,7 @@ module ApiSim
           headers: overrides.fetch(:headers),
           response_body: overrides.fetch(:response_body),
           schema: overrides.fetch(:schema),
+          request_schema: overrides.fetch(:request_schema)
         )
       end
     end

data/lib/api_sim/version.rb

@@ -1,3 +1,3 @@
 module ApiSim
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/lib/api_sim/views/responses/form.html.erb

@@ -32,7 +32,11 @@
 
       <div class="form-group">
         <label for="schema">Response schema</label>
-        <textarea type="text" class="form-control" id="schema" name="schema" data-prettify rows="25"><%= h (params['schema'] || config.schema) %></textarea>
+        <textarea type="text" class="form-control" id="schema" name="schema" data-prettify rows="25"><%= h (params[:schema] || config.schema) %></textarea>
+      </div>
+      <div class="form-group">
+        <label for="request-schema">Request schema</label>
+        <textarea class="form-control" id="request-schema" name="request-schema" data-prettify rows="12"><%= h (params[:request_schema] || config.request_schema) %></textarea>
       </div>
     </div>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_sim
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra