curl-param-gen

Generate curl parameter from configuration file.

Requirements

zsh >= 5.2

Usage

Main script requires kmhjs/zcl. Run init.sh as ./init.sh .
- zcl will be downloaded into lib directory.
Prepare your definition and configuration file.
Use script as ./curl-param-gen.sh -d ./example/definition.conf -c ./example/user.conf -c ./example/user_secret.conf

Notes

Pretty print option is available.
- Use script as ./curl-param-gen.sh -d ./example/definition.conf -c ./example/user.conf -c ./example/user_secret.conf --pretty .

Example

Definition

Available value for :type field
- base : Base configurations
- header : Header values
- cookie : Cookie values
- query : Query parameters
- http_method : HTTP method / {GET, POST, ...}

Note that value must be urlencoded value if you use constant value.

#
# Base configurations (url, path)
#
(
  :type  'base'
  :key   'url'
  :value '${base_url}'
)
(
  :type  'base'
  :key   'path'
  :value '${base_path}'
)

#
# Request configuration
#
(
  :type  'http_method'
  :key   'method'
  :value 'GET'
)

#
# Header configuration
#
(
  :type  'header'
  :key   'type'
  :value '${header_type}'
)
(
  :type  'header'
  :key   'session_id'
  :value '${header_option}'
)

#
# URL query parameter configuration
#
(
  :type  'query'
  :key   'name'
  :value '${query_name}'
)
(
  :type  'query'
  :key   'id'
  :value '${query_id}'
)
(
  :type  'query'
  :key   'option'
  :value '${query_option}'
)
(
  :type  'query'
  :key   'constant_field'
  :value 'constant-value'
)

#
# Cookie configuration
#
(
  :type  'cookie'
  :key   'session_id'
  :value '${cookie_session_id}'
)
(
  :type  'cookie'
  :key   'option'
  :value '${cookie_option}'
)

Private configuration

Following configuration is an example for example definition.
Variable name must be matched to definition value field (if you use variable in :value) .

Note:

Value must be urlencoded value
Configuration file will imported by source command
- DO NOT use PATH and other special variable (used by your system) for configuration variable.

base_url='http://example.com'
base_path='/task'

header_type='sample'
header_option='header-option'

query_name='username'
query_id='0123456789'
query_option='query-option'

cookie_session_id='session-id-value-0123456789'
cookie_option='cookie-option'

If you give more than 2 file paths with -c option, duplicated configuration will be overwritten.
For example:

If you give 2 configuration files first.conf and second.conf
- As -c first.conf -c second.conf
- Both of them contains value for same variable

In this case, the value defined in second.conf will be used for the final result.

Result

The result for following command execution.

./curl-param-gen.sh -d ./example/definition.conf -c ./example/user.conf -c ./example/user_secret.conf --pretty

curl -X GET \
     -H 'session_id:header-option' \
     -H 'type:sample' \
     -H 'Cookie: session_id=session-id-value-0123456789; option=cookie-option' \
     'http://example.com/task?option=query-option&constant_field=constant-value&id=0123456789&name=username'

License

See LICENSE.

kmhjs / curl-param-gen