ostatus2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73f059441105cb19ff006d6e1e73b3e4a6f1e480
+  data.tar.gz: 578ef3a4bedebe13ea5eb673082c24ff6ea1a8f0
+SHA512:
+  metadata.gz: eb93203d24dab71975713420ed7fd17b5c03efa10aa296193800612c0f7d657d14df20bfac8d7e24c04ac5f98ceb0fc863f8058e1fbe3160e392df3693164212
+  data.tar.gz: 72c752cd43c93434b650b14f46148892d69e17c81fd247ca1bea6dca86e995154c26001aba025fe38bb65b4724eed6ec538ec000d26b18fa2d503cb23f6bf1c2

data/README.md

@@ -0,0 +1,74 @@
+OStatus2
+========
+
+[![Gem Version](http://img.shields.io/gem/v/ostatus2.svg)][gem]
+[![Build Status](http://img.shields.io/travis/Gargron/ostatus2.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/Gargron/ostatus2.svg)][gemnasium]
+
+[gem]: https://rubygems.org/gems/ostatus2
+[travis]: https://travis-ci.org/Gargron/ostatus2
+[gemnasium]: https://gemnasium.com/Gargron/ostatus2
+
+A Ruby toolset for interacting with the OStatus suite of protocols:
+
+* Subscribing to and publishing feeds via PubSubHubbub
+* Interacting with feeds via Salmon
+
+The 2 in the name is not a reference to any protocol version. There used to be a different Ruby gem called "ostatus" which this one seeks to replace.
+
+## Installation
+
+    gem install ostatus2
+
+## Usage
+
+When your feed updates and you need to notify subscribers:
+
+    p = OStatus2::Publication.new('http://url.to/feed', ['http://some.hub'])
+    p.publish
+
+When you want to subscribe to a feed:
+
+    token  = 'abc123'
+    secret = 'def456'
+
+    s = OStatus2::Subscription.new('http://url.to/feed', token: token, secret: secret, webhook: 'http://url.to/webhook', hub: 'http://some.hub')
+    s.subscribe
+
+Your webhook URL will receive a HTTP **GET** request that you will need to handle:
+
+    if s.valid?(params['hub.topic'], params['hub.verify_token'])
+      # echo back params['hub.challenge']
+    else
+      # return 404
+    end
+
+Once the subscription is established, your webhook URL will be receiving HTTP **POST** requests. Among the headers of such a request will be the hub's signature on the content: `X-Hub-Signature`. You can verify the integrity of the request:
+
+    body      = request.body.read
+    signature = request.env['HTTP_X_HUB_SIGNATURE']
+
+    if s.verify(body, signature)
+      # Do something with the data!
+    end
+
+When you want to notify a remote resource about an interaction (like a comment):
+
+    your_rsa_keypair = OpenSSL::PKey::RSA.new 2048
+
+    salmon   = OStatus2::Salmon.new
+    envelope = salmon.pack(comment, your_rsa_keypair)
+
+    salmon.post('http://remote.salmon/endpoint', envelope)
+
+When you receive a Salmon notification about a remote interaction:
+
+    salmon  = OStatus2::Salmon.new
+    comment = salmon.unpack(envelope)
+
+    # Parse comment and determine who the remote author is pretending to be,
+    # fetch their public key via Webfinger or something like that, and finally
+
+    if salmon.verify(envelope, remote_public_key)
+      # You can be sure the salmon is genuine
+    end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ostatus2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugen Rochko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Toolset for interacting with the OStatus suite of protocols
+email:
+- eugen@zeonfederated.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+homepage: https://github.com/Gargron/ostatus2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Toolset for interacting with the OStatus suite of protocols
+test_files: []
+has_rdoc: