heisenberg 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    heisenberg (0.0.2)
+      rack-test (>= 0.6.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (1.4.1)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  heisenberg!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marcello Milhomem Albuquerque
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+Heisenberg
+=======
+
+Acceptance test for REST apis.
+
+Installation
+---------
+
+Simply add the gem to your project's Gemfile:
+
+    gem 'heisenberg', group: :test
+
+and then run the bundle command:
+
+    $ bundle
+
+Usage
+-----
+
+First of all, we must set our spec to use Heisenberg by setting the spec type to rest_api.
+
+```ruby
+require "spec_helper"
+
+describe "My awesome REST API", type: :rest_api
+  it "should do something awesome"
+end
+```
+
+By default, all specs under the rest_apis directory will use Heisenberg, allowing you to ommit the type declaration.
+
+To send messages to your api you can call any of these methods:
+
+```ruby
+get "/people"
+post "/people", person: { name: "Chuck Norris" }
+delete "/people/1"
+put "/people/1", person: { name: "Jet Li" }
+```
+
+To get the response body from the last request you can call the response_body method, which will return the response body parsed to a HashWithIndifferentAccess. For example:
+
+```ruby
+get "/people/1"
+expect(response_body).to be_eql {person: {name: "Jet Li" }}
+```
+
+You can get the response status code from the last request and do expectations using Heisenberg's status code matchers, as follows:
+
+```ruby
+get "/people/1"
+expect(response_status).to be_successful
+```
+
+Other status code matchers available are:
+
+```ruby
+expect(response_status).to be_successful
+expect(response_status).to be_forbidden
+expect(response_status).to be_bad_request
+expect(response_status).to be_unprocessable_entity
+expect(response_status).to be_created
+expect(response_status).to be_unauthorized
+expect(response_status).to be_server_error
+expect(response_status).to be_not_found
+expect(response_status).to be_no_content
+```
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Added some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/heisenberg.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/heisenberg/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marcello Milhomem Albuquerque"]
+  gem.email         = ["marcello.m.albuquerque@gmail.com"]
+  gem.description   = "Heisenberg is an REST API integration testing tool for rack based REST APIs"
+  gem.summary       = "Heisenberg's goal is to make API integration tests more concise by allowing to spec APIs through a dead simple API"
+  gem.homepage      = "https://github.com/marcelloma/heisenberg"
+  gem.files         = `git ls-files`.split($\)
+  gem.name          = "heisenberg"
+  gem.require_paths = ["lib"]
+  gem.version       = Heisenberg::VERSION
+
+  gem.add_dependency "rack-test", ">= 0.6.2"
+end

data/lib/heisenberg.rb

@@ -0,0 +1,16 @@
+require "rack/test"
+require "heisenberg/hashext"
+require "heisenberg/version"
+require "heisenberg/api_integration_spec"
+
+module Heisenberg
+  if defined? RSpec
+    RSpec.configure do |config|
+      config.include ApiIntegrationSpec,
+        example_group: { file_path: /spec\/rest_apis/ },
+        type: :rest_api
+    end
+
+    require "heisenberg/matchers"
+  end
+end

data/lib/heisenberg/api_integration_spec.rb

@@ -0,0 +1,39 @@
+module Heisenberg
+  module ApiIntegrationSpec
+    extend ActiveSupport::Concern
+
+    included do
+      include Rack::Test::Methods
+      include Rails.application.routes.url_helpers
+
+      metadata[:type] = :rest_api
+
+      Rails.application.routes.default_url_options[:host] = Rack::Test::DEFAULT_HOST
+
+      def app
+        Rails.application
+      end
+
+      def last_response_json
+        parsed_json = JSON.parse(last_response.body)
+        parsed_json = parsed_json.recursive_symbolize_keys if parsed_json.is_a? Hash
+        parsed_json = parsed_json.map(&:recursive_symbolize_keys) if parsed_json.is_a? Array
+        parsed_json
+      end
+
+      def serialize resource, options = {}
+        if resource.is_a? Array
+          array_serializer = options.fetch(:serializer) { ActiveModel::ArraySerializer }
+          array_serializer.new(resource, options).as_json
+        else
+          serializer = options.fetch(:serializer) { resource.active_model_serializer }
+          serializer.new(resource).as_json
+        end
+      end
+
+      before :each do
+        header 'Accept', "application/json"
+      end
+    end
+  end
+end

data/lib/heisenberg/hashext.rb

@@ -0,0 +1,14 @@
+class Hash
+  def recursive_symbolize_keys
+    new_hash = self.dup
+    new_hash.symbolize_keys!
+    new_hash.values.select{ |v| v.is_a?(Hash) }.each &:recursive_symbolize_keys!
+    new_hash.values.select{ |v| v.is_a?(Array) }.each { |h| h.each &:recursive_symbolize_keys! }
+    new_hash
+  end
+
+  def recursive_symbolize_keys!
+    symbolize_keys!
+    values.select{ |v| v.is_a?(Hash) }.each { |h| h.recursive_symbolize_keys! }
+  end
+end

data/lib/heisenberg/matchers.rb

@@ -0,0 +1,27 @@
+http_statuses = {
+  successful:           200,
+  created:              201,
+  no_content:           204,
+  bad_request:          400,
+  unauthorized:         401,
+  unprocessable_entity: 422,
+  forbidden:            403,
+  not_found:            404,
+  server_error:         500,
+}
+
+for status, code in http_statuses
+  eval <<-EOS
+    RSpec::Matchers.define "be_#{status}" do
+
+      match do |actual|
+        actual.to_s == "#{code}"
+      end
+
+      failure_message_for_should do |actual|
+        "Expected " + http_statuses.key(actual).to_s + " to be #{status.to_s}"
+      end
+
+    end
+  EOS
+end

data/lib/heisenberg/version.rb

@@ -0,0 +1,3 @@
+module Heisenberg
+  VERSION = "0.0.4"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heisenberg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -34,7 +34,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- heisenberg.gemspec
+- lib/heisenberg.rb
+- lib/heisenberg/api_integration_spec.rb
+- lib/heisenberg/hashext.rb
+- lib/heisenberg/matchers.rb
+- lib/heisenberg/version.rb
 homepage: https://github.com/marcelloma/heisenberg
 licenses: []
 post_install_message: