restpack_serializer 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa7cfdbe2a9599b02355d695b51fb1ba6bd50bed
-  data.tar.gz: aa3d9b0c277baf98f13fb7ab9c798a445c903a7a
+  metadata.gz: c406b9af62170a52083627f373ffdc67a1942140
+  data.tar.gz: 7b73768866438375cf7e1b870e5da680ef60b363
 SHA512:
-  metadata.gz: e9adc45be506cf71e5d2edb1d71dd09e5d92132b6f2252d0894ac47537096840bf8b9b7cc77551ef75445eeaefdfb99314ebc075e5dc706c4322ae2136e62e6a
-  data.tar.gz: ba50400c0c244ea96efcd89988026c58f4f9c11cdae1a53b0c0ea691243218b4d78181710f1fc3ee43a1a03e3db2caf2bbc713a12ff01673ce036d73ec8f9752
+  metadata.gz: ddd06300644271b871ace5bf86921c284145361fe7d3f5e3c334fedf7e8475f10afaaf74299e628a21320706229ae56927c7a20a404b414c8d8aed53a26d2fd5
+  data.tar.gz: a92f904c22955987d9415c772e61b7b0bccbffb8864d102d3a1d6b3d96d2b9af431eb4dc79e4d29b6bf6d756a51d80d687fb4b300499243380b27501ca0d401c

data/README.md

@@ -42,7 +42,7 @@ end
   "title": "Kid A",
   "year": 2000,
   "artist_id": 1,
-  "href": "/albums/1.json"
+  "href": "/albums/1"
 }
 ```
 
@@ -62,7 +62,7 @@ class AlbumsController < ApplicationController
 end
 ```
 
-These endpoint will live at URLs such as `/albums.json` and `/albums/142857.json`:
+These endpoint will live at URLs such as `/albums` and `/albums/142857`:
 
 * http://restpack-serializer-sample.herokuapp.com/albums.json
 * http://restpack-serializer-sample.herokuapp.com/albums/4.json
@@ -90,7 +90,7 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
         {
             "id": "4",
             "title": "How to Dissapear Completely",
-            "href": "/songs/4.json",
+            "href": "/songs/4",
             "links": {
                 "artist": "1",
                 "album": "1"
@@ -99,7 +99,7 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
         {
             "id": "5",
             "title": "Treefingers",
-            "href": "/songs/5.json",
+            "href": "/songs/5",
             "links": {
                 "artist": "1",
                 "album": "1"
@@ -108,7 +108,7 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
         {
             "id": "6",
             "title": "Optimistic",
-            "href": "/songs/6.json",
+            "href": "/songs/6",
             "links": {
                 "artist": "1",
                 "album": "1"
@@ -124,17 +124,17 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
             "page_count": 14,
             "previous_page": 1,
             "next_page": 3,
-            "previous_href": "/api/v1/songs.json?page_size=3",
-            "next_href": "/api/v1/songs.json?page=3&page_size=3"
+            "previous_href": "/api/v1/songs?page_size=3",
+            "next_href": "/api/v1/songs?page=3&page_size=3"
         }
     },
     "links": {
         "songs.artist": {
-            "href": "/artists/{songs.artist}.json",
+            "href": "/artists/{songs.artist}",
             "type": "artists"
         },
         "songs.album": {
-            "href": "/albums/{songs.album}.json",
+            "href": "/albums/{songs.album}",
             "type": "albums"
         }
     }
@@ -143,8 +143,8 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
 
 URL Templates to related data are included in the `links` element. These can be used to construct URLs such as:
 
-* /artists/1.json
-* /albums/1.json
+* /artists/1
+* /albums/1
 
 ## Side-loading
 
@@ -178,7 +178,7 @@ which yields:
             "id": "1",
             "title": "Kid A",
             "year": 2000,
-            "href": "/albums/1.json",
+            "href": "/albums/1",
             "links": {
                 "artist": "1"
             }
@@ -187,7 +187,7 @@ which yields:
             "id": "2",
             "title": "Amnesiac",
             "year": 2001,
-            "href": "/albums/2.json",
+            "href": "/albums/2",
             "links": {
                 "artist": "1"
             }
@@ -196,7 +196,7 @@ which yields:
             "id": "3",
             "title": "Murder Ballads",
             "year": 1996,
-            "href": "/albums/3.json",
+            "href": "/albums/3",
             "links": {
                 "artist": "2"
             }
@@ -205,7 +205,7 @@ which yields:
             "id": "4",
             "title": "Curtains",
             "year": 2005,
-            "href": "/albums/4.json",
+            "href": "/albums/4",
             "links": {
                 "artist": "3"
             }
@@ -228,19 +228,19 @@ which yields:
     },
     "links": {
         "albums.songs": {
-            "href": "/songs.json?album_id={albums.id}",
+            "href": "/songs?album_id={albums.id}",
             "type": "songs"
         },
         "albums.artist": {
-            "href": "/artists/{albums.artist}.json",
+            "href": "/artists/{albums.artist}",
             "type": "artists"
         },
         "artists.albums": {
-            "href": "/albums.json?artist_id={artists.id}",
+            "href": "/albums?artist_id={artists.id}",
             "type": "albums"
         },
         "artists.songs": {
-            "href": "/songs.json?artist_id={artists.id}",
+            "href": "/songs?artist_id={artists.id}",
             "type": "songs"
         }
     },
@@ -249,19 +249,19 @@ which yields:
             "id": "1",
             "name": "Radiohead",
             "website": "http://radiohead.com/",
-            "href": "/artists/1.json"
+            "href": "/artists/1"
         },
         {
             "id": "2",
             "name": "Nick Cave & The Bad Seeds",
             "website": "http://www.nickcave.com/",
-            "href": "/artists/2.json"
+            "href": "/artists/2"
         },
         {
             "id": "3",
             "name": "John Frusciante",
             "website": "http://johnfrusciante.com/",
-            "href": "/artists/3.json"
+            "href": "/artists/3"
         }
     ]
 }

data/lib/restpack_serializer/serializable/attributes.rb

@@ -2,7 +2,7 @@ module RestPack::Serializer::Attributes
   extend ActiveSupport::Concern
 
   def default_href
-    "#{RestPack::Serializer.config.href_prefix}/#{self.class.key}/#{@model.id}.json"
+    "#{RestPack::Serializer.config.href_prefix}/#{self.class.key}/#{@model.id}"
   end
 
   module ClassMethods

data/lib/restpack_serializer/serializable/paging.rb

@@ -58,7 +58,7 @@ module RestPack::Serializer::Paging
     def page_href(page, options)
       return nil unless page
 
-      url = "#{RestPack::Serializer.config.href_prefix}/#{self.key}.json"
+      url = "#{RestPack::Serializer.config.href_prefix}/#{self.key}"
 
       params = []
       params << "page=#{page}" unless page == 1

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -31,11 +31,11 @@ module RestPack::Serializer::SideLoading
       associations.each do |association|
         if association.macro == :belongs_to
           link_key = "#{self.key}.#{association.name}"
-          href = "/#{association.plural_name}/{#{link_key}}.json"
+          href = "/#{association.plural_name}/{#{link_key}}"
         elsif association.macro == :has_many
           singular_key = self.key.to_s.singularize
           link_key = "#{self.key}.#{association.plural_name}"
-          href = "/#{association.plural_name}.json?#{singular_key}_id={#{key}.id}"
+          href = "/#{association.plural_name}?#{singular_key}_id={#{key}.id}"
         end
 
         links[link_key] = {

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.8'
+    VERSION = '0.4.9'
   end
 end

data/spec/serializable/paging_spec.rb

@@ -23,12 +23,12 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:previous_page].should == nil
         page[:meta][:songs][:previous_href].should == nil
         page[:meta][:songs][:next_page].should == 2
-        page[:meta][:songs][:next_href].should == '/songs.json?page=2'
+        page[:meta][:songs][:next_href].should == '/songs?page=2'
       end
       it "includes links" do
         page[:links].should == {
-          'songs.album' => { :href => "/albums/{songs.album}.json", :type => :albums },
-          'songs.artist' => { :href => "/artists/{songs.artist}.json", :type => :artists }
+          'songs.album' => { :href => "/albums/{songs.album}", :type => :albums },
+          'songs.artist' => { :href => "/artists/{songs.artist}", :type => :artists }
         }
       end
     end
@@ -41,7 +41,7 @@ describe RestPack::Serializer::Paging do
       end
       it "includes the custom page size in the page hrefs" do
         page[:meta][:songs][:next_page].should == 2
-        page[:meta][:songs][:next_href].should == '/songs.json?page=2&page_size=3'
+        page[:meta][:songs][:next_href].should == '/songs?page=2&page_size=3'
       end
     end
 
@@ -93,7 +93,7 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:page].should == 2
         page[:meta][:songs][:previous_page].should == 1
         page[:meta][:songs][:next_page].should == nil
-        page[:meta][:songs][:previous_href].should == '/songs.json'
+        page[:meta][:songs][:previous_href].should == '/songs'
       end
     end
 
@@ -109,7 +109,7 @@ describe RestPack::Serializer::Paging do
       end
 
       it "includes the side-loads in page hrefs" do
-        page[:meta][:songs][:next_href].should == '/songs.json?page=2&include=albums'
+        page[:meta][:songs][:next_href].should == '/songs?page=2&include=albums'
       end
 
       it "includes links between documents" do
@@ -133,7 +133,7 @@ describe RestPack::Serializer::Paging do
         end
 
         it "includes the side-loads in page hrefs" do
-          page[:meta][:songs][:next_href].should == '/songs.json?page=2&include=albums,artists'
+          page[:meta][:songs][:next_href].should == '/songs?page=2&include=albums,artists'
         end
 
         it "includes links" do
@@ -164,7 +164,7 @@ describe RestPack::Serializer::Paging do
         end
 
         it "includes the filter in page hrefs" do
-          page[:meta][:songs][:next_href].should == "/songs.json?page=2&album_id=#{@album1.id}"
+          page[:meta][:songs][:next_href].should == "/songs?page=2&album_id=#{@album1.id}"
         end
       end
     end

data/spec/serializable/serializer_spec.rb

@@ -55,7 +55,7 @@ describe RestPack::Serializer do
       serializer.class.serialize(person).should == {
         people: [{
           id: '123', name: 'Gavin', description: 'This is person #123',
-          href: '/people/123.json', custom_key: 'custom value for model id 123'
+          href: '/people/123', custom_key: 'custom value for model id 123'
         }]
       }
     end
@@ -65,14 +65,14 @@ describe RestPack::Serializer do
     it "serializes specified attributes" do
       serializer.as_json(person).should == {
         id: '123', name: 'Gavin', description: 'This is person #123',
-        href: '/people/123.json', custom_key: 'custom value for model id 123'
+        href: '/people/123', custom_key: 'custom value for model id 123'
       }
     end
 
     context "with options" do
       it "excludes specified attributes" do
         serializer.as_json(person, { include_description?: false }).should == {
-          id: '123', name: 'Gavin', href: '/people/123.json',
+          id: '123', name: 'Gavin', href: '/people/123',
           custom_key: 'custom value for model id 123'
         }
       end

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -52,11 +52,11 @@ describe RestPack::Serializer::SideLoading do
   describe "#links" do
     MyApp::AlbumSerializer.links.should == {
       "albums.artist" => {
-        :href => "/artists/{albums.artist}.json",
+        :href => "/artists/{albums.artist}",
         :type => :artists
       },
       "albums.songs" => {
-        :href => "/songs.json?album_id={albums.id}",
+        :href => "/songs?album_id={albums.id}",
         :type => :songs
       }
     }
@@ -64,7 +64,7 @@ describe RestPack::Serializer::SideLoading do
     it "applies custom RestPack::Serializer.config.href_prefix" do
       original = RestPack::Serializer.config.href_prefix
       RestPack::Serializer.config.href_prefix = "/api/v1"
-      MyApp::AlbumSerializer.links["albums.artist"][:href].should == "/api/v1/artists/{albums.artist}.json"
+      MyApp::AlbumSerializer.links["albums.artist"][:href].should == "/api/v1/artists/{albums.artist}"
       RestPack::Serializer.config.href_prefix = original
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord