ryquest 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32ac1fdb4ae871b7e52a0df4179d982cc3a9a8bd8bc6bac8e7ea17b2858a81c
-  data.tar.gz: 80cf2f367cf8b5f321891be62fe74386f74c53b48af98309442c422e9f7c0b23
+  metadata.gz: 2a77be824e336c393322a2ca0612d66a2a422ec2188bc8e9c69843f7679ac845
+  data.tar.gz: a2b08ab7d1dd13480fee42dbadeeb0bdecf4fa4879f29f45adeb35cb09581462
 SHA512:
-  metadata.gz: '0415958de921a0769182be9f4fa46b13937203818b88b688d8099ad744f2ad5b0da24cd00f9db2349503badb65b33daf7c50aa3f05ebc97ce80e59d872f829ec'
-  data.tar.gz: b2a4c736dc8c802ed6d482a6ace36dc7cd2f2a01b2c374a9b6d93f94265e4fedd938f926d975a0750bf087a7116d395719c46ff8ea5a441847eb277cf3aae2a8
+  metadata.gz: ec077bc542b01e5d8f32761bd07a4b5c14d9dbe93ba8ca2bab9199caecc0e6d651c83aa37fe1d25463ad56afb0e1935c07c876a0925afdc22adbcbb4beed6f2e
+  data.tar.gz: ba2cb2a88461ae68c648a6e217e4ca70133687248ed30b68fc1c67478f44d60f48595e8c4dd45146dd034019b73ec02f07ade4972a378bfe1b2cc05d658c8ea2

data/README.md

@@ -95,6 +95,9 @@ To use specific headers and params with `response!`, put their value in `let` va
   end
 ```
 
+Params are converted by default to form-urlencoded format.
+`Ryquest.configuration.content_type` can change this behaviour.
+
 ### With route parameters
 
 `response!` handle route parameters by looking for a `let` variable with the same parameter name.
@@ -133,3 +136,15 @@ To use specific headers and params with `response!`, put their value in `let` va
       end
     end
   ```
+
+### Configuration
+
+Configuration can be change with `Ryquest.configuration` or `Ryquest.configure` method.
+
+* `content_type` change how params are converted and sent. Note that it can change CONTENT_TYPE header
+  * `:form` (default value) convert to form-urlencoded
+  * `:json` convert to JSON, change CONTENT-TYPE to application/json
+
+### TODO
+
+* Permit to pass params and headers into response rather than update params directly

data/lib/ryquest/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ryquest
+  # Hold / handle writable configuration variables
+  # @attr content_type [Symbol] Must be :form or :json.
+  #   Define in which format response! send data. Accepted value:
+  #   * :form (default) - x-www-form-urlencoded
+  #   * :json - JSON (only affect post, put, patch))
+  #   Note that the value will affect CONTENT-TYPE header
+  class Configuration
+    attr_reader :content_type
+
+    def content_type= value
+      raise ArgumentError, 'content_type configuration value must be form or json' if %i[form json].exclude? value
+
+      @content_type = value
+    end
+
+    # Define default configuration value
+    def initialize
+      @content_type = :form
+    end
+  end
+end

data/lib/ryquest/context.rb

@@ -0,0 +1,79 @@
+# Context to include to get request DSL improvment
+RSpec.shared_context 'ryquest helper' do # rubocop:disable Metrics/BlockLength
+  let(:headers) { nil }
+  let(:params) { nil }
+
+  # Execute request described in example description and return #response value.
+  # Example description must be formated as: "VERB /path".
+  #
+  # Request will not be launch if it not exist or response already have a value.
+  #
+  # VERB can be: GET, POST, PUT, PATCH, DELETE
+  #
+  # To add specific body or headers define them with `let(:headers/:params) { { key: :value } }
+  #
+  # Params path can be send as: 'VERB /path/:param',
+  # :param will be replaced by `param` value (let, method, ...) or their `id` value.
+  #
+  # @return [ActionDispatch::TestResponse] the #response value
+  def response!
+    match = match_verb
+    return response if response || match.nil?
+
+    verb = match[1]
+    path = match[2]
+    content = build_content verb
+
+    send verb.downcase, build_path(path), params: content[:params], headers: content[:headers]
+    response
+  end
+
+  # @return [Hash] the #response!.body parsed from json
+  def json!; JSON.parse response!.body end
+
+  private
+  # Convert params and header to the request content (body, params, headers, ...)
+  # @return [Hash] with params and headers key
+  def build_content verb
+    if Ryquest.configuration.content_type == :form || %w[GET DELETE].include?(verb)
+      return { params: params, headers: headers }
+    end
+
+    { params: params, headers: headers || {} }.tap do |result|
+      result[:params] = result[:params].to_json
+      result[:headers] = result[:headers].merge 'CONTENT_TYPE' => 'application/json'
+    end
+  end
+
+  # Find request http verb and path in the parents example description.
+  # @return [MatchData] verb in [0] path in [1]
+  def match_verb
+    match = nil
+
+    self.class.parent_groups.each do |parent|
+      match = parent.description.match /^(GET|POST|PATCH|PUT|DELETE) (.+)/
+      break if match
+    end
+
+    match
+  end
+
+  # Replace params path with their value.
+  # Use param path #id if present.
+  # @return [String]
+  def build_path path
+    return path if path.exclude? ':'
+
+    path.scan(/:(\w+\b)/).flatten.each do |match|
+      value = send match
+      value = value.id if value.respond_to? :id
+
+      path = path.gsub ":#{match}", value.to_s
+    end
+
+    path
+  end
+end
+
+# Include the context when using the type: :request option
+RSpec.configure { |config| config.include_context 'ryquest helper', type: :request }

data/lib/ryquest/version.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# Root module
 module Ryquest
   # Ryquest version number: major.minor.maintenance
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/ryquest.rb

@@ -1,68 +1,15 @@
 # frozen_string_literal: true
 
-# Context to include to get request DSL improvment
-RSpec.shared_context 'ryquest helper' do # rubocop:disable Metrics/BlockLength
-  let(:headers) { nil }
-  let(:params) { nil }
+require 'ryquest/configuration'
+require 'ryquest/context'
 
-  # Execute request described in example description and return #response value.
-  # Example description must be formated as: "VERB /path".
-  #
-  # Request will not be launch if it not exist or response already have a value.
-  #
-  # VERB can be: GET, POST, PUT, PATCH, DELETE
-  #
-  # To add specific body or headers define them with `let(:headers/:params) { { key: :value } }
-  #
-  # Params path can be send as: 'VERB /path/:param',
-  # :param will be replaced by `param` value (let, method, ...) or their `id` value.
-  #
-  # @return [ActionDispatch::TestResponse] the #response value
-  def response!
-    match = match_verb
-    return response if response || match.nil?
+# Root module
+module Ryquest
+  # @return [Ryquest::Configuration] Global configuration instance (create it if not present)
+  def self.configuration; @configuration ||= Configuration.new end
 
-    verb = match[1]
-    path = match[2]
-
-    send verb.downcase, build_path(path), params: params, headers: headers
-    response
-  end
-
-  # @return [Hash] the #response!.body parsed from json
-  def json!; JSON.parse response!.body end
-
-  private
-
-  # Find request http verb and path in the parents example description.
-  # @return [MatchData] verb in [0] path in [1]
-  def match_verb
-    match = nil
-
-    self.class.parent_groups.each do |parent|
-      match = parent.description.match /^(GET|POST|PATCH|PUT|DELETE) (.+)/
-      break if match
-    end
-
-    match
-  end
-
-  # Replace params path with their value.
-  # Use param path #id if present.
-  # @return [String]
-  def build_path path
-    return path if path.exclude? ':'
-
-    path.scan(/:(\w+\b)/).flatten.each do |match|
-      value = send match
-      value = value.id if value.respond_to? :id
-
-      path = path.gsub ":#{match}", value.to_s
-    end
-
-    path
-  end
+  # Yields #configuration to a block
+  # @yield [Ryquest::Configuration]
+  def self.configure; yield configuration end
 end
 
-# Include the context when using the type: :request option
-RSpec.configure { |config| config.include_context 'ryquest helper', type: :request }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryquest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pierre Guego
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -27,6 +27,8 @@ files:
 - Makefile
 - README.md
 - lib/ryquest.rb
+- lib/ryquest/configuration.rb
+- lib/ryquest/context.rb
 - lib/ryquest/version.rb
 - ryquest.gemspec
 homepage: https://github.com/faljie/ryquest