Merge pull request #1 from SqREL/change-json

Add swagger formating

Author: SqREL

.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: 8

.gitignore

@@ -10,13 +10,12 @@ GIT
 PATH
   remote: ../
   specs:
-    rspec_api_documentation (1.1.0)
+    rspec_api_documentation (2.0.0)
       activesupport (>= 3.0.0)
       i18n (>= 0.1.0)
       json (>= 1.4.6)
       mustache (>= 0.99.4)
       rspec (>= 2.14.0)
-      webmock (>= 1.7.0)
 
 GEM
   remote: http://rubygems.org/
@@ -49,7 +48,6 @@ GEM
       activesupport (= 3.1.3)
     activesupport (3.1.3)
       multi_json (~> 1.0)
-    addressable (2.3.5)
     arel (2.2.3)
     builder (3.0.4)
     coffee-rails (3.1.1)
@@ -59,8 +57,6 @@ GEM
       coffee-script-source
       execjs
     coffee-script-source (1.6.3)
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
     erubis (2.7.0)
     execjs (1.4.0)
@@ -86,7 +82,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.23)
     multi_json (1.7.9)
-    mustache (0.99.4)
+    mustache (0.99.5)
     polyglot (0.3.3)
     rack (1.3.10)
     rack-cache (1.2)
@@ -134,7 +130,6 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    safe_yaml (0.9.5)
     sass (3.2.10)
     sass-rails (3.1.7)
       actionpack (~> 3.1.0)
@@ -159,9 +154,6 @@ GEM
     uglifier (2.1.2)
       execjs (>= 0.3.0)
       multi_json (~> 1.0, >= 1.0.2)
-    webmock (1.13.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
 
 PLATFORMS
   ruby

.rspec

@@ -33,6 +33,7 @@ module Writers
     autoload :HtmlWriter
     autoload :TextileWriter
     autoload :JsonWriter
+    autoload :JsonSwaggerWriter
     autoload :AppendJsonWriter
     autoload :JsonIodocsWriter
     autoload :IndexHelper

.travis.yml

@@ -56,6 +56,8 @@ def self.add_setting(name, opts = {})
 
     add_setting :curl_headers_to_filter, :default => nil
     add_setting :curl_host, :default => nil
+    add_setting :base_api_path, :default => nil
+    add_setting :api_version, :default => nil
     add_setting :keep_source_order, :default => false
     add_setting :api_name, :default => "API Documentation"
     add_setting :io_docs_protocol, :default => "http"

Gemfile

@@ -9,6 +9,7 @@ def self.define_action(method)
           options[:method] = method
           options[:route] = args.first
           options[:api_doc_dsl] = :endpoint
+          options[:descriptionf] = "afdsfasdfsdf"
           args.push(options)
           args[0] = "#{method.to_s.upcase} #{args[0]}"
           context(*args, &block)
@@ -41,10 +42,39 @@ def parameter(name, description, options = {})
         parameters.push(options.merge(:name => name.to_s, :description => description))
       end
 
+      def modified_root_path(path)
+        metadata[:modified_root_path] = path
+        if superclass_metadata && metadata[:modified_root_path].equal?(superclass_metadata[:modified_root_path])
+          metadata[:modified_root_path] = Marshal.load(Marshal.dump(superclass_metadata[:modified_root_path]))
+        end
+        metadata[:modified_root_path]
+      end
+
       def header(name, value)
         headers[name] = value
       end
 
+      def descriptionf(text)
+        example.metadata[:descriptionf] = text
+      end
+
+      def example(title, params={}, &block)
+        metadata[:mute] = !!params[:mute]
+        if superclass_metadata && metadata[:mute].equal?(superclass_metadata[:mute])
+          metadata[:mute] = Marshal.load(Marshal.dump(superclass_metadata[:mute]))
+        end
+
+        super title, &block
+      end
+
+      def root_path(path)
+        metadata[:root_path] = path
+        if superclass_metadata && metadata[:root_path].equal?(superclass_metadata[:root_path])
+          metadata[:root_path] = Marshal.load(Marshal.dump(superclass_metadata[:root_path]))
+        end
+        metadata[:root_path]
+      end
+
       private
       def parameters
         metadata[:parameters] ||= []

Gemfile.lock

@@ -0,0 +1,141 @@
+require 'rspec_api_documentation/writers/formatter'
+
+module RspecApiDocumentation
+  module Writers
+    class JsonSwaggerWriter < Writer
+      delegate :docs_dir, :to => :configuration
+
+      def write
+        FileUtils.rm_rf docs_dir.join('v1')
+        FileUtils.mkdir_p(docs_dir.join('v1'))
+
+        File.open(docs_dir.join('v1', "index.json"), "w+") do |f|
+          f.write Formatter.to_json(JsonSwaggerIndex.new(index, configuration))
+        end
+        write_examples
+      end
+
+      def write_examples
+        json_examples = {}
+        a = []
+        index.examples.each do |example|
+          unless example.mute
+            a << example.route
+            json_example = JsonSwaggerExample.new(example, configuration)
+            dirname = example.route.split('/').reject(&:blank?)
+            FileUtils.mkdir_p(docs_dir.join(dirname[0..-2].join('/')))
+            #(json_examples[docs_dir.join(dirname.join('/') << '.json')] ||= []) << JsonSwaggerExample.new(example, configuration)
+            (json_examples[docs_dir.join('v1', (example.root_path.gsub(/^\//, "") << '.json'))] ||= []) << JsonSwaggerExample.new(example, configuration)
+          end
+        end
+
+        json_examples.each do |dirname, examples|
+          #directory = File.dirname(dirname)
+
+          File.open(docs_dir.join(dirname), "a+") do |f|
+            f.write Formatter.to_json(format_examples(examples))
+          end
+        end
+      end
+
+      def format_examples(json_examples)
+        json_examples_sorted = {}
+        json_examples.each do |example|
+          root_path = example.root_path
+          root_path = example.modified_root_path if example.try(:modified_root_path)
+          (json_examples_sorted[root_path] ||= []) << example
+        end
+
+        {
+          basePath: @configuration.base_api_path,
+          apiVersion: @configuration.api_version,
+          apis: json_examples_sorted.map { |path, examples| { path: path, operations: examples } }
+        }
+      end
+    end
+
+    class JsonSwaggerIndex
+      def initialize(index, configuration)
+        @index = index
+        @configuration = configuration
+      end
+
+      def sections
+        IndexHelper.sections(examples, @configuration)
+      end
+
+      def examples
+        @index.examples.map { |example| JsonSwaggerExample.new(example, @configuration) }
+      end
+
+      def as_json(opts = nil)
+        {
+          apiVersion: @configuration.api_version,
+          apis: section_hash
+        }
+      end
+
+      def section_hash
+        sections.map do |section|
+          {
+            path: section[:examples].first.metadata[:root_path],
+            description: section[:resource_name]
+          }
+        end
+      end
+    end
+
+    class JsonSwaggerExample
+      def initialize(example, configuration)
+        @example = example
+        @host = configuration.curl_host
+        @filter_headers = configuration.curl_headers_to_filter
+      end
+
+      def method_missing(method, *args, &block)
+        @example.send(method, *args, &block)
+      end
+
+      def respond_to?(method, include_private = false)
+        super || @example.respond_to?(method, include_private)
+      end
+
+      def dirname
+        resource_name.downcase.gsub(/\s+/, '_')
+      end
+
+      def filename
+        basename = description.downcase.gsub(/\s+/, '_').gsub(/[^a-z_]/, '')
+        "#{basename}.json"
+      end
+
+      def as_json(opts = nil)
+        {
+          method:     http_method,
+          type:       resource_name,
+          summary:    description,
+          nickname:   "#{http_method}#{resource_name}",
+          parameters: respond_to?(:parameters) ? formatted_parameters : [],
+          responseMessages: []
+        }
+      end
+
+      def requests
+        super.map do |hash|
+          if @host
+            if hash[:curl].is_a? RspecApiDocumentation::Curl
+              hash[:curl] = hash[:curl].output(@host, @filter_headers)
+            end
+          else
+            hash[:curl] = nil
+          end
+          hash
+        end
+      end
+
+      def formatted_parameters
+        parameters
+      end
+    end
+  end
+end

LICENSE.md

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe RspecApiDocumentation::Writers::JsonWriter do
+  let(:index) { RspecApiDocumentation::Index.new }
+  let(:configuration) { RspecApiDocumentation::Configuration.new }
+
+  describe ".write" do
+    let(:writer) { double(:writer) }
+
+    it "should build a new writer and write the docs" do
+      described_class.stub(:new).with(index, configuration).and_return(writer)
+      writer.should_receive(:write)
+      described_class.write(index, configuration)
+    end
+  end
+
+  describe "#write" do
+    let(:writer) { described_class.new(index, configuration) }
+
+    before do
+      FileUtils.mkdir_p(configuration.docs_dir)
+    end
+
+    it "should write the index" do
+      writer.write
+      index_file = File.join(configuration.docs_dir, "index.json")
+      File.exists?(index_file).should be_true
+    end
+  end
+end