rspec_api_documentation 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fdee8e89c27e8a561132407268a857e5b19aa8f
-  data.tar.gz: d56e732d91259b9ebb6dc61beacc44625257a1a9
+  metadata.gz: 33e8850c767dbaf09a5469f45db448b6119a1d9d
+  data.tar.gz: 7b83d526470ad8734fa2bdaa8c22d48792da4dd7
 SHA512:
-  metadata.gz: b60c664a190f76360dddd09be2c8645c98ad692374f28b2f6417afaa5548565d0ddcd346a45a1e9057f8750aa98db5f5957bca7a3ad7823c1e0cea009bf1ae33
-  data.tar.gz: 9f66c3c77dfe4e33999858f7d22a1a34438c33f8bee65838775f6b4c05163e299174e75be56281121ed0443b03125e0ef590cba95383318f00f6018c033b0e65
+  metadata.gz: c75314c9d799bc9296b7b3217e08261cf0df0b6bb4ba3ece99faaf36f2b08fa31a4ffba57a4b745bf877aa919937ecbbe2237ccd66bd62e0ad62d27da34c04a8
+  data.tar.gz: 50ef1cca010fb51adaaf3d8776e17d6fb5ed6b89baa65d377b5eb4153d59c0ea4396e482f206f6592d8044df50258ade305466e324f03789627dc7c7396cafcb

data/lib/rspec_api_documentation/assets/stylesheets/rspec_api_documentation/styles.css

@@ -0,0 +1,102 @@
+
+body {
+  font-family: Helvetica,Arial,sans-serif;
+  font-size: 13px;
+  font-weight: normal;
+  line-height: 18px;
+  color: #404040;
+}
+
+.container {
+  width: 940px;
+  margin-left: auto;
+  margin-right: auto;
+  zoom: 1;
+}
+
+pre {
+  background-color: #f5f5f5;
+  display: block;
+  padding: 8.5px;
+  margin: 0 0 18px;
+  line-height: 18px;
+  font-size: 12px;
+  border: 1px solid #ccc;
+  border: 1px solid rgba(0, 0, 0, 0.15);
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  white-space: pre;
+  white-space: pre-wrap;
+  word-wrap: break-word;
+}
+
+td.required .name:after {
+  float: right;
+  content: "required";
+  font-weight: normal;
+  color: #F08080;
+}
+
+a{
+  color: #0069d6;
+  text-decoration: none;
+  line-height: inherit;
+  font-weight: inherit;
+}
+
+p {
+  padding: 15px;
+  font-size: 130%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-weight: bold;
+  color: #404040;
+}
+
+h1 {
+  margin-bottom: 18px;
+  font-size: 30px;
+  line-height: 36px;
+}
+h2 {
+  font-size: 24px;
+  line-height: 36px;
+}
+h3{
+  font-size: 18px;
+  line-height: 36px;
+}
+h4 {
+  font-size: 16px;
+  line-height: 36px;
+}
+
+table{
+  width: 100%;
+  margin-bottom: 18px;
+  padding: 0;
+  border-collapse: separate;
+  font-size: 13px;
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+  border-spacing: 0;
+  border: 1px solid #ddd;
+}
+
+table th {
+  padding-top: 9px;
+  font-weight: bold;
+  vertical-align: middle;
+  border-bottom: 1px solid #ddd;
+}
+table th+th, table td+td {
+  border-left: 1px solid #ddd;
+}
+table th, table td {
+  padding: 10px 10px 9px;
+  line-height: 18px;
+  text-align: left;
+}

data/lib/rspec_api_documentation/configuration.rb

@@ -78,6 +78,7 @@ module RspecApiDocumentation
     add_setting :io_docs_protocol, :default => "http"
     add_setting :request_headers_to_include, :default => nil
     add_setting :response_headers_to_include, :default => nil
+    add_setting :html_embedded_css_file, :default => nil
 
     # Change how the post body is formatted by default, you can still override by `raw_post`
     # Can be :json, :xml, or a proc that will be passed the params

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -38,19 +38,21 @@ module RspecApiDocumentation::DSL
       if method == :get && !query_string.blank?
         path_or_query += "?#{query_string}"
       else
-        formatter = RspecApiDocumentation.configuration.post_body_formatter
-        case formatter
-        when :json
-          params_or_body = params.to_json
-        when :xml
-          params_or_body = params.to_xml
-        when Proc
-          params_or_body = formatter.call(params)
+        if respond_to?(:raw_post) 
+          params_or_body = raw_post
         else
-          params_or_body = params
+          formatter = RspecApiDocumentation.configuration.post_body_formatter
+          case formatter
+          when :json
+            params_or_body = params.to_json
+          when :xml
+            params_or_body = params.to_xml
+          when Proc
+            params_or_body = formatter.call(params)
+          else
+            params_or_body = params
+          end
         end
-
-        params_or_body = respond_to?(:raw_post) ? raw_post : params_or_body
       end
 
       rspec_api_documentation_client.send(method, path_or_query, params_or_body, headers)

data/lib/rspec_api_documentation/views/html_example.rb

@@ -11,6 +11,12 @@ module RspecApiDocumentation
       def extension
         EXTENSION
       end
+
+      def styles
+        app_styles_url = RspecApiDocumentation.configuration.html_embedded_css_file
+        gem_styles_url = File.join(File.dirname(__FILE__), "..", "assets", "stylesheets","rspec_api_documentation", "styles.css")
+        return File.read(app_styles_url) rescue File.read(gem_styles_url)
+      end
     end
   end
 end

data/lib/rspec_api_documentation/views/html_index.rb

@@ -6,6 +6,12 @@ module RspecApiDocumentation
         self.template_name = "rspec_api_documentation/html_index"
       end
 
+      def styles
+        app_styles_url = RspecApiDocumentation.configuration.html_embedded_css_file
+        gem_styles_url = File.join(File.dirname(__FILE__), "..", "assets", "stylesheets","rspec_api_documentation", "styles.css")
+        return File.read(app_styles_url) rescue File.read(gem_styles_url)
+      end
+
       def examples
         @index.examples.map { |example| HtmlExample.new(example, @configuration) }
       end

data/templates/rspec_api_documentation/html_example.mustache

@@ -4,27 +4,7 @@
     <title>{{resource_name}} API</title>
     <meta charset="utf-8">
     <style>
-      td.required .name:after {
-        float: right;
-        content: "required";
-        font-weight: normal;
-        color: #F08080;
-      }
-
-      p {
-        padding: 15px;
-        font-size: 130%;
-      }
-
-      pre {
-        white-space: pre-wrap;
-      }
-
-      body {
-        margin-left: auto;
-        margin-right: auto;
-        width: 900px;
-      }
+      {{ styles }}
     </style>
   </head>
   <body>
@@ -130,7 +110,7 @@
             <pre class="response status">{{ response_status }} {{ response_status_text}}</pre>
             {{# response_body }}
               <h4>Body</h4>
-              <pre class="response body">{{{ response_body }}}</pre>
+              <pre class="response body">{{ response_body }}</pre>
             {{/ response_body }}
           {{/ response_status }}
         {{/ requests }}

data/templates/rspec_api_documentation/html_index.mustache

@@ -3,13 +3,8 @@
 <head>
   <title>{{ api_name }}</title>
   <meta charset="utf-8">
-
   <style>
-    body {
-      margin-left: auto;
-      margin-right: auto;
-      width: 900px;
-    }
+    {{ styles }}
   </style>
 </head>
 <body>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,15 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -26,9 +23,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -224,6 +218,7 @@ files:
 - lib/rspec_api_documentation.rb
 - lib/rspec_api_documentation/api_documentation.rb
 - lib/rspec_api_documentation/api_formatter.rb
+- lib/rspec_api_documentation/assets/stylesheets/rspec_api_documentation/styles.css
 - lib/rspec_api_documentation/client_base.rb
 - lib/rspec_api_documentation/configuration.rb
 - lib/rspec_api_documentation/curl.rb