Add NodeInfo 2.0 support

Author: SuperTux88

app/presenters/node_info_presenter.rb

@@ -26,8 +26,7 @@ def add_configuration(doc)
 
   def add_static_data(doc)
     doc.software.name = "diaspora"
-    doc.protocols.inbound << "diaspora"
-    doc.protocols.outbound << "diaspora"
+    doc.protocols.protocols << "diaspora"
   end
 
   def add_user_counts(doc)

lib/node_info.rb

@@ -2,7 +2,7 @@
 require "json-schema"
 
 module NodeInfo
-  VERSIONS = %w(1.0)
+  VERSIONS = %w(1.0 2.0).freeze
   SCHEMAS = {}
   private_constant :VERSIONS, :SCHEMAS
 
@@ -21,17 +21,21 @@ def version_10_hash
       end
     end
 
-    Protocols = Struct.new(:inbound, :outbound) do
-      def initialize(inbound=[], outbound=[])
-        super(inbound, outbound)
+    Protocols = Struct.new(:protocols) do
+      def initialize(protocols=[])
+        super(protocols)
       end
 
       def version_10_hash
         {
-          "inbound"  => inbound,
-          "outbound" => outbound
+          "inbound"  => protocols,
+          "outbound" => protocols
         }
       end
+
+      def version_20_array
+        protocols
+      end
     end
 
     Services = Struct.new(:inbound, :outbound) do
@@ -90,6 +94,8 @@ def as_json(_options={})
       case version
       when "1.0"
         version_10_hash
+      when "2.0"
+        version_20_hash
       end
     end
 
@@ -124,6 +130,18 @@ def version_10_hash
       )
     end
 
+    def version_20_hash
+      deep_compact(
+        "version"           => "2.0",
+        "software"          => software.version_10_hash,
+        "protocols"         => protocols.version_20_array,
+        "services"          => services.version_10_hash,
+        "openRegistrations" => open_registrations,
+        "usage"             => usage.version_10_hash,
+        "metadata"          => metadata
+      )
+    end
+
     def deep_compact(hash)
       hash.tap do |hash|
         hash.reject! {|_, value|

spec/controllers/node_info_controller_spec.rb

@@ -15,6 +15,9 @@
       expect(jrd).to include "links" => [{
         "rel"  => "http://nodeinfo.diaspora.software/ns/schema/1.0",
         "href" => node_info_url("1.0")
+      }, {
+        "rel"  => "http://nodeinfo.diaspora.software/ns/schema/2.0",
+        "href" => node_info_url("2.0")
       }]
     end
   end
@@ -28,24 +31,27 @@
       end
     end
 
-    context "version 1.0" do
-      it "responds to JSON" do
-        get :document, version: "1.0", format: :json
+    %w(1.0 2.0).each do |version|
+      context "version #{version}" do
+        it "responds to JSON" do
+          get :document, version: version, format: :json
 
-        expect(response).to be_success
-      end
+          expect(response).to be_success
+        end
 
-      it "calls NodeInfoPresenter" do
-        expect(NodeInfoPresenter).to receive(:new).with("1.0")
-          .and_return(double(as_json: {}, content_type: "application/json"))
+        it "calls NodeInfoPresenter" do
+          expect(NodeInfoPresenter).to receive(:new).with(version)
+            .and_return(double(as_json: {}, content_type: "application/json"))
 
-        get :document, version: "1.0", format: :json
-      end
+          get :document, version: version, format: :json
+        end
 
-      it "notes the schema in the content type" do
-        get :document, version: "1.0", format: :json
+        it "notes the schema in the content type" do
+          get :document, version: version, format: :json
 
-        expect(response.content_type).to eq "application/json; profile=http://nodeinfo.diaspora.software/ns/schema/1.0#"
+          expect(response.content_type)
+            .to eq("application/json; profile=http://nodeinfo.diaspora.software/ns/schema/#{version}#")
+        end
       end
     end
   end

spec/lib/connection_tester_spec.rb

@@ -116,8 +116,7 @@
       ni_document = NodeInfo.build do |doc|
         doc.version = "1.0"
         doc.open_registrations = true
-        doc.protocols.inbound << "diaspora"
-        doc.protocols.outbound << "diaspora"
+        doc.protocols.protocols << "diaspora"
         doc.software.name = "diaspora"
         doc.software.version = "a.b.c.d"
       end

spec/presenters/node_info_presenter_spec.rb

@@ -128,5 +128,30 @@
         expect(hash).to include "metadata" => include("xmppChat" => true)
       end
     end
+
+    context "version 2.0" do
+      it "provides generic pod data in json" do
+        expect(NodeInfoPresenter.new("2.0").as_json.as_json).to eq(
+          "version"           => "2.0",
+          "software"          => {
+            "name"    => "diaspora",
+            "version" => AppConfig.version_string
+          },
+          "protocols"         => ["diaspora"],
+          "services"          => {
+            "inbound"  => [],
+            "outbound" => AppConfig.configured_services.map(&:to_s)
+          },
+          "openRegistrations" => AppConfig.settings.enable_registrations?,
+          "usage"             => {
+            "users" => {}
+          },
+          "metadata"          => {
+            "nodeName" => AppConfig.settings.pod_name,
+            "xmppChat" => AppConfig.chat.enabled?
+          }
+        )
+      end
+    end
   end
 end

vendor/nodeinfo/schemas/2.0.json

@@ -0,0 +1,182 @@
+
+
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://nodeinfo.diaspora.software/ns/schema/2.0#",
+  "description": "NodeInfo schema version 2.0.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "software",
+    "protocols",
+    "services",
+    "openRegistrations",
+    "usage",
+    "metadata"
+  ],
+  "properties": {
+    "version": {
+      "description": "The schema version, must be 2.0.",
+      "enum": [
+        "2.0"
+      ]
+    },
+    "software": {
+      "description": "Metadata about server software in use.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "version"
+      ],
+      "properties": {
+        "name": {
+          "description": "The canonical name of this server software.",
+          "type": "string",
+          "pattern": "^[a-z0-9-]+$"
+        },
+        "version": {
+          "description": "The version of this server software.",
+          "type": "string"
+        }
+      }
+    },
+    "protocols": {
+      "description": "The protocols supported on this server.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "enum": [
+          "activitypub",
+          "buddycloud",
+          "dfrn",
+          "diaspora",
+          "libertree",
+          "ostatus",
+          "pumpio",
+          "tent",
+          "xmpp",
+          "zot"
+        ]
+      }
+    },
+    "services": {
+      "description": "The third party sites this server can connect to via their application API.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inbound",
+        "outbound"
+      ],
+      "properties": {
+        "inbound": {
+          "description": "The third party sites this server can retrieve messages from for combined display with regular traffic.",
+          "type": "array",
+          "minItems": 0,
+          "items": {
+            "enum": [
+              "atom1.0",
+              "gnusocial",
+              "imap",
+              "pnut",
+              "pop3",
+              "pumpio",
+              "rss2.0",
+              "twitter"
+            ]
+          }
+        },
+        "outbound": {
+          "description": "The third party sites this server can publish messages to on the behalf of a user.",
+          "type": "array",
+          "minItems": 0,
+          "items": {
+            "enum": [
+              "atom1.0",
+              "blogger",
+              "buddycloud",
+              "diaspora",
+              "dreamwidth",
+              "drupal",
+              "facebook",
+              "friendica",
+              "gnusocial",
+              "google",
+              "insanejournal",
+              "libertree",
+              "linkedin",
+              "livejournal",
+              "mediagoblin",
+              "myspace",
+              "pinterest",
+              "pnut",
+              "posterous",
+              "pumpio",
+              "redmatrix",
+              "rss2.0",
+              "smtp",
+              "tent",
+              "tumblr",
+              "twitter",
+              "wordpress",
+              "xmpp"
+            ]
+          }
+        }
+      }
+    },
+    "openRegistrations": {
+      "description": "Whether this server allows open self-registration.",
+      "type": "boolean"
+    },
+    "usage": {
+      "description": "Usage statistics for this server.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "users"
+      ],
+      "properties": {
+        "users": {
+          "description": "statistics about the users of this server.",
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "total": {
+              "description": "The total amount of on this server registered users.",
+              "type": "integer",
+              "minimum": 0
+            },
+            "activeHalfyear": {
+              "description": "The amount of users that signed in at least once in the last 180 days.",
+              "type": "integer",
+              "minimum": 0
+            },
+            "activeMonth": {
+              "description": "The amount of users that signed in at least once in the last 30 days.",
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
+        "localPosts": {
+          "description": "The amount of posts that were made by users that are registered on this server.",
+          "type": "integer",
+          "minimum": 0
+        },
+        "localComments": {
+          "description": "The amount of comments that were made by users that are registered on this server.",
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "metadata": {
+      "description": "Free form key value pairs for software specific values. Clients should not rely on any specific key present.",
+      "type": "object",
+      "minProperties": 0,
+      "additionalProperties": true
+    }
+  }
+}