calamum 1.2.0 → 1.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmFkMDE0YWU2M2NhZGYyNjk1MjZjYmFlZjlhNzI3ZTZhZGRkYjdmOQ==
+    NTNmOTAzNzRjNmU2NGE3ZDQxNjFmMGQyMmNkYWI1NDBkNWQ4NDE1Mg==
   data.tar.gz: !binary |-
-    ZjlhZmIwY2UzZTdjMTA0MmZiYmNkMDFjNTk1MzM4MTAxODgzNjc4Ng==
+    ZGM2NmUzY2NhYmZlNmExNmM5ZDFmZmUyYzY1ZDJiYjhjNTM3YjI4Yw==
 SHA512:
   metadata.gz: !binary |-
-    ZTk4ZTY2NjVhODBkZjc5NTlkYTEyOWM2Zjk4N2NjZjg1ZmVhZDZjMmYxNjUz
-    ZDhjMzA1NTZiYzM1NTkyMGM2MTc1ODgxMWYzNGUwYWMzNThkN2NmY2FiNmY2
-    YTgwZDcwNjU5ZTdlYmIxNDJhY2FhNjg2OTBiOTlmNzRjZTEzMjY=
+    MmNhZTk2Mzc1MDdmNDNkOGZkNTUxMWRjMTY0YTlhYjcwMGU4YmYzMjhkMzM4
+    ZjY4YTkyOGZkNDJjYzBhMGI4OWRiOTAzNDM4OTNjMzI5NWYwMjc4MjczNTRk
+    NGY2ZDJjZTY3NTE2ODI0ZjU5NmYxOTY3YzQ4NjI1YjdjY2MzNDk=
   data.tar.gz: !binary |-
-    MjVmYjA3MDdiZjFiMjkxZWJiMTlkMmUxNTdiZGY4NGU1NTAxMTk2OWYyNTYy
-    ZGY5ZTEyYzZmYmZlNjgzNDM5N2ZhNzBiY2FhYjgzOWI5M2I5ZDEzM2FhOWZk
-    Zjk5YTczODVkMWZiODJkM2U1MGE3YmY1MzA3ODE3YzQ0NmQwN2U=
+    OWI3MGQ5YWQ0ZDc1ZjljZThlY2Q5M2RlZmJmNmU1ZDUzNzJmZjllODk3Njc3
+    MWNhZjY5OWU5ZGQ0YmY3NGUyNWUxMWFjN2U1ZjA4YzZmMjhhMGUyZjFmZDM3
+    NGRkNjFhNWU0YmMxYzcyNDZmNWYyYWZlYjE2YjhjZDEzZWQ0Yzk=

data/bin/calamum

@@ -2,7 +2,7 @@
 #
 # Calamum is a simple REST API documentation generator.
 # This is a fork, that allows you to work with JSON format.
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'
 require 'calamum/runner'

data/lib/calamum/config.rb

@@ -1,4 +1,3 @@
-# require 'calamum'
 require 'mixlib/config'
 
 # Provides a class-based configuration object.
@@ -14,8 +13,11 @@ class Calamum::Config
     merge!(config)
 
     self.doc_path = File.join(config[:path], 'docs')
-    self.tpl_path = File.join(File.dirname(__FILE__), 'templates', config[:template])
-    raise "Unknown template #{config[:template]}" unless Calamum::VALID_TEMPLATES.include?(config[:template])
+    self.tpl_path = File.join(File.dirname(__FILE__),
+                              'templates',
+                              config[:template])
+    unless Calamum::VALID_TEMPLATES.include?(config[:template])
+      fail "Unknown template #{config[:template]}"
+    end
   end
-
 end

data/lib/calamum/doc_parser.rb

@@ -18,10 +18,18 @@ class Calamum::DocParser
     @definition['version']
   end
 
+  def get_authentication
+    @definition['authentication']
+  end
+
   def get_description
     @definition['description']
   end
 
+  def get_errors
+    @definition['errors']
+  end
+
   def get_resources
     resources = @definition['resources'].kind_of?(String) ? get_seperate_resources : @definition['resources']
     Calamum::Config[:sort]? resources.sort : resources

data/lib/calamum/runner.rb

@@ -66,7 +66,13 @@ class Calamum::Runner
     @definition.load_resources
     Calamum::DocGenerator.init_base_dir
     process_index
-    process_pages if config[:template] == 'twitter'
+
+    if config[:template] == 'twitter'
+      process_pages
+      process_section("overview",  @definition.get_description)
+      process_section("authentication", @definition.get_authentication)
+      process_errors
+    end
   rescue => ex
     puts_error ex.message
   end
@@ -97,6 +103,28 @@ class Calamum::Runner
     page.save_template('index.html', bindings)
   end
 
+  # Bind values to overview and authentication pages and save them.
+  def process_section(section, content)
+    bindings = {
+      :section => section,
+      :name => @definition.get_name,
+      :version => @definition.get_version,
+      :description => content,
+    }
+    page = Calamum::DocGenerator.new(:section)
+    page.save_template("#{section}.html", bindings)
+  end
+
+  def process_errors
+    bindings = {
+      :name => @definition.get_name,
+      :version => @definition.get_version,
+      :errors => @definition.get_errors,
+    }
+    page = Calamum::DocGenerator.new(:errors)
+    page.save_template("errors.html", bindings)
+  end
+
   # Bind values to view pages and save them.
   def process_pages
     bindings = {

data/lib/calamum/templates/twitter/errors.html.erb

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Developers API</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <link type="text/css" rel="stylesheet" href="assets/css/main.css" />
+  </head>
+  <body class="no-sidebars">
+    <div id="page">
+      <div id="header-outer">
+        <div id="header">
+          <a href="/" id="logo" title="Home"><%= @name %></a>
+
+          <ul id="title-nav">
+            <li><a href="overview.html">Overview</a></li>
+            <li><a href="authentication.html">Authentication</a></li>
+            <li><a href="index.html">Resources</a></li>
+            <li><a href="errors.html">Errors</a></li>
+          </ul>
+        </div>
+      </div>
+
+      <div id="content-outer">
+        <h1>Error Codes</h1>
+	<% unless @errors.nil? %>
+         <div class="content api-docs">
+          <% unless @errors['http_errors'].empty? %>
+            <table>
+              <caption>
+                <strong> HTTP Status Codes</strong>
+	        <p>The API attempts to return appropriate
+	          <a rel="nofollow" href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes" class="ext" target="_blank">
+	             HTTP status codes
+	          </a>for every request.<p>
+              </caption>
+              <thead>
+                <tr>
+                  <th class="views-field-title">Code</th>
+		  <th class="views-field-title">Text</th>
+		  <th class="views-field-title">Description</th>
+                </tr>
+              </thead>
+              <tbody>
+                <% @errors['http_errors'].each do |error| %>
+                  <tr>
+                    <td class="">
+                      <%= error['code'] %>
+                    </td>
+                    <td class="views-field">
+                      <%= error['text'] %>
+                    </td>
+		    <td class="views-field">
+                      <%= error['description'] %>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% end %>
+	  <% unless @errors['api_errors'].empty? %>
+            <table>
+              <caption>
+                <strong> API Status Codes</strong>
+	        <p> Description of the Api specific errors codes.
+              </caption>
+              <thead>
+                <tr>
+                  <th class="views-field-title">Code</th>
+		  <th class="views-field-title">Text</th>
+		  <th class="views-field-title">Description</th>
+                </tr>
+              </thead>
+              <tbody>
+                <% @errors['api_errors'].each do |error| %>
+                  <tr>
+                    <td class="">
+                      <%= error['code'] %>
+                    </td>
+                    <td class="views-field">
+                      <%= error['text'] %>
+                    </td>
+		    <td class="views-field">
+                      <%= error['description'] %>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% end %>
+        </div>
+	<% end %>
+      </div>
+
+      <div id="footer-outer">
+        <div id="footer"><%= @name %> &copy; 2013</div>
+      </div>
+
+    </div>
+  </body>
+</html>

data/lib/calamum/templates/twitter/index.html.erb

@@ -7,7 +7,6 @@
   </head>
   <body class="no-sidebars">
     <div id="page">
-
       <div id="header-outer">
         <div id="header">
           <a href="/" id="logo" title="Home"><%= @name %></a>
@@ -15,7 +14,6 @@
           <ul id="title-nav">
             <li><a href="overview.html">Overview</a></li>
             <li><a href="authentication.html">Authentication</a></li>
-            <li><a href="entities.html">Entities</a></li>
             <li><a href="index.html">Resources</a></li>
             <li><a href="errors.html">Errors</a></li>
           </ul>

data/lib/calamum/templates/twitter/section.html.erb

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Developers API</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <link type="text/css" rel="stylesheet" href="assets/css/main.css" />
+  </head>
+  <body class="no-sidebars">
+    <div id="page">
+
+      <div id="header-outer">
+        <div id="header">
+          <a href="/" id="logo" title="Home"><%= @name %></a>
+
+          <ul id="title-nav">
+            <li><a href="overview.html">Overview</a></li>
+            <li><a href="authentication.html">Authentication</a></li>
+            <li><a href="index.html">Resources</a></li>
+            <li><a href="errors.html">Errors</a></li>
+          </ul>
+        </div>
+      </div>
+
+      <div id="content-outer">
+        <h1><%= @section.capitalize %></h1>
+        <div class="content api-docs">
+          <%= @description %>
+        </div>
+      </div>
+
+      <div id="footer-outer">
+        <div id="footer"><%= @name %> &copy; 2013</div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/calamum/templates/twitter/view.html.erb

@@ -15,7 +15,6 @@
           <ul id="title-nav">
             <li><a href="overview.html">Overview</a></li>
             <li><a href="authentication.html">Authentication</a></li>
-            <li><a href="entities.html">Entities</a></li>
             <li><a href="index.html">Resources</a></li>
             <li><a href="errors.html">Errors</a></li>
           </ul>

data/lib/calamum/version.rb

@@ -1,3 +1,3 @@
 module Calamum
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calamum
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Alex Y.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -67,6 +67,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +95,48 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 description: 
 email:
 - lachheb.mehrez@gmail.com
@@ -112,7 +168,9 @@ files:
 - lib/calamum/templates/twitter/assets/css/main.css
 - lib/calamum/templates/twitter/assets/javascripts/bootstrap.js
 - lib/calamum/templates/twitter/assets/javascripts/jquery-1.7.2.min.js
+- lib/calamum/templates/twitter/errors.html.erb
 - lib/calamum/templates/twitter/index.html.erb
+- lib/calamum/templates/twitter/section.html.erb
 - lib/calamum/templates/twitter/view.html.erb
 - lib/calamum/version.rb
 homepage: https://github.com/malachheb/calamum
@@ -140,3 +198,4 @@ signing_key:
 specification_version: 4
 summary: REST API documentation generator
 test_files: []
+has_rdoc: