Add support for relationship-level links and meta attributes.

[beauby]

Based on top of #1447.
Allows the following:

has_many :posts do
  link :self do
    href '//example.com/link_author/relationships/posts'
    meta stuff: 'value'
  end
  link :related do
    href '//example.com/link_author/posts'
    meta count: object.posts.count
  end
  include_data false
end

[beauby]

Travis is failing because of the rubocop config (https://github.com/rails-api/active_model_serializers/blob/master/.rubocop.yml#L40 – we should allow with_first_parameter).
Current:

hash[association.key] = JsonApi::Association.new(serializer,
                                                 association.serializer,
                                                 association.options,
                                                 association.links,
                                                 association.meta)

Expected by rubocop:

hash[association.key] = JsonApi::Association.new(serializer,
  association.serializer,
  association.options,
  association.links,
  association.meta)

[bf4]

any reason for the instance variables here?

[bf4]

Looks pretty good, 😄 though, since both there are boundary changes along with refactoring and new behavior, I'll want to come back and look at what has 'changed'

[groyoh]

Any update on this PR? Is there something needed to merge this PR? I could work on it if needed.

[bf4]

should be serializer.read_attribute_for_serialization(:id)

[groyoh]

To be on the same page here, that would change the current behaviour, right? (see https://github.com/beauby/active_model_serializers/blob/master/lib/active_model/serializer/adapter/json_api.rb#L125)
And I guess you meant serializer.object.read_attribute_for_serialization(:id), right?

[bf4]

nope, I did indeedy mean to call it on the serializer, but @groyoh thanks for pointing out my error that this was just a direct port of the method

[groyoh]

Oh you're right, I didn't realized that read_attribute_for_serialization was now defined on the serializer.

[bf4]

@groyoh that's be great. Would you want to make a PR into @beauby 's branch? I can review and merge that. I think he's not around right now.

[bf4]

Merged. Added Needs follow up tag.

[janvarljen]

is there a way to use Rails URL helpers in links?

like this:

has_many :posts do
  link :related do
    href api_author_posts_url(author: object)
  end
  include_data false
end

[sheldonbaker]

@janvarljen I did the following hack to get what you're after.

module ActiveModel
  class Serializer
    module Adapter
      class JsonApi
        class Link
          def routes
            Rails.application.routes.url_helpers
          end
        end
      end
    end
  end
end

has_many :posts do
  link :related do
    href routes.api_author_posts_url(author: object)
  end
  include_data false
end

[groyoh]

@sheldonnbbaker Nice hack but I'd recommend:

UrlHelpers = Rails.application.routes.url_helpers

has_many :posts do
  link :related do
    href UrlHelpers.api_author_posts_url(author: object)
    # or
    # href Rails.application.routes.url_helpers.api_author_posts_url(author: object)
  end
  include_data false
end

if you want to avoid monkey patching AMS.

@janvarljen I don't think there is a cleaner way at the moment.

[bf4]

@sheldonnbbaker @janvarljen @remear @groyoh the url_helpers issue is #1269 just needs a PR.. good stuff above

[janvarljen]

@sheldonnbbaker @groyoh thx for the ideas. I'm doing the same thing atm but wanted to discuss a more elegant solution.

One more thing I think we're missing in these solutions is url_options context like :host, :protocol etc... we need for url_helpers to work as expected.

They way I do it:

in api_controller

serialization_scope :scope

def scope
  {
    url_options: url_options
  }
end

in base_serializer

include Rails.application.routes.url_helpers

def url_options
  scope[:url_options]
end

then I can use url helpers in serializer methods but not inside link block because we don't have access to the serializer methods

[remear]

I'm working on adding the url_helpers to 0.10 so you won't need a workarounds like these. If all goes well, that means you should have the ability to do things like:

link :self { user_url(object) }
link :self { url_for([object, :users, @user]) }
link :self { "http://example.com/posts/#{object.id}" }
link :self, "http://example.com/user"

[janvarljen]

@remear that would be great. Ping me if you need any help

[bf4]

ref: #1269

[bf4]

Maybe a 'wip' pr?

On Thu, Feb 25, 2016 at 12:37 PM Jan Varljen notifications@github.com
wrote:

@remear https://github.com/remear that would be great. Ping me if you
need any help

—
Reply to this email directly or view it on GitHub
#1454 (comment)
.

[remear]

@janvarljen, @sheldonnbbaker Feedback is welcome on #1550, which aims to add url_helpers for links.

[rjsteen]

Does anyone know when this functionality will be available in active_model_serializers gem?

[NullVoxPopuli]

you can install from our master branch until we cut another release -- would that work?

[rjsteen]

I am not seeing these changes on active_model_serializers:master

[remear]

This PR and #1550, which adds Rails url_helpers, have been merged into the master branch. They are not yet available in a version available from RubyGems. You'll need to have your application use the master branch of this repository until the next release. If you're having other troubles, I suggest opening a new issue with more details.

[rjsteen]

👍