apipony 0.0.4 → 0.0.7

data/lib/apipony/response_attribute.rb

@@ -0,0 +1,130 @@
+##
+# A class used to describe an attribute in a response.
+class Apipony::ResponseAttribute
+  @type_definitions = {}
+  ##
+  # Allow a common subobject definition for code reuse.
+  # Probably use the `subtype` method in the `subtype` method of the DSL
+  # `define` DSL instead. 
+  def self.define_type(name, type)
+    @type_definitions[name] = type
+  end
+
+  ##
+  # Get a list of predefined subtypes.
+  # Probably use the `
+  def self.defined_subtypes
+    @type_definitions
+  end
+  ##
+  # Get a subtype with the given name.
+  def self.get_defined(name)
+    @type_definitions[name]
+  end
+
+  attr_accessor :name, :type, :description, :attributes, :choices
+  def initialize(name, 
+                 type: :string, 
+                 description: "", 
+                 array: false,
+                 example: nil,
+                 &block)
+    @name = name
+    @description = description
+    @type = type
+    @array = array
+    @example = example
+    if block_given? 
+      instance_eval(&block)
+    ## This attribute is of a predefined subtype
+    elsif (subtype = self.class.get_defined(@type))
+      @attributes = subtype.attributes
+      # If the subtype is an array, this is also an array
+      @array = subtype.is_array? unless @array
+      @is_subtype = true
+    end
+  end
+
+  ## 
+  # Build an example from this object
+  def example
+    sub = nil
+    if is_object? || is_subtype?
+      sub = Hash[@attributes.select(&:example).map{|a| [a.name, a.example]}]
+    elsif is_enum?
+      sub = choices.first.name
+    else
+      sub = @example
+    end
+    ## 
+    # If we have an example an are an array
+    if sub and is_array?
+      [sub]
+    else
+      sub
+    end
+  end
+  ##
+  # Is this attribute an array?
+  # Note that marking an attribute as an array does not over-ride the top-level
+  # type. For example, a definition like:
+  #     attribute :aliases, type: :string, array: true
+  # denotates an array of strings. Also note that subattributes are not
+  # over-ridden. This lets you make an array of objects.
+  #     attribute :users, type: :object, array: true do
+  #       attribute :id, type: :integer
+  #       attribute :name, type: :integer
+  #     end
+  #
+  def is_array?
+    !! @array
+  end
+
+  ##
+  # See if this attribute is a reference to a predefined subtype.
+  def is_subtype?
+    !! @is_subtype
+  end
+
+  def use_defined(type)
+    a = self.class.get_defined(name)
+    raise "Tried to use an undefined subtype" unless a
+    ##
+    # Shallow clone so we can alias the name
+    a = a.clone
+    a.name = as
+    add_subattribute a
+  end
+
+  def attribute(name, **params, &block)
+    add_subattribute self.class.new(name, **params, &block)
+  end
+
+  def is_object?
+    @type == :object
+  end
+
+  def is_enum?
+    @type == :enum
+  end
+
+  def choice(name, **params)
+    @choices ||= []
+    @type = :enum
+    @choices << EnumChoice.new(name, **params)
+  end
+
+  class EnumChoice
+    attr_accessor :name, :description
+    def initialize(name, description: "")
+      @name = name
+      @description = description
+    end
+  end
+  private
+  def add_subattribute atr
+    @attributes ||= []
+    @type = :object
+    @attributes << atr
+  end
+end

data/lib/apipony/section.rb

@@ -1,6 +1,15 @@
+##
+# A section is a way to logically separate your endpoints. All endpoints in
+# a section should be related in some way. 
 class Apipony::Section
-  attr_accessor :title, :endpoints
-
+  ##
+  # What to call this endpoint. This will show up on the generated page.
+  attr_accessor :title
+  ##
+  # :nodoc: 
+  # This contains an array of endpoints added with the `endpoint` method of the
+  # DSL
+  attr_accessor :endpoints
   def initialize(title, &block)
     @title = title
     @endpoints = []

data/lib/apipony/version.rb

@@ -1,3 +1,5 @@
 module Apipony
-  VERSION = '0.0.4'
+  ##
+  #:nodoc:
+  VERSION = '0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipony
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Sergey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !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
@@ -80,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: faker
   requirement: !ruby/object:Gem::Requirement
@@ -175,18 +189,26 @@ files:
 - 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/initializers/haml.rb
+- app/views/apipony/application/_attribute.html.erb
+- app/views/apipony/application/_footer.html.erb
+- app/views/apipony/application/_header.html.erb
+- app/views/apipony/application/_method.html.erb
+- app/views/apipony/application/_request.html.erb
+- app/views/apipony/application/_response.html.erb
+- app/views/apipony/application/_sidebar.html.erb
+- app/views/apipony/application/index.html.erb
+- app/views/layouts/apipony/application.html.erb
 - config/routes.rb
 - lib/apipony.rb
 - lib/apipony/base.rb
 - lib/apipony/documentation.rb
 - lib/apipony/endpoint.rb
 - lib/apipony/engine.rb
+- lib/apipony/example_response.rb
 - lib/apipony/parameter.rb
 - lib/apipony/request.rb
 - lib/apipony/response.rb
+- lib/apipony/response_attribute.rb
 - lib/apipony/section.rb
 - lib/apipony/version.rb
 - lib/generators/apipony/install/templates/initializer.rb
@@ -216,3 +238,4 @@ signing_key:
 specification_version: 4
 summary: Easy Rails API documentation.
 test_files: []
+has_rdoc: 

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

@@ -1,74 +0,0 @@
-%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

@@ -1,12 +0,0 @@
-!!!
-%html
-  %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
-    = yield

data/config/initializers/haml.rb

@@ -1 +0,0 @@
-require 'haml-rails'