rest_api_builder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0a07766b5d80c9e2913f70d5004cf946a3c01eb08ea9f43f4c36961122f441
-  data.tar.gz: 7be95767413d7fa4ce3f881282ff75b1c575353ef9fe5522e85c6936eac5d303
+  metadata.gz: dd44f147795470f5d2665d31c027f845fccf9430e925fbae1a2e070037637f8a
+  data.tar.gz: 8f9a34b3768349a1e8ec837cd2739b6c997766adee3910a6d7518084eed6e13d
 SHA512:
-  metadata.gz: 45531bd762b6039b93f63306be50ada5b880099e04f1c9c59ffbbbca457b790fc2b3f032899b9dfdd65b469e7be319b052d8b024f035d2f0dd82e5e44dc96a1a
-  data.tar.gz: b75b1bfc01db61ebd28bc50200a0ec3c18f487819515e9cf558db7f4411fdd4a58d5039addaab209ba2896ba48160e2439a0f9fb6c4aa90c0b6af32780bd02f4
+  metadata.gz: 23e78a1b9a9e16c120515e389857366b3093ba776b2c329610fa3ef684d302dce82ca5018476ca3381b4edd5fc4cf9c31532e715fa34f347ae30822170f0ea60
+  data.tar.gz: fde6a4d5c6fb9fcbb3caeba61720b68f0867492052d566370488f706ec199eef0759937e3ae10e4efa9074a497ee666c85c1c365f49c37732bcfe2e342639f06

data/README.md

@@ -132,9 +132,9 @@ Expectations.expect_execute(
   base_url: "test.com", 
   method: :post, 
   response: { body: 'hello' }, 
-  request: { body: WebMock::API.hash_including({foo: "bar"}) }
+  request: { body: { foo: "bar" } } # body will be matched partially using hash_including matcher
 )
-response = my_request.json_execute(base_url: "test.com", method: :post, body: {foo: "bar"})
+response = my_request.json_execute(base_url: "test.com", method: :post, body: { foo: "bar", bar: "baz" })
 response[:success] #=> true
 response[:body]    #=> 'hello'
 
@@ -184,13 +184,13 @@ Returns ruby hash with `:success` and `:raw_response` keys.
 
 ## WebMockRequestExpectations API
 ### RestAPIBuilder::WebMockRequestExpectations.expect_execute(options)
-Defines a request expectation using WebMock's `stub_request`. Returns an instance of `WebMock::RequestStub` on which methods such as `with`, `to_return`, `to_timeout` can be called
+Defines a request expectation using WebMock's `stub_request`. Returns an instance of `WebMock::RequestStub` on which methods such as `with`, `to_return`, `to_timeout` can be called.
 
 #### Options:
 * **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
+* **request**: request details which will be passed to `WebMock::RequestStub#with` if provided. If `query` or `body` keys are present and are hashes, they will be converted into WebMock's `hash_including` matcher. Optional
 * **response**: response details which will be passed to `WebMock::RequestStub#to_return` if provided. Optional
 
 ### RestAPIBuilder::WebMockRequestExpectations.expect_json_execute(options)

data/lib/rest_api_builder/webmock_request_expectations.rb

@@ -17,11 +17,27 @@ module RestAPIBuilder
     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
+      if !request.nil? && request.any?
+        add_request_expectations(expectation, request)
+      end
+
       expectation.to_return(response) if response
 
       expectation
     end
+
+    def add_request_expectations(expectation, request)
+      if request[:body].is_a?(Hash)
+        request = request.merge(body: hash_including(request[:body]))
+      end
+
+      if request[:query].is_a?(Hash)
+        query = request[:query].transform_values(&:to_s)
+        request = request.merge(query: hash_including(query))
+      end
+
+      expectation.with(request)
+    end
   end
 
   WebMockRequestExpectations = WebMockRequestExpectationsSingleton.new

data/rest_api_builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rest_api_builder'
-  s.version     = '0.1.0'
+  s.version     = '0.1.1'
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_api_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexey D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -86,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for rest-client