grape-scaffold 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60dd30d57edc0adcb25d2e1d0f1d313d385f5a48
+  data.tar.gz: 7160dbd560b6805a5ef0da6de90c442949e3fc3a
+SHA512:
+  metadata.gz: fffe1673c00d08142d2d7aa86b3c9a8c30ef831a4ba57798440b1cf3d13b6153b6661839df34ac332122962057e748f0b16bf4d8d9da7f624435fcb1e39d61f8
+  data.tar.gz: a6174842988dec728e4710d90e89ee8839055d659ba120f29d38a549cb60925b2b4ccd90d374e026749c44e3d0d9ce3f54bf10810f702c8e9eb37ac17cfa7043

data/lib/generators/grape/controller/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Creates a Grape controller.
+
+Example:
+    rails generate grape:controller MODEL
+
+    This will create:
+      A controller with the model name.

data/lib/generators/grape/controller/controller_generator.rb

@@ -0,0 +1,33 @@
+module Grape
+  class ControllerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :model_name, type: :string
+
+    class_option :controller_path, desc: 'Set default controller path', type: :string, defaut: 'app/controllers/api/v1'
+    class_option :skip_controller_tests, :desc => 'Skip generated controller tests', :type => :boolean
+
+    def generate_controller
+      template 'controller.erb', "app/controllers/api/v1/#{model_name.pluralize.underscore}.rb"
+    end
+
+    def generate_controller_specs
+      unless options[:skip_controller_tests]
+        template 'controller_spec.erb', "spec/requests/#{model_name.singularize.underscore}_spec.rb"
+      end
+    end
+
+    protected
+      def attribute_name(attribute)
+        attribute.split(':').first
+      end
+
+      def attribute_is_id?(attribute)
+        attribute.split(':').first.last(3) == "_id"
+      end
+
+      def attribute_without_id(attribute)
+        attribute.split(':').first[0..-4]
+      end
+  end
+end

data/lib/generators/grape/controller/templates/controller.erb

@@ -0,0 +1,69 @@
+module API
+  module V1
+    class <%= model_name.camelize.pluralize %> < Grape::API
+
+      resource :<%= model_name.pluralize.underscore %> do
+        # Get a list of <%= model_name.pluralize.underscore %>
+        #
+        # Example Request:
+        #   GET /v1/<%= model_name.pluralize.underscore %>
+        get do
+          <%= model_name.camelize.singularize %>.all
+        end
+
+        # Get a single <%= model_name.underscore.singularize %>
+        #
+        # Parameters:
+        #   id (required) - The ID of a <%= model_name.underscore.singularize %>
+        # Example Request:
+        #   GET /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        get ':id' do
+          <%= model_name.camelize.singularize %>.find(params[:id])
+        end
+
+        # Create a new <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   POST /v1/<%= model_name.pluralize.underscore %>
+        post do
+          <%= model_name.underscore.singularize %> = <%= model_name.camelize.singularize %>.new(params)
+          if <%= model_name.underscore.singularize %>.save
+            <%= model_name.underscore.singularize %>
+          else
+            <%= model_name.underscore.singularize %>.errors
+          end
+        end
+
+        # Delete a <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   DELETE /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        delete ':id' do
+          <%= model_name.camelize.singularize %>.destroy(params[:id])
+        end
+
+        # Edit a <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   PUT /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        put ':id' do
+          <%= model_name.underscore.singularize %> = <%= model_name.camelize.singularize %>.find(params[:id])
+          if <%= model_name.underscore.singularize %>.update(params)
+            <%= model_name.underscore.singularize %>
+          else
+            <%= model_name.underscore.singularize %>.errors
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/grape/controller/templates/controller_spec.erb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe '<%= model_name.camelize.pluralize %>' do
+  describe 'GET /v1/<%= model_name.pluralize.underscore %>' do
+    describe 'should return <%= model_name.underscore.singularize %> list' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        get '/v1/<%= model_name.pluralize.underscore %>'
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'returns a <%= model_name.underscore.singularize %>' do
+        expect(json.length).to eq 1
+      end
+
+      it 'returns the same <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'GET /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should return <%= model_name.underscore.singularize %> details' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        get "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'returns a <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'POST /v1/<%= model_name.pluralize.underscore %>' do
+    describe 'should save parameters' do
+      before do
+        post '/v1/<%= model_name.pluralize.underscore %>'
+      end
+
+      it 'returns 201 success status' do
+        expect(response.response_code).to eq 201
+      end
+
+      it 'saves the <%= model_name.underscore.singularize %>' do
+        expect(<%= model_name.camelize.singularize %>.all.count).to eq 1
+      end
+
+      it 'saves the <%= model_name.underscore.singularize %> with correct attributes' do
+        pending
+      end
+    end
+  end
+
+  describe 'PUT /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should save parameters' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        put "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'updates the <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'DELETE /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should delete <%= model_name.underscore.singularize %>' do
+      before(:each) do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        delete "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'deletes the <%= model_name.underscore.singularize %>' do
+        expect(<%= model_name.camelize.singularize %>.all.count).to eq 0
+      end
+    end
+  end
+end

data/lib/generators/grape/scaffold/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Scaffolds Grape API resource including model, controller, and specs.
+
+Example:
+    rails generate grape:scaffold MODEL ATTRIBUTES
+
+    This will create:
+      The model, controller, and specs.

data/lib/generators/grape/scaffold/scaffold_generator.rb

@@ -0,0 +1,45 @@
+module Grape
+  class ScaffoldGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :model_name, type: :string
+    argument :attributes, type: :array, default: []
+
+    class_option :controller_path, desc: 'Set default controller path', type: :string, defaut: 'app/controllers/api/v1'
+    class_option :skip_model_tests, :desc => 'Skip generated model tests', :type => :boolean
+    class_option :skip_controller_tests, :desc => 'Skip generated controller tests', :type => :boolean
+
+    def generate_model
+      generate 'model', "#{model_name} #{attributes.join(' ')}"
+    end
+
+    def generate_model_specs
+      unless options[:skip_model_tests]
+        template 'model_spec.erb', "spec/models/#{model_name.singularize.underscore}_spec.rb"
+      end
+    end
+
+    def generate_controller
+      template 'controller.erb', "#{options[:controller_path]}/#{model_name.pluralize.underscore}.rb"
+    end
+
+    def generate_controller_specs
+      unless options[:skip_controller_tests]
+        template 'controller_spec.erb', "spec/requests/#{model_name.singularize.underscore}_spec.rb"
+      end
+    end
+
+    protected
+      def attribute_name(attribute)
+        attribute.split(':').first
+      end
+
+      def attribute_is_id?(attribute)
+        attribute.split(':').first.last(3) == "_id"
+      end
+
+      def attribute_without_id(attribute)
+        attribute.split(':').first[0..-4]
+      end
+  end
+end

data/lib/generators/grape/scaffold/templates/controller.erb

@@ -0,0 +1,69 @@
+module API
+  module V1
+    class <%= model_name.camelize.pluralize %> < Grape::API
+
+      resource :<%= model_name.pluralize.underscore %> do
+        # Get a list of <%= model_name.pluralize.underscore %>
+        #
+        # Example Request:
+        #   GET /v1/<%= model_name.pluralize.underscore %>
+        get do
+          <%= model_name.camelize.singularize %>.all
+        end
+
+        # Get a single <%= model_name.underscore.singularize %>
+        #
+        # Parameters:
+        #   id (required) - The ID of a <%= model_name.underscore.singularize %>
+        # Example Request:
+        #   GET /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        get ':id' do
+          <%= model_name.camelize.singularize %>.find(params[:id])
+        end
+
+        # Create a new <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   POST /v1/<%= model_name.pluralize.underscore %>
+        post do
+          <%= model_name.underscore.singularize %> = <%= model_name.camelize.singularize %>.new(params)
+          if <%= model_name.underscore.singularize %>.save
+            <%= model_name.underscore.singularize %>
+          else
+            <%= model_name.underscore.singularize %>.errors
+          end
+        end
+
+        # Delete a <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   DELETE /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        delete ':id' do
+          <%= model_name.camelize.singularize %>.destroy(params[:id])
+        end
+
+        # Edit a <%= model_name.underscore.singularize %>
+        #
+        # Example Request:
+        #   PUT /v1/<%= model_name.pluralize.underscore %>/:id
+        params do
+          requires :id
+        end
+        put ':id' do
+          <%= model_name.underscore.singularize %> = <%= model_name.camelize.singularize %>.find(params[:id])
+          if <%= model_name.underscore.singularize %>.update(params)
+            <%= model_name.underscore.singularize %>
+          else
+            <%= model_name.underscore.singularize %>.errors
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/grape/scaffold/templates/controller_spec.erb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe '<%= model_name.camelize.pluralize %>' do
+  describe 'GET /v1/<%= model_name.pluralize.underscore %>' do
+    describe 'should return <%= model_name.underscore.singularize %> list' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        get '/v1/<%= model_name.pluralize.underscore %>'
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'returns a <%= model_name.underscore.singularize %>' do
+        expect(json.length).to eq 1
+      end
+
+      it 'returns the same <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'GET /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should return <%= model_name.underscore.singularize %> details' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        get "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'returns a <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'POST /v1/<%= model_name.pluralize.underscore %>' do
+    describe 'should save parameters' do
+      before do
+        post '/v1/<%= model_name.pluralize.underscore %>'
+      end
+
+      it 'returns 201 success status' do
+        expect(response.response_code).to eq 201
+      end
+
+      it 'saves the <%= model_name.underscore.singularize %>' do
+        expect(<%= model_name.camelize.singularize %>.all.count).to eq 1
+      end
+
+      it 'saves the <%= model_name.underscore.singularize %> with correct attributes' do
+        pending
+      end
+    end
+  end
+
+  describe 'PUT /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should save parameters' do
+      before do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        put "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'updates the <%= model_name.underscore.singularize %>' do
+        pending
+      end
+    end
+  end
+
+  describe 'DELETE /v1/<%= model_name.pluralize.underscore %>/:id' do
+    describe 'should delete <%= model_name.underscore.singularize %>' do
+      before(:each) do
+        @<%= model_name.underscore.singularize %> = create(:<%= model_name.underscore.singularize %>)
+        delete "/v1/<%= model_name.pluralize.underscore %>/#{@<%= model_name.underscore.singularize %>.id}"
+      end
+
+      it 'returns 200 success status' do
+        expect(response.response_code).to eq 200
+      end
+
+      it 'deletes the <%= model_name.underscore.singularize %>' do
+        expect(<%= model_name.camelize.singularize %>.all.count).to eq 0
+      end
+    end
+  end
+end

data/lib/generators/grape/scaffold/templates/model_spec.erb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe <%= model_name.camelize.singularize %> do
+  let(:<%= model_name.underscore.singularize %>) { create(:<%= model_name.underscore.singularize %>) }
+
+  context '#object' do
+    it 'should be valid' do
+      <%= model_name.underscore.singularize %>.should be_valid
+    end
+  end
+
+    context '#associations' do
+      <%- attributes.each do |attribute| -%>
+      <%- if attribute_is_id?(attribute) -%>
+      it { should belong_to(:<%= attribute_without_id(attribute) -%>) }
+      <%- end -%>
+      <%- end -%>
+      pending
+    end
+
+    context '#values' do
+      <%- attributes.each do |attribute| -%>
+      <%- unless attribute_is_id?(attribute) -%>
+      it { should respond_to(:<%= attribute_name(attribute) %>) }
+      <%- end -%>
+      <%- end -%>
+    end
+
+    context '#scopes' do
+      pending
+    end
+
+    context '#validations' do
+      pending
+    end
+
+    context '#methods' do
+      pending
+    end
+
+    context '#callbacks' do
+      pending
+    end
+end

data/lib/grape_scaffold.rb

@@ -0,0 +1,4 @@
+require "grape_scaffold/version"
+
+module GrapeScaffold
+end

data/lib/grape_scaffold/version.rb

@@ -0,0 +1,3 @@
+module GrapeScaffold
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: grape-scaffold
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shrivara K S
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: An API scaffold generator for Grape which generates controller, models
+  and specs
+email:
+- shrivara.ks@icicletech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/grape/controller/USAGE
+- lib/generators/grape/controller/controller_generator.rb
+- lib/generators/grape/controller/templates/controller.erb
+- lib/generators/grape/controller/templates/controller_spec.erb
+- lib/generators/grape/scaffold/USAGE
+- lib/generators/grape/scaffold/scaffold_generator.rb
+- lib/generators/grape/scaffold/templates/controller.erb
+- lib/generators/grape/scaffold/templates/controller_spec.erb
+- lib/generators/grape/scaffold/templates/model_spec.erb
+- lib/grape_scaffold.rb
+- lib/grape_scaffold/version.rb
+homepage: https://github.com/icicletech/grape_scaffold
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An API scaffold generator for Grape
+test_files: []