aepic 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b84ed455960e7c9b19f9406984a7dc49f14529
-  data.tar.gz: 48ca4c4d21750b579bb7f1498fb6aa1a146bc432
+  metadata.gz: 971b3b0f35e7ea9e4d72c4d41dd4e12a3e3137c5
+  data.tar.gz: 8de792fc9d7a30eb486a2f55acaa095c0f4a0ed2
 SHA512:
-  metadata.gz: b7bd2a420c029dbb10e07ef2becf4815c20abd010c2d3ca01edcf044f7ed9b14f2c824316ec21f2b8f3b115e8bcfd1b78fedb10b75717ba8df2cdd2d12d21974
-  data.tar.gz: c6fdd4a3987f7772476e693f7def5eff5c081b66dfc5f6656e0b3c9677f0d343c3f4527ffd7959b603d67a9d4521cc76ec1833c39f3f19e4bba8f7fd14da3def
+  metadata.gz: 9c189a9c8b35d0aa93ff4c820e71b8ebf7c5c6a2d89888e0648cbbf69cba618c14292d85b595ab75e851009d78d818641ed7f93ebfecd4b8a0524e3aaba61d73
+  data.tar.gz: e8b28d75408909a18b944ffde972f3e9329c9b3fecfc9df78295ce0ab2124a381e18479b798b238a56c890d9df9cf1e227959d00eeb9b85629702adf0fe82b9e

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aepic.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 3.4.0'
+  gem 'simplecov', '~> 0.11.0'
+end

data/README.md

@@ -46,3 +46,7 @@ TODO: Write usage instructions here
 [WADL]: http://en.wikipedia.org/wiki/WADL
 [RSDL]: http://en.wikipedia.org/wiki/RSDL
 [Swagger]: https://developers.helloreverb.com/swagger/
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/alsemyonov/aepic/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/aepic.gemspec

@@ -18,15 +18,16 @@ Gem::Specification.new do |spec|
   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_runtime_dependency 'kaminari'
+  spec.add_runtime_dependency 'actionpack', '~> 4.2.5'
+  spec.add_runtime_dependency 'active_model_serializers', '~> 0.10.0.rc3'
+  spec.add_runtime_dependency 'inherited_resources', '~> 1.6.0'
+  spec.add_runtime_dependency 'has_scope', '~> 0.6.0'
+  spec.add_runtime_dependency 'responders', '~> 2.1.0'
+  spec.add_runtime_dependency 'draper', '~> 2.1.0'
+  spec.add_runtime_dependency 'kaminari', '~> 0.16.3'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'apipie-rails'
 end

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

@@ -0,0 +1,24 @@
+h1= page_title(resource_class: resource_class.model_name.human)
+
+h2 JSON-LD Context:
+p
+  | Link:
+  code= link_to(collection_url(format: :jsonld))
+pre
+  | JSON:
+  code= JSON.pretty_generate resource_serializer.jsonld
+
+h2 Resources:
+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/lib/aepic.rb

@@ -1,3 +1,11 @@
+# Dependencies
+require 'inherited_resources'
+require 'responders'
+require 'kaminari'
+require 'has_scope'
+require 'apipie-rails'
+
+# AEpic
 require 'aepic/version'
 require 'active_support'
 require 'active_support/concern'
@@ -14,6 +22,7 @@ module Aepic
   module Concerns
     extend ActiveSupport::Autoload
 
+    autoload :ApiController
     autoload :Controller
     autoload :Decorator
     autoload :Responder

data/lib/aepic/concerns/api_controller.rb

@@ -0,0 +1,90 @@
+# coding: utf-8
+require 'aepic'
+require 'active_support/concern'
+require 'apipie-rails'
+require 'apipie/validator/integer_validator'
+
+module Aepic
+  module Concerns
+    module ApiController
+      extend ActiveSupport::Concern
+
+      included do
+        has_api!
+      end
+
+      module ClassMethods
+        def has_api!
+          human_name = resource_class.model_name.human
+          param_group_id = "#{resource_class.model_name.singular}_id".to_sym
+          param_group_resource = resource_class.model_name.singular.to_sym
+          param_group_id_resource = "#{resource_class.model_name.singular}_resource".to_sym
+
+          resource_description do
+            formats ['json']
+            error 404, 'Missing'
+            error 500, 'Server crashed for some reason'
+          end
+
+          if block_given?
+            yield
+          else
+            def_param_group(param_group_id) do
+              param :id, Integer, "ID of #{human_name}"
+            end
+            columns = resource_class.columns_hash
+            def_param_group(param_group_resource) do
+              param param_group_resource, Hash, action_aware: true do
+                columns.each do |name, column|
+                  param name.to_sym, column.sql_type.classify.safe_constantize || String, required: !column.null unless name == 'id'
+                  # STDERR.puts "params :#{name}, #{column.sql_type.classify.safe_constantize || String}"
+                end
+              end
+            end
+            def_param_group(param_group_id_resource) do
+              param_group(param_group_id)
+              param_group(param_group_resource)
+            end
+          end
+
+          class_eval do
+            api! "List #{human_name.pluralize}"
+            formats %w(json jsonld)
+
+            def index
+              super
+            end
+
+            api! "Show #{human_name}"
+            param_group(param_group_id)
+
+            def show
+              super
+            end
+
+            api! "Create #{human_name}"
+            param_group(param_group_resource)
+
+            def create
+              super
+            end
+
+            api! "Update #{human_name}"
+            param_group(param_group_id_resource)
+
+            def update
+              super
+            end
+
+            api! "Delete #{human_name}"
+            param_group(param_group_id)
+
+            def destroy
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aepic/concerns/controller.rb

@@ -30,6 +30,8 @@ module Aepic
         include Overrides
 
         api_schema << self
+
+        include ApiController
       end
 
       module ClassMethods

data/lib/aepic/concerns/responder.rb

@@ -11,7 +11,7 @@ module Aepic
       private
 
       def do_http_cache?
-        get? && (@http_cache != false) && persisted? && resourceful? && resource_item.respond_to?(:updated_at)
+        get? && (@http_cache != false) && persisted? && resource_item.respond_to?(:updated_at)
       end
 
       # @return [Boolean]

data/lib/aepic/version.rb

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

data/lib/apipie/validator/integer_validator.rb

@@ -0,0 +1,25 @@
+module Apipie
+  module Validator
+    class IntegerValidator < Apipie::Validator::BaseValidator
+      def initialize(param_description, argument)
+        super(param_description)
+        @type = argument
+      end
+
+      def validate(value)
+        return false if value.nil?
+        !!(value.to_s =~ /^[-+]?[0-9]+$/)
+      end
+
+      def self.build(param_description, argument, options, block)
+        if argument == Integer || argument == Fixnum
+          self.new(param_description, argument)
+        end
+      end
+
+      def description
+        "Must be #{@type}."
+      end
+    end
+  end
+end

data/spec/aepic_spec.rb

@@ -4,8 +4,4 @@ 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

@@ -1,2 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'aepic'
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+end

metadata

@@ -1,153 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: aepic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexander Semyonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2015-11-30 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'
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0.rc3
 - !ruby/object:Gem::Dependency
   name: inherited_resources
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: has_scope
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: draper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.3
 - !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'
+- !ruby/object:Gem::Dependency
+  name: apipie-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: Build your epic APIs same time you are building your website. Docs included
@@ -157,19 +171,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - aepic.gemspec
 - app/views/application/api.html.haml
+- app/views/application/api.html.slim
 - app/views/application/api.xml.builder
 - app/views/application/index.jsonld.erb
 - lib/aepic.rb
+- lib/aepic/concerns/api_controller.rb
 - lib/aepic/concerns/controller.rb
 - lib/aepic/concerns/decorator.rb
 - lib/aepic/concerns/responder.rb
@@ -180,6 +195,7 @@ files:
 - lib/aepic/schema.rb
 - lib/aepic/serializer.rb
 - lib/aepic/version.rb
+- lib/apipie/validator/integer_validator.rb
 - spec/aepic_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/alsemyonov/aepic
@@ -192,20 +208,20 @@ 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.7
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
-summary: Æpic is for your epic APIs
+summary: "Æpic is for your epic APIs"
 test_files:
 - spec/aepic_spec.rb
 - spec/spec_helper.rb

data/.ruby-version

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