diaspora_federation-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bf7654fe5fb9891ce35ab3724bf2f5856e78e09
+  data.tar.gz: a0bfe0e3755eb6c95e3040c9388130b7e63372a5
+SHA512:
+  metadata.gz: 5c02284b47b4b559c7f3b06a54ac22f197c3cca690c6770ef53221751a143bc19dc4ea1afcc9c011f3014a64770f29107c6a6e62add69038f4a3113719626d5c
+  data.tar.gz: f7bb3e034736005500a5b26c9442fe5238da1772dce2f021aa976437cc09139f2bdabecead19e227add62522a1bb42d7bdfbeaec80a9499d7dbb5b7150978266

data/LICENSE

@@ -0,0 +1,18 @@
+Diaspora Federation Rails Engine
+Copyright (C) 2015  Benjamin Neff
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Some parts are based on an older federation gem from Florian Staudacher:
+https://github.com/Raven24/diaspora-federation

data/README.md

@@ -0,0 +1,68 @@
+# diaspora* federation library
+
+**A library that provides functionalities needed for the diaspora* federation protocol**
+
+[![Build Status](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=master)](https://travis-ci.org/SuperTux88/diaspora_federation)
+[![Code Climate](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation)
+[![Test Coverage](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/coverage.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation/coverage)
+[![Dependency Status](https://gemnasium.com/SuperTux88/diaspora_federation.svg)](https://gemnasium.com/SuperTux88/diaspora_federation)
+[![Inline docs](https://inch-ci.org/github/SuperTux88/diaspora_federation.svg?branch=master)](https://inch-ci.org/github/SuperTux88/diaspora_federation)
+[![Gem Version](https://badge.fury.io/rb/diaspora_federation.svg)](https://badge.fury.io/rb/diaspora_federation)
+
+[Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
+[Bugtracker](https://github.com/SuperTux88/diaspora_federation/issues)
+
+## Library
+
+The ```diaspora_federation``` gem provides the functionality for de-/serialization and de-/encryption of Entities
+in the protocols used for communication among the various installations of Diaspora*
+
+## Rails Engine
+
+The ```diaspora_federation-rails``` gem is a rails engine that adds the diaspora* federation protocol to a rails app.
+
+### Usage
+
+Add the gem to your ```Gemfile```:
+
+```ruby
+gem "diaspora_federation-rails"
+```
+
+Mount the routes in your ```config/routes.rb```:
+
+```ruby
+mount DiasporaFederation::Engine => "/"
+```
+
+Configure the engine in ```config/initializers/diaspora_federation.rb```:
+
+```ruby
+DiasporaFederation.configure do |config|
+  # the pod url
+  config.server_uri = AppConfig.pod_uri
+
+  # the class to be used for a person
+  config.person_class = Person
+end
+```
+
+## Development
+
+**!!! This gem is currently under heavy development, so every release can contain breaking changes !!!**
+
+If you want to help, please contact me, help is welcome.
+
+After the first stable release, this repo will be moved to the [diaspora organization](https://github.com/diaspora/).
+
+## Diaspora
+
+A privacy-aware, distributed, open source social network
+
+Links:
+[Project site](https://diasporafoundation.org) |
+[Wiki](https://wiki.diasporafoundation.org)
+
+## License
+
+This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.

data/app/controllers/diaspora_federation/application_controller.rb

@@ -0,0 +1,5 @@
+module DiasporaFederation
+  # Base-Controller for all DiasporaFederation-Controller
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/diaspora_federation/h_card_controller.rb

@@ -0,0 +1,18 @@
+require_dependency "diaspora_federation/application_controller"
+
+module DiasporaFederation
+  # this controller generates the hcard
+  class HCardController < ApplicationController
+    # returns the hcard of the user
+    #
+    # GET /hcard/users/:guid
+    def hcard
+      person_hcard = DiasporaFederation.callbacks.trigger(:person_hcard_fetch, params[:guid])
+
+      return render nothing: true, status: 404 if person_hcard.nil?
+
+      logger.info "hcard profile request for: #{person_hcard.nickname}:#{person_hcard.guid}"
+      render html: person_hcard.to_html.html_safe
+    end
+  end
+end

data/app/controllers/diaspora_federation/receive_controller.rb

@@ -0,0 +1,32 @@
+require_dependency "diaspora_federation/application_controller"
+
+module DiasporaFederation
+  # this controller processes receiving messages
+  class ReceiveController < ApplicationController
+    before_action :check_for_xml
+
+    # receives public messages
+    #
+    # POST /receive/public
+    def public
+      logger.info "received a public message"
+      logger.debug CGI.unescape(params[:xml])
+      render nothing: true, status: :ok
+    end
+
+    # receives private messages for a user
+    #
+    # POST /receive/users/:guid
+    def private
+      logger.info "received a private message for #{params[:guid]}"
+      logger.debug CGI.unescape(params[:xml])
+      render nothing: true, status: :ok
+    end
+
+    private
+
+    def check_for_xml
+      render nothing: true, status: 422 if params[:xml].nil?
+    end
+  end
+end

data/app/controllers/diaspora_federation/webfinger_controller.rb

@@ -0,0 +1,58 @@
+require_dependency "diaspora_federation/application_controller"
+
+module DiasporaFederation
+  # this controller handles all webfinger-specific requests
+  class WebfingerController < ApplicationController
+    # returns the host-meta xml
+    #
+    # example:
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+    #        <Link rel="lrdd" type="application/xrd+xml" template="https://server.example/webfinger?q={uri}"/>
+    #   </XRD>
+    #
+    # GET /.well-known/host-meta
+    def host_meta
+      render body: WebfingerController.host_meta_xml, content_type: "application/xrd+xml"
+    end
+
+    # @deprecated this is the pre RFC 7033 webfinger
+    #
+    # example:
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+    #     <Subject>acct:alice@localhost:3000</Subject>
+    #     <Alias>http://localhost:3000/people/c8e87290f6a20132963908fbffceb188</Alias>
+    #     <Link rel="http://microformats.org/profile/hcard" type="text/html"
+    #           href="http://localhost:3000/hcard/users/c8e87290f6a20132963908fbffceb188"/>
+    #     <Link rel="http://joindiaspora.com/seed_location" type="text/html" href="http://localhost:3000/"/>
+    #     <Link rel="http://joindiaspora.com/guid" type="text/html" href="c8e87290f6a20132963908fbffceb188"/>
+    #     <Link rel="http://webfinger.net/rel/profile-page" type="text/html" href="http://localhost:3000/u/alice"/>
+    #     <Link rel="http://schemas.google.com/g/2010#updates-from" type="application/atom+xml"
+    #           href="http://localhost:3000/public/alice.atom"/>
+    #     <Link rel="salmon" href="http://localhost:3000/receive/users/c8e87290f6a20132963908fbffceb188"/>
+    #     <Link rel="diaspora-public-key" type="RSA" href="LS0tLS1CRU......"/>
+    #   </XRD>
+    # GET /webfinger?q=<uri>
+    def legacy_webfinger
+      person_wf = find_person_webfinger(params[:q]) if params[:q]
+
+      return render nothing: true, status: 404 if person_wf.nil?
+
+      logger.info "webfinger profile request for: #{person_wf.acct_uri}"
+      render body: person_wf.to_xml, content_type: "application/xrd+xml"
+    end
+
+    private
+
+    # creates the host-meta xml with the configured server_uri and caches it
+    # @return [String] XML string
+    def self.host_meta_xml
+      @host_meta_xml ||= WebFinger::HostMeta.from_base_url(DiasporaFederation.server_uri.to_s).to_xml
+    end
+
+    def find_person_webfinger(query)
+      DiasporaFederation.callbacks.trigger(:person_webfinger_fetch, query.strip.downcase.gsub("acct:", ""))
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,15 @@
+DiasporaFederation::Engine.routes.draw do
+  controller :receive do
+    post "receive-new/public"      => :public,  :as => "receive_public"
+    post "receive-new/users/:guid" => :private, :as => "receive_private"
+  end
+
+  controller :webfinger do
+    get ".well-known/host-meta" => :host_meta,        :as => "host_meta"
+    get "webfinger"             => :legacy_webfinger, :as => "legacy_webfinger"
+  end
+
+  controller :h_card do
+    get "hcard/users/:guid" => :hcard, :as => "hcard"
+  end
+end

data/lib/diaspora_federation/engine.rb

@@ -0,0 +1,14 @@
+module DiasporaFederation
+  # diaspora* federation rails engine
+  class Engine < ::Rails::Engine
+    isolate_namespace DiasporaFederation
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.after_initialize do
+      DiasporaFederation.validate_config
+    end
+  end
+end

data/lib/diaspora_federation/rails.rb

@@ -0,0 +1,9 @@
+require "diaspora_federation/engine"
+
+require "diaspora_federation"
+
+module DiasporaFederation
+  # diaspora* federation rails engine
+  module Rails
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: diaspora_federation-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Benjamin Neff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: diaspora_federation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: A rails engine that adds the diaspora* federation protocol to a rails
+  app
+email:
+- benjamin@coding4.coffee
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/controllers/diaspora_federation/application_controller.rb
+- app/controllers/diaspora_federation/h_card_controller.rb
+- app/controllers/diaspora_federation/receive_controller.rb
+- app/controllers/diaspora_federation/webfinger_controller.rb
+- config/routes.rb
+- lib/diaspora_federation/engine.rb
+- lib/diaspora_federation/rails.rb
+homepage: https://github.com/SuperTux88/diaspora_federation
+licenses:
+- AGPL 3.0 - http://www.gnu.org/licenses/agpl-3.0.html
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: diaspora* federation rails engine
+test_files: []
+has_rdoc: