kublog 0.0.1.1 → 0.9.0

data/.gitignore

@@ -2,8 +2,7 @@
 log/*.log
 pkg/
 *.gem
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/public/uploads/
-test/dummy/config/initializers/kublog.rb
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/public/uploads/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -4,5 +4,7 @@ gemspec
 
 # Optional Gems
 gem 'delayed_job'
-gem 'sprockets', '2.0.0.beta.13' # Only here until official release
+
+# Development Gems
+gem 'rspec-rails'
 gem 'ruby-debug19', :require => 'ruby-debug'

data/Gemfile.lock

@@ -1,111 +1,108 @@
 PATH
   remote: .
   specs:
-    kublog (0.0.1)
-      carrierwave (~> 0.5.7)
-      coffee-script (~> 2.2.0)
-      fb_graph (~> 1.9.5)
-      friendly_id (~> 4.0.0.beta8)
-      jquery-rails (~> 1.0.13)
-      liquid (~> 2.2.2)
-      rails (~> 3.1.0.rc5)
-      rmagick (~> 2.13.1)
-      sanitize (~> 2.0.3)
-      twitter (~> 1.6.2)
+    kublog (0.9.0)
+      carrierwave
+      coffee-script (>= 2.2.0)
+      fb_graph
+      friendly_id (>= 4.0.0.beta14)
+      jquery-rails (>= 1.0.13)
+      liquid
+      rails (>= 3.1.0)
+      rmagick
+      sanitize
+      twitter
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.0.rc6)
-      actionpack (= 3.1.0.rc6)
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
       mail (~> 2.3.0)
-    actionpack (3.1.0.rc6)
-      activemodel (= 3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
       rack (~> 1.3.2)
-      rack-cache (~> 1.0.2)
-      rack-mount (~> 0.8.1)
-      rack-test (~> 0.6.0)
-      sprockets (~> 2.0.0.beta.12)
-    activemodel (3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
-      bcrypt-ruby (~> 2.1.4)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.0.rc6)
-      activemodel (= 3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
       arel (~> 2.2.1)
       tzinfo (~> 0.3.29)
-    activeresource (3.1.0.rc6)
-      activemodel (= 3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
-    activesupport (3.1.0.rc6)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
       multi_json (~> 1.0)
     addressable (2.2.6)
     archive-tar-minitar (0.5.2)
     arel (2.2.1)
     attr_required (0.0.3)
-    bcrypt-ruby (2.1.4)
+    bcrypt-ruby (3.0.0)
     builder (3.0.0)
-    carrierwave (0.5.7)
+    carrierwave (0.5.8)
       activesupport (~> 3.0)
     coffee-script (2.2.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.1.2)
+    coffee-script-source (1.1.3)
     columnize (0.3.4)
     daemons (1.1.4)
     delayed_job (2.1.4)
       activesupport (~> 3.0)
       daemons
+    diff-lcs (1.1.3)
     erubis (2.7.0)
-    execjs (1.2.4)
+    execjs (1.2.9)
       multi_json (~> 1.0)
-    factory_girl (2.0.4)
+    factory_girl (2.0.5)
     factory_girl_rails (1.1.0)
       factory_girl (~> 2.0.0)
       railties (>= 3.0.0)
-    faraday (0.7.4)
+    faraday (0.7.5)
       addressable (~> 2.2.6)
-      multipart-post (~> 1.1.0)
-      rack (< 2, >= 1.1.0)
-    faraday_middleware (0.7.0)
-      faraday (~> 0.7.3)
-    fb_graph (1.9.5)
+      multipart-post (~> 1.1.3)
+      rack (>= 1.1.0, < 2)
+    fb_graph (2.2.2)
       httpclient (>= 2.2.0.2)
-      rack-oauth2 (>= 0.8.0)
-    friendly_id (4.0.0.beta8)
-    hashie (1.1.0)
+      rack-oauth2 (>= 0.9.4)
+    friendly_id (4.0.0.beta14)
     hike (1.2.1)
-    httpclient (2.2.1)
+    httpclient (2.2.3)
     i18n (0.6.0)
-    jquery-rails (1.0.13)
+    jquery-rails (1.0.18)
       railties (~> 3.0)
       thor (~> 0.14)
-    json (1.5.3)
+    json (1.6.1)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
-    liquid (2.2.2)
+    liquid (2.3.0)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
+    mime-types (1.17.2)
     multi_json (1.0.3)
-    multi_xml (0.2.2)
     multipart-post (1.1.3)
     nokogiri (1.5.0)
-    polyglot (0.3.2)
+    polyglot (0.3.3)
     rack (1.3.2)
-    rack-cache (1.0.2)
+    rack-cache (1.0.3)
       rack (>= 0.4)
-    rack-mount (0.8.2)
+    rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-oauth2 (0.9.2)
+    rack-oauth2 (0.11.0)
       activesupport (>= 2.3)
       attr_required (>= 0.0.3)
       httpclient (>= 2.2.0.2)
@@ -116,24 +113,37 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.1.0.rc6)
-      actionmailer (= 3.1.0.rc6)
-      actionpack (= 3.1.0.rc6)
-      activerecord (= 3.1.0.rc6)
-      activeresource (= 3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
       bundler (~> 1.0)
-      railties (= 3.1.0.rc6)
-    railties (3.1.0.rc6)
-      actionpack (= 3.1.0.rc6)
-      activesupport (= 3.1.0.rc6)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2)
-    rdoc (3.9.2)
+    rdoc (3.9.4)
     rmagick (2.13.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
     ruby-debug-base19 (0.11.25)
       columnize (>= 0.3.1)
       linecache19 (>= 0.5.11)
@@ -145,26 +155,27 @@ GEM
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
     sanitize (2.0.3)
-      nokogiri (< 1.6, >= 1.4.4)
+      nokogiri (>= 1.4.4, < 1.6)
     simple_oauth (0.1.5)
-    sprockets (2.0.0.beta.13)
+    sprockets (2.0.0)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (!= 1.3.0, ~> 1.1)
+      tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.4)
     thor (0.14.6)
-    tilt (1.3.2)
+    tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    twitter (1.6.2)
-      faraday (~> 0.7.4)
-      faraday_middleware (~> 0.7.0)
-      hashie (~> 1.1.0)
-      multi_json (~> 1.0.0)
-      multi_xml (~> 0.2.0)
-      simple_oauth (~> 0.1.5)
-    tzinfo (0.3.29)
+    twitter (2.0.0)
+      activesupport (~> 3.0)
+      faraday (~> 0.7)
+      multi_json (~> 1.0)
+      simple_oauth (~> 0.1)
+      twitter-text (~> 1.4)
+    twitter-text (1.4.13)
+      activesupport
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
@@ -173,5 +184,6 @@ DEPENDENCIES
   delayed_job
   factory_girl_rails
   kublog!
+  rspec-rails
   ruby-debug19
   sqlite3

data/README.rdoc

@@ -1,102 +1,143 @@
 = Kublog
 
-Kublog is a complete yet simple way to have a Product Blog that integrates with your apps user base. It includes social sharing, atom feeds and moderated comments.
+Kublog is a simple yet complete way to have a Product Blog that integrates with your apps user base. It includes social sharing, atom feeds and moderated comments. 
 
 Built for Rails 3.1, Kublog is a complete stack, fully configurable solution. 
 
-Currently in alpha and under continuous development, hackers welcome.
+Currently live for Rutanet[http://rutanet.com] on http://rutanet.com/blog and other products at Innku[http://innku.com].
 
 == Features
 
 * Publish posts with the most basic and simple wysiwyg
 * Attach multiple images to your content
 * Share your posts on your Product's Twitter Page and Facebook Fan Page
-* E-mail personalized versions of your posts to your users
+* E-mail personalized versions of your posts to all your users
 * Optional background processing with Delayed Job
 * Moderated comments from apps users, apps admins, and visitors
 * Atom feed for main blog and individual post categories
 
-== What you need
+== Kublog Basic Usage
+
+Kublog is a mountable Engine that assumes you use the following tools for development:
 
-* Ruby  1.9.x
 * Rails 3.1
-* Bundler
+* ActiveRecord
 
-== Install
+In your Gemfile
 
-Require in your Gemfile
-  
-  gem 'kublog', '0.0.1'
-  
-Migrate the Kublog posts into your database
+  gem 'kublog', '0.9.0'
 
-  rake kublog:install:migrations
-  
-Mount Kublog on your routes file
+Generate migrations and all the code you'll likely want to customize.
+
+  rails generate kublog:install
+
+Run the migrations
+
+  rake db:migrate
+
+Mount the engine on your routes
 
   mount Kublog::Engine => "/blog(.:format)"
+
+Include the author module under the model that will have access to create posts on the blog:
+
+  class User < ActiveRecord::Base
+    include Kublog::Author
+  end
+
+Configure your blog's basic information on **initializers/kublog.rb**
+
+  Kublog.setup do |config|
+    config.blog_name = 'Example blog'
+    config.blog_description = 'Best blog ever'
+    config.default_url_options = {:host => 'www.exampleblog.com'}
+  end
   
-== How to Use
+Kublog uses I18n, the install generator will create the file **locales/kublog/en.yml**, make sure to add its content to your own en.yml file or add the following line on your **application.rb** also include the folders under locales:
 
-On your user model:
+    config.i18n.load_path += Dir[File.join(Rails.root, 'config', 'locales', '**', '*.{rb,yml}')]
 
-  include Kublog::Author
-  include Kublog::Notifiable
+To get the most of Kublog you'll want to **Integrate your Users**, **Add E-mail Notifications** and **Configure your Social Networks**.
 
-=== User Integration
+== Integrate your Users
 
-Kublog User Integration depends on two functioning methods living on Kublog::ApplicationController
+The install generator will create the file **controllers/kublog/application_controller**.
 
-* current_user
-* is_admin?
+On this file you will see the definitions of two empty methods **current_user** and **is_admin?**. Since Kublog is an isolated mountable Engine, you **will** need to define this methods, even if you have them on your apps application_controller. 
 
-==== Basic User Management
+After you finish, it might will look something like this:
 
-If you are currently storing your users on session[:user_id] and have the method *admin?* for your user class, things should just work.
+    def current_user
+      @current_user ||= User.find(session[:user_id])
+    end
+    
+    def is_admin?
+      @current_user.admin?
+    end
 
-==== Devise
+It's **important** to know that if you're using Devise, you won't need a current_user method. If the model you're using is named something other than user, you can call the controller access method inside of **current_user**.
 
-Replace this line
+=== Author#to_s
 
-  include UserIntegration::Common
-  
-With this line
-  
-  include UserIntegration::Devise
-  
-==== Uber custom user integration
+I recommend you define a to_s method for your Author such as:
 
-Override current_user, is_admin? methods for Kublog::ApplicationController
+    def to_s
+      "#{self.name} #{self.last_name}"
+    end
 
-Override admin? for your Kublog::Author class
+== Add E-mail Notifications
 
-TODO: Better docs
-  
-==== Custom Integration, Social Networks and Image Uploading
+To add E-mail notifications, include the **Kublog::Notifiable** module into the user class that will be notified.
+
+    class User < ActiveRecord::Base
+      include Kublog::Notifiable
+    end
 
-Take a look at this example configuration:
+The E-mail from which they will receive the notification is configured in your **kublog.rb** initializer:
+
+    config.author_email "Kublog Test <test@kublog.com>"
+    
+You may also configure a block to specify that the user receives the notification from the author's E-mail:
+
+    config.author_email do |post|
+      post.user.email
+    end
+=== Configure your social Networks
+
+Configuring **Twitter** is pretty easy, you might want to create a twitter app on https://dev.twitter.com/
+
+You will need to feed Kublog:
+
+* Consumer Key
+* Consumer Secret
+* Oauth Token
+* Oauth Secret
+
+=== Sample twitter configuration on initializers/kublog.rb
 
-  Kublog.setup do |config|
-  
-    config.blog_name = 'Rutanet'
-    config.default_url_options = {:host => 'www.rutanet.com'}
-    config.notification_processing = :immediate # or :delayed_job     
-                                                                  
-    config.user_kinds = %w(shipper carrier logistics)
-  
-    config.image_storage = :file # or :s3
-  
     config.twitter do |twitter|
-      twitter.consumer_key = 'xxx'
-      twitter.consumer_secret = 'xxx'
-      twitter.oauth_token = 'xxx'
-      twitter.oauth_token_secret = 'xxx'
+      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
-  
-    config.facebook_page_token = 'xxx'
-  
-  end
-  
-TODO: More docs
 
-Will include much more documentation as development continues, please be patient.
+Configuring **Facebook** Fan page posts is a little trickier, you will only need the access token for your Fan Page. 
+
+Find out how to get it here: https://github.com/innku/authorizefb
+
+=== Sample Facebook configuration on initializers/kublog.rb
+
+    config.facebook_page_token = 'your-page-token'
+
+== What's coming   
+
+* Drafts
+* Captcha for unsigned user notifications
+* Pagination
+
+If you wish to work on this. Fork it and pull request, please =) 
+    
+== Check out the code
+
+Kublog is made to be as simple as possible so you can modify fork it, modify it and reuse it. Please do.