jsonapi-resources-home 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cff29ba2ac131709adc8c382e99439761195f3c8
+  data.tar.gz: c605fc66880b4926dd8ffc6375e8d3a9c907f588
+SHA512:
+  metadata.gz: f2d4c7d8dbd83f16ef17d861d4bdac0f33c17518730e273fd29a3bf1fc18f823dbcef5970ec1c01e8eb9571a7e8dd03a5f3d8f2d2b32aad65f82e4458ab4f46c
+  data.tar.gz: e7e289f4cac855522c1bbf048f0ac7eb6e45ffd7134624257057e41f6bd5c42f3e9ac6565a7e8e1e7dd6e1fdfac7d55e23b883989e39ee94ea3916cb2f904e4e

data/LICENSE

@@ -0,0 +1,6 @@
+ISC License (ISC)
+Copyright 2017 Kurtis Rainbolt-Greene
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,251 @@
+# jsonapi-resources-home
+
+  - [![Build](http://img.shields.io/travis-ci/krainboltgreene/blankgem.gem.svg?style=flat-square)](https://travis-ci.org/krainboltgreene/blankgem.gem)
+  - [![License](http://img.shields.io/badge/license-ISC-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/ISC)
+  - [![Version](http://img.shields.io/gem/v/blankgem.svg?style=flat-square)](https://rubygems.org/gems/blankgem)
+
+An implementation of JSONAPIHome (which is a fork of JSONHome).
+
+
+## Using
+
+First, set yourself up with a `HOME_LOCATION`, this is the protocol+hostname[+suffix] combination where your api exists:
+
+```
+HOME_LOCATION=https://origin.example.com
+``
+
+To have this all work you just need to mount the engine:
+
+``` ruby
+Rails.application.routes.draw do
+  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+
+  mount JSONAPI::Resources::Home::Engine, at: "/"
+
+  namespace :v1 do
+    jsonapi_resources :accounts
+  end
+end
+```
+
+This will setup the basic set of home routes, and with this request:
+
+```
+* Preparing request to http://localhost:3000/v1/resources
+* Enable automatic URL encoding
+* Enable SSL validation
+* Enable cookie sending with jar of 0 cookies
+* Found bundle for host localhost: 0x7fe522cdb340 [can pipeline]
+* Re-using existing connection! (#29) with host localhost
+* Connected to localhost (::1) port 3000 (#29)
+> GET /v1/resources HTTP/1.1
+> Host: localhost:3000
+> User-Agent: insomnia/5.9.6
+> Accept: */*
+> Accept-Encoding: deflate, gzip
+```
+
+You'll get this payload:
+
+``` json
+{
+	"data": []
+}
+```
+
+The reason nothing shows up is because we need to opt-in to the jsonapi home endpoint:
+
+``` ruby
+module V1
+  class AccountsController < V1::ApplicationController
+    home_discoverable description: "The accounts resource"
+  end
+end
+
+```
+
+Which results in this payload:
+
+``` json
+{
+	"data": [
+		{
+			"id": "accounts-v1-list",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-list"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "list",
+				"verb": "GET",
+				"href": "http://home.example.com/v1/accounts",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.043-08:00"
+			}
+		},
+		{
+			"id": "accounts-v1-create",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-create"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "create",
+				"verb": "POST",
+				"href": "http://home.example.com/v1/accounts",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.044-08:00"
+			}
+		},
+		{
+			"id": "accounts-v1-show",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-show"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "show",
+				"verb": "GET",
+				"href": "http://home.example.com/v1/accounts/{id}",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.044-08:00"
+			}
+		},
+		{
+			"id": "accounts-v1-update",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-update"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "update",
+				"verb": "PATCH",
+				"href": "http://home.example.com/v1/accounts/{id}",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.045-08:00"
+			}
+		},
+		{
+			"id": "accounts-v1-update",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-update"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "update",
+				"verb": "PATCH",
+				"href": "http://home.example.com/v1/accounts/{id}",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.045-08:00"
+			}
+		},
+		{
+			"id": "accounts-v1-destroy",
+			"type": "resources",
+			"links": {
+				"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-destroy"
+			},
+			"attributes": {
+				"namespace": "accounts",
+				"version": "v1",
+				"intent": "destroy",
+				"verb": "DELETE",
+				"href": "http://home.example.com/v1/accounts/{id}",
+				"allowed": null,
+				"mediatype": "application/vnd.api+json",
+				"description": "The accounts resource",
+				"created-at": "2017-11-10T00:27:39.039-08:00",
+				"updated-at": "2017-11-10T00:27:39.046-08:00"
+			}
+		}
+	]
+}
+```
+
+You can also inquire about individual endpoints:
+
+```
+* Preparing request to http://localhost:3000/v1/resources/accounts-v1-list
+* Enable automatic URL encoding
+* Enable SSL validation
+* Enable cookie sending with jar of 0 cookies
+* Connection 65 seems to be dead!
+* Closing connection 65
+*   Trying ::1...
+* TCP_NODELAY set
+* Connected to localhost (::1) port 3000 (#66)
+> GET /v1/resources/accounts-v1-list HTTP/1.1
+> Host: localhost:3000
+> User-Agent: insomnia/5.9.6
+> Accept: */*
+> Accept-Encoding: deflate, gzip
+```
+
+``` json
+{
+	"data": {
+		"id": "accounts-v1-list",
+		"type": "resources",
+		"links": {
+			"self": "http://localhost:3000/jsonapi/resources/home/v1/resources/accounts-v1-list"
+		},
+		"attributes": {
+			"namespace": "accounts",
+			"version": "v1",
+			"intent": "list",
+			"verb": "GET",
+			"href": "http://home.example.com/v1/accounts",
+			"allowed": null,
+			"mediatype": "application/vnd.api+json",
+			"description": "The accounts resource",
+			"created-at": "2017-11-10T01:01:28.576-08:00",
+			"updated-at": "2017-11-10T01:01:28.582-08:00"
+		}
+	}
+}
+```
+
+Because it's jsonapi.org you can use all the normal interfaces.
+
+
+## Installing
+
+Install with gemrat:
+
+  $ gemrat jsonapi-resources-home
+
+
+## Contributing
+
+  1. Read the [Code of Conduct](/CONDUCT.md)
+  2. Fork it
+  3. Create your feature branch (`git checkout -b my-new-feature`)
+  4. Commit your changes (`git commit -am 'Add some feature'`)
+  5. Push to the branch (`git push origin my-new-feature`)
+  6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+begin
+  require "bundler/setup"
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+require "rspec/core/rake_task"
+
+desc "Run all the tests in spec"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Default: run tests"
+task default: :spec

data/app/controllers/jsonapi/resources/home/v1/resources_controller.rb

@@ -0,0 +1,13 @@
+module JSONAPI
+  module Resources
+    module Home
+      module V1
+        class ResourcesController < ::ApplicationController
+          include JSONAPI::ActsAsResourceController
+
+          home_discoverable description: "All discoverable HTTP API endpoints"
+        end
+      end
+    end
+  end
+end

data/app/models/jsonapi/resources/home/v1/resource.rb

@@ -0,0 +1,110 @@
+module JSONAPI
+  module Resources
+    module Home
+      module V1
+        class Resource
+          include ActiveModel::Model
+
+          MEDIATYPE = "application/vnd.api+json"
+          private_constant :MEDIATYPE
+          CREATED_AT = Time.now
+          private_constant :CREATED_AT
+
+          attr_accessor :namespace
+          attr_accessor :version
+          attr_accessor :intent
+          attr_accessor :verb
+          attr_accessor :href
+          attr_accessor :allowed
+          attr_accessor :mediatype
+          attr_accessor :description
+          attr_reader :route
+          private :route
+
+          def self.all
+            routes.map(&method(:new)).select(&:valid?)
+          end
+
+          def self.where(attributes)
+            all.where(attributes)
+          end
+
+          private_class_method def self.routes
+            Rails.
+              application.
+              routes.routes.
+              to_a
+          end
+
+          def initialize(route)
+            @route = route
+          end
+
+          def id
+            "#{namespace}-#{version}-#{intent}"
+          end
+
+          def intent
+            if defaults.fetch(:action) == "index"
+              "list"
+            else
+              defaults.fetch(:action)
+            end
+          end
+
+          def version
+            defaults.fetch(:controller).split("/").first
+          end
+
+          def namespace
+            defaults.fetch(:controller).split("/").last
+          end
+
+          def description
+            controller.instance_variable_get(:@jsonapi_resources_home_description)
+          end
+
+          def verb
+            route.verb
+          end
+
+          def href
+            File.join(controller.instance_variable_get(:@json_api_home_location) || ENV.fetch("HOME_LOCATION"), path)
+          end
+
+          def mediatype
+            MEDIATYPE
+          end
+
+          def created_at
+            CREATED_AT
+          end
+
+          def updated_at
+            Time.now
+          end
+
+          def valid?
+            !route.internal && defaults.any? && controller.instance_variable_get(:@jsonapi_resources_home)
+          end
+
+          private def payload
+            route.parts.without(:format).map {|part| {part => "{#{part}}"}}.reduce(:merge) || {}
+          end
+
+          private def path
+            URI.decode(route.format(payload))
+          end
+
+          private def controller
+            "#{defaults.fetch(:controller).classify.pluralize}Controller".constantize
+          end
+
+          private def defaults
+            route.defaults
+          end
+        end
+      end
+    end
+  end
+end

data/app/resources/jsonapi/resources/home/v1/resource_resource.rb

@@ -0,0 +1,30 @@
+module JSONAPI
+  module Resources
+    module Home
+      module V1
+        class ResourceResource < ::ApplicationResource
+          key_type :string
+
+          immutable
+
+          model_name "JSONAPI::Resources::Home::V1::Resource"
+
+          attribute :namespace
+          attribute :version
+          attribute :intent
+          attribute :verb
+          attribute :href
+          attribute :allowed
+          attribute :mediatype
+          attribute :description
+          attribute :created_at
+          attribute :updated_at
+
+          def self.default_sort
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+JSONAPI::Resources::Home::Engine.routes.draw do
+  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+
+  namespace :v1 do
+    resources :resources, only: [:index, :show]
+  end
+end