apipony 0.0.9 → 1.0.0.rc1

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

@@ -1,42 +1,50 @@
 Apipony::Documentation.define do
-  config do |c|
-    c.title = 'API Documentation'
-    c.base_url = '/api/v1'
+  configure do
+    title 'API Documentation'
+    base_url '/api/v1'
   end
 
   section 'Ponies' do
-    endpoint 'get', '/ponies' do |e|
-      e.description = 'Find ponies'
+    endpoint :get, '/ponies' do
+      description 'List ponies.'
 
       request_with do
-        param :name, example: :applejack, required: true
+        headers do
+          {
+            'Accept': 'application/json'
+          }
+        end
+
+        param :name, required: true, description: 'Name of pony.',
+                                     example: :fluttershy
       end
 
-      response_with 200 do
-        set :body, {
-          :name => :applejack,
-          :kind => :earth,
-          :sex => :female,
-          :occupation => :farmer
-        }
+      response_with do
+        body do
+          [
+            {
+              name: 'Fluttershy',
+              kind: 'Pegasus'
+            }
+          ]
+        end
       end
     end
 
-    endpoint 'post', '/ponies' do |e|
-      e.description = 'Create pony'
+    endpoint :post, '/ponies' do
+      description 'Create new pony.'
 
       request_with do
-        param :name, example: :fluttershy
+        param :name, required: true, example: :fluttershy
         param :kind, example: :pegasus
-        param :sex, example: :female
-        param :occupation, example: :caretaker
+        param :sex, required: true, example: :female
+        param :occupation, example: :caretaker,
+                           description: 'What this pony do for living.'
       end
-
-      response_with 200
     end
 
-    endpoint 'put', '/ponies/:id' do |e|
-      e.description = 'Update pony id'
+    endpoint :put, '/ponies/:id' do
+      description 'Update pony by id.'
 
       request_with do
         param :name
@@ -46,32 +54,41 @@ Apipony::Documentation.define do
       end
     end
 
-    endpoint 'delete', '/ponies/:id' do |e|
-      e.description = 'Delete pony by id'
-
-      response_with 200
+    endpoint :delete, '/ponies/:id' do
+      description 'Delete pony by id.'
     end
   end
 
   section 'Places' do
-    endpoint 'get', '/places' do |e|
-      e.description = 'Get places'
+    endpoint :get, '/places' do
+      description 'List places.'
 
-      response_with 200 do
-        set :body, [
-          {
-            :id => 1,
-            :name => :equestria
-          },
-          {
-            :id => 2,
-            :name => :ponyville
-          },
+      response_with do
+        status 200
+
+        body do
+          [
+            {
+              name: 'Equestria'
+            },
+            {
+              name: 'Ponyville'
+            }
+          ]
+        end
+      end
+    end
+
+    endpoint :get, '/places/:id' do
+      response_with do
+        status 200
+
+        body do
           {
-            :id => 3,
-            :name => :canterlot
+            name: 'Crystal Empire',
+            population: 107706
           }
-        ]
+        end
       end
     end
   end

data/lib/generators/apipony/install_generator.rb

@@ -10,11 +10,17 @@ module Apipony
       end
 
       def mount_engine
-        insert_into_file "#{Rails.root}/config/routes.rb", :after => /routes.draw.do\n/ do
-          %Q{  mount Apipony::Engine => '/apipony'
-}
+        insert_into_file routes_path, after: /routes.draw.do\n/ do
+          %(  mount Apipony::Engine => '/apipony'
+)
         end
       end
+
+      private
+
+        def routes_path
+          "#{Rails.root}/config/routes.rb"
+        end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipony
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Sergey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
@@ -189,7 +203,6 @@ files:
 - app/assets/stylesheets/apipony/application.css
 - app/assets/stylesheets/apipony/styles.scss
 - app/controllers/apipony/application_controller.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
@@ -200,16 +213,15 @@ files:
 - 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/shared/description.rb
+- lib/apipony/shared/headers.rb
 - lib/apipony/version.rb
 - lib/generators/apipony/install/templates/initializer.rb
 - lib/generators/apipony/install_generator.rb
@@ -228,12 +240,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Easy Rails API documentation.

data/app/views/apipony/application/_attribute.html.erb

@@ -1,42 +0,0 @@
-<li class="attribute-container">
-  <div class="attribute">
-    <div class="attribute-name name">
-      <%= attribute.name %>
-    </div>
-
-    <div class="attribute-type type">
-      <% if attribute.is_subtype? %>
-        <%= link_to root_path(:anchor => "subtype-#{attribute.type}") do %>
-          <%= attribute.type %>
-        <% end %>
-      <% else %>
-        <%= attribute.type %>
-      <% end %>
-    </div>
-
-    <% if attribute.description %>
-      <div class="attribute-description"><%= attribute.description %></div>
-    <% end %>
-  </div>
-  
-  <% if attribute.is_enum? %>
-    <ul class="attribute-enum-list">
-      <div class="title">Possible values</div>
-      <% attribute.choices.each do |choice| %>
-        <li class="attribute-enum-member">
-          <div class="attribute-enum-member-name"><%= choice.name %></div>
-          <div class="attribute-enum-member-description"><%= choice.description %></div>
-        </li>
-      <% end %>
-    </ul>
-  <% end %>
-
-  <% if attribute.is_object? %>
-    <ul class="attribute-object-list">
-      <div class="title">Child attributes</div>
-      <%= render partial: "attribute",
-      collection: attribute.attributes,
-      as: :attribute %>
-    </ul>
-  <% end %>
-</li>

data/lib/apipony/base.rb

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

data/lib/apipony/example_response.rb

@@ -1,9 +0,0 @@
-##
-# Display an example response to help with understanding of the API.
-class Apipony::ExampleResponse < Apipony::Base
-  attr_accessor :headers, :body
-  def initialize(&block)
-    instance_eval(&block) if block_given?
-  end
-
-end

data/lib/apipony/response_attribute.rb

@@ -1,130 +0,0 @@
-##
-# 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