wt-rspec-grape 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c7ff180932d3ab13b7ce3d2bcf2f83c5e1854b96bc5d449cd96371b662252c2
+  data.tar.gz: 6d30fd19262e4f1b2cfcefd9dfffd5eab343231d647fcb0b7c02255b17d45b25
+SHA512:
+  metadata.gz: 6c43ae2cca1a7e1fd1b09d04f7f93610efc8f6a978d8514ec384c95fc83bf3fe69f25c06e0e52f141fccda5a4151878df2afce836f01a8a58ed99e271cff0343
+  data.tar.gz: 0d849a85b81ecc246ccc72421ad6f852199330123c5e508f435f9d4214ef56eab1ec284b4ac890990c50e929239d216da7fe17fcb713cfd3a906733f203a8b02

data/.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.3']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Timothy Kovalev
+
+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,142 @@
+# Rspec::Grape
+
+Originally a fork of https://github.com/ktimothy/rspec-grape.
+
+This gem is a set of spec helpers, that will help to test [Grape](https://github.com/ruby-grape/grape) APIs easily. The usual approach to test apis, as [official documentation shows](https://github.com/ruby-grape/grape#rspec), is:
+
+```ruby
+context 'GET /api/v1/test' do
+  it 'returns 200' do
+    get '/api/v1/test'
+    expect(last_response.status).to eq(200)
+  end
+end
+```
+
+Here you describe context as `GET /api/v1/test`, then you have to repeat url and method in example: `get '/api/v1/test'`. But what if you don't have to?
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-grape'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-grape
+
+## Usage
+
+### Conventions
+
+Gem's behaviour is based on some conventions:
+* `described_class` should point to your API class
+* examples should be grouped by endpoints
+* group of endpoint specs shoud be described as 'HTTP_METHOD /api/path'
+
+In order to have helpers available in examples, you need to add `type: :api` metadata:
+```ruby
+describe MyAPI, type: :api do
+```
+Or use a symbol:
+```ruby
+describe MyAPI, :api do
+```
+
+### Basic usage
+
+This gem provides the `call_api` helper method. It automatically reads endpoint url and method from context description, allowing you to avoid duplication and write a shorter spec:
+
+```ruby
+context 'GET /api/v1/test' do
+  it 'returns 200' do
+    expect(call_api.status).to eq(200)
+  end
+end
+```
+
+### Passing request params
+
+Params can be passed to `call_api` method:
+
+```ruby
+call_api({foo: :bar})
+```
+
+### Stubbing API helpers
+
+rspec-grape provides two methods to stub API helpers: `expect_endpoint_to` and `expect_endpoint_not_to`. You can easily write:
+
+```ruby
+expect_endpoint_to receive(:help_me)
+expect_endpoint_not_to receive(:dont_help)
+```
+
+Note that under the hood those methods use `Grape::Endpoint.before_each`, as suggested by [documentation](https://github.com/ruby-grape/grape#stubbing-helpers). Thanks to [Jon Rowe](https://github.com/JonRowe) for the idea.
+
+### Inline parameters
+
+When you define some parameters in url like
+```ruby
+get '/url/with/:param'
+```
+you can use `parameterized_api_url` helper to generate full url. Pass parameters as hash. The result will be url with parameter names substituted with actual values:
+```ruby
+parameterized_api_url(param: 'defined') # '/url/with/defined'
+```
+
+If some parameters are not set, method will raise `RSpec::Grape::UrlNotSetException`.
+Note that `call_api` helper will use parameterized_url to generate url to be called.
+
+### Nested descriptions
+
+You may need to define nested descriptions of endpoint when you are using inline url parameters:
+```ruby
+describe 'GET /inline/:param' do
+  describe 'GET /inline/false' do
+    ...
+  end
+
+  describe 'GET /inline/true' do
+    ...
+  end
+end
+```
+
+In this case `api_url` will point to inner description, `/inline/false` and `/inline/true` consequently. If you set all inline parameters in description, there is no need to pass parameters to `call_api`.
+
+### Additional spec helpers
+
+It is also possible to use two methods in your specs: `api_url` and `api_method`. The former returns url from spec description, while the latter returns http method.
+
+You can always use them, as `call_api` methods does:
+
+```ruby
+send(api_method, api_url)
+```
+
+Note that you do not need to `include Rack::Test::Methods` as they are already included by gem.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ktimothy/rspec-grape.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rspec/grape/exceptions.rb

@@ -0,0 +1,15 @@
+module RSpec
+  module Grape
+    class NoEndpointDescription < StandardError
+      def message; 'Endpoint description like \'METHOD /path/to/endpoint\' is not found!'; end
+    end
+
+    class UrlParameterNotSet < StandardError
+      def message; 'Url parameter is not defined!'; end
+    end
+
+    class UrlIsNotParameterized < StandardError
+      def message; 'Url has no parameters'; end
+    end
+  end
+end

data/lib/rspec/grape/methods.rb

@@ -0,0 +1,66 @@
+module RSpec
+  module Grape
+    module Methods
+      include Rack::Test::Methods
+
+      def app
+        self.described_class
+      end
+
+      def api_method
+        @api_method ||= api_endpoint_description.split(' ').first.downcase.to_sym
+      end
+
+      def api_url
+        @api_url ||= api_endpoint_description.split(' ').last
+      end
+
+      def parameterized_api_url(params = nil)
+        raise RSpec::Grape::UrlIsNotParameterized unless parameterized_url?
+
+        params ||= {}
+
+        url = api_url.dup
+        names = RSpec::Grape::Utils.url_param_names(api_url)
+        names.each do |name|
+          raise RSpec::Grape::UrlParameterNotSet unless params.has_key?(name.to_sym)
+
+          url[":#{name}"] = params[name].to_s
+        end
+
+        url
+      end
+
+      def call_api(params = nil)
+        params ||= {}
+
+        if parameterized_url?
+          url = parameterized_api_url(params)
+        else
+          url = api_url
+        end
+
+        self.send(api_method, url, params)
+      end
+
+      def expect_endpoint_to(matcher)
+        ::Grape::Endpoint.before_each { |endpoint| expect(endpoint).to matcher }
+      end
+
+      def expect_endpoint_not_to(matcher)
+        ::Grape::Endpoint.before_each { |endpoint| expect(endpoint).not_to matcher }
+      end
+
+
+      private
+
+      def api_endpoint_description
+        @api_endpoint_description ||= RSpec::Grape::Utils.find_endpoint_description(self.class)
+      end
+
+      def parameterized_url?
+        api_url =~ /\/:/
+      end
+    end
+  end
+end

data/lib/rspec/grape/utils.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Grape
+    module Utils
+      HTTP_METHODS = %w[GET HEAD PUT POST DELETE OPTIONS PATCH LINK UNLINK]
+      DESCRIPTION_REGEXP = /(#{HTTP_METHODS.join('|')}) \/.*/
+      PARAMS_REGEXP = /(\/:([^\/]*))/
+
+      def self.is_description_valid?(description)
+        !!(description =~ DESCRIPTION_REGEXP)
+      end
+
+      def self.find_endpoint_description(klass)
+        ancestors = klass.ancestors.select { |a| a < RSpec::Core::ExampleGroup }
+        ancestors = ancestors.select do |a|
+          is_description_valid?(a.description)
+        end
+
+        raise RSpec::Grape::NoEndpointDescription unless ancestors.any?
+
+        ancestors.first.description
+      end
+
+      def self.url_param_names(url)
+        url.scan(PARAMS_REGEXP).map { |a| a[1].to_sym }
+      end
+    end
+  end
+end

data/lib/rspec/grape/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Grape
+    VERSION = "0.0.5"
+  end
+end

data/lib/wt-rspec-grape.rb

@@ -0,0 +1,18 @@
+require 'rspec/core'
+require 'rack/test'
+
+require 'rspec/grape/exceptions'
+require 'rspec/grape/utils'
+require 'rspec/grape/methods'
+
+RSpec.configure do |config|
+  config.include RSpec::Grape::Methods, type: :api
+  config.include RSpec::Grape::Methods, :api
+
+  after = Proc.new do
+    ::Grape::Endpoint.before_each nil
+  end
+
+  config.after(:each, :api, &after)
+  config.after(:each, type: :api, &after)
+end

data/rspec-grape.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/grape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wt-rspec-grape"
+  spec.version       = Rspec::Grape::VERSION
+  spec.authors       = ["Ivan Tarapon"]
+  spec.email         = ["ivan.tarapon@wetravel.com"]
+
+  spec.summary       = %q{A set of helpers, which make grape api specs shorter.}
+  spec.homepage      = "https://github.com/wetravel-com/rspec-grape"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rack-test", "~> 2.0"
+  spec.add_runtime_dependency "rspec-core", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "grape"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: wt-rspec-grape
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Ivan Tarapon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- ivan.tarapon@wetravel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/grape/exceptions.rb
+- lib/rspec/grape/methods.rb
+- lib/rspec/grape/utils.rb
+- lib/rspec/grape/version.rb
+- lib/wt-rspec-grape.rb
+- rspec-grape.gemspec
+homepage: https://github.com/wetravel-com/rspec-grape
+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: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A set of helpers, which make grape api specs shorter.
+test_files: []