shapeable 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 249116685b8033f80052635f2483dc5a35046537
+  data.tar.gz: 6d3212f5162741786d818022b40669ad61c6b5e1
+SHA512:
+  metadata.gz: 01ccd24321df0ddbb2ae20344f34f35c02cff8d8776dd93cbcd699f06795fe98c4a5f4dc030f58f5e313d6b77d932c4680440979ca76c43ca69527afa30f86af
+  data.tar.gz: 81a86272c1e050c4d0f598f5b960ef0fd23f7c9ffd5e2c694d26d14f2909bc223bc3e33f3520ff2ae433e62f047bc881899621794d9f507ad599c6042062fe48

data/.gitignore

@@ -0,0 +1,10 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 VTS
+
+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,63 @@
+# Shapeable
+
+API versioning that promotes convention over configuration.
+
+The premise of this gem is that consumers of your API need versioning and different shapes of your resources. Without proper thought into versioning and shaping, your codebase can quickly resolve into a redundant and confusing state. This gem tries to solve that problem by allowing the API owner to use simple conventions -- Accept headers and ActiveModelSerializer namespacing -- to achieve controller reuse by controllers delegating resource versioning and shaping to the serializer level.
+
+
+## example
+
+
+Let's say we have a resource of type `Foo` and `foos_controller.rb` that includes our gem and has a `show` action:
+
+``` Ruby
+class FoosController < ActionController::Base
+  acts_as_shapeable(path: Serializers::Foo)
+
+  def show
+    render json: Foo.new(first_name: 'Shawn'), serializer: shape(default_version: 1, default_shape: 'short')
+  end
+
+end
+```
+
+A client on v1 would like a list of `foos` in short form:
+
+`curl http://localhost:3000/foos -H 'Accept: application/javascript; version=1 shape=short'`
+
+A client on v2 would like a list of `foos` in short form:
+
+`curl http://localhost:3000/foos -H 'Accept: application/javascript; version=2 shape=short'`
+
+A client on v1 would like a list of `foos` in full form:
+
+`curl http://localhost:3000/foos -H 'Accept: application/javascript; version=1 shape=full'`
+
+A client on v2 would like a list of `foos` in default form, in this case short:
+
+`curl http://localhost:3000/foos -H 'Accept: application/javascript;`
+
+Assuming we have the following ActiveModelSerializer directory structure, we wouldn't have to change the above controller at all to fulfill these requests:
+
+```
+app
+  serializers
+    foo
+      v1
+        foo_short_serializer.rb
+        foo_full_serializer.rb
+      v2
+        foo_full_serializer.rb
+        foo_serializer.rb
+```
+
+
+The `shape` method returns the serializer constant.
+
+Both `acts_as_shapeable` and `shape` accept the following arguments:
+
+* `path`: The top level module where the serializers are defined
+* `default_version`: The default version in cases where the header is not specified
+* `default_shape`: The deafault shape in cases where the shape is not specified
+
+All three options must be defined either on `acts_as_shapeable` or `shape`. The options defined on `shape` have greater precedence than those on `acts_as_shapeable`.

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.3

data/lib/shapeable.rb

@@ -0,0 +1,48 @@
+require 'shapeable/version'
+
+module Shapeable
+
+  def acts_as_shapeable(**opts)
+
+    normalize_options(opts)
+    acts_as_shapeable_opts = opts || {}
+
+    define_method(:shape) do |opts|
+      opts = acts_as_shapeable_opts.merge(opts)
+      default_shape = opts[:default_shape]
+      default_version = opts[:default_version]
+      path = opts[:path]
+      raise ArgumentError, "specify a default shape" unless default_shape
+      raise ArgumentError, "specify a default version" unless default_version
+      raise ArgumentError, "specify a path" unless path
+      resource = path.name.split('::').last.constantize
+      if request.accept
+        version = request.accept[/version\s?=\s?(\d+)/, 1].to_i.presence || default_version
+        shape = request.accept[/shape\s?=\s?(\w+)/, 1] || default_shape
+        begin
+          serializer = path.const_get("V#{version}").const_get("#{resource}#{shape.camelize}Serializer")
+        rescue NameError
+          raise InvalidShapeError, 'invalid shape'
+        end
+      end
+      serializer
+    end
+  end
+
+  private
+
+  def normalize_options(opts)
+    opts.keep_if do |k, _v|
+      [:path, :default_shape, :default_version].include?(k)
+    end
+  end
+
+  class InvalidShapeError < NameError; end
+
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    extend Shapeable
+  end
+end

data/lib/shapeable/version.rb

@@ -0,0 +1,3 @@
+module Shapeable
+  VERSION = '0.2.0'
+end

data/shapeable.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shapeable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shapeable'
+  spec.version       = Shapeable::VERSION
+  spec.authors       = ['Shawn O\'Mara', 'Dean Nasseri']
+  spec.email         = ['shaw3257@gmail.com']
+
+  spec.summary       = 'API versioning that promotes convention over configuration'
+
+  spec.description   = 'The premise of this gem is that consumers of your API need versioning
+                        and different shapes of your resources. Without proper thought into versioning
+                        and shaping, your codebase can quickly resolve into a redundant and confusing state.
+                        This gem tries to solve that problem by allowing the API owner to use simple
+                        conventions -- Accept headers and ActiveModelSerializer namespacing -- to achieve
+                        controller reuse by controllers delegating resource versioning and shaping
+                        to the serializer level.'
+
+  spec.homepage      = 'https://github.com/viewthespace/shapeable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'active_model_serializers'
+
+  spec.add_development_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: shapeable
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Shawn O'Mara
+- Dean Nasseri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: activesupport
+  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: 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: rspec-rails
+  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: |-
+  The premise of this gem is that consumers of your API need versioning
+                          and different shapes of your resources. Without proper thought into versioning
+                          and shaping, your codebase can quickly resolve into a redundant and confusing state.
+                          This gem tries to solve that problem by allowing the API owner to use simple
+                          conventions -- Accept headers and ActiveModelSerializer namespacing -- to achieve
+                          controller reuse by controllers delegating resource versioning and shaping
+                          to the serializer level.
+email:
+- shaw3257@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- circle.yml
+- lib/shapeable.rb
+- lib/shapeable/version.rb
+- shapeable.gemspec
+homepage: https://github.com/viewthespace/shapeable
+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.4.8
+signing_key: 
+specification_version: 4
+summary: API versioning that promotes convention over configuration
+test_files: []