jsonapi-serializers 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d249f8286496af92b2caa669aede02fae2def8
-  data.tar.gz: 660a8816d3b5fa6bb4c1d173cc7aceabca5c0550
+  metadata.gz: 7e698b9154b539960338d5350474f81c77aa0c1e
+  data.tar.gz: 08be38cb9c93ceb3812d05d0ce29e3d4cd318d32
 SHA512:
-  metadata.gz: 1843eb6c3c067686497e28efc782328d1bbaf4571d25bc7fd87bf7bb46188119894db28f4d7072adaa5de3c823881a5b09699b3dcd5e7b5e6dd835f0882b7a9f
-  data.tar.gz: 3de93fc69bd9a1350d7246054858c4b623c3b9a7cb84057ba2d322042b6b32937e275f01f8eeb79a5fc98e7a4b6ed72a5d18e6b870f80d90563af83d061ed537
+  metadata.gz: b2798644c46503bc5ea943cf245b855a132667ef2370219ae32b73be1629bdbb27154154b778d2c5528ae823ef96ce296e9f1e199e447e7ac5936b5ec01fca10
+  data.tar.gz: 8938cae3c0014f386449736e7ba7f5a703948ecb084814dcdafd2c6bc1ec925890d7296d5374845926a547f20f4825b9a5bddcb9ea0c0b8e69f92a36b6149331

data/README.md

@@ -16,6 +16,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [Null handling](#null-handling)
   * [Custom attributes](#custom-attributes)
   * [More customizations](#more-customizations)
+  * [Base URL](#base-url)
 * [Relationships](#relationships)
   * [Compound documents and includes](#compound-documents-and-includes)
   * [Relationship path handling](#relationship-path-handling)
@@ -208,8 +209,14 @@ def meta
 end
 ```
 ```ruby
+# Override this to set a base URL (http://example.com) for all links. No trailing slash.
+def base_url
+  @base_url
+end
+```
+```ruby
 def self_link
-  "/#{type}/#{id}"
+  "#{base_url}/#{type}/#{id}"
 end
 ```
 ```ruby
@@ -225,6 +232,70 @@ end
 
 If you override `self_link`, `relationship_self_link`, or `relationship_related_link` to return `nil`, the link will be excluded from the serialized object.
 
+### Base URL
+
+You can override the `base_url` instance method to set a URL to be used in all links.
+
+```ruby
+class BaseSerializer
+  include JSONAPI::Serializer
+
+  def base_url
+    'http://example.com'
+  end
+end
+
+class PostSerializer < BaseSerializer
+  attribute :title
+  attribute :content
+
+  has_one :author
+  has_many :comments
+end
+
+JSONAPI::Serializer.serialize(post)
+```
+
+Returns:
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "posts",
+    "attributes": {
+      "title": "Hello World",
+      "content": "Your first post"
+    },
+    "links": {
+      "self": "http://example.com/posts/1"
+    },
+    "relationships": {
+      "author": {
+        "links": {
+          "self": "http://example.com/posts/1/relationships/author",
+          "related": "http://example.com/posts/1/author"
+        }
+      },
+      "comments": {
+        "links": {
+          "self": "http://example.com/posts/1/relationships/comments",
+          "related": "http://example.com/posts/1/comments"
+        },
+      }
+    }
+  }
+}
+```
+
+Alternatively, you can specify `base_url` as an argument to `serialize` which allows you to build the URL with different subdomains or other logic from the request:
+
+```ruby
+JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
+```
+
+Note: if you override `self_link` in your serializer and leave out `base_url`, it will not be included.
+
 ## Relationships
 
 You can easily specify relationships with the `has_one` and `has_many` directives.
@@ -439,6 +510,7 @@ end
 
 ## Release notes
 
+* v0.2.6: Add `base_url` support.
 * v0.2.5: Allow disabling ambiguous collection checks for Sequel support.
 * v0.2.4: Improve handling for nil relationship links.
 * v0.2.3: Support serializers with no attributes.

data/lib/jsonapi-serializers/serializer.rb

@@ -24,10 +24,12 @@ module JSONAPI
     module InstanceMethods
       attr_accessor :object
       attr_accessor :context
+      attr_accessor :base_url
 
       def initialize(object, options = {})
         @object = object
         @context = options[:context] || {}
+        @base_url = options[:base_url]
 
         # Internal serializer options, not exposed through attr_accessor. No touchie.
         @_include_linkages = options[:include_linkages] || []
@@ -64,8 +66,13 @@ module JSONAPI
       def meta
       end
 
+      # Override this to set a base URL (http://example.com) for all links. No trailing slash.
+      def base_url
+        @base_url
+      end
+
       def self_link
-        "/#{type}/#{id}"
+        "#{base_url}/#{type}/#{id}"
       end
 
       def relationship_self_link(attribute_name)
@@ -214,6 +221,7 @@ module JSONAPI
       options[:serializer] = options.delete('serializer') || options[:serializer]
       options[:context] = options.delete('context') || options[:context] || {}
       options[:skip_collection_check] = options.delete('skip_collection_check') || options[:skip_collection_check] || false
+      options[:base_url] = options.delete('base_url') || options[:base_url]
 
       # Normalize includes.
       includes = options[:include]
@@ -223,7 +231,8 @@ module JSONAPI
       passthrough_options = {
         context: options[:context],
         serializer: options[:serializer],
-        include: includes
+        include: includes,
+        base_url: options[:base_url]
       }
 
       if !options[:skip_collection_check] && options[:is_collection] && !objects.respond_to?(:each)
@@ -280,10 +289,11 @@ module JSONAPI
         end
 
         result['included'] = relationship_data.map do |_, data|
-          passthrough_options = {}
-          passthrough_options[:serializer] = find_serializer_class(data[:object])
-          passthrough_options[:include_linkages] = data[:include_linkages]
-          serialize_primary(data[:object], passthrough_options)
+          included_passthrough_options = {}
+          included_passthrough_options[:base_url] = passthrough_options[:base_url]
+          included_passthrough_options[:serializer] = find_serializer_class(data[:object])
+          included_passthrough_options[:include_linkages] = data[:include_linkages]
+          serialize_primary(data[:object], included_passthrough_options)
         end
       end
       result

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.2.5'
+    VERSION = '0.2.6'
   end
 end

data/spec/serializer_spec.rb

@@ -705,4 +705,37 @@ describe JSONAPI::Serializer do
     xit 'is correctly passed through all serializers' do
     end
   end
+
+  describe 'base_url' do
+    it 'is empty by default' do
+      long_comments = create_list(:long_comment, 1)
+      post = create(:post, long_comments: long_comments)
+      data = JSONAPI::Serializer.serialize(post)
+      expect(data['data']['links']['self']).to eq('/posts/1')
+      expect(data['data']['relationships']['author']['links']).to eq({
+        'self' => '/posts/1/relationships/author',
+        'related' => '/posts/1/author'
+      })
+    end
+    it 'adds base_url to links if passed' do
+      long_comments = create_list(:long_comment, 1)
+      post = create(:post, long_comments: long_comments)
+      data = JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
+      expect(data['data']['links']['self']).to eq('http://example.com/posts/1')
+      expect(data['data']['relationships']['author']['links']).to eq({
+        'self' => 'http://example.com/posts/1/relationships/author',
+        'related' => 'http://example.com/posts/1/author'
+      })
+    end
+    it 'uses overriden base_url method if it exists' do
+      long_comments = create_list(:long_comment, 1)
+      post = create(:post, long_comments: long_comments)
+      data = JSONAPI::Serializer.serialize(post, serializer: MyApp::PostSerializerWithBaseUrl)
+      expect(data['data']['links']['self']).to eq('http://example.com/posts/1')
+      expect(data['data']['relationships']['author']['links']).to eq({
+        'self' => 'http://example.com/posts/1/relationships/author',
+        'related' => 'http://example.com/posts/1/author'
+      })
+    end
+  end
 end

data/spec/support/serializers.rb

@@ -115,6 +115,22 @@ module MyApp
     end
   end
 
+  class PostSerializerWithBaseUrl
+    include JSONAPI::Serializer
+
+    def base_url
+      'http://example.com'
+    end
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    has_one :author
+    has_many :long_comments
+  end
+
   class EmptySerializer
     include JSONAPI::Serializer
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Mike Fotinakis