Commit Graph

105 Commits

Author SHA1 Message Date
Leigh Halliday
4440a092d2 Updating wording on cache expiry in README 2015-09-12 20:17:44 -04:00
L. Preston Sego III
885d61120f Fixed indentation in readme under 'using without render' 2015-09-12 11:36:51 -04:00
Pericles Theodorou
a93ddda83e Documentation for serializing resources without render 2015-09-12 15:29:03 +01:00
Bruno Bacarini
8634503849 Remove url options
Removing url options because It does not works at all.
Thus, there are others PR at the moment to include url(links) as well.
2015-09-07 12:13:19 -03:00
João Moura
8e084377d8 Adding code climate badges 2015-09-06 18:33:13 -03:00
João Moura
83975fc5be Updating appveyor badge 2015-09-06 18:03:03 -03:00
João M. D. Moura
49ea8bde86 TYPO on README 2015-08-26 04:49:27 -03:00
João Moura
af280abbb7 Merge pull request #1066 from rails-api/appveyor
Adding appveyor to the project
2015-08-26 04:46:16 -03:00
João M. D. Moura
58968ebe95 updating README to add windows build status 2015-08-21 01:28:28 -03:00
Bruno Bacarini
f85027e631 add more documentation to pagination links 2015-08-19 11:09:47 -03:00
Bruno Bacarini
2c2f948fa0 Add pagination links automatically
Pagination links will be included in your response automatically as long
as the resource is paginated using Kaminari or WillPaginate
and if you are using a JSON-API adapter. The others adapters does not have this feature.
2015-08-18 19:04:04 -03:00
Bruno Bacarini
acb6545c50 add documentation to pagination feature 2015-08-18 19:04:03 -03:00
Bruno Bacarini
1fe8b06986 exchange pagination class to inside json_api scope 2015-08-18 19:04:02 -03:00
Bruno Bacarini
f7c77c1256 add feature to include pagination links in response 2015-08-18 19:04:02 -03:00
artLopez
b68305f560 Fixed Comments highlight 2015-08-04 12:00:53 -07:00
Baozi Wu
672618447e Update README.md 2015-07-27 02:44:53 +08:00
Baozi Wu
e388be9c01 Update README.md 2015-07-26 16:01:52 +08:00
Rodrigo Ra
df63b59512 Add key option to serializer associations 2015-07-05 19:47:58 -03:00
João Moura
867d36a3a3 updating readme and changelog 2015-06-18 19:17:44 -03:00
Kang-Kyu Lee
ed818d9fd3 Update README.md
I wonder how `ActiveRecord::Serializer` and `ActiveRecord::Serializers` are different? However I found they have different name between the title and code.
2015-06-17 11:24:48 -07:00
Sandro Munda
a865ba53ea AMS supports JSONAPI 1.0 instead of RC4 2015-06-10 14:11:28 +02:00
João Moura
a40df8fd3d reverting PR #909 and adding json api usage advise on readme 2015-05-27 18:35:00 -03:00
Benedikt Deicke
2f6c431d5a Updates Readme to reflect changes to JSON API RC4 2015-05-22 14:34:00 +02:00
João Moura
738894e5b4 updating readme declaring JsonApi as default adapter 2015-05-11 16:21:14 -03:00
Attila Domokos
cbd1e672d8 Fixing typos in README.md 2015-04-30 18:28:21 -05:00
Alexandre de Oliveira
1577969cb7 Bumps to 0.10.0.rc1 2015-04-22 03:06:06 -03:00
João Moura
792fb8a905 Adding Fragment Cache to AMS
It's an upgrade based on the new Cache implementation #693.
It allows to use the Rails conventions to cache
specific attributes or associations.
It's based on the Cache Composition implementation.
2015-04-05 18:19:57 -03:00
Josh Smith
589a5806ab Add issue stats to README
We should probably make it clearer how active the development is and also how quickly we close issues. Will help motivate us to do better and also clarify to everyone else that we are _really_ active.
2015-03-28 00:28:55 -07:00
Alex Matchneer
7a70cf7eb8 README: Add emphasis to single-word difference
Minor change to make the distinction b/w adapters and serializers jump out more.
2015-03-27 08:50:10 -04:00
Mateo Murphy
ef3bfdd1e9 Update README.md
Indicate support for RC3 of JSON API
2015-03-22 20:43:56 -04:00
Josh Smith
cd2f2c8884 Remove the mailing list from the README
We discussed this previously, but I think it's time for the mailing list to be removed from the README. Every day more discussion, issues, and pull requests happen here then ever before. The mailing list is not representative of this activity and only dilutes the purpose of the blossoming community we're finding here.

A related note: I think we should actively encourage folks to ask questions on StackOverflow with the AMS tag, and put some documentation in here about that. I can open a separate PR for this later, but it would require more than a few of us to actively monitor SO and help where we can. If we successfully do this, then I think we effectively cover all the use cases the mailing list originally may have had.
2015-03-15 19:53:19 -07:00
Robbie Pitts
ad5677c4ec Make json api adapter 'include' option accept an array, accommodate comma delimited string for legacy reasons 2015-03-11 10:01:44 -04:00
Josh Smith
fa4a6a7ae7 Add CONTRIBUTING.md and update README.md to point to it 2015-03-08 12:30:43 -07:00
Gary Gordon
651b99f22e Support has_one to be compatible with 0.8.x
Update README and CHANGELOG
2015-03-01 13:47:34 -05:00
Alex Stophel
13243f2e70 Add Overriding attribute methods section to README. 2015-02-07 00:09:50 -05:00
Joao Moura
8a432ad2b3 Adding cache support to version 0.10.0
It's a new implementation of cache based on ActiveSupport::Cache.
The implementation abstracts the cache in Adapter class on a
private method called cached_object, this method is intended
to be used on Adapters inside serializable_hash method in order
to cache each instance of the object that will be returned by
the serializer.

Some of its features are:
- A different syntax. (no longer need the cache_key method).
- An options argument that have the same arguments of ActiveSupport::Cache::Store, plus a key option that will be the prefix of the object cache on a pattern "#{key}-#{object.id}".
- It cache the objects individually and not the whole Serializer return, re-using it in different requests (as a show and a index method for example.)
2015-02-02 14:53:34 -02:00
Alexandre de Oliveira
e47231cdc8 Support overriding association methods
You can override associations to define custom scope on them.
2015-01-29 16:52:18 -02:00
Alexandre de Oliveira
6eb75af96b Merge pull request #696 from ggordon/explicit_serializer
Explicitly set serializer for associations
2015-01-06 09:57:07 -02:00
Alexandre de Oliveira
bd27da1b76 Adds support for meta attribute
Currently, 0.10.0.pre doesn't support `meta` option in `render`. This
way, there's no way to support features such as pagination. `0.9` had
this feature in place.

This adds support for it, as well as fixes small things in README.md.

This won't support `meta` in array responses because arrays don't have
keys, obviously. Also, the response should have a `root` key, otherwise
no `meta` will be included.

In some cases, for example using JsonApi, ArraySerializer will result in
a response with a `root`. In that case, `meta` will be included.
2015-01-05 02:56:33 -02:00
James Herdman
faa6f906d6 A Friendly Note on Which AMS Version to Use
Per the discussion in #702, I figured it might be nice to note which
version of AMS is recommended to be used in new projects.
2014-11-20 10:20:04 -05:00
Gary Gordon
9f9715801a Explicitly set serializer for associations
Document specifying serializer for assocaition
2014-11-13 10:17:59 -05:00
Gary Gordon
08716d20c9 Rename attribute with :key (0.8.x compatibility) 2014-11-13 08:03:22 -05:00
Mike A. Owens
58b6c4a6b7 Allow for the implicit use of ArraySerializer when :each_serializer is specified. 2014-11-07 09:39:36 -05:00
Gary Gordon
c84430cdad Support serializer and each_serializer in render json 2014-11-05 15:10:14 -05:00
Gary Gordon
d5bae0c2f0 Include 'linked' member for json-api collections
The options passed to the render are partitioned into adapter options
and serializer options. 'include' and 'root' are sent to the adapter,
not sure what options would go directly to serializer, but leaving this
in until I understand that better.
2014-11-03 17:13:55 -05:00
Craig Little
76ce2130e7 Update build badge URL
s/steveklabnik/rails-api/
2014-09-03 00:43:58 -07:00
Tema Bolshakov
b4a313e6d8 Merge remote-tracking branch 'upstream/master' into feature/adapter 2014-08-29 12:55:20 +04:00
Laurent Arnoud
f02f5b767a README: typo fix on attributes 2014-08-27 11:48:14 +02:00
Tema Bolshakov
6cc4fa0258 * Configure adapter using ActiveModel::Serializer.config.adapter
* Get adapter instance using ActiveModel::Serializer::Adapter.adapter_for(serializer)
2014-08-27 09:05:28 +04:00
Žiga
e8727ae272 ruby syntax highlights 2014-08-25 19:21:15 +02:00
Steve Klabnik
09bc715c0b Update README with branch info, etc. 2014-08-22 17:01:14 -04:00
Steve Klabnik
67688b77e6 Typo.
❤️ @wycats
2014-07-05 12:11:08 -04:00
Steve Klabnik
4a2d9853ba First iteration of the README. 2014-07-05 01:50:14 -04:00
Steve Klabnik
4e0538255a Travis badge and first build 2014-07-05 00:58:44 -04:00
Steve Klabnik
c718915075 Generate a basic gem 2014-07-05 00:53:48 -04:00