proclaim 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c804948c26e92b6c025b23e0b436ff0f2ce3063
-  data.tar.gz: 4a38e087429d2f5a122b5d16a7d21145b0912b26
+  metadata.gz: 1a4fb217ab74d5f76f8c5b04aafe1bb4d328e41e
+  data.tar.gz: 164386ed38ec2c67e27e1b0565cf4bef4353b04b
 SHA512:
-  metadata.gz: 1cd62bc9af70f115ba3765d5370b426d7030d36fba5fd78800ac23ca2b0f769f2d41d07078c5b2542d64c77b0b59149c9a0a54b39f9ce6879c2c48e028f13129
-  data.tar.gz: 3021330ed8024b80122d5080b3dd01f9681794d44890eac4c310f3409114ea9dced85e2d308efff6294c02a91884eb9a40bce5d43af1720ab65407707871457c
+  metadata.gz: 13f1c62fa387363bca3c295c5f28f15360f98ab553bb3cad58a535334098082635adce8d72f5767226e469dff2454129d627e0e754e4e06c92698a3398b72682
+  data.tar.gz: e1235a462a4f29c74a9ac912480513d04f06858ebea23a1a0b92438d7cf7f34c404d1237887590eefaae55fb9e6679ec95b46f9f5bd73cdf2c6beab76b64b12f

data/CHANGELOG

@@ -1,3 +1,12 @@
+0.4.0
+  - Added media query to emails for better display on mobile devices
+  - Added callbacks as a way for main app to be notified of new posts,
+    comments, or subscriptions. Configured in initializer
+  - Fixed bug where email field didn't hide after successful comment
+  - Added ability to administer subscriptions
+  - Added page titles for each Proclaim page
+  - Removed the use of calc from mailer layout
+
 v 0.3.1
   - Fixed bug causing floated images to display improperly in emails
   - Added link to emails to view post online

data/README.md

@@ -14,7 +14,7 @@ Linkesch's [Image Insert plugin][2] tied to CarrierWave for image uploads.
 Proclaim doesn't include any users or authentication. It was made to be able to
 work with whatever setup you're using. All that it requires is that your
 application _has_ users and authentication ([Devise][3] is recommended). In
-Proclaim 0.1, authentication is also used as authorization. If a user is logged
+Proclaim 0.4, authentication is also used as authorization. If a user is logged
 in, it can create/publish/edit/delete posts and edit/delete comments. If no user
 is logged in, it can only read posts and create comments.
 
@@ -25,11 +25,11 @@ scheme is given below.
 
 ### Get Proclaim
 
-Proclaim 0.2 works with Rails 4.2 and on, with Ruby 1.9.3 and on. Add it to your
+Proclaim 0.4 works with Rails 4.2 and on, with Ruby 1.9.3 and on. Add it to your
 Gemfile with:
 
 ```ruby
-gem 'proclaim', "~> 0.3.1"
+gem 'proclaim', "~> 0.4.0"
 ```
 
 Run `bundle install` to install it.
@@ -116,6 +116,7 @@ Proclaim.editor_whitelist_tags = %w(h1 h2 h3 h4 h5 h6
 Proclaim.editor_whitelist_attributes = %w(class id style href title src alt
                                           align draggable)
 Proclaim.mailer_sender = nil
+Proclaim.secret_key = nil
 ```
 
 - **Proclaim.author_class**
@@ -132,13 +133,14 @@ Proclaim.mailer_sender = nil
 
 - **Proclaim.current_author_method**
 
-  Method to obtain the currently-authenticated user. Should return nil if no
-  user is currently authenticated.
+  Method to obtain the currently-authenticated user. This should be a method on
+  the `ApplicationController`, and it should return nil if no user is currently
+  authenticated.
 
 - **Proclaim.authentication_method**
 
-  Method to verify that a user is authenticated, and if not, will redirect to
-  some sort of authentication page.
+  `ApplicationController` method to verify that a user is authenticated, and if
+  not, to redirect to some sort of authentication page.
 
 - **Proclaim.excerpt_length**
 
@@ -164,10 +166,89 @@ Proclaim.mailer_sender = nil
   not specified (the default), the mailer's default params will be used, which
   means it should be set in your environment.
 
-Astute readers may note that the defaults corresponds to defaults from Devise (on
-the User class). If that's not your setup, all of these options can be changed
-in the initializer installed by `rails generate proclaim:install`.
+- **Proclaim.secret_key**
 
+  The secret key to use for generating subscription tokens. Changing this will
+  invalidate any tokens already generated.
+
+Astute readers may note that the defaults corresponds to defaults from Devise
+(on the User class). If that's not your setup, all of these options can be
+changed in the initializer installed by `rails generate proclaim:install`.
+
+
+## Handy Things
+
+### Page Titles
+
+Each of Proclaim's included views stores its associated page title in the
+content identifier `:proclaim_title`. In order to actually get that into one's
+page title, then, one must simply throw something like this in one's layout
+header:
+
+```html
+<head>
+	...
+	<title><%= content_for :proclaim_title %></title>
+	...
+</head>
+```
+
+### Callbacks
+
+Proclaim can notify your main application when certain things happen. These are
+all configured in the initializer installed by
+`rails generate proclaim:install`.
+
+#### When Posts Are Published
+
+To register callbacks for when a post is published, use `after_post_published`
+in the initializer, for example:
+
+```ruby
+Proclaim.setup do |config|
+	# Can specify multiple callbacks. You can use a Proc:
+	config.after_post_published lambda { |p| puts "Post published: #{p.title}"}
+
+	# Or you can use a block:
+	config.after_post_published do |p|
+		puts "Post published: #{p.title}"
+	end
+end
+```
+
+#### When Comments Are Made
+
+To register callbacks for when a comment is made, use `after_new_comment`
+in the initializer, for example:
+
+```ruby
+Proclaim.setup do |config|
+	# Can specify multiple callbacks. You can use a Proc:
+	config.after_new_comment lambda { |c| puts "Comment made by #{c.author}"}
+
+	# Or you can use a block:
+	config.after_new_comment do |c|
+		puts "Comment made by #{c.author}"
+	end
+end
+```
+
+#### When Subscriptions Are Created
+
+To register callbacks for when a subscription is created, use
+`after_new_subscription` in the initializer, for example:
+
+```ruby
+Proclaim.setup do |config|
+	# Can specify multiple callbacks. You can use a Proc:
+	config.after_new_subscription lambda { |s| puts "New subsciber: #{s.name}"}
+
+	# Or you can use a block:
+	config.after_new_subscription do |s|
+		puts "New subsciber: #{s.name}"
+	end
+end
+```
 
 ## Customizations
 

data/Rakefile

@@ -40,7 +40,7 @@ namespace :test do
   end
 
   Rails::TestTask.new(:units) do |t|
-    t.pattern = 'test/{models,helpers,unit}/**/*_test.rb'
+    t.pattern = 'test/{models,helpers,unit,policies}/**/*_test.rb'
   end
 
   Rails::TestTask.new(:functionals) do |t|

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/app/assets/javascripts/proclaim/comments_handler.js.coffee

@@ -179,6 +179,9 @@ class CommentsHandler
 		form.each (index, element) =>
 			thisForm = $(element)
 
+			# Hide the email field
+			thisForm.children(@subscribeEmailClass).hide()
+
 			# Don't remove the main comment form-- just clear it
 			if thisForm.is(@mainCommentFormClass)
 				element.reset()

data/app/assets/stylesheets/proclaim/subscriptions.css.scss

@@ -1,3 +1,36 @@
 // Place all the styles related to the Subscriptions controller here.
 // They will automatically be included in application.css.
 // You can use Sass (SCSS) here: http://sass-lang.com/
+
+div.post_subscriptions
+{
+	float: right;
+	width: 40%;
+
+	h2
+	{
+		margin-top: 0;
+		padding-top: 0;
+	}
+
+	table
+	{
+		width: 100%;
+	}
+}
+
+div.blog_subscriptions
+{
+	width: 40%;
+
+	h2
+	{
+		margin-top: 0;
+		padding-top: 0;
+	}
+
+	table
+	{
+		width: 100%;
+	}
+}

data/app/controllers/proclaim/comments_controller.rb

@@ -16,7 +16,9 @@ module Proclaim
 					subscription = nil
 					params = subscription_params
 					if params and params[:subscribe]
-						subscription = Subscription.new(email: params[:email], post: @comment.post)
+						subscription = Subscription.new(name: @comment.author,
+						                                email: params[:email],
+						                                post: @comment.post)
 					end
 
 					respond_to do |format|

data/app/controllers/proclaim/posts_controller.rb

@@ -3,7 +3,7 @@ require_dependency "proclaim/application_controller"
 module Proclaim
 	class PostsController < ApplicationController
 		before_action :authenticate_author, except: [:index, :show]
-		after_action :verify_authorized, except: :index
+		after_action :verify_authorized
 		after_action :verify_policy_scoped, only: :index
 		before_action :set_post, only: [:show, :edit, :update, :destroy]
 
@@ -40,16 +40,20 @@ module Proclaim
 			@post = Post.new(post_params)
 			@post.author = current_author
 
-			if params[:publish] == "true"
-				@post.publish
-			end
-
 			authorize @post
 
-			if @post.valid?
+			# Save here before potentially publishing, so we can save images
+			if @post.save
+
+				if params[:publish] == "true"
+					@post.publish
+					authorize @post # Re-authorize now that it's to be published
+				end
+
 				# Save and rewrite each image in Carrierwave's cache
 				@post.body = saved_and_rewrite_cached_images(@post.body)
 
+				# Save again, in case the body changed or it was published
 				@post.save
 
 				redirect_to @post, notice: 'Post was successfully created.'

data/app/controllers/proclaim/subscriptions_controller.rb

@@ -2,24 +2,24 @@ require_dependency "proclaim/application_controller"
 
 module Proclaim
 	class SubscriptionsController < ApplicationController
-		after_action :verify_authorized, except: [:subscribed, :unsubscribed]
-		before_action :set_subscription, only: [:unsubscribe, :destroy]
+		after_action :verify_authorized
+		after_action :verify_policy_scoped, only: :index
+		before_action :set_subscription, only: [:show, :edit, :update, :destroy]
+
+		def index
+			@subscriptions = policy_scope(Subscription).order(:post_id, :name)
+			authorize Subscription
+		end
 
 		def new
 			@subscription = Subscription.new
 			authorize @subscription
 		end
 
-		def subscribed
-		end
-
-		def unsubscribe
+		def show
 			authorize @subscription
 		end
 
-		def unsubscribed
-		end
-
 		def create
 			@subscription = Subscription.new(subscription_params)
 
@@ -28,13 +28,19 @@ module Proclaim
 			if antispam_params[:answer] == antispam_params[:solution]
 				respond_to do |format|
 					if @subscription.save
-						format.html { redirect_to subscribed_path }
+						format.html {
+							redirect_to subscription_path(@subscription.token),
+							            notice: "Thanks for subscribing! You should "\
+							                    "receive a confirmation email soon."
+						}
 					else
 						format.html { render :new }
 					end
 				end
 			else
-				@subscription.errors.add(:base, "Antispam question wasn't answered correctly")
+				@subscription.errors.add(:base,
+				                         "Antispam question wasn't answered "\
+				                         "correctly")
 				respond_to do |format|
 					format.html { render :new }
 				end
@@ -43,9 +49,20 @@ module Proclaim
 
 		def destroy
 			authorize @subscription
-
 			@subscription.destroy
-			redirect_to unsubscribed_path, notice: "Successfully unsubscribed."
+
+			respond_to do |format|
+				format.html {
+					if current_author
+						redirect_to subscriptions_path,
+					               notice: "Subscription was successfully destroyed."
+					else
+						redirect_to posts_path,
+					               notice: "Successfully unsubscribed. Sorry to "\
+					                       "see you go!"
+					end
+				}
+			end
 		end
 
 		private
@@ -56,7 +73,7 @@ module Proclaim
 
 		# Only allow a trusted parameter "white list" through.
 		def subscription_params
-			params.require(:subscription).permit(:email)
+			params.require(:subscription).permit(:name, :email)
 		end
 
 		def antispam_params

data/app/helpers/proclaim/application_helper.rb

@@ -22,13 +22,8 @@ module Proclaim
 			end.join.html_safe
 		end
 
-#		def timeago(time, options = {})
-#			options[:class] ||= "timeago"
-#			if time
-#				content_tag(:time,
-#					         time.to_s,
-#					         options.merge(datetime: time.getutc.iso8601))
-#			end
-#		end
+		def proclaim_title(page_title)
+			content_for :proclaim_title, page_title.to_s
+		end
 	end
 end

data/app/models/proclaim/comment.rb

@@ -17,6 +17,7 @@ module Proclaim
 		belongs_to :post, inverse_of: :comments
 		after_initialize :maintainPost
 		after_create :notifyPostSubscribers
+		after_create { Proclaim.notify_new_comment(self) }
 
 		validates_presence_of :body, :author, :post
 

data/app/models/proclaim/post.rb

@@ -136,6 +136,8 @@ module Proclaim
 		def notifyBlogSubscribersIfPublished
 			# If we just published this post, notify the subscribers
 			if published? and state_changed?
+				Proclaim.notify_post_published(self)
+
 				Subscription.blog_subscriptions.each do | subscription |
 					subscription.deliver_new_post_notification_email(self)
 				end

data/app/models/proclaim/subscription.rb

@@ -15,13 +15,14 @@ module Proclaim
 		belongs_to :post, inverse_of: :subscriptions
 
 		after_create :deliver_welcome_email
-
-		validates :email, uniqueness: { scope: :post_id, case_sensitive: false }, format: { with: /@/ }
+		after_create { Proclaim.notify_new_subscription(self) }
 
 		# RFC-compliant email addresses are way nasty to match with regex, so why
 		# try? We'll be sending them an email anyway-- if they don't get it, they
 		# can re-subscribe. We'll just do an easy validation match here.
-		#validates_format_of :email, :with => /@/
+		validates :email, uniqueness: { scope: :post_id, case_sensitive: false }, format: { with: /@/ }
+
+		validates_presence_of :name
 
 		# Subscriptions aren't required to belong to a post, but if we're given
 		# one it had better be valid
@@ -44,15 +45,15 @@ module Proclaim
 		end
 
 		def self.verifier
-			ActiveSupport::MessageVerifier.new(Rails.application.secrets.secret_key_base)
+			ActiveSupport::MessageVerifier.new(Proclaim.secret_key)
 		end
 
 		def self.from_token(token)
 			begin
 				id = verifier.verify(token)
-				Subscription.find_by_id(id)
+				Subscription.find(id)
 			rescue ActiveSupport::MessageVerifier::InvalidSignature
-				nil
+				raise ActiveRecord::RecordNotFound
 			end
 		end
 

data/app/policies/proclaim/image_policy.rb

@@ -21,7 +21,7 @@ module Proclaim
 				if @user
 					scope.all # Users can access all images
 				else
-					nil
+					scope.none
 				end
 			end
 		end