Added client testing docs #79
Conversation
README.md
Outdated
| @@ -389,6 +389,61 @@ describe App do | |||
| end | |||
| ``` | |||
|
|
|||
| In order to test the client side `stub_request` with Webmock. | |||
There was a problem hiding this comment.
Building on the above, I think this part should say ...
In order to stub the response to actual queries, dump the schema into a JSON file and specify it via schema_path as follows.
# your exampleNow the first note is taken care by the intro, and the second note is unrelated here - I think if we're going to describe what happens in camel case vs. underscore it should be its own section and we need to show where this happens and why.
There was a problem hiding this comment.
Auto camelCase <-> snake-case happens in graphq-ruby
README.md
Outdated
| ) | ||
| end | ||
|
|
||
| it 'responds ok when querying data' do |
There was a problem hiding this comment.
it returns the expected data, not just responds ok
README.md
Outdated
| @@ -389,6 +389,61 @@ describe App do | |||
| end | |||
| ``` | |||
|
|
|||
| In order to test the client side `stub_request` with Webmock. | |||
There was a problem hiding this comment.
Auto camelCase <-> snake-case happens in graphq-ruby
|
Updated the docs and added the example as a working test. |
| require 'spec_helper' | ||
|
|
||
| describe 'App' do | ||
| include_context 'Dummy Client' |
There was a problem hiding this comment.
I think this is unnecessary/potentially misleading.
I believe you only need this:
include Rack::Test::MethodsCheck and also match in the docs?
|
|
||
| ```ruby | ||
| describe App do | ||
| let(:url) { 'http://graph.biz/graphql' } |
There was a problem hiding this comment.
I think you need include Rack::Test::Methods as well.
There was a problem hiding this comment.
include Rack::Test::Methods is not necessary when using rspec and webmock. That's the reason the test work in the suite. Including it will lead to confusion as users may think that is required in order to work.
|
One more fix regarding the test methods, please. If you feel like it, since this is a schema for an invoice API, maybe rename |
|
Updated PR with requested changes |
|
Merged, thank you! |
After a couple of days struggling to test the client side with webmock, I decided to share the solution as the original docs lacks of this information.
Hope this helps other users!