apige 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0052c0a5cdbc649eef08962d8aa20432f7d67ff7
+  data.tar.gz: 3a66942bd9878b0ff1bcf430bc63ce5aaa14c94c
+SHA512:
+  metadata.gz: 6a82ba307bceb34e87b8fbe7b073e1c7455e1cb7382d28a82f5e595bab70b1f8280e7ce28b029136ec0bc1f2038f459f220d8a141290955e6095a1a51c6f64ff
+  data.tar.gz: f4640aff36e89a5a831bd4207d6d0619e0549f51e2ff0c4fd68600eda5de5824520defd0f92223a6489185df6a10373d8ee49d0ed1bf23718abd238a9c696c3f

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+# Apige
+
+Just another api doc generator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apige'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apige
+
+## Usage
+
+Initialize:
+
+```
+# Will create default apige folder with default template and demo files.
+apige init
+# Create with specific folder
+apige init /apidoc
+```
+
+Then
+
+```
+# This will create md files in apige/docs/#{version}(optional)/#{api_filename}.md.
+apige compile
+```
+
+## FAQ
+
+### How to custom template?
+
+Just modify  temlate file in apige/templates.
+
+Structure.
+
+ - HEAD
+
+ - API Content(Render in defined order)
+
+## References
+
+### Configuration
+
+- templates: Required, Hash
+- date
+- version
+- author
+- meta
+
+### Scope Method
+
+#### group & resources
+
+- desc
+- meta
+
+#### get/put/post/delete
+
+- title
+- desc
+- meta
+- params
+- required
+
+### Template Varable
+
+- head: all config value
+- group: level name description parent children type apis
+- resources: Same with group
+- api: level title path method params response_value
+
+
+## WIP
+
+- Mock server
+- Support Api blueprint format.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/apige.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apige/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "apige"
+  spec.version = Apige::VERSION
+  spec.authors = ["Jerry Tao"]
+  spec.email = ["taojie@yeezon.com"]
+
+  spec.summary = %q{Just another api doc generator.}
+  spec.description = %q{Just another api doc generator.}
+  spec.homepage = "https://github.com/jerry-tao/apige"
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "gli", "~> 2.13"
+  spec.add_dependency "activesupport", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apige"
+
+# 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,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/examples/apis/post.rb

@@ -0,0 +1,71 @@
+Apige.run do
+  post = {:id => "bfed8b96-87a0-429d-ac4c-47f2b281b047",
+          :title => "My First Post",
+          :image => "http://image.example.com/example.jpg",
+          :author => "Jerry Tao",
+          :pub_date => "2017-4-1",
+          :summary => "This is my first post."}
+
+  post_simple = {"id": "6d78672f-85a3-44b9-a110-2356754a49c1", "title": "My First Post", "summary": "This is my first post."}
+  comment = {content:"Good for you.", date:"2017-4-2"}
+
+  ## Api scope
+  get '/' do
+    title 'Service Info'
+    desc 'This is service description api.'
+    # All return value will generate json default. Custom it in templates.
+    {version: '1.0', doc: 'http://doc.example.com', home: 'http://home.example.com', icon: 'http://icon.example.com'}
+  end
+
+  ## Group Scope
+  group 'Helper Api' do
+    desc 'This is some helper api'
+    meta responser: 'Jerry' # Meta is used for custom info, available in api, group and resources scope.
+    get '/status' do
+      title 'Service Status'
+      desc 'This is service status api.'
+      {status: 'OK'}
+    end
+  end
+
+  ## Resources Scope
+  resources 'Post' do
+    desc 'Used for resources post'
+    get '/posts' do
+      desc ''
+      params :page
+      [post_simple]
+    end
+
+    get '/posts/:id' do
+      required :id
+      post
+    end
+
+    post '/posts' do
+      params :title, :content, :image, :author, :pub_date, :summary # Params could include required or not, doesn't matter.
+      required :title, :content
+      post
+    end
+    put '/posts/:id' do
+      params :title, :content, :image, :author, :pub_date, :summary
+      required :id
+      post
+    end
+
+    delete '/posts/:id' do
+      required :id
+      post
+    end
+  end
+
+  ## Put it together
+  group 'Post related api' do
+    resources 'Comment' do
+      get '/posts/:post_id/comments' do
+        required :post_id
+        [comment]
+      end
+    end
+  end
+end

data/examples/config.rb

@@ -0,0 +1,15 @@
+Apige.configure do |config|
+  description = <<EOF
+This is my first project.
+EOF
+  config.date = Time.now
+  config.author = "Jerry Tao"
+  config.version = 'beta'
+  config.meta = { project_name: 'My first project', description: description }
+  config.templates = {
+    head: 'templates/head.md.erb',
+    group: 'templates/group.md.erb',
+    resources: 'templates/resources.md.erb',
+    api: 'templates/api.md.erb',
+  }
+end

data/exe/apige

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apige"
+require 'gli'
+require "pry"
+
+module GliWrapper
+  include GLI::App
+  extend self
+
+  program_desc 'Api generator.'
+  version Apige::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+
+  desc 'Initialize the apige file.'
+  arg_name 'folder'
+  command [:init] do |c|
+    c.action do |global_options, options, args|
+      dir = args[0] ==nil ? '.' : args[0]
+      dir = File.join(dir, 'apige')
+      FileUtils.mkdir_p(dir)
+      root = File.expand_path('../../.',__FILE__)
+      FileUtils.cp_r(File.join(root,'templates'), dir)
+      FileUtils.cp(File.join(root,'examples/config.rb'), dir)
+      FileUtils.cp_r(File.join(root,'examples/apis'), dir)
+    end
+  end
+
+  desc 'Create the md file.'
+  command [:compile] do |c|
+    c.action do |global_options, options, args|
+      if File.exists?('./apige')
+        root_dir = File.join('.', 'apige')
+      elsif File.exists?('./apis')
+        root_dir = '.'
+      else
+        raise "Can't find the apige forlder."
+      end
+      require File.join(root_dir, 'config.rb')
+      Apige.compile!(root_dir)
+    end
+  end
+
+  pre do |global, command, options, args|
+    true
+  end
+
+  on_error do |exception|
+    case exception.class
+    when Errno::EEXIST
+      puts "Folder already exists."
+    else
+      puts exception
+      puts exception.backtrace
+    end
+  end
+
+  exit run(ARGV)
+end

data/lib/apige.rb

@@ -0,0 +1,50 @@
+require "apige/version"
+require "apige/config"
+require "apige/context"
+require "apige/context/api"
+require "apige/context/scope"
+require "apige/context/api_wrapper"
+
+module Apige
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def run(&block)
+      @context = Context.new(block)
+      @context.run!
+    end
+
+    def context
+      @context
+    end
+
+    def compile!(root_dir)
+      config.root_dir = root_dir
+      doc_dir = File.join(root_dir, 'docs', Apige.config.version.to_s)
+      FileUtils.mkdir_p(doc_dir)
+      Dir["#{root_dir}/apis/*.rb"].each { |r|
+        api = File.basename r, '.rb'
+        require r
+        File.open(File.join(doc_dir, api+'.md'), 'w') do |file|
+          file.write Apige.context.compile!
+        end
+      }
+    end
+
+    def templates
+      config.templates
+    end
+
+    def root_dir
+      config.root_dir
+    end
+  end
+
+end

data/lib/apige/config.rb

@@ -0,0 +1,7 @@
+require "active_support/all"
+module Apige
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :date, :meta, :version, :templates, :author, :root_dir
+  end
+end

data/lib/apige/context.rb

@@ -0,0 +1,98 @@
+module Apige
+  class Context
+    def initialize(block)
+      @block = block
+      @scope = Scope.new
+      @result = ''
+    end
+
+    def run!
+      instance_exec &@block
+    end
+
+    def compile!
+      @result << compile_head
+      @result << "\n"
+      compile(@scope)
+      @result
+    end
+
+    def compile_head
+      template = File.join(Apige.root_dir, Apige.templates[:head])
+      erb = ERB.new(File.read(template))
+      erb.filename = template
+      erb.def_method(Apige::Config, 'render()')
+      Apige.config.render()
+    end
+
+    def compile(scope)
+      if !scope.children.empty?
+        compile_api(scope)
+        scope.children.map { |item| compile(item) }
+      else
+        template = File.join(Apige.root_dir, Apige.templates[scope.type])
+        erb = ERB.new(File.read(template))
+        erb.filename= template
+        erb.def_method(Scope, 'render()')
+        @result << scope.render()
+        @result << "\n"
+        compile_api(scope)
+      end
+    end
+
+    def compile_api(scope)
+      scope.apis.map { |wrapper|
+        template =File.join(Apige.root_dir, Apige.templates[:api])
+        erb = ERB.new(File.read(template))
+        erb.filename= template
+        erb.def_method(Api, 'render(level)')
+        @result << wrapper.api.render(scope.level+1)
+        @result << "\n"
+      }
+    end
+
+    def default_api(method, path, block)
+      @scope.apis << ApiWrapper.new(method, path, block)
+    end
+
+
+    def desc(description)
+      @scope.description = description
+    end
+
+    def group(name, &block)
+      scope = @scope.new_child(name, :group)
+      @scope = scope
+      instance_exec &block
+      @scope = @scope.parent
+    end
+
+    def meta(data)
+      @scope.meta = data
+    end
+
+    def resources(name, &block)
+      @scope = @scope.new_child(name, :resources)
+      instance_exec &block
+      @scope = @scope.parent
+    end
+
+    def get(path, &block)
+      default_api(:get, path, block)
+    end
+
+    def put(path, &block)
+      default_api(:get, path, block)
+    end
+
+    def post(path, &block)
+      default_api(:get, path, block)
+    end
+
+    def delete(path, &block)
+      default_api(:get, path, block)
+    end
+
+  end
+
+end

data/lib/apige/context/api.rb

@@ -0,0 +1,13 @@
+module Apige
+  class Context
+    class Api
+      attr_accessor :method, :path, :origin_params, :required, :response_value, :title, :desc, :meta
+
+      def params
+        Array((origin_params+required).uniq).map do |item|
+          {name: item, required: required.index(item)!=nil}
+        end
+      end
+    end
+  end
+end

data/lib/apige/context/api_wrapper.rb

@@ -0,0 +1,39 @@
+module Apige
+  class Context
+    class ApiWrapper
+      def initialize(method, path, block)
+        @api = Api.new
+        api.method = method
+        api.path = path
+        api.origin_params = []
+        api.required = []
+        @block = block
+        api.response_value = instance_exec &block
+      end
+
+      def api
+        @api
+      end
+
+      def required(*argv)
+        api.required = api.required.concat(argv).uniq
+      end
+
+      def params(*argv)
+        api.origin_params = api.origin_params.concat(argv).uniq
+      end
+
+      def meta(data)
+        api.meta = data
+      end
+
+      def desc(argv)
+        api.desc = argv
+      end
+
+      def title(argv)
+        api.title = argv
+      end
+    end
+  end
+end

data/lib/apige/context/scope.rb

@@ -0,0 +1,24 @@
+module Apige
+  class Context
+    class Scope
+      def initialize(name='', type='top', parent=nil, level=1)
+        @level = level
+        @apis = []
+        @name = name
+        @type = type
+        @parent = parent
+        @children = []
+        @description = ''
+      end
+
+      attr_accessor :meta, :children, :apis, :description, :name,:level, :type, :parent
+
+      def new_child(name, type)
+        scope = Scope.new(name, type, self, @level+1)
+        @children << scope
+        scope
+      end
+
+    end
+  end
+end

data/lib/apige/version.rb

@@ -0,0 +1,3 @@
+module Apige
+  VERSION = "0.1.1"
+end

data/templates/api.md.erb

@@ -0,0 +1,14 @@
+<%="#" * level%> <%= @title %> [<%= method.to_s.upcase%> <%= path %>]
+
+<%if params.size != 0%>
+Params
+
+<% params.each do |item|%>
+<%= item[:name]%>: <%= item[:required]%>
+<% end%>
+<% end%>
+Response
+
+```
+<%=JSON.pretty_generate(response_value)%>
+```

data/templates/group.md.erb

@@ -0,0 +1,2 @@
+<%="#" * level%> <%= name %>
+<%=description%>

data/templates/head.md.erb

@@ -0,0 +1,7 @@
+Version: <%= version %>
+Author: <%= author %>
+Date: <%= date.strftime '%Y-%m-%d' %>
+
+# <%= meta[:project_name]%>
+
+<%= meta[:description]%>

data/templates/resources.md.erb

@@ -0,0 +1,2 @@
+<%="#" * @level%> <%= name %>
+<%=description%>

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: apige
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jerry Tao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 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: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Just another api doc generator.
+email:
+- taojie@yeezon.com
+executables:
+- apige
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- apige.gemspec
+- bin/console
+- bin/setup
+- examples/apis/post.rb
+- examples/config.rb
+- exe/apige
+- lib/apige.rb
+- lib/apige/config.rb
+- lib/apige/context.rb
+- lib/apige/context/api.rb
+- lib/apige/context/api_wrapper.rb
+- lib/apige/context/scope.rb
+- lib/apige/version.rb
+- templates/api.md.erb
+- templates/group.md.erb
+- templates/head.md.erb
+- templates/resources.md.erb
+homepage: https://github.com/jerry-tao/apige
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Just another api doc generator.
+test_files: []