fix: Multi-word custom endpoint not respecting route format

[sebasjimenez10]

This PR fixes an issue I experienced when working with multi-word custom endpoints. If you have a multi-word custom endpoint and you also have the self.route_format = :dasherized_route config in your base class, upon calling that custom_endpoint JsonApiClient doesn't respect the configuration selected and will use the underscored version of the endpoint name.

For instance:

Given,

class Pet < TestResource
  self.site = "http://example.com/"
  self.route_format = :dasherized_route

  custom_endpoint :related_pets, on: :member, request_method: :get
  custom_endpoint :vip_pets, on: :collection, request_method: :get
end

When calling Pet.vip_pets or pet = Pet.new(...); pet.related_pets the resulting endpoint being called will be either:
http://example.com/pets/vip_pets or http://example.com/pets/:id/related_pets

instead of http://example.com/pets/vip-pets or http://example.com/pets/:id/related-pets

Same issue applies for camelized_routes.

This PR fixes this by checking the route_format configuration attribute and making sure it is converted to the appropriate endpoint name, using ActiveSupport helper methods.

The methods defined in the instance of the class will still be underscored, so that we can still do Pet.vip_vets.

Happy to address any concerns or comments, thanks!

[sebasjimenez10]

Hey @gaorlov 👋 giving this one a bump for you to take a look 🙏

[esbanarango]

What's the current blocker for merging this one? 🙏

[gaorlov]

Hello! Thanks for taking the time to contribute! I'll take a closer look tomorrow. I'm the meantime, can you please add an entry to the changelog?

Thanks!

Greg

[sebasjimenez10]

@gaorlov updated the changelog! 🙏

[sebasjimenez10]

@gaorlov small bump! 🙂

[gaorlov]

@sebasjimenez10 sorry about the delay. For reasons i don't yet understand the automated testing has stopped working. I'm working with the owners of the JsonAPiClient org to resolve this issue and will let you know when we can start merging again.

I appreciate your patience!

Greg

[sebasjimenez10]

@gaorlov thank you so much for looking into it. No worries on the wait, I'm glad to contribute 🙏🏻

[sebasjimenez10]

Hey @gaorlov, just dropping by and giving this one a bump! 🙏

[sebasjimenez10]

Hey @gaorlov, hope you're doing good! Just wanted to bump this one!

[esbanarango]

🙏

[gaorlov]

Can this be a method on name? like name.to_route(route_format)?

[sebasjimenez10]

@gaorlov name here is a Symbol, that would require a big refactor in other places as well and I believe that to be out of scope for this PR. But happy to discuss further to continue contributing 🙏

[gaorlov]

Could you do like

module Routable
  def to_route(format: :dasherized_route)
    case format
    when :dasherized_route
      to_s.dasherize
    when :camelized_route
      to_s.camelize(:lower)
    else
      self
    end
  end
end
 
class Symbol
  include Routable
end

and then you can have name.to_route(route_format) and not have to do anything else to the code

[gaorlov]

Looks great! thanks for contributing!
Please merge in main to get tests running in the PR
Thanks!

[sebasjimenez10]

@gaorlov done! Just rebased on top of master (main). Tests are looking good. Please let me know if there is anything else I need to do!

[sebasjimenez10]

@gaorlov small bump!

[sebasjimenez10]

@gaorlov tiny bump on this one! 🙏

[gaorlov]

thank you for you contributions and patience!
1.23.0 is now live with your changes