apitome 0.0.8 → 0.1.0

data/spec/apitome/configuration_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Apitome::Configuration do
+  it "should be tested"
+end

data/spec/apitome/engine_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Apitome::Engine do
+  it "should be tested"
+end

data/spec/dummy/config/application.rb

@@ -1,16 +1,37 @@
 require File.expand_path('../boot', __FILE__)
 
 require "action_controller/railtie"
+require "sprockets/railtie"
+begin
+  require "haml-rails"
+  require "coffee-rails"
+  require "sass-rails"
+  require "jquery-rails"
+rescue LoadError
+  # intentionally do nothing here, let the failure happen later.
+end
 
-Bundler.require
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
 
 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'
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Change our relative root url to show that if relative paths are setup properly, teaspoon will
+    # continue to work and load the proper urls.
+    config.relative_url_root = "/relative"
+    config.assets.prefix = "/relative/assets" # this must be set for any asset paths to be correct!
   end
 end

data/spec/dummy/config/boot.rb

@@ -1,7 +1,3 @@
-require "rubygems"
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-# 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"
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/spec/dummy/config/environment.rb

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

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

@@ -1,27 +1,41 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+Rails.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
+  # Do not eager load code on boot.
+  config.eager_load = 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
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
 
-  # Do not compress assets
-  config.assets.compress = false
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
 
-  # Expands the lines which load the assets
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
   config.assets.debug = true
 
-  # Eager loading
-  config.eager_load = false
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

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

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  # config.active_record.dump_schema_after_migration = false
+end

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

@@ -1,5 +1,5 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+Rails.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
@@ -7,23 +7,36 @@ Dummy::Application.configure do
   # 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"
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files = true
+  config.static_cache_control = 'public, max-age=3600'
 
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  # 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
+  # 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
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
 
-  # Print deprecation notices to the stderr
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
-  # Eager loading
-  config.eager_load = false
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/config/routes.rb

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

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: a28312cb73c1f3bc98f5fa393a6d8347d067ef9c24ac90f40e8ea98315d448cfd0ebcf9079b04eb77358afd81522a521ddc1c5bc30b31d3cbf812ef904dd55a2
+
+test:
+  secret_key_base: 8fe67c730ce5c57f02cb83acf73e4d527b45e805639b2e9f56a6dc7cf579affa4838d75432903bbeb7f4766ec57d8392ff0f42e630615cbc2d564f8242a4471c
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/dummy/doc/api.md

@@ -1,20 +1,39 @@
-## API Documentation
+API Documentation
+=================
 
-### Request Headers
+### Current Version
+
+  1. `/api/v1/*`
+  2. `/api/edge/*` (forthcoming version)
+
+### Introduction
+
+This API adheres to the [json:api specification](http://jsonapi.org). To be explicit you can provide the `Accept` header
+as `application/vnd.api+json`, but this is the default behavior.
 
-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.
+Each endpoint response is validated against a JSON schema, and the documentation for each scenario contains a link to
+the schema used in the validation layer. These schemas sometimes include a `$ref` node to an additional schema, and in
+these cases you can modify the url to load the desired JSON schema.
 
-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.
+#### Authentication
 
-### Response Codes
+A **Client ID** and **Secret Key** will be issued for your specific client application which can then be used to
+retrieve an OAuth token. These are considered your **client credentials**.
 
-#### 401 Unauthorized
+Before any API request can be fulfilled, a valid OAuth access token must be requested and provided back on subsequent
+API requests. The token must be provided in the `Authorization` header as `Bearer [access_token]`, or as an
+`access_token` param. The header technique is strongly recommended but may not always work, for instance on event
+streams.
 
-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.
+If no token or an invalid/expired token is provided to any API endpoint, a 401 status code will be returned with
+additional messaging, at which point a new token may be requested.
+
+There are two token types. A [client access token](#access-tokens-client-access-token-client-credentials-) (a
+`client_credential` grant), and a [user access token](#access-tokens-user-access-token-password-) (a `password` grant).
+All requests require a token, most requiring a user access token, and a few that only require a client access token, you
+may need to use both token types under different circumstances.
+
+### Request Headers
 
-```json
-{
-  "error": "unauthenticated",
-  "error_description": "This action requires authentication to continue."
-}
-```
+The `Accept-Language` header should be provided on all requests to enable localization of messaging. The value will
+default to `en-US,en` if left unspecified.

data/spec/dummy/doc/api/access_tokens/-_when_the_user_credentials_are_invalid.json

@@ -0,0 +1,69 @@
+{
+  "resource": "Access Tokens",
+  "http_method": "POST",
+  "route": "/api/oauth/token",
+  "description": "- When the user credentials are invalid",
+  "parameters": [
+    {
+      "required": true,
+      "name": "client_id",
+      "description": "Client ID (as provided)"
+    },
+    {
+      "required": true,
+      "name": "client_secret",
+      "description": "Client Secret (as provided)"
+    },
+    {
+      "required": true,
+      "Expected": "password",
+      "name": "grant_type",
+      "description": "Grant Type"
+    },
+    {
+      "required": true,
+      "name": "email",
+      "description": "Email address"
+    },
+    {
+      "required": true,
+      "name": "password",
+      "description": "Password"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "/api/oauth/token",
+      "request_body": "{\"client_id\":\"04e83c5f62d57a5458c8fd970cf499677156274ab02895cf8dabcc6e07beb2b1\",\"client_secret\":\"5c49359ffdc9b5ee6914716e573f9916ad6cbac1c13f4863a9082dcfdc7dab07\",\"grant_type\":\"password\",\"email\":\"sterling@isisagency.com\",\"password\":\"martini\"}",
+      "request_headers": {
+        "Content-Type": "application/json",
+        "Host": "example.co,",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 401,
+      "response_status_text": "Unauthorized",
+      "response_body": "{\"errors\":{\"status\":\"401\",\"title\":\"No dice. Unable to find account.\",\"code\":\"not_valid\"}}",
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "Cache-Control": "no-store",
+        "Pragma": "no-cache",
+        "Content-Type": "application/json; charset=utf-8",
+        "WWW-Authenticate": "Bearer realm=\"Example\", error=\"not_valid\", error_description=\"No dice. Unable to find account.\"",
+        "X-Request-Id": "95eef58b-e70f-4cb8-9dec-56bc819491fc",
+        "X-Runtime": "0.329802",
+        "Content-Length": "89"
+      },
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+    }
+  ]
+}

data/spec/dummy/doc/api/access_tokens/-_when_the_user_has_been_locked_out.json

@@ -0,0 +1,69 @@
+{
+  "resource": "Access Tokens",
+  "http_method": "POST",
+  "route": "/api/oauth/token",
+  "description": "- When the user has been locked out",
+  "parameters": [
+    {
+      "required": true,
+      "name": "client_id",
+      "description": "Client ID (as provided)"
+    },
+    {
+      "required": true,
+      "name": "client_secret",
+      "description": "Client Secret (as provided)"
+    },
+    {
+      "required": true,
+      "Expected": "password",
+      "name": "grant_type",
+      "description": "Grant Type"
+    },
+    {
+      "required": true,
+      "name": "email",
+      "description": "Email address"
+    },
+    {
+      "required": true,
+      "name": "password",
+      "description": "Password"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "/api/oauth/token",
+      "request_body": "{\"client_id\":\"04e83c5f62d57a5458c8fd970cf499677156274ab02895cf8dabcc6e07beb2b1\",\"client_secret\":\"5c49359ffdc9b5ee6914716e573f9916ad6cbac1c13f4863a9082dcfdc7dab07\",\"grant_type\":\"password\",\"email\":\"sterling@isisagency.com\",\"password\":\"lanaisawesome\"}",
+      "request_headers": {
+        "Content-Type": "application/json",
+        "Host": "example.com",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 401,
+      "response_status_text": "Unauthorized",
+      "response_body": "{\"errors\":{\"status\":\"401\",\"title\":\"No dice. Account has been locked.\",\"code\":\"locked_out\"}}",
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "Cache-Control": "no-store",
+        "Pragma": "no-cache",
+        "Content-Type": "application/json; charset=utf-8",
+        "WWW-Authenticate": "Bearer realm=\"Example\", error=\"locked_out\", error_description=\"No dice. Account has been locked.\"",
+        "X-Request-Id": "d51a737f-c6a1-433c-beeb-2fe6689ab3e1",
+        "X-Runtime": "0.003804",
+        "Content-Length": "91"
+      },
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+    }
+  ]
+}