api_sim 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbfb4f82a254fc887ef63f48e4c3a04733dcae00
-  data.tar.gz: b23ca755915f2cfe063cd7c45fae8af53d5c0455
+  metadata.gz: b861496c5eace589914cf22783667e76a98b9e58
+  data.tar.gz: 18936141652259c619b2432669a2b926ffe33997
 SHA512:
-  metadata.gz: f2867efebd7de8faf3a1f9427f9125d8be5c75e07e51183e218c13d7fd71de933972190e18d565600da81daf31d00f507c52d932f50ffb5eee180d8deb63c6e8
-  data.tar.gz: b174edc0615398d14e777e4e23fd53080712adecf11bb98067ab0b10085237c2f1ed93970d9aaa771581811a8be96102b89702e8f50bdfb8764682367e8c13fd
+  metadata.gz: 6916e181541ce761dd3fdf4182efc6e2b0f45ebf0c2e61aa893f7b8e5e27e5be9e41454827f3a3c43b1156e5673c0adce7ab30db76a715821266cb717e903f44
+  data.tar.gz: d4518904d1c87e9684ed66453cafe275991ed4dd0f5f544f6d48a67407c8763679bc2a715827e7c8c2b4381cded513aa085f6fa149d5424bb571a12bc42f0b65

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ```ruby
 require 'api_sim'
 
-ENDPOINT_JSON_SCHEMA = {"type": "object", "properties": {"a": {"type": "integer"}}}.to_json
+ENDPOINT_JSON_SCHEMA = {type: "object", properties: {a: {type: "integer"}}}.to_json
 
 app = ApiSim.build_app do
   configure_endpoint 'GET', '/endpoint', 'Hi!', 200, {'X-CUSTOM-HEADER' => 'easy as abc'}, ENDPOINT_JSON_SCHEMA
@@ -43,11 +43,11 @@ end
 run app
 ```
 
-The above is an exact copy of the `config.example.ru` from the root of the repo. You can boot this without too much
+The above is an exact copy of the `basic/config.ru` from the examples. You can boot this without too much
 effort by running:
 
 ```bash
-bundle check || bundle install && bundle exec rackup -Ilib config.example.ru
+cd examples/basic && bundle check || bundle install && bundle exec rackup -I../../lib
 ```
 
 After which the simulators should be running on port 9292.

data/examples/basic/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'api_sim', path: '../../'

data/examples/basic/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: ../../
+  specs:
+    api_sim (2.2.0)
+      json-schema (>= 2.5)
+      nokogiri (~> 1.6.7)
+      sinatra (~> 1.0)
+
+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)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_sim!
+
+BUNDLED WITH
+   1.12.5

data/{config.example.ru → examples/basic/config.ru}

@@ -1,6 +1,6 @@
 require 'api_sim'
 
-ENDPOINT_JSON_SCHEMA = {"type": "object", "properties": {"a": {"type": "integer"}}}.to_json
+ENDPOINT_JSON_SCHEMA = {type: "object", properties: {a: {type: "integer"}}}.to_json
 
 app = ApiSim.build_app do
   configure_endpoint 'GET', '/endpoint', 'Hi!', 200, {'X-CUSTOM-HEADER' => 'easy as abc'}, ENDPOINT_JSON_SCHEMA

data/examples/cors/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'api_sim', path: '../../'
+gem 'rack-cors', require: 'rack/cors'

data/examples/cors/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: ../../
+  specs:
+    api_sim (2.2.0)
+      json-schema (>= 2.5)
+      nokogiri (~> 1.6.7)
+      sinatra (~> 1.0)
+
+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)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_sim!
+  rack-cors
+
+BUNDLED WITH
+   1.12.5

data/examples/cors/README.md

@@ -0,0 +1,6 @@
+# CORS Example for APISim
+
+As a fairly common usecase for things like this is to simulate APIs for static UI apps,
+this example shows how you can use the Rack Middleware Rack-CORS to setup CORS support.
+
+Like the other examples, you can just copy and paste this, and tweak to your liking.

data/examples/cors/config.ru

@@ -0,0 +1,19 @@
+require 'rack/cors'
+require 'api_sim'
+
+app = ApiSim.build_app do
+  configure_endpoint 'GET', '/endpoint', 'Hi!', 200, {'X-CUSTOM-HEADER' => 'easy as abc'}
+end
+
+# See the documentation for Rack::Cors for all the options here.
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '/*',
+      :methods => [:get, :post, :delete, :put, :patch, :options, :head],
+      :headers => :any,
+      :max_age => 600
+  end
+end
+
+run app

data/examples/with-fixtures/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'api_sim', path: '../../'

data/examples/with-fixtures/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: ../../
+  specs:
+    api_sim (2.2.0)
+      json-schema (>= 2.5)
+      nokogiri (~> 1.6.7)
+      sinatra (~> 1.0)
+
+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)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_sim!
+
+BUNDLED WITH
+   1.12.5

data/examples/with-fixtures/config.ru

@@ -0,0 +1,30 @@
+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) }
+end
+
+run app

data/examples/with-fixtures/data/users/1/GET.json

@@ -0,0 +1,17 @@
+{
+  "status": 201,
+  "body": {
+    "id": 1,
+    "name": "Polly Peppers"
+  },
+  "headers": {
+    "Content-Type": "application/json"
+  },
+  "schema": {
+    "type": "object",
+    "properties": {
+      "id": {"type": "integer"},
+      "name": {"type": "string"}
+    }
+  }
+}

data/lib/api_sim/built_app.rb

@@ -36,7 +36,7 @@ module ApiSim
     post '/ui/response/:method/*' do
       @config = matcher(faux_request(http_method, route, faux_body))
       unless params['schema'].empty?
-        @errors = JSON::Validator.fully_validate(params['schema'], params['body'])
+        @errors = JSON::Validator.fully_validate(JSON.parse(params['schema']), params['body'])
         if @errors.any?
           return erb :'responses/form.html', layout: :'layout.html'
         end
@@ -79,7 +79,7 @@ module ApiSim
       endpoint.requests.to_json
     end
 
-    %i(get post put patch delete).each do |http_method|
+    %i(get post put patch delete options).each do |http_method|
       public_send(http_method, '/*') do
         endpoint = matcher(request)
         endpoint.record_request(request)

data/lib/api_sim/matchers/base_matcher.rb

@@ -49,6 +49,19 @@ module ApiSim
       def response(_)
         [response_code, headers, response_body]
       end
+
+      protected
+
+      def matches_route_pattern?(request)
+        route_tokens = route.split('/')
+        request_tokens = request.path.split('/')
+
+        return false if route_tokens.count != request_tokens.count && !route_tokens.include?('*')
+        route_tokens.zip(request_tokens).all? do |matcher_part, request_part|
+          break true if matcher_part == '*'
+          matcher_part == request_part || matcher_part.start_with?(':')
+        end
+      end
     end
   end
 end

data/lib/api_sim/matchers/dynamic_request_matcher.rb

@@ -15,7 +15,7 @@ module ApiSim
       end
 
       def matches?(request)
-        request.path == route && request.request_method == http_method && matcher.call(request)
+        matches_route_pattern?(request) && request.request_method == http_method && matcher.call(request)
       end
 
       def response(request)
@@ -33,4 +33,4 @@ module ApiSim
       end
     end
   end
-end
+end

data/lib/api_sim/matchers/static_request_matcher.rb

@@ -18,11 +18,7 @@ module ApiSim
       end
 
       def matches?(request)
-        matches_dynamic_path?(request) && request.request_method == http_method && matcher.call(request)
-      end
-
-      def custom_matcher?
-        matcher != ALWAYS_TRUE_MATCHER
+        matches_route_pattern?(request) && request.request_method == http_method && matcher.call(request)
       end
 
       def overridden!
@@ -33,25 +29,11 @@ module ApiSim
         !!@overridden
       end
 
-      def requests
-        @requests ||= []
-      end
-
       def to_s
         <<-DOC.gsub(/^\s+/, '')
           #{http_method} #{route} -> (#{response_code}) #{response_body[0..20]}...
         DOC
       end
-
-      def matches_dynamic_path?(request)
-        route_tokens = route.split('/')
-        request_tokens = request.path.split('/')
-
-        return false unless route_tokens.count == request_tokens.count
-        route_tokens.zip(request_tokens).all? do |matcher_part, request_part|
-          matcher_part == request_part || matcher_part.start_with?(':')
-        end
-      end
     end
   end
-end
+end

data/lib/api_sim/version.rb

@@ -1,3 +1,3 @@
 module ApiSim
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_sim
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -126,7 +126,17 @@ files:
 - api_sim.gemspec
 - bin/console
 - bin/setup
-- config.example.ru
+- examples/basic/Gemfile
+- examples/basic/Gemfile.lock
+- examples/basic/config.ru
+- examples/cors/Gemfile
+- examples/cors/Gemfile.lock
+- examples/cors/README.md
+- examples/cors/config.ru
+- examples/with-fixtures/Gemfile
+- examples/with-fixtures/Gemfile.lock
+- examples/with-fixtures/config.ru
+- examples/with-fixtures/data/users/1/GET.json
 - lib/api_sim.rb
 - lib/api_sim/app_builder.rb
 - lib/api_sim/built_app.rb