kublog 0.0.1.1 → 0.9.0

data/kublog.gemspec

@@ -19,18 +19,18 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Runtime dependencies
-  s.add_runtime_dependency "rails", '~>3.1.0.rc5'
-  s.add_runtime_dependency "jquery-rails", '~>1.0.13'
-  s.add_runtime_dependency 'coffee-script', '~>2.2.0'
-  s.add_runtime_dependency "friendly_id", "~> 4.0.0.beta8"
-  s.add_runtime_dependency "sanitize", '~>2.0.3'
+  s.add_runtime_dependency "rails", '>=3.1.0'
+  s.add_runtime_dependency "jquery-rails", '>=1.0.13'
+  s.add_runtime_dependency 'coffee-script', '>=2.2.0'
+  s.add_runtime_dependency "friendly_id", ">= 4.0.0.beta14"
+  s.add_runtime_dependency "sanitize"
   
   # This gems should stop being dependencies but optional with certain features
-  s.add_runtime_dependency "rmagick", '~>2.13.1'
-  s.add_runtime_dependency "carrierwave", '~>0.5.7'
-  s.add_runtime_dependency 'liquid', '~>2.2.2'
-  s.add_runtime_dependency 'twitter', '~>1.6.2'
-  s.add_runtime_dependency 'fb_graph', '~>1.9.5'
+  s.add_runtime_dependency "rmagick"
+  s.add_runtime_dependency "carrierwave"
+  s.add_runtime_dependency 'liquid'
+  s.add_runtime_dependency 'twitter'
+  s.add_runtime_dependency 'fb_graph'
   
   # Development dependencies
   s.add_development_dependency "factory_girl_rails"

data/lib/generators/kublog/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create all the necessary files to use and customize Kublog.
+
+Example:
+    rails generate install kublog
+
+    This will create:
+        what/will/it/create

data/lib/generators/kublog/install/install_generator.rb

@@ -0,0 +1,78 @@
+module Kublog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path(Engine.root, __FILE__)
+      
+      class_option :coffee, :type => :boolean, :default => false, :desc => 'Generates Kublogs coffeescripts'
+      
+      ## Generates migrations to make all installation in one step
+      def generate_migrations
+        Dir[File.join(source_paths, 'db', 'migrate', '*.rb')].each do |file|
+          migration_filepath = file.match(/\A.+\/(db\/migrate\/.+)\Z/i)[1]
+          raw_migration_filename = file.match(/\d+\_(.+)\Z/i)[1]   
+          migration_template migration_filepath, "db/migrate/#{raw_migration_filename}" 
+        end
+      end
+      
+      ## Generates the controller needed for user integration
+      def generate_kublog_controller
+        copy_file "app/controllers/kublog/application_controller.rb"
+      end
+  
+      ## Generates all html views to the users app. Does not copy RSS 
+      def generate_html_views
+        selective_copy 'app/views/kublog/posts/*.html.erb'
+      end
+      
+      ## Generates all email views to the users app
+      def generate_email_views
+        directory "app/views/kublog/post_mailer"
+      end
+      
+      def generate_layout
+        directory 'app/views/layouts/kublog'
+      end
+      
+      def generate_css
+        directory 'app/assets/stylesheets/kublog'
+      end
+      
+      def generate_configuration
+        copy_file template_path('configuration.rb.tt'), 'config/initializers/kublog.rb'
+      end
+        
+      def generate_localization
+        copy_file "config/locales/kublog/en.yml"
+      end
+      
+      ## Optionally copies javascript files
+      def generate_coffee
+        if options.coffee?
+          directory "app/assets/javascripts/kublog"
+        end
+      end
+        
+      private
+      
+      def self.next_migration_number(path)
+        @seconds = @seconds.nil? ? Time.now.sec : (@seconds.to_i + 1)
+        @seconds = "0#{@seconds.to_s}" if @seconds < 10
+        Time.now.utc.strftime("%Y%m%d%H%M") + @seconds.to_s
+      end
+      
+      ## Copies files in a directory filtering them with a given extension
+      def selective_copy(directory, &block)
+        Dir[File.join(source_paths, directory)].each do |filename|
+          file = filename.to_s.gsub("#{Engine.root.to_s}/", '')
+          copy_file file
+        end
+      end
+      
+      def template_path(file)
+        File.join(File.expand_path(__FILE__), '..', 'templates', file)
+      end
+        
+    end
+  end
+end

data/lib/generators/kublog/install/templates/configuration.rb.tt

@@ -0,0 +1,45 @@
+Kublog.setup do |config|
+  
+  ## General Configuration
+  ##
+  config.blog_name = 'Your Blog Name Here'
+  config.blog_description = 'Description of your blog here'
+  config.default_url_options = {:host => 'www.example.com'}
+                             
+  ## Segment E-mail notifications
+  ##
+  ## Uncomment to segment users notified
+  ## config.user_kinds = %w(paying_customers free_loaders)
+  
+  config.author_email 'kublog@kublog.com'
+  
+  ## Twitter Sharing Settings
+  ##
+  ## config.twitter do |twitter|
+  ##   twitter.consumer_key = 'your-consumer-key'
+  ##   twitter.consumer_secret = 'your-consumer-secret'
+  ##   twitter.oauth_token = 'your-oauth-token'
+  ##   twitter.oauth_token_secret = 'your-consumer-secret'
+  ## end
+  
+  ## Facebook Sharing Setting
+  ## It's sort of trick to find this, check docs at github.com/innku/kublog
+  ##
+  ## config.facebook_page_token = 'your-page-token'
+  
+  
+  ## Notification processing
+  ##
+  ## config.notification_processing = {:development => :delayed_job,
+  ##                                   :test => :immediate,
+  ##                                   :staging => :delayed_job,
+  ##                                   :production => :delayed_job }[Rails.env.to_sym]
+  
+  ## Image Storage Configuration
+  ##
+  ## config.image_storage = {:development => :file, 
+  ##                         :test => :file, 
+  ##                         :staging => :s3, 
+  ##                         :production => :s3}[Rails.env.to_sym]\
+  
+end

data/lib/kublog.rb

@@ -5,9 +5,9 @@ require "twitter"
 require "fb_graph"
 require "friendly_id"
 require "carrierwave"
-require "rmagick"
-require "sanitize"
+require "RMagick"
 require "liquid"
+require "sanitize"
 
 require "kublog/engine"
 require "kublog/version"
@@ -16,14 +16,12 @@ module Kublog
   
   autoload   :Notifiable, 'kublog/notifiable'
   autoload   :Author,     'kublog/author'
+  autoload   :Processor,  'kublog/processor'
   
-  module Notification
-    autoload :Email,      'kublog/notification/email'
-    autoload :EmailJob,   'kublog/notification/email_job'
-    autoload :Tweet,      'kublog/notification/tweet'
-    autoload :TweetJob,   'kublog/notification/tweet_job'
-    autoload :FbPost,     'kublog/notification/fb_post'
-    autoload :FbPostJob,  'kublog/notification/fb_post_job'
+  module Network
+    autoload :Email,      'kublog/network/email'
+    autoload :Facebook,   'kublog/network/facebook'
+    autoload :Twitter,    'kublog/network/twitter'
   end
   
   module XhrUpload
@@ -42,7 +40,7 @@ module Kublog
   @@user_kinds = []
   
   mattr_reader    :notification_processing
-  @@notification_processing = :immediately
+  @@notification_processing = :immediate
   
   mattr_accessor  :image_storage
   @@image_storage = :file
@@ -50,6 +48,9 @@ module Kublog
   mattr_accessor :author_class
   @@author_class =  'User'
   
+  mattr_accessor :notify_class
+  @@notify_class =  'User'
+  
   def self.notification_processing=(method='')
     @@notification_processing = method.to_sym
     if @@notification_processing == :delayed_job
@@ -59,6 +60,24 @@ module Kublog
     end
   end
   
+  def self.email_from(post)
+    if defined?(@@from_action)
+      @@from_action.yield(post)
+    elsif defined?(@@from_string)
+      @@from_string
+    else
+      'Change Me Now Kublog<test@kublog.com>'
+    end
+  end
+  
+  def self.author_email(email='', &block)
+    if block_given?
+      @@from_action = block 
+    else
+      @@from_string = email
+    end
+  end
+  
   KublogTwitter = Twitter.clone
   mattr_accessor  :twitter_client
   @@twitter_client = KublogTwitter::Client.new
@@ -67,6 +86,9 @@ module Kublog
   
   mattr_accessor  :blog_name
   @@blog_name =   'Kublog::Blog'
+  
+  mattr_accessor  :blog_description
+  @@blog_description =   'Some blog'
     
   def self.facebook_page_token=(token)
     @@facebook_client = FbGraph::User.me(token)
@@ -77,16 +99,24 @@ module Kublog
   end
   
   def self.twitter
+    @@twitter_config = true
     yield @@twitter_client
   end
   
-  def self.asset_path(path)
-    ["/assets", self.root_path , path].join
+  def self.facebook?
+    @@facebook_client.present?
+  end
+  
+  def self.twitter?
+    defined? @@twitter_config
+  end
+  
+  def self.email?
+    Kublog.notify_class.present?
   end
   
   def self.root_path
     Engine.routes.url_helpers.root_path
   end
   
-  
 end

data/lib/kublog/author.rb

@@ -1,6 +1,5 @@
-# Module to be included in user that enables him to be
-# published in Posts
-
+# Include module in the model to be referenced as author in the post
+# Gives the author an association to every post he has published
 module Kublog
   module Author
     

data/lib/kublog/engine.rb

@@ -1,3 +1,4 @@
+## Sets up the engine with an isolated namespace
 module Kublog
   class Engine < Rails::Engine
     isolate_namespace Kublog

data/lib/kublog/network/email.rb

@@ -0,0 +1,113 @@
+# Sets up email delivery method for the notification model
+# Includes validations of non blank email content
+
+module Kublog
+  module Network
+    module Email
+      
+      TEMPLATE = "app/views/kublog/post_mailer/new_post.liquid.html.erb"
+      
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :extend,  ClassMethods
+        base.send :validate, :valid_email_content, :if => :email?
+      end
+      
+      module InstanceMethods 
+        
+        # Calls appropriate processor to process e-mail sending to the
+        # bulk of users
+        def deliver_email
+          Processor.work(BulkEmail.new(self))
+        end  
+        
+        # Never send e-mail notification by default
+        def default_email
+          false
+        end
+        
+        # Returns true if notification acts as e-mail
+        def email?
+          self.kind == 'email'
+        end
+        
+        def delivered
+          self.times_delivered ||= 0
+          self.update_attribute :times_delivered, (self.times_delivered + 1)
+        end
+        
+        private
+        
+        def valid_email_content
+          errors.add(:content, :email) if self.content.blank?
+        end
+        
+      end
+      
+      module ClassMethods
+        
+        # Renders a preview of the e-mail that will be sent to the user
+        # so that the Author can edit the content of the e-mail on a Liquid Template
+        def email_template(post)
+          ERB.new(email_erb_template.read).result(binding)
+        end
+
+        private
+        
+        def email_erb_template
+          if File.exists?(File.join(Rails.root, TEMPLATE))
+            File.open(File.join(Rails.root, TEMPLATE))
+          else
+            File.open(File.join(Engine.root, TEMPLATE))
+          end
+        end
+        
+      end
+      
+      class BulkEmail
+        
+        def initialize(notification)
+          @notification = notification
+          @post = notification.post
+        end
+      
+        # Processes sending email to bunch of users if appropriate
+        # calls notify_post? on every user to determine whether or not
+        # to send e-mail
+        def perform
+          klass = eval(Kublog.notify_class)    
+          klass.all.each do |user|
+            if user.notify_post?(@notification.roles)
+              Processor.work(SingleEmail.new(@notification, user))
+            end
+          end
+        end
+        
+      end
+      
+      class SingleEmail
+        
+        attr_accessor :subject, :body, :post, :url
+        
+        def initialize(notification, user)
+          @subject = notification.title
+          @notification = notification
+          @body = notification.content
+          @post = notification.post
+          @url =  notification.url
+          @user = user
+        end   
+        
+        # Sends a single e-mail to the user
+        def perform
+          PostMailer.new_post(self, @post, @user).deliver
+          @notification.delivered
+        end
+                
+      end
+      
+    end
+    
+     
+  end
+end

data/lib/kublog/network/facebook.rb

@@ -0,0 +1,54 @@
+module Kublog
+  module Network
+    module Facebook
+      
+      def self.included(base)        
+        base.send :include, InstanceMethods
+        base.send :validate, :valid_facebook_content, :if => :facebook?
+      end
+      
+      module InstanceMethods
+        
+        # Calls the appropriate processor on create callback
+        # Posts on the fan page wall a link to the post        
+        def deliver_facebook
+          Processor.work(WallPost.new(self.url, self.content))
+        end
+        
+        # Defaults to create a facebook wall post when creating a post
+        # off by default when editing a post
+        def default_facebook
+          post.new_record?
+        end
+        
+        # Returns true when notification acts as facebook notification
+        def facebook?
+          self.kind == 'facebook'
+        end
+        
+        private
+        
+        def valid_facebook_content
+          errors.add(:content, :facebook) if self.content.blank?
+        end
+        
+      end
+      
+      class WallPost
+        
+        def initialize(url, message)
+          @url = url
+          @message = message
+        end
+        
+        # Posts a link to the post with the title of the content of the notification
+        # as a default message
+        def perform
+          Kublog.facebook_client.link! :link => @url, :message => @message
+        end
+        
+      end
+      
+    end
+  end
+end