api_docs 1.0.5 → 1.0.6

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle
+.DS_Store
+.rvmrc
+.rbenv-gemsets
+.rbenv-version
+pkg
+Gemfile.lock
+/test/dummy/log/
+/test/dummy/tmp/
+/test/dummy/doc/

data/Gemfile

@@ -1,8 +1,3 @@
 source 'http://rubygems.org'
 
-gem 'rails', '>=3.1.0'
-gem 'jquery-rails'
-
-group :development do
-  gem 'jeweler'
-end
+gemspec

data/Rakefile

@@ -1,31 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+require 'rubygems'
+require 'rake/testtask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name        = 'api_docs'
-    gem.homepage    = 'http://github.com/twg/api_docs'
-    gem.license     = 'MIT'
-    gem.summary     = 'Generate API documentation using integration tests in Ruby on Rails 3'
-    gem.description = 'Generate API documentation using integration tests in Ruby on Rails 3'
-    gem.email       = 'jack@twg.ca'
-    gem.authors     = ['Oleg Khabarov', 'Jack Neto', 'The Working Group Inc.']
-  end
-  Jeweler::RubygemsDotOrgTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
 end
 
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
 task :default => :test

data/api_docs.gemspec

@@ -1,104 +1,20 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
-Gem::Specification.new do |s|
-  s.name = "api_docs"
-  s.version = "1.0.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Oleg Khabarov", "Jack Neto", "The Working Group Inc."]
-  s.date = "2013-02-28"
-  s.description = "Generate API documentation using integration tests in Ruby on Rails 3"
-  s.email = "jack@twg.ca"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    "Gemfile",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "api_docs.gemspec",
-    "app/assets/javascripts/api_docs.js",
-    "app/assets/stylesheets/api_docs.css",
-    "app/controllers/api_docs/docs_controller.rb",
-    "app/views/api_docs/docs/_action.html.erb",
-    "app/views/api_docs/docs/_request_params.html.erb",
-    "app/views/api_docs/docs/index.html.erb",
-    "config/routes.rb",
-    "doc/screenshot.png",
-    "lib/api_docs.rb",
-    "lib/api_docs/configuration.rb",
-    "lib/api_docs/engine.rb",
-    "lib/api_docs/test_helper.rb",
-    "lib/tasks/api_docs.rake",
-    "script/rails",
-    "test/api_docs_test.rb",
-    "test/docs_controller_test.rb",
-    "test/dummy/README.rdoc",
-    "test/dummy/Rakefile",
-    "test/dummy/app/assets/images/glyphicons-halflings-white.png",
-    "test/dummy/app/assets/images/glyphicons-halflings.png",
-    "test/dummy/app/assets/javascripts/application.js",
-    "test/dummy/app/assets/javascripts/bootstrap.min.js",
-    "test/dummy/app/assets/stylesheets/application.css",
-    "test/dummy/app/assets/stylesheets/bootstrap.min.css",
-    "test/dummy/app/controllers/application_controller.rb",
-    "test/dummy/app/helpers/application_helper.rb",
-    "test/dummy/app/mailers/.gitkeep",
-    "test/dummy/app/models/.gitkeep",
-    "test/dummy/app/views/layouts/application.html.erb",
-    "test/dummy/config.ru",
-    "test/dummy/config/application.rb",
-    "test/dummy/config/boot.rb",
-    "test/dummy/config/environment.rb",
-    "test/dummy/config/environments/development.rb",
-    "test/dummy/config/environments/production.rb",
-    "test/dummy/config/environments/test.rb",
-    "test/dummy/config/initializers/backtrace_silencers.rb",
-    "test/dummy/config/initializers/inflections.rb",
-    "test/dummy/config/initializers/mime_types.rb",
-    "test/dummy/config/initializers/secret_token.rb",
-    "test/dummy/config/initializers/session_store.rb",
-    "test/dummy/config/initializers/wrap_parameters.rb",
-    "test/dummy/config/locales/en.yml",
-    "test/dummy/config/routes.rb",
-    "test/dummy/lib/assets/.gitkeep",
-    "test/dummy/log/.gitkeep",
-    "test/dummy/public/404.html",
-    "test/dummy/public/422.html",
-    "test/dummy/public/500.html",
-    "test/dummy/public/favicon.ico",
-    "test/dummy/script/rails",
-    "test/test_helper.rb",
-    "test/test_helper_test.rb"
-  ]
-  s.homepage = "http://github.com/twg/api_docs"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
-  s.summary = "Generate API documentation using integration tests in Ruby on Rails 3"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.1.0"])
-      s.add_runtime_dependency(%q<jquery-rails>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-    else
-      s.add_dependency(%q<rails>, [">= 3.1.0"])
-      s.add_dependency(%q<jquery-rails>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rails>, [">= 3.1.0"])
-    s.add_dependency(%q<jquery-rails>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-  end
-end
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'api_docs/version'
 
+Gem::Specification.new do |s|
+  s.name          = "api_docs"
+  s.version       = ApiDocs::VERSION
+  s.authors       = ["Oleg Khabarov"]
+  s.email         = ["oleg@khabarov.ca"]
+  s.homepage      = "http://github.com/twg/api_docs"
+  s.summary       = "Generate API documentation using integration tests in Ruby on Rails"
+  s.description   = "Generate API documentation using integration tests in Ruby on Rails"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  
+  s.add_dependency 'rails', '>=3.1.0'
+end

data/lib/api_docs.rb

@@ -1,3 +1,4 @@
+require 'api_docs/version'
 require 'api_docs/engine'
 require 'api_docs/configuration'
 require 'api_docs/test_helper'

data/lib/api_docs/test_helper.rb

@@ -1,68 +1,74 @@
 module ApiDocs::TestHelper
   
-  # Method that allows test creation and will document results in a YAML file
-  # Example usage:
-  #   api_call(:get, '/users/:id', :id => 12345) do |doc|
-  #     doc.description = 'Something for the docs'
-  #     ... regular test code
-  #   end
-  def api_call(method, path, params = { })
-    parsed_params = params.dup
-    parsed_path   = path.dup
+  module InstanceMethods
+    # Method that allows test creation and will document results in a YAML file
+    # Example usage:
+    #   api_call(:get, '/users/:id', :id => 12345) do |doc|
+    #     doc.description = 'Something for the docs'
+    #     ... regular test code
+    #   end
+    def api_call(method, path, params = { })
+      parsed_params = params.dup
+      parsed_path   = path.dup
     
-    parsed_params.each do |k, v|
-      parsed_params.delete(k) if parsed_path.gsub!(":#{k}", v.to_s)
-    end
+      parsed_params.each do |k, v|
+        parsed_params.delete(k) if parsed_path.gsub!(":#{k}", v.to_s)
+      end
+      
+      if credentials = parsed_params.delete('HTTP_AUTHORIZATION')
+        auth = {'HTTP_AUTHORIZATION' => credentials}
+      end
     
-    # Making actual test request. Based on the example above:
-    #   get '/users/12345'
-    doc = OpenStruct.new
-    send(method, parsed_path, parsed_params)
+      # Making actual test request. Based on the example above:
+      #   get '/users/12345'
+      doc = OpenStruct.new
+      send(method, parsed_path, parsed_params, auth)
 
-    yield doc if block_given?
+      yield doc if block_given?
     
-    # Assertions inside test block didn't fail. Preparing file
-    # content to be written
-    c = request.filtered_parameters['controller']
-    a = request.filtered_parameters['action']
+      # Assertions inside test block didn't fail. Preparing file
+      # content to be written
+      c = request.filtered_parameters['controller']
+      a = request.filtered_parameters['action']
     
-    file_path = File.expand_path("#{c.gsub('/', ':')}.yml", ApiDocs.config.docs_path)
-    params    = api_deep_clean_params(params)
+      file_path = File.expand_path("#{c.gsub('/', ':')}.yml", ApiDocs.config.docs_path)
+      params    = ApiDocs::TestHelper.api_deep_clean_params(params)
     
-    # Marking response as an unique
-    key = 'ID-' + Digest::MD5.hexdigest("
-      #{method}#{path}#{doc.description}#{params}#{response.status}}
-    ")
+      # Marking response as an unique
+      key = 'ID-' + Digest::MD5.hexdigest("
+        #{method}#{path}#{doc.description}#{params}#{response.status}}
+      ")
     
-    data = if File.exists?(file_path)
-      YAML.load_file(file_path) rescue Hash.new
-    else
-      Hash.new
-    end
+      data = if File.exists?(file_path)
+        YAML.load_file(file_path) rescue Hash.new
+      else
+        Hash.new
+      end
     
-    data[a] ||= { }
-    data[a][key] = {
-      'description' => doc.description,
-      'method'      => request.method,
-      'path'        => path,
-      'params'      => api_deep_clean_params(params),
-      'status'      => response.status,
-      'body'        => response.body
-    }
-    FileUtils.mkdir_p(File.dirname(file_path))
-    File.open(file_path, 'w'){|f| f.write(data.to_yaml)}
+      data[a] ||= { }
+      data[a][key] = {
+        'description' => doc.description,
+        'method'      => request.method,
+        'path'        => path,
+        'params'      => ApiDocs::TestHelper.api_deep_clean_params(params),
+        'status'      => response.status,
+        'body'        => response.body
+      }
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.open(file_path, 'w'){|f| f.write(data.to_yaml)}
+    end
   end
   
   # Cleans up params. Removes things like File object handlers
   # Sets up ignored values so we don't generate new keys for same data
-  def api_deep_clean_params(params)
+  def self.api_deep_clean_params(params)
     case params
     when Hash
       params.each_with_object({}) do |(key, value), res|
-        res[key.to_s] = api_deep_clean_params(value)
+        res[key.to_s] = ApiDocs::TestHelper.api_deep_clean_params(value)
       end
     when Array
-      params.collect{|value| api_deep_clean_params(value)}
+      params.collect{|value| ApiDocs::TestHelper.api_deep_clean_params(value)}
     else
       case params 
       when Rack::Test::UploadedFile
@@ -74,4 +80,4 @@ module ApiDocs::TestHelper
   end
 end
 
-ActionDispatch::IntegrationTest.send :include, ApiDocs::TestHelper
+ActionDispatch::IntegrationTest.send :include, ApiDocs::TestHelper::InstanceMethods

data/lib/api_docs/version.rb

@@ -0,0 +1,3 @@
+module ApiDocs
+  VERSION = "1.0.6"
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,24 +1,6 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery
   
-  def index
-    respond_to do |format|
-      format.json {
-        render :text => [{
-          :id         => 1,
-          :name       => 'Test User',
-          :created_at => 1.day.ago
-        }].to_json
-      }
-      format.xml {
-        render :text => [{
-          :id         => 1,
-          :name       => 'Test User',
-          :created_at => 1.day.ago
-        }].to_xml(:root => 'users')
-      }
-    end
-  end
+  http_basic_authenticate_with :name => 'user', :password => 'secret', :only => :authenticate
   
   def show
     status = :ok
@@ -41,4 +23,8 @@ class ApplicationController < ActionController::Base
       end
     end
   end
+  
+  def authenticate
+    render :text => {:message => 'Authenticated'}.to_json
+  end
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
   mount ApiDocs::Engine => '/'
-  match '/users/:id' => 'application#show'
+  match '/users/:id'    => 'application#show'
+  match '/authenticate' => 'application#authenticate'
 end

data/test/test_helper_test.rb

@@ -11,21 +11,21 @@ class TestHelperTest < ActionDispatch::IntegrationTest
   
   def test_api_deep_clean_params
     assert_equal ({'a' => 'b'}),
-      api_deep_clean_params({:a => 'b'})
+      ApiDocs::TestHelper.api_deep_clean_params({:a => 'b'})
     
     assert_equal ({'a' => {'b' => 'c'}}),
-      api_deep_clean_params({:a => {:b => 'c'}})
+      ApiDocs::TestHelper.api_deep_clean_params({:a => {:b => 'c'}})
     
     assert_equal ([{'a' => 'b'}, {'c' => 'd'}]),
-      api_deep_clean_params([{:a => 'b'}, {:c => 'd'}])
+      ApiDocs::TestHelper.api_deep_clean_params([{:a => 'b'}, {:c => 'd'}])
       
     assert_equal ({'a'=>[{'b'=>'c'}]}),
-      api_deep_clean_params({:a => [{:b => 'c'}]})
+      ApiDocs::TestHelper.api_deep_clean_params({:a => [{:b => 'c'}]})
   end
   
   def test_api_deep_clean_params_with_file_handler
     assert_equal ({'a' => 'BINARY'}),
-      api_deep_clean_params({:a => Rack::Test::UploadedFile.new(__FILE__)})
+      ApiDocs::TestHelper.api_deep_clean_params({:a => Rack::Test::UploadedFile.new(__FILE__)})
   end
   
   def test_api_call
@@ -110,4 +110,18 @@ eoxml
     assert_equal 1, output['show'].keys.size
   end
   
+  def test_api_call_with_httpauth
+    auth = ActionController::HttpAuthentication::Basic.encode_credentials('user', 'secret')
+    api_call(:get, '/authenticate', :random => 1, :format => 'json', 'HTTP_AUTHORIZATION' => auth) do
+      assert_response :success
+      assert_equal ({'message' => 'Authenticated'}), JSON.parse(response.body)
+    end
+  end
+  
+  def test_api_call_with_httpauth_failure
+    api_call(:get, '/authenticate', :random => 1, :format => 'json') do
+      assert_response :unauthorized
+    end
+  end
+  
 end

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: api_docs
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
 - Oleg Khabarov
-- Jack Neto
-- The Working Group Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -29,46 +27,14 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Generate API documentation using integration tests in Ruby on Rails 3
-email: jack@twg.ca
+description: Generate API documentation using integration tests in Ruby on Rails
+email:
+- oleg@khabarov.ca
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -87,6 +53,7 @@ files:
 - lib/api_docs/configuration.rb
 - lib/api_docs/engine.rb
 - lib/api_docs/test_helper.rb
+- lib/api_docs/version.rb
 - lib/tasks/api_docs.rake
 - script/rails
 - test/api_docs_test.rb
@@ -129,8 +96,7 @@ files:
 - test/test_helper.rb
 - test/test_helper_test.rb
 homepage: http://github.com/twg/api_docs
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,9 +107,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -620307920657419595
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,5 +118,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Generate API documentation using integration tests in Ruby on Rails 3
+summary: Generate API documentation using integration tests in Ruby on Rails
 test_files: []