lib/ethon/easy/http/actionable.rb
# frozen_string_literal: true require 'ethon/easy/http/putable' require 'ethon/easy/http/postable' module Ethon class Easy module Http # This module represents a Http Action and is a factory # for more real actions like GET, HEAD, POST and PUT. module Actionable QUERY_OPTIONS = [ :params, :body, :params_encoding ] # Create a new action. # # @example Create a new action. # Action.new("www.example.com", {}) # # @param [ String ] url The url. # @param [ Hash ] options The options. # # @return [ Action ] A new action. def initialize(url, options) @url = url @options, @query_options = parse_options(options) end # Return the url. # # @example Return url. # action.url # # @return [ String ] The url. def url @url end # Return the options hash. # # @example Return options. # action.options # # @return [ Hash ] The options. def options @options end # Returns the query options hash. # # @example Return query options. # action.query_options # # @return [ Hash ] The query options. def query_options @query_options end # Return the params. # # @example Return params. # action.params # # @return [ Params ] The params. def params @params ||= Params.new(@easy, query_options.fetch(:params, nil)) end # Return the form. # # @example Return form. # action.form # # @return [ Form ] The form. def form @form ||= Form.new(@easy, query_options.fetch(:body, nil), options.fetch(:multipart, nil)) end # Get the requested array encoding. By default it's # :typhoeus, but it can also be set to :rack. # # @example Get encoding from options # action.params_encoding # def params_encoding @params_encoding ||= query_options.fetch(:params_encoding, :typhoeus) end # Setup everything necessary for a proper request. # # @example setup. # action.setup(easy) # # @param [ easy ] easy the easy to setup. def setup(easy) @easy = easy # Order is important, @easy will be used to provide access to options # relevant to the following operations (like whether or not to escape # values). easy.set_attributes(options) set_form(easy) unless form.empty? if params.empty? easy.url = url else set_params(easy) end end # Setup request with params. # # @example Setup nothing. # action.set_params(easy) # # @param [ Easy ] easy The easy to setup. def set_params(easy) params.escape = easy.escape? params.params_encoding = params_encoding base_url, base_params = url.split('?') base_url << '?' base_url << base_params.to_s base_url << '&' if base_params base_url << params.to_s easy.url = base_url end # Setup request with form. # # @example Setup nothing. # action.set_form(easy) # # @param [ Easy ] easy The easy to setup. def set_form(easy) end private def parse_options(options) query_options = {} options = options.dup QUERY_OPTIONS.each do |query_option| if options.key?(query_option) query_options[query_option] = options.delete(query_option) end end return options, query_options end end end end end