apipony 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16ec7c74c22986537ee6460f202811c66a46d91b
+  data.tar.gz: 562ca6ed7206f38acf9ebff6ef0f902f543dc729
+SHA512:
+  metadata.gz: 2a74541337286f496381429131949798932742457c0166be5385dc62673b08e2a570f0165e1c5d3d7b38d14d4fa946a768e776f1fc027a6237f74b3d3d225223
+  data.tar.gz: 390e6edd30e0f94a030cf39ab604d2c538f13c4925eda4b3b5a16fe726594bf39ecf5b16abf3a27aadd1eaffbf14c9b6d65c0b60215b42a41c6131ebe3404786

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Sergey Novikov
+
+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,50 @@
+# Apipony
+
+Ruby DSL to create Rails API documentation from your application.
+
+## Getting started
+
+* Add `gem 'apipony'` to Gemfile
+* `bundle install`
+* `rails g apipony:install`
+* Now you can edit your documentation in `config/initializers/apipony.rb`
+
+## How it works
+
+DSL example:
+
+```ruby
+Apipony::Documentation.define do
+  config do |c|
+    c.title = 'Apipony Documentation'
+    c.base_url = '/api/v1'
+  end
+
+  section 'Ponies' do
+    endpoint 'get', '/ponies' do |e|
+      e.description = 'Find ponies'
+
+      request_with do
+        set :params, {
+          :name => :applejack
+        }
+      end
+
+      response_with 200 do
+        set :body, {
+          :name => :applejack,
+          :kind => :earth,
+          :sex => :female,
+          :occupation => :farmer
+        }
+      end
+    end
+  end
+end
+```
+
+Generated documentation example:
+
+![Example](https://raw.githubusercontent.com/droptheplot/apipony/master/preview.png)
+
+By default documentation available here `/apipony`. But you can always change it in `config/routes.rb`.

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Apipony'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/apipony/application.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/apipony/scripts.js

@@ -0,0 +1,5 @@
+$(document).ready(function() {
+  $('.code').each(function(i, block) {
+    hljs.highlightBlock(block);
+  });
+});

data/app/assets/stylesheets/apipony/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/apipony/styles.scss

@@ -0,0 +1,154 @@
+$dark_color: #111;
+$medium_color: #888;
+$light_color: #eee;
+
+* {
+  margin: 0;
+  padding: 0;
+  &:focus {
+    outline: none;
+  }
+}
+
+html, body {
+  height: 100%;
+  margin: 0;
+}
+
+body {
+  font-family: 'Arial';
+  font-size: 14px;
+  color: $dark_color;
+  -webkit-font-smoothing: antialiased;
+}
+
+a {
+  color: $dark_color;
+  text-decoration: none;
+}
+
+h1 {
+  font-size: 24px;
+  font-weight: bold;
+  padding-bottom: 20px;
+  margin-bottom: 40px;
+  border-bottom: 1px solid $light_color;
+}
+
+h2 {
+  font-size: 22px;
+  font-weight: normal;
+  margin-bottom: 20px;
+}
+
+h3 {
+  font-size: 17px;
+  line-height: 17px;
+}
+
+h4 {
+  font-size: 14px;
+  margin-bottom: 10px;
+  font-weight: bold;
+}
+
+h5 {
+  font-weight: normal;
+}
+
+ul {
+  margin-bottom: 20px;
+  li {
+    margin-bottom: 10px;
+  }
+}
+
+.container {
+  width: 940px;
+  margin: 0 auto;
+  padding: 40px 0;
+  position: relative;
+}
+
+.row {
+  overflow: hidden;
+  margin: 0 -10px;
+}
+
+@for $i from 1 through 12 {
+  .col-#{$i} {
+    box-sizing: border-box;
+    margin: 0 10px;
+    width: 60px * $i + 20px * ($i - 1);
+    float: left;
+  }
+}
+
+@for $i from 1 through 12 {
+  .col-offset-#{$i} {
+    margin-left: 60px * $i + 20px * ($i - 1) + 30px;
+  }
+}
+
+.section {
+  &:not(:last-child) {
+    padding-bottom: 40px;
+    margin-bottom: 40px;
+    border-bottom: 1px solid $light_color;
+  }
+  .endpoint {
+    position: relative;
+    &:not(:last-child) {
+      margin-bottom: 40px;
+    }
+    .description {
+      font-size: 12px;
+      color: $medium_color;
+      padding-top: 20px;
+      font-weight: normal;
+    }
+    .response, .request {
+      padding-top: 20px;
+      .code {
+        padding: 8px 10px 10px;
+        font-size: 12px;
+        border-radius: 0 0 3px 3px;
+      }
+    }
+  }
+}
+
+.panel {
+  border: 1px solid darken($light_color, 5%);
+  border-radius: 3px;
+  margin-top: 20px;
+  .title {
+    border-bottom: 1px solid darken($light_color, 5%);
+    padding: 10px;
+    font-size: 11px;
+    font-weight: bold;
+  }
+}
+
+.method {
+  text-transform: uppercase;
+  color: #fff;
+  font-size: 9px;
+  padding: 4px 5px;
+  border-radius: 3px;
+  margin-right: 5px;
+  font-weight: bold;
+  background: $medium_color;
+  &.get {
+    background: #1ABC9C;
+  }
+  &.post {
+    background: #3498DB;
+  }
+  &.put {
+    background: #2980B9;
+  }
+  &.delete {
+    background: #C0392B;
+  }
+}

data/app/controllers/apipony/application_controller.rb

@@ -0,0 +1,7 @@
+module Apipony
+  class ApplicationController < ActionController::Base
+    def index
+      @documentation = Apipony::Documentation
+    end
+  end
+end

data/app/views/apipony/application/index.html.haml

@@ -0,0 +1,50 @@
+.row
+  .col-3
+    - @documentation.sections.each do |section|
+      %h4= section.title
+      %ul
+        - section.endpoints.each do |endpoint|
+          %li
+            %h5
+              = link_to root_path(:anchor => endpoint.id) do
+                %span.method{ :class => endpoint.method }<
+                  = endpoint.method
+                = endpoint.url
+  .col-9
+    %h1= @documentation.title
+    - @documentation.sections.each do |section|
+      .section
+        %h2= section.title
+        - section.endpoints.each do |endpoint|
+          .endpoint{ :id => endpoint.id }
+            %h3
+              %span.method{ :class => endpoint.method }<
+                = endpoint.method
+              = endpoint.url
+            - if endpoint.description
+              .description= endpoint.description
+            - if endpoint.request || endpoint.response
+              - if endpoint.request
+                .request
+                  %h4 Request:
+                  - if endpoint.request.params
+                    .panel
+                      .title Parameters
+                      %pre.code= JSON.pretty_generate(endpoint.request.params)
+                  - if endpoint.request.headers
+                    .panel
+                      .title Headers
+                      %pre.code= JSON.pretty_generate(endpoint.request.headers)
+              - if endpoint.response
+                .response
+                  %h4
+                    Response:
+                    = endpoint.response.status
+                  - if endpoint.response.body
+                    .panel
+                      .title Body
+                      %pre.code= JSON.pretty_generate(endpoint.response.body)
+                  - if endpoint.response.headers
+                    .panel
+                      .title Headers
+                      %pre.code= JSON.pretty_generate(endpoint.response.headers)

data/app/views/layouts/apipony/application.html.haml

@@ -0,0 +1,12 @@
+!!!
+%html
+  %head
+    %title Apipony
+    %link{ :href => '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css', :rel => 'stylesheet' }/
+    = stylesheet_link_tag 'apipony/application', media: 'all'
+    %script{ :src => '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/highlight.min.js' }
+    = javascript_include_tag 'apipony/application'
+    = csrf_meta_tags
+  %body
+    .container
+      = yield

data/config/routes.rb

@@ -0,0 +1,4 @@
+Apipony::Engine.routes.draw do
+  get 'application/index'
+  root 'application#index'
+end

data/lib/apipony/base.rb

@@ -0,0 +1,7 @@
+class Apipony::Base
+  private
+
+    def set(variable, value)
+      instance_variable_set("@#{ variable }", value)
+    end
+end

data/lib/apipony/documentation.rb

@@ -0,0 +1,19 @@
+class Apipony::Documentation
+  class << self
+    attr_accessor :title, :base_url, :sections
+
+    def define(&block)
+      @sections = []
+
+      instance_eval(&block)
+    end
+
+    def section(title, &block)
+      @sections << Apipony::Section.new(title, &block)
+    end
+
+    def config(&block)
+      instance_eval(&block)
+    end
+  end
+end

data/lib/apipony/endpoint.rb

@@ -0,0 +1,28 @@
+class Apipony::Endpoint < Apipony::Base
+  attr_accessor :method, :url, :description, :response, :request
+
+  def initialize(method, url, &block)
+    @method = method
+    @url = set_base_url(url)
+
+    instance_eval(&block) if block_given?
+  end
+
+  def response_with(status, &block)
+    @response = Apipony::Response.new(status, &block)
+  end
+
+  def request_with(&block)
+    @request = Apipony::Request.new(&block)
+  end
+
+  def id
+    File.join(@method, @url)
+  end
+
+  private
+
+    def set_base_url(url)
+      File.join(Apipony::Documentation.base_url, url)
+    end
+end

data/lib/apipony/engine.rb

@@ -0,0 +1,5 @@
+module Apipony
+  class Engine < ::Rails::Engine
+    isolate_namespace Apipony
+  end
+end

data/lib/apipony/request.rb

@@ -0,0 +1,7 @@
+class Apipony::Request < Apipony::Base
+  attr_accessor :params, :headers
+
+  def initialize(&block)
+    instance_eval(&block)
+  end
+end

data/lib/apipony/response.rb

@@ -0,0 +1,9 @@
+class Apipony::Response < Apipony::Base
+  attr_accessor :status, :headers, :body
+
+  def initialize(status, &block)
+    @status = status
+
+    instance_eval(&block) if block_given?
+  end
+end

data/lib/apipony/section.rb

@@ -0,0 +1,14 @@
+class Apipony::Section
+  attr_accessor :title, :endpoints
+
+  def initialize(title, &block)
+    @title = title
+    @endpoints = []
+
+    instance_eval(&block)
+  end
+
+  def endpoint(method, url, &block)
+    @endpoints << Apipony::Endpoint.new(method, url, &block)
+  end
+end

data/lib/apipony/version.rb

@@ -0,0 +1,3 @@
+module Apipony
+  VERSION = '0.0.1'
+end

data/lib/apipony.rb

@@ -0,0 +1,11 @@
+require 'apipony/engine'
+
+require 'apipony/base'
+require 'apipony/documentation'
+require 'apipony/section'
+require 'apipony/endpoint'
+require 'apipony/response'
+require 'apipony/request'
+
+module Apipony
+end

data/lib/generators/apipony/install/templates/initializer.rb

@@ -0,0 +1,84 @@
+Apipony::Documentation.define do
+  config do |c|
+    c.title = 'Apipony Documentation'
+    c.base_url = '/api/v1'
+  end
+
+  section 'Ponies' do
+    endpoint 'get', '/ponies' do |e|
+      e.description = 'Find ponies'
+
+      request_with do
+        set :params, {
+          :name => :applejack
+        }
+      end
+
+      response_with 200 do
+        set :body, {
+          :name => :applejack,
+          :kind => :earth,
+          :sex => :female,
+          :occupation => :farmer
+        }
+      end
+    end
+
+    endpoint 'post', '/ponies' do |e|
+      e.description = 'Create pony'
+
+      request_with do
+        set :params, {
+          :name => :fluttershy,
+          :kind => :pegasus,
+          :sex => :female,
+          :occupation => :caretaker
+        }
+      end
+
+      response_with 200
+    end
+
+    endpoint 'put', '/ponies/:id' do |e|
+      e.description = 'Update pony id'
+
+      request_with do
+        set :params, {
+          :name => :fluttershy,
+          :kind => :pegasus,
+          :sex => :female,
+          :occupation => :singer
+        }
+      end
+    end
+
+    endpoint 'delete', '/ponies/:id' do |e|
+      e.description = 'Delete pony by id'
+
+      response_with 200
+    end
+  end
+
+  section 'Places' do
+    endpoint 'get', '/places' do |e|
+      e.description = 'Get places'
+
+      response_with 200 do
+        set :body, [
+          {
+            :id => 1,
+            :name => :equestria
+          },
+          {
+            :id => 2,
+            :name => :ponyville
+          },
+          {
+            :id => 3,
+            :name => :canterlot
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/generators/apipony/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/base'
+
+module Apipony
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../install/templates', __FILE__)
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/apipony.rb'
+      end
+
+      def mount_engine
+        insert_into_file "#{Rails.root}/config/routes.rb", :after => /routes.draw.do\n/ do
+          %Q{  mount Apipony::Engine => '/apipony'
+}
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: apipony
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Novikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.19
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: 
+email:
+- novikov359@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/apipony/application.js
+- app/assets/javascripts/apipony/scripts.js
+- app/assets/stylesheets/apipony/application.css
+- app/assets/stylesheets/apipony/styles.scss
+- app/controllers/apipony/application_controller.rb
+- app/views/apipony/application/index.html.haml
+- app/views/layouts/apipony/application.html.haml
+- config/routes.rb
+- lib/apipony.rb
+- lib/apipony/base.rb
+- lib/apipony/documentation.rb
+- lib/apipony/endpoint.rb
+- lib/apipony/engine.rb
+- lib/apipony/request.rb
+- lib/apipony/response.rb
+- lib/apipony/section.rb
+- lib/apipony/version.rb
+- lib/generators/apipony/install/templates/initializer.rb
+- lib/generators/apipony/install_generator.rb
+homepage: https://github.com/droptheplot/apipony
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Easy Rails API documentation.
+test_files: []