flunk 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a617a93d04bbd6c20b131f21271ed6d9c372bc3d
-  data.tar.gz: 33e9a15f41753fe0fd543d581c21154cc2daf8e6
+  metadata.gz: fbfaf66ff6b6869fdd639cc3c5c789232ba7a1ca
+  data.tar.gz: 93e06a64ffe38ff97f6cd77ebcec094eef85e441
 SHA512:
-  metadata.gz: c15a389b2b9c0b56df060115d0c6129347fca4f8920041194316895f1d7c35ddd1ec028d435efd468a3bd92da74fdf44838baf5ec1d71f1cd9fae44b94e2f88d
-  data.tar.gz: a233c0b670c259fe4f5a162a76650084b4dc4078f313351b21b453faeb9dfa434375ecba3de0aa4804aa95fd0ec1d616987ca87ead489d00e1ab2c35cabb7e10
+  metadata.gz: 69e745859d1458782bcfa680df4750ad6ff89304a03f81129fbd0ac28255de8bfc41b7a258f982f3e744b500795d690af1be3f88b74233ac56103f0df64eb499
+  data.tar.gz: 17c6790e060ccdc1f913dab6b90b62dd00634585911e43c99826b9f44b55aeda69361fbff06a99be7724b832df3cc2191f8f3adac5e03fd4ef021c2e460af7a6

data/lib/flunk.rb

@@ -5,10 +5,10 @@ class Flunk < ActionDispatch::IntegrationTest
   def self.test(resource, action, &block)
 
     if action.class == Hash
-      name    = action[:name]
-      action  = action[:action]
+      name          = action[:name]
+      action        = action[:action]
     end
-  
+
     new_proc = Proc.new do
       @resource ||= resource
       @action   ||= action
@@ -38,11 +38,11 @@ class Flunk < ActionDispatch::IntegrationTest
       @method     ||= self.class.config.read_method
       @ssl        ||= self.class.config.read_ssl
 
+      @headers ||= {}
+
       if @username || @password
-        @headers ||= {}
         @headers["HTTP_AUTHORIZATION"] = "Basic #{Base64.encode64(@username.to_s + ":" + @password.to_s)}".strip
       elsif @auth_token
-        @headers ||= {}
         @headers["HTTP_AUTHORIZATION"] = "Token token=\"#{@auth_token}\"".strip
       end
 
@@ -50,20 +50,38 @@ class Flunk < ActionDispatch::IntegrationTest
 
       @response = response
 
-      assert_response @status, @response.body
+      expected_status_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[@status]
+
+      if response.status == 422 and expected_status_code != 422
+        puts "VALIDATION ERRORS:"
+        puts JSON.pretty_generate(JSON.parse(response.body))
+      end
+
+      if response.status.to_i != expected_status_code
+        puts "STATUS MISMATCH:"
+        puts "path: #{@path}"
+        puts "headers: #{@headers.to_json}"
+        puts "body: #{@body}"
+      end
+
+      assert_response @status
 
       unless response.body.blank?
+        @result = response.body
         if response.content_type == 'application/json'
-          json = ActiveSupport::JSON.decode(response.body)
-          rec_symbolize( json )
-          @result = json
+          begin
+            json = ActiveSupport::JSON.decode(response.body)
+            rec_symbolize( json )
+            @result = json
+          rescue => e
+          end
         end
       end
 
       if not @desc.nil?
         make_doc @resource, @action, @desc, @path, @method, @auth_token, @headers, @body, @status, @result
       end
-      
+
     end
 
     @result
@@ -72,7 +90,7 @@ class Flunk < ActionDispatch::IntegrationTest
   def desc(desc)
     @desc = desc
   end
-  
+
   def read_desc
     @desc
   end
@@ -86,7 +104,10 @@ class Flunk < ActionDispatch::IntegrationTest
   end
 
   def path(path)
-    @path = path
+    uri = URI.parse path
+    uri.path = uri.path[0] == "/" ? uri.path : "/#{uri.path}"
+    uri.path = uri.path[-5..-1] == ".json" ? uri.path : "#{uri.path}.json"
+    @path = uri.to_s
   end
 
   def read_path
@@ -151,7 +172,7 @@ class Flunk < ActionDispatch::IntegrationTest
 
   def header(key, value)
     @headers ||= {}
-    @headers = self.class.config.read_headers.merge @headers
+    @headers = self.class.config.read_headers.merge @headers if self.class.config.read_headers
     @headers[key] = value
   end
 
@@ -170,7 +191,7 @@ class Flunk < ActionDispatch::IntegrationTest
 
   def doc_directory(doc_directory)
     FileUtils.rm_r(doc_directory) if File.exists?(doc_directory)
-    FileUtils.mkdir_p(doc_directory) 
+    FileUtils.mkdir_p(doc_directory)
     @doc_directory = doc_directory
   end
 
@@ -184,6 +205,18 @@ class Flunk < ActionDispatch::IntegrationTest
     @doc_directory
   end
 
+  def doc_base_url(doc_base_url)
+    @doc_base_url = doc_base_url
+  end
+
+  def read_config_doc_base_url
+    @doc_base_url
+  end
+
+  def read_doc_base_url
+    self.class.config.read_config_doc_base_url || "http://www.example.com/"
+  end
+
 
 
 
@@ -223,46 +256,104 @@ class Flunk < ActionDispatch::IntegrationTest
   def make_doc resource, action, desc, path, method, auth_token, headers, body, status, response
     body = body.class == String ? JSON.parse(body) : body
     url = File.join(@@config.read_base_url.to_s, path.to_s)
+
+    headers ||= {}
+    headers["Content-Type"] = "application/json"
+    headers["Accept"]       = "application/json"
+
     contents = ""
+
     contents += "# #{action.humanize}\n\n"
+
     contents += "#{desc.humanize}\n\n"
+
     contents += "## Request\n\n"
+
     if not auth_token.nil?
-      contents += "- Requires Authentication\n"
+      contents += "- **Requires Authentication**\n"
     end
-    contents += "- HTTP Method: #{method.to_s.upcase}\n"
-    contents += "- URL: #{url}\n"
+
+    contents += "- **Method:** #{method.to_s.upcase}\n"
+
+    # if not headers.nil?
+    #   headers_strings = headers.map {|k,v| "  - #{k}: #{v}" }
+    #   contents += "- **Headers:**\n#{headers_strings.join("\n")}\n"
+    # end
+
+    contents += "- **URL:** #{url}\n"
+
     if not body.nil?
-      contents += "- Body:\n\n```js\n#{JSON.pretty_generate(body)}\n```\n\n"
+      contents += "- **Body:**\n\n```json\n#{pretty(body)}\n```\n\n"
     else
       contents += "\n"
     end
+
     contents += "## Response\n\n"
-    contents += "- Status: #{status} #{status.to_s.humanize}\n"
+
+    contents += "- **Status:** #{Rack::Utils::SYMBOL_TO_STATUS_CODE[status]} #{status.to_s.humanize}\n"
+
     if not response.nil?
-      contents += "- Body:\n\n```js\n#{JSON.pretty_generate(response)}\n```\n\n"
+      contents += "- **Body:**\n\n```json\n#{pretty(response)}\n```\n\n"
     else
       contents += "\n"
     end
+
     contents += "## Example\n\n"
-    contents += 
+
+    contents +=
 "```bash
 curl -X #{method.to_s.upcase} \\\n"
-    headers.to_h.each do |key, value|      
-      contents += 
-"     -H \"#{key}: #{value}\" \\\n"
+    headers.to_h.each do |key, value|
+      contents +=
+"     -H \'#{key}: #{value}\' \\\n"
     end
     if not body.nil?
-      contents += 
-"     -d '#{body.to_json}' \\"
+      contents +=
+"     -d '#{pretty(body).gsub /\n/, "\n         "}' \\\n"
     end
-    contents += 
-"     \"#{url}\"
+    contents +=
+"     \"#{ URI::join(read_doc_base_url, url) }\"
 ```"
+
+    save_doc resource, action, contents
+  end
+
+
+  # custom attributes must follow this form:
+  # customer_attributes =
+  #   key:
+  #     kind: [text | code]
+  #     content: [text]
+  def make_custom_doc resource, action, desc, custom_attributes
+    contents = ""
+    contents += "# #{action.humanize}\n\n"
+    contents += "#{desc.humanize}\n\n"
+
+    custom_attributes.each do |key, value|
+      if value[:kind] == :text
+        contents += "- **#{key.to_s.humanize}:** #{value[:content]}\n"
+      elsif value[:kind] == :code
+        contents += "- **#{key.to_s.humanize}:**\n\n```\n#{value[:content]}\n```\n\n"
+      end
+    end
+
+    save_doc resource, action, contents
+  end
+
+
+  def save_doc resource, action, contents
     resource_directory = File.join( read_doc_directory, resource.pluralize.capitalize )
     FileUtils.mkdir_p(resource_directory) unless File.exists?( resource_directory )
     file_path = File.join( resource_directory, "#{action.capitalize}.md" )
     File.open(file_path, 'w') {|f| f.write(contents) }
   end
 
+  def pretty json
+    begin
+      pretty_json = JSON.pretty_generate(json)
+    rescue => e
+      pretty_json = json
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flunk
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Adam Kirk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies: []
 description: A gem for testing Ruby on Rails web APIs by simulating a client.
 email: atomkirk@gmail.com
@@ -30,17 +30,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A gem for testing Ruby on Rails web APIs by simulating a client.