fake_api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 291b0a2acbe638fd0298f165f52361d40ed135aaae8ac5788879071810796573
+  data.tar.gz: ffd968738a8652262fbeeabc9ffda18c99139989a55ac22f4c7cdb0bdd7db564
+SHA512:
+  metadata.gz: 32d03d9f654d063f9726cc944ebc4c380e0ddfca498a49a27a295f547c829cb6adfecd6ef92618021f53753dc3e85ba8b947bb31f6eb46a5ad27a52412e622bd
+  data.tar.gz: c2cac52ff859c0566d60d80ab448d528da024c06801f334dbb152bd225b78a962e731e45e7bb32ac6a4dc01ee19dd531ff5d9bef46008cc4ae9757bcd7573589

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Igor Kasyanchuk
+
+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,122 @@
+# Fake API
+
+The **fastest** way to prototype API with most real dummy data, and provide them to other team members.
+
+Instead of creating many new controllers and actions, and sending random data like `"First name #{rand(100)}"` you'll get real data for developing/testing.
+
+Gem has a syntax similar to rails routes, factory bot, and uses faker to generate dummy data.
+
+![Demo](/docs/fake_api_demo.gif)
+
+Features:
+
+* fast API prototyping
+* clear and familiar syntax
+* Faker for test data generation
+  * including links to images if needed
+* manage cookies, session, headers with fake response
+* executes your factories in real-time, so you always get fresh and random data
+* has generator
+
+## Installation & Usage
+
+Installation process is very simple.
+
+- add `gem 'fake_api'` to the Gemfile
+- run `bundle install`
+- mount gem in routes.rb `mount FakeApi::Engine => '/api'`
+- `rails g fake_api Product`. It will generate factory and routing files.
+- edit `app/fake_api/*.rb`, define your routing and factories.
+- open `localhost:300/api/projects.json` (see step 5) or `localhost:300/api/projects.xml` (to return XML in API response)
+- profit :)
+
+You can keep your routing and factories in many files.
+
+## Examples
+
+Sample of the factory:
+
+```ruby
+# app/fake_api/factory.rb
+class Factory < FakeApi::Factoring
+
+  # Example of User object
+  # you can see that it will generate link to fake image
+  factory(:user) do
+    {
+      id: rand(100),
+      first_name: Faker::Name.first_name,
+      last_name: Faker::Name.first_name,
+      avatar_url: Faker::Avatar.image(size: '128x128'),
+      age: rand(100)
+    }
+  end
+
+  # heare you can put "relations" to other factories
+  # see "author" node
+  factory(:project) do
+    {
+      id: rand(1_000),
+      title: Faker::Company.name,
+      description: Faker::Company.catch_phrase,
+      type: Faker::Company.type,
+      author: object(:user)
+    }
+  end
+
+  # or have factory which contains from the list of Projects and a single user
+  factory(:complex) do
+    {
+      projects: create_list(:project, 2),
+      user: object(:user)
+    }
+  end
+
+end
+```
+
+And sample of routing:
+
+```ruby
+# app/fake_api/app_routing.rb
+class AppRouting < FakeApi::Routing
+  get('/projects').and_return           { create_list(:project, 5) }.with_status(202).with_headers({TOKEN: "SECRET"})
+  get(%r{/projects/\d+$}).and_return    { object(:project) }
+  post('/projects').and_return          { object(:project).merge({created: 'ok'}) }
+  delete(%r{/projects/\d+$}).and_return { { result: :deleted } }.with_status(333)
+
+  post('/auth')
+    .and_return { { status: "OK" } }
+    .with_cookies({x: "A"})
+    .with_session({y: "B"})
+    .with_headers({token: "C"})
+end
+```
+
+## Factory Methods
+
+- `create_list(:factory_name, 10)` to create an array of 10 factories.
+- `object(:factory_nane)` to return a factory
+
+## Routing Methods
+
+- `get/post/put/patch/delete` to define route
+- `and_return` to specify the response. This response will be converted to FORMAT (json, xml, js, csv(for arrays) etc)
+- `with_cookies` to list returned cookies
+- `with_session` to list changes in session
+- `with_headers` to list returned headers
+
+## TODO
+
+- CI (travis, github actions, etc)
+- render ERB?
+- exclude from code converage generator and dummy app
+- make code coverage 100%
+
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FakeApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/fake_controller.rb

@@ -0,0 +1,27 @@
+class FakeController < ApplicationController
+
+  def data
+    result = FakeApi::Handler.handle(request.method, path: params[:path], params: params, headers: request.headers)
+
+    response.status = result.status
+
+    result.headers.each { |k, v| headers[k.to_s] = v }
+    result.cookies.each { |k, v| cookies[k.to_s] = v }
+    result.session.each { |k, v| session[k.to_s] = v }
+
+    respond_to do |format|
+      format.html { render plain: result.data.inspect }
+      format.xml  { render xml: result.data }
+      format.json { render json: result.data }
+      format.js   { render js: result.data }
+      format.csv  {
+        require 'csv'
+        csv_string = CSV.generate(headers: false) do |csv|
+          result.data.each { |i| csv << i }
+        end
+        render plain: csv_string
+      }
+    end
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+FakeApi::Engine.routes.draw do
+  match '/*path', to: 'fake#data', via: :all
+
+  # to get mounted route
+  get '/__test__test', to: 'fake#data', as: :__test__test
+end

data/lib/fake_api.rb

@@ -0,0 +1,16 @@
+require "fake_api/engine"
+require "faker"
+require "pry"
+require "ostruct"
+
+require_relative './fake_api/data.rb'
+require_relative './fake_api/base.rb'
+require_relative './fake_api/route.rb'
+require_relative './fake_api/factory.rb'
+require_relative './fake_api/handler.rb'
+require_relative './fake_api/debug.rb'
+
+require_relative './generators/fake_api_generator.rb' rescue nil
+
+module FakeApi
+end

data/lib/fake_api/base.rb

@@ -0,0 +1,11 @@
+module FakeApi
+  class Base
+    mattr_accessor :data
+    @@data = FakeApiData.instance
+    class << self
+      delegate_missing_to :data
+    end
+  end
+  Routing   = Base
+  Factoring = Base
+end

data/lib/fake_api/data.rb

@@ -0,0 +1,71 @@
+module FakeApi
+
+  class FakeApiData
+    attr_reader :responses, :routes
+
+    def FakeApiData.instance
+      @@instance ||= FakeApiData.new
+    end
+
+    def initialize
+      @responses = {}
+      @routes    = {}
+    end
+
+    def factory(name, &block)
+      response = Factory.new(name: name, value: block)
+      @responses[name] = response
+    end
+
+    def route(request_method, route:, &block)
+      e = Route.new(route: route)
+      @routes[request_method.upcase] ||= {}
+      @routes[request_method.upcase][route] = e
+    end
+
+    def get(path)
+      route("GET", route: path)
+    end
+
+    def post(path)
+      route("POST", route: path)
+    end
+
+    def put(path)
+      route("PUT", route: path)
+    end
+
+    def patch(path)
+      route("PATCH", route: path)
+    end
+
+    def delete(path)
+      route("DELETE", route: path)
+    end
+
+    def object(something)
+      response_or_value(something)
+    end
+    alias :create :object
+    alias :build :object
+
+    def create_list(something, amount)
+      result = []
+      amount.times { result << response_or_value(something) }
+      result
+    end
+
+    def response_or_value(e)
+      if e.is_a?(Symbol)
+        if response = FakeApiData.instance.responses[e]
+          response.value.call
+        else
+          nil
+        end
+      else
+        e
+      end
+    end
+  end
+
+end

data/lib/fake_api/debug.rb

@@ -0,0 +1,42 @@
+module FakeApi
+
+  class Debug
+
+    def Debug.status
+      result = {}
+      result[:factories] = []
+      result[:responses] = {}
+
+      FakeApiData.instance.responses.each do |name, response|
+        result[:factories] << name
+      end
+
+      FakeApiData.instance.routes.each do |request_method, info|
+        result[:responses][request_method] ||= []
+        info.each do |(path, route)|
+          result[:responses][request_method] << {
+            route: route.route,
+            status: route.status
+          }
+        end
+      end
+      result
+    end
+
+  end
+
+end
+
+# module FakeApi
+#   extend ActiveSupport::Autoload
+
+#   eager_autoload do
+#     autoload :Handler
+#     autoload :Route
+#     autoload :Response
+#     autoload :Factory
+#     autoload :Routing
+#     autoload :Handler
+#     autoload :FakeApiData
+#   end
+# end

data/lib/fake_api/engine.rb

@@ -0,0 +1,22 @@
+module FakeApi
+  class Engine < ::Rails::Engine
+    def Engine.mounted_in
+      @mounted_in ||= FakeApi::Engine.routes.url_helpers.__test__test_path.gsub("/__test__test", '')
+    end
+
+    config.to_prepare do
+      Engine.load_fake_api_dependencies
+    end
+
+    config.after_initialize do |app|
+      app.config.paths.add 'app/fake_api', eager_load: true
+      app.config.autoload_paths += Dir["#{Rails.root}/app/fake_api/**/*.rb"]
+    end
+
+    def Engine.load_fake_api_dependencies
+      Dir["#{Rails.root}/app/fake_api/**/*.rb"].each do |file|
+        require_dependency file
+      end
+    end
+  end
+end

data/lib/fake_api/factory.rb

@@ -0,0 +1,14 @@
+module FakeApi
+  class Factory
+    attr_reader :name, :value
+    def initialize(name:, value: nil, &block)
+      @name  = name
+      @value = value || block
+    end
+
+    def returns(new_value = nil, &block)
+      @value = new_value || block
+      self
+    end
+  end
+end

data/lib/fake_api/handler.rb

@@ -0,0 +1,56 @@
+module FakeApi
+  class Handler
+
+    def Handler.handle(method, path:, params: {}, headers: {})
+      if route = Handler.resolve(method, path)
+        result(
+          data: route.response.call,
+          status: route.status,
+          headers: route.headers,
+          cookies: route.cookies,
+          session: route.session
+        )
+      else
+        # READ MORE: https://github.com/igorkasyanchuk/fake_api
+        result(
+          data: %Q{
+            Route "#{FakeApi::Engine.mounted_in}/#{path}" was not found. Please edit your fake_api rounting file(s) in app/fake_api/*.rb.\n\nAvailable:
+            \n#{available.presence || 'NONE'}
+          }.strip,
+          status: 500,
+        )        
+      end
+    end
+
+    def Handler.result(data:, status: 200, headers: {}, cookies: {}, session: {})
+      OpenStruct.new(
+        data: data,
+        status: status,
+        headers: headers,
+        cookies: cookies,
+        session: session
+      )
+    end
+
+    private
+
+    def Handler.resolve(method, path)
+      FakeApiData.instance.routes.fetch(method, {}).each do |k, v|
+        return v if "/#{path}" == k
+        return v if k.is_a?(Regexp) && "/#{path}" =~ k
+      end
+      nil
+    end
+
+    def Handler.available
+      result = []
+      FakeApiData.instance.routes.collect do |method, route|
+        route.each do |k, v|
+          result << "#{method} #{FakeApi::Engine.mounted_in}#{k}"
+        end
+      end
+      result.sort.join("\n")
+    end
+
+  end
+end

data/lib/fake_api/route.rb

@@ -0,0 +1,40 @@
+module FakeApi
+  class Route
+    attr_reader :route, :response, :status, :headers, :cookies, :session
+
+    def initialize(route:, response: nil, status: 200, headers: {}, cookies: {}, session: {})
+      @route    = route
+      @response = response
+      @status   = status
+      @headers  = headers
+      @cookies  = cookies
+      @session  = session
+      self
+    end
+
+    def with_status(new_status)
+      @status = new_status
+      self
+    end
+
+    def and_return(new_response = nil, &block)
+      @response = new_response || block
+      self
+    end
+
+    def with_headers(new_headers)
+      @headers = new_headers
+      self
+    end
+
+    def with_cookies(new_cookies)
+      @cookies = new_cookies
+      self
+    end
+
+    def with_session(new_session)
+      @session = new_session
+      self
+    end
+  end
+end

data/lib/fake_api/version.rb

@@ -0,0 +1,3 @@
+module FakeApi
+  VERSION = '0.9.0'
+end

data/lib/generators/fake_api_generator.rb

@@ -0,0 +1,20 @@
+class FakeApiGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def create_fake_api_file
+    if file_name.blank?
+      puts "Sample: rails g fake_api Product"
+      exit
+    end
+    template 'routing.rb', File.join('app/fake_api', "#{file_name}_routing.rb")
+    template 'factory.rb', File.join('app/fake_api', "#{file_name}_factory.rb")
+  end
+
+  def class_name
+    args[0]&.strip
+  end
+
+  def file_name
+    class_name&.underscore
+  end
+end

data/lib/generators/templates/factory.rb

@@ -0,0 +1,29 @@
+class <%= class_name %>Factory < FakeApi::Factoring
+
+  factory(:user) do
+    {
+      id: rand(100),
+      first_name: Faker::Name.first_name,
+      last_name: Faker::Name.first_name,
+      avatar_url: Faker::Avatar.image(size: '128x128')
+    }
+  end
+
+  factory(:project) do
+    {
+      id: rand(1_000),
+      title: Faker::Company.name,
+      description: Faker::Company.catch_phrase,
+      type: Faker::Company.type,
+      author: object(:user)
+    }
+  end
+
+  factory(:complex) do
+    {
+      projects: create_list(:project, 2),
+      user: object(:user)
+    }
+  end
+
+end

data/lib/generators/templates/routing.rb

@@ -0,0 +1,13 @@
+class <%= class_name %>Routing < FakeApi::Routing
+  get('/projects').and_return           { create_list(:project, 5) }.with_status(202).with_headers({TOKEN: "SECRET"})
+
+  get(%r{/projects/\d+$})
+    .and_return { object(:project) }
+    .with_cookies({x: "A"})
+    .with_session({y: "B"})
+    .with_headers({token: "C"})
+
+  post('/projects').and_return          { object(:project).merge({created: 'ok'}) }
+
+  delete(%r{/projects/\d+$}).and_return { { result: :deleted } }.with_status(200)
+end

data/lib/tasks/fake_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fake_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fake_api
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The fastest way to prototype API in your Rails app using Faker and mix
+  of rails routes, factory bot and faker syntax
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/fake_api_manifest.js
+- app/controllers/fake_controller.rb
+- config/routes.rb
+- lib/fake_api.rb
+- lib/fake_api/base.rb
+- lib/fake_api/data.rb
+- lib/fake_api/debug.rb
+- lib/fake_api/engine.rb
+- lib/fake_api/factory.rb
+- lib/fake_api/handler.rb
+- lib/fake_api/route.rb
+- lib/fake_api/version.rb
+- lib/generators/fake_api_generator.rb
+- lib/generators/templates/factory.rb
+- lib/generators/templates/routing.rb
+- lib/tasks/fake_api_tasks.rake
+homepage: https://github.com/igorkasyanchuk/fake_api
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: The fastest way to prototype API in your Rails app.
+test_files: []