remote_partial 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Rob Nichols and Warwickshire County Council
+
+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,63 @@
+= RemotePartial
+
+This rails engine allows partials to be created from remote content.
+
+== Installation
+
+Add this to your Gemfile:
+
+    gem 'remote_partial'
+
+== Defining a remote partial
+
+Define the remote partials in an initializer (config/initializers/remote_partial.rb)
+
+    RemotePartial.define(
+      url: 'http://www.ruby-lang.org/en/',
+      name: 'ruby',
+      criteria: '#intro',
+      minimum_life: 3.hours
+    )
+
+This will create a partial at:
+
+    app/veiws/remote_partials/_ruby.html.erb
+
+The content of this partial will be grabbed from the page at the url, and will
+comprise the content defined by '#intro' (that is, the content of the tag with
+an id='intro'). This content will not be updated for at least 3 hours.
+
+== Criteria
+
+Nokogiri is used to extract content from within the target page. Criteria are
+passed to Nokogiri's search method, and can be either xpath or css format. See:
+
+http://nokogiri.org/tutorials/searching_a_xml_html_document.html
+
+== Adding remote partial content to a page
+
+To output the content of the remote partial 'ruby' to a rails view add this:
+
+    <%= render_remote_partial 'ruby' %>
+
+== Updating the content
+
+The content update process is run each time the host app is loaded. An update can
+also be triggered by running the follow rake task:
+
+    rake remote_partial:update
+
+Each time a remote partial is updated, its partial.stale_at is set as the
+current datetime plus the minimum life of that partial (defaults to 1 minute).
+If an update process is run before the stale_at time, that partial will not be
+updated.
+
+So once the 'ruby' remote partial has been updated, it will be at least three
+hours before it will be updated again.
+
+== Problems grabbing content
+
+If remote partial is unable to retrieve remote content, the problem will be
+logged, and a retrieval will be tried again at the next update.
+
+This project wobbles and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RemotePartial'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/helpers/remote_partial/application_helper.rb

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

data/app/helpers/remote_partial/host_app_helper.rb

@@ -0,0 +1,11 @@
+# Helper methods added here, should be available to the host app
+
+module RemotePartial
+  module HostAppHelper
+
+    def render_remote_partial(name)
+      render partial: "remote_partials/#{name}"
+    end
+    
+  end
+end

data/app/models/remote_partial/builder.rb

@@ -0,0 +1,30 @@
+
+module RemotePartial
+  class Builder
+    attr_reader :args, :partial
+
+    def self.build(args)
+      builder = new(args)
+      builder.run
+    end
+
+    def initialize(args)
+      @args = args
+    end
+    
+    def run
+      create_or_update_partial
+      partial.update_stale_file
+    rescue RemotePartialRetrivalError => error
+      Rails.logger.warn error.message
+    end
+
+    def create_or_update_partial
+      @partial = Partial.find_or_initialize_by_name(args[:name])
+      @partial.url = args[:url]
+      @partial.criteria = args[:criteria]
+      @partial.repeat_period = args.fetch(:repeat_period, 12.hour)
+      @partial.save
+    end
+  end
+end

data/app/models/remote_partial/exceptions.rb

@@ -0,0 +1,24 @@
+module RemotePartial
+
+  class RemotePartialRetrivalError < StandardError
+    attr_reader :url, :source
+
+    def initialize(url, source)
+      @url = url
+      @source = source
+    end
+
+    def message
+      "Unable to retrieve remote partial at #{url}: #{error_message}"
+    end
+
+    def error_message
+      if source.class == RuntimeError
+        source.message
+      else
+        source.inspect
+      end
+    end
+  end
+
+end

data/app/models/remote_partial/partial.rb

@@ -0,0 +1,57 @@
+
+module RemotePartial
+  class Partial < ActiveRecord::Base
+
+    validates :name, :url, presence: true
+
+    def output_file_name
+      [partial_folder, file_name].join("/")
+    end
+
+    def update_file
+      resource_manager.output_to output_file_name
+    end
+
+    def update_stale_file
+      update_file if stale?
+    end
+
+    def criteria
+      super if super.present? # ensure criteria doesn't return empty string
+    end
+
+    def resource_manager
+      ResourceManager.new(url, criteria)
+    end
+    
+    def repeat_period
+      super.present? ? super : 60
+    end
+
+    def update_stale_at
+      reset_stale_at if stale?
+    end
+
+    def reset_stale_at
+      update_attribute(:stale_at, (Time.now + repeat_period))
+    end
+
+    def stale?
+      stale_at.blank? or stale_at < Time.now
+    end
+
+    private
+    def partial_folder
+      RemotePartial.partial_location.gsub(tailing_slash_pattern, "")
+    end
+
+    def file_name
+      "_#{name}.html.erb"
+    end
+
+    def tailing_slash_pattern
+      /\/$/
+    end
+
+  end
+end

data/app/models/remote_partial/resource_manager.rb

@@ -0,0 +1,66 @@
+require 'nokogiri'
+require 'net/http'
+
+module RemotePartial
+  class ResourceManager
+    attr_reader :content, :url, :criteria
+
+    def self.get_page(url)
+      Nokogiri::HTML(get_raw(url))
+    end
+
+    def self.get_raw(url)
+      response = Net::HTTP.get_response(URI(url))
+      
+      case response.code.to_i
+      when ok_response_codes
+        return response.body
+      when redirect_response_codes
+        get_raw(URI.parse(response['location']))
+      else
+        raise response.inspect
+      end
+    rescue => exception # Do main exception raising outside of case statement so that SocketErrors are also handled
+      raise RemotePartialRetrivalError.new(url, exception)
+    end
+
+    def initialize(url, criteria = nil)
+      @url = url
+      @content = self.class.get_page(url)
+      @criteria = criteria
+    end
+
+    def html
+      return content.to_s unless criteria
+      content.search(criteria).to_s
+    end
+
+    def output_to(path)
+      @path = path
+      ensure_output_folder_exists
+      File.write(path, html)
+    end
+
+    private
+    def output_folder
+      File.dirname(@path)
+    end
+
+    def ensure_output_folder_exists
+      FileUtils.mkdir_p(output_folder) unless output_folder_exists?
+    end
+
+    def output_folder_exists?
+      Dir.exists?(output_folder)
+    end
+
+    def self.ok_response_codes
+      200..299
+    end
+
+    def self.redirect_response_codes
+      300..399
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+RemotePartial::Engine.routes.draw do
+end

data/db/migrate/20130702072157_create_remote_partial_partials.rb

@@ -0,0 +1,12 @@
+class CreateRemotePartialPartials < ActiveRecord::Migration
+  def change
+    create_table :remote_partial_partials do |t|
+      t.string   :name,    limit: 100,   null: false
+      t.text     :url,     limit: 0x7ff, null: false
+      t.string   :criteria
+      t.float    :repeat_period
+      t.datetime :stale_at
+      t.timestamps
+    end
+  end
+end

data/lib/remote_partial/engine.rb

@@ -0,0 +1,11 @@
+module RemotePartial
+  class Engine < ::Rails::Engine
+    isolate_namespace RemotePartial
+
+    initializer 'remote_partial.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper RemotePartial::HostAppHelper
+      end
+    end
+  end
+end

data/lib/remote_partial/version.rb

@@ -0,0 +1,3 @@
+module RemotePartial
+  VERSION = "0.0.1"
+end

data/lib/remote_partial.rb

@@ -0,0 +1,23 @@
+require "remote_partial/engine"
+
+begin
+  require 'webmock'
+  WebMock.disable! if defined?(WebMock)
+rescue LoadError
+  # Ignore - WebMock not available
+end
+module RemotePartial
+
+  def self.define(args = {})
+    Builder.build(args)
+  end
+
+  def self.partial_location
+    @partial_location || File.expand_path('app/views/remote_partials', Rails.root)
+  end
+
+  def self.partial_location=(path)
+    @partial_location = path
+  end
+
+end

data/lib/tasks/remote_partial_tasks.rake

@@ -0,0 +1,10 @@
+namespace :remote_partial do
+
+  desc "Updates remote partials"
+  task :update => :environment do
+    # Don't need to do anything more than reload the environment, as remote
+    # partials are reloaded on application start.
+    Rails.logger.info "Updated remote partials at #{Time.now.to_s(:db)}"
+  end
+  
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/demos.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/javascripts/samples.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.