Sinja: RESTful, {json:api}-compliant web services in Sinatra/Lobby

Jonathan Gnagy

@jgnagy

        index(roles: %i[user trusted]) do
          Models::User.all
        end

changing it like so:

        index(roles: %i[user trusted]) do
          serialize_models Models::User.all, fields: { users: indexable_fields }
        end

doesn't error out, and seems to be making use of exactly what you linked to

Lucas Hosseini

@beauby

Yup

Jonathan Gnagy

@jgnagy

however... it goes from returning 3 users to 0

@body=["{\"data\":[],\"jsonapi\":{\"version\":\"1.0\"},\"included\":[]}"]

Lucas Hosseini

@beauby

Hmm that sucks :)

Jonathan Gnagy

@jgnagy

        def indexable_fields
            %i[admin apikeys groups organizations identities].tap do |a|
              if role.include?(:admin)
                a << :verified
                a << :email
              end
            end
          end

Lucas Hosseini

@beauby

I’m not really familiar with sinja so sadly I can’t be of much help

Jonathan Gnagy

@jgnagy

just so you see what that helper is doing

ah, ok

I think the breakdown is that I'm not sure I can use the result of serialize_modelsdirectly in the index sinja route helper

Lucas Hosseini

@beauby

Looking at the docs you could probably hack your way through:

resource :posts do
  helpers do
    def before_index
      params[:fields] = { users: indexable_fields }
    end
  end

Snippet taken and modified from there: https://github.com/mwpastore/sinja#sorting

Jonathan Gnagy

@jgnagy

that's worth trying

Lucas Hosseini

@beauby

You’d have to add a bit more logic to handle actual user-provided sparse fieldsets while removing email, but I think it should work

Jonathan Gnagy

@jgnagy

yeah, I like it

I think that'll work

Lucas Hosseini

@beauby

:+1:

Jonathan Gnagy

@jgnagy

figuring out the right mix of fields will take some work

but testing that brute-force in the before_* helper worked

Jonathan Gnagy

@jgnagy

this seems to do what I wanted

          def before_index
            params[:fields] = {
              users: if params[:fields] && params[:fields].key?(:users)
                       params[:fields].select { |k, _| indexable_fields.include?(k) }
                     else
                       indexable_fields
                     end
            }
          end

almost

Lucas Hosseini

@beauby

You should get rid of && params[:fields].key?(:users)

oops no sorry

Jonathan Gnagy

@jgnagy

          def before_index
            params[:fields] = {
              users: if params[:fields] && params[:fields].key?(:users)
                       params[:fields][:users].select { |k, _| indexable_fields.include?(k) }
                     else
                       indexable_fields
                     end
            }
          end

Lucas Hosseini

@beauby

I meant,

Yeah, that :)

Mike Pastore

@mwpastore

looks good. the problem with your other attempt is that you should just return the collection from your action helper (serialize_models is called behind the scenes), along with a hash of options to pass to jsonapi-serializers. and you can't use return, you have to use next. so you wanted

index(roles: %i[user trusted]) do
  next Models::User.all, fields: { users: indexable_fields }
end

this is covered in the first paragraph of this section here https://github.com/mwpastore/sinja#action-helpers and several examples are scattered throughout the readme

but in general, yes, as Lucas points out I recommend using before_index (and before_show, etc.) to set defaults for query parameters like include, fields, sort, filter, page, etc.

Jonathan Gnagy

@jgnagy

thanks, and I'll keep that in mind going forward

I've enjoyed using Sinja, by the way... it has really made creating my API easier

keep up the great work!

Mike Pastore

@mwpastore

that's great to hear

thank you :)

Jonathan Gnagy

@jgnagy

if you care to see the service I've been hacking on that uses it: https://github.com/knuedge/authify-api

Mike Pastore

@mwpastore

it's clumsy in lots of places and looking back on it there's a lot I'd like to revisit but on the whole I'm happy with the type of application development it enables

sweet

Lucas Hosseini

@beauby

Hey @mwpastore, FYI, I started building a compliance-testing tool for jsonapi serialization libraries (https://github.com/beauby/jsonapi-grader, see description here: https://github.com/json-api/json-api/pull/1203#issuecomment-319733112 )

Mike Pastore

@mwpastore

@beauby oh, that's really exciting! is there going to be a description of the resource endpoints that must be implemented to pass the test suite?

Lucas Hosseini

@beauby

@mwpastore So for now I decided to do it on a lower level, and simply provide fixed jsonapi documents that each implementation would have to provide a way to generate

So it doesn’t really concern Sinja or higher-level frameworks

Mike Pastore

@mwpastore

ah so it's testing serialization formats more than anything

Lucas Hosseini

@beauby

But I’m planning to work on an HTTP compliance test suite as well

Mike Pastore

@mwpastore

that would be really cool

Lucas Hosseini

@beauby

ah so it's testing serialization formats more than anything

Yup

Mike Pastore

@mwpastore

I see you're writing it in Ruby, let me know if I can be of any assistance

Where communities thrive

People

Repo info

Activity