rspec-grape 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61834a03e2598768f0724919732a86f1204c997c
-  data.tar.gz: 39a042a5038ec2596505223a3df4017587f7c84a
+  metadata.gz: 344cd46b986acfa1c98f7df3419a1a51864c78c3
+  data.tar.gz: 2afd9b00e7aca8e40e585ec4ed8f91ba699107f7
 SHA512:
-  metadata.gz: 5d1d279c4611105cc38a690606036df67fd8667df68210a1bb508dcfb82e943c27ada97feaf11576549380f7d6341c05d928be8e5ffcccfc40ee9b573ebe2f03
-  data.tar.gz: 7bf5c4314dc0e3ff8e1ea7f06c1962aa5cf5f951d492963fa53e01044a27a98f06cd1c2ec4173fb2f12c19bba76d2951afd62659ca258b130a2b27b822216eaf
+  metadata.gz: fd7def411a10fc6144d71b73e3bdd4f5e8dcac2dfd06870504a576c6b4a0a7ada075de768dd4c0fa4719310abb64bfb8cda02d80cebbab7b33f944d6ab09ae24
+  data.tar.gz: 2d85a9763c394be30c67320ea9e3ed10a0db18cc17c52624f0f28108bb29c29721eb03091e890c681e0659952c83c2e3f5fcfd649051d57550f703206edbd239

data/README.md

@@ -1,4 +1,4 @@
-# Rspec::Grape
+# Rspec::Grape [![Build Status](https://travis-ci.org/ktimothy/rspec-grape.svg?branch=master)](https://travis-ci.org/ktimothy/rspec-grape) [![Gem Version](https://badge.fury.io/rb/rspec-grape.svg)](https://badge.fury.io/rb/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:
 
@@ -87,6 +87,20 @@ 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. You can set parameter values via `:api_params` or expliciltly pass them to helper. 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.
+
 ### 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.
@@ -99,9 +113,6 @@ 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`
 
 ## Development
 

data/lib/rspec/grape/exceptions.rb

@@ -3,5 +3,13 @@ module RSpec
     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

@@ -8,17 +8,39 @@ module RSpec
       end
 
       def api_method
-        api_endpoint_description.split(' ').first.downcase.to_sym
+        @api_method ||= api_endpoint_description.split(' ').first.downcase.to_sym
       end
 
       def api_url
-        api_endpoint_description.split(' ').last
+        @api_url ||= api_endpoint_description.split(' ').last
+      end
+
+      def parameterized_api_url(params = nil)
+        raise RSpec::Grape::UrlIsNotParameterized unless parameterized_url?
+
+        params ||= resolve_params(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 ||= self.respond_to?(:api_params) ? api_params : {}
+        params ||= resolve_params(params)
 
-        self.send(api_method, api_url, 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)
@@ -35,6 +57,14 @@ module RSpec
       def api_endpoint_description
         @api_endpoint_description ||= RSpec::Grape::Utils.find_endpoint_description(self.class)
       end
+
+      def parameterized_url?
+        api_url =~ /\/:/
+      end
+
+      def resolve_params(params = nil)
+        params || self.respond_to?(:api_params) ? api_params : {}
+      end
     end
   end
 end

data/lib/rspec/grape/utils.rb

@@ -2,10 +2,11 @@ module RSpec
   module Grape
     module Utils
       HTTP_METHODS = %w[GET HEAD PUT POST DELETE OPTIONS PATCH LINK UNLINK]
-      REGEXP = /(#{HTTP_METHODS.join('|')}) \/.*/
+      DESCRIPTION_REGEXP = /(#{HTTP_METHODS.join('|')}) \/.*/
+      PARAMS_REGEXP = /(\/:([^\/]*))/
 
       def self.is_description_valid?(description)
-        !!(description =~ REGEXP)
+        !!(description =~ DESCRIPTION_REGEXP)
       end
 
       def self.find_endpoint_description(klass)
@@ -18,6 +19,10 @@ module RSpec
 
         ancestors.last.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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-grape
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Timothy Kovalev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-17 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test