aepic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02a135b8f945df6ce5bc603d613d4e7618f5797c
+  data.tar.gz: 8a80b4f63e684fec3af33334ed7cc9add21d3201
+SHA512:
+  metadata.gz: 3aa6e4eef60ce11e7999dc574ffb1f9ad0ea622afbe7aeb4dfe6e037a1b6089adbf667ba08a037cc6649a2aba3741e0a84173499c67880f2c15f0a9a9a97fbed
+  data.tar.gz: 4e8eb70e130b0168f3b92d65b63c4a44ef11aa4464484cd0581edc1b6ce80c516792e5eeab991fa36ec9721c4d6c24497c2b582922b0e1f12dbfe2e4fa11c49c

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/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Semyonov
+
+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,43 @@
+# Æpic is for your epic APIs
+
+Æpic gives you ability to easily add standards-based ([JSON-API][] and [JSON-LD][]) [API][] for
+your existing [RESTful][REST] controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aepic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aepic
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Roadmap
+
+* TODO: Provide similar Atom-based XML representation
+* TODO: Provide [WADL][] for [API][]
+* TODO: Provide [RSDL][] for [API][]
+
+## 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
+
+[JSON-API]: http://jsonapi.org/
+[JSON-LD]: http://json-ld.org/
+[REST]: http://en.wikipedia.org/wiki/Representational_state_transfer
+[API]: http://en.wikipedia.org/wiki/Application_programming_interface
+[WADL]: http://en.wikipedia.org/wiki/WADL
+[RSDL]: http://en.wikipedia.org/wiki/RSDL

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aepic.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aepic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aepic'
+  spec.version       = Aepic::VERSION
+  spec.authors       = ['Alexander Semyonov']
+  spec.email         = %w(al@semyonov.us)
+  spec.description   = %q{Build your epic APIs same time you are building your website. Docs included}
+  spec.summary       = %q{Æpic is for your epic APIs}
+  spec.homepage      = 'http://github.com/alsemyonov/aepic'
+  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 = %w(lib)
+
+  spec.add_runtime_dependency 'actionpack', '>= 3.2'
+  spec.add_runtime_dependency 'active_model_serializers'
+  spec.add_runtime_dependency 'inherited_resources'
+  spec.add_runtime_dependency 'has_scope'
+  spec.add_runtime_dependency 'responders'
+  spec.add_runtime_dependency 'draper'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/app/views/application/api.html.haml

@@ -0,0 +1,26 @@
+%h1= page_title(resource_class: resource_class.model_name.human)
+
+%h2 JSON LD Context:
+%pre
+  %code= resource_serializer.jsonld
+
+%h2 Available endpoints:
+%ul
+  - if controller.respond_to?(:index)
+    %li
+      %code GET #{collection_path(format: :json)}
+  - if controller.respond_to?(:create)
+    %li
+      %code POST #{collection_path(format: :json)}
+  - if controller.respond_to?(:show)
+    %li
+      %code GET #{resource_path(':id', format: :json)}
+  - if controller.respond_to?(:update)
+    %li
+      %code PUT #{resource_path(':id', format: :json)}
+  - if controller.respond_to?(:update)
+    %li
+      %code PATCH #{resource_path(':id', format: :json)}
+  - if controller.respond_to?(:destroy)
+    %li
+      %code DELETE #{resource_path(':id', format: :json)}

data/app/views/application/api.xml.builder

@@ -0,0 +1,19 @@
+xml.application(
+  xsi: 'http://www.w3.org/2001/XMLSchema-instance',
+  'xsi:schemaLocation' => 'http://wadl.dev.java.net/2009/02 wadl.xsd',
+  xsd: 'http://www.w3.org/2001/XMLSchema',
+  xmlns: 'http://wadl.dev.java.net/2009/02') do
+
+  schema = Aepic::Schema.default
+  schema.controllers.each do |controller|
+    xml.resources base: root_url do
+      xml.resource path: "#{controller.controller_name}", id: controller.controller_name do
+        controller.action_methods.each do |action|
+          xml.method name: schema.method_for(action) do
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aepic.rb

@@ -0,0 +1,16 @@
+require 'aepic/version'
+require 'active_support'
+
+module Aepic
+  extend ActiveSupport::Autoload
+
+  autoload :Controller
+  autoload :Schema
+
+  module Concerns
+    extend ActiveSupport::Autoload
+
+    autoload :Controller
+    autoload :Serializer
+  end
+end

data/lib/aepic/concerns/controller.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+require 'aepic'
+require 'active_support/concern'
+require 'inherited_resources'
+
+module Aepic
+  module Concerns
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        inherit_resources
+
+        respond_to :json
+        respond_to :jsonld, only: :index
+
+        has_scope :ids, only: :index do |controller, scope, ids|
+          ids = ids.to_s.split(',').map { |id| id.to_i }
+          scope.where(id: ids)
+        end
+        helper_method :resource_serializer
+
+        api_schema << self
+      end
+
+      module ClassMethods
+        # @return [ActiveModel::Serializer]
+        def resource_serializer
+          resource_class.active_model_serializer
+        end
+
+        def api_schema
+          @api_schema ||= Schema.default
+        end
+      end
+
+      protected
+
+      # @return [ActiveModel::Serializer]
+      def resource_serializer
+        self.class.resource_serializer
+      end
+
+      # @return [Draper::Decorator]
+      def resource
+        get_resource_ivar || set_resource_ivar(super.decorate)
+      end
+
+      # @return [Draper::Decorator]
+      def build_resource
+        get_resource_ivar || set_resource_ivar(super.decorate)
+      end
+
+      # @return [Draper::CollectionDecorator]
+      def collection
+        get_collection_ivar || set_collection_ivar(super.decorate)
+      end
+    end
+  end
+end

data/lib/aepic/concerns/decorator.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+module Aepic
+  module Concerns
+    module Decorator
+      def jsonld_context
+        h.polymorphic_url(object.class, format: :jsonld)
+      end
+    end
+  end
+end

data/lib/aepic/concerns/serializer.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+require 'aepic'
+
+module Aepic
+  module Concerns
+    module Serializer
+      attributes :id
+
+      XSD_TYPES = Hash.new { |hash, key| hash[key] = "xsd:#{key}"}.merge({
+      })
+
+      def self.jsonld_context
+        {}.tap do |context|
+          schema[:attributes].each do |name, type|
+            context[name] = XSD_TYPES[type]
+          end
+        end
+      end
+
+      def self.jsonld
+        {'@context' => jsonld_context.merge(xsd: 'http://www.w3.org/2001/XMLSchema#')}
+      end
+
+      def attributes
+        hash = super
+        hash['@context'] = object.jsonld_context
+        hash
+      end
+    end
+  end
+end

data/lib/aepic/controller.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+require 'aepic'
+
+module Aepic
+  class Controller < ApplicationController
+    include Aepic::Concerns::Controller
+  end
+end

data/lib/aepic/schema.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+require 'aepic'
+
+module Aepic
+  class Schema
+    METHODS = {
+      :index => :get,
+      :show => :get,
+      :update => [:put, :patch],
+      :create => :post,
+      :destroy => :delete,
+      :edit => :get,
+    }
+
+    def self.default
+      @default ||= new
+    end
+
+    def resources
+      controllers.each do |controller|
+        if controller.action_methods.include?('index')
+
+        end
+      end
+    end
+
+    def controllers
+      @controllers ||= Set.new
+    end
+
+    def <<(controller)
+      controllers << controller
+    end
+
+    def method_for(action)
+      METHODS[action.to_sym].to_s.upcase
+    end
+  end
+end

data/lib/aepic/version.rb

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

data/spec/aepic_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Aepic do
+  it 'should have a version number' do
+    Aepic::VERSION.should_not be_nil
+  end
+
+  it 'should do something useful' do
+    false.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'aepic'

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: aepic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Semyonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: inherited_resources
+  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: has_scope
+  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: responders
+  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: draper
+  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
+    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: Build your epic APIs same time you are building your website. Docs included
+email:
+- al@semyonov.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aepic.gemspec
+- app/views/application/api.html.haml
+- app/views/application/api.xml.builder
+- lib/aepic.rb
+- lib/aepic/concerns/controller.rb
+- lib/aepic/concerns/decorator.rb
+- lib/aepic/concerns/serializer.rb
+- lib/aepic/controller.rb
+- lib/aepic/schema.rb
+- lib/aepic/version.rb
+- spec/aepic_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alsemyonov/aepic
+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: Æpic is for your epic APIs
+test_files:
+- spec/aepic_spec.rb
+- spec/spec_helper.rb