calamum 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmFkMDE0YWU2M2NhZGYyNjk1MjZjYmFlZjlhNzI3ZTZhZGRkYjdmOQ==
+  data.tar.gz: !binary |-
+    ZjlhZmIwY2UzZTdjMTA0MmZiYmNkMDFjNTk1MzM4MTAxODgzNjc4Ng==
+SHA512:
+  metadata.gz: !binary |-
+    ZTk4ZTY2NjVhODBkZjc5NTlkYTEyOWM2Zjk4N2NjZjg1ZmVhZDZjMmYxNjUz
+    ZDhjMzA1NTZiYzM1NTkyMGM2MTc1ODgxMWYzNGUwYWMzNThkN2NmY2FiNmY2
+    YTgwZDcwNjU5ZTdlYmIxNDJhY2FhNjg2OTBiOTlmNzRjZTEzMjY=
+  data.tar.gz: !binary |-
+    MjVmYjA3MDdiZjFiMjkxZWJiMTlkMmUxNTdiZGY4NGU1NTAxMTk2OWYyNTYy
+    ZGY5ZTEyYzZmYmZlNjgzNDM5N2ZhNzBiY2FhYjgzOWI5M2I5ZDEzM2FhOWZk
+    Zjk5YTczODVkMWZiODJkM2U1MGE3YmY1MzA3ODE3YzQ0NmQwN2U=

data/lib/calamum.rb

@@ -2,7 +2,6 @@ require 'erb'
 require 'yajl'
 require 'yaml'
 require 'fileutils'
-require 'pry'
 
 module Calamum
   require 'calamum/config'

data/lib/calamum/config.rb

@@ -1,4 +1,4 @@
-require 'calamum'
+# require 'calamum'
 require 'mixlib/config'
 
 # Provides a class-based configuration object.

data/lib/calamum/doc_parser.rb

@@ -13,17 +13,28 @@ class Calamum::DocParser
   def get_name
     @definition['name']
   end
-  
+
   def get_version
     @definition['version']
   end
-  
+
   def get_description
     @definition['description']
   end
 
   def get_resources
-    Calamum::Config[:sort]? @definition['resources'].sort : @definition['resources']
+    resources = @definition['resources'].kind_of?(String) ? get_seperate_resources : @definition['resources']
+    Calamum::Config[:sort]? resources.sort : resources
+  end
+
+  def get_seperate_resources
+    extension = File.extname(Calamum::Config[:source])
+    path = File.expand_path("#{@definition['resources']}", File.dirname(Calamum::Config[:source]))
+    case extension
+    when '.json' then Dir["#{path}/*#{extension}"].map { |f| Yajl.load File.read(f) }.flatten.reduce({}, :merge)
+    when '.yml' then Dir["#{path}/*#{extension}"].map { |f| YAML.load File.read(f) }.flatten.reduce({}, :merge)
+    else raise 'unknown source file extension'
+    end
   end
 
   def load_resources

data/lib/calamum/resource.rb

@@ -3,7 +3,7 @@
 # So anywhere in view template we can use this object.
 class Calamum::Resource
   attr_accessor :uri, :action, :headers,
-    :auth, :params, :errors, :description, :response
+    :auth, :params, :errors, :description, :response, :tryit
 
   # Initialize object from attributes.
   #
@@ -12,13 +12,22 @@ class Calamum::Resource
     @uri = attrs['uri']
     @action = attrs['action'].upcase
     @headers = attrs['headers'] || {}
-    @auth = !!attrs['authentication']
+    @auth = !attrs['authentication']
     @params = attrs['params'] || {}
     @errors = attrs['errors'] || {}
     @description = attrs['description']
     @response = attrs['response']
+    @tryit = attrs['tryit']
   end
-  
+
+  # Returns a unique, but readable name for this resource suitable for use as a filename
+  #
+  # @return [String] resource filename
+  def slug
+    sanitized_uri = uri.gsub(/[^\w]/, '_').gsub('__', '_')
+    "#{sanitized_uri}_#{action.downcase}_#{self.object_id}"
+  end
+
   # @override
   # Returns a string representing a label css class.
   #

data/lib/calamum/runner.rb

@@ -49,14 +49,14 @@ class Calamum::Runner
     :description  => 'Show version number',
     :proc         => lambda { |x| puts Calamum::VERSION },
     :exit         => 0
-    
+
   option :sort,
     :short        => "-s",
     :long         => "--sort",
     :description  => "Sort the resources alphabetically",
     :boolean      => true,
     :default      => false
-    
+
   # Parses command line options and generates API documentation.
   # See samples for details how to define meta-data for your API.
   def run
@@ -65,7 +65,7 @@ class Calamum::Runner
     @definition = Calamum::DocParser.new(load_source)
     @definition.load_resources
     Calamum::DocGenerator.init_base_dir
-    process_index 
+    process_index
     process_pages if config[:template] == 'twitter'
   rescue => ex
     puts_error ex.message
@@ -82,7 +82,7 @@ class Calamum::Runner
       raise 'unknown source file extension'
     end
   end
-  
+
   # Bind values to index page and save it.
   def process_index
     bindings = {
@@ -108,7 +108,7 @@ class Calamum::Runner
     @definition.resources.each do |methods|
       methods[1].each do |resource|
         bindings.merge!(:resource => resource)
-        filename = "#{resource.object_id}.html"
+        filename = "#{resource.slug}.html"
         page.save_template(filename, bindings)
       end
     end

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

@@ -2,6 +2,7 @@
 <html lang="en">
 <head>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="">
 <meta name="author" content="">
 <link href="./assets/stylesheets/bootstrap.css" rel="Stylesheet"/>
@@ -58,22 +59,22 @@
     <% requests.each do |req| %>
     <div class="accordion-group">
       <div class="accordion-heading <%= req.action.downcase %>Header">
-	<a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#<%= req.object_id %>">
+	<a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#<%= req.slug %>">
           <span><span class="label <%= req.action_label %>"><%= req.action %></span><h4 style="display:inline;"><%= "  #{req.uri}" %></h4></span>
         </a>
       </div>
-      <div id="<%= req.object_id %>" class="accordion-body collapse">
+      <div id="<%= req.slug %>" class="accordion-body collapse">
       <div class="accordion-inner">
 	<ul class="nav nav-tabs">
-	  <li class="active"><a href="#description_<%= req.object_id %>"  data-toggle="tab">Description</a></li>
-	  <li><a href="#header_<%= req.object_id %>" data-toggle="tab">Header</a></li>
-	  <li><a href="#params_<%= req.object_id %>" data-toggle="tab">Parameters</a></li>
-	  <li><a href="#response_<%= req.object_id %>" data-toggle="tab">Response</a></li>
+	  <li class="active"><a href="#description_<%= req.slug %>"  data-toggle="tab">Description</a></li>
+	  <li><a href="#header_<%= req.slug %>" data-toggle="tab">Header</a></li>
+	  <li><a href="#params_<%= req.slug %>" data-toggle="tab">Parameters</a></li>
+	  <li><a href="#response_<%= req.slug %>" data-toggle="tab">Response</a></li>
 	</ul>
         <div class="tab-content">
-	 <div class="tab-pane active" id="description_<%= req.object_id %>"><%= req.description %></div>
-	 <div class="tab-pane" id="header_<%= req.object_id %>">
-	   <% unless req.params.empty? %>
+	 <div class="tab-pane active" id="description_<%= req.slug %>"><%= req.description %></div>
+	 <div class="tab-pane" id="header_<%= req.slug %>">
+	   <% unless req.headers.empty? %>
 	   <table class="table table-bordered table-hover">
 	     <thead>
 	       <tr>
@@ -94,7 +95,7 @@
 	      Request without headers
 	   <% end %>
 	 </div>
-	 <div class="tab-pane" id="params_<%= req.object_id %>">
+	 <div class="tab-pane" id="params_<%= req.slug %>">
 	   <% unless req.params.empty? %>
 	   <table class="table table-bordered table-hover">
 	     <thead>
@@ -117,10 +118,10 @@
 	     </tbody>
 	   </table>
 	   <% else %>
-	      Request without parametres
+	      Request without parameters
 	   <% end %>
 	 </div>
-	   <div class="tab-pane content" id="response_<%= req.object_id %>">
+	   <div class="tab-pane content" id="response_<%= req.slug %>">
 		<% if req.response %>
 	  	 <pre class="prettyprint"><%= pj req.response %></pre>
 		 <% end%>

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

@@ -41,7 +41,7 @@
                 <% endpoints.each do |resource| %>
                   <tr>
                     <td class="views-field-title">
-                      <a href="<%= resource.object_id %>.html"><%= resource.action %> <%= resource.uri %></a>
+                      <a href="<%= resource.slug %>.html"><%= resource.action %> <%= resource.uri %></a>
                     </td>
                     <td class="views-field-body">
                       <%= resource.description %>

data/lib/calamum/version.rb

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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calamum
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Y.
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,18 +49,48 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-its
+  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'
 description: 
-email: 
+email:
+- lachheb.mehrez@gmail.com
 executables:
 - calamum
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/calamum
+- lib/calamum.rb
 - lib/calamum/config.rb
 - lib/calamum/doc_generator.rb
 - lib/calamum/doc_parser.rb
@@ -91,30 +115,28 @@ files:
 - lib/calamum/templates/twitter/index.html.erb
 - lib/calamum/templates/twitter/view.html.erb
 - lib/calamum/version.rb
-- lib/calamum.rb
-- bin/calamum
 homepage: https://github.com/malachheb/calamum
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: REST API documentation generator
 test_files: []