capybara-json 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+-c
+-t wip

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use capybara-json

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - head
+gemfile:
+  - Gemfile
+  - Gemfile.capybara.lt.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capybara-json.gemspec
+gem 'capybara', '> 1.0.0'
+gemspec

data/Gemfile.capybara.lt.1.0

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capybara-json.gemspec
+gem 'capybara', '< 1.0.0'
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# capybara-json
+
+capybara-json provides the same interface to testing JSON API (both local and remote) 
+
+Capybara is an acceptance test framework, and it has no interest with client error(4xx response).
+testing web application 
+
+## USAGE
+    require 'capybara/json'
+    Capybara.current_driver = :rack_test_json
+
+    include Capybara::Json
+    post '/', { "this is" => "json" } # POST { "this is": "json" } 
+    body   #=> parsed json response
+    source #=> raw response body
+
+## ROADMAP
+
+* 0.0.1
+    * create :rack_test_json driver which supports normal json response (2xx, 3xx)
+* 0.0.2
+    * create :httpclient driver for remote testing
+* 0.0.3
+    * create :httpclient_json driver with the same interface with :rack_test_json in normal json response
+* 0.1.0
+    * ensure :rack_test_json and :httpclient_json has the same interface in error response (4xx, 5xx)
+* 0.2.0
+    * add jsonpath? interface to search response

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/capybara-json.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "capybara-json"
+  s.version     = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).chomp
+  s.authors     = ["okitan"]
+  s.email       = ["okitakunio@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{for testing json-api with capybara}
+  s.description = %q{for testing json-api with capybara}
+
+  s.rubyforge_project = "capybara-json"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  [ [ 'capybara' ],
+    [ 'multi_json' ],
+  ].each do |gem, version|
+    s.add_runtime_dependency gem, version
+  end
+
+  [ [ 'rspec', '~> 2.8.0.rc' ],
+    [ 'sinatra' ],
+    [ 'yajl-ruby' ],
+    [ 'autowatchr' ],
+  ].each do |gem, version|
+    s.add_development_dependency gem, version
+  end
+end

data/lib/capybara-json.rb

@@ -0,0 +1,2 @@
+require 'capybara/json'
+

data/lib/capybara/json.rb

@@ -0,0 +1,35 @@
+require 'capybara'
+require 'capybara/dsl'
+
+module Capybara
+  module Json
+    def self.included(base)
+      base.__send__(:include, Capybara::DSL) unless base < Capybara or base < Capybara::DSL 
+      base.extend(self)
+    end
+
+    %w[ get delete ].each do |method|
+      module_eval %{
+        def #{method}(path, params = {}, env = {})
+          page.driver.#{method}(path, params, env)
+        end
+      }
+    end
+
+    %w[ post put ].each do |method|
+      module_eval %{
+        def #{method}(path, json, env = {})
+          page.driver.#{method}(path, json, env)
+        end
+      }
+    end
+  end
+
+  module RackTestJson
+    autoload :Driver, 'capybara/rack_test_json/driver'
+  end
+end
+
+Capybara.register_driver :rack_test_json do |app|
+  Capybara::RackTestJson::Driver.new(app)
+end

data/lib/capybara/rack_test_json/driver.rb

@@ -0,0 +1,24 @@
+require 'multi_json'
+
+class Capybara::RackTestJson::Driver < Capybara::RackTest::Driver
+  def body
+    MultiJson.decode(source) || {}
+  end
+  
+
+  %w[ post put ].each do |method|
+    class_eval %{
+      def #{method}(path, json, env = {})
+        json = MultiJson.encode(json) unless json.is_a?(String)
+        
+        request_env = {
+          'CONTENT_LENGTH' => json.size,
+          'CONTENT_TYPE'   => "application/json; charset=\#{json.encoding.to_s.downcase}", 
+          'rack.input'     => StringIO.new(json)
+        }.merge(env)
+        
+        super(path, {}, request_env)
+      end
+    }
+  end
+end

data/spec/capybara/json_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe "to require 'capybara/json'" do
+  it 'should register driver' do
+    Capybara.drivers.should have_key(:rack_test_json)
+  end
+end
+
+describe Capybara::Json do
+  include described_class
+
+  before(:all) do
+    Capybara.app = JsonTestApp
+    Capybara.current_driver = :rack_test_json
+  end
+
+  after(:all) do
+    Capybara.app = nil
+    Capybara.current_driver = Capybara.default_driver
+  end
+
+  %w[ get delete ].each do |method|
+    it "register #{method}" do
+      __send__(method, '/')
+      body.should == { 'Hello world!' => 'Hello world!' }
+    end
+  end
+
+  %w[ post put ].each do |method|
+    it "register #{method}" do
+      __send__(method, '/', {})
+      body.should == { 'Hello world!' => 'Hello world!' }
+    end
+
+    it "#{method} send json" do
+      json = { "some" => "args" }
+      __send__(method, '/env', json)
+
+      body['content_type'].should =~ %r"application/json"
+      body['rack.input'].should == MultiJson.encode(json)
+    end
+  end
+end

data/spec/capybara/rack_test_json/driver_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# this code is written in capybara's spec/spec_helper
+alias :running :lambda
+
+klass = Capybara::RackTestJson::Driver
+
+describe klass do
+  before { @driver = described_class.new(JsonTestApp) }
+
+  it_should_behave_like 'driver'
+  it_should_behave_like 'driver with header support'
+  it_should_behave_like 'driver with status code support'
+  it_should_behave_like 'driver with cookies support'
+  it_should_behave_like 'driver with infinite redirect detection'
+
+  it_should_behave_like 'driver to post json'
+  it_should_behave_like 'driver to put json'
+end

data/spec/spec.watchr

@@ -0,0 +1,10 @@
+require 'autowatchr'
+
+Autowatchr.new(self) do |config|
+  config.ruby      = 'clear && rspec'
+  config.test_dir  = 'spec'
+  config.test_re   = "^#{config.test_dir}/(.*)_spec\.rb$"
+  config.test_file = '%s_spec.rb'
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ROOT = File.dirname(__FILE__)
+$: << File.expand_path('../lib', ROOT)
+
+require 'capybara/json'
+Dir[File.expand_path("support/**/*.rb", ROOT)].each {|f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/driver_examples.rb

@@ -0,0 +1,64 @@
+require 'capybara/spec/driver'
+
+[ 'driver', 'driver with header support' ].each do |shared|
+  RSpec.world.shared_example_groups.delete(shared)
+end
+
+shared_examples_for 'driver' do
+  describe '#visit' do
+    it "should move to another page" do
+      @driver.visit('/')
+      @driver.body.should include('Hello world!')
+      @driver.visit('/foo')
+      @driver.body.should include('Another World')
+    end
+
+    it "should show the correct URL" do
+      @driver.visit('/foo')
+      @driver.current_url.should include('/foo')
+    end
+  end
+
+  describe '#body' do
+    it "should return json reponses" do
+      @driver.visit('/')
+      @driver.body.should include('Hello world!')
+    end
+    # pending encoding
+  end
+
+  # TODO: find by jsonpath?
+end
+
+shared_examples_for 'driver with header support' do
+  it "should make headers available through response_headers" do
+    @driver.visit('/')
+    @driver.response_headers['Content-Type'].should =~ /^application\/json/
+  end
+end
+
+
+%w[ post put ].each do |method|
+  shared_examples_for "driver to #{method} json" do
+    it 'should set content type as json to request' do
+      @driver.__send__(method, '/env', {})
+      @driver.body['content_type'].should =~ %r"^application/json"
+    end
+    
+    it 'should set content length' do
+      json = { :some => :args }
+      
+      @driver.__send__(method, '/env', json)
+      @driver.body['content_length'].should == MultiJson.encode(json).length
+    end
+    
+    it 'should post body' do
+      json = { :some => :args }
+      
+      @driver.__send__(method, '/env', json)
+      @driver.body['rack.input'].should == MultiJson.encode(json)
+    end
+  end
+end
+
+

data/spec/support/json_test_app.rb

@@ -0,0 +1,40 @@
+require 'capybara/spec/test_app'
+
+class JsonTestApp < TestApp
+  def invoke
+    res = catch(:halt) { yield }
+
+    res = [ MultiJson.encode(res => res) ] if Fixnum === res or String === res
+    res = [ MultiJson.encode(res) ] if Hash === res
+    if Array === res and Fixnum === res.first
+      status(res.shift)
+      body(res.pop)
+      headers(*res)
+    elsif res.respond_to? :each 
+      content_type :json
+      body res
+    end
+  end
+
+  %w[ get post put delete ].each do |method|
+    __send__(method, '/') do
+      'Hello world!'
+    end
+
+    # rack specifications
+    # http://rack.rubyforge.org/doc/SPEC.html
+    __send__(method, '/env') do
+      envs = %w[ REQUEST_METHOD PATH_INFO QUERY_STRING CONTENT_TYPE CONTENT_LENGTH rack.url_scheme ]\
+               .inject({}) do |hash, key|
+        hash[key.downcase] = env[key]
+        hash
+      end
+      headers = env.select {|key, value| key.start_with?('HTTP_') }.inject({}) do |hash, (key, value)|
+        hash[key.sub('HTTP_', '')] = value
+        hash
+      end
+      
+      envs.merge('params' => params, 'headers' => headers, 'rack.input' => env['rack.input'].string)
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: capybara-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- okitan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &83236190 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83236190
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &83234440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83234440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &83233800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: *83233800
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &83228020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83228020
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &83227250 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83227250
+- !ruby/object:Gem::Dependency
+  name: autowatchr
+  requirement: &83226910 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83226910
+description: for testing json-api with capybara
+email:
+- okitakunio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.capybara.lt.1.0
+- README.md
+- Rakefile
+- VERSION
+- capybara-json.gemspec
+- lib/capybara-json.rb
+- lib/capybara/json.rb
+- lib/capybara/rack_test_json/driver.rb
+- spec/capybara/json_spec.rb
+- spec/capybara/rack_test_json/driver_spec.rb
+- spec/spec.watchr
+- spec/spec_helper.rb
+- spec/support/driver_examples.rb
+- spec/support/json_test_app.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: capybara-json
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: for testing json-api with capybara
+test_files:
+- spec/capybara/json_spec.rb
+- spec/capybara/rack_test_json/driver_spec.rb
+- spec/spec.watchr
+- spec/spec_helper.rb
+- spec/support/driver_examples.rb
+- spec/support/json_test_app.rb