Added Response available options list

[mberlanda]

I recently did a PR in omniauth-saml gem to allow more options for a OneLogin::RubySaml::Response object (omniauth/omniauth-saml#159).

After merging it, I was discussing with @md5 about the possibility to source the allowed options from ruby-saml gem instead of hardcode them in this gem.

As of today, omniauth-saml had ~2.3 million downloads and I believe that introducing a whitelist of response options will make the dependency on ruby-saml stronger and even more reliable.

Moreover, it will allow to developers who are using ruby-saml standalone to have a better overview on the options they can use.

[mberlanda]

hi @pitbulk

I saw in the travis build that jruby-1.7.21 and jruby-9.0.0.0 are failing since a while. They might need a separated Gemfile (https://docs.travis-ci.com/user/languages/ruby/#JRuby:-C-extensions-are-not-supported).

In ree and ruby-1.8.7 an array of symbols is raising TypeError: Symbol as array index. How are you handling this data structure?

Thanks

[pitbulk]

What happens to projects using ruby-saml that extended the SAMLResponse options with more options?
This PR will break their projects.

Is the whitelist of options really important?

Related to jruby, I haven't got an environment to test it.

[mberlanda]

Thank you for your quick reply!

Actually the whitelist of options is a nice workaround to make sure that dependent gems such as omniauth-saml will be updated with the options offered by your gem. I haven't considered the case of someone extending the class and passing custom options.

This is not the only possible solution but it would prevent several prs on other gems which depends on yours.

Would it be suitable to you to rename the ALLOWED_OPTIONS to AVAILABLE_OPTIONS and remove the validation of the options provided? This would achieve the purpose of this PR.

[pitbulk]

Yes, I think adding ALLOWED_OPTIONS is not bad idea

[mberlanda]

Perfect! I changed then to AVAILABLE_OPTIONS and dropped the commit which was introducing the filter. I guess this could be ready for a review.

[mberlanda]

hi @pitbulk ! Could you please bump a minor version of the gem including this PR changes?
Thank you very much