apipony 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fba28b70c7a9ec44196e47c169e155354c568b6c
-  data.tar.gz: b3a2c51b00dbff1967a9eda1912361782f63b32e
+  metadata.gz: 86b81077625eb78efec26c41c96c30e832ef5c02
+  data.tar.gz: d05befea092568084df3b920dfbc5ed4ea64f17d
 SHA512:
-  metadata.gz: 8de377ae321a47d1bc86b5d952554ba17483b886e4ecdc59f239fefa76bc98ea30a9bbf9ee36dd816c662ed67b3554fed721029da5729e56bbaf104cd7831602
-  data.tar.gz: 6ad91921dd5e5e85618d5fcbbdb30d557807ba2e5fae69e5413ad6ac2b5ff92b43afd04e628f7db18035e8316af795f9e694ead06a2c756bc223d6285200a4db
+  metadata.gz: 5fe9cdb7e1cfea04e9d4bac98aee904753b87750048da48fc4c37c826b9232bf709c17d1ed58f9c5c146b50f22915abc3cb91e054d85bd2c0c220d4c354c522c
+  data.tar.gz: 2b756e4a6ec30fe410c96d8fa6d609dac9d73284b8c7f7b3bb594427d178873c97c857ce60a6d022d5ed629d6bea18aba6527a03f37d7b379b1a5961e6fbc698

data/README.md

@@ -28,9 +28,7 @@ Apipony::Documentation.define do
       e.description = 'Find ponies'
 
       request_with do
-        set :params, {
-          :name => :applejack
-        }
+        param :name, example: 'applejack', required: true 
       end
 
       response_with 200 do

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

@@ -1,6 +1,9 @@
 $dark_color: #111;
 $medium_color: #888;
 $light_color: #eee;
+$brand_color: #5E147D;
+
+@import url(https://fonts.googleapis.com/css?family=Cuprum&subset=latin,cyrillic);
 
 * {
   margin: 0;
@@ -66,7 +69,6 @@ ul {
 .container {
   width: 940px;
   margin: 0 auto;
-  padding: 40px 0;
   position: relative;
 }
 
@@ -90,6 +92,39 @@ ul {
   }
 }
 
+header {
+  background: $brand_color;
+  height: 60px;
+  line-height: 60px;
+  .title {
+    font-family: 'Cuprum';
+    font-weight: bold;
+    font-size: 20px;
+    color: #fff;
+  }
+  .back {
+    float: right;
+    color: #fff;
+    opacity: .7;
+    font-size: 12px;
+  }
+}
+
+main {
+  padding: 40px 0;
+}
+
+footer {
+  height: 60px;
+  line-height: 60px;
+  border-top: 1px solid $light_color;
+  text-align: right;
+  font-size: 12px;
+  a {
+    color: $medium_color;
+  }
+}
+
 .section {
   &:not(:last-child) {
     padding-bottom: 40px;
@@ -152,3 +187,29 @@ ul {
     background: #C0392B;
   }
 }
+
+.param {
+  .name {
+    color: $brand_color;
+    font-weight: bold;
+  }
+  .type {
+    color: $medium_color;
+    font-style: italic;
+  }
+  .required {
+    text-align: center;
+    .fa {
+      color: $medium_color;
+    }
+  }
+}
+
+.table {
+  padding: 8px 0;
+  tr {
+    td {
+      padding: 2px 10px;
+    }
+  }
+}

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

@@ -1,50 +1,74 @@
-.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)
+%header
+  .container
+    = link_to @documentation.title, root_path, class: 'title'
+    - if main_app.root_path
+      = link_to 'Back to site', main_app.root_path, class: 'back'
+%main
+  .container
+    .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
+        - @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
+                          %table.table
+                            - endpoint.request.params.each do |param|
+                              %tr.param
+                                %td.name
+                                  = param.name
+                                %td.type
+                                  = param.type
+                                %td.required
+                                  - if param.required
+                                    %i.fa.fa-check-square-o{ :title => 'Required' }
+                                  - else
+                                    %i.fa.fa-square-o{ :title => 'Optional' }
+                                %td.example
+                                  = param.example
+                      - 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)
+%footer
+  .container
+    = link_to 'https://github.com/droptheplot/apipony' do
+      %i.fa.fa-github
+      Apipony

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

@@ -3,10 +3,10 @@
   %head
     %title Apipony
     %link{ :href => '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css', :rel => 'stylesheet' }/
+    %link{ :href => 'https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.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
+    = yield

data/lib/apipony.rb

@@ -6,6 +6,7 @@ require 'apipony/section'
 require 'apipony/endpoint'
 require 'apipony/response'
 require 'apipony/request'
+require 'apipony/parameter'
 
 module Apipony
 end

data/lib/apipony/parameter.rb

@@ -0,0 +1,10 @@
+class Apipony::Parameter < Apipony::Base
+  attr_accessor :name, :type, :example, :required
+
+  def initialize(name, example, type, required)
+    @name = name
+    @example = example
+    @type = type
+    @required = required
+  end
+end

data/lib/apipony/request.rb

@@ -2,6 +2,12 @@ class Apipony::Request < Apipony::Base
   attr_accessor :params, :headers
 
   def initialize(&block)
+    @params = []
+
     instance_eval(&block)
   end
+
+  def param(name, example: '', type: :string, required: false)
+    @params << Apipony::Parameter.new(name, example, type, required)
+  end
 end

data/lib/apipony/version.rb

@@ -1,3 +1,3 @@
 module Apipony
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

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

@@ -9,9 +9,7 @@ Apipony::Documentation.define do
       e.description = 'Find ponies'
 
       request_with do
-        set :params, {
-          :name => :applejack
-        }
+        param :name, example: :applejack, required: true
       end
 
       response_with 200 do
@@ -28,12 +26,10 @@ Apipony::Documentation.define do
       e.description = 'Create pony'
 
       request_with do
-        set :params, {
-          :name => :fluttershy,
-          :kind => :pegasus,
-          :sex => :female,
-          :occupation => :caretaker
-        }
+        param :name, example: :fluttershy
+        param :kind, example: :pegasus
+        param :sex, example: :female
+        param :occupation, example: :caretaker
       end
 
       response_with 200
@@ -43,12 +39,10 @@ Apipony::Documentation.define do
       e.description = 'Update pony id'
 
       request_with do
-        set :params, {
-          :name => :fluttershy,
-          :kind => :pegasus,
-          :sex => :female,
-          :occupation => :singer
-        }
+        param :name
+        param :kind
+        param :sex
+        param :occupation
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipony
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sergey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,6 +184,7 @@ files:
 - lib/apipony/documentation.rb
 - lib/apipony/endpoint.rb
 - lib/apipony/engine.rb
+- lib/apipony/parameter.rb
 - lib/apipony/request.rb
 - lib/apipony/response.rb
 - lib/apipony/section.rb