Add ability to pass encoder to HTTP::FormData::Urlencoded instance

[summera]

Since encoder is global and currently defined at the class level, it's difficult to customize on a per user-case basis. For example, there's an issue with the Twitter gem (sferik/twitter-ruby#677), which depends on this gem, where the default encoding of asterisks does not work and Twitter will throw an error. The only way around this is to customize the encoding, but being forced to customize encoding at the class level makes things difficult since other gems could be using http-form_data. There's also no easy way to figure out if the Twitter gem is the one making the request in order to conditionally customize the encoding. In summary, defining an encoder at the global level makes it difficult to conditionally encode form data based on the current context.

Therefore, this PR adds the ability to pass in an encoder at the instance level when creating an HTTP::FormData::Urlencoded instance, which makes it easier to conditionally encode your form data.

Please let me know if I'm overlooking or missing anything here.

---

This change is 

[ixti]

Reviewable status: 0 of 3 files reviewed, 1 unresolved discussion (waiting on @summera)

---

lib/http/form_data/urlencoded.rb, line 66 at r1 (raw file):

      # @param [#to_h, Hash] data form data key-value Hash
      def initialize(data, encoder = nil)

I would like this to be keyword argument too, just like on FormData.create

[summera]

@ixti done in 3083334

[ixti]

Reviewed 1 of 3 files at r1.
Reviewable status: 0 of 3 files reviewed, 2 unresolved discussions (waiting on @ixti and @summera)

---

lib/http/form_data.rb, line 50 at r2 (raw file):

          Multipart.new(data)
        else
          Urlencoded.new(data, encoder: encoder)

This breaks rubocop. Please use Ruby 1.9 Hash syntax instead: :encoder => encoder, same about spec. Other than that I'm happy to merge once CI pass.

[summera]

@ixti oops sorry I missed that. Fixed in 518d820

[ixti]

Reviewed 3 of 3 files at r2, 2 of 2 files at r3.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @summera)

[ixti]

Reviewable status: complete! all files reviewed, all discussions resolved

[summera]

@ixti thanks for the merge and feedback. Any chance of cutting a new release soon? I'd like to be able to use this with the http gem. I'm happy to submit a PR to http as well, if that's needed.

[ixti]

No, http gem won't need an update. Will cut form_data release ASAP.

[ixti]

Released as 2.3.0

[summera]

@ixti thanks! Much appreciated.

I might be missing something, but on using this with the http gem, wouldn't HTTP#make_request_body (and potentially HTTP#build_request depending on implementation) have to change slightly to allow for an encoder to be passed in? The way it's written now, it's only possible to pass a form data hash.

[ixti]

@summera Oh. Indeed. Will need to think on how to enhance API of http gem to pass that, right now the most straight forward way is:

form = HTTP::FormData.create(form_data, :encoder => custom_encoder)
HTTP.headers("Content-Type" => form.content_type).post(url, :body => form)

[ixti]

I'm going to enhance HTTP to accept FormData as is without re-encoding, that will allow to pass form data directly:

HTTP.post(url, :form => HTTP::FormData.new(form_data, :encoder => custom_encoder))

[summera]

Perfect! Happy to help if you need a hand. Just let me know.

[ixti]

@summera Sure! Thank you. If you can open a PR that will make HTTP respect FormData as is - will be happy to review and merge.

[summera]

@ixti 👍 . Done in httprb/http#599