http-mock-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4b44a4091d6546ca6be584fd530cc51f1c17274
+  data.tar.gz: 63e3f4d49cac17d2bee75001e2d9d9812621251d
+SHA512:
+  metadata.gz: d8a7b37fea4e2a8ef36d77586bf243ceb93f579963c74780c4bb90d6cefbb7aad96b640b2e7b62cf593d93f81779bd59feff50261da509480c0ce14e58c1d696
+  data.tar.gz: d5a7d905096892035c2b0e1b8eba3814db53c9939325eca319f492794973f6b3726616cc592fdfcad9526e6276dcb30f89af889ebcf443c2739edcfc8530be85

data/.gitignore

@@ -0,0 +1 @@
+_misc/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.0)
+    mustermann (1.0.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-protection (2.0.1)
+      rack
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  sinatra
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2018 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# HTTP Mock Server [![Gem Version](https://badge.fury.io/rb/http-mock-server.svg)](https://badge.fury.io/rb/http-mock-server)
+
+A Ruby HTTP Mock Server based on Sinatra. JSON responses.
+
+Features:
+- simple config YAML file
+- routes reloaded every time (but only the updated ones)
+- string interpolations on response body (even *binding.pry* to inspect a request)
+
+## Install
+
+`gem install http-mock-server`
+
+## Usage
+
+- Create a *mock.yml* config file in the current directory (see the [example](mock.yml))
+- Execute: `http-mock-server`
+
+## Config example
+
+```yml
+config:
+  # no_cors: true  # don't send CORS headers
+  port: 8080       # server port
+  # timeout: 10    # response timeout
+  verbose: true    # shows request params
+not_found:
+  body:
+    message: This is not the path you are looking for...
+routes:
+  -
+    get: '/posts'
+    headers:
+      'A-Random-Header': Something
+    body:
+      message: List of posts
+  -
+    get: '/posts/:id'
+    body:
+      content: A random number {rand} !
+      extra:
+        today: Today is {DateTime.now}
+        request: Post id {params[:id]} - request path {request.path}
+        more:
+          is_first: "conditional check {params[:id] == '1' ? 'first' : 'other'}"
+  -
+    get: '/pry'
+    body:
+      message: '{binding.pry}'
+  -
+    post: '/posts'
+    status: 201
+    body:
+      code: 201
+      result: Ok
+  -
+    delete: '*'
+    status: 405
+    body:
+      message: Please don't do it
+  -
+    options: '*'
+    status: 200
+    headers:
+      'Access-Control-Allow-Origin': '*'
+      'Access-Control-Allow-Methods': 'HEAD,GET,PUT,DELETE,OPTIONS'
+      'Access-Control-Allow-Headers': 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept'
+      'Access-Control-Expose-Headers': 'X-Total-Count'
+```
+
+## Notes
+
+- Routes are loaded from the Yaml config at each request, but it updates only the exiting routes; new / old routes are ignored, you have to restart *http-mock-server* to include them
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+## Contributors
+
+- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
+
+## License
+
+[MIT](LICENSE.txt)

data/bin/http-mock-server

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENV['http_mock_server_bin'] = '1'
+
+require 'rack'
+require 'tilt'
+require 'http-mock-server'

data/http-mock-server.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path( '../lib', __FILE__ )
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+
+Gem::Specification.new do |spec|
+  spec.name        = 'http-mock-server'
+  spec.version     = '0.1.0'
+  spec.authors     = [ 'Mattia Roccoberton' ]
+  spec.email       = 'mat@blocknot.es'
+  spec.homepage    = 'https://github.com/blocknotes/http-mock-server'
+  spec.summary     = 'HTTP Mock Server'
+  spec.description = 'A Ruby HTTP Mock Server based on Sinatra'
+  spec.platform    = Gem::Platform::RUBY
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'pry', '~> 0.11'
+  spec.add_runtime_dependency 'sinatra', '~> 2.0'
+end

data/lib/http-mock-server.rb

@@ -0,0 +1,117 @@
+require 'pry'
+require 'sinatra/base'
+require 'yaml'
+
+CONFIG_FILE = 'mock.yml'
+MIME_JSON = ['application/json']
+
+$config = YAML.load File.read(CONFIG_FILE) rescue begin
+    puts "Config file not found: #{CONFIG_FILE}"
+    exit 1
+  end
+$config['config'] ||= {}
+$config['routes'] ||= []
+
+class HttpMockServer < Sinatra::Base
+  METHODS = %w(connect delete get head options patch post put trace)
+
+  # set :environment, :development
+  set :port, $config['config']['port'] if $config['config']['port']
+  set :server_settings, timeout: $config['config']['timeout'] || 0
+
+  configure do
+  end
+
+  before do
+    content_type :json
+    unless $config['config']['no_cors']
+      headers(
+        'Access-Control-Allow-Origin'  => '*',
+        'Access-Control-Allow-Methods' => 'POST, GET, PUT, DELETE, OPTIONS',
+        'Access-Control-Allow-Headers' => 'Origin, Content-Type, Accept, Authorization, Token',
+      )
+    end
+  end
+
+  $config['routes'].each_with_index do |rt, i|
+    method = nil
+    METHODS.each do |m|
+      method = m if rt[m]
+      break if method
+    end
+    if method
+      send method, rt[method] do
+        route = reload_route i
+        code = route['status'] || 200
+        log code, method.upcase, request.path
+        ( route['headers'] || {} ).each do |k, v|
+          response.headers[k] = v
+        end
+        status code
+        if route['body']
+          content = route['body'].dup
+          traverse! content
+          content.to_json
+        end
+      end
+    end
+  end
+
+  if $config['not_found']
+    not_found do
+      route = reload_route(-1)
+      code = route['status'] || 404
+      log code, request.path, ''
+      ( route['headers'] || {} ).each do |k, v|
+        response.headers[k] = v
+      end
+      status code
+      if route['body']
+        content = route['body'].dup
+        traverse! content
+        content.to_json
+      end
+    end
+  end
+
+  def log( code, method, path )
+    print "#{DateTime.now.strftime('%F %T')} - [#{code}] #{method} #{path}\n"
+    if $config['config']['verbose']
+      if MIME_JSON.include? env['CONTENT_TYPE']
+        request.body.rewind
+        data = JSON.parse request.body.read
+        print "  PARAMS_JSON: #{data.to_s}\n" unless data.empty?
+      else
+        pars = params.dup
+        pars.delete 'captures'
+        pars.delete 'splat'
+        print "  PARAMS_DATA: #{pars.to_s}\n" if pars.any?
+      end
+    end
+  end
+
+  def interpolate( string )
+    return '' unless string
+    vars = string.scan( /{(.*?)}/ ).flatten.map{|t| eval(t)}
+    string.gsub( /{(.*?)}/, '%s' ) % vars
+  end
+
+  def reload_route( route_id )
+    config = YAML.load File.read(CONFIG_FILE) || {}
+    return config['not_found'] || {} if route_id < 0
+    return {} if !config['routes'] || !config['routes'][route_id]
+    config['routes'][route_id]
+  end
+
+  def traverse!( hash )
+    hash.each do |k, v|
+      if v.is_a?(Hash)
+        traverse! v
+      else
+        hash[k] = interpolate v
+      end
+    end
+  end
+
+  run! if app_file == $0 || ENV['http_mock_server_bin']
+end

data/mock.yml

@@ -0,0 +1,48 @@
+---
+config:
+  # no_cors: true  # don't send CORS headers
+  port: 8080       # server port
+  # timeout: 10    # response timeout
+  verbose: true    # shows request params
+not_found:
+  body:
+    message: This is not the path you are looking for...
+routes:
+  -
+    get: '/posts'
+    headers:
+      'A-Random-Header': Something
+    body:
+      message: List of posts
+  -
+    get: '/posts/:id'
+    body:
+      content: A random number {rand} !
+      extra:
+        today: Today is {DateTime.now}
+        request: Post id {params[:id]} - request path {request.path}
+        more:
+          is_first: "conditional check {params[:id] == '1' ? 'first' : 'other'}"
+  -
+    get: '/pry'
+    body:
+      message: '{binding.pry}'
+  -
+    post: '/posts'
+    status: 201
+    body:
+      code: 201
+      result: Ok
+  -
+    delete: '*'
+    status: 405
+    body:
+      message: Please don't do it
+  -
+    options: '*'
+    status: 200
+    headers:
+      'Access-Control-Allow-Origin': '*'
+      'Access-Control-Allow-Methods': 'HEAD,GET,PUT,DELETE,OPTIONS'
+      'Access-Control-Allow-Headers': 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept'
+      'Access-Control-Expose-Headers': 'X-Total-Count'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: http-mock-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby HTTP Mock Server based on Sinatra
+email: mat@blocknot.es
+executables:
+- http-mock-server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/http-mock-server
+- http-mock-server.gemspec
+- lib/http-mock-server.rb
+- mock.yml
+homepage: https://github.com/blocknotes/http-mock-server
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: HTTP Mock Server
+test_files: []