aepic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a135b8f945df6ce5bc603d613d4e7618f5797c
-  data.tar.gz: 8a80b4f63e684fec3af33334ed7cc9add21d3201
+  metadata.gz: e0b84ed455960e7c9b19f9406984a7dc49f14529
+  data.tar.gz: 48ca4c4d21750b579bb7f1498fb6aa1a146bc432
 SHA512:
-  metadata.gz: 3aa6e4eef60ce11e7999dc574ffb1f9ad0ea622afbe7aeb4dfe6e037a1b6089adbf667ba08a037cc6649a2aba3741e0a84173499c67880f2c15f0a9a9a97fbed
-  data.tar.gz: 4e8eb70e130b0168f3b92d65b63c4a44ef11aa4464484cd0581edc1b6ce80c516792e5eeab991fa36ec9721c4d6c24497c2b582922b0e1f12dbfe2e4fa11c49c
+  metadata.gz: b7bd2a420c029dbb10e07ef2becf4815c20abd010c2d3ca01edcf044f7ed9b14f2c824316ec21f2b8f3b115e8bcfd1b78fedb10b75717ba8df2cdd2d12d21974
+  data.tar.gz: c6fdd4a3987f7772476e693f7def5eff5c081b66dfc5f6656e0b3c9677f0d343c3f4527ffd7959b603d67a9d4521cc76ec1833c39f3f19e4bba8f7fd14da3def

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/README.md

@@ -24,8 +24,12 @@ TODO: Write usage instructions here
 ## Roadmap
 
 * TODO: Provide similar Atom-based XML representation
-* TODO: Provide [WADL][] for [API][]
-* TODO: Provide [RSDL][] for [API][]
+* TODO: Provide [WADL][]
+
+## Ideas
+
+* TODO: Provide [Swagger-compatible][Swagger] API description
+* TODO: Provide [RSDL][]
 
 ## Contributing
 
@@ -41,3 +45,4 @@ TODO: Write usage instructions here
 [API]: http://en.wikipedia.org/wiki/Application_programming_interface
 [WADL]: http://en.wikipedia.org/wiki/WADL
 [RSDL]: http://en.wikipedia.org/wiki/RSDL
+[Swagger]: https://developers.helloreverb.com/swagger/

data/aepic.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'has_scope'
   spec.add_runtime_dependency 'responders'
   spec.add_runtime_dependency 'draper'
+  spec.add_runtime_dependency 'kaminari'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

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

@@ -1,10 +1,14 @@
 %h1= page_title(resource_class: resource_class.model_name.human)
 
-%h2 JSON LD Context:
+%h2 JSON-LD Context:
+%p
+  Link:
+  %code= link_to(collection_url(format: :jsonld))
 %pre
-  %code= resource_serializer.jsonld
+  JSON:
+  %code= JSON.pretty_generate resource_serializer.jsonld
 
-%h2 Available endpoints:
+%h2 Resources:
 %ul
   - if controller.respond_to?(:index)
     %li

data/app/views/application/index.jsonld.erb

@@ -0,0 +1 @@
+<%= raw resource_serializer.jsonld.to_json %>

data/lib/aepic.rb

@@ -1,16 +1,24 @@
 require 'aepic/version'
 require 'active_support'
+require 'active_support/concern'
 
 module Aepic
   extend ActiveSupport::Autoload
 
   autoload :Controller
+  autoload :Engine
   autoload :Schema
+  autoload :Responder
+  autoload :Serializer
 
   module Concerns
     extend ActiveSupport::Autoload
 
     autoload :Controller
+    autoload :Decorator
+    autoload :Responder
     autoload :Serializer
   end
 end
+
+require 'aepic/engine' if defined?(Rails)

data/lib/aepic/concerns/controller.rb

@@ -2,6 +2,8 @@
 require 'aepic'
 require 'active_support/concern'
 require 'inherited_resources'
+require 'has_scope'
+require 'kaminari'
 
 module Aepic
   module Concerns
@@ -10,6 +12,8 @@ module Aepic
 
       included do
         inherit_resources
+        self.perform_caching = true
+        self.responder = Aepic::Responder
 
         respond_to :json
         respond_to :jsonld, only: :index
@@ -18,8 +22,13 @@ module Aepic
           ids = ids.to_s.split(',').map { |id| id.to_i }
           scope.where(id: ids)
         end
+
+        has_scope :page, only: :index, default: '1'
+        has_scope :per, only: :index
         helper_method :resource_serializer
 
+        include Overrides
+
         api_schema << self
       end
 
@@ -29,31 +38,71 @@ module Aepic
           resource_class.active_model_serializer
         end
 
+        # @return [Draper::Decorator]
+        def resource_decorator
+          "#{resource_class.name}Decorator".safe_constantize
+        end
+
         def api_schema
           @api_schema ||= Schema.default
         end
       end
 
-      protected
+      module Overrides
+        protected
 
-      # @return [ActiveModel::Serializer]
-      def resource_serializer
-        self.class.resource_serializer
-      end
+        # @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 resource_decorator
+          self.class.resource_decorator
+        end
 
-      # @return [Draper::Decorator]
-      def build_resource
-        get_resource_ivar || set_resource_ivar(super.decorate)
-      end
+        # @return [Draper::Decorator]
+        def resource
+          get_resource_ivar || set_resource_ivar(resource_decorator.decorate(super))
+        end
+
+        # @return [Draper::Decorator]
+        def build_resource
+          get_resource_ivar || set_resource_ivar(resource_decorator.decorate(super))
+        end
+
+        # @return [Draper::CollectionDecorator]
+        def collection
+          get_collection_ivar || set_collection_ivar(resource_decorator.decorate_collection(super))
+        end
 
-      # @return [Draper::CollectionDecorator]
-      def collection
-        get_collection_ivar || set_collection_ivar(super.decorate)
+        # @see http://jsonapi.org/format/
+        # Singular resources are represented as JSON objects.
+        # However, they are still wrapped inside an array:
+        # {"posts": [{ ... }]}
+        # This simplifies processing, as you can know that a resource key
+        # will always be a list.
+        def _render_option_json(resource, options)
+          options[:meta] ||= {}
+
+          etags = combine_etags(resource)
+          key = ActiveSupport::Cache.expand_cache_key(etags)
+          etag = %("#{Digest::MD5.hexdigest(key)}")
+          options[:meta][:etag] = etag
+
+          resource = Array.wrap(resource) unless resource.respond_to?(:length)
+          if resource.respond_to?(:total_count)
+            options[:meta][:total] = resource.total_count
+          end
+
+          json = ActiveModel::Serializer.build_json(self, resource, options)
+
+          if json
+            super(json, options)
+          else
+            super
+          end
+        end
       end
     end
   end

data/lib/aepic/concerns/decorator.rb

@@ -1,10 +1,20 @@
 # coding: utf-8
 
+require 'aepic'
+
 module Aepic
   module Concerns
     module Decorator
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def jsonld_context
+          @json_context ||= h.polymorphic_url(object_class, format: :jsonld)
+        end
+      end
+
       def jsonld_context
-        h.polymorphic_url(object.class, format: :jsonld)
+        self.class.jsonld_context
       end
     end
   end

data/lib/aepic/concerns/responder.rb

@@ -0,0 +1,40 @@
+require 'aepic'
+require 'responders'
+
+module Aepic
+  module Concerns
+    module Responder
+      extend ActiveSupport::Concern
+
+      include Responders::HttpCacheResponder
+
+      private
+
+      def do_http_cache?
+        get? && (@http_cache != false) && persisted? && resourceful? && resource_item.respond_to?(:updated_at)
+      end
+
+      # @return [Boolean]
+      def do_http_cache!
+        last_modified = resource_item.updated_at
+        etag = resource_collection
+
+        resource_collection.each do |resource|
+          last_modified = resource.updated_at if resource.updated_at > last_modified
+        end if resource_collection.length > 1
+
+        !controller.stale?(etag: etag, last_modified: last_modified)
+      end
+
+      # @return [Array] array of resources
+      def resource_collection
+        @resource_collection ||= resource.is_a?(Array) ? resource : resources
+      end
+
+      # @return [Object] just one resource
+      def resource_item
+        @resource_item ||= resource.is_a?(Array) ? resource.last : resource
+      end
+    end
+  end
+end

data/lib/aepic/concerns/serializer.rb

@@ -4,27 +4,49 @@ require 'aepic'
 module Aepic
   module Concerns
     module Serializer
-      attributes :id
+      extend ActiveSupport::Concern
 
-      XSD_TYPES = Hash.new { |hash, key| hash[key] = "xsd:#{key}"}.merge({
+      XSD_TYPES = Hash.new do |hash, key|
+        hash[key] = "xsd:#{key}"
+      end.merge({
       })
 
-      def self.jsonld_context
-        {}.tap do |context|
-          schema[:attributes].each do |name, type|
-            context[name] = XSD_TYPES[type]
+      included { attributes :id }
+
+      module ClassMethods
+        def jsonld_context
+          {}.tap do |context|
+            schema[:attributes].each do |name, type|
+              context[name] = XSD_TYPES[type]
+            end
+            schema[:associations].each do |name, type|
+              class_name = name.to_s
+              if class_name =~ /_ids?\Z/
+                context[name] = 'xsd:integer'
+              else
+                class_name = name.to_s.classify
+                associated_class = "#{class_name}Decorator".constantize
+                context[name] = associated_class.jsonld_context
+              end
+            end
           end
         end
-      end
 
-      def self.jsonld
-        {'@context' => jsonld_context.merge(xsd: 'http://www.w3.org/2001/XMLSchema#')}
+        def jsonld
+          {'@context' => {xsd: 'http://www.w3.org/2001/XMLSchema#'}.merge(jsonld_context)}
+        end
       end
 
+      #def root_name
+      #  self.class._root
+      #end
+
       def attributes
-        hash = super
-        hash['@context'] = object.jsonld_context
-        hash
+        {'@context' => jsonld_context}.merge(super)
+      end
+
+      def jsonld_context
+        object.jsonld_context
       end
     end
   end

data/lib/aepic/engine.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+require 'aepic'
+require 'rails/engine'
+
+module Aepic
+  class Engine < Rails::Engine
+    initializer 'aepic.mime_types' do
+      # Unable to add Mime type synonym (only extension synonyms supported), so reregister JSON
+      Mime::Type.unregister :json
+      Mime::Type.register 'application/json', :json, %w( text/x-json application/jsonrequest application/vnd.api+json )
+      Mime::Type.register 'application/ld+json', :jsonld
+
+      require 'action_controller/metal/renderers'
+      ActionController::Renderers.add(:jsonld) do |object, options|
+        self.content_type = Mime[:jsonld]
+        object.respond_to?(:jsonld) ? object.jsonld.to_json(options) : object
+      end
+    end
+  end
+end

data/lib/aepic/responder.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+require 'aepic'
+require 'aepic/concerns/responder'
+
+module Aepic
+  class Responder < ActionController::Responder
+    include Aepic::Concerns::Responder
+  end
+end

data/lib/aepic/schema.rb

@@ -17,11 +17,13 @@ module Aepic
     end
 
     def resources
-      controllers.each do |controller|
-        if controller.action_methods.include?('index')
-
+      @resources ||=
+        controllers.inject do |resources, controller|
+          if controller.action_methods.include?('index')
+            resources << Resource.new()
+          end
+          resources
         end
-      end
     end
 
     def controllers

data/lib/aepic/serializer.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+require 'aepic'
+require 'active_model_serializers'
+
+module Aepic
+  class Serializer < ActiveModel::Serializer
+    include Aepic::Concerns::Serializer
+  end
+end

data/lib/aepic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aepic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Semyonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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
@@ -145,6 +159,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -153,12 +168,17 @@ files:
 - aepic.gemspec
 - app/views/application/api.html.haml
 - app/views/application/api.xml.builder
+- app/views/application/index.jsonld.erb
 - lib/aepic.rb
 - lib/aepic/concerns/controller.rb
 - lib/aepic/concerns/decorator.rb
+- lib/aepic/concerns/responder.rb
 - lib/aepic/concerns/serializer.rb
 - lib/aepic/controller.rb
+- lib/aepic/engine.rb
+- lib/aepic/responder.rb
 - lib/aepic/schema.rb
+- lib/aepic/serializer.rb
 - lib/aepic/version.rb
 - spec/aepic_spec.rb
 - spec/spec_helper.rb
@@ -182,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Æpic is for your epic APIs