rspec-request_describer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ca21c6862e6856b379b8ccacd6279d5b40f89bb
+  data.tar.gz: 8afcab50af6f8ce460b5ba4fbc5fc3a3c22f876e
+SHA512:
+  metadata.gz: 710cee94beebe0c190845b52abdb412937942608c622dbe182239e1ef03fd3b2447747dc9a0d4e938bfb6bc98b2f01232f08177a5cfeb779ebd43aeb3f202c4c
+  data.tar.gz: 7756bb744d9b772e1da7aef87693d557b09dec428c790491a6e28d1565df77cb939077deabc74d0971c43f1ec6683afc7f53ea7c74b16d70c6239c7ef674671e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-request_describer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+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,88 @@
+# RSpec::RequestDescriber
+Force some rules to write self-documenting request spec.
+
+## Setup
+Add `rspec-request_describer` into your Gemfile, then run `bundle install`.
+
+```ruby
+# Gemfile
+gem "rspec-request_describer"
+
+# rspec-request_describer depends on some methods of rspec-rails (or rack-test),
+# so you may need to add it unless you haven't do it yet.
+gem "rspec-rails" # or "rack-test"
+```
+
+Then include `RSpec::RequestDescriber` into your `RSpec.configuration`.
+
+```ruby
+# spec/spec_helper.rb
+RSpec.configuration.include RSpec::RequestDescriber
+```
+
+## Usage
+RSpec::RequestDescriber provides some `subject` and `let` to your specs.
+
+### subject
+In the example below, the `subject` calls an HTTP request of GET /users,
+then returns its status code.
+
+```ruby
+describe "GET /users" do
+  it { should == 200 }
+end
+```
+
+### headers
+`headers` is provided to modify request headers.
+In the above example, a token is added into Authorization request header.
+
+
+```ruby
+describe "GET /users" do
+  context "with Authorization header" do
+    before do
+      headers["Authorization"] = "token 12345"
+    end
+    it { should == 200 }
+  end
+end
+```
+
+### params
+You can also pass query parameter or request body by modifying `params`.
+In the this example, `?sort=id` is added into URL query string.
+For GET request `params` is converted into URL query string,
+while it's converted into request body for the other methods
+.
+Note that if you specified `application/json` Content-Type request header,
+`params` would be encoded into JSON format.
+
+```ruby
+describe "GET /users" do
+  context "with sort parameter" do
+    before do
+      params["sort"] = "id"
+    end
+
+    it "returns users in ID order" do
+      users = JSON.parse(response.body)
+      users[0].id.should == 1
+      users[1].id.should == 2
+    end
+  end
+end
+```
+
+### variable
+You can use variables in URL path like `:id`.
+In this example, the returned value of `id` method is used as its real value.
+
+```ruby
+describe "GET /users/:id" do
+  let(:id) do
+    User.create(name: "alice").id
+  end
+  it { should == 200 }
+end
+```

data/Rakefile

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

data/lib/rspec/request_describer/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module RequestDescriber
+    VERSION = "0.0.1"
+  end
+end

data/lib/rspec/request_describer.rb

@@ -0,0 +1,62 @@
+require "rspec/request_describer/version"
+
+module RSpec
+  module RequestDescriber
+    RESERVED_HEADER_NAMES = %w(
+      Content-Type
+      Host
+    )
+
+    SUPPORTED_METHODS = %w(
+      GET
+      POST
+      PUT
+      PATCH
+      DELETE
+    )
+
+    def self.included(base)
+      base.instance_eval do
+        subject do
+          send method, path, request_body, env
+        end
+
+        let(:request_body) do
+          if headers["Content-Type"] == "application/json"
+            params.to_json
+          else
+            params
+          end
+        end
+
+        let(:headers) do
+          {}
+        end
+
+        let(:params) do
+          {}
+        end
+
+        let(:env) do
+          headers.inject({}) do |result, (key, value)|
+            key = "HTTP_" + key unless key.in?(RESERVED_HEADER_NAMES)
+            key = key.gsub("-", "_").upcase
+            result.merge(key => value)
+          end
+        end
+
+        let(:endpoint_segments) do
+          example.full_description.match(/(#{SUPPORTED_METHODS.join("|")}) ([\/a-z0-9_:]+)/).to_a
+        end
+
+        let(:method) do
+          endpoint_segments[1].downcase
+        end
+
+        let(:path) do
+          endpoint_segments[2].gsub(/:([^\s\/]+)/) { send($1) }
+        end
+      end
+    end
+  end
+end

data/rspec-request_describer.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/request_describer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-request_describer"
+  spec.version       = RSpec::RequestDescriber::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Force some rules to write self-documenting request spec."
+  spec.homepage      = "https://github.com/r7kamura/rspec-request_describer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rspec-request_describer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/request_describer.rb
+- lib/rspec/request_describer/version.rb
+- rspec-request_describer.gemspec
+homepage: https://github.com/r7kamura/rspec-request_describer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Force some rules to write self-documenting request spec.
+test_files: []
+has_rdoc: