stackoverfeeds 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2RiYjc2MDAzY2QwZjA1NWM3YmU3ZTM4MGQ5NzlhYWY5MTkyMTgwMg==
+  data.tar.gz: !binary |-
+    ZmM3YWNkYzY3NjM0ZTI2MGViNDg0YTNlOTlmNzcxNWNhNThhMGIzZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmZjYTdjZjJkYWExNWQzZWEyZDRlMDMyMzQ2MmVkNzNjYjE3NWQ0OTdjYmE1
+    YjZkYmMwM2Y0M2Q0N2YzYTExMjJkMGYyNDc3YTExZTY4ZThkMTA4MmQ0ZTJm
+    YTZjMDQxMTRjNWZlYzg5NDBhNGZjNzFjYTYyZWZmMjdiZTVkMTQ=
+  data.tar.gz: !binary |-
+    ZmUyZDEyMGIyMDVjMmRkNzJjZjRiYjIyNmQ0NzE0OGUyOTlhYzc4OGE3Yjdm
+    ODUwY2E5NjM3ZTQ3ZWFmYzBiNDViYjQ1NTg4M2M4ZGFlMDRlODAwNzA0ZTY4
+    OTBlYWViMjYxMjQ5OTRmNGRiZWMzYTRkNGM2MzAwNzljM2E5NDM=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,121 @@
+= Stackoverfeeds
+
+Stackoverfeeds is a full RoR gem that let you show your Stackoverflow activity in a fancy way with minimal configuration. It:
+
+* Is a full Rails engine
+* Can be added like a gem in your RoR application
+* Is a complete MVC solution
+* Offers you a predefined view (Stackoverflow like style) that displays your Stackoverflow activity
+* Based on feedshub (https://github.com/VAIRIX/feedshub)
+
+== Benefits
+
+This solution fits very well for everyone who wants to give more visibility to their company or maybe themselves.
+
+== Installation
+
+You can add it to your Gemfile with:
+
+<code>
+gem 'stackoverfeeds'
+</code>
+
+Then run the bundle command to install it
+
+<code>
+bundle install
+</code>
+
+After you install Stackoverfeeds, you need to run the generator
+
+<code>
+rails generate stackoverfeeds:install
+</code>
+
+The generator will copy:
+
+* Necessary migrations
+* Assets you can customize
+* Environment configurations
+
+Also, it will add environment variables in your application.rb file in order to load Stackoverfeeds.
+
+The last step is run the migrations
+
+<code>
+rake db:migrate
+</code>
+
+== Configuration
+
+To customize the behaviour of the gem you have to edit <code>/config/stackoverfeeds/config.yml</code>
+
+  #Set your user assigned number from Stackoverflow
+  user_number: '3470100'
+
+  #Set your user name from Stackoverflow
+  user_name: 'vairix'
+
+  #Set the default number of feeds to retrieve (if no amount set by parameter)
+  feeds_number: '10'
+
+  #Set the theme to the Stackoverflow flair to show on top of the activities
+  theme: 'default'
+
+And also edit <code>/config/stackoverfeeds/schedule.rb</code> to customize the period of feeds updates.
+Feedshub use whenever Gem to schedule the updates of feeds. For more information visit <https://github.com/javan/whenever>
+
+
+To generate the schedule task, run:
+
+<code>
+RAILS_ENV=your_environment rake stackoverfeeds:schedule
+</code>
+
+You need to do this to keep updated feeds.
+
+== How to integrate it?
+
+The integration is done using a helper that will render the public activity wherever you want in the view.
+In order to do it you have to:
+
+Include the helper reference in the view controller
+<code>ruby helper Stackoverfeeds::StackoverfeedsHelper</code>
+
+In your view, call the helper as shown below
+
+<code>
+<%= stackoverflow_feeds %>
+</code>
+
+By calling the helper without parameter, it will display the number of feeds specified in the configuration and with all activities collapsed. You can add two parameters (ie.:<code><%= stackoverflow_feeds(50, true) %></code>) to specify the number of feeds to show in the view, and the display mode (activities collapsed or expanded). In non extended mode, each activity summary is retrieve on demand.
+
+== Screenshots
+
+This is the default style of Feedshub.
+
+http://vairix.com/assets/stackoverfeeds.png
+
+
+== License
+
+Copyright 2014 VAIRIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stackoverfeeds'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/stackoverfeeds/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/stackoverfeeds/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/stackoverfeeds/application_controller.rb

@@ -0,0 +1,4 @@
+module Stackoverfeeds
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/stackoverfeeds/so_feeds_controller.rb

@@ -0,0 +1,10 @@
+module Stackoverfeeds
+  class SoFeedsController < ApplicationController
+
+    def feed_summary
+      entry_id = params[:entry_id]
+      render text: Stackoverfeeds::SoFeed.find(entry_id).summary
+    end
+
+  end
+end

data/app/helpers/stackoverfeeds/application_helper.rb

@@ -0,0 +1,4 @@
+module Stackoverfeeds
+  module ApplicationHelper
+  end
+end

data/app/helpers/stackoverfeeds/stackoverfeeds_helper.rb

@@ -0,0 +1,8 @@
+module Stackoverfeeds
+  module StackoverfeedsHelper
+    def stackoverflow_feeds(limit=ENV['feeds_number'].to_i, extended=!!ENV['extended'])
+      @entries = Stackoverfeeds::SoFeed.public_feeds(limit)
+      render partial: 'stackoverfeeds/stackoverflow_feeds', locals: { extended: extended }
+    end
+  end
+end

data/app/models/stackoverfeeds/so_feed.rb

@@ -0,0 +1,9 @@
+module Stackoverfeeds
+  class SoFeed < ActiveRecord::Base
+
+    def self.public_feeds(limit = ENV['stackoverflow_feeds_number'].to_i)
+      SoFeed.order('published DESC').limit(limit)
+    end
+
+  end
+end

data/app/views/stackoverfeeds/_stackoverflow_feeds.html.erb

@@ -0,0 +1,28 @@
+<div id='stackoverflow_feeds' class='user-tab-content'>
+  <% if ENV['theme'] -%>
+    <a href='http://stackoverflow.com/users/<%= ENV['user_number'] %>/<%= ENV['user_name'] %>' target= '_blank'>
+      <img src='http://stackoverflow.com/users/flair/<%= ENV['user_number'] %>.png?theme=<%= ENV['theme'] %>' width='208' height='58' >
+    </a>
+  <% end -%>
+  <table class='history-table'>
+    <tbody>
+      <% @entries.each do |entry| %>
+        <tr>
+          <td id='enable-load-body-<%= entry.id %>' class='async-load load-prepped'>
+            <% if(extended) -%>
+              <a class='load-body expander-arrow-small-hide hide-body expander-arrow-small-show'></a>
+              <b><%= link_to entry.title, entry.entry_id, target: '_blank', class: 'answer-hyperlink timeline-answers' %></b>
+              </br>
+              <span class='comments' style='display: block;'><%= entry.summary.html_safe unless (entry.summary.blank?) %></span>
+            <% else -%>
+              <a class='load-body expander-arrow-small-hide'></a>
+              <b><%= link_to entry.title, entry.entry_id, target: '_blank', class: 'answer-hyperlink timeline-answers' %></b>
+              </br>
+              <span class='comments' style='display: none;'></span>
+            <% end -%>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/stackoverfeeds/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Stackoverfeeds</title>
+  <%= stylesheet_link_tag    "stackoverfeeds/application", media: "all" %>
+  <%= javascript_include_tag "stackoverfeeds/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Stackoverfeeds::Engine.routes.draw do
+  match 'feed_summary', controller: 'so_feeds', action: 'feed_summary', as: 'feed_summary', via: :get
+end

data/db/migrate/20140402191249_create_stackoverfeeds_so_feeds.rb

@@ -0,0 +1,14 @@
+class CreateStackoverfeedsSoFeeds < ActiveRecord::Migration
+  def change
+    create_table :stackoverfeeds_so_feeds do |t|
+      t.string :author
+      t.string :entry_id
+      t.text :summary
+      t.string :title
+      t.datetime :updated
+      t.datetime :published
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'rails/generators'
+
+module Stackoverfeeds
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'This generator prepare Stackoverfeeds to be used'
+
+      def add_assets
+        css_manifest = 'app/assets/stylesheets/application.css'
+
+        if File.exist?(css_manifest)
+          content = File.read(css_manifest)
+          unless content.match(/require_tree\s+\.\s*$/) || content.match(/require stackoverfeeds\/feeds/)
+            style_require_block = "\r\n*= require stackoverfeeds/feeds\r\n"
+            insert_into_file css_manifest, style_require_block, :before => "*/"
+          end
+        else
+          copy_file 'application.css', 'app/assets/stylesheets/application.css'
+        end
+
+        js_manifest = 'app/assets/javascripts/application.js'
+        if File.exist?(js_manifest)
+          content = File.read(js_manifest)
+          unless content.match(/require_tree\s+\.\s*$/) || content.match(/require stackoverfeeds\/feeds/)
+            js_require_block = "\r\n//= require stackoverfeeds/feeds"
+            append_to_file js_manifest, js_require_block
+          end
+        else
+          copy_file 'application.js', 'app/assets/javascripts/application.js'
+        end
+      end
+
+      def add_styles
+        copy_file 'feeds.css', 'app/assets/stylesheets/stackoverfeeds/feeds.css'
+      end
+
+      def add_scripts
+        copy_file 'feeds.js', 'app/assets/javascripts/stackoverfeeds/feeds.js'
+      end
+
+      def add_images
+        copy_file 'sprites.png', 'app/assets/images/stackoverfeeds/sprites.png'
+      end
+
+      def add_config
+        unless File.read('config/application.rb').match(/stackoverfeeds\/config.yml/)
+          conf_manifest = 'config/stackoverfeeds/config.yml'
+          env_update = "\r\nENV.update YAML.load(File.read(File.expand_path('../stackoverfeeds/config.yml', __FILE__)))\n"
+          copy_file 'config.yml', conf_manifest
+          append_to_file 'config/application.rb', env_update
+        end
+      end
+
+      def add_routes
+        routes = 'config/routes.rb'
+        unless File.read(routes).match(/stackoverfeeds/)
+          routes_update = "\r\n\r\n  mount Stackoverfeeds::Engine => '\/stackoverfeeds'\n"
+          insert_into_file routes, routes_update, :after => "Application.routes.draw do"
+        end
+      end
+
+      def copy_schedule
+        copy_file 'schedule.rb', 'config/stackoverfeeds/schedule.rb'
+      end
+
+      def run_tasks
+        exec('rake stackoverfeeds:install:migrations')
+      end
+
+    end
+  end
+end

data/lib/generators/stackoverfeeds/install/templates/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree .
+*/

data/lib/generators/stackoverfeeds/install/templates/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/lib/generators/stackoverfeeds/install/templates/config.yml

@@ -0,0 +1,14 @@
+#Set your user assigned number from Stackoverflow
+user_number: '3470100'
+
+#Set your user name from Stackoverflow
+user_name: 'vairix'
+
+#Set the default number of feeds to retrieve (if no amount set by parameter)
+feeds_number: '10'
+
+#Set the display mode
+#extended: false
+
+#Set the theme to the Stackoverflow flair to show on top of the activities
+theme: 'default'