diaspora_federation-rails-0.1.4/ 0000755 0000041 0000041 00000000000 12757133674 016675 5 ustar www-data www-data diaspora_federation-rails-0.1.4/Changelog.md 0000644 0000041 0000041 00000004721 12757133674 021112 0 ustar www-data www-data # 0.1.4
## Refactor
* Improve magic envelope validation [90d12e7](https://github.com/diaspora/diaspora_federation/commit/90d12e71d00bd4874c09f81cde968360111933f9)
* Raise ValidationError if properties are missing [4295237](https://github.com/diaspora/diaspora_federation/commit/4295237e9e6e8e0ff23a5d8d732654b865f44944)
# 0.1.3
## Refactor
* Improve handling of `xml_order` in relayables [36a787d](https://github.com/diaspora/diaspora_federation/commit/36a787dd87f9770e16fbc1bbc0a6c0d6f059e727) [ba129aa](https://github.com/diaspora/diaspora_federation/commit/ba129aafa38f978f69565d39b7a881a245b03bab) [41de99b](https://github.com/diaspora/diaspora_federation/commit/41de99bd5e4ed2779d574183a58f9ac9550c658a)
# 0.1.2
## Refactor
* Improve code documentation [#38](https://github.com/diaspora/diaspora_federation/pull/38)
* Improve validation [9b32315](https://github.com/diaspora/diaspora_federation/commit/9b3231583d85e6007bf43cedc4480f043c8bde15) [eb8cdef](https://github.com/diaspora/diaspora_federation/commit/eb8cdef604cc8fe71e8455f36a317d80657f1582) [0980294](https://github.com/diaspora/diaspora_federation/commit/0980294a0d259cba1fa2a2a655163b3fa844d239)
* Photo: `status_message_guid` is optional [4136fb9](https://github.com/diaspora/diaspora_federation/commit/4136fb973e7ad27158ef605df12727f4e959c3a3)
* A GUID is at most 255 chars long [f7d269c](https://github.com/diaspora/diaspora_federation/commit/f7d269cd6a4c1b48a7b34083f5fea04ac0835a48)
* hCard: `nickname` is optional [4b94949](https://github.com/diaspora/diaspora_federation/commit/4b949491df3a16b30f6e27113d6fa95c165c1edc)
* StatusMessage: Rename `raw_message` to `text` [2aaff56](https://github.com/diaspora/diaspora_federation/commit/2aaff56e147b505626a615d60564fbbf22c2f452) [#29](https://github.com/diaspora/diaspora_federation/issues/29)
## Bug fixes
* Do not reuse cURL sockets to avoid issues caused by too many simultaneous connections [#37](https://github.com/diaspora/diaspora_federation/pull/37)
* Handle empty xml-elements for nested entities [26b7991](https://github.com/diaspora/diaspora_federation/commit/26b7991defe1d84d10c1186a151676076946b26f)
* Gracefully handle missing xml elements of relayables [9097097](https://github.com/diaspora/diaspora_federation/commit/90970973a58cbc3d897d21a43c0a6c93a30605be)
# 0.1.1
## Features
* Fetch root posts for reshares [9b090a3](https://github.com/diaspora/diaspora_federation/commit/9b090a39501705f00403f124e215e78866039f1e)
# 0.1.0
## Features
* Added Salmon support
diaspora_federation-rails-0.1.4/lib/ 0000755 0000041 0000041 00000000000 12757133674 017443 5 ustar www-data www-data diaspora_federation-rails-0.1.4/lib/diaspora_federation/ 0000755 0000041 0000041 00000000000 12757133674 023445 5 ustar www-data www-data diaspora_federation-rails-0.1.4/lib/diaspora_federation/engine.rb 0000644 0000041 0000041 00000000451 12757133674 025237 0 ustar www-data www-data 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
diaspora_federation-rails-0.1.4/lib/diaspora_federation/rails.rb 0000644 0000041 0000041 00000000236 12757133674 025105 0 ustar www-data www-data require "diaspora_federation/engine"
require "diaspora_federation"
module DiasporaFederation
# diaspora* federation rails engine
module Rails
end
end
diaspora_federation-rails-0.1.4/config/ 0000755 0000041 0000041 00000000000 12757133674 020142 5 ustar www-data www-data diaspora_federation-rails-0.1.4/config/initializers/ 0000755 0000041 0000041 00000000000 12757133674 022650 5 ustar www-data www-data diaspora_federation-rails-0.1.4/config/initializers/filter_parameter_logging.rb 0000644 0000041 0000041 00000000124 12757133674 030225 0 ustar www-data www-data # Don't log received xml data.
Rails.application.config.filter_parameters += [:xml]
diaspora_federation-rails-0.1.4/config/routes.rb 0000644 0000041 0000041 00000001072 12757133674 022010 0 ustar www-data www-data DiasporaFederation::Engine.routes.draw do
controller :receive do
post "receive/public" => :public, :as => "receive_public"
post "receive/users/:guid" => :private, :as => "receive_private"
end
controller :fetch do
get "fetch/:type/:guid" => :fetch, :as => "fetch"
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
diaspora_federation-rails-0.1.4/LICENSE 0000644 0000041 0000041 00000001466 12757133674 017711 0 ustar www-data www-data 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 .
Some parts are based on an older federation gem from Florian Staudacher:
https://github.com/Raven24/diaspora-federation
diaspora_federation-rails-0.1.4/diaspora_federation-rails.gemspec 0000644 0000041 0000041 00000003524 12757133674 025360 0 ustar www-data www-data #########################################################
# This file has been automatically generated by gem2tgz #
#########################################################
# -*- encoding: utf-8 -*-
Gem::Specification.new do |s|
s.name = "diaspora_federation-rails"
s.version = "0.1.4"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Benjamin Neff"]
s.date = "2016-08-21"
s.description = "A rails engine that adds the diaspora* federation protocol to a rails app"
s.email = ["benjamin@coding4.coffee"]
s.files = ["Changelog.md", "LICENSE", "README.md", "app/controllers/diaspora_federation/application_controller.rb", "app/controllers/diaspora_federation/fetch_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/initializers/filter_parameter_logging.rb", "config/routes.rb", "lib/diaspora_federation/engine.rb", "lib/diaspora_federation/rails.rb"]
s.homepage = "https://github.com/diaspora/diaspora_federation"
s.licenses = ["AGPL-3.0"]
s.require_paths = ["lib"]
s.required_ruby_version = Gem::Requirement.new("~> 2.1")
s.rubygems_version = "1.8.23"
s.summary = "diaspora* federation rails engine"
if s.respond_to? :specification_version then
s.specification_version = 4
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
s.add_runtime_dependency(%q, ["= 0.1.4"])
s.add_runtime_dependency(%q, ["~> 4.2"])
else
s.add_dependency(%q, ["= 0.1.4"])
s.add_dependency(%q, ["~> 4.2"])
end
else
s.add_dependency(%q, ["= 0.1.4"])
s.add_dependency(%q, ["~> 4.2"])
end
end
diaspora_federation-rails-0.1.4/app/ 0000755 0000041 0000041 00000000000 12757133674 017455 5 ustar www-data www-data diaspora_federation-rails-0.1.4/app/controllers/ 0000755 0000041 0000041 00000000000 12757133674 022023 5 ustar www-data www-data diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/ 0000755 0000041 0000041 00000000000 12757133674 026025 5 ustar www-data www-data diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/fetch_controller.rb 0000644 0000041 0000041 00000002325 12757133674 031710 0 ustar www-data www-data require_dependency "diaspora_federation/application_controller"
module DiasporaFederation
# This controller processes fetch requests.
class FetchController < ApplicationController
# Returns the fetched entity or a redirect
#
# GET /fetch/:type/:guid
def fetch
entity = fetch_public_entity
if entity
magic_env = create_magic_envelope(entity)
if magic_env
render xml: magic_env, content_type: "application/magic-envelope+xml"
else
redirect_to DiasporaFederation.callbacks.trigger(:fetch_person_url_to,
entity.author, "/fetch/#{params[:type]}/#{params[:guid]}")
end
else
render nothing: true, status: 404
end
end
private
def fetch_public_entity
type = DiasporaFederation::Entity.entity_class(params[:type]).to_s.rpartition("::").last
DiasporaFederation.callbacks.trigger(:fetch_public_entity, type, params[:guid])
end
def create_magic_envelope(entity)
privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key, entity.author)
Salmon::MagicEnvelope.new(entity, entity.author).envelop(privkey) if privkey
end
end
end
diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/receive_controller.rb 0000644 0000041 0000041 00000003500 12757133674 032235 0 ustar www-data www-data 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
legacy = request.content_type != "application/magic-envelope+xml"
data = data_for_public_message(legacy)
logger.debug data
DiasporaFederation.callbacks.trigger(:queue_public_receive, data, legacy)
render nothing: true, status: 202
end
# Receives private messages for a user
#
# POST /receive/users/:guid
def private
legacy = request.content_type != "application/json"
data = data_for_private_message(legacy)
logger.debug data
success = DiasporaFederation.callbacks.trigger(:queue_private_receive, params[:guid], data, legacy)
render nothing: true, status: success ? 202 : 404
end
private
# Checks the xml parameter for legacy salmon slaps
# @deprecated
def check_for_xml
legacy_request = request.content_type.nil? || request.content_type == "application/x-www-form-urlencoded"
render nothing: true, status: 422 if params[:xml].nil? && legacy_request
end
def data_for_public_message(legacy)
if legacy
logger.info "received a public salmon slap"
CGI.unescape(params[:xml])
else
logger.info "received a public magic envelope"
request.body.read
end
end
def data_for_private_message(legacy)
if legacy
logger.info "received a private salmon slap for #{params[:guid]}"
CGI.unescape(params[:xml])
else
logger.info "received a private encrypted magic envelope for #{params[:guid]}"
request.body.read
end
end
end
end
diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/application_controller.rb 0000644 0000041 0000041 00000000515 12757133674 033121 0 ustar www-data www-data module DiasporaFederation
# Base controller for all DiasporaFederation controllers
class ApplicationController < ActionController::Base
before_action :set_locale
# Fix locale leakage from other requests.
# Set "en" as locale for every federation request.
def set_locale
I18n.locale = :en
end
end
end
diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/webfinger_controller.rb 0000644 0000041 0000041 00000005115 12757133674 032567 0 ustar www-data www-data require_dependency "diaspora_federation/application_controller"
module DiasporaFederation
# This controller handles all webfinger-specific requests.
class WebfingerController < ApplicationController
# Returns the host-meta xml
#
# example:
#
#
#
#
#
# GET /.well-known/host-meta
def host_meta
render xml: WebfingerController.host_meta_xml, content_type: "application/xrd+xml"
end
# @deprecated This is the pre RFC 7033 webfinger.
#
# example:
#
#
# acct:alice@localhost:3000
# http://localhost:3000/people/c8e87290f6a20132963908fbffceb188
#
#
#
#
#
#
#
#
# GET /webfinger?q=
def legacy_webfinger
person_wf = find_person_webfinger(params[:q]) if params[:q]
if person_wf.nil?
render nothing: true, status: 404
else
logger.info "webfinger profile request for: #{person_wf.acct_uri}"
render xml: person_wf.to_xml, content_type: "application/xrd+xml"
end
end
# 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 ||= Discovery::HostMeta.from_base_url(DiasporaFederation.server_uri.to_s).to_xml
end
private
def find_person_webfinger(query)
DiasporaFederation.callbacks.trigger(:fetch_person_for_webfinger, query.strip.downcase.sub("acct:", ""))
end
end
end
diaspora_federation-rails-0.1.4/app/controllers/diaspora_federation/h_card_controller.rb 0000644 0000041 0000041 00000001304 12757133674 032033 0 ustar www-data www-data 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(:fetch_person_for_hcard, params[:guid])
if person_hcard.nil?
render nothing: true, status: 404
else
logger.info "hcard profile request for: #{person_hcard.nickname}:#{person_hcard.guid}"
# rubocop:disable Rails/OutputSafety
render html: person_hcard.to_html.html_safe
# rubocop:enable Rails/OutputSafety
end
end
end
end
diaspora_federation-rails-0.1.4/README.md 0000644 0000041 0000041 00000005110 12757133674 020151 0 ustar www-data www-data # diaspora* federation library
### A library that provides functionalities needed for the diaspora\* federation protocol
**master:** [](https://travis-ci.org/diaspora/diaspora_federation) |
**develop:** [](https://travis-ci.org/diaspora/diaspora_federation)
[](https://codeclimate.com/github/diaspora/diaspora_federation)
[](https://codeclimate.com/github/diaspora/diaspora_federation/coverage)
[](https://gemnasium.com/diaspora/diaspora_federation)
[](https://inch-ci.org/github/diaspora/diaspora_federation)
[](https://badge.fury.io/rb/diaspora_federation)
[Gem Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
[Protocol Documentation](http://diaspora.github.io/diaspora_federation/) |
[Bugtracker](https://github.com/diaspora/diaspora_federation/issues)
This repository contains two gems:
* `diaspora_federation` provides the functionality for de-/serialization and de-/encryption of Entities in the protocols used for communication among the various installations of diaspora\*.
* `diaspora_federation-rails` 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
config.define_callbacks do
on :fetch_person_for_webfinger do |diaspora_id|
person = Person.find_local_by_diaspora_id(diaspora_id)
if person
DiasporaFederation::Discovery::WebFinger.new(
# ...
)
end
end
on :fetch_person_for_hcard do |guid|
# ...
end
end
end
```
## Contributing
See [our contribution guide](/CONTRIBUTING.md) for more information on how to contribute to the diaspora\* federation library.
## License
[GNU Affero General Public License](/LICENSE).