grape-api-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e3658b3e980b2e434eec0d2a60bdcf49735f6ae
+  data.tar.gz: 447fb0d2639ac4fa47249b03d99716115ae9fefa
+SHA512:
+  metadata.gz: 907faf96e7a87fa7b9fae828c94b2116b53c1ec56aedb30dd082317419831a02e5774f399d881efd07ee19411df5480f2a68c40510f38dfa7b8bc1ef82031e2e
+  data.tar.gz: 37dab1afba2c0145974ef8d054c500b32e64130a2c526c1952126dbc4d97c76b13ec0aec79a05e45d3ff11feb3740074f887875ecaf5f43bbedf4b805e0f4215

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ducvinh
+
+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,50 @@
+# Grape API Generators
+
+A collection all Rails generator scripts for Grape.
+
+## Getting started
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'grape-api-generator'
+```
+
+Then run `bundle` command to install it.
+
+After you installed the gem, you could run the install generator to generate basic `MyApp` API structure:
+
+    rails generate grape:install my_app
+
+You could also specify the API version and authentication model in the generator:
+
+    rails generate grape:install my_app --version 2 --model_name customer
+
+## Scaffolding new resource
+
+To scaffold a resource API, e.g. `Post`
+
+    rails generate grape:scaffold my_app post
+
+It will create the resource API, entity and spec/test files.
+
+You could also specify list of attributes for the resource API:
+
+    rails generate grape:scaffold my_app post title:string:r content published_at:date_time
+
+It will expose `tilte`, `content` and `published_at` in the entity as well as define the params list as following:
+
+```ruby
+requires :title, type: String
+optional :content, type: String
+optional :published_at, type: DateTime
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/vinh0604/grape-api-generator/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape-api-generator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-api-generator"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Vinh Bachsy"]
+  spec.email         = ["bsdvinhuit@gmail.com"]
+
+  spec.summary       = %q{A collection of Rails generator scripts for Grape.}
+  spec.description   = %q{A collection of Rails generator scripts for Grape.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "grape", ">= 0.11.0"
+  spec.add_runtime_dependency "grape-entity"
+  spec.add_runtime_dependency "grape-kaminari"
+  spec.add_runtime_dependency "grape-swagger"
+  spec.add_runtime_dependency "hashie-forbidden_attributes"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rails', '~> 4.2'
+end

data/lib/generators/grape/install_generator.rb

@@ -0,0 +1,48 @@
+module Grape
+  class InstallGenerator < Rails::Generators::Base
+    argument :vendor, required: true, desc: 'The API vendor name'
+
+    class_option :version, type: :string, default: '1', description: "API version"
+    class_option :model_name, type: :string, default: 'user', description: "Authentication model name"
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def modify_config
+      application "config.autoload_paths += Dir[Rails.root.join('app', 'api', '*')]"
+      application "config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb')"
+    end
+
+    def create_base_api
+      template "api/api.rb",
+               "app/api/#{vendor}/api.rb"
+    end
+
+    def create_version_api
+      template "api/version.rb",
+               "app/api/#{vendor}/#{version}.rb"
+    end
+
+    def create_api_helper
+      template "api/api_helpers.rb",
+               "app/api/#{vendor}/api_helpers.rb"
+    end
+
+    def add_route_entry
+      route "mount #{vendor.classify}::#{version.upcase} => '/'"
+    end
+
+    def version
+      @version ||= version_valid? ? "v#{options.version}" : "v1"
+    end
+
+    def model_name
+      options.model_name.parameterize
+    end
+
+    private
+
+    def version_valid?
+      options.version.to_i > 0
+    end
+  end
+end

data/lib/generators/grape/scaffold_generator.rb

@@ -0,0 +1,54 @@
+module Grape
+  class ScaffoldGenerator < Rails::Generators::Base
+    argument :vendor, required: true, desc: 'The API vendor name'
+    argument :resource, required: true, desc: 'The resource API name'
+    argument :raw_attributes, required: false, type: :array, desc: 'List of attributes of the resource API'
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_api_file
+      template "api/resource_api.rb",
+               "app/api/#{vendor}/#{resource}_api.rb"
+    end
+
+    def create_base_entity_file
+      template "entities/base.rb",
+               "app/api/#{vendor}/entities/base.rb"
+    end
+
+    def create_resource_entity_file
+      template "entities/resource.rb",
+               "app/api/#{vendor}/entities/#{resource}.rb"
+    end
+
+    def attributes
+      @raw_attributes ||= []
+      raw_attributes.map do |attr|
+        parts = attr.split(':')
+        {
+          name: parts[0],
+          type: (parts[1].presence || 'string').classify,
+          required: parts[2] == 'r'
+        }
+      end
+    end
+
+    def attributes_names
+      attributes.map { |attr| attr[:name] }
+    end
+
+    def attributes_params
+      params = attributes.map do |attr|
+        line = attr[:required] ? 'requires' : 'optional'
+        line += " :#{attr[:name]}"
+        line += ", type: #{attr[:type]}"
+
+        line
+      end
+
+      params.join("\n        ")
+    end
+
+    hook_for :test_framework, as: :grape_scaffold
+  end
+end

data/lib/generators/grape/templates/api/api.rb

@@ -0,0 +1,21 @@
+module <%= vendor.classify %>
+  class API < Grape::API
+    include Grape::Kaminari
+
+    content_type :json, "application/json;charset=UTF-8"
+    format :json
+
+    helpers <%= vendor.classify %>::ApiHelpers
+
+    rescue_from ActiveRecord::RecordNotFound do |e|
+      error!({ error: "404 Not found." }, 404)
+    end
+
+    if Rails.env.production?
+      rescue_from :all do |e|
+        Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+        error!({ error: "500 Internal server error." }, 500)
+      end
+    end
+  end
+end

data/lib/generators/grape/templates/api/api_helpers.rb

@@ -0,0 +1,27 @@
+module <%= vendor.classify %>
+  module ApiHelpers
+    extend Grape::API::Helpers
+
+    params :pagination do
+      optional :page, type: Integer, default: 1
+      optional :per_page, type: Integer, default: 20
+    end
+
+    def current_<%= model_name %>
+      # Implement your API authentication here
+      # @current_<%= model_name %> ||= <%= model_name.classify %>.authenticate!(env)
+    end
+
+    def authenticate!
+      error!({ error: "401 Unauthorized." }, 401) unless current_<%= model_name %>
+    end
+
+    def permitted_params
+      declared(params, include_missing: false)
+    end
+
+    def resource_error!(resource)
+      error!({ error: user.errors.full_messages.join(', ') }, 422)
+    end
+  end
+end

data/lib/generators/grape/templates/api/resource_api.rb

@@ -0,0 +1,38 @@
+module <%= vendor.classify %>
+  class <%= resource.classify %>API < <%= vendor.classify %>::API
+    resource :<%= resource.pluralize %> do
+      paginate per_page: 20
+
+      get do
+        <%= resource.pluralize %> = <%= resource.classify %>.all
+        present paginate(<%= resource.pluralize %>), with: <%= vendor.classify %>::Entities::<%= resource.classify %>
+      end
+
+      params do
+        <%= attributes_params %>
+      end
+      post do
+        <%= resource %> = <%= resource.classify %>.new(permitted_params)
+
+        if <%= resource %>.save
+          present <%= resource %>, with: <%= vendor.classify %>::Entities::<%= resource.classify %>
+        else
+          resource_error!(<%= resource %>)
+        end
+      end
+
+      params do
+        <%= attributes_params %>
+      end
+      put ":id" do
+        <%= resource %> = <%= resource.classify %>.find(params[:id])
+
+        if <%= resource %>.update_attributes(permitted_params)
+          present <%= resource %>, with: <%= vendor.classify %>::Entities::<%= resource.classify %>
+        else
+          resource_error!(<%= resource %>)
+        end
+      end
+    end
+  end
+end

data/lib/generators/grape/templates/api/version.rb

@@ -0,0 +1,12 @@
+module <%= vendor.classify %>
+  class <%= version.upcase %> < <%= vendor.classify %>::API
+    version "<%= version %>", using: :path
+    prefix :api
+
+    get do
+      { version: "<%= version %>" }
+    end
+
+    add_swagger_documentation hide_format: true, api_version: "api/<%= version %>"
+  end
+end

data/lib/generators/grape/templates/entities/base.rb

@@ -0,0 +1,7 @@
+module <%= vendor.classify %>
+  module Entities
+    class Base < Grape::Entity
+      format_with(:iso_timestamp) { |dt| dt ? dt.iso8601 : nil }
+    end
+  end
+end

data/lib/generators/grape/templates/entities/resource.rb

@@ -0,0 +1,13 @@
+module <%= vendor.classify %>
+  module Entities
+    class <%= resource.classify %> < <%= vendor.classify %>::Entities::Base
+      expose :id
+<% attributes_names.each do |name| %>      expose :<%= name %>
+<% end %>
+      with_options(format_with: :iso_timestamp) do
+        expose :created_at
+        expose :updated_at
+      end
+    end
+  end
+end

data/lib/generators/rspec/grape_scaffold_generator.rb

@@ -0,0 +1,15 @@
+module Rspec
+  module Generators
+    class GrapeScaffoldGenerator < Rails::Generators::Base
+      argument :vendor, required: true, desc: 'The API vendor name'
+      argument :resource, required: true, desc: 'The resource API name'
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_spec_file
+        template "resource_spec.rb",
+                 "spec/api/#{vendor}/#{resource}_api_spec.rb"
+      end
+    end
+end
+end

data/lib/generators/rspec/templates/resource_spec.rb

@@ -0,0 +1,4 @@
+require "rails_helper"
+
+describe <%= vendor.classify %>::<%= resource.classify %>API do
+end

data/lib/generators/test_unit/grape_scaffold_generator.rb

@@ -0,0 +1,15 @@
+module TestUnit
+  module Generators
+    class GrapeScaffoldGenerator < Rails::Generators::Base
+      argument :vendor, required: true, desc: 'The API vendor name'
+      argument :resource, required: true, desc: 'The resource API name'
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_spec_file
+        template "resource_test.rb",
+                 "test/api/#{vendor}/#{resource}_api_test.rb"
+      end
+    end
+  end
+end

data/lib/generators/test_unit/templates/resource_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module <%= vendor.classify %>
+  class <%= resource.classify %>APITest < ActionDispatch::IntegrationTest
+  end
+end

data/lib/grape-api-generator.rb

@@ -0,0 +1,5 @@
+require 'grape'
+require 'grape-entity'
+require 'grape-kaminari'
+require 'grape-swagger'
+require 'hashie-forbidden_attributes'

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: grape-api-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vinh Bachsy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  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: grape-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: grape-swagger
+  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: hashie-forbidden_attributes
+  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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: A collection of Rails generator scripts for Grape.
+email:
+- bsdvinhuit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- grape-api-generator.gemspec
+- lib/generators/grape/install_generator.rb
+- lib/generators/grape/scaffold_generator.rb
+- lib/generators/grape/templates/api/api.rb
+- lib/generators/grape/templates/api/api_helpers.rb
+- lib/generators/grape/templates/api/resource_api.rb
+- lib/generators/grape/templates/api/version.rb
+- lib/generators/grape/templates/entities/base.rb
+- lib/generators/grape/templates/entities/resource.rb
+- lib/generators/rspec/grape_scaffold_generator.rb
+- lib/generators/rspec/templates/resource_spec.rb
+- lib/generators/test_unit/grape_scaffold_generator.rb
+- lib/generators/test_unit/templates/resource_test.rb
+- lib/grape-api-generator.rb
+homepage: 
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A collection of Rails generator scripts for Grape.
+test_files: []