mull 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a2987de9b36325820ea3a5a25cbc342a366b2d3
+  data.tar.gz: 2796dbf0627c8d9ff9e4742eb1c1a6edc3e3db03
+SHA512:
+  metadata.gz: 8683a179bb9713d53a6a3e8add738f5c7d0656913ed67ac7baf3825397156223442806aa31894927bc774819790b0aa24984d4c1426b617853bd62e043949873
+  data.tar.gz: ac9e98e2c823db374c10c7d1aebe20f5830351ee25b40cc62f99ca91d053f758ee58ed040ddec68df58edc13506d72a61c26597ceb48443efb2711f9b8c630b4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+r.rb
+mull-0.1.0.gem
+mull.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2015, CrowdRise, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of [project] nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ehren Murdick and Scott Orlyck
+
+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,102 @@
+# Mull
+
+
+> mull
+>
+> **verb**
+>
+> think about (a fact, proposal, or request) deeply and at length.
+> "she began to mull over the various possibilities"
+> synonyms:	ponder, consider, think over/about, reflect on, contemplate, turn over in one's mind, chew over, cogitate on, give some thought to
+> "I'll have to mull it over before making a final decision"
+
+mull is a tool for thinking over an api service you are consuming.
+
+It has two jobs:
+
+* execute pre-defined requests against an api server you are consuming and save the results to a fixtures directory
+* mirror those requests with the fixture content
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'mull'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mull
+
+## Usage
+
+Define all your requests in a `mull.yml` file. It has the following format:
+
+```
+root_url: http://jsonplaceholder.typicode.com
+path_prefix: fixtures
+requests:
+- url: /posts/1
+  matcher: /posts/\d+
+  method: POST
+  status: 200
+  file: foobar.json
+  headers:
+    test-header: 1
+  post_body:
+    thing: ^\d$
+
+```
+
+**Valid keys**
+
+*Top level keys*
+
+* `root_url:` The root url of the api server you  are consuming
+* `path_prefix:` The directory where you want the fixture files to go
+
+
+*Per request keys*
+
+* `url:` The exact path of the request on the server, eg. `/posts/1`. If `matcher:` is not present, this value is also used to route incoming requests. The outgoing request won't be made if this key is missing.
+* `matcher:` A regex that matches the exact path. `mull server` will use this to map incoming requests
+* `matcher_headers:` Hash of headers to use. If present, `mull server` will use this to map incoming requests. If not, no header checking will occur against incoming requests.
+* `headers:` Hash of headers to use. If present, `mull fetch_all` requests will this for outgoing requests. If not, no headers will be used for outgoing requests.
+* `post_body:` Hash of multipart form body values. Will both be submitted with the `mull fetch_all` requests and matched against incoming requests to `mull server`
+* `method:` HTTP method of the request. Incoming and outgoing
+* `status:` HTTP status
+* `file:` Path to fixture file to use
+* `body:` Hard-coded response for this endpoint. It is an error to use both the `body` key and the `file` key. The outgoing request will not be made if this key is present.
+
+
+Once your mull file is good to go, you can execute all the defined requests and save the results by running
+
+```
+mull fetch_all
+```
+
+Then with the fixtures in place, start up a local server with
+
+```
+mull server
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+
+## License
+
+mull is [BSD licensed](./LICENSE).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mull"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mull

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'mull'
+Mull::Cli.start(ARGV)

data/lib/mull.rb

@@ -0,0 +1,75 @@
+require "mull/version"
+require 'mull/request'
+require 'mull/cli'
+require 'mull/file_util'
+require 'mull/response'
+require 'sinatra'
+require 'httparty'
+
+class MullServer < Sinatra::Base
+  set :bind, '0.0.0.0'
+end
+
+module Mull
+  extend self
+
+  module Container
+    extend self
+    def file_utils; FileUtils; end
+    def file; File; end
+    def http; HTTParty; end
+    def server; MullServer; end
+
+    def config key
+      @config ||= YAML.load_file('mull.yml')
+      @config[key.to_s]
+    end
+
+    def request(definition:)
+      Request.new(
+        definition: definition,
+        file_utils: file_util,
+        http: http,
+        root_url: config(:root_url)
+      )
+    end
+
+    def response(definition:)
+      Response.new(
+        definition: definition,
+        file_utils: file_util,
+        server: server
+      )
+    end
+
+    def file_util
+      Mull::FileUtil.new(
+        path_prefix: config(:path_prefix),
+        file: file,
+        file_utils: file_utils
+      )
+    end
+  end
+
+
+  def requests
+    @requests ||= Container.config(:requests).map do |d|
+      Container.request(definition: d)
+    end
+  end
+
+  def responses
+    @responses ||= Container.config(:requests).map do |d|
+      Container.response(definition: d)
+    end
+  end
+
+  def save_all
+    requests.each(&:save_response!)
+  end
+
+  def server
+    responses.each(&:map_server_route)
+    Container.server.run!
+  end
+end

data/lib/mull/cli.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+module Mull
+  class Cli < Thor
+    class << self
+      attr_accessor :app
+    end
+
+    self.app = Mull
+
+    desc "fetch_all", "Fetch all endpoints defined in the yml and save the responses"
+    def fetch_all
+      self.class.app.save_all
+    end
+
+    desc "server", "Start the server"
+    def server
+      self.class.app.server
+    end
+  end
+end

data/lib/mull/file_util.rb

@@ -0,0 +1,35 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module Mull
+  class FileUtil
+
+    delegate :join, to: :file
+
+    attr_accessor\
+      :path_prefix,
+      :file,
+      :file_utils
+
+    def initialize(path_prefix:, file:, file_utils:)
+      self.path_prefix = path_prefix || '.'
+      self.file        = file
+      self.file_utils  = file_utils
+    end
+
+    def read_file(path:)
+      return nil unless path
+      path = file.join(path_prefix, path)
+      file.read(path)
+    end
+
+    def write_file(path:, content:)
+      path = file.join(path_prefix, path)
+      dir = file.dirname(path)
+      unless file.exists?(dir)
+        file_utils.mkpath(dir)
+      end
+      file.open(path, 'w+') { |f| f.write content }
+    end
+  end
+end

data/lib/mull/request.rb

@@ -0,0 +1,89 @@
+require 'httparty'
+require 'active_support'
+require 'active_support/core_ext'
+require 'json'
+
+module Mull
+  class Request
+    # dependencies
+    attr_accessor\
+      :file_utils,
+      :http
+
+
+    attr_accessor\
+      :filepath,
+      :headers,
+      :matcher,
+      :method,
+      :post_body,
+      :root_url,
+      :status,
+      :url
+
+    def initialize(root_url:, definition:, file_utils:, http:)
+      self.file_utils = file_utils
+      self.http       = http
+      self.root_url   = root_url
+
+      defaults = {
+        'method' => 'GET',
+        'post_body' => {},
+        'headers' => {},
+        'status' => 200,
+      }
+
+      definition = defaults.merge(definition)
+
+      self.filepath  = definition['file']
+      self.headers   = definition['headers']
+      self.method    = definition['method']
+      self.post_body = definition['post_body']
+      self.url       = definition['url']
+      self.status    = definition['status']
+      self.matcher   = definition['matcher'] || url
+    end
+
+    def headers
+      Hash[@headers.map do |h, k|
+        [h.to_s, k.to_s]
+      end]
+    end
+
+    def fully_qualified_url
+      @_fully_qualified_url ||= file_utils.join(root_url, url)
+    end
+
+    def request_options
+      opts = {}
+      opts[:headers] = headers if headers.present?
+      opts[:body]    = post_body if post_body.present?
+      opts
+    end
+
+    def result
+      @result ||= \
+      if request_options.empty?
+        http.send(method.downcase, fully_qualified_url)
+      else
+        http.send(method.downcase, fully_qualified_url, request_options)
+      end
+    end
+
+    def pretty_json_if_possible(body)
+      begin
+        parsedJson = JSON.parse(body)
+        return JSON.pretty_generate(parsedJson)
+      rescue Exception => e
+        return body
+      end
+    end
+
+    def save_response!
+      return unless filepath
+      return unless url
+      
+      file_utils.write_file(path: filepath, content: pretty_json_if_possible(result.body))
+    end
+  end
+end

data/lib/mull/response.rb

@@ -0,0 +1,49 @@
+class Response
+  attr_accessor\
+    :file_utils,
+    :filepath,
+    :headers,
+    :matcher,
+    :method,
+    :post_body,
+    :response_body,
+    :server,
+    :status
+
+  def initialize(definition:, file_utils:, server:)
+    self.file_utils = file_utils
+    self.server     = server
+
+    self.filepath  = definition['file']
+    self.headers   = definition['matcher_headers'] || {}
+    self.method    = definition['method'] || 'GET'
+    self.post_body = definition['post_body'] || {}
+    self.status    = definition['status'] || 200
+    self.matcher   = definition['matcher'] || definition['url']
+
+    self.response_body = definition['body'] || file_utils.read_file(path: filepath)
+  end
+
+  def headers
+    return {} unless @headers
+    Hash[@headers.map do |h, k|
+      [h.to_s, k.to_s]
+    end]
+  end
+
+  def map_server_route
+    this = self
+    server.send(method.downcase, Regexp.new(matcher)) do
+      this.headers.each do |key, value|
+        pass and return unless request.env["HTTP_" + key.gsub(/-/, '_').upcase] == value
+      end
+
+      this.post_body.each do |key, value|
+        pass and return unless Regexp.new(value.to_s) === params[key]
+      end
+
+      status this.status
+      this.response_body
+    end
+  end
+end

data/lib/mull/version.rb

@@ -0,0 +1,3 @@
+module Mull
+  VERSION = "0.1.0"
+end

data/mull.example.yml

@@ -0,0 +1,11 @@
+root_url: http://jsonplaceholder.typicode.com
+requests:
+- url: /posts/1
+  method: GET
+  status: 200
+  file: artifacts/foo
+
+- url: /posts/1
+  method: GET
+  status: 200
+  file: artifacts/bar

data/mull.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mull/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mull"
+  spec.version       = Mull::VERSION
+  spec.authors       = ["CrowdRise"]
+  spec.email         = ["devteam@crowdrise.com"]
+  spec.homepage      = 'https://github.com/crowdrise/mull'
+
+  spec.summary       = %q{Mull is a tool to mirror a live api for development}
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = ['mull']
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "sinatra", "~> 1.4"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.1"
+  spec.add_development_dependency "guard", "~> 2.13"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: mull
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CrowdRise
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: 
+email:
+- devteam@crowdrise.com
+executables:
+- mull
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- artifacts/.gitignore
+- bin/console
+- bin/setup
+- exe/mull
+- lib/mull.rb
+- lib/mull/cli.rb
+- lib/mull/file_util.rb
+- lib/mull/request.rb
+- lib/mull/response.rb
+- lib/mull/version.rb
+- mull.example.yml
+- mull.gemspec
+homepage: https://github.com/crowdrise/mull
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Mull is a tool to mirror a live api for development
+test_files: []