swagger_api 0.1.43

data/lib/swagger_api/operations/delete.rb

@@ -0,0 +1,20 @@
+module SwaggerApi
+  module Operations
+    class Delete < Base
+      def success_response
+        {
+          '204' => {
+            description: "#{readable_action} #{model_name.downcase}'s information",
+          }
+        }
+      end
+
+
+      def error_responses
+        super.reject do |error_response|
+          %w(422).include?(error_response.keys.first)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_api/operations/index.rb

@@ -0,0 +1,50 @@
+module SwaggerApi
+  module Operations
+    class Index < Base
+      def headers
+        {
+          'x-total' => {
+            schema: {
+              type: :integer
+            },
+            description: 'total results available',
+          },
+          'x-link-next' => {
+            schema: {
+              type: :string
+            },
+            description: 'uri for next page of results',
+          },
+        }
+      end
+
+      def parameters
+        columns.map do |column|
+          {
+            name: column.name,
+            in: 'query',
+            required: false,
+            description: "#{column.name} of #{model.name}",
+            schema: SwaggerApi::ColumnSchema.new(column: column).create,
+          }
+        end
+      end
+
+      def success_response
+        success = super
+        success['200'][:headers] = headers
+        success
+      end
+
+      def readable_action
+        'list'
+      end
+
+      def error_responses
+        super.reject do |error_response|
+          %w(404 422).include?(error_response.keys.first)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_api/operations/show.rb

@@ -0,0 +1,11 @@
+module SwaggerApi
+  module Operations
+    class Show < Base
+      def error_responses
+        super.reject do |error_response|
+          %w(422).include?(error_response.keys.first)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_api/operations/update.rb

@@ -0,0 +1,32 @@
+module SwaggerApi
+  module Operations
+    class Update < Base
+      def create
+        create = super
+        create[:requestBody] = request_body
+        create
+      end
+
+      def request_body
+        {
+          "$ref" => "#/components/requestBodies/#{model_name}"
+        }
+      end
+
+      def success_response
+        {
+          '303' => {
+            description: "#{readable_action} #{model_name.downcase}'s information",
+            headers: {
+              Location: {
+                schema: {
+                  type: :string
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/swagger_api/paths.rb

@@ -0,0 +1,52 @@
+module SwaggerApi
+  class Paths
+    include ActiveAttr::Model
+    attr_accessor :controllers
+
+    def create
+      return @paths unless @paths.nil?
+      @paths = {}
+      controllers.each do |controller|
+        if controller.custom_path_file.nil?
+          @paths.merge!(paths(controller))
+        else
+          @paths.merge!(custom_json(controller))
+        end
+      end
+      @paths
+    end
+
+    private
+
+    def paths(controller)
+      paths = {}
+      paths["#{route(controller)}"] = {}
+      paths["#{route(controller)}{id}/"] = {}
+      paths["#{route(controller)}"][:get] = SwaggerApi::Operations::Index.new(controller: controller).create if action?(controller, 'index')
+      paths["#{route(controller)}"][:post] = SwaggerApi::Operations::Create.new(controller: controller).create if action?(controller, 'create')
+      paths["#{route(controller)}{id}/"][:get] = SwaggerApi::Operations::Show.new(controller: controller).create if action?(controller, 'show')
+      paths["#{route(controller)}{id}/"][:put] = SwaggerApi::Operations::Update.new(controller: controller).create if action?(controller, 'update')
+      paths["#{route(controller)}{id}/"][:delete] = SwaggerApi::Operations::Delete.new(controller: controller).create if action?(controller, 'delete')
+      paths["#{route(controller)}"].delete if paths["#{route(controller)}"].blank?
+      paths["#{route(controller)}{id}/"].delete if paths["#{route(controller)}{id}/"].blank?
+      paths
+    end
+
+    def route(controller)
+      "/#{controller.name.demodulize.underscore.gsub('_controller', '')}/"
+    end
+
+    def custom_json(controller)
+      file = File.read(controller.custom_path_file)
+      JSON.parse(file)
+    end
+
+    def actions(controller)
+      SwaggerApi::Actions.new(controller: controller).all!
+    end
+
+    def action?(controller, action_name)
+      actions(controller).include?(action_name)
+    end
+  end
+end

data/lib/swagger_api/railtie.rb

@@ -0,0 +1,6 @@
+require 'rails'
+class SwaggerApi::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'swagger_api/tasks/swagger.rake'
+  end
+end

data/lib/swagger_api/request_bodies.rb

@@ -0,0 +1,28 @@
+module SwaggerApi
+  class RequestBodies
+    include ActiveAttr::Model
+    attr_accessor :controllers
+
+    def create
+      request_bodies = {}
+      controllers.each do |controller|
+        request_bodies[controller.model] = request_body(controller)
+      end
+      request_bodies
+    end
+
+    def request_body(controller)
+      {
+        content: {
+          'application/json' => {
+            schema: {
+              '$ref' => "#/components/schemas/#{controller.model}"
+            }
+          }
+        },
+        description: "audience attribute",
+        required: true
+      }
+    end
+  end
+end

data/lib/swagger_api/tasks/swagger.rake

@@ -0,0 +1,13 @@
+
+namespace :swagger do
+  desc 'Create a local version of the swagger api json file'
+  task swagger_api: [:environment] do
+    generator = SwaggerApi::Generator.new
+    File.open('api.yml', 'w+') do |file|
+      file.write(YAML.dump(JSON.parse(generator.json)))
+    end
+    File.open('api.json', 'w+') do |file|
+      file.write(generator.prettify)
+    end
+  end
+end

data/lib/swagger_api/version.rb

@@ -0,0 +1,3 @@
+module SwaggerApi
+  VERSION = "0.1.43"
+end

data/swagger.yml

@@ -0,0 +1,46 @@
+info:
+  version: 1.0.0-oas
+  title: FME Integrations
+  description: Student basic information and audiences
+servers:
+  cm_production:
+    url: https://cm.fullmeasureed.com/api/webservices
+  cm_stage:
+    url: https://cm.stage.fullmeasureed.com/api/webservices
+  iwu_production:
+    url: https://iwu.fullmeasureed.com/api/webservices
+  iwu_stage:
+    url: https://iwu.stage.fullmeasureed.com/api/webservices
+  development:
+    url: https://localhost:3000/api/webservices
+controllers:
+  - name: Api::WebServices::StudentsController
+    model: Student
+    columns:
+      only:
+        - id
+        - first_name
+        - last_name
+        - email
+        - mobile_phone_number
+        - external_student_id
+        - type
+
+      required:
+        - id
+        - first_name
+        - last_name
+        - email
+        - mobile_phone_number
+        - external_student_id
+        - type
+
+  - name: Api::WebServices::AudiencesController
+    model: Audience
+
+  - name: Api::WebServices::AudienceStudentsController
+    actions:
+      except:
+        - update
+    model: AudienceStudent
+

data/swagger_api.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swagger_api'
+  spec.version       = SwaggerApi::VERSION
+  spec.authors       = ['Full Measure Education']
+  spec.email         = ['devops@fullmeasureed.com']
+
+  spec.summary       = %q{A simple library for autocreating RESTful swagger api docs from Rails controllers.}
+  spec.description   = %q{A simple library for autocreating RESTful swagger api docs from Rails controllers.}
+  spec.homepage      = 'https://gitlab.com/fullmeasure/public/swagger-api/swagger_api'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'rails', '>= 5.0'
+  spec.add_dependency 'active_attr'
+  spec.add_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: swagger_api
+version: !ruby/object:Gem::Version
+  version: 0.1.43
+platform: ruby
+authors:
+- Full Measure Education
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  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: rspec-rails
+  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'
+description: A simple library for autocreating RESTful swagger api docs from Rails
+  controllers.
+email:
+- devops@fullmeasureed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swagger_api.rb
+- lib/swagger_api/actions.rb
+- lib/swagger_api/column_schema.rb
+- lib/swagger_api/component_schema.rb
+- lib/swagger_api/components.rb
+- lib/swagger_api/concerns/columns.rb
+- lib/swagger_api/operations/base.rb
+- lib/swagger_api/operations/create.rb
+- lib/swagger_api/operations/delete.rb
+- lib/swagger_api/operations/index.rb
+- lib/swagger_api/operations/show.rb
+- lib/swagger_api/operations/update.rb
+- lib/swagger_api/paths.rb
+- lib/swagger_api/railtie.rb
+- lib/swagger_api/request_bodies.rb
+- lib/swagger_api/tasks/swagger.rake
+- lib/swagger_api/version.rb
+- swagger.yml
+- swagger_api.gemspec
+homepage: https://gitlab.com/fullmeasure/public/swagger-api/swagger_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A simple library for autocreating RESTful swagger api docs from Rails controllers.
+test_files: []