extendible 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0083e6b235bb54b3ea7514edc43f243f01a9f34e
+  data.tar.gz: 3fd7a8872549382ed62109cf908ce30c057cf5a6
+SHA512:
+  metadata.gz: e99dffdda5cf1f80320cc781541d2cd2cb17db1579290b04e70b72029447344e026408d4d03c18e9985942aa2aef220cf7779944aed772a3bd32dc967654d5c2
+  data.tar.gz: 726fe2a50080d2ae9023ae6bbca7c79998284dbd74f0731b8b4e783ad096c61967236bbf6fb917b2230a365f63d9250364899aaf4dfc39fa39540a9f23c520be

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in extendible.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Falkén
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Extendible
+
+Make referenced objects in your 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'extendible'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install extendible
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/extendible.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'extendible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "extendible"
+  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.summary       = %q{Serializer extension}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/extendible/version.rb

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

data/lib/extendible.rb

@@ -0,0 +1,51 @@
+module Extendible
+
+  def self.included(base)
+    base.class_eval { extend ClassMethods }
+  end
+
+  def extended_objects
+    return @extended_objects unless @extended_objects.nil?
+    # empty array if no params[:extend] is provided
+    return [] if scope[:extend].nil?
+    all = {}
+    # iterate comma separated list of objects to extend
+    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('.')
+        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
+          all[obj.to_sym] = [attr]
+        end
+      else # no dot (.) found, extend with all attributes
+        all[object_name.to_sym] = nil
+      end
+    end
+
+    @extended_objects = all
+  end
+
+  module ClassMethods
+    def extendible(*children)
+      # iterate through all obects that are supposed to be extendible
+      children.each do |child_sym|
+        attributes child_sym
+        define_method child_sym do
+          # nil if child is nonexistent
+          return nil if object.try(child_sym).nil?
+          if extended_objects.has_key?(child_sym) # params[:extend] includes child, extend attributes
+            if extended_objects[child_sym].nil? # no attributes are specified, extend with all
+              object.try(child_sym)
+            else # only extend with attributes provided with dot notation
+              object.try(child_sym).attributes.extract!(*extended_objects[child_sym].map(&:to_s))
+            end
+          else # child is not in params[:extend], only include id
+            object.try(child_sym).attributes.extract!('id')
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/extendible_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Extendible do
+	pending 'add tests'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'extendible'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: extendible
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Falkén
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes ActiveModel::Serializer objects extendible by query parameters
+email:
+- f@lken.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- extendible.gemspec
+- lib/extendible.rb
+- lib/extendible/version.rb
+- spec/extendible_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Serializer extension
+test_files:
+- spec/extendible_spec.rb
+- spec/spec_helper.rb