apipony 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fca19d37a6ccc6f5a2e474eb27657e312ad130f3
-  data.tar.gz: 975aae5c882566e15cbc868d81ef8b78e76041ff
+  metadata.gz: 7456f0b6bcd79edd941bfba6e1db27e3c0b94f00
+  data.tar.gz: 08f3bb7e4dfdb5a590a78f8ed2be46b5a475e873
 SHA512:
-  metadata.gz: 81ed5a84d5f47fb2d648f597fe2d268e5411f44b05d4e2dbeddbf63adca9393ee6b311ed8ec299c336a1fa1d498a1a8f2a494d46760a16d7940e0edb06935129
-  data.tar.gz: cc163b4c0eb474e7c610e4e6adcaba9c44d518771e25aaac66a4c38d11697e676f9866741a58bf0b5eed8ba423394baf6309ab0150f32ba84bcc9088151e6265
+  metadata.gz: d8a9c0b84b6da18245b2dc3187a63ee8ad30de426d45a4fd47f2ee7e384405dd1e4a2665358f0df09b214804157afaa09d0a5c6c2c2410120782c281bfdb79ff
+  data.tar.gz: 4d7d48df1304b3e316adc35e410ae44f040195127e9dfcd4dca971c6c2dcd806d737ee0ceb31a68c1fd3173b1884333da21b02989c97a252f8390ce8fc45c2c1

data/README.md

@@ -25,7 +25,7 @@ Apipony::Documentation.define do
   end
 
   section 'Ponies' do
-    endpoint 'get', '/ponies' do |e|
+    endpoint :get, '/ponies' do |e|
       e.description = 'Find ponies'
 
       request_with do
@@ -33,12 +33,10 @@ Apipony::Documentation.define do
       end
 
       response_with 200 do
-        set :body, {
-          :name => :applejack,
-          :kind => :earth,
-          :sex => :female,
-          :occupation => :farmer
-        }
+        attribute :name, type: :string, example: 'applejack'
+        attribute :kind, type: :string, example: 'earth'
+        attribute :sex, type: :string, example: 'female'
+        attribute :occupation, type: :string, example: 'farmer'
       end
     end
   end
@@ -50,8 +48,8 @@ end
 
 ### Response Attribute Documentation
 Apipony lets you provide further documentation about the attributes in your
-API's responses. Simply create a new `attribute` inside a `respond_with` block.
-These attributes can even have nested sub-attributes, for documentation of 
+API's responses. Simply create a new `attribute` inside a `response_with` block.
+These attributes can even have nested sub-attributes, for documentation of
 more complex object graphs.
 
 ```ruby
@@ -59,8 +57,8 @@ Apipony::Documentation.define do
   section "Species" do
     endpoint 'get', '/species/:id' do |e|
       e.description = "Get information about a species"
-      respond_with 200 do 
-        example do 
+      response_with 200 do
+        example do
           set :body, {
             name: "Unicorn",
             is_pony: true,
@@ -92,7 +90,7 @@ Apipony::Documentation.define do
   section "Ponies" do
     endpoint "get", "/ponies/:id" do |e|
       e.description = "Information about a pony"
-      example do 
+      example do
         set :body, {
           name: "Applejack",
           sex: "female",
@@ -115,14 +113,14 @@ end
 
 ### Example Generation
 When describing attributes, you can provide an optional `example:` parameter.
-If included, this will be used to generate the example response in the 
-documentation. 
+If included, this will be used to generate the example response in the
+documentation.
 
 ```ruby
 Apipony::Documentation.define do
   section "Ponies" do
     endpoint "get", "/ponies/:id" do |e|
-      respond_with 200 do
+      response_with 200 do
         attribute :name, type: :string, example: "Applejack"
         # Enum members automatically select the first choice
         attribute :kind, type: :enum do
@@ -136,7 +134,7 @@ Apipony::Documentation.define do
 
     endpoint "get", "/ponies/" do |e|
       # Automatic serialization of arrays is supported
-      respond_with 200, array: true do
+      response_with 200, array: true do
         attribute :name, type: :string, example: "Applejack"
         attribute :id, type: :integer, example: 10
       end
@@ -171,7 +169,7 @@ format. Apipony lets you define this common format once, then use it multiple
 times. Check it out:
 
 ```ruby
-Apipony::Documentation.define do 
+Apipony::Documentation.define do
   subtype :pony_stub do
     attribute :name, type: :string
     attribute :id, type: :integer

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

@@ -102,12 +102,19 @@ ul {
 }
 
 .sidebar {
-  flex: 1 120px;
+  flex: 1 80px;
+  margin-right: 40px;
 
   @media all and (max-width: $mobile-width) {
     flex: 1 100%;
     margin-bottom: 30px;
   }
+
+  h5 {
+    text-overflow: ellipsis;
+    white-space: nowrap;
+    overflow: auto;
+  }
 }
 
 .main-col {
@@ -233,7 +240,7 @@ footer {
   &.put {
     background-color: $put-color;
   }
-  
+
   &.delete {
     background-color: $delete-color;
   }
@@ -254,7 +261,7 @@ footer {
 
   .required {
     text-align: center;
-  
+
     .fa {
       color: $medium_color;
     }
@@ -263,7 +270,7 @@ footer {
 
 .table {
   padding: 8px 0;
-  
+
   tr {
     td {
       padding: 4px 10px;
@@ -274,13 +281,13 @@ footer {
 .attribute-container {
   display: flex;
   flex-flow: column nowrap;
-  
+
   .attribute {
     display: flex;
     flex-flow: row nowrap;
     align-items: inherit;
     justify-content: flex-start;
-    
+
     > div {
       padding: 4px 10px;
     }

data/lib/apipony/endpoint.rb

@@ -38,7 +38,7 @@ class Apipony::Endpoint < Apipony::Base
   ##
   # Create a unique identifier for this endpoint
   def id
-    File.join(@method, @url)
+    File.join(@method.to_s, @url)
   end
 
   private

data/lib/apipony/version.rb

@@ -1,5 +1,5 @@
 module Apipony
   ##
   #:nodoc:
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipony
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Sergey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails