restpack_serializer 0.2.8 → 0.2.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTBhNDdkYjA4OTdiYzE4NTJmMzg4NzExMWY5OGM1ODY5OWUwN2Y5Mw==
+    M2M0YjM0NjM5MGExZWY2Y2JiZmJiZGU3ZDBiN2U0NWRkZTBlYWIyNg==
   data.tar.gz: !binary |-
-    YWI2ZGYwMTU1NTM0MDQxYWQ1MjBmMzI4MWI5ZDQ0ZTdlZWI4ZjVlMg==
+    ZDNiOTQxNTk0ZDM4NDZhZGExZDM3MGVjMTQ5OGUwOGJlYzg0YzQ3YQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTVlYWRlNDgzYWE2NDBkZTNjYTA4ZTlhZjY1ZGM2MGFmZjNhZGZlNGQ0NDU5
-    YzMyYjk5NzQ3YmEyZWI3Mzc3MGEyMWE0NDBjYjQ1MzgzYWNlYTg4ZGRkNTQ4
-    NzU1MjA3NzdjZjgyZDVlMzQxM2JmNDA4YmIxOTkwNWE3ZmZkOWU=
+    OTQ4MTA0NmI5NDcxOTU3NTgxNWM0MTc3MzJjNzk4ZGYzYzBkZWYzY2I4NGFh
+    YzA4NmRhMDdiYjFhODM2YWYwMzRhNjU1ZDAxNTIxNDNhMzhiODY1ZDE3MzE4
+    M2Y5ZjkzMzU4Y2ZhNGQzOTg1OWEwMGZmYmE1ZjU4YWRiNmFkNzQ=
   data.tar.gz: !binary |-
-    Yzc5OGZjYWIwZmFkMDhkMmUzYzExMGI2ZDc2MWM1ODEzOTBjNDUyMThhY2Vi
-    YTI0ZmEwMWEwMThkZGM4ODdlMTgzNTg3OTc4YWU5ZmY3ZjYxYmM0N2VkZjFl
-    YTA0OTU5ZmE0MmUyYTgxMmRmOTQxN2RmN2ZhNzI3NDcxN2Q1YTM=
+    ZWIyYjkzZTQzNjNhYzFhNmRjZTgyYjBlN2JhNzRjOWQ3N2YxOTg1MWI1ZmQ5
+    NzI5NTk2NTVlYjljM2U0OTMxZjRkYzZmMDM2YTAyNmEzMmYzOTAyNDJhNDM0
+    M2IyOTNhNDdhYmE2NzAyYTk2ZDBkZTNmNzZmM2FjODQ4ZGQzOGQ=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restpack_serializer (0.2.8)
+    restpack_serializer (0.2.9)
       activerecord (>= 3.0)
       activesupport (>= 3.0)
       will_paginate (~> 3.0)

data/README.md

@@ -31,10 +31,6 @@ restpack_serializer allows us to define a corresponding serializer:
 class AlbumSerializer
   include RestPack::Serializer
   attributes :id, :title, :year, :artist_id, :href
-
-  def href
-    "/albums/#{id}.json"
-  end
 end
 ```
 
@@ -52,7 +48,7 @@ end
 
 ## Exposing an API
 
-The `AlbumSerializer` provides `page` and `resource` method which provide paged collection and singular resource GET endpoints.
+The `AlbumSerializer` provides `page` and `resource` methods which provide paged collection and singular resource GET endpoints.
 
 ```ruby
 class AlbumsController < ApplicationController
@@ -71,7 +67,7 @@ These endpoint will live at URLs such as `/albums.json` and `/albums/142857.json
 * http://restpack-serializer-sample.herokuapp.com/albums.json
 * http://restpack-serializer-sample.herokuapp.com/albums/4.json
 
-Both `page` and `resource` methods can have an optional scope allowing us to enforce arbitrary constraints:
+Both `page` and `resource` methods take an optional scope argument allowing us to enforce arbitrary constraints:
 
 ```ruby
 AlbumSerializer.page(params, Albums.where("year < 1950"))
@@ -102,7 +98,7 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
         },
         {
             "id": "5",
-            "title": "Treedfingers",
+            "title": "Treefingers",
             "href": "/songs/5.json",
             "links": {
                 "artist": "1",
@@ -127,7 +123,9 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
             "includes": [],
             "page_count": 14,
             "previous_page": 1,
-            "next_page": 3
+            "next_page": 3,
+            "previous_href": "/api/v1/songs.json?page_size=3",
+            "next_href": "/api/v1/songs.json?page=3&page_size=3"
         }
     },
     "links": {
@@ -156,11 +154,8 @@ Side-loading allows related resources to be optionally included in a single API
 class AlbumSerializer
   include RestPack::Serializer
   attributes :id, :title, :year, :artist_id, :href
+  
   can_include :songs, :artists
-
-  def href
-    "/albums/#{id}.json"
-  end
 end
 ```
 
@@ -226,7 +221,9 @@ which yields:
             ],
             "page_count": 1,
             "previous_page": null,
-            "next_page": null
+            "next_page": null,
+            "previous_href": null,
+            "next_href": null
         }
     },
     "links": {

data/lib/restpack_serializer/configuration.rb

@@ -0,0 +1,12 @@
+module RestPack
+  module Serializer
+    class Configuration
+      attr_accessor :href_prefix, :page_size
+
+      def initialize
+        @href_prefix = ''
+        @page_size = 10
+      end
+    end
+  end
+end

data/lib/restpack_serializer/options.rb

@@ -2,13 +2,11 @@ module RestPack::Serializer
   class Options
     attr_accessor :page, :page_size, :includes, :filters, :model_class, :scope, :include_links
 
-    DEFAULT_PAGE_SIZE = 10
-
     def initialize(model_class, params = {}, scope = nil)
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
 
       @page = 1
-      @page_size = DEFAULT_PAGE_SIZE
+      @page_size = RestPack::Serializer.config.page_size
       @includes = []
       @filters = filters_from_params(params, model_class)
       @model_class = model_class
@@ -34,7 +32,7 @@ module RestPack::Serializer
     end
 
     def default_page_size?
-      @page_size == DEFAULT_PAGE_SIZE
+      @page_size == RestPack::Serializer.config.page_size
     end
 
     def filters_as_url_params

data/lib/restpack_serializer/serializable/attributes.rb

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

data/lib/restpack_serializer/serializable/paging.rb

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

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -45,7 +45,7 @@ module RestPack::Serializer::SideLoading
         end
 
         links[link_key] = {
-          :href => RestPack::Serializer.href_prefix + href,
+          :href => RestPack::Serializer.config.href_prefix + href,
           :type => association.plural_name.to_sym
         }
       end

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.2.8'
+    VERSION = '0.2.9'
   end
 end

data/lib/restpack_serializer.rb

@@ -2,13 +2,17 @@ require 'will_paginate'
 require 'will_paginate/active_record'
 
 require 'restpack_serializer/version'
+require 'restpack_serializer/configuration'
 require 'restpack_serializer/serializable'
 require 'restpack_serializer/factory'
 
 module RestPack
   module Serializer
-    mattr_accessor :href_prefix
+    mattr_accessor :config
+    @@config = Configuration.new
 
-    @@href_prefix = ''
+    def self.setup
+      yield @@config
+    end
   end
 end

data/spec/restpack_serializer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe RestPack::Serializer do
+  before { @original_config = subject.config.clone }
+  after { subject.config = @original_config }
+
+  context "#setup" do
+    it "has defaults" do
+      subject.config.href_prefix.should == ''
+      subject.config.page_size.should == 10
+    end
+
+    it "can be configured" do
+      subject.setup do |config|
+        config.href_prefix = '/api/v1'
+        config.page_size = 50
+      end
+
+      subject.config.href_prefix.should == '/api/v1'
+      subject.config.page_size.should == 50
+    end
+  end
+end

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -61,11 +61,11 @@ describe RestPack::Serializer::SideLoading do
       }
     }
 
-    it "applies custom RestPack::Serializer.href_prefix" do
-      original = RestPack::Serializer.href_prefix
-      RestPack::Serializer.href_prefix = "/api/v1"
+    it "applies custom RestPack::Serializer.config.href_prefix" do
+      original = RestPack::Serializer.config.href_prefix
+      RestPack::Serializer.config.href_prefix = "/api/v1"
       AlbumSerializer.links["albums.artist"][:href].should == "/api/v1/artists/{albums.artist}.json"
-      RestPack::Serializer.href_prefix = original
+      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.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -181,6 +181,7 @@ files:
 - README.md
 - Rakefile
 - lib/restpack_serializer.rb
+- lib/restpack_serializer/configuration.rb
 - lib/restpack_serializer/factory.rb
 - lib/restpack_serializer/options.rb
 - lib/restpack_serializer/serializable.rb
@@ -193,6 +194,7 @@ files:
 - spec/factory/factory_spec.rb
 - spec/fixtures/db.rb
 - spec/fixtures/serializers.rb
+- spec/restpack_serializer_spec.rb
 - spec/serializable/attributes_spec.rb
 - spec/serializable/options_spec.rb
 - spec/serializable/paging_spec.rb
@@ -230,6 +232,7 @@ test_files:
 - spec/factory/factory_spec.rb
 - spec/fixtures/db.rb
 - spec/fixtures/serializers.rb
+- spec/restpack_serializer_spec.rb
 - spec/serializable/attributes_spec.rb
 - spec/serializable/options_spec.rb
 - spec/serializable/paging_spec.rb