api_sim 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33ae9a739bbdc45eb8993364f722ccfea5c87804
-  data.tar.gz: d727a1055689f9f901f5f99462158822335e024d
+SHA256:
+  metadata.gz: 327685bacf8a6f9deecaa212e828fb2357c733f56ff84b34e55d883014c54d01
+  data.tar.gz: bf1feab48cb25aadbbca0f5a6602c1ed47c4781b40833033857f1c0a40dfac62
 SHA512:
-  metadata.gz: b2861183246f952a21ed526d5b4de6d980bd34225bc656e1eef26109c54136c9a6aa59e25e73011505307e27bd74cebb6b213a63b60454b0705c76d6853cd509
-  data.tar.gz: 87ad7f7ab2387625233e075d2eb90cba7dba7244d75846d71fdf65869d96fd4135eae2bad3bd3c98b9ea5b87554da5331b279e5d5e5dc9aa8882b7af7fb35518
+  metadata.gz: fdd5e1c789269cd0bd2e87e5a9616987f4ff726406e43f9070e668120e2fc548de0dd5d5434c77273bb55cb850b7e357976b27cdc12f2c51c00277af698782b5
+  data.tar.gz: 887ab0200e2597021038c29f2f518b0f8c3d48f68160c54cecd738325ee59fd137ab758f6b05d3ed3f4d52fff241f656fdd3c22cad21f31ca5fbc51633b004a0

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.4.1
+  - 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,11 +19,11 @@ 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 "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"

data/examples/basic/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    api_sim (6.1.1)
+    api_sim (7.0.0)
       json-schema (>= 2.5)
       mustermann (~> 1.0.0.beta2)
       nokogiri (~> 1.6)
@@ -10,23 +10,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    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.3.0)
-    mustermann (1.0.1)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    public_suffix (3.0.1)
-    rack (1.6.8)
-    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.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -35,4 +35,4 @@ DEPENDENCIES
   api_sim!
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

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/lib/api_sim/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_sim
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,14 +16,14 @@ 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
@@ -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
@@ -189,8 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A DSL on top of sinatra for building application simulators