api_sim 5.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c78fb49e9b8055b9c57b7d929f14e3ccdc550400
-  data.tar.gz: f366b4b136aa46472c39ec18e2be8e66032e01ac
+SHA256:
+  metadata.gz: 327685bacf8a6f9deecaa212e828fb2357c733f56ff84b34e55d883014c54d01
+  data.tar.gz: bf1feab48cb25aadbbca0f5a6602c1ed47c4781b40833033857f1c0a40dfac62
 SHA512:
-  metadata.gz: 46122772e2556bc430916fa25d89f0cdbbb864ef1d980a6644674da31f7133038ca2b3af48ca393544e0d0077c686e7f811f54cbc0a363ba16827d6bfe639490
-  data.tar.gz: c42b0887edaed2dad8ffde3f39d6bf661607e89828041f2e6cda7729a927f55ec0374b21a6fe9761f7e01f9934b1bfb1c2c72942555be7db33e0acd592edf49a
+  metadata.gz: fdd5e1c789269cd0bd2e87e5a9616987f4ff726406e43f9070e668120e2fc548de0dd5d5434c77273bb55cb850b7e357976b27cdc12f2c51c00277af698782b5
+  data.tar.gz: 887ab0200e2597021038c29f2f518b0f8c3d48f68160c54cecd738325ee59fd137ab758f6b05d3ed3f4d52fff241f656fdd3c22cad21f31ca5fbc51633b004a0

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.7.0

data/README.md

@@ -54,12 +54,62 @@ After which the simulators should be running on port 9292.
 
 ## API
 
+API Sim has an HTTP API that allows you, the developer, to manage responses and verify
+requests.
+
+### The "Request/Response" API
+
+
+#### Modify the response from an endpoint
+
+The star in the path should match the request path that you want to update.
+The "method" in the PUT request should match the HTTP method for the request.
+```HTTP
+HTTP/1.1 PUT /response/*
+{
+  "method": "post",
+  "status": 999,
+  "body": "{\"id\": 99}",
+  "headers": {"NEW-HEADER": "output"}
+}
+```
+
+
+
+#### Read requests made to an endpoint
+
+The star in the path should match the path that you want to retrieve requests for.
+```HTTP
+GET /requests/:method/*
+```
+
+```HTTP
+HTTP/1.1 200 OK
+
+[
+  {}
+]
+```
+
+### 498
+
 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.
 
+## UI
+
+The simulator application has a UI for manipulating and monitoring requests and responses.
+You can view this UI by visiting `/ui` at the URL of the simulator.
+
+Additionally, you can configure the endpoint for viewing the UI by adding to your config.ru.
+
+```ruby
+ui_root '/path/to/ui'
+```
+
 ## 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/api_sim.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sinatra", '~> 1.0'
-  spec.add_dependency "nokogiri", '~> 1.6.7'
+  spec.add_dependency "sinatra", '~> 2.0'
+  spec.add_dependency "nokogiri", '~> 1.6'
   spec.add_dependency "json-schema", '>= 2.5'
   spec.add_dependency "mustermann", '~> 1.0.0.beta2'
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "capybara", "~> 2.7.0"
+  spec.add_development_dependency "capybara", "~> 2.7"
 end

data/examples/basic/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: ../..
   specs:
-    api_sim (5.0.0)
+    api_sim (7.0.0)
       json-schema (>= 2.5)
       mustermann (~> 1.0.0.beta2)
-      nokogiri (~> 1.6.7)
-      sinatra (~> 1.0)
+      nokogiri (~> 1.6)
+      sinatra (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
-    json-schema (2.8.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    json-schema (2.8.1)
       addressable (>= 2.4)
-    mini_portile2 (2.1.0)
-    mustermann (1.0.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    public_suffix (2.0.5)
-    rack (1.6.5)
-    rack-protection (1.5.3)
+    mini_portile2 (2.4.0)
+    mustermann (1.0.3)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.1)
+    rack (1.6.11)
+    rack-protection (1.5.5)
       rack
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    tilt (2.0.7)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -35,4 +35,4 @@ DEPENDENCIES
   api_sim!
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

data/examples/basic/config.ru

@@ -3,7 +3,7 @@ require 'api_sim'
 ENDPOINT_JSON_SCHEMA = {type: "object", properties: {a: {type: "integer"}}}.to_json
 
 app = ApiSim.build_app do
-  configure_endpoint 'GET', '/endpoint?queryParam=foo', 'Hi!', 200, {'X-CUSTOM-HEADER' => 'easy as abc'}, ENDPOINT_JSON_SCHEMA
+  configure_endpoint 'GET', '/endpoint?queryParam=foo', 'Hi!', 201, {'X-CUSTOM-HEADER' => 'easy as abc'}, ENDPOINT_JSON_SCHEMA
   configure_endpoint 'GET', '/endpoint', 'Hi!', 200, {'X-CUSTOM-HEADER' => 'easy as abc'}, ENDPOINT_JSON_SCHEMA
   configure_endpoint 'GET', '/begin/:middle/end', 'You found an any-value path', 200, {'CONTENT-TYPE' => 'application/json'}
 

data/examples/cors/Gemfile.lock

@@ -1,31 +1,34 @@
 PATH
-  remote: ../../
+  remote: ../..
   specs:
-    api_sim (2.2.0)
+    api_sim (7.0.0)
       json-schema (>= 2.5)
-      nokogiri (~> 1.6.7)
-      sinatra (~> 1.0)
+      mustermann (~> 1.0.0.beta2)
+      nokogiri (~> 1.6)
+      sinatra (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
-    json-schema (2.6.2)
-      addressable (~> 2.3.8)
-    mini_portile2 (2.1.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
-    rack (1.6.4)
-    rack-cors (0.4.0)
-    rack-protection (1.5.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    mini_portile2 (2.4.0)
+    mustermann (1.0.3)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.1)
+    rack (1.6.11)
+    rack-cors (1.0.6)
+      rack (>= 1.6.0)
+    rack-protection (1.5.5)
       rack
-    sinatra (1.4.7)
+    sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    tilt (2.0.5)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -35,4 +38,4 @@ DEPENDENCIES
   rack-cors
 
 BUNDLED WITH
-   1.12.5
+   1.17.2

data/examples/with-fixtures/Gemfile.lock

@@ -1,30 +1,32 @@
 PATH
-  remote: ../../
+  remote: ../..
   specs:
-    api_sim (2.2.0)
+    api_sim (7.0.0)
       json-schema (>= 2.5)
-      nokogiri (~> 1.6.7)
-      sinatra (~> 1.0)
+      mustermann (~> 1.0.0.beta2)
+      nokogiri (~> 1.6)
+      sinatra (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
-    json-schema (2.6.2)
-      addressable (~> 2.3.8)
-    mini_portile2 (2.1.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
-    rack (1.6.4)
-    rack-protection (1.5.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    mini_portile2 (2.4.0)
+    mustermann (1.0.3)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.1)
+    rack (1.6.11)
+    rack-protection (1.5.5)
       rack
-    sinatra (1.4.7)
+    sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    tilt (2.0.5)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -33,4 +35,4 @@ DEPENDENCIES
   api_sim!
 
 BUNDLED WITH
-   1.12.5
+   1.17.2

data/examples/with-fixtures/config.ru

@@ -1,30 +1,8 @@
 require 'api_sim'
 require 'find'
 
-DATA_DIR = File.expand_path('./data', __dir__)
-endpoints = []
-Find.find(DATA_DIR) do |path|
-  next if Dir.exist?(path) # Skip directories
-  http_method = File.basename(path, '.json') # our files are their HTTP method with the mime-type as the extension
-  route = File.dirname(path).gsub(DATA_DIR, '') # the endpoint URL is everything else
-  response = JSON.parse(File.read(path))
-  status = response['status']
-  headers = response['headers']
-  body = response['body'].to_json
-  schema = response['schema'].to_json
-  puts "Configuring endpoint #{http_method} #{route}"
-  endpoints << [
-    http_method,
-    route,
-    body,
-    status,
-    headers,
-    schema
-  ]
-end
-
 app = ApiSim.build_app do
-  endpoints.each {|endpoint| configure_endpoint(*endpoint) }
+  configure_fixture_directory './data'
 end
 
 run app

data/lib/api_sim/app_builder.rb

@@ -9,9 +9,15 @@ module ApiSim
       config = self
       Sinatra.new(BuiltApp) do
         endpoints config.endpoint_configurations
+        ui_root config.ui_root || '/ui'
       end
     end
 
+    def ui_root(root = nil)
+      @ui_root = root if root
+      @ui_root
+    end
+
     def configure_endpoint(http_method, route, response_body, response_code=200, headers={}, schema_string='', request_schema: nil)
       endpoint_configurations.push(
         Matchers::StaticRequestMatcher.new(
@@ -48,14 +54,28 @@ module ApiSim
             headers: response[1],
             response_body: response[2],
             default: true,
-            body_matches: matcher
+            body_matches: matcher,
           )
         )
       end
     end
 
+    def configure_fixture_directory(dir)
+      dir = dir.chomp('/')
+      Dir[File.join(dir, "**/*.json.erb")].each do |path|
+        endpoint_match = path.match(%r{#{dir}([/\w+\_\-]+)/(GET|POST|PATCH|OPTIONS|HEAD|PUT|DELETE).json})
+        config = JSON.parse(File.read(path))
+        configure_endpoint endpoint_match[2],
+          endpoint_match[1],
+          config['body'].to_json,
+          config['status'],
+          config['headers'],
+          config['schema'].to_json
+      end
+    end
+
     def endpoint_configurations
       @endpoint_configurations ||= []
     end
   end
-end
+end

data/lib/api_sim/built_app.rb

@@ -2,59 +2,27 @@ require 'sinatra/base'
 require 'nokogiri'
 require 'json'
 require 'tilt/erb'
-require 'api_sim/view_helpers'
 require 'json-schema'
 require 'mustermann'
+require 'api_sim/view_helpers'
+require 'api_sim/ui_app'
 
 module ApiSim
   class BuiltApp < Sinatra::Base
     API_REQUEST_MATCHER = Mustermann.new('/requests/:method{+path}')
     use Rack::MethodOverride
 
-    helpers do
-      include ViewHelpers
-    end
-
     def self.endpoints(endpoints = nil)
       @endpoints = endpoints if endpoints
       return @endpoints
     end
 
-    get '/' do
-      erb :'index.html', layout: :'layout.html'
-    end
-
-    get '/ui/response/:method/*' do
-      @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
-      erb :'responses/form.html', layout: :'layout.html'
-    end
-
-    get '/ui/requests/:method/*' do
-      @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
-
-      erb :'requests/index.html', layout: :'layout.html'
-    end
-
-    post '/ui/response/:method/*' do
-      @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
-      unless params['schema'].empty?
-        @errors = JSON::Validator.fully_validate(JSON.parse(params['schema']), params['body'])
-        if @errors.any?
-          return erb :'responses/form.html', layout: :'layout.html'
-        end
+    def self.ui_root(root = nil)
+      if root
+        @ui_root = root
+        self.register UiApp.with_root(root)
       end
-      new_config = create_matcher_override(mimicked_request)
-
-      self.class.endpoints.unshift(new_config)
-      redirect to '/'
-    end
-
-    delete '/ui/response/:method/*' do
-      all_matching_matchers = matchers(mimicked_request)
-      all_matching_matchers.each &:reset!
-      non_default_matchers = all_matching_matchers.reject(&:default)
-      self.class.endpoints.delete_if { |endpoint| non_default_matchers.include?(endpoint) }
-      redirect to '/'
+      @ui_root
     end
 
     put '/response/*' do
@@ -141,7 +109,8 @@ module ApiSim
 
       @response_body = case request.env['CONTENT_TYPE']
       when %r{application/json} then
-        JSON.parse(request.body.read)
+        body = request.body.read
+        body.empty? ? {} : JSON.parse(body)
       when %r{text/xml} then
         Nokogiri::XML(request.body.read)
       when %r{application/x-www-form-urlencoded} then
@@ -165,6 +134,10 @@ module ApiSim
       end
     end
 
+    def route
+      "/#{params[:splat].first}"
+    end
+
     def blank?(item)
       item.nil? || item.empty?
     end

data/lib/api_sim/recorded_request.rb

@@ -23,10 +23,10 @@ module ApiSim
     private
     def parse_headers_from(request_env)
       request_env.select do |k, v|
-        k =~ /^HTTP_/
+        k =~ /^HTTP_/ || k =~ /CONTENT_TYPE/
       end.each_with_object({}) do |(k, v), h|
-        h[k.split('_')[1..-1].join('-')] = v
-      end.sort
+        h[k.gsub(/HTTP\_/, '').split('_').join('-').downcase] = v
+      end
     end
   end
 end

data/lib/api_sim/ui_app.rb

@@ -0,0 +1,50 @@
+require 'sinatra/base'
+require 'api_sim/view_helpers'
+
+module ApiSim
+  module UiApp
+    def self.with_root(root)
+      Module.new do
+        def self.registered(app)
+          app.helpers ViewHelpers
+          app.get "#{app.ui_root}" do
+            erb :'index.html', layout: :'layout.html'
+          end
+
+          app.get "#{app.ui_root}/response/:method/*" do
+            @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
+            erb :'responses/form.html', layout: :'layout.html'
+          end
+
+          app.get "#{app.ui_root}/requests/:method/*" do
+            @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
+
+            erb :'requests/index.html', layout: :'layout.html'
+          end
+
+          app.post "#{app.ui_root}/response/:method/*" do
+            @config = matcher(faux_request(method: http_method, path: route, body: faux_body, query: request.query_string))
+            unless params['schema'].empty?
+              @errors = JSON::Validator.fully_validate(JSON.parse(params['schema']), params['body'])
+              if @errors.any?
+                return erb :'responses/form.html', layout: :'layout.html'
+              end
+            end
+            new_config = create_matcher_override(mimicked_request)
+
+            self.class.endpoints.unshift(new_config)
+            redirect to app.ui_root
+          end
+
+          app.delete "#{app.ui_root}/response/:method/*" do
+            all_matching_matchers = matchers(mimicked_request)
+            all_matching_matchers.each &:reset!
+            non_default_matchers = all_matching_matchers.reject(&:default)
+            self.class.endpoints.delete_if {|endpoint| non_default_matchers.include?(endpoint)}
+            redirect to app.ui_root
+          end
+        end
+      end
+    end
+  end
+end

data/lib/api_sim/version.rb

@@ -1,3 +1,3 @@
 module ApiSim
-  VERSION = "5.1.0"
+  VERSION = "8.0.0"
 end

data/lib/api_sim/view_helpers.rb

@@ -16,14 +16,10 @@ module ApiSim
       @config
     end
 
-    def route
-      "/#{params[:splat].first}"
-    end
-
     def link_to_response_edit(endpoint)
       match = endpoint.match_on_body? ? endpoint.matcher.source : ''
       <<-HTML
-      <a href="/ui/response/#{endpoint.http_method}#{endpoint.route}?match=#{match}">
+      <a href="#{ui_root}/response/#{endpoint.http_method}#{endpoint.route}?match=#{match}">
         #{endpoint.route}
       </a>
       HTML
@@ -36,7 +32,7 @@ module ApiSim
     def link_to_read_requests(endpoint)
       match = endpoint.match_on_body? ? endpoint.matcher.source : ''
       <<-HTML
-        <a href="/ui/requests/#{endpoint.http_method}#{endpoint.route}?match=#{match}">
+        <a href="#{ui_root}/requests/#{endpoint.http_method}#{endpoint.route}?match=#{match}">
           #{endpoint.requests.count}
         </a>
       HTML
@@ -49,5 +45,9 @@ module ApiSim
         ''
       end
     end
+
+    def ui_root
+      self.class.ui_root
+    end
   end
-end
+end

data/lib/api_sim/views/index.html.erb

@@ -25,7 +25,7 @@
         <%= link_to_read_requests endpoint %>
       </td>
       <td>
-        <form action="/ui/response/<%= endpoint.http_method %><%= endpoint.route %>" method="post">
+        <form action="<%= ui_root %>/response/<%= endpoint.http_method %><%= endpoint.route %>" method="post">
           <input type="hidden" value="delete" name="_method">
           <input type="hidden" value="<%= endpoint_match endpoint %>" name="match">
           <button class='btn-link' type="submit">Reset</button>
@@ -34,4 +34,4 @@
     </tr>
   <% end %>
   </tbody>
-</table>
+</table>

data/lib/api_sim/views/requests/index.html.erb

@@ -30,7 +30,7 @@
             <td>
               <ul>
               <% request.headers.each do |header, value| %>
-                <li><%= header %>: <%= value %></li>
+                <li><%= header.upcase %>: <%= value %></li>
               <% end %>
               </ul>
             </td>

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

@@ -2,7 +2,7 @@
   <h1>Simulators</h1>
   <h2>Response for <%= config.http_method %> <%= config.route %></h2>
 </div>
-<form action="/ui/response/<%= config.http_method %><%= config.route %>" method="post">
+<form action="<%= ui_root %>/response/<%= config.http_method %><%= config.route %>" method="post">
   <div class="row">
     <% if @errors %>
       <div class="alert alert-danger">
@@ -51,4 +51,4 @@
       <button class='btn btn-primary' type="submit">Save</button>
     </div>
   </div>
-</form>
+</form>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_sim
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.7'
 description: A DSL on top of sinatra for building application simulators
 email:
 - dugancathal@gmail.com
@@ -150,7 +150,7 @@ files:
 - examples/with-fixtures/Gemfile
 - examples/with-fixtures/Gemfile.lock
 - examples/with-fixtures/config.ru
-- examples/with-fixtures/data/users/1/GET.json
+- examples/with-fixtures/data/users/1/GET.json.erb
 - lib/api_sim.rb
 - lib/api_sim/app_builder.rb
 - lib/api_sim/built_app.rb
@@ -163,6 +163,7 @@ files:
 - lib/api_sim/public/app.js
 - lib/api_sim/public/favicon.ico
 - lib/api_sim/recorded_request.rb
+- lib/api_sim/ui_app.rb
 - lib/api_sim/version.rb
 - lib/api_sim/view_helpers.rb
 - lib/api_sim/views/index.html.erb
@@ -188,8 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A DSL on top of sinatra for building application simulators