automock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37d437b11b0f119b81e778eeebc0b545eca51343
+  data.tar.gz: 06ea82d3917a6bfd050337eb3316f628cf398ae6
+SHA512:
+  metadata.gz: 52df14de3e03fb8b013b3952cba9bc859a1d709bb7e8f891847903b17db8fb36cee466f8635e8197c32bf0661dcf1e70273d0ce3bd2e5b1c2872c2f84c4755ca
+  data.tar.gz: 7778f6516f9dc6b9248e24e3c381f5dd2ee88e9d8c39d41ed0744102533ae835fa63c3d0d278c4609d793776126578dc69bfe4ad56cef30e7251cbb833c26049

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/fixtures/data

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.0
+sudo: false
+before_install: gem install bundler -v 1.11.2
+before_install: nvm install 4.2.3
+install:
+  - ./bin/setup
+script:
+  - bundle exec rake spec
+  - cd server && npm test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at joe.tialtngo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 joe-re
+
+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/LISENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Masato Noguchi
+
+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,110 @@
+# Automock
+
+Generate WebAPI mocking response data from your rails application's request-spec.
+
+And run proxy server for mocking response.
+
+Inspired by [autodoc](https://github.com/r7kamura/autodoc).
+
+## Installation
+
+Add this line to your rails application's Gemfile:
+
+```ruby
+gem "automock", group: :test
+```
+
+Download and install by running:
+
+```
+$ bundle install
+```
+
+And setup mocking server.
+
+```
+$ rake automock:setup
+```
+
+This generate `automock` directory under your rails root.  
+Mocking server is inside it.
+I recommend adding automock directory to .gitignore;
+
+Then run mocking server.
+
+```
+$ rake automock:server
+```
+
+By default, proxy server use 8001 port and target application using 3000 port.  
+Mocking management server use 8000 port.  
+Now you can access it, localhost:8000.  
+And access localhost:8001, you can receive response by proxy;
+
+## Usage
+
+### Generate data for mocking response
+Run rspec with AUTOMOCK=1 to generate mocking data for your request-specs tagged with :automock.
+
+```
+AUTOMOCK=1 rspec
+```
+
+#### Example
+
+```ruby
+RSpec.describe 'users', type: :request do
+  describe 'GET /api/v1/users', automock: true do
+    before do
+      get '/api/v1/users'
+    end
+    it 'receives 200 and users json' do
+      expect(response.status).to eq 200
+    end
+    # and more example...
+  end
+end
+```
+
+### Mocking response
+
+You can manage mocking data, on or off, by mocking response management server.
+By default, mocking management server use 8000 port.
+So you can access it.
+
+![management_server_screenshot](https://cloud.githubusercontent.com/assets/4954534/12078401/3621c93c-b254-11e5-9f7e-21bd075bed2e.png)
+
+Selected mocking data is used by proxy.  
+Unselected api is passed through normally.
+
+### Configration
+
+You can change automock's using port by rake args.
+
+- automock_port
+- rails_port
+- proxy_port
+
+Example:
+```
+$ rake automock:server automock_port=3001 rails_port=3002 proxy_port=3003
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+If you run mocking server, run `bin/server` to start it;
+
+### spec
+
+Then, run `rake spec` to run the tests for ruby code.  
+And change directory to `server`, then run `npm run test` to run the tests for mocking server.  
+If you want to update mock data for specs, run `bundle exec rake update_mockdata_fixtures` command.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joe-re/automock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task :update_mockdata_fixtures do
+  system('rm -rf spec/dummy/automock')
+  system('AUTOMOCK=1 bundle exec rspec spec/dummy/spec/requests/dummy_api.rb')
+  FileUtils.cp_r('spec/dummy/automock/data', 'spec/fixtures/', remove_destination: true)
+end

data/automock/data/test.json

@@ -0,0 +1 @@
+{"description":"1 receives 200 and users json","method":"GET","uri":"/api/v1/users","status":200,"response_header":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e224cce5657514dd4f022471dc9261c6\"","Cache-Control":"max-age=0, private, must-revalidate","X-Request-Id":"dc872bfa-ebc0-447e-ad5c-4c7932897bb2","X-Runtime":"0.008449","Content-Length":"42"},"response_body":"{\"users\":[{\"user\":{\"name\":\"dummy user\"}}]}"}

data/automock/data/test2.json

@@ -0,0 +1 @@
+{"description":"2 receives 200 and users json","method":"GET","uri":"/api/v1/users2","status":200,"response_header":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e224cce5657514dd4f022471dc9261c6\"","Cache-Control":"max-age=0, private, must-revalidate","X-Request-Id":"dc872bfa-ebc0-447e-ad5c-4c7932897bb2","X-Runtime":"0.008449","Content-Length":"42"},"response_body":"{\"users\":[{\"user\":{\"name\":\"dummy user\"}}]}"}

data/automock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'automock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'automock'
+  spec.version       = Automock::VERSION
+  spec.authors       = ['joe-re']
+  spec.email         = ['joe.tialtngo@gmail.com']
+
+  spec.summary       = 'Auto-generate mock_data of JSON API response from your request-specs.'
+  spec.homepage      = 'https://github.com/joe-re/automock'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'rails', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "automock"
+
+# 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/server

@@ -0,0 +1,3 @@
+export AUTOMOCK_DATA_PATH=${PWD}/automock/data
+cd server
+node app/index.js

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path vendor/bundle
+bundle exec rake update_mockdata_fixtures
+
+# Do any other automated setup that you need to do here
+cd server
+npm install
+npm run build
+node node_modules/db-migrate/bin/db-migrate up --config app/db/database.json -e dev

data/lib/automock/response_mock.rb

@@ -0,0 +1,55 @@
+require 'pathname'
+
+module Automock
+  class ResponseMock
+    def initialize(context, example)
+      @context = context
+      @example = example
+    end
+
+    def description
+      @example.description
+    end
+
+    def method
+      @context.request.method
+    end
+
+    def uri
+      @context.request.env['PATH_INFO']
+    end
+
+    def response_header
+      @context.response.try(:header)
+    end
+
+    def status
+      @context.response.try(:status)
+    end
+
+    def response_body
+      @context.response.try(:body)
+    end
+
+    def filename
+      "#{method}_#{description.gsub(/\s/, '_').gsub(/[?"\\\<>*|]/, '')}.json"
+    end
+
+    def mock_data
+      {
+        description: description,
+        method: method,
+        uri: uri,
+        status: status,
+        response_header: response_header,
+        response_body: response_body
+      }.to_json
+    end
+
+    def write
+      pathname = Pathname.new("#{Rails.root}/automock/data/#{uri}/#{filename}")
+      pathname.parent.mkpath
+      pathname.open('w') { |file| file << mock_data }
+    end
+  end
+end

data/lib/automock/rspec.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+RSpec.configure do |c|
+  c.after(:each, automock: true) do |example|
+    Automock.append(self, example)
+  end
+
+  c.after(:suite) do
+    Automock.write
+  end
+end

data/lib/automock/version.rb

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

data/lib/automock.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'automock/version'
+require 'automock/response_mock'
+require 'automock/rspec'
+
+module Automock
+  class << self
+    def append(context, example)
+      return unless ENV["AUTOMOCK"]
+      @mocks ||= []
+      @mocks << ResponseMock.new(context.clone, example.clone)
+    end
+
+    def write
+      @mocks && @mocks.each(&:write)
+    end
+  end
+
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/automock.rake'
+    end
+  end
+end

data/lib/tasks/automock.rake

@@ -0,0 +1,31 @@
+require 'pathname'
+require 'fileutils'
+
+namespace :automock do
+  desc 'Setup automock'
+  task :setup, :options do |_, _args|
+    dist = Pathname.new('automock')
+    dist.mkpath
+    src = [
+      "#{File.dirname(__FILE__)}/../../server"
+    ]
+    FileUtils.cp_r(src, dist, remove_destination: true)
+    puts "created #{dist}"
+    Rake::Task['automock:install'].execute
+  end
+
+  task :install, :options do |_, _args|
+    Dir.chdir "#{Rails.root}/automock/server"
+    sh 'npm install && npm run build'
+    sh 'node node_modules/db-migrate/bin/db-migrate up --config app/db/database.json -e dev'
+  end
+
+  task :server, :options do |_, _args|
+    ap = ENV['automock_port'] || 8000
+    rp = ENV['rails_port'] || 3000
+    pp = ENV['proxy_port'] || 8001
+    mock_data_path = "#{Rails.root}/automock/data"
+    Dir.chdir "#{Rails.root}/automock/server"
+    sh "./bin/server #{mock_data_path} #{ap} #{rp} #{pp}"
+  end
+end

data/server/.babelrc

@@ -0,0 +1,3 @@
+{
+ presets: [ 'es2015', 'react' ]
+}

data/server/.eslintrc

@@ -0,0 +1,104 @@
+{
+  "parser": "babel-eslint",
+  "env": {
+    "browser": true,
+    "node": false
+  },
+  "ecmaFeatures": {
+    "jsx": true
+  },
+  "plugins": [
+    "react"
+  ],
+  "rules": {
+    "strict": 0,
+
+    "comma-dangle": 2,
+    "comma-style": [2, "last"],
+    "comma-spacing": [2, {"before": false, "after": true}],
+    "semi": [2, "always"],
+    "indent": [2, 2],
+    "key-spacing": [0],
+    "quotes": [2, "single", "avoid-escape"],
+    "brace-style": [2, "1tbs", { "allowSingleLine": false }],
+    "curly": 2,
+    "object-curly-spacing": [2, "always"],
+    "array-bracket-spacing": [2, "always"],
+    "dot-location": [2, "object"],
+    "camelcase": [2, {"properties": "never"}],
+    "dot-notation": 2,
+    "yoda": [2, "never", { "exceptRange": true }],
+
+    "no-alert": 2,
+    "no-array-constructor": 2,
+    "no-caller": 2,
+    "no-catch-shadow": 2,
+    "no-dupe-args": 2,
+    "no-else-return": 2,
+    "no-empty-label": 2,
+    "no-eval": 2,
+    "no-extend-native": 2,
+    "no-extra-bind": 2,
+    "no-implied-eval": 2,
+    "no-iterator": 2,
+    "no-label-var": 2,
+    "no-labels": 2,
+    "no-lone-blocks": 2,
+    "no-lonely-if": 2,
+    "no-loop-func": 2,
+    "no-multi-spaces": [2, {
+      "exceptions":{
+        "Property": true,
+        "ImportDeclaration": true,
+        "VariableDeclarator": true,
+        "AssignmentExpression": true
+      }
+    }],
+    "no-multi-str": 2,
+    "no-multiple-empty-lines": [2, {max: 2}],
+    "no-native-reassign": 2,
+    "no-nested-ternary": 2,
+    "no-new": 0,
+    "no-new-func": 2,
+    "no-new-object": 2,
+    "no-new-wrappers": 2,
+    "no-octal-escape": 2,
+    "no-process-exit": 2,
+    "no-proto": 2,
+    "no-return-assign": 2,
+    "no-script-url": 2,
+    "no-sequences": 2,
+    "no-shadow": 2,
+    "no-shadow-restricted-names": 2,
+    "no-spaced-func": 2,
+    "no-throw-literal": 2,
+    "no-trailing-spaces": 2,
+    "no-undef": 0,
+    "no-undef-init": 2,
+    "no-underscore-dangle": 2,
+    "no-unneeded-ternary": 2,
+    "no-unused-expressions": 2,
+    "no-unused-vars": [2, {"vars": "all", "args": "all", "argsIgnorePattern": "^_"}],
+    "no-use-before-define": 2,
+    "no-void": 2,
+    "no-with": 2,
+
+    "max-len": [1, 120, 2],
+    "max-params": [1, 3],
+    "max-depth": [1, 3],
+    "max-statements": [1, 50],
+
+    "new-cap": 0,
+    "eqeqeq": 2,
+
+    "no-var": 2,
+    "object-shorthand": [2, "always"],
+    "prefer-const": 2,
+    "constructor-super": 2,
+    "no-this-before-super": 2,
+    "space-after-keywords": 2,
+    "arrow-spacing": 2,
+
+    "react/jsx-uses-vars": 1
+  }
+}

data/server/.flowconfig

@@ -0,0 +1,11 @@
+[ignore]
+.*/node_modules/.*/node_modules/.*
+.*/node_modules/babel-core/lib/.*
+
+[include]
+./node_modules/
+
+
+[libs]
+
+[options]

data/server/.gitignore

@@ -0,0 +1,4 @@
+/app/assets/
+/node_modules/
+/npm-debug.log
+/*.db

data/server/app/db/database.json

@@ -0,0 +1,10 @@
+{
+  "dev": {
+    "driver": "sqlite3",
+    "filename": "automock.db"
+  },
+  "test": {
+    "driver": "sqlite3",
+    "filename": "automock_test.db"
+  }
+}

data/server/app/db/sequelize.js

@@ -0,0 +1,4 @@
+const Sequelize = require('sequelize');
+const storage = process.env.NODE_ENV === 'test' ? './automock_test.db' : './automock.db';
+const sequelize = new Sequelize('automock', '', '', { dialect:'sqlite', storage });
+module.exports = sequelize;