rspec-request_describer 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7860d4f2fb580876b71c84c3c4b84f844644af11
-  data.tar.gz: c9e1bf92c070cdaa7b4b76c30cb31459b11bc54f
+SHA256:
+  metadata.gz: f663222473fe59484bc2e7b66a12a0f00edbd594fe8c7213b25e65c09e301b5e
+  data.tar.gz: ff27bc035f85f243c1fbd9724f215329b700cabb963e99a23d3a795226c5d868
 SHA512:
-  metadata.gz: a64cf031ee613b3c12080fcda4b927c3f8ae9fd3f678aa54c53c106b2965c062198d5996a64aca08dc949b50ce1bbf58f578dd5c5dbfba4821df8dbda5dbb2c5
-  data.tar.gz: b0adab9b3884366e6024bacfbd3b6d2ea4a5d1671a7eb3963344294ecc734aa6c991217ab5db9cb6eec1dbc85d7ebd775275710320052392e9ca115d53873c5d
+  metadata.gz: f4f0580c22c26f5c1d3ce15f7f14d7e24fba46bfb7b471b5d84c7d634965f5d981e467740e1484e6bfc5a081176439e0e608fcd151de317c673c8870e9d7c535
+  data.tar.gz: 219b07cde7c240ba1a2b42cb5ba433c7fec176f5bc32397ca09389dd774a3b214539f5e35d03410b0a9bdeb902fe339c2513aa2a7696fc46f8b14bd103a43db9

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  rspec:
+    uses: r7kamura/workflows/.github/workflows/ruby-rspec.yml@main
+    with:
+      ruby-version: 2.7.4
+  rubocop:
+    uses: r7kamura/workflows/.github/workflows/ruby-rubocop.yml@main
+    with:
+      ruby-version: 2.7.4

data/.gitignore

@@ -1,14 +1,11 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,45 +1,115 @@
-## v0.2.2
+# Changelog
 
-- Fix bug: Ignore case-sensitivity of HTTP headers (Thx @k5trismegistus, #14)
+## Unreleased
 
-## 0.2.1
+## 0.4.0 - 2023-07-10
 
-- Fix error from `#process`
+### Added
 
-## 0.2.0
+- Support HEAD HTTP method.
 
-- Support actionpack 5.1.0
-- Dependent on actionpack
+## 0.3.2 - 2020-02-15
 
-## 0.1.1
-- Prevent warning for Rails 5  (Thx @mrkn, #9)
+### Removed
 
-## 0.1.0
-- Rename `method` with `http_method` (Thx @yujinakayama, #8)
+- Remove runtime gem dependency on actionpack.
 
-## 0.0.9
-- Ignore case-sensivity on Content-Type checking
+## 0.3.1 - 2019-05-08
 
-## 0.0.8
-- Use more sophisticated method capture pattern
+### Fixed
 
-## 0.0.7
-- Add `send_request` to explicitly call `subject` (Thx @lazywei)
+- Fix env calculation timing.
 
-## 0.0.6
-- Allow any non-space characters in URL path
+## 0.3.0 - 2019-05-05
 
-## 0.0.5
-- Allow hyphen in path
+### Added
 
-## 0.0.4
-- Define HTTPS as reserved header name
+- Support symbol keys in request headers.
 
-## 0.0.3
-- Remove dependency on ActiveSupport's `Object#in?`
+## 0.2.2 - 2018-05-13
 
-## 0.0.2
-- Support RSpec 3
+### Fixed
 
-## 0.0.1
-- 1st Release
+- Fix bug: Ignore case-sensitivity of HTTP headers.
+
+## 0.2.1 - 2017-02-27
+
+### Fixed
+
+- Fix error from `#process`.
+
+## 0.2.0 - 2017-02-27
+
+### Added
+
+- Support actionpack 5.1.0.
+
+### Changed
+
+- Declare runtime dependency on actionpack.
+
+## 0.1.1 - 2016-05-15
+
+### Fixed
+
+- Prevent warning for Rails 5.
+
+## 0.1.0 - 2015-10-09
+
+### Changed
+
+- Rename `method` with `http_method`.
+
+## 0.0.9 - 2015-06-24
+
+### Changed
+
+- Ignore case-sensivity on Content-Type checking.
+
+## 0.0.8 - 2015-05-20
+
+### Changed
+
+- Use more sophisticated method capture pattern.
+
+## 0.0.7 - 2015-04-20
+
+### Added
+
+- Add `send_request` to explicitly call `subject`.
+
+## 0.0.6 - 2015-02-12
+
+### Fixed
+
+- Allow any non-space characters in URL path.
+
+## 0.0.5 - 2014-12-25
+
+### Fixed
+
+- Allow hyphen in path.
+
+## 0.0.4 - 2014-12-18
+
+### Added
+
+- Define HTTPS as reserved header name.
+
+## 0.0.3 - 2014-10-13
+
+### Removed
+
+- Remove dependency on ActiveSupport's `Object#in?`.
+
+## 0.0.2 - 2014-09-25
+
+### Added
+
+- Support RSpec 3.
+
+## 0.0.1 - 2014-08-29
+
+### Added
+
+- 1st Release.

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-request_describer.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rspec-request_describer (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  rspec-request_describer!
+  rubocop
+
+BUNDLED WITH
+   2.2.29

data/README.md

@@ -1,88 +1,132 @@
 # RSpec::RequestDescriber
-Force some rules to write self-documenting request spec.
+
+[![test](https://github.com/r7kamura/rspec-request_describer/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rspec-request_describer/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/rspec-request_describer.svg)](https://rubygems.org/gems/rspec-request_describer)
+
+An RSpec plugin to write self-documenting request-specs.
+
+This gem is designed for:
+
+- [rack-test](https://github.com/rack-test/rack-test)
+- [rspec-rails](https://github.com/rspec/rspec-rails)
 
 ## Setup
-Add `rspec-request_describer` into your Gemfile, then run `bundle install`.
+
+### Install
+
+Add this line to your application's Gemfile:
 
 ```ruby
-# Gemfile
-gem "rspec-request_describer"
+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"
+And then execute:
+
+```
+bundle
 ```
 
-Then include `RSpec::RequestDescriber` into your `RSpec.configuration`.
+Or install it yourself as:
+
+```
+gem install rspec-request_describer
+```
+
+### Include
+
+Include `RSpec::RequestDescriber` to your example groups like this:
 
 ```ruby
-# spec/spec_helper.rb
-RSpec.configuration.include RSpec::RequestDescriber, type: :request
+require 'rspec/request_describer'
+
+RSpec.configure do |config|
+  config.include RSpec::RequestDescriber, type: :request
+end
 ```
 
 ## Usage
-RSpec::RequestDescriber provides some `subject` and `let` to your specs.
+
+Note that this is an example in a Rails app.
 
 ### subject
-In the example below, the `subject` calls an HTTP request of GET /users,
-then returns its status code.
+
+`RSpec::RequestDescriber` provides `subject` from its top-level description.
 
 ```ruby
-describe "GET /users" do
-  it { should == 200 }
+# subject will be `get('/users')`.
+RSpec.describe 'GET /users' do
+  it 'returns 200' do
+    subject
+    expect(response).to have_http_status(200)
+  end
 end
 ```
 
 ### headers
-`headers` is provided to modify request headers.
-In the below example, a token is added into Authorization request header.
 
+If you want to modify request headers, change `headers` before calling `subject`.
 
 ```ruby
-describe "GET /users" do
-  context "with Authorization header" do
+# `subject` will be `get('/users', headers: { 'Authorization' => 'token 12345' })`.
+RSpec.describe 'GET /users' do
+  context 'with Authorization header' do
     before do
-      headers["Authorization"] = "token 12345"
+      headers['Authorization'] = 'token 12345'
+    end
+
+    it 'returns 200' do
+      subject
+      expect(response).to have_http_status(200)
     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.
+
+If you want to modify request parameters, change `params` before calling `subject`.
 
 ```ruby
-describe "GET /users" do
-  context "with sort parameter" do
+# `subject` will be `get('/users', params: { 'sort' => 'id' })`.
+RSpec.describe 'GET /users' do
+  context 'with sort parameter' do
     before do
-      params["sort"] = "id"
+      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
+    it 'returns 200 with expected JSON body' do
+      subject
+      expect(response).to have_http_status(200)
+      expect(response.parsed_body).to match(
+        [
+          hash_including('id' => 1),
+          hash_including('id' => 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.
+### path parameters
+
+You can embed variables in URL path like `/users/:user_id`.
+In this example, the returned value of `user_id` method will be emobeded as its real value.
 
 ```ruby
-describe "GET /users/:id" do
-  let(:id) do
-    User.create(name: "alice").id
+# `subject` will be `get("/users/#{user_id}")`.
+RSpec.describe 'GET /users/:user_id' do
+  let(:user) do
+    User.create(name: 'alice')
+  end
+
+  let(:user_id) do
+    user.id
+  end
+
+  it 'returns 200' do
+    subject
+    expect(response).to have_http_status(200)
   end
-  it { should == 200 }
 end
 ```

data/Rakefile

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

data/lib/rspec/request_describer/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module RequestDescriber
-    VERSION = "0.2.2"
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/rspec/request_describer.rb

@@ -1,20 +1,21 @@
-require "rspec/request_describer/version"
+require 'rspec/request_describer/version'
 
 module RSpec
   module RequestDescriber
-    RESERVED_HEADER_NAMES = %w(
+    RESERVED_HEADER_NAMES = %w[
       content-type
       host
       https
-    )
+    ].freeze
 
-    SUPPORTED_METHODS = %w(
+    SUPPORTED_METHODS = %w[
       DELETE
       GET
+      HEAD
       PATCH
       POST
       PUT
-    )
+    ].freeze
 
     class << self
       def included(base)
@@ -28,15 +29,17 @@ module RSpec
               http_method,
               path,
               headers: env,
-              params: request_body,
+              params: request_body
             )
           end
 
           let(:request_body) do
-            if headers.any? { |key, value| key.downcase == "content-type" && value == "application/json" }
+            if headers.any? { |key, value| key.to_s.casecmp('content-type').zero? && value == 'application/json' }
               params.to_json
             else
-              params
+              params.inject({}) do |result, (key, value)|
+                result.merge(key.to_s => value)
+              end
             end
           end
 
@@ -50,8 +53,9 @@ module RSpec
 
           let(:env) do
             headers.inject({}) do |result, (key, value)|
-              key = "HTTP_" + key unless RESERVED_HEADER_NAMES.include?(key.downcase)
-              key = key.gsub("-", "_").upcase
+              key = key.to_s
+              key = 'HTTP_' + key unless RESERVED_HEADER_NAMES.include?(key.downcase)
+              key = key.tr('-', '_').upcase
               result.merge(key => value)
             end
           end
@@ -67,7 +71,7 @@ module RSpec
           end
 
           let(:path) do
-            endpoint_segments[2].gsub(/:(\w+[!?=]?)/) { send($1) }
+            endpoint_segments[2].gsub(/:(\w+[!?=]?)/) { send(Regexp.last_match(1)) }
           end
         end
       end

data/rspec-request_describer.gemspec

@@ -1,23 +1,18 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $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.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.authors       = ['Ryo Nakamura']
+  spec.email         = ['r7kamura@gmail.com']
+  spec.summary       = 'An RSpec plugin to write self-documenting request-specs.'
+  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_dependency "actionpack", ">= 5.0.0"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.require_paths = ['lib']
 end

data/spec/rspec/request_describer_spec.rb

@@ -0,0 +1,141 @@
+require 'openssl'
+
+RSpec.describe RSpec::RequestDescriber do
+  include RSpec::RequestDescriber
+
+  def get(*args)
+    [__method__, *args]
+  end
+
+  describe 'GET /users' do
+    it 'calls #get' do
+      is_expected.to eq(
+        [
+          :get,
+          '/users',
+          headers: {},
+          params: {}
+        ]
+      )
+    end
+
+    context 'with headers' do
+      let(:headers) do
+        super().merge('Authorization' => 'token 12345')
+      end
+
+      it 'calls #get with HTTP_ prefixed and upper-cased headers' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: { 'HTTP_AUTHORIZATION' => 'token 12345' },
+            params: {}
+          ]
+        )
+      end
+    end
+
+    context 'with headers including reserved header name' do
+      let(:headers) do
+        super().merge('Https' => 'on')
+      end
+
+      it 'calls #get with headers with non HTTP_ prefixed and upper-cased headers' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: { 'HTTPS' => 'on' },
+            params: {}
+          ]
+        )
+      end
+    end
+
+    context 'with symbolized keys headers' do
+      let(:headers) do
+        super().merge(AUTHORIZATION: 'token 12345')
+      end
+
+      it 'calls #get with HTTP_ prefixed and stringified keys headers' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: { 'HTTP_AUTHORIZATION' => 'token 12345' },
+            params: {}
+          ]
+        )
+      end
+    end
+
+    context 'with headers including request body' do
+      before do
+        headers['X-Signature'] = "sha1=#{OpenSSL::HMAC.hexdigest('SHA1', 'secret', request_body.to_s)}"
+      end
+
+      it 'calls #get with HTTP_ prefixed and stringified keys headers' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: { 'HTTP_X_SIGNATURE' => 'sha1=5d61605c3feea9799210ddcb71307d4ba264225f' },
+            params: {}
+          ]
+        )
+      end
+    end
+
+    context 'with params' do
+      let(:params) do
+        super().merge('sort' => 'id')
+      end
+
+      it 'calls #get with params' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: {},
+            params: { 'sort' => 'id' }
+          ]
+        )
+      end
+    end
+
+    context 'with symbolized keys params' do
+      let(:params) do
+        super().merge(sort: 'id')
+      end
+
+      it 'calls #get with stringified keys params' do
+        is_expected.to eq(
+          [
+            :get,
+            '/users',
+            headers: {},
+            params: { 'sort' => 'id' }
+          ]
+        )
+      end
+    end
+  end
+
+  describe 'GET /users/:user_id' do
+    let(:user_id) do
+      1
+    end
+
+    it 'calles #get with embeded variable in URL path' do
+      is_expected.to eq(
+        [
+          :get,
+          '/users/1',
+          headers: {},
+          params: {}
+        ]
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec/request_describer'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_describer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !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'
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - r7kamura@gmail.com
@@ -59,15 +17,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec/request_describer.rb
 - lib/rspec/request_describer/version.rb
 - rspec-request_describer.gemspec
+- spec/rspec/request_describer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rspec-request_describer
 licenses:
 - MIT
@@ -87,9 +51,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: Force some rules to write self-documenting request spec.
-test_files: []
+summary: An RSpec plugin to write self-documenting request-specs.
+test_files:
+- spec/rspec/request_describer_spec.rb
+- spec/spec_helper.rb