rack-superfeedr 0.4.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/rack-superfeedr.rb

@@ -2,13 +2,7 @@ require 'base64'
 require 'net/http'
 require 'uri'
 
-module Rack
-
-
-  ##
-  # This is a Rack Middleware that can be used in your rack-compatible web framework (Rails, Sinatra...) to perform subscriptions over at superfeedr
-  # using the PubSubHubbub API.
-  class Superfeedr
+module SuperfeedrAPI
 
     @@superfeedr_endpoint = "https://push.superfeedr.com/"
     @@port = 80
@@ -18,135 +12,225 @@ module Rack
     @@login = nil
     @@password = nil
 
-    def self.superfeedr_endpoint= _superfeedr_endpoint
+    def superfeedr_endpoint= _superfeedr_endpoint
       @@superfeedr_endpoint = _superfeedr_endpoint
     end
 
-    def self.port= _port
+    def superfeedr_endpoint
+      @@superfeedr_endpoint
+    end
+
+    def port= _port
       @@port = _port
     end
 
-    def self.host= _host
+    def port
+      @@port
+    end
+
+    def host= _host
       @@host = _host
     end
 
-    def self.base_path= _base_path
+    def host
+      @@host
+    end
+    
+    def base_path= _base_path
       @@base_path = _base_path
     end
 
-    def self.scheme= _scheme
+    def base_path
+      @@base_path
+    end
+
+    def scheme= _scheme
       @@scheme = _scheme
     end
 
-    def self.login= _login
+    def scheme
+      @@scheme
+    end
+
+    def login= _login
       @@login = _login
     end
 
-    def self.password= _password
+    def login
+      @@login
+    end
+
+    def password= _password
       @@password = _password
     end
 
-    ##
-    # Subscribe you to a url. id is optional but strongly recommanded has a unique identifier for this url. It will be used to help you identify which feed
-    # is concerned by a notification.
-    # A 3rd options argument can be supplied with
-    # - retrieve => true if you want to retrieve the previous items in the feed
-    # - format => 'json' or 'atom' to specify the format of the notifications, defaults to atom
-    # - secret => a secret string used to compyte HMAC signatures so you can check that the data is coming from Superfeedr
-    # - sync => true (defaults to false) if you want to perfrom a verification of intent syncrhonously
-    # - async => true  (defaults to false) if you want to perfrom a verification of intent asyncrhonously
-    # - hub => if you want to use an explicit hub, defaults to Superfeedr's http://push.superfeedr.com
-    # It yields 3 arguments to a block:
-    # - body of the response (useful if you used the retrieve option)
-    # - success flag 
-    # - response (useful to debug failed requests mostly)
-    def self.subscribe(url, id = nil, opts = {}, &blk)
-      endpoint = opts[:hub] || @@superfeedr_endpoint
-      request = prep_request(url, id, endpoint, opts)
-
-      if opts[:retrieve]
-        request['retrieve'] = true
-      end
-      
-      if opts[:format] == "json"
-        request['format'] = "json"
-      end
+    def password
+      @@password
+    end
 
-      if opts[:secret]
-        request['hub.secret'] = opts[:secret]
-      else
-        request['hub.secret'] = "WHAT DO WE PICK? A UNIQUE SCRET THE CALLBACK? SO WE CAN USE THAT ON NOTIFS?" 
-      end
-      
-      request['hub.mode'] = 'subscribe'
+  ##
+  # Subscribe you to a url. id is optional but strongly recommanded has a unique identifier for this url. It will be used to help you identify which feed
+  # is concerned by a notification.
+  # A 3rd options argument can be supplied with
+  # - retrieve => true if you want to retrieve the previous items in the feed
+  # - format => 'json' or 'atom' to specify the format of the notifications, defaults to atom
+  # - secret => a secret string used to compyte HMAC signatures so you can check that the data is coming from Superfeedr
+  # - sync => true (defaults to false) if you want to perfrom a verification of intent syncrhonously
+  # - async => true  (defaults to false) if you want to perfrom a verification of intent asyncrhonously
+  # - hub => if you want to use an explicit hub, defaults to Superfeedr's http://push.superfeedr.com
+  # It yields 3 arguments to a block:
+  # - body of the response (useful if you used the retrieve option)
+  # - success flag 
+  # - response (useful to debug failed requests mostly)
+  def subscribe(url, id = nil, opts = {}, &blk)
+    endpoint = opts[:hub] || @@superfeedr_endpoint
+    request = prep_request(url, id, endpoint, opts)
+
+    if opts[:retrieve]
+      request['retrieve'] = true
+    end
+    
+    if opts[:format] == "json"
+      request['format'] = "json"
+    end
+
+    if opts[:secret]
+      request['hub.secret'] = opts[:secret]
+    else
+      request['hub.secret'] = "WHAT DO WE PICK? A UNIQUE SCRET THE CALLBACK? SO WE CAN USE THAT ON NOTIFS?" 
+    end
+    
+    request['hub.mode'] = 'subscribe'
+
+    response = http_post(endpoint, request)
 
-      response = http_post(endpoint, request)
+    blk.call(response.body, opts[:async] && Integer(response.code) == 202 || Integer(response.code) == 204 || opts[:retrieve] && Integer(response.code) == 200, response) if blk
+  end
 
-      blk.call(response.body, opts[:async] && Integer(response.code) == 202 || Integer(response.code) == 204 || opts[:retrieve] && Integer(response.code) == 200, response) if blk
+  ##
+  # Retrieve the content of a resource at Superfeedr
+  # A 2nd options argument can be supplied with
+  # - format => 'json' or 'atom' to specify the format of the notifications, defaults to atom
+  # - count => Integer (number of items to retrieve)
+  # - before => The id of an entry in the feed. The response will only include entries published before this one.
+  # - after => The id of an entry in the feed. The response will only include entries published after this one.
+  # It yields 3 arguments to a block (if block is supplied. If not, just returns the triplet)
+  # - body of the response (useful if you used the retrieve option)
+  # - success flag 
+  # - response (useful to debug failed requests mostly)
+  def retrieve_by_topic_url(url, opts = {}, &blk)
+    endpoint = opts[:hub] || @@superfeedr_endpoint
+    request = prep_request(url, '', endpoint, opts)
+
+    if opts[:format] == "json"
+      request['format'] = "json"
     end
 
-    ##
-    # Retrieve the content of a resource at Superfeedr
-    # A 2nd options argument can be supplied with
-    # - format => 'json' or 'atom' to specify the format of the notifications, defaults to atom
-    # - count => Integer (number of items to retrieve)
-    # - before => The id of an entry in the feed. The response will only include entries published before this one.
-    # - after => The id of an entry in the feed. The response will only include entries published after this one.
-    # It yields 3 arguments to a block (if block is supplied. If not, just returns the triplet)
-    # - body of the response (useful if you used the retrieve option)
-    # - success flag 
-    # - response (useful to debug failed requests mostly)
-    def self.retrieve_by_topic_url(url, opts = {}, &blk)
-      endpoint = opts[:hub] || @@superfeedr_endpoint
-      request = prep_request(url, '', endpoint, opts)
-
-      if opts[:format] == "json"
-        request['format'] = "json"
-      end
+    if opts[:count]
+      request['count'] = opts[:count]
+    else
+      request['count'] = 10
+    end
+    
+    request['hub.mode'] = 'retrieve'
 
-      if opts[:count]
-        request['count'] = opts[:count]
-      else
-        request['count'] = 10
-      end
-      
-      request['hub.mode'] = 'retrieve'
+    response = http_get(endpoint, request)
 
-      response = http_get(endpoint, request)
+    if blk
+      blk.call(response.body, Integer(response.code) == 200, response) if blk
+    else
+      [response.body, Integer(response.code) == 200, response]
+    end
+  end
 
-      if blk
-        blk.call(response.body, Integer(response.code) == 200, response) if blk
-      else
-        [response.body, Integer(response.code) == 200, response]
-      end
+  ##
+  # Unsubscribes a url. If you used an id for the susbcription, you need to use _the same_.
+  # The optional block will be called to let you confirm the subscription (or not). This is not applicable for if you use params[:async] => true
+  # It returns true if the unsubscription was successful (or will be confirmed if you used async => true in the options), false otherwise
+  # You can also pass an opts third argument that will be merged with the options used in Typhoeus's Request (https://github.com/dbalatero/typhoeus)
+  
+  ##
+  # Subscribe you to a url. id needs to match the id you used to subscribe. 
+  # A 3rd options argument can be supplied with
+  # - sync => true (defaults to false) if you want to perfrom a verification of intent syncrhonously
+  # - async => true  (defaults to false) if you want to perfrom a verification of intent asyncrhonously
+  # - hub => if you want to use an explicit hub, defaults to Superfeedr's http://push.superfeedr.com
+  # It yields 3 arguments to a block:
+  # - body of the response (useful to debug failed notifications)
+  # - success flag 
+  # - response (useful to debug failed requests mostly)
+  def unsubscribe(url, id = nil, opts = {}, &blk)
+    endpoint = opts[:hub] || @@superfeedr_endpoint
+    request = prep_request(url, id, endpoint, opts)
+
+    request['hub.mode'] = 'unsubscribe'
+
+    response = http_post(endpoint, request)
+
+    blk.call(response.body, opts[:async] && Integer(response.code) == 202 || Integer(response.code) == 204, response) if blk
+  end
+
+  protected
+
+  def prep_request(url, id, endpoint, opts)
+    feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
+
+    request = {
+      'hub.topic' => url,
+      'hub.callback' =>  generate_callback(url, feed_id)
+    }
+
+    if endpoint == @@superfeedr_endpoint && @@login && @@password
+      request['authorization'] = Base64.encode64( "#{@@login}:#{@@password}" ).chomp
     end
 
-    ##
-    # Unsubscribes a url. If you used an id for the susbcription, you need to use _the same_.
-    # The optional block will be called to let you confirm the subscription (or not). This is not applicable for if you use params[:async] => true
-    # It returns true if the unsubscription was successful (or will be confirmed if you used async => true in the options), false otherwise
-    # You can also pass an opts third argument that will be merged with the options used in Typhoeus's Request (https://github.com/dbalatero/typhoeus)
-    
-    ##
-    # Subscribe you to a url. id needs to match the id you used to subscribe. 
-    # A 3rd options argument can be supplied with
-    # - sync => true (defaults to false) if you want to perfrom a verification of intent syncrhonously
-    # - async => true  (defaults to false) if you want to perfrom a verification of intent asyncrhonously
-    # - hub => if you want to use an explicit hub, defaults to Superfeedr's http://push.superfeedr.com
-    # It yields 3 arguments to a block:
-    # - body of the response (useful to debug failed notifications)
-    # - success flag 
-    # - response (useful to debug failed requests mostly)
-    def self.unsubscribe(url, id = nil, opts = {}, &blk)
-      endpoint = opts[:hub] || @@superfeedr_endpoint
-      request = prep_request(url, id, endpoint, opts)
-
-      request['hub.mode'] = 'unsubscribe'
-
-      response = http_post(endpoint, request)
-
-      blk.call(response.body, opts[:async] && Integer(response.code) == 202 || Integer(response.code) == 204, response) if blk
+    if opts[:async]
+      request['hub.verify'] = 'async'
+    end
+
+    if opts[:sync]
+      request['hub.verify'] = 'sync'
+    end
+
+    request
+  end
+
+  def http_get(url, opts)
+    uri = URI.parse URI.encode(url)
+    uri.query = URI.encode_www_form opts || {}
+    uri.path=='/' if uri.path.empty?
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new uri.request_uri
+    http.request(request)
+  end
+
+  def http_post(url, opts)
+    uri = URI.parse URI.encode(url)
+    uri.path=='/' if uri.path.empty?
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new uri.request_uri
+    request.set_form_data (opts||{})
+    http.request(request)
+  end
+
+  def generate_callback(url, feed_id)
+    if @@scheme == "https"
+      URI::HTTPS.build({:scheme => @@scheme, :host => @@host, :path => "#{@@base_path}#{feed_id}", :port => @@port }).to_s
+    else
+      URI::HTTP.build({:scheme => @@scheme, :host => @@host, :path => "#{@@base_path}#{feed_id}", :port => @@port }).to_s
     end
+  end
+end
+
+
+module Rack
+
+  ##
+  # This is a Rack Middleware that can be used in your rack-compatible web framework (Rails, Sinatra...) to perform subscriptions over at superfeedr
+  # using the PubSubHubbub API.
+  class Superfeedr
 
     ##
     # This allows you to define what happens with the notifications. The block passed in argument is called for each notification, with 4 arguments
@@ -203,13 +287,13 @@ module Rack
     # Called by Rack!
     def call(env)
       req = Rack::Request.new(env)
-      if env['REQUEST_METHOD'] == 'GET' && feed_id = env['PATH_INFO'].match(/#{@@base_path}(.*)/)
+      if env['REQUEST_METHOD'] == 'GET' && feed_id = env['PATH_INFO'].match(/#{Rack::Superfeedr.base_path}(.*)/)
         if @verification.call(req.params['hub.mode'], feed_id[1], req.params['hub.topic'], req)
           Rack::Response.new(req.params['hub.challenge'], 200).finish
         else
           Rack::Response.new("not valid", 404).finish
         end
-      elsif env['REQUEST_METHOD'] == 'POST' && feed_id = env['PATH_INFO'].match(/#{@@base_path}(.*)/)
+      elsif env['REQUEST_METHOD'] == 'POST' && feed_id = env['PATH_INFO'].match(/#{Rack::Superfeedr.base_path}(.*)/)
         @callback.call(feed_id[1], req.body.read, req.env['HTTP_X_PUBSUBHUBBUB_TOPIC'], req)
         Rack::Response.new("Thanks!", 200).finish
       else
@@ -217,57 +301,8 @@ module Rack
       end
     end
 
-    protected
-
-    def self.prep_request(url, id, endpoint, opts)
-      feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
-
-      request = {
-        'hub.topic' => url,
-        'hub.callback' =>  generate_callback(url, feed_id)
-      }
-
-      if endpoint == @@superfeedr_endpoint && @@login && @@password
-        request['authorization'] = Base64.encode64( "#{@@login}:#{@@password}" ).chomp
-      end
+    extend SuperfeedrAPI
 
-      if opts[:async]
-        request['hub.verify'] = 'async'
-      end
-
-      if opts[:sync]
-        request['hub.verify'] = 'sync'
-      end
-
-      request
-    end
-
-    def self.http_get(url, opts)
-      uri = URI.parse URI.encode(url)
-      uri.query = URI.encode_www_form opts || {}
-      uri.path=='/' if uri.path.empty?
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      request = Net::HTTP::Get.new uri.request_uri
-      http.request(request)
-    end
-
-    def self.http_post(url, opts)
-      uri = URI.parse URI.encode(url)
-      uri.path=='/' if uri.path.empty?
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      request = Net::HTTP::Post.new uri.request_uri
-      request.set_form_data (opts||{})
-      http.request(request)
-    end
-
-    def self.generate_callback(url, feed_id)
-      if @@scheme == "https"
-        URI::HTTPS.build({:scheme => @@scheme, :host => @@host, :path => "#{@@base_path}#{feed_id}", :port => @@port }).to_s
-      else
-        URI::HTTP.build({:scheme => @@scheme, :host => @@host, :path => "#{@@base_path}#{feed_id}", :port => @@port }).to_s
-      end
-    end
   end
 end
+

data/rack-superfeedr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-superfeedr"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["julien51"]
-  s.date = "2015-04-15"
+  s.date = "2015-04-16"
   s.description = "A gem that provides a rack middleware to interract with Superfeedr's API. "
   s.email = "julien@superfeedr.com"
   s.extra_rdoc_files = [

data/test/test_rack-superfeedr.rb

@@ -3,7 +3,7 @@ require 'rack'
 require_relative 'helper.rb'
 
 # To run tests locally, we're using runscope's passageway which proxies requests inside the firewall. (make sure you bind to port 4567)
-HOST = '5f83728c358.b.passageway.io'
+HOST = '39fbb9eba21.b.passageway.io'
 PORT = 80
 # Also, we need superfeedr credentials.
 LOGIN = 'demo'
@@ -22,6 +22,11 @@ end
 
 # Run an app in a thread
 Thread.new do
+	opts = {
+		:Port => 4567, 
+		# Logger: WEBrick::Log.new("/dev/null"), 
+		AccessLog: []
+	}
 	Rack::Handler::WEBrick.run(Rack::Superfeedr.new(MyRackApp.new) do |superfeedr|
 	
 	superfeedr.on_verification do |mode, feed_id, url, request|
@@ -39,7 +44,7 @@ Thread.new do
 	end	
 
 
-	end, :Port => 4567, Logger: WEBrick::Log.new("/dev/null"), AccessLog: [],) 
+	end, opts) 
 end
 sleep 3
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-superfeedr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -159,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3582772756696706427
+      hash: 1123161724621889271
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: