rest_api_builder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ffe941de96bc46453108079ed3dce2d654947b2930f2127c2e18737c9b00199
-  data.tar.gz: 59665b1e50fe3a2ab479d73dd549a2369718f6f2ba7adc02b66399b1a6c32a24
+  metadata.gz: cf07f7e26da929aa46e970e076dc189a744fafcb7cac4ccdc532529d3e6b8dd4
+  data.tar.gz: 192ffc62ea57897d606260b0d255722ce23c624be85dc137efa411a6df77c995
 SHA512:
-  metadata.gz: cf33cca8a23fdfe9302e0fd6e9fabfddb4b67bc73c762f91689f1bf0130d6827c5545f5eb9ee3e4dda639f053fdc07a9ab92c175463b370ee2884e52c6ea3dbe
-  data.tar.gz: 8a70a3bbf1b7cd2c83b5ad65c45b98191a32daf864ac826fa40920f30a4f423169e9bfbadd6896eee2f6796b886f4caeabe65fa90fad834ff8d1b9b7ca574e1b
+  metadata.gz: b28c914cdb039919614d82e108d1413c349e9530a659ed78898b2cbe4e6b182a3ebdc3aa34f5b4383a21d68d827c9e7d7aef93fea97656536cde1197d6815500
+  data.tar.gz: 1560932fb31df12f946b56060a5411e249d19926c287fb561c95e863af1d6be37ff106ce304b6eb8dc34dc7b620ecddb2fd0c2fd7a667a7598cc73e7f33071d1

data/README.md

@@ -84,7 +84,7 @@ response[:status]  #=> 200
 response[:body]    #=> ''
 response[:headers] #=> {}
 
-# Specifying response details
+# Specifying expectation details with WebMock::Request methods
 Expectations
   .expect_execute(base_url: "test.com", method: :get)
   .to_return(status: 404, body: "not found")
@@ -93,6 +93,29 @@ response = Request.execute(base_url: "test.com", method: :get)
 response[:success] #=> false
 response[:status]  #=> 404
 response[:body]    #=> "not found"
+
+# Specifying expectation details with :request and :response options
+Expectations.expect_execute(
+  base_url: "test.com", 
+  method: :post, 
+  response: { body: 'hello' }, 
+  request: { body: WebMock::API.hash_including({foo: "bar"}) }
+)
+response = Request.json_execute(base_url: "test.com", method: :post, body: {foo: "bar"})
+response[:success] #=> true
+response[:body]    #=> 'hello'
+
+Request.json_execute(base_url: "test.com", method: :post, body: {bar: "baz"}) # => Raises WebMock::NetConnectNotAllowedError
+
+# Using #expect_json_execute
+Expectations.expect_json_execute(
+  base_url: "test.com", 
+  method: :get, 
+  response: { body: {hi: 'hello'} }
+)
+response = Request.execute(base_url: "test.com", method: :get)
+response[:success] #=> true
+response[:body]    #=> "{\"hi\":\"hello\"}"
 ```
 
 ## Request API
@@ -127,6 +150,11 @@ Defines a request expectation using WebMock's `stub_request`. Returns an instanc
 * **base_url**: Base URL of the request. Required.
 * **method**: HTTP method of the request(e.g :get, :post, :patch). Required.
 * **path**: Path to be appended to the :base_url. Optional.
+* **request**: request details which will be passed to `WebMock::RequestStub#with` if provided. Optional
+* **response**: response details which will be passed to `WebMock::RequestStub#to_return` if provided. Optional
+
+### RestAPIBuilder::WebMockRequestExpectations.expect_json_execute(options)
+A convenience shortcut for `#json_execute` which will convert `request[:body]` to JSON if it's provided
 
 ## License
 MIT

data/lib/rest_api_builder/webmock_request_expectations.rb

@@ -6,8 +6,21 @@ module RestAPIBuilder
     include WebMock::API
     include RestAPIBuilder::UrlHelper
 
-    def expect_execute(base_url:, method:, path: nil)
-      stub_request(method, full_url(base_url, path))
+    def expect_json_execute(response: nil, **options)
+      if response && response[:body]
+        response = response.merge(body: JSON.generate(response[:body]))
+      end
+
+      expect_execute(**options, response: response)
+    end
+
+    def expect_execute(base_url:, method:, path: nil, request: nil, response: nil)
+      expectation = stub_request(method, full_url(base_url, path))
+
+      expectation.with(request) if request
+      expectation.to_return(response) if response
+
+      expectation
     end
   end
 

data/rest_api_builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rest_api_builder'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.summary     = "A simple wrapper for rest-client"
   s.description = "A simple wrapper for rest-client aiming to make creation and testing of API clients easier."
   s.authors     = ["Alexey D"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_api_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexey D