flunk 0.0.12 → 0.0.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a617a93d04bbd6c20b131f21271ed6d9c372bc3d
+  data.tar.gz: 33e9a15f41753fe0fd543d581c21154cc2daf8e6
+SHA512:
+  metadata.gz: c15a389b2b9c0b56df060115d0c6129347fca4f8920041194316895f1d7c35ddd1ec028d435efd468a3bd92da74fdf44838baf5ec1d71f1cd9fae44b94e2f88d
+  data.tar.gz: a233c0b670c259fe4f5a162a76650084b4dc4078f313351b21b453faeb9dfa434375ecba3de0aa4804aa95fd0ec1d616987ca87ead489d00e1ab2c35cabb7e10

data/lib/flunk.rb

@@ -3,32 +3,47 @@ require 'rails/test_help'
 class Flunk < ActionDispatch::IntegrationTest
 
   def self.test(resource, action, &block)
+
+    if action.class == Hash
+      name    = action[:name]
+      action  = action[:action]
+    end
+  
     new_proc = Proc.new do
+      @resource ||= resource
+      @action   ||= action
       instance_eval(&block)
       result
       instance_eval(&@after) unless @after.nil?
     end
 
-    if !action || !resource
-      name = action || resource
-    else
-      name = resource + ": " + action
-    end
-
+    name = resource + ": " + action if name.nil?
     super name, &new_proc
   end
 
   def self.flunk(resource, action, failure_reason, &block)
-    test("FLUNKED! #{resource}: #{action} (#{failure_reason})", nil, &block)
+    name = "Flunked #{resource}: #{action} (#{failure_reason})"
+    test(resource, { action: action, name: name }, &block)
   end
 
+
   def result
     if !@result_fetched
       @result_fetched = true
 
+      @username   ||= self.class.config.read_username
+      @password   ||= self.class.config.read_password
+      @auth_token ||= self.class.config.read_auth_token
+      @headers    ||= self.class.config.read_headers
+      @method     ||= self.class.config.read_method
+      @ssl        ||= self.class.config.read_ssl
+
       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
 
       send @method, @path, @body, @headers
@@ -44,53 +59,136 @@ class Flunk < ActionDispatch::IntegrationTest
           @result = json
         end
       end
+
+      if not @desc.nil?
+        make_doc @resource, @action, @desc, @path, @method, @auth_token, @headers, @body, @status, @result
+      end
+      
     end
 
     @result
   end
 
+  def desc(desc)
+    @desc = desc
+  end
+  
+  def read_desc
+    @desc
+  end
+
+  def base_url(base_url)
+    @base_url
+  end
+
+  def read_base_url
+    @base_url
+  end
+
   def path(path)
     @path = path
   end
 
+  def read_path
+    @path
+  end
+
   def method(method)
     @method = method
   end
 
+  def read_method
+    @method
+  end
+
   def username(username)
     @username = username
   end
 
+  def read_username
+    @username
+  end
+
   def password(password)
     @password = password
   end
 
+  def read_password
+    @password
+  end
+
+  def auth_token(auth_token)
+    @auth_token = auth_token
+  end
+
+  def read_auth_token
+    @auth_token
+  end
+
   def ssl(ssl)
     @ssl = ssl
   end
 
+  def read_ssl
+    @ssl
+  end
+
   def body(body)
     @body = body
   end
 
+  def read_body
+    @body
+  end
+
+  def status(status)
+    @status = status
+  end
+
+  def read_status
+    @status
+  end
+
   def header(key, value)
     @headers ||= {}
+    @headers = self.class.config.read_headers.merge @headers
     @headers[key] = value
   end
 
+  def read_headers
+    @headers
+  end
+
   def param(key, value)
     @params ||= {}
     @params[key] = value
   end
 
-  def status(status)
-    @status = status
+  def read_params
+    @params
   end
 
-  def desc(desc)
-    @desc = desc
+  def doc_directory(doc_directory)
+    FileUtils.rm_r(doc_directory) if File.exists?(doc_directory)
+    FileUtils.mkdir_p(doc_directory) 
+    @doc_directory = doc_directory
   end
 
+  def read_config_doc_directory
+    @doc_directory
+  end
+
+  def read_doc_directory
+    @doc_directory = self.class.config.read_config_doc_directory || "docs/flunk"
+    FileUtils.mkdir_p(@doc_directory) unless File.exists?(@doc_directory)
+    @doc_directory
+  end
+
+
+
+
+  # before/after blocks
+
   def before(&block)
     @before = block
     instance_eval(&@before)
@@ -100,6 +198,18 @@ class Flunk < ActionDispatch::IntegrationTest
     @after = block
   end
 
+
+
+  # global
+
+  def self.config
+    @@config ||= self.new "FlunkConfig"
+  end
+
+
+
+  # helpers
+
   def rec_symbolize(obj)
     if obj.class == Hash
       obj.symbolize_keys!
@@ -110,4 +220,49 @@ class Flunk < ActionDispatch::IntegrationTest
     nil
   end
 
+  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)
+    contents = ""
+    contents += "# #{action.humanize}\n\n"
+    contents += "#{desc.humanize}\n\n"
+    contents += "## Request\n\n"
+    if not auth_token.nil?
+      contents += "- Requires Authentication\n"
+    end
+    contents += "- HTTP Method: #{method.to_s.upcase}\n"
+    contents += "- URL: #{url}\n"
+    if not body.nil?
+      contents += "- Body:\n\n```js\n#{JSON.pretty_generate(body)}\n```\n\n"
+    else
+      contents += "\n"
+    end
+    contents += "## Response\n\n"
+    contents += "- Status: #{status} #{status.to_s.humanize}\n"
+    if not response.nil?
+      contents += "- Body:\n\n```js\n#{JSON.pretty_generate(response)}\n```\n\n"
+    else
+      contents += "\n"
+    end
+    contents += "## Example\n\n"
+    contents += 
+"```bash
+curl -X #{method.to_s.upcase} \\\n"
+    headers.to_h.each do |key, value|      
+      contents += 
+"     -H \"#{key}: #{value}\" \\\n"
+    end
+    if not body.nil?
+      contents += 
+"     -d '#{body.to_json}' \\"
+    end
+    contents += 
+"     \"#{url}\"
+```"
+    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
+
 end

data/lib/generators/flunk_test/templates/flunk_test.rb

@@ -7,15 +7,15 @@ class <%= class_name.pluralize %>Test < Flunk
 
   # Write tests that should succeed to make sure the required functionality works.
   test "Resource", "Action" do
+    before {
+      assert_equal 1, 1
+    }
     desc      "A description of the function this tests"
     path      "resource/:id"
     method    :get
     username  @user.username
     password  @user.password
     status    :ok
-    before {
-      assert_equal 1, 1
-    }
     after {
       assert_equal 2, 2
     }

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flunk
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Adam Kirk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies: []
 description: A gem for testing Ruby on Rails web APIs by simulating a client.
 email: atomkirk@gmail.com
@@ -22,32 +21,27 @@ files:
 - lib/generators/flunk_test/flunk_test_generator.rb
 - lib/generators/flunk_test/templates/flunk_test.rb
 - lib/tasks/flunk.rake
-- test/integration/bananas_test.rb
-- test/test_helper.rb
 homepage: https://github.com/mysterioustrousers/flunk
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A gem for testing Ruby on Rails web APIs by simulating a client.
-test_files:
-- test/integration/bananas_test.rb
-- test/test_helper.rb
+test_files: []

data/test/integration/bananas_test.rb

@@ -1,37 +0,0 @@
-require 'test_helper'
-require 'flunk'
-
-class BananasTest < Flunk
-
-  setup do
-  end
-
-  # Write tests that should succeed to make sure the required functionality works.
-  test "Banana", "Create" do
-    before {
-      @count = 1
-      p "before was called"
-    }
-
-    p @count
-    desc      "Create a Banana"
-    path      "bananas"
-    method    :post
-    status    :created
-    body      banana: { weight: 2 }
-
-    after {
-      assert_equal @count, 1
-      p "after was called"
-    }
-  end
-
-
-  # Write a test that SHOULD fail to ensure your application handles bad requests gracefully.
-  # flunk "Banana", "Create", "Not found" do
-  #   path      "/bananas/10000"
-  #   method    :get
-  #   status    :not_found
-  # end
-
-end

data/test/test_helper.rb

@@ -1,13 +0,0 @@
-ENV["RAILS_ENV"] = "test"
-require File.expand_path('../../config/environment', __FILE__)
-require 'rails/test_help'
-
-class ActiveSupport::TestCase
-  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
-  #
-  # Note: You'll currently still have to declare fixtures explicitly in integration tests
-  # -- they do not yet inherit this setting
-  fixtures :all
-
-  # Add more helper methods to be used by all tests here...
-end