push_type_api 0.10.0.beta.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75bbc95444676040e4b78f21a4a562205d705842
+  data.tar.gz: 1fa0b87e1175fd79e62258afd907127d18fa8321
+SHA512:
+  metadata.gz: 3dea2e28935fd0d595c83a4ad8f1a1f1743016b7474f81382ed807d65d134f5b09860b41d6857f71ee8775f1f6eca30fab0ef2f9bd415d8adb8246bd842702bc
+  data.tar.gz: 136134ca14377dbcc5da58605817df1219f39b200f943d19be9bce21904f5b4af379be855fe11c72c0d5d489587a6f6e0f301e18805bbb8b7882734a1209547b

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2014-2016 Push Code Ltd
+
+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,28 @@
+# Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/push_type/api/assets_controller.rb

@@ -0,0 +1,72 @@
+require_dependency "push_type/api_controller"
+
+module PushType
+  class Api::AssetsController < ApiController
+
+    before_action :build_asset, only: [:create]
+    before_action :load_asset,  only: [:show, :update, :destroy, :restore]
+
+    def index
+      @assets = PushType::Asset.not_trash.page(params[:page]).per(12)
+    end
+
+    def trash
+      @assets = PushType::Asset.trashed.page(params[:page]).per(12)
+      render :index
+    end
+
+    def show
+    end
+
+    def create
+      if @asset.save
+        render :show, status: :created
+      else
+        render json: { errors: @asset.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if @asset.update_attributes asset_params
+        render :show
+      else
+        render json: { errors: @asset.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      if @asset.trashed?
+        @asset.destroy
+        head :no_content
+      else
+        @asset.trash!
+        render :show
+      end
+    end
+
+    def restore
+      @asset.restore!
+      render :show
+    end
+
+    def empty
+      PushType::Asset.trashed.destroy_all
+      head :no_content
+    end
+
+    private
+
+    def build_asset
+      @asset = PushType::Asset.new asset_params.merge(uploader: push_type_user)
+    end
+
+    def load_asset
+      @asset = PushType::Asset.find params[:id]
+    end
+
+    def asset_params
+      params.fetch(:asset, {}).permit(:file, :description)
+    end
+
+  end
+end

data/app/controllers/push_type/api/nodes_controller.rb

@@ -0,0 +1,108 @@
+require_dependency "push_type/api_controller"
+
+module PushType
+  class Api::NodesController < ApiController
+
+    before_action :build_node,  only: [:create]
+    before_action :load_node, only: [:show, :update, :destroy, :restore, :position]
+
+    def index
+      @nodes = node_scope.not_trash.page(params[:page]).per(30)
+    end
+
+    def trash
+      @nodes = PushType::Node.all.trashed.page(params[:page]).per(30).reorder(deleted_at: :desc)
+      render :index
+    end
+
+    def show
+    end
+
+    def create
+      if @node.save
+        render :show, status: :created
+      else
+        render json: { errors: @node.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if @node.update_attributes node_params_with_fields.merge(updater: push_type_user)
+        render :show
+      else
+        render json: { errors: @node.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      if @node.trashed?
+        @node.destroy
+        head :no_content
+      else
+        @node.trash!
+        render :show
+      end
+    end
+
+    def position
+      if reorder_node
+        head :no_content
+      else
+        render json: { errors: @node.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def restore
+      @node.restore!
+      render :show
+    end
+
+    def empty
+      PushType::Node.trashed.destroy_all
+      head :no_content
+    end
+
+    private
+
+    def node_scope
+      @node_scope ||= if params[:node_id]
+        @parent = PushType::Node.find params[:node_id]
+        @parent.children
+      else
+        PushType::Node.roots
+      end
+    end
+
+    def build_node
+      @node = node_scope.new type: node_type, creator: push_type_user, updater: push_type_user
+      @node.attributes = @node.attributes.merge(node_params_with_fields.to_h)
+    end
+
+    def load_node
+      @node = PushType::Node.find params[:id]
+    end
+
+    def node_params
+      @node_params ||= params.fetch(:node, {}).permit(:type, :parent_id, :title, :slug, :status, :published_at, :published_to)
+    end
+
+    def node_type
+      node_params[:type]
+    end
+
+    def node_params_with_fields
+      node_params.tap do |whitelist|
+        @node.fields.keys.each { |k| whitelist[k] = params[:node][k] if params[:node][k].present? }
+      end
+    end
+
+    def reorder_node
+      if params[:prev]
+        PushType::Node.find(params[:prev]).append_sibling(@node)
+      elsif params[:next]
+        PushType::Node.find(params[:next]).prepend_sibling(@node)
+      end
+    end
+
+  end
+end

data/app/controllers/push_type/api/users_controller.rb

@@ -0,0 +1,67 @@
+require_dependency "push_type/api_controller"
+
+module PushType
+  class Api::UsersController < ApiController
+
+    before_action :build_user, only: [:create]
+    before_action :load_user,  only: [:show, :update, :destroy]
+
+    def index
+      @users = user_scope.page(params[:page]).per(30)
+    end
+
+    def show
+    end
+
+    def create
+      if @user.save
+        render :show, status: :created
+      else
+        render json: { errors: @user.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if @user.update_attributes user_params_with_fields
+        render :show
+      else
+        render json: { errors: @user.errors }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      if @user != push_type_user
+        @user.destroy
+        head :no_content
+      else
+        head :bad_request
+      end
+    end
+
+    private
+
+    def user_scope
+      PushType::User
+    end
+
+    def build_user
+      @user = user_scope.new
+      @user.attributes = @user.attributes.merge(user_params_with_fields.to_h)
+    end
+
+    def load_user
+      @user = user_scope.find params[:id]
+    end
+
+    def user_params
+      @node_params ||= params.fetch(:user, {}).permit(:name, :email)
+    end
+
+    def user_params_with_fields
+      user_params.tap do |whitelist|
+        @user.fields.keys.each { |k| whitelist[k] = params[:user][k] if params[:user][k].present? }
+      end
+    end
+
+  end
+end

data/app/controllers/push_type/api_controller.rb

@@ -0,0 +1,13 @@
+module PushType
+  class ApiController < ActionController::Base
+
+    protect_from_forgery with: :null_session
+
+    protected
+
+    def push_type_user
+      respond_to?(:current_user) ? current_user : nil
+    end
+    
+  end
+end

data/app/helpers/push_type/api_helper.rb

@@ -0,0 +1,4 @@
+module PushType
+  module ApiHelper
+  end
+end

data/app/views/push_type/api/assets/_asset.json.jbuilder

@@ -0,0 +1,9 @@
+json.id           asset.id
+json.file_name    asset.file_name
+json.file_size    asset.file_size
+json.mime_type    asset.mime_type
+json.description  asset.description
+json.created_at   asset.created_at
+json.updated_at   asset.updated_at
+json.is_image     asset.image?
+json.is_trashed   asset.trashed?

data/app/views/push_type/api/assets/index.json.jbuilder

@@ -0,0 +1,12 @@
+json.assets @assets do |asset|
+  json.partial! 'asset', asset: asset
+
+  json.links do
+    json.url      media_path(asset)
+    json.preview  asset.image? ? media_path(asset, style: :push_type_thumb) : image_path("push_type/icons-assets.svg##{ asset.kind }")
+  end
+end
+
+json.meta do
+  json.partial! 'push_type/api/shared/pagination', collection: @assets
+end

data/app/views/push_type/api/assets/show.json.jbuilder

@@ -0,0 +1,3 @@
+json.asset do
+  json.partial! 'asset', asset: @asset
+end

data/app/views/push_type/api/nodes/_node.json.jbuilder

@@ -0,0 +1,13 @@
+json.id           node.id
+json.type         node.type
+json.is_exposed   node.exposed?
+json.parent_id    node.parent_id
+json.title        node.title
+json.slug         node.slug
+json.permalink    node_url(node)
+json.created_at   node.created_at
+json.updated_at   node.updated_at
+json.published_at node.published_at
+json.published_to node.published_to
+json.children     node.children.count
+json.is_trashed   node.trashed?

data/app/views/push_type/api/nodes/index.json.jbuilder

@@ -0,0 +1,11 @@
+json.nodes @nodes do |node|
+  json.partial! 'node', node: node
+end
+
+json.meta do
+  json.partial! 'push_type/api/shared/pagination', collection: @nodes
+
+  if params[:action] == 'index'
+    json.child_nodes @parent ? @parent.child_nodes : PushType.root_nodes
+  end
+end

data/app/views/push_type/api/nodes/show.json.jbuilder

@@ -0,0 +1,17 @@
+json.node do
+  json.partial! 'node', node: @node
+
+  @node.fields.each do |key, field|
+    json.set! key, field.value
+  end
+end
+
+if params[:action] == 'show'
+  json.meta do
+    json.fields @node.fields do |key, field|
+      json.name field.name
+      json.kind field.kind
+    end
+    json.child_nodes @node.child_nodes
+  end
+end

data/app/views/push_type/api/shared/_pagination.json.jbuilder

@@ -0,0 +1,5 @@
+json.current_page collection.current_page
+json.next_page    collection.next_page
+json.prev_page    collection.prev_page
+json.total_pages  collection.total_pages
+json.total_count  collection.total_count

data/app/views/push_type/api/users/_user.json.jbuilder

@@ -0,0 +1,5 @@
+json.id           user.id
+json.name         user.name
+json.email        user.email
+json.created_at   user.created_at
+json.updated_at   user.updated_at

data/app/views/push_type/api/users/index.json.jbuilder

@@ -0,0 +1,7 @@
+json.users @users do |user|
+  json.partial! 'user', user: user
+end
+
+json.meta do
+  json.partial! 'push_type/api/shared/pagination', collection: @users
+end

data/app/views/push_type/api/users/show.json.jbuilder

@@ -0,0 +1,16 @@
+json.user do
+  json.partial! 'user', user: @user
+
+  @user.fields.each do |key, field|
+    json.set! key, field.value
+  end
+end
+
+if params[:action] == 'show'
+  json.meta do
+    json.fields @user.fields do |key, field|
+      json.name field.name
+      json.kind field.kind
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,31 @@
+PushType::Api::Engine.routes.draw do
+
+  scope module: 'api', except: [:new, :edit], defaults: { format: :json } do
+
+    resources :nodes do
+      collection do
+        get 'trash'
+        delete 'trash' => 'nodes#empty'
+      end
+      member do
+        post 'position'
+        put 'restore'
+      end
+      resources :nodes, only: [:index]
+    end
+
+    resources :assets, path: 'media' do
+      collection do
+        get 'trash'
+        delete 'trash' => 'assets#empty'
+      end
+      member do
+        put 'restore'
+      end
+    end
+
+    resources :users
+    
+  end
+
+end

data/lib/push_type/api/engine.rb

@@ -0,0 +1,15 @@
+module PushType
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace PushType
+      engine_name 'push_type_api'
+
+      config.generators do |g|
+        g.assets false
+        g.helper false
+        g.test_framework  :test_unit, fixture: false
+      end
+      
+    end
+  end
+end

data/lib/push_type/api.rb

@@ -0,0 +1,12 @@
+require 'push_type_core'
+
+require 'jbuilder'
+require 'kaminari'
+
+module PushType
+  module Api
+    PushType.register_engine self, mount: 'api'
+  end
+end
+
+require 'push_type/api/engine'

data/lib/push_type_api.rb

@@ -0,0 +1 @@
+require 'push_type/api'

data/lib/tasks/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :api do
+#   # Task goes here
+# end

data/test/controllers/push_type/api/assets_controller_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+module PushType
+  class Api::AssetsControllerTest < ActionController::TestCase
+
+    let(:asset_attrs) { FactoryGirl.attributes_for(:asset) }
+    let(:asset) { FactoryGirl.create :asset }
+    
+    describe 'GET #index' do
+      before do
+        5.times { FactoryGirl.create :asset }
+        get :index
+      end
+      it { response.must_respond_with :success }
+      it { json_response['assets'].size.must_equal 5 }
+      it { json_response['meta'].must_be :present? }
+      it { json_response['meta']['current_page'].must_equal 1 }
+    end
+
+    describe 'GET #trash' do
+      before do
+        2.times { FactoryGirl.create :asset }
+        3.times { FactoryGirl.create :asset, deleted_at: Time.zone.now }
+        get :trash
+      end
+      it { response.must_respond_with :success }
+      it { json_response['assets'].size.must_equal 3 }
+      it { json_response['meta'].must_be :present? }
+    end
+
+    describe 'GET #show' do
+      before { get :show, params: { id: asset.id } }
+      it { response.must_respond_with :success }
+      it { json_response['asset'].must_be :present? }
+      it { json_response['asset']['id'].must_equal asset.id }
+    end
+
+    describe 'POST #create' do
+      before { @count = Asset.count }
+      describe 'with in-valid asset' do
+        before { post :create, params: { asset: {} } }
+        it { response.must_respond_with :unprocessable_entity }
+        it { json_response['errors'].must_be :present? }
+      end
+      describe 'with valid asset' do
+        before { post :create, params: { asset: asset_attrs } }
+        it { response.must_respond_with :created }
+        it { json_response['asset'].must_be :present? }
+        it { Asset.count.must_equal @count + 1 }
+      end
+    end
+
+    describe 'PUT #update' do
+      before { put :update, params: { id: asset.id, asset: { description: new_description } } }
+      describe 'with valid asset' do
+        let(:new_description) { 'Foo bar baz' }
+        it { response.must_respond_with :ok }
+        it { json_response['asset'].must_be :present? }
+        it { json_response['asset']['description'].must_equal new_description }
+      end
+    end
+
+    describe 'DELETE #destroy' do
+      describe 'with untrashed asset' do
+        before { delete :destroy, params: { id: asset.id } }
+        it { response.must_respond_with :ok }
+        it { json_response['asset'].must_be :present? }
+        it { json_response['asset']['is_trashed'].must_equal true }
+        it { asset.reload.must_be :trashed? }
+      end
+      describe 'with trashed asset' do
+        before do
+          asset.trash!
+          delete :destroy, params: { id: asset.id }
+        end
+        it { response.must_respond_with :no_content }
+        it { response.body.must_be :blank? }
+        it { proc { asset.reload }.must_raise ActiveRecord::RecordNotFound }
+      end
+    end
+
+    describe 'PUT #restore' do
+      before do
+        asset.trash!
+        put :restore, params: { id: asset.id }
+      end
+      it { response.must_respond_with :ok }
+      it { json_response['asset'].must_be :present? }
+      it { json_response['asset']['is_trashed'].must_equal false }
+      it { asset.reload.wont_be :trashed? }
+    end
+
+    describe 'DELETE #empty' do
+      before do
+        3.times { FactoryGirl.create :asset, deleted_at: Time.zone.now }
+        delete :empty
+      end
+      it { response.must_respond_with :no_content }
+      it { response.body.must_be :blank? }
+      it { PushType::Asset.trashed.must_be :empty? }
+    end
+
+  end
+end