api_def 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cf0a8c51de632e9b5a12ad9aa40733cbf39c0f7
+  data.tar.gz: 74351fd28942fc015d13048ae8e9343b749db347
+SHA512:
+  metadata.gz: 3419a50a596b5e0d68461a82f8451a82880e48877b692c1dd253b294b42ab5972190b4686bd2ded9002018116daa8140900a64f173b77749732efa6403b9da0a
+  data.tar.gz: 3399a162a124f985c2acce996f55e253520f060ec672178ecceb5561a3624c4bfd98ec4c08196360d5422e6dd60ae9857287150ef664e9f9c7554cf128f85c91

data/bin/api_def

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+#TODO: remove after development finished
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'api_def'
+
+ApiDef::CLI.start(ARGV)

data/lib/api_def/cli.rb

@@ -0,0 +1,33 @@
+require 'thor'
+
+class ApiDef::CLI < Thor
+  desc "build FILE", "build API specification for FILE"
+  option :template, {
+    aliases: '-t',
+    default: 'markdown',
+    required: true,
+    type: :string,
+    enum: ['markdown', 'html'],
+    desc: 'Output template'
+  }
+  def build(file)
+    spec = load_spec file
+    tpl = ApiDef::Template.find(options[:template]).new
+    STDOUT.write tpl.render(spec)
+  end
+
+  desc "mock FILE", "start a mock server for FILE"
+  def mock(file)
+    spec = load_spec file
+    app  = ApiDef::Mock.create_application spec
+    app.run!
+  end
+
+  private
+  def load_spec(file)
+    content = File.open(file).read.to_s
+    spec = ApiDef::Specification.new
+    spec.instance_eval content, file
+  end
+
+end

data/lib/api_def/element.rb

@@ -0,0 +1,17 @@
+class ApiDef::Element
+  include ApiDef::Support::AttrUno
+  include ApiDef::Support::AttrArray
+  include ApiDef::Support::AttrUnoArray
+
+  attr_uno :name, :desc
+
+  def initialize(name = nil, options = {})
+    self.name name
+    self.on_options(options)
+    yield self if block_given?
+  end
+
+  def on_options(options)
+    self.desc options[:desc]
+  end
+end

data/lib/api_def/entry.rb

@@ -0,0 +1,7 @@
+# ApiDef::Entry means a entry of api
+class ApiDef::Entry < ApiDef::Element
+  attr_uno :method, :path
+
+  attr_uno_array :request, class: 'ApiDef::Request'
+  attr_uno_array :response,class: 'ApiDef::Response'
+end

data/lib/api_def/group.rb

@@ -0,0 +1,4 @@
+# ApiDef::Group means a group of api entries
+class ApiDef::Group < ApiDef::Element
+  attr_uno_array :entry, store: :entries, class: 'ApiDef::Entry'
+end

data/lib/api_def/mock.rb

@@ -0,0 +1,32 @@
+require 'sinatra/base'
+
+class ApiDef::Mock
+
+  def self.create_application(spec)
+    Class.new(Sinatra::Base) do
+      configure do
+        set :public_folder, File.expand_path("../../public", __FILE__)
+        disable :protection
+        settings.add_charset << "application/json"
+      end
+      before do
+        content_type :json
+      end
+      # root for description
+      get "/" do
+        content_type :html
+        tpl = ApiDef::Template::Html.new
+        tpl.render spec
+      end
+      # entries
+      spec.groups.each do |group|
+        group.entries.each do |entry|
+          self.send(entry.method.to_sym, entry.path) do
+            JSON.pretty_generate(entry.responses.sample.body)
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/api_def/parameter.rb

@@ -0,0 +1,9 @@
+class ApiDef::Parameter < ApiDef::Element
+  attr_uno :optional, :type
+
+  def on_options(options)
+    super
+    self.optional options[:optional]
+    self.type options[:type]
+  end
+end

data/lib/api_def/request.rb

@@ -0,0 +1,4 @@
+# ApiDef::Request means a request made to a api entry
+class ApiDef::Request < ApiDef::Element
+  attr_uno_array :param, class: 'ApiDef::Parameter'
+end

data/lib/api_def/response.rb

@@ -0,0 +1,13 @@
+require 'jbuilder'
+
+# ApiDef::Response means a response api returned
+class ApiDef::Response < ApiDef::Element
+
+  def body(&block)
+    if block
+      @body = Jbuilder.new(&block).attributes!
+    else
+      @body
+    end
+  end
+end

data/lib/api_def/specification.rb

@@ -0,0 +1,5 @@
+class ApiDef::Specification < ApiDef::Element
+  attr_uno        :version
+  attr_uno_array  :group,   class: 'ApiDef::Group'
+  attr_uno_array  :element, class: 'ApiDef::Element'
+end

data/lib/api_def/support/attr_array.rb

@@ -0,0 +1,22 @@
+module ApiDef::Support::AttrArray
+
+  def self.included(mod)
+
+    mod.class_eval do
+
+      # Create method +name+ with +@name+ for array storage
+      def self.attr_array(*names)
+        names.flatten.each do |name|
+          self.class_eval <<-EOF
+          def #{name}
+            @#{name} ||= []
+          end
+          EOF
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/api_def/support/attr_uno.rb

@@ -0,0 +1,26 @@
+module ApiDef::Support::AttrUno
+
+  def self.included(mod)
+
+    mod.class_eval do
+
+      # Create method +name+ with +name(value)+ for setter and +name+ for getter
+      def self.attr_uno(*names)
+        names.flatten.each do |name|
+          self.class_eval <<-EOF
+          def #{name}(value = nil)
+            if value
+              @#{name} = value
+            else
+              @#{name}
+            end
+          end
+          EOF
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/api_def/support/attr_uno_array.rb

@@ -0,0 +1,29 @@
+module ApiDef::Support::AttrUnoArray
+
+  def self.included(mod)
+
+    mod.class_eval do
+
+      def self.attr_uno_array(name, opts)
+        clazz = opts[:class]
+        raise "Please specify a class" unless clazz
+        store = opts[:store] || (name.to_s + "s")
+
+        self.attr_array store
+        self.class_eval <<-EOF
+
+        def #{name}(value = nil, opts = {})
+          obj = #{clazz}.new(value, opts)
+          yield obj if block_given?
+          self.#{store} << obj
+          self
+        end
+
+        EOF
+      end
+
+    end
+
+  end
+
+end

data/lib/api_def/template/html.rb

@@ -0,0 +1,37 @@
+require 'redcarpet'
+
+class ApiDef::Template::Html < ApiDef::Template
+
+  def render(spec)
+    tpl = ApiDef::Template::Markdown.new
+    md  = tpl.render(spec)
+    content = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+    :autolink => true,
+    :space_after_headers => true,
+    :fenced_code_blocks => true
+    ).render(md)
+    %{
+      <!doctype html>
+      <html>
+      <head>
+      <meta name="content-type" content="text/html;charset=utf-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1, minimal-ui">
+      <title>#{spec.name}</title>
+      <style>
+      body {
+        min-width: 200px;
+        max-width: 790px;
+        margin: 0 auto;
+        padding: 30px;
+      }
+      </style>
+      </head>
+      <body>
+      <article class="markdown-body">
+      #{content}
+      </article>
+      </body>
+      </html>
+    }
+  end
+end

data/lib/api_def/template/markdown.rb

@@ -0,0 +1,64 @@
+require 'erb'
+require 'json'
+
+class ApiDef::Template::Markdown < ApiDef::Template
+  TEMPLATE_FILE= %{
+# <%= spec.name %>
+# <%= spec.version %>
+
+<% spec.elements.each do |ele| -%>
+## <%= ele.name %>
+
+<%= ele.desc %>
+<% end -%>
+
+<% spec.groups.each do |group| -%>
+## <%= group.name %>
+
+<%= group.desc %>
+    <% group.entries.each do |entry| %>
+### <%= entry.name %>
+
+<%= entry.desc %>
+
+#### `<%= entry.path %>` [<%= entry.method.to_s.upcase %>]
+      <% entry.requests.each do |request| -%>
+
+##### Request <%= request.name %>
+
+<%= request.desc %>
+
+<% request.params.each do |param| -%>
++ `<%= param.name %>`, <%= param.type %>, <%="Optional, " if param.optional%><%= param.desc %>
+<% end -%>
+
+      <% end -%>
+
+      <% entry.responses.each do |response| -%>
+
+##### Response <%= response.name %>
+
+<%= response.desc %>
+
+```json
+<%= JSON.pretty_generate(response.body) %>
+```
+      <% end -%>
+    <% end -%>
+  <% end -%>
+}
+
+  def render(_spec)
+    clazz = ::ERB.new(TEMPLATE_FILE, nil, "-").def_class
+    clazz.class_eval do
+      def initialize(_spec)
+        @spec = _spec
+      end
+
+      def spec
+        @spec
+      end
+    end
+    clazz.new(_spec).result
+  end
+end

data/lib/api_def/template.rb

@@ -0,0 +1,17 @@
+class ApiDef::Template
+  autoload :Markdown, 'api_def/template/markdown'
+  autoload :Html,     'api_def/template/html'
+
+  def self.find(name)
+    case name.to_s
+    when 'html'
+      ApiDef::Template::Html
+    when 'markdown'
+      ApiDef::Template::Markdown
+    end
+  end
+
+  def render(spec)
+    raise "Implementation required"
+  end
+end

data/lib/api_def.rb

@@ -0,0 +1,28 @@
+module ApiDef
+  VERSION="1.0.0"
+  # CLI
+  autoload :CLI,      'api_def/cli'
+  autoload :Template, 'api_def/template'
+
+  # Specification and DSL
+  autoload :Specification,  'api_def/specification'
+
+  # ApiDef models
+  autoload :Element,  'api_def/element'
+
+  autoload :Group,    'api_def/group'
+  autoload :Entry,    'api_def/entry'
+  autoload :Request,  'api_def/request'
+  autoload :Parameter,'api_def/parameter'
+  autoload :Response, 'api_def/response'
+
+  # Mock Server
+  autoload :Mock,     'api_def/mock'
+
+  # Supports
+  module Support
+    autoload :AttrUno,        'api_def/support/attr_uno'
+    autoload :AttrUnoArray,   'api_def/support/attr_uno_array'
+    autoload :AttrArray,      'api_def/support/attr_array'
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: api_def
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- YANKE Guo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+description: Ruby DSL based API definition tool.
+email: me@yanke.io
+executables:
+- api_def
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/api_def/cli.rb
+- lib/api_def/element.rb
+- lib/api_def/entry.rb
+- lib/api_def/group.rb
+- lib/api_def/mock.rb
+- lib/api_def/parameter.rb
+- lib/api_def/request.rb
+- lib/api_def/response.rb
+- lib/api_def/specification.rb
+- lib/api_def/support/attr_array.rb
+- lib/api_def/support/attr_uno.rb
+- lib/api_def/support/attr_uno_array.rb
+- lib/api_def/template/html.rb
+- lib/api_def/template/markdown.rb
+- lib/api_def/template.rb
+- lib/api_def.rb
+- bin/api_def
+homepage: http://rubygems.org/gems/api_def
+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.0.14
+signing_key: 
+specification_version: 4
+summary: API definition tool
+test_files: []