apitome 0.0.8 → 0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitome
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.3.0
 platform: ruby
 authors:
 - jejacks0n
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,22 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_api_documentation
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,23 +39,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: rspec_api_documentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
 description: API documentation renderer for Rails using RSpec API Documentation JSON
   output
 email:
-- info@modeset.com
+- jejacks0n@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -73,9 +67,11 @@ files:
 - app/assets/stylesheets/apitome/application.css
 - app/assets/stylesheets/apitome/bundle.css
 - app/controllers/apitome/docs_controller.rb
+- app/helpers/apitome/docs_helper.rb
 - app/views/apitome/docs/_all_examples.html.erb
 - app/views/apitome/docs/_body.html.erb
 - app/views/apitome/docs/_curl.html.erb
+- app/views/apitome/docs/_endpoint.html.erb
 - app/views/apitome/docs/_example.html.erb
 - app/views/apitome/docs/_explanation.html.erb
 - app/views/apitome/docs/_header.html.erb
@@ -83,6 +79,7 @@ files:
 - app/views/apitome/docs/_navigation.html.erb
 - app/views/apitome/docs/_params.html.erb
 - app/views/apitome/docs/_query.html.erb
+- app/views/apitome/docs/_resource_explanation.html.erb
 - app/views/apitome/docs/_response_fields.html.erb
 - app/views/apitome/docs/_route.html.erb
 - app/views/apitome/docs/_status.html.erb
@@ -91,7 +88,6 @@ files:
 - app/views/layouts/apitome/application.html.erb
 - config/locales/en.yml
 - config/locales/es.yml
-- config/routes.rb
 - lib/apitome.rb
 - lib/apitome/configuration.rb
 - lib/apitome/engine.rb
@@ -101,57 +97,91 @@ files:
 - lib/generators/apitome/install/install_generator.rb
 - lib/generators/apitome/install/templates/api.md
 - lib/generators/apitome/install/templates/initializer.rb
-- spec/apitome/configuration_spec.rb
-- spec/apitome/engine_spec.rb
-- spec/dummy/Rakefile
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/apitome.rb
-- spec/dummy/config/routes.rb
-- spec/dummy/doc/api.md
-- spec/dummy/public/favicon.ico
-- spec/dummy/script/rails
 - vendor/assets/javascripts/apitome/bootstrap.min.LICENSE
 - vendor/assets/javascripts/apitome/bootstrap.min.js
 - vendor/assets/javascripts/apitome/highlight.min.LICENSE
 - vendor/assets/javascripts/apitome/highlight.min.js
 - vendor/assets/javascripts/apitome/jquery-2.0.3.min.js
 - vendor/assets/stylesheets/apitome/bootstrap.min.css
+- vendor/assets/stylesheets/apitome/highlight_themes/agate.css
+- vendor/assets/stylesheets/apitome/highlight_themes/androidstudio.css
+- vendor/assets/stylesheets/apitome/highlight_themes/arduino-light.css
 - vendor/assets/stylesheets/apitome/highlight_themes/arta.css
 - vendor/assets/stylesheets/apitome/highlight_themes/ascetic.css
-- vendor/assets/stylesheets/apitome/highlight_themes/brown_paper.css
-- vendor/assets/stylesheets/apitome/highlight_themes/brown_papersq.png
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-cave-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-cave-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-dune-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-dune-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-estuary-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-estuary-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-forest-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-forest-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-heath-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-heath-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-lakeside-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-lakeside-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-plateau-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-plateau-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-savanna-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-savanna-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-seaside-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-seaside-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-sulphurpool-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/atelier-sulphurpool-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/brown-paper.css
+- vendor/assets/stylesheets/apitome/highlight_themes/brown-papersq.png
+- vendor/assets/stylesheets/apitome/highlight_themes/codepen-embed.css
+- vendor/assets/stylesheets/apitome/highlight_themes/color-brewer.css
 - vendor/assets/stylesheets/apitome/highlight_themes/dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/darkula.css
 - vendor/assets/stylesheets/apitome/highlight_themes/default.css
+- vendor/assets/stylesheets/apitome/highlight_themes/docco.css
+- vendor/assets/stylesheets/apitome/highlight_themes/dracula.css
 - vendor/assets/stylesheets/apitome/highlight_themes/far.css
+- vendor/assets/stylesheets/apitome/highlight_themes/foundation.css
+- vendor/assets/stylesheets/apitome/highlight_themes/github-gist.css
 - vendor/assets/stylesheets/apitome/highlight_themes/github.css
 - vendor/assets/stylesheets/apitome/highlight_themes/googlecode.css
+- vendor/assets/stylesheets/apitome/highlight_themes/grayscale.css
+- vendor/assets/stylesheets/apitome/highlight_themes/gruvbox-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/gruvbox-light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/hopscotch.css
+- vendor/assets/stylesheets/apitome/highlight_themes/hybrid.css
 - vendor/assets/stylesheets/apitome/highlight_themes/idea.css
-- vendor/assets/stylesheets/apitome/highlight_themes/ir_black.css
+- vendor/assets/stylesheets/apitome/highlight_themes/ir-black.css
+- vendor/assets/stylesheets/apitome/highlight_themes/kimbie.dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/kimbie.light.css
 - vendor/assets/stylesheets/apitome/highlight_themes/magula.css
+- vendor/assets/stylesheets/apitome/highlight_themes/mono-blue.css
+- vendor/assets/stylesheets/apitome/highlight_themes/monokai-sublime.css
 - vendor/assets/stylesheets/apitome/highlight_themes/monokai.css
+- vendor/assets/stylesheets/apitome/highlight_themes/obsidian.css
+- vendor/assets/stylesheets/apitome/highlight_themes/paraiso-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/paraiso-light.css
 - vendor/assets/stylesheets/apitome/highlight_themes/pojoaque.css
 - vendor/assets/stylesheets/apitome/highlight_themes/pojoaque.jpg
+- vendor/assets/stylesheets/apitome/highlight_themes/purebasic.css
+- vendor/assets/stylesheets/apitome/highlight_themes/qtcreator_dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/qtcreator_light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/railscasts.css
 - vendor/assets/stylesheets/apitome/highlight_themes/rainbow.css
-- vendor/assets/stylesheets/apitome/highlight_themes/school_book.css
-- vendor/assets/stylesheets/apitome/highlight_themes/school_book.png
-- vendor/assets/stylesheets/apitome/highlight_themes/solarized_dark.css
-- vendor/assets/stylesheets/apitome/highlight_themes/solarized_light.css
+- vendor/assets/stylesheets/apitome/highlight_themes/school-book.css
+- vendor/assets/stylesheets/apitome/highlight_themes/school-book.png
+- vendor/assets/stylesheets/apitome/highlight_themes/solarized-dark.css
+- vendor/assets/stylesheets/apitome/highlight_themes/solarized-light.css
 - vendor/assets/stylesheets/apitome/highlight_themes/sunburst.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-blue.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-bright.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-eighties.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night.css
 - vendor/assets/stylesheets/apitome/highlight_themes/tomorrow.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_blue.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_bright.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_eighties.css
 - vendor/assets/stylesheets/apitome/highlight_themes/vs.css
 - vendor/assets/stylesheets/apitome/highlight_themes/xcode.css
+- vendor/assets/stylesheets/apitome/highlight_themes/xt256.css
 - vendor/assets/stylesheets/apitome/highlight_themes/zenburn.css
-homepage: https://github.com/modeset/apitome
-licenses: []
+homepage: https://github.com/jejacks0n/apitome
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -159,32 +189,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: 'Apitome: /iˈpitəmē/ An API documentation reader RSpec API Documentation'
-test_files:
-- spec/apitome/configuration_spec.rb
-- spec/apitome/engine_spec.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/apitome.rb
-- spec/dummy/config/routes.rb
-- spec/dummy/config.ru
-- spec/dummy/doc/api.md
-- spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/script/rails
+test_files: []

data/config/routes.rb

@@ -1,4 +0,0 @@
-Apitome::Engine.routes.draw do
-  root to: 'docs#index'
-  get '/*path', to: 'docs#show'
-end

data/spec/dummy/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks

data/spec/dummy/config.ru

@@ -1,15 +0,0 @@
-# This file is used by Rack-based servers to start the application.
-
-require 'rails/commands/server'
-
-module Rails
-  class Server
-    alias :default_options_alias :default_options
-    def default_options
-      default_options_alias.merge!(:Port => 3333)
-    end
-  end
-end
-
-require ::File.expand_path('../config/environment',  __FILE__)
-run Dummy::Application

data/spec/dummy/config/application.rb

@@ -1,16 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require "action_controller/railtie"
-
-Bundler.require
-
-module Dummy
-  class Application < Rails::Application
-    config.encoding = "utf-8"
-    config.session_store :cookie_store, key: '_dummy_session'
-    config.secret_token = 'bc510a13d2fb96575782e90e9f2f64afc0ba4e63e5869b6139613686f104d4d3dd92ee696468de5bcbbb74daedb702d3da97554efbc6792abe75091b9df0a2ab'
-    config.secret_key_base = 'bc510a13d2fb96575782e90e9f2f64afc0ba4e63e5869b6139613686f104d4d3dd92ee696468de5bcbbb74daedb702d3da97554efbc6792abe75091b9df0a2ab'
-    config.assets.enabled = true
-    config.assets.version = '1.0'
-  end
-end

data/spec/dummy/config/boot.rb

@@ -1,7 +0,0 @@
-require "rubygems"
-
-# Set up gems listed in the Gemfile.
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../../Gemfile", __FILE__)
-
-require "bundler/setup" if File.exists?(ENV["BUNDLE_GEMFILE"])
-require "rubygems"

data/spec/dummy/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the rails application
-require File.expand_path('../application', __FILE__)
-
-# Initialize the rails application
-Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -1,27 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
-
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Do not compress assets
-  config.assets.compress = false
-
-  # Expands the lines which load the assets
-  config.assets.debug = true
-
-  # Eager loading
-  config.eager_load = false
-end

data/spec/dummy/config/environments/test.rb

@@ -1,29 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
-  config.cache_classes = true
-
-  # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
-
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
-
-  # Print deprecation notices to the stderr
-  config.active_support.deprecation = :stderr
-
-  # Eager loading
-  config.eager_load = false
-end

data/spec/dummy/config/initializers/apitome.rb

@@ -1,44 +0,0 @@
-Apitome.setup do |config|
-
-  # This determines where the Apitome routes will be mounted. Changing this to "/api/documentation" for instance would
-  # allow you to browse to http://localhost:3000/api/documentation to see your api documentation. Set to nil and mount
-  # it yourself if you need to.
-  config.mount_at = "/api/docs"
-
-  # This defaults to Rails.root if left nil. If you're providing documentation for an engine using a dummy application
-  # it can be useful to set this to your engines root.. E.g. Application::Engine.root
-  config.root = nil
-
-  # This is where rspec_api_documentation outputs the JSON files. This is configurable within RAD, and so is
-  # configurable here.
-  config.doc_path = 'doc/api'
-
-  # The title of the documentation -- If your project has a name, you'll want to put it here.
-  config.title = 'Apitome Documentation'
-
-  # The main layout view for all documentation pages. By default this is pretty basic, but you may want to use your own
-  # application layout.
-  config.layout = 'apitome/application'
-
-  # We're using highlight.js (https://github.com/isagalaev/highlight.js) for code highlighting, and it comes with some
-  # great themes. You can check http://softwaremaniacs.org/media/soft/highlight/test.html for themes, and enter the
-  # theme as lowercase/underscore.
-  config.code_theme = 'default'
-
-  # This allows you to override the css manually. You typically want to require `apitome/application` within the
-  # override, but if you want to override it entirely you can do so.
-  config.css_override = nil
-
-  # This allows you to override the javascript manually. You typically want to require `apitome/application` within the
-  # override, but if you want to override it entirely you can do so.
-  config.js_override = nil
-
-  # You can provide a "README" style markdown file for the documentation, which is a useful place to include general
-  # information. This path is relative to your doc_path configuration.
-  config.readme = '../api.md'
-
-  # Apitome can render the documentation into a single page that uses scrollspy, or it can render the documentation on
-  # individual pages on demand. This allows you to specify which one you want, as a single page may impact performance.
-  config.single_page = true
-
-end

data/spec/dummy/config/routes.rb

@@ -1,2 +0,0 @@
-Dummy::Application.routes.draw do
-end

data/spec/dummy/doc/api.md

@@ -1,20 +0,0 @@
-## API Documentation
-
-### Request Headers
-
-The [`Accept-Language`](http://www.w3.org/International/questions/qa-accept-lang-locales) header should be provided in all requests so localization of messaging can be applied and/or different translations for records can be returned. The value will default to `en-US,en` if unspecified.
-
-The `X-Unit-Type` header should be provided in all requests so units of measurements (temperature, etc) can be provided back to the client in the correct format or processed/converted before storing. The value can be either `imperial`, or `metric`. This could be provided to the user as a setting, and if omitted will be inferred using the `Accept-Language` header or 'en-US,en'. Imperial/Fahrenheit will be used for country codes matching "US", "LR" (Liberia), or "MM" (Myanmar/Burma), otherwise Metric/Celsius is assumed.
-
-### Response Codes
-
-#### 401 Unauthorized
-
-The server responds with a 401 if the client isn't providing the correct client id/secret or if the user doesn't have access to the given resource being requested.
-
-```json
-{
-  "error": "unauthenticated",
-  "error_description": "This action requires authentication to continue."
-}
-```