rspec-grape 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce1c2bd204c85ed12e3882ec9dae4fef40b3564a
-  data.tar.gz: 6bfef25db90716def3574f63c8f5037512e76610
+  metadata.gz: 61834a03e2598768f0724919732a86f1204c997c
+  data.tar.gz: 39a042a5038ec2596505223a3df4017587f7c84a
 SHA512:
-  metadata.gz: b972ea8f1a983a193b72eb42cc78c320aff74c256cb55d55eafe1c585b9cc936e55e57ebf742ad5a9123d9fb23ad41b055c9f7cd9cec127d2e6285565cd0efde
-  data.tar.gz: 99b912315880faca5b9fdf3585d3911539c415a1d7b098e57cb393c2ed9dd15f3caeb4da1108647f3e97fac3dd6351726b5f2eec2dfcfe9bdb93c537949d82d5
+  metadata.gz: 5d1d279c4611105cc38a690606036df67fd8667df68210a1bb508dcfb82e943c27ada97feaf11576549380f7d6341c05d928be8e5ffcccfc40ee9b573ebe2f03
+  data.tar.gz: 7bf5c4314dc0e3ff8e1ea7f06c1962aa5cf5f951d492963fa53e01044a27a98f06cd1c2ec4173fb2f12c19bba76d2951afd62659ca258b130a2b27b822216eaf

data/README.md

@@ -2,7 +2,7 @@
 
 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'
@@ -39,11 +39,20 @@ Gem's behaviour is based on some conventions:
 * 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)
@@ -55,18 +64,28 @@ end
 
 Params can be either passed to `call_api` method:
 
-```
+```ruby
 call_api({foo: :bar})
 ```
 
 or set via `let`:
 
-```
+```ruby
 let(:api_params) { { foo: :bar } }
 ```
 
 Note, that params, explicitly passed to `call_api`, have precendence over thoose set in `api_params`.
 
+### 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.
 
 ### Additional spec helpers
 
@@ -74,14 +93,15 @@ It is also possible to use two methods in your specs: `api_url` and `api_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.
+
 ## TODO
 
 * Support urls with params: `/api/test/:id`
-* Provide `api_helpers` for easier helpers stubbing [see](https://github.com/ruby-grape/grape#stubbing-helpers)
 
 ## Development
 

data/lib/rspec-grape.rb

@@ -8,4 +8,11 @@ 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/lib/rspec/grape/methods.rb

@@ -21,6 +21,15 @@ module RSpec
         self.send(api_method, api_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

data/lib/rspec/grape/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Grape
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/rspec-grape.gemspec

@@ -14,8 +14,6 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rack-test", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-grape
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Timothy Kovalev
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -108,8 +108,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/rspec-grape.rb
 - lib/rspec/grape/exceptions.rb
 - lib/rspec/grape/methods.rb

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rspec/grape"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here