apiblueprint-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d759b00f7d866a0a4c9ce7b7e3a8dbd1dff31689
+  data.tar.gz: ac8ba99cd91677e1abfc3c8df346ed88e0f19f6b
+SHA512:
+  metadata.gz: dbffc1b4e3ed117140257ee2fb2747ecde33a364d14e91858769b7885e4ab2b517be4be09aa40efabb1da1c6817339ceefb4a30f91b1ebaa15ecc89495c9f034
+  data.tar.gz: 91ca08cff849f7748d617fccd8072a70b037dcd787b223d72940553401496ef8c46dea2fce82b6f2d5af6ee82da14d0a7cab3193da3f890b6f0e59c8ea657a09

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naoyoshi Aikawa
+
+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,54 @@
+# apiblueprint-rails
+
+apiblueprint-rails creates [API Blueprint](https://apiblueprint.org/) boilerplate when calling `rails g apiblueprint`.
+
+## Installation
+
+Add this line to your rails application's Gemfile:
+
+```ruby
+gem 'apiblueprint-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+After installing apiblueprint-rails to your rails application, use apiblueprint keyword to generate scaffold.
+For example,
+
+```bash
+$ rails g apiblueprint User name age:integer admin:boolean
+```
+
+creates `doc/users.apib` file.
+
+You can change `doc` directory by passing `--apidoc-dir=<directory>` flag to the option.
+
+
+If you want to generate apiblueprint only, you can use `rails generate apiblueprint --generate=none` command.
+
+```bash
+$ rails g apiblueprint --generate=none User name age:integer admin:boolean
+```
+
+generates just the same apib output above.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apiblueprint-rails.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apiblueprint-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiblueprint/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apiblueprint-rails"
+  spec.version       = Apiblueprint::Rails::VERSION
+  spec.authors       = ["Naoyoshi Aikawa"]
+  spec.email         = ["nao@wantedly.com", "dev@wantedly.com"]
+
+  spec.summary       = "API Blueprint generator for Rails"
+  spec.description   = "apiblueprint-rails creates API Blueprint boilerplate when generating scaffold by rails"
+  spec.homepage      = "https://github.com/wantedly/apiblueprint-rails"
+  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 "railties", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apiblueprint/rails"
+
+# 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/setup

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

data/lib/apiblueprint/rails/version.rb

@@ -0,0 +1,5 @@
+module Apiblueprint
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/apiblueprint/rails.rb

@@ -0,0 +1,6 @@
+require "apiblueprint/rails/version"
+
+module Apiblueprint
+  module Rails
+  end
+end

data/lib/generators/rails/apiblueprint/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate apiblueprint Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/rails/apiblueprint/apiblueprint_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/named_base'
+
+class Rails::ApiblueprintGenerator < Rails::Generators::NamedBase
+  desc "create apiblueprint file"
+  source_root File.expand_path("../templates", __FILE__)
+
+  argument(
+    :attributes,
+    type: :array,
+    default: [],
+    banner: "field:type field:type"
+  )
+
+  class_option "apidoc-dir", type: :string, default: "doc", desc: "Change doc directory by passing"
+  class_option "generate", type: :string, default: "scaffold", desc: "Change generate type (Default:scaffold, Other: none, controller, model...)"
+
+  def set_attribute
+    @attrs = Array.new()
+    @args = Array.new()
+    attributes.map do |val|
+      @attrs.push( { name: val.name, type: val.type, init: val.default } )
+    end
+    @attrs.map do |attr|
+      @args.push(attr[:name].to_s + ":" + attr[:type].to_s)
+      case attr[:type].to_s
+      when "integer", "primary_key", "decimal", "float" then
+        attr[:type] = "number"
+      when "boolean" then
+        attr[:type] = "boolean"
+      when "references" then
+        attr[:name] = attr[:name] + "_id"
+        attr[:type] = "number, required"
+      else
+        attr[:type] = "string"
+      end
+    end
+  end
+
+  def create_apib_file
+    template "apiblueprint.erb", "#{options["apidoc-dir"]}/#{file_name}.apib"
+    if options["generate"] != "none" then
+      invoke(options["generate"], [file_name, @args])
+    end
+  end
+end

data/lib/generators/rails/apiblueprint/templates/apiblueprint.erb

@@ -0,0 +1,74 @@
+
+FORMAT: 1A
+
+# <%= file_name %> API
+
+Write an overall API discription.
+
+# <%= plural_table_name %> action [<%= route_url %>]
+
+Write a discription.
+
+## Create <%= singular_table_name %> [POST]
+
+Write a [POST] discription.
+
++ Request <%= table_name %> (application/json; charset=utf-8)
+    + Attributes
+        <% @attrs.map do |attr| %>+ <%= attr[:name] %>: <%= attr[:init] %> (<%= attr[:type] %>)
+        <% end %>
++ Response 201 (application/json; charset=utf-8)
+    + Attributes (<%= table_name %>)
+
+## Get <%= plural_table_name %> [GET]
+
+Write a [GET] discription.
+
++ Response 200 (application/json; charset=utf-8)
+    + Attributes (array)
+        + (<%= table_name %>)
+        + (<%= table_name %>)
+
+# <%= singular_table_name %> action [<%= route_url %>/{id}]
+
+Write a discription.
+
++ Parameters
+    + id: `1` (enum[string]) - The ID of the desired <%= singular_table_name %>.
+        + Members
+            + `1`
+            + `2`
+            + `3`
+
+## Get <%= singular_table_name %> [GET]
+
+Write a [GET] discription.
+
++ Response 200 (application/json; charset=utf-8)
+    + Attributes (<%= table_name %>)
+
+## Update <%= singular_table_name %> [PUT]
+
+Write a [PUT] discription.
+
++ Request <%= table_name %> (application/json; charset=utf-8)
+    + Attributes
+        <% @attrs.map do |attr| %>+ <%= attr[:name] %>: <%= attr[:init] %> (<%= attr[:type] %>)
+        <% end %>
++ Response 200 (application/json; charset=utf-8)
+    + Attributes (<%= table_name %>)
+
+## Delete <%= singular_table_name %> [DELETE]
+
+Write a [DELETE] discription.
+
++ Response 204
+
+# Data Structures
+
+## <%= table_name %> (object)
+
++ id: 1 (number) - Id<% @attrs.map do |attr| %>
++ <%= attr[:name] %>: <%= attr[:init] %> (<%= attr[:type] %>)<% end %>
++ created_at: `2000-01-01 00:00:00` (string) - CreatedTime
++ updated_at: `2000-01-01 00:00:00` (string) - UpdatedTime

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: apiblueprint-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naoyoshi Aikawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: apiblueprint-rails creates API Blueprint boilerplate when generating
+  scaffold by rails
+email:
+- nao@wantedly.com
+- dev@wantedly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apiblueprint-rails.gemspec
+- bin/console
+- bin/setup
+- lib/apiblueprint/rails.rb
+- lib/apiblueprint/rails/version.rb
+- lib/generators/rails/apiblueprint/USAGE
+- lib/generators/rails/apiblueprint/apiblueprint_generator.rb
+- lib/generators/rails/apiblueprint/templates/apiblueprint.erb
+homepage: https://github.com/wantedly/apiblueprint-rails
+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.5.1
+signing_key: 
+specification_version: 4
+summary: API Blueprint generator for Rails
+test_files: []
+has_rdoc: