apiarist 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWMwYzdkMTU3YTM2M2NhNTE3ZTZiY2YwYWZjNjBmNDIxNmU4ZDVhZQ==
+  data.tar.gz: !binary |-
+    OGQ2ZWM3MzhhYTBmODdiM2NiNTY2MmM3MDMzZmQ0ZjAzNGZhYTQ1OQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjgxMzNmNmVjNWZlNTBjNWNhYzljNmEwNWIyMDJlZjg3ODZkOTJkOTM3Yjhl
+    OGYzMDgzOGI0NDhiMGFlZTdlZTBkYWIyNTZjNjNmMGFiNTFkZDhhNmE2NWZj
+    NDlhODc4NmE2ODQ4NjE0ZWRjYWNlOTI0YzZkYTg2ZjkxMzA2MzM=
+  data.tar.gz: !binary |-
+    MTI3NzQwMTY2MDAyYmY5ZjM3OWIyNTIxZTAyNDA0NmMyOTJkOWRlYzUwMTE2
+    ZTkzMmYxZGEzNzZhMjg1MzFmMmRmMGFhNzI0YWQ1MjhhYjEyMzhmMTI3ZTgy
+    ZjhlNDVkZmM3ODg0YjlhMWExM2E2OGJiYjY1ZmZjZWM3YWU4OWY=

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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Victor Martinez
+
+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,66 @@
+# Apiarist
+
+Apiarist is an opinionated [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) alternative
+
+## Why?
+
+* Built on the top of [inherited_resources](https://github.com/josevalim/inherited_resources). Creating an API is as easy as defining your resource representations.
+* Serializers inherit controller's namespace making it easier to version and maintain your API.
+* Serialization scopes: allows you to define different representations of the same resource.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'apiarist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apiarist
+
+## Usage
+
+~~~ruby
+# app/controllers/api/v1/products_controller.rb
+class Api::V1::Products < Apiarist::ResourceController::Base
+  actions :index, :show
+  belongs_to :category
+
+  serialization_scope :basic, only: :index
+  serialization_scope :extended, only: :show
+end
+
+# app/serializers/api/v1/category_serializer.rb
+class Api::V1::CategorySerializer < Apiarist::Serializer
+  attributes :id, :name
+end
+
+# app/serializers/api/v1/product_serializer.rb
+class Api::V1::ProductSerializer < Apiarist::Serializer
+  attributes :id, :name, :description
+
+  scope :basic do
+    attribute :category_name
+  end
+
+  scope :extended do
+    association :category
+  end
+
+  def category_name
+    category.name
+  end
+end
+~~~
+
+## 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/apiarist.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiarist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apiarist"
+  spec.version       = Apiarist::VERSION
+  spec.authors       = ["Victor Martinez"]
+  spec.email         = ["knoopx@gmail.com"]
+  spec.description   = %q{An opinionated ActiveModel::Serializers alternative}
+  spec.summary       = %q{An opinionated ActiveModel::Serializers alternative}
+  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_dependency 'activesupport', '>= 3.0'
+  spec.add_dependency 'actionpack', '>= 3.0'
+  spec.add_dependency 'inherited_resources', '>= 1.3.1'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/apiarist.rb

@@ -0,0 +1,8 @@
+module Apiarist
+  autoload :AbstractController, 'apiarist/abstract_controller'
+  autoload :Controller, 'apiarist/controller'
+  autoload :ResourceController, 'apiarist/resource_controller'
+  autoload :Serialization, 'apiarist/serialization'
+  autoload :Serializer, 'apiarist/serializer'
+  autoload :VERSION, 'apiarist/version'
+end

data/lib/apiarist/abstract_controller.rb

@@ -0,0 +1,30 @@
+require 'action_controller/metal'
+
+module Apiarist
+  class AbstractController < ActionController::Metal
+    SKIP_MODULES = [:Cookies, :Flash, :RequestForgeryProtection, :HttpAuthentication]
+
+    abstract!
+
+    module Compatibility
+      def cache_store; end
+      def cache_store=(*); end
+      def assets_dir=(*); end
+      def javascripts_dir=(*); end
+      def stylesheets_dir=(*); end
+      def page_cache_directory=(*); end
+      def asset_path=(*); end
+      def asset_host=(*); end
+      def relative_url_root=(*); end
+      def perform_caching=(*); end
+      def helpers_path=(*); end
+      def allow_forgery_protection=(*); end
+      def helper_method(*); end
+      def helper(*); end
+    end
+
+    extend Compatibility
+    ActionController::Base.without_modules(SKIP_MODULES).each { |mod| include mod }
+    ActiveSupport.run_load_hooks(:action_controller, self)
+  end
+end

data/lib/apiarist/controller.rb

@@ -0,0 +1,6 @@
+module Apiarist
+  module Controller
+    autoload :Base, 'apiarist/controller/base'
+    autoload :Serialization, 'apiarist/controller/serialization'
+  end
+end

data/lib/apiarist/controller/base.rb

@@ -0,0 +1,9 @@
+module Apiarist
+  module Controller
+    class Base < Apiarist::AbstractController
+      respond_to :json
+
+      include Apiarist::Controller::Serialization
+    end
+  end
+end

data/lib/apiarist/controller/serialization.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module Apiarist
+  module Controller
+    module Serialization
+      extend ActiveSupport::Concern
+      include Apiarist::Serialization
+
+      included do
+        class_attribute :_serialization_scope
+        self._serialization_scope = :default
+      end
+
+      def serialization_context
+        self
+      end
+
+      module ClassMethods
+        def serialization_scope(name, opts = {})
+          before_filter(opts) { self._serialization_scope = name }
+        end
+      end
+    end
+  end
+end

data/lib/apiarist/resource_controller.rb

@@ -0,0 +1,6 @@
+module Apiarist
+  module ResourceController
+    autoload :Base, 'apiarist/resource_controller/base'
+    autoload :Responder, 'apiarist/resource_controller/responder'
+  end
+end

data/lib/apiarist/resource_controller/base.rb

@@ -0,0 +1,12 @@
+require 'inherited_resources/base'
+
+module Apiarist
+  module ResourceController
+    class Base < Apiarist::Controller::Base
+      InheritedResources::Base.inherit_resources(self)
+
+      respond_to :json
+      self.responder = Responder
+    end
+  end
+end

data/lib/apiarist/resource_controller/responder.rb

@@ -0,0 +1,20 @@
+require 'action_controller/metal/responder'
+require 'active_support/core_ext/module/delegation'
+
+module Apiarist
+  module ResourceController
+    class Responder < ActionController::Responder
+      delegate :serialize, :resource_class, :_serialization_scope, to: :controller
+
+      def display(resource, options = {})
+        if resource.respond_to?(:each)
+          root = resource_class.name.underscore.pluralize
+        else
+          root = resource_class.name.underscore
+        end
+
+        super({root => serialize(resource, scope: _serialization_scope)}, options)
+      end
+    end
+  end
+end

data/lib/apiarist/serialization.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+
+module Apiarist
+  module Serialization
+    def serialize(obj, opts = {})
+      if obj.respond_to?(:map)
+        obj.map { |resource| serialize_object(resource, opts) }
+      else
+        serialize_object(obj, opts)
+      end
+    end
+
+    private
+
+    def serialize_object(obj, opts = {})
+      opts.assert_valid_keys(:scope, :context, :serializer)
+      obj && opts.fetch(:serializer, serializer_class(obj.class)).new(obj, serialization_context, opts)
+    end
+
+    def serializer_class(resource_class)
+      "#{self.class.name.deconstantize}::#{resource_class}Serializer".constantize
+    end
+  end
+end

data/lib/apiarist/serializer.rb

@@ -0,0 +1,79 @@
+require 'delegate'
+require 'active_support/core_ext/array/extract_options'
+
+module Apiarist
+  class Serializer < SimpleDelegator
+    include Apiarist::Serialization
+
+    attr_reader :context
+
+    def initialize(resource, context = self, opts = {})
+      @resource = resource, @context = context
+      @options = opts
+      super(resource)
+    end
+
+    alias_method :resource, :__getobj__
+
+    def as_json(_ = {})
+      json = {}
+      _keys.each_with_object(json) do |(name, opts), hash|
+        serialization_opts = opts.dup
+        key = serialization_opts.delete(:as) || name
+
+        if serialization_scope_include?(serialization_opts.delete(:if))
+          case serialization_opts.delete(:type)
+            when :association
+              value = serialize(send(name), serialization_opts)
+            else
+              value = send(name)
+          end
+
+          hash[key] = value
+        end
+      end
+
+      json
+    end
+
+    def serialization_context
+      context.serialization_context
+    end
+
+    class << self
+      def attribute(name, opts = {})
+        self._keys = _keys.dup
+        _keys[name] = opts
+      end
+
+      def attributes(*names)
+        opts = names.extract_options!
+        names.each { |name| attribute(name, opts) }
+      end
+
+      def association(name, opts = {})
+        attribute(name, opts.merge(type: :association))
+      end
+
+      def associations(*associations)
+        opts = associations.extract_options!
+        associations.each { |name| association(name, opts) }
+      end
+
+      def scope(name, &block)
+        with_options(if: name) do |scope|
+          scope.instance_eval(&block)
+        end
+      end
+    end
+
+    private
+
+    class_attribute :_keys
+    self._keys = {}
+
+    def serialization_scope_include?(scope)
+      [@options[:scope], nil].flatten.include?(scope)
+    end
+  end
+end

data/lib/apiarist/version.rb

@@ -0,0 +1,3 @@
+module Apiarist
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: apiarist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Martinez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  name: activesupport
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  name: actionpack
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  name: inherited_resources
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rake
+description: An opinionated ActiveModel::Serializers alternative
+email:
+- knoopx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apiarist.gemspec
+- lib/apiarist.rb
+- lib/apiarist/abstract_controller.rb
+- lib/apiarist/controller.rb
+- lib/apiarist/controller/base.rb
+- lib/apiarist/controller/serialization.rb
+- lib/apiarist/resource_controller.rb
+- lib/apiarist/resource_controller/base.rb
+- lib/apiarist/resource_controller/responder.rb
+- lib/apiarist/serialization.rb
+- lib/apiarist/serializer.rb
+- lib/apiarist/version.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: An opinionated ActiveModel::Serializers alternative
+test_files: []