extendible 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0083e6b235bb54b3ea7514edc43f243f01a9f34e
-  data.tar.gz: 3fd7a8872549382ed62109cf908ce30c057cf5a6
+  metadata.gz: cf2096b90c342157893afa133b45e9a61f3eccb0
+  data.tar.gz: d4aec8e5d1729ea0886514815cd176bde73d3dde
 SHA512:
-  metadata.gz: e99dffdda5cf1f80320cc781541d2cd2cb17db1579290b04e70b72029447344e026408d4d03c18e9985942aa2aef220cf7779944aed772a3bd32dc967654d5c2
-  data.tar.gz: 726fe2a50080d2ae9023ae6bbca7c79998284dbd74f0731b8b4e783ad096c61967236bbf6fb917b2230a365f63d9250364899aaf4dfc39fa39540a9f23c520be
+  metadata.gz: 27b0174585d3c96bcf100da65d703d8d20ac6a830f18e473f8a2afe662085038b68e97678c7bbbd577f524ff81eac26522b66fe849b296094c666002f4b452e1
+  data.tar.gz: 2ee0d6ae8a28df83826730edb699fc295507aa2a4e7f942d0f50fea4f6caeaa72947a1562430ff976996b902e6b2aaed201c7609267878c01233ade0aaa64532

data/README.md

@@ -1,8 +1,8 @@
 # Extendible
 
-Make referenced objects in your API only include ID attribute by default, and extend them using URL parameters.
+Let referenced objects in your ActiveModel::Serializer based API only include ID attribute by default, and extend them using URL parameters.
 
-e.g. `https://resource-endpoint?extend=author.name,author.email` to extend your referenced author with its name and email attributes.
+e.g. `https://api/resource?extend=author.name,author.username` to extend your referenced author with its name and username attributes.
 
 ## Installation
 
@@ -20,7 +20,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to scope your params to the serializer by adding this to your controller:
+
+    serialization_scope :params
+
+and also include extendible in your serializer class:
+
+    include Extendible     
+
+Then you can define your extendible references simply by adding this your serializer
+
+    extendible :author
+
+You can also make multiple referenced objects extendible        
+    
+    extendible :author, :category
+
+*full example of app/serializers/post_serializer.rb*
+
+    class PostSerializer < ActiveModel::Serializer
+      include Extendible
+
+      attributes :id,
+                 :subject,
+                 :body
+
+
+      extendible :author
+    end
+
+This will by default only include the id attribute for your author object
+
+    {
+      ...
+      "author": {
+        "id": 1
+      }
+    }
+
+You can then extend the object by passing `?extend=author` in the URL, which will include all author attributes
+
+    {
+      ...
+      "author": {
+        "id": 1,
+        "name": "Robert Falken",
+        "username": "robertfalken"
+      }
+    }
+
+Or, if you would like to only get the username, use dot notation `?extend=author.username`
+
+    {
+      ...
+      "author": {
+        "id": 1,
+        "username": "robertfalken"
+      }
+    }
+
+You also can extend multiple objects or attributes by comma separating them `?extend=author.username,category`    
 
 ## Contributing
 

data/extendible.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Extendible::VERSION
   spec.authors       = ["Robert Falkén"]
   spec.email         = ["f@lken.se"]
-  spec.description   = %q{Makes ActiveModel::Serializer objects extendible by query parameters}
+  spec.description   = %q{Makes ActiveModel::Serializer objects extendible by URL parameters}
   spec.summary       = %q{Serializer extension}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/robertfalken/extendible"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'active_model_serializers'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/extendible.rb

@@ -13,6 +13,7 @@ module Extendible
     scope[:extend].split(',').map(&:strip).each do |object_name|
       if object_name.include?('.') # dot found, split into object and attribute
         obj, attr = object_name.split('.')
+        all[obj.to_sym] = ['id'] unless all.has_key?(obj.to_sym)
         if all.has_key?(obj.to_sym) # object already has attributes specified, add attribute to array
           all[obj.to_sym] << attr
         else # first attribute for array, initialize array with attribute

data/lib/extendible/version.rb

@@ -1,3 +1,3 @@
 module Extendible
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/extendible_spec.rb

@@ -1,5 +1,19 @@
 require 'spec_helper'
 
+
+class TestSerializer < ActiveModel::Serializer
+  include Extendible
+end
+
+
 describe Extendible do
-	pending 'add tests'
+  it 'responds to extendible' do
+    expect(TestSerializer.respond_to?(:extendible)).to be_true
+  end
+
+  it 'makes extendible objects available' do
+    serializer = TestSerializer.new({})
+    TestSerializer.extendible :ref_one, :ref_two
+    expect((serializer.respond_to?(:ref_one) and serializer.respond_to?(:ref_two))).to be_true
+  end
 end

data/spec/spec_helper.rb

@@ -2,3 +2,10 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'extendible'
+require 'active_model_serializers'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extendible
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Falkén
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Makes ActiveModel::Serializer objects extendible by query parameters
+description: Makes ActiveModel::Serializer objects extendible by URL parameters
 email:
 - f@lken.se
 executables: []
@@ -69,7 +83,7 @@ files:
 - lib/extendible/version.rb
 - spec/extendible_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/robertfalken/extendible
 licenses:
 - MIT
 metadata: {}