begin integration docs

[NullVoxPopuli]

There are always going to be little quirks here and there when integrating with different technologies, especially newer ones.

Here is a pattern suggested by @bf4 for organizing information on how to prepare other technologies to work along with AMS.

note: this doesn't mean that these docs are only for if the integratee needs to change to work with AMS.
When AMS gets the ability to change the key format (specifically for JSON-api) that will clean up the ember-integration documentation a bit.

[bf4]

I think this is pretty good, but am thinking we might also benefit from an external links section oof posts/tutorials/screencasts/recipes etc. like http://emberwatch.com/tutorials.html has so we can e.g. link to, in date sorted format:

-http://tech.kinesis.org/2015/11/06/a-migration-path-to-json-api-with-ember-data-from-ams/

• https://netguru.co/blog/active-model-serializers-ember
• https://blog.engineyard.com/2015/active-model-serializers
• www.sitepoint.com/active-model-serializers-rails-and-json-oh-my/
• http://confreaks.tv/videos/railsconf2015-ams-api-rails-and-a-developer-a-love-story
• https://thesocietea.org/2015/03/building-a-json-api-with-rails-part-2-serialization/
• alternatives
  • http://www.cerebris.com/blog/2014/08/22/introducing-jsonapi-resources/

[bf4]

Also ref: https://github.com/SauloSilva/sinatra-active-model-serializers/ and #1258

[bf4]

@NullVoxPopuli Let's get this cleaned up and shipped! Great work, just needs some touch-ups, and maybe reference versions of AMS the integrations target, e.g.

Integration	Known supported versions	Gem name and/or link
Ember.js	0.9.x	active-model-adapter
Ember.js	0.10.x	docs/integrations/ember-and-json-api.md
Grape	0.10.x	#1258
Grape	0.9.x	https://github.com/jrhe/grape-active_model_serializers/
Sinatra	0.9.x	https://github.com/SauloSilva/sinatra-active-model-serializers/

| Integration | Known supported versions |  Gem name and/or link
|----|-----|----
| Ember.js | 0.9.x | [active-model-adapter](https://github.com/ember-data/active-model-adapter)
| Ember.js | 0.10.x |  [docs/integrations/ember-and-json-api.md](docs/integrations/ember-and-json-api.md)
| Grape | 0.10.x | #1258  |
| Grape | 0.9.x | https://github.com/jrhe/grape-active_model_serializers/ |
| Sinatra | 0.9.x | https://github.com/SauloSilva/sinatra-active-model-serializers/

[NullVoxPopuli]

I really like that compatibility table.

I'll push an update shortly

[NullVoxPopuli]

This also needs to be mentioned:

#1027 (comment)

[NullVoxPopuli]

how's it look, @bf4 ?

[bf4]

Not sure if we might want something like https://github.com/cerebris/jsonapi-resources/blob/master/lib/jsonapi/mime_types.rb but I have no way of testing it right now

module JSONAPI
  MEDIA_TYPE = 'application/vnd.api+json'
end

Mime::Type.register JSONAPI::MEDIA_TYPE, :api_json

ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime::Type.lookup(JSONAPI::MEDIA_TYPE)] = lambda do |body|
  data = JSON.parse(body)
  data = {:_json => data} unless data.is_a?(Hash)
  data.with_indifferent_access
end

[NullVoxPopuli]

We could certainly add that later - maybe when the JSON API implementation becomes more complete. I think that should be separate from this PR though.

[bf4]

Pretty good.

I'm happy to merge, but wanted to bring up in one place

• considering an external links section begin integration docs #1312 (comment)
• handling JSON API mime-types within AMS begin integration docs #1312 (comment)

[NullVoxPopuli]

re: the links,
I'm wary of including links to other places, as I believe that may appear like we support those links in that they are compatible with AMS -- personally, I haven't tried many of the links -- there may be things forgotten in any number of guides -- or slightly version incompatibilities for whatever reason..

idk. :-\