kamen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4395a5b7b9ba7cf4d7210f9bc97fddb77eeed76
+  data.tar.gz: 4ea9cc06d60b5dabab76aafe43a057611f4b36de
+SHA512:
+  metadata.gz: f09c200619e6fdc0b7989d7457c604f90137a5cb327b6ffa37e2b2984adffe35808ce81093c3cac10bc2b41ea27f2c91c90ab4e4720ff713835dd3c578e3ef68
+  data.tar.gz: 799f1c6929ce0a5feacd1421e554e97c45ad158338031b0fd48b78a79a7dc3e622123c2e2ce3bcd991ea724c8eb1f0049e37ceb381fe2f4e9f2b281bdb03ced4

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at st.chenlei@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kamen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 iChen
+
+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,64 @@
+# Kamen
+
+A light-weight api mock engine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kamen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kamen
+
+## Usage
+
+You will do nothing but add some comments above your action method
+
+```ruby
+class UsersController < ApplicationController
+
+  # MockData
+  # {
+  #   id: 1,
+  #   name: 'Frank',
+  #   gender: 'M',
+  # }
+  # MockData
+
+  def show
+  end
+end
+```
+
+Then call the api with curl or your favourite http client like postman
+
+```ruby
+$ curl http://example.com/users/1
+$ { id: 1, name: 'Frank', gender: 'M'}
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kamen. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kamen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kamen/blob/master/CODE_OF_CONDUCT.md).

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 "kamen"
+
+# 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(__FILE__)

data/bin/setup

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

data/kamen.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kamen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kamen"
+  spec.version       = Kamen::VERSION
+  spec.authors       = ["freezemad"]
+  spec.email         = ["frozenderk@gmail.com"]
+
+  spec.summary       = %q{"A light-weight api mock engine."}
+  spec.description   = %q{"A light-weight api mock engine."}
+  spec.homepage      = "https://github.com/freezemad/kamen"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/kamen.rb

@@ -0,0 +1,34 @@
+require "kamen/version"
+require "kamen/control"
+require "kamen/parser"
+require "kamen/mock_cache"
+require "kamen/middleware/mock_request"
+
+# == Kamen Initialization
+#
+# When installed as a gem, you can activate the mock server on the following way:
+#
+# For Rails, add:
+#   gem 'kamen'
+# to your Gemfile
+#
+# Now ONLY Rails 3+ framework be supported.
+#
+
+if defined?(Rails::VERSION)
+  if Rails::VERSION::MAJOR.to_i >= 3
+    module Kamen
+      class Railtie < Rails::Railtie
+
+        initializer "kamen.mock_middleware", before: :load_config_initializers do |app|
+          Kamen::Control.init_engine(app)
+        end
+      end
+    end
+  else
+    warn "Your Rails version is too low, we recommend you to upgrade your framework"
+  end
+else
+  warn "Kamen ONLY support Rails 3+ framework"
+end
+

data/lib/kamen/control.rb

@@ -0,0 +1,12 @@
+require 'kamen/middleware/mock_request'
+
+module Kamen
+  class Control
+    def self.init_engine(config)
+      config.middleware.insert_after(
+        'ActionDispatch::RemoteIp',
+        'Kamen::Middleware::MockRequest'
+      )
+    end
+  end
+end

data/lib/kamen/middleware/mock_request.rb

@@ -0,0 +1,44 @@
+require 'action_dispatch'
+
+module Kamen
+  # middleware
+  module Middleware
+    class MockRequest
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        request = ActionDispatch::Request.new(env)
+
+        Rails.application.routes.router.recognize(request) do |route, params|
+          # params => {:controller=>"v1/users", :action=>"show", :id=>"1"}
+
+          resp = ::Kamen::MockCache.find_mock_response(params)
+          if resp[:read]  # source file is parsed
+            unless resp[:data].nil? # cache hits, there is a mock data
+              return [200, {}, [resp[:data]]]
+            else # no mock data given, pass request to rails application
+              # just skip this branch and exit block to call downstream middleware
+            end
+          else
+
+            if ::Kamen::Parser.handle_source_file(params)
+
+              # there is some data written in cache so we can load again.
+              resp = ::Kamen::MockCache.find_mock_response(params)
+
+              return [200, {}, [resp[:data]]] if resp[:read] && resp[:data]
+            end
+          end
+        end
+
+        @status, @headers, @response = @app.call(env)
+        [@status, @headers, @response]
+      end
+
+    end
+  end
+end
+
+

data/lib/kamen/mock_cache.rb

@@ -0,0 +1,62 @@
+module Kamen
+
+  # Kamen will write mock data to file system, simultaneously cache them
+  # in memory. It will be retrieved from cache when each request received.
+  #
+  # If cache hits, the data would be returned upstream. And if not, we will
+  # find the source file and parse it. The parsed result would be persisted
+  # and loaded in memory.
+  #
+  # Cache structure is Hash. The definition of key and value is as below.
+  #
+  # key: controller#action
+  # value: [
+  #   read,  # true|false, if already parsed
+  #   data,  # mock data
+  # ]
+  #
+  # There might be 3 cases for cache as below.
+  # 1. Request mock exists but not in cache. It may be that no request ever come.
+  #    Since our cache is lazyloaded, if no request is received, nothing would be cached.
+  #
+  # 2. Request mock exists in cache as value [true, {...}]. This is as we expected.
+  #
+  # 3. Request mock exists in cache as value [true, nil]. This means no mock data
+  #    given by our Rais application. But we have already parsed the source. So next time
+  #    the request would be passed directly to Rails application.
+  module MockCache
+    extend self
+
+    @@mock_caches ||= {}
+    @@mutex = Mutex.new
+
+    # build a cache key
+    def cache_key(params)
+      controller = params.fetch(:controller, nil)
+      action     = params.fetch(:action, nil)
+
+      "#{controller}##{action}"
+    end
+
+    # Find mock response from cache.
+    # return:
+    # {
+    #   read: true | false,
+    #   data: mock
+    # }
+    def find_mock_response params
+      key = cache_key(params)
+      data = @@mock_caches[key] || [false, nil]
+
+      Hash[[:read, :data].zip(data)]
+    end
+
+    # Write mock response to cache.
+    def write_mock_response key, value
+      @@mutex.synchronize do
+        @@mock_caches[key] = [true, value]
+      end
+    end
+
+  end
+end

data/lib/kamen/parser.rb

@@ -0,0 +1,71 @@
+module Kamen
+  # =begin/=end is temporarily not supported
+  module Parser
+    extend self
+
+    TOKENIZER = "MockData"
+
+    # tokenizer of mock data comment block
+    def mock_tokenizer
+      @@mock_tokenizer ||= Regexp.new(/^[[:blank:]]*\#.*#{TOKENIZER}/)
+    end
+
+    # build source file fullpath
+    def find_source_file params
+      source_dir = File.expand_path(File.join(Rails.root, 'app','controllers'))
+      basename = "#{params[:controller]}_controller.rb"
+
+      File.join(source_dir, basename)
+    end
+
+    # Read source and parse.
+    # Kamen will mark that the source is already handled unless you modify the source.
+    # So if no mock given, we will pass request to your rails application the next request directly.
+    # This will avoid to do some logic repeatly.
+    #
+    # return:
+    #   true | false , if there is some data written in cache.
+    def handle_source_file params
+      filepath = find_source_file(params)
+
+      return false unless File.exists?(filepath)
+
+      file = File.open(filepath, 'r')
+
+      _started = false
+      _data = []
+      _return_val = false
+
+      file.each_line do |line|
+        if mch = /^[[:blank:]]*def ([a-z0-9_]+)/.match(line)
+          if _data.blank? # current method has no mock data
+            next
+          else
+            if mch[1] == params[:action]  # hit
+              key = MockCache.cache_key(params)
+              MockCache.write_mock_response(key, _data.join)
+              _return_val = true
+            else # miss, but there exists a mock
+              key = MockCache.cache_key(controller: params[:controller],
+                                           action: mch[1])
+              MockCache.write_mock_response(key, _data.join)
+            end
+            _data = []
+            next
+          end
+        end
+
+        if line =~ mock_tokenizer
+          _started = !_started
+          next
+        end
+        if _started
+          _data << line.gsub(/^[[:blank:]]*\#/, "")
+        end
+      end
+      file.close
+      _return_val
+    end
+
+  end
+end

data/lib/kamen/version.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: kamen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- freezemad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: '"A light-weight api mock engine."'
+email:
+- frozenderk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kamen.gemspec
+- lib/kamen.rb
+- lib/kamen/control.rb
+- lib/kamen/middleware/mock_request.rb
+- lib/kamen/mock_cache.rb
+- lib/kamen/parser.rb
+- lib/kamen/version.rb
+homepage: https://github.com/freezemad/kamen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: '"A light-weight api mock engine."'
+test_files: []