erithmetic-mountebank 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5dae41e4f0fcd04086d1d174fac9a46f6b5dc4872e214a81cc5311284a67d5fc
+  data.tar.gz: 8d29433c98194dea11895138e880af203651e78453316b2c4270720d8c168110
+SHA512:
+  metadata.gz: 21bfbc0344bb4e8a0fc4f3ffe0af91007b731ae32a0a6c072e94448ccc1dda30510b73999482474fbc9b8f80abb2f3602ffa96f9a2b80c26dd73fac0b747600d
+  data.tar.gz: 5d1b8b87cd02c468500211e1bd5a67e713cd6cad2b6d71560c548f6d7bd5861e258b4863aafdbaa3d65714fcf4b74cb54002d7931cab03d840e22046c64f442e

data/.env

@@ -0,0 +1,2 @@
+MOUNTEBANK_SERVER=127.0.0.1
+MOUNTEBANK_PORT=2525

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+mb.log
+mb.pid
+tags
+.idea/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mountebank.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Cheng
+
+MIT License
+
+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,139 @@
+# Mountebank
+
+A simple Ruby library that lets you manage your [Mountebank test server](http://www.mbtest.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mountebank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mountebank
+
+## Usage
+
+### Pre-Requisite
+
+Install Mountebank:
+
+```
+npm install -g mountebank --production
+```
+
+Start Mountebank:
+
+```
+mb --allowInjection
+```
+
+I recommend reading the [Mountebank documentation](http://www.mbtest.org/docs/api/overview) for a deeper understanding of their API.
+
+### Initialization
+
+1. Add these to you environment hash (eg. add to your `.env` file)
+
+```
+MOUNTEBANK_SERVER=127.0.0.1
+MOUNTEBANK_PORT=2525
+```
+
+2. Require the lib in your `spec_helper`.
+
+```ruby
+require 'mountebank'
+```
+
+### Get all available imposters
+
+```ruby
+Mountebank.imposters
+```
+
+### Create Imposter
+
+```ruby
+port = 4545
+protocol = Mountebank::Imposter::PROTOCOL_HTTP
+imposter = Mountebank::Imposter.create(port, protocol)
+```
+
+### Create Imposter with Stub
+
+```ruby
+port = 4545
+protocol = Mountebank::Imposter::PROTOCOL_HTTP
+imposter = Mountebank::Imposter.build(port, protocol)
+
+# Create a response
+status_code = 200
+headers = {"Content-Type" => "application/json"}
+body = {foo:"bar"}.to_json
+response = Mountebank::Stub::HttpResponse.create(status_code, headers, body)
+
+imposter.add_stub(response)
+imposter.save!
+```
+
+Check the URL:
+```
+curl http://127.0.0.1:4545
+```
+
+### Get all stubs
+
+```ruby
+imposter = Mountbank.imposters.first
+puts imposter.stubs
+```
+
+### Create Imposter with Stub & Predicate
+
+```ruby
+port = 4545
+protocol = Mountebank::Imposter::PROTOCOL_HTTP
+imposter = Mountebank::Imposter.build(port, protocol)
+
+# Create a response
+status_code = 200
+headers = {"Content-Type" => "application/json"}
+body = {foo:"bar2"}.to_json
+response = Mountebank::Stub::HttpResponse.create(status_code, headers, body)
+
+# Create a predicate
+data = {equals: {path:"/test"}}
+predicate = Mountebank::Stub::Predicate.new(data)
+
+imposter.add_stub(response, predicate)
+imposter.save!
+```
+
+Check the URL:
+```
+curl http://127.0.0.1:4545/test
+```
+
+### Create a response with behaviors
+[Behaviors](http://www.mbtest.org/docs/api/behaviors) can be passed through when creating a stub http response.
+```ruby
+response = Mountebank::Stub::HttpResponse.create(status_code, headers, body, {wait: 1000}) # Wait 1 second before responding
+```
+
+## Running Specs
+
+The current set of specs require the Mountebank instance to be started with the `--mock` flag.
+
+## Contributing
+
+1. Fork it ( https://github.com/CoderKungfu/mountebank/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'dotenv/tasks'
+
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+task :default => [:dotenv, :spec]
+

data/lib/mountebank/helper.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+
+module Mountebank
+  class Helper
+    # Convert Ruby Hash keys into symbols
+    # Source: https://gist.github.com/Integralist/9503099
+    def self.symbolize(obj)
+      return obj.reduce({}) do |memo, (k, v)|
+        memo.tap { |m| m[k.to_sym] = symbolize(v) }
+      end if obj.is_a? Hash
+
+      return obj.reduce([]) do |memo, v|
+        memo << symbolize(v); memo
+      end if obj.is_a? Array
+
+      obj
+    end
+  end
+
+  class SymbolizeKeys < ::Faraday::Middleware
+    def initialize(app = nil, options = {})
+      super(app)
+      @options = options
+      @content_types = Array(options[:content_type])
+    end
+
+    def call(environment)
+      @app.call(environment).on_complete do |env|
+        if env[:body].is_a? Hash
+          env[:body] = Helper.symbolize(env[:body])
+        end
+      end
+    end
+  end
+
+  if ::Faraday::Middleware.respond_to? :register_middleware
+    ::Faraday::Response.register_middleware :symbolize_keys => lambda { Mountebank::SymbolizeKeys }
+  end
+end

data/lib/mountebank/imposter.rb

@@ -0,0 +1,134 @@
+module Mountebank
+  class Imposter
+    attr_reader :port, :protocol, :name, :stubs, :requests, :matches, :mode, :record_requests
+
+    PROTOCOL_HTTP = 'http'
+    PROTOCOL_HTTPS = 'https'
+    PROTOCOL_SMTP = 'smtp'
+    PROTOCOL_TCP = 'tcp'
+
+    PROTOCOLS = [
+      PROTOCOL_HTTP,
+      PROTOCOL_HTTPS,
+      PROTOCOL_SMTP,
+      PROTOCOL_TCP
+    ]
+
+    CREATE_PARAMS_HTTP = [:protocol, :port, :name, :stubs]
+    CREATE_PARAMS_HTTPS = [:protocol, :port, :name, :stubs]
+    CREATE_PARAMS_TCP = [:protocol, :mode, :mode, :name, :stubs]
+    CREATE_PARAMS_SMTP = [:protocol, :port, :name]
+
+    def initialize(data={})
+      set_attributes(data)
+    end
+
+    def self.build(port, protocol=PROTOCOL_HTTP, options={})
+      raise 'Invalid port number' unless port.is_a? Integer
+      raise 'Invalid protocol' unless PROTOCOLS.include?(protocol)
+
+      data = {port: port, protocol: protocol}.merge(options)
+      Mountebank::Imposter.new(data)
+    end
+
+    def save!
+      delete!
+      response = Network.post('/imposters', replayable_data)
+      return reload if response.success?
+
+      false
+    end
+
+    def self.create(port, protocol=PROTOCOL_HTTP, options={})
+      self.build(port, protocol, options).save!
+    end
+
+    def self.find(port)
+      imposter_data = Imposter.get_imposter_config(port)
+      return Mountebank::Imposter.new(imposter_data) unless imposter_data.empty?
+
+      false
+    end
+
+    def self.delete(port)
+      response = Network.delete("/imposters/#{port}")
+      response.success? && !response.body.empty?
+    end
+
+    def delete!
+      Imposter.delete(@port)
+    end
+
+    def reload
+      data = Imposter.get_imposter_config(@port)
+      set_attributes(data) unless data.empty?
+
+      self
+    end
+
+    def add_stub(response=nil, predicate=nil)
+      responses, predicates = [], []
+
+      if response.is_a? Array
+        responses = response
+      elsif response.is_a? Mountebank::Stub::Response
+        responses << response
+      end
+
+      if predicate.is_a? Array
+        predicates = predicate
+      elsif predicate.is_a? Mountebank::Stub::Predicate
+        predicates << predicate
+      end
+
+      @stubs << Mountebank::Stub.create(responses, predicates)
+    end
+
+    def replayable_data
+      data = serializable_hash
+      data.delete(:requests)
+      data.delete(:matches)
+
+      data
+    end
+
+    def to_json(*args)
+      serializable_hash.to_json(*args)
+    end
+
+    private
+
+    def serializable_hash
+      data = {port: @port, protocol: @protocol, name: @name}
+      data[:stubs] = @stubs unless @stubs.empty?
+      data[:requests] = @requests unless @requests.empty?
+      data[:matches] = @matches unless @matches.empty?
+      data[:mode] = @mode unless @mode.nil?
+      data[:recordRequests] = @record_requests unless @record_requests.nil?
+
+      data
+    end
+
+    def self.get_imposter_config(port)
+      response = Network.get("/imposters/#{port}")
+      response.success? ? response.body : []
+    end
+
+    def set_attributes(data)
+      @port = data[:port]
+      @protocol = data[:protocol]
+      @name = data[:name] || "imposter_#{@port}"
+      @stubs = []
+      if data[:stubs].respond_to?(:each)
+        data[:stubs].each do |stub|
+          stub = Mountebank::Stub.new(stub) unless stub.is_a? Mountebank::Stub
+          @stubs << stub
+        end
+      end
+      @requests = data[:requests] || []
+      @matches = data[:matches] || []
+      @mode = data[:mode] || nil
+      @record_requests = data[:record_requests] || data[:recordRequests] || false
+    end
+  end
+end

data/lib/mountebank/network.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Mountebank
+  class Network
+    def self.connection
+      @conn ||= Faraday.new(url: mountebank_server_uri) do |conn|
+        conn.request :json
+        conn.response :symbolize_keys, :content_type => /\bjson$/
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def self.get(uri)
+      connection.get(uri)
+    end
+
+    def self.post(uri, data)
+      connection.post do |req|
+        req.url uri
+        req.body = data
+      end
+    end
+
+    def self.put(uri, data)
+      connection.put do |req|
+        req.url uri
+        req.body = data
+      end
+    end
+
+    def self.delete(uri)
+      connection.delete do |req|
+        req.url uri
+      end
+    end
+
+    def self.mountebank_server
+      ENV['MOUNTEBANK_SERVER'] || 'localhost'
+    end
+
+    def self.mountebank_server_port
+      ENV['MOUNTEBANK_PORT'] || '2525'
+    end
+
+    def self.mountebank_server_uri
+      "http://#{mountebank_server}:#{mountebank_server_port}"
+    end
+  end
+end

data/lib/mountebank/stub/http_response.rb

@@ -0,0 +1,12 @@
+class Mountebank::Stub::HttpResponse < Mountebank::Stub::Response
+  def self.create(statusCode=200, headers={}, body='', behaviors={})
+    payload = {}
+    payload[:statusCode] = statusCode
+    payload[:headers] = headers unless headers.empty?
+    payload[:body] = body unless body.empty?
+
+    data = {is: payload}
+    data.merge!(_behaviors: behaviors) unless behaviors.empty?
+    new(data)
+  end
+end

data/lib/mountebank/stub/https_response.rb

@@ -0,0 +1,2 @@
+class Mountebank::Stub::HttpsResponse < Mountebank::Stub::HttpResponse
+end

data/lib/mountebank/stub/predicate.rb

@@ -0,0 +1,26 @@
+class Mountebank::Stub::Predicate
+  attr_accessor :equals, :deepEquals, :contains, :startsWith, :endsWith, :matches, :exists, :not, :or, :and, :inject, :caseSensitive, :except
+
+  VALID_OPERATORS = [
+    :equals, :deepEquals, :contains, :startsWith, :endsWith, :matches, :exists, :not,
+    :or, :and, :inject
+  ]
+
+  def initialize(data={})
+    VALID_OPERATORS.each do |key|
+      send("#{key}=", data[key]) if data.key?(key)
+    end
+    @caseSensitive = data[:caseSensitive] || nil
+    @except = data[:except] || nil
+  end
+
+  def to_json(*args)
+    data = {}
+    VALID_OPERATORS.each do |key|
+      data[key] = send("#{key}") if instance_variable_defined?("@#{key}")
+    end
+    data[:caseSensitive] = @caseSensitive unless @caseSensitive.nil?
+    data[:except] = @except unless @except.nil?
+    data.to_json(*args)
+  end
+end

data/lib/mountebank/stub/proxy_response.rb

@@ -0,0 +1,14 @@
+class Mountebank::Stub::ProxyResponse < Mountebank::Stub::Response
+  PROXY_MODE_ONCE = 'proxyOnce'
+  PROXY_MODE_ALWAYS = 'proxyAlways'
+
+  def self.create(to, mode=PROXY_MODE_ONCE, predicateGenerators=[])
+    data = {proxy: {
+        to: to,
+        mode: mode,
+        predicateGenerators: predicateGenerators
+      }
+    }
+    new(data)
+  end
+end

data/lib/mountebank/stub/response.rb

@@ -0,0 +1,26 @@
+class Mountebank::Stub::Response
+  attr_accessor :is, :proxy, :inject
+
+  def initialize(data={})
+    @is = data[:is] || nil
+    @proxy = data[:proxy] || nil
+    @inject = data[:inject] || nil
+    @behaviors = data[:_behaviors]
+  end
+
+  def self.with_injection(injection='')
+    return false if injection.empty?
+
+    data = {inject:injection}
+    new(data)
+  end
+
+  def to_json(*args)
+    data = {}
+    data[:is] = @is unless @is.nil?
+    data[:proxy] = @proxy unless @proxy.nil?
+    data[:inject] = @inject unless @inject.nil?
+    data[:_behaviors] = @behaviors unless @behaviors.nil?
+    data.to_json(*args)
+  end
+end

data/lib/mountebank/stub/tcp_response.rb

@@ -0,0 +1,9 @@
+class Mountebank::Stub::TcpResponse < Mountebank::Stub::Response
+  def self.create(data='')
+    payload = {}
+    payload[:data] = data unless data.empty?
+
+    data = {is: payload}
+    new(data)
+  end
+end

data/lib/mountebank/stub.rb

@@ -0,0 +1,46 @@
+class Mountebank::Stub
+  attr_reader :responses, :predicates
+
+  def initialize(data={})
+    set_attributes(data)
+  end
+
+  def self.create(responses=[], predicates=[])
+    data = {
+      :responses => responses,
+      :predicates => predicates
+    }
+    new(data)
+  end
+
+  def to_json(*args)
+    data = {}
+    data[:responses] = @responses unless @responses.empty?
+    data[:predicates] = @predicates unless @predicates.empty?
+    data.to_json(*args)
+  end
+
+  private
+
+  def set_attributes(data={})
+    @responses, @predicates = [], []
+
+    if data[:responses]
+      data[:responses].each do |response|
+        unless response.is_a? Mountebank::Stub::Response
+          response = Mountebank::Stub::Response.new(response)
+        end
+        @responses << response
+      end
+    end
+
+    if data[:predicates]
+      data[:predicates].each do |predicate|
+        unless predicate.is_a? Mountebank::Stub::Predicate
+          predicate = Mountebank::Stub::Predicate.new(predicate)
+        end
+        @predicates << predicate
+      end
+    end
+  end
+end

data/lib/mountebank/version.rb

@@ -0,0 +1,3 @@
+module Mountebank
+  VERSION = "0.0.1"
+end

data/lib/mountebank.rb

@@ -0,0 +1,34 @@
+require "mountebank/version"
+require "mountebank/helper"
+require "mountebank/network"
+require "mountebank/imposter"
+require "mountebank/stub"
+require "mountebank/stub/response"
+require "mountebank/stub/http_response"
+require "mountebank/stub/https_response"
+require "mountebank/stub/tcp_response"
+require "mountebank/stub/proxy_response"
+require "mountebank/stub/predicate"
+require "json"
+
+module Mountebank
+  extend self
+
+  def self.imposters
+    imposters = []
+
+    response = Network.get('/imposters')
+    if response.success?
+      response.body[:imposters].each do |imposter|
+        imposters << Mountebank::Imposter.new(imposter)
+      end
+    end
+
+    imposters
+  end
+
+  def self.reset
+    response = Network.delete('/imposters')
+    response.success?
+  end
+end

data/mountebank.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mountebank/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "erithmetic-mountebank"
+  spec.version       = Mountebank::VERSION
+  spec.authors       = ["Michael Cheng", "Erica Kastner"]
+  spec.email         = ["mcheng.work@gmail.com"]
+  spec.summary       = %q{Ruby GEM to manage a Mountebank Test Server}
+  spec.description   = %q{A simple Ruby library that lets you manage your Mountebank test server.}
+  spec.homepage      = "https://github.com/CoderKungfu/mountebank-gem"
+  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.add_runtime_dependency "faraday", "~>0.9.0"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "dotenv", "~> 1.0.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end