orthorings 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Robotic Foo
+
+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.markdown

@@ -0,0 +1,86 @@
+# Orthorings
+
+Orthorings is a gem to interact with and display content from Orthor.com
+
+The 2 main things you can do with Orthorings are:
+
+* Define an entire site backed by Orthor with the included DSL (more on this below)
+* Display content on any page in your app using the included helper methods and the Orthorings class
+
+## Installation
+
+As a gem (coming soon)
+  sudo gem install anthony-orthorings
+
+## Configuration
+
+Add a new file (e.g. orthor_config.rb) with the something like the below to your startup directory (e.g. in Rails config/initializers)
+
+    Orthorings.setup do |config|
+      config.account_id = "orthor"
+      config.caching :memory, 300, {}
+    end
+
+You can specify any Moneta cache class as the first argument to config.caching, the second argument is expiry time in seconds. The third is any additional arguments you want passed to the cache class on initialize.
+
+## DSL
+
+To make creating a new site backed by Orthor super easy, we've included a DSL that lets you define your site. You don't need to supply any view files, you only need to create your own custom layout to override the included dull one. Currently the DSL plays with Sinatra and Rails - the Sinatra Extension is included in lib/sinatra/orthor.rb, Rails support is provided by engine functionality (seen in app/ and config/).
+
+Here is some example usage (more docs to come, this is still a WIP and some aspects will change)
+
+    Orthor::Site.define do
+      cache_for 300 # in seconds, http caching
+      layout :application 
+      keywords "your, site, specific, keywords"
+      description "what's your site doing?"
+  
+      page "/", "Home" 
+      page "/about", "About Us"
+
+      feed "/blog.rss", "Blog" do
+        id "our-blog"
+      end
+  
+      category "/writings" do
+        keywords "lets, do, some, seo"
+        description "a more apt description for this section of the site"
+        
+        page "/writings/why", "Why we write"
+        page_path "/writings/:id" 
+    
+        feed "/writings.rss" do
+          id "our-writings"
+          name "Our Writings"
+        end
+
+        category "/writings/announcements" do
+          page_path "/writings/announcements/:id"
+        end
+      end
+    end
+
+In the above example, every route defined will be handled by the Orthorings gem and rendered through your specified layout, easy! In rails, you will also get named routes based off of the orthor id, e.g. 
+
+    "our-blog" -> our_blog_path
+
+Inside of any block in the dsl, you can specify the orthor id, if you don't give an id, the dsl assumes the last fragment of the specified path is the orthor object id, e.g. "/writings" has an orthor id of "writings". Stay tuned for more examples and documentation.
+
+## TODO
+
+Things that are being mulled over
+
+* Nav helpers (generate navigation based off of the DSL structure)
+* Static Page use needs to be defined more (perhaps define a action to render?)
+* Release as a 0.1 gem
+* ...I'm sure there'll be something else here soon
+
+## Example Usage (as provided by the OrthorHelper module, defined as class methods of Orthorings)
+
+    orthor_content("content-item-id")  or Orthorings.content("id")
+    orthor_query("query-id") or Orthorings.query("id")
+    orthor_category("category-id") or Orthorings.category("id")
+    orthor_feed("feed-id") or Orthorings.feed("id")
+
+
+Copyright (c) 2009 Robotic Foo, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "orthorings"
+    gem.summary = "Orthorings is a gem for displaying content from orthor.com"
+    gem.email = "anthony@orthor.com"
+    gem.homepage = "http://github.com/anthony/orthorings"
+    gem.authors = ["Anthony Langhorne"]
+    gem.add_dependency("moneta", "0.6.0")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc "Run all the Orthorings specs"
+Spec::Rake::SpecTask.new(:ospec) do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/orthor/content_controller.rb

@@ -0,0 +1,24 @@
+class Orthor::ContentController < ApplicationController
+  def orthor_content
+    expires_in Orthor::Site.cache_for, :public => true if Orthor::Site.cache_for > 0
+    
+    if params[:id]
+      @orthor_content = Orthorings.content(params[:id])
+      resource = Orthor::Site.find_resource_by_page_path(request.request_uri, params[:id])
+    else 
+      resource = Orthor::Site.find_resource_by_path(request.request_uri)
+      @orthor_content = resource.content
+    end
+    
+    if resource.is_a?(Orthor::Feed)
+      render :xml => @orthor_content
+    else
+      @name = resource.name
+      @meta_keywords = resource.keywords
+      @meta_description = resource.description
+      @orthor_feeds = resource.respond_to?(:feeds) ? resource.feeds : []
+      
+      render :action => "orthor_content", :layout => Orthor::Site.layout.to_s
+    end
+  end
+end

data/app/views/layouts/orthor_layout.html.erb

@@ -0,0 +1,31 @@
+<html>
+  <head>
+    <title><%= @name %> | Orthorings Default Layout</title>
+    <%= keywords.untaint %>
+    <%= description.untaint %>
+    <%= orthor_feed_tags.untaint %>
+    <style>
+    * { margin: 0; }
+    body { margin: 20px; font-family: helvetica,arial,sans-serif; color: #333; background-color: #fff; }
+    div, p { margin: 10px 0px; }
+    div.template-explanation { float: right; margin-left: 20px; }
+    div.template-explanation p { margin: 0; }
+    div.template-explanation pre { padding: 5px; background-color: #ccc; }
+    </style>
+  </head>
+  <body>
+    <div class="template-explanation">
+      <p>Tell Orthor about your own template:</p>
+<pre>
+  Orthor::Site.define do
+    layout :application
+    ...
+  end
+</pre>
+    </div>
+    
+    <div class="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/orthor/content/orthor_content.html.erb

@@ -0,0 +1 @@
+<div class="orthor_content"><%= @orthor_content %></div>

data/config/routes.rb

@@ -0,0 +1,9 @@
+ActionController::Routing::Routes.draw do |map|
+  Orthor::Site.resources.each do |resource|
+    if resource.is_a?(::Orthor::Category) && !resource.page_path.nil?
+      map.send("#{resource.path_name}_pages", resource.page_path, :controller => "orthor/content", :action => "orthor_content")
+    end
+    
+    map.send(resource.path_name, resource.path, :controller => "orthor/content", :action => "orthor_content")
+  end
+end

data/lib/core_ext/dsl_accessor.rb

@@ -0,0 +1,15 @@
+class Module
+  def dsl_accessor(*symbols)
+    symbols.each do |sym|
+      class_eval %{
+        def #{sym}(*val)
+          if val.empty?
+            @#{sym}
+          else
+            @#{sym} = val.size == 1 ? val[0] : val
+          end
+        end
+      }
+    end
+  end
+end

data/lib/orthor/category.rb

@@ -0,0 +1,16 @@
+module Orthor
+  class Category < Orthor::Object
+    include Orthor::Collections
+
+    dsl_accessor :page_path
+
+    def initialize(path, category_name, &block)
+      @feeds, @categories, @pages, @static_pages = [], [], [], []
+      super path, category_name, &block
+    end
+    
+    def fetch_content
+      Orthorings.category(@id)
+    end
+  end
+end

data/lib/orthor/collections.rb

@@ -0,0 +1,26 @@
+module Orthor
+  module Collections
+    attr_accessor :feeds, :categories, :pages, :static_pages
+
+    def feed(path, name = nil, &block)
+      feeds << Orthor::Feed.new(path, name, &block)
+    end
+
+    def category(path, name = nil, &block)
+      categories << Orthor::Category.new(path, name, &block)
+    end
+
+    def page(path, name = nil, &block)
+      pages << Orthor::Page.new(path, name, &block)
+    end
+
+    def static_page(path, name = nil, &block)
+      static_pages << Orthor::StaticPage.new(path, name, &block)
+    end 
+    
+    def resources
+      return [] unless @feeds && @pages && @static_pages && @categories
+      (@feeds + @pages + @static_pages + @categories + @categories.collect { |category| category.resources }).flatten
+    end
+  end
+end

data/lib/orthor/feed.rb

@@ -0,0 +1,7 @@
+module Orthor
+  class Feed < Orthor::Object
+    def fetch_content
+      Orthorings.feed(@id)
+    end
+  end
+end

data/lib/orthor/http_caching.rb

@@ -0,0 +1,15 @@
+module Orthor
+  module HttpCaching
+    def cache_for(time=nil)
+      if time
+        @cache_for = time
+      else
+        if @cache_for.nil?
+          Orthor::Site.cache_for
+        else
+          @cache_for
+        end
+      end
+    end
+  end
+end

data/lib/orthor/meta_data.rb

@@ -0,0 +1,19 @@
+module Orthor
+  module MetaData
+    [ :keywords, :description ].each do |sym|
+      class_eval %{
+        def #{sym}(*val)
+          if val.empty?
+            if @#{sym}.nil?
+              Orthor::Site.#{sym}
+            else
+              @#{sym}
+            end
+          else
+            @#{sym} = val.size == 1 ? val[0] : val
+          end
+        end
+      }
+    end
+  end
+end

data/lib/orthor/object.rb

@@ -0,0 +1,30 @@
+module Orthor
+  class Object
+    include Orthor::HttpCaching
+    include Orthor::MetaData
+
+    attr_accessor :path
+    dsl_accessor :name, :id
+
+    def initialize(path, object_name = nil, &block)
+      @path = path
+      raise "Path required" unless @path
+      @id = @path.split("/").last # by default, can be passed in
+      name(object_name)
+
+      instance_eval &block if block_given?
+    end
+    
+    def content
+      fetch_content
+    end
+    
+    def path_name
+      @id.gsub(/[^a-z0-9]+/i, '_')
+    end
+    
+    def fetch_content
+      raise "This must be overriden in any Orthor::Object subclass"
+    end
+  end
+end

data/lib/orthor/page.rb

@@ -0,0 +1,7 @@
+module Orthor
+  class Page < Orthor::Object
+    def fetch_content
+      Orthorings.content(@id)
+    end
+  end
+end

data/lib/orthor/site.rb

@@ -0,0 +1,29 @@
+module Orthor
+  class Site
+    class << self
+      include Orthor::Collections
+      include Orthor::HttpCaching
+      include Orthor::MetaData
+      
+      dsl_accessor :layout
+
+      def define(&block)
+        @feeds, @categories, @pages, @static_pages = [], [], [], []
+        layout(:orthor_layout) 
+        cache_for 0
+        keywords ""
+        description ""
+
+        class_eval &block
+      end
+      
+      def find_resource_by_path(path)
+        Orthor::Site.resources.detect { |r| r.path == path }
+      end
+      
+      def find_resource_by_page_path(path, id)
+        Orthor::Site.resources.detect { |r| r.is_a?(Orthor::Category) && r.page_path.gsub(":id", id) == path }
+      end
+    end
+  end
+end

data/lib/orthor/static_page.rb

@@ -0,0 +1,17 @@
+module Orthor
+  class StaticPage
+    include Orthor::HttpCaching
+    include Orthor::MetaData
+
+    attr_accessor :path
+    dsl_accessor :name
+
+    def initialize(path, page_name, &block)
+      @path = path
+      name(page_name)
+      raise "Path required" unless @path
+
+      instance_eval &block if block_given?
+    end
+  end
+end

data/lib/orthor.rb

@@ -0,0 +1,5 @@
+Dir[File.dirname(__FILE__) + '/core_ext/*.rb'].each { |e| require e }
+%w(orthor/http_caching orthor/meta_data orthor/collections orthor/site orthor/object orthor/category orthor/feed orthor/page orthor/static_page).each { |r| require File.join(File.dirname(__FILE__), r) }
+require File.join(File.dirname(__FILE__), 'orthorings')
+require File.join(File.dirname(__FILE__), 'orthor_helper')
+require 'moneta'

data/lib/orthor_helper.rb

@@ -0,0 +1,35 @@
+module OrthorHelper
+  def orthor_content(id)
+    return Orthorings.content(id)
+  end
+  
+  def orthor_category(id)
+    return Orthorings.category(id)
+  end
+  
+  def orthor_query(id)
+    return Orthorings.query(id)
+  end
+  
+  def orthor_feed(id)
+    return Orthorings.feed(id)
+  end
+  
+  def keywords
+    content = @meta_keywords || Orthor::Site.keywords
+    return if content.nil? || content.empty?
+    %Q(<meta content="#{content}" name="keywords" />)
+  end
+  
+  def description
+    content = @meta_description || Orthor::Site.description
+    return if content.nil? || content.empty?
+    %Q(<meta content="#{content}" name="description" />)
+  end
+  
+  def orthor_feed_tags
+    (Orthor::Site.feeds + (@orthor_feeds.nil? ? [] : @orthor_feeds)).inject("") do |html, feed|
+      html += %Q(<link rel="alternate" type="application/rss+xml" title="#{feed.name || "RSS"}" href="#{feed.path}" />)
+    end
+  end
+end

data/lib/orthorings.rb

@@ -0,0 +1,69 @@
+class Orthorings
+  require 'net/http'
+  
+  class << self
+    attr_accessor :account_id, :cache, :cache_expiry
+
+    def content(id)
+      get_content(id, "http://content.orthor.com/#{@account_id}/content_items/#{id}.html")
+    end
+  
+    def query(id)
+      get_content(id, "http://content.orthor.com/#{@account_id}/queries/#{id}.html")
+    end
+  
+    def category(id)
+      get_content(id, "http://content.orthor.com/#{@account_id}/categories/#{id}.html")
+    end
+    
+    def feed(id)
+      get_content(id, "http://content.orthor.com/#{@account_id}/feeds/#{id}.rss")
+    end
+    
+    def caching(file, expiry = 300, options = {})
+      klass = file.to_s.split('_').collect { |e| e.capitalize }.join
+      Moneta.autoload(klass.to_sym, "moneta/#{file}")
+      @cache = Moneta.const_get(klass).new(options)
+      @cache_expiry = expiry
+    end
+
+    def setup
+      @cache = false # default
+
+      yield self
+
+      raise "No orthor account id given... Please add one to your Orthorings setup block" if Orthorings.account_id.nil?
+      ActionView::Base.send(:include, OrthorHelper) if defined?(ActionView::Base) && !ActionView::Base.include?(OrthorHelper)
+    end
+    
+  private
+    def get_content(id, url)
+      if @cache
+        get_cached_content(id, url)
+      else
+        get_response(url)
+      end
+    end
+    
+    def get_cached_content(id, url)
+      content = @cache[id]
+      if content.empty?
+        content = get_response(url)
+        cache_content(id, content)
+      end
+      content
+    end
+    
+    def cache_content(id, content)
+      @cache.store(id, content, :expires_in => @cache_expiry) unless content.empty?
+    end
+  
+    def get_response(uri)
+      r = Net::HTTP.get_response(URI.parse(uri))
+      return (r.code.to_i == 200) ? r.body : ""
+    rescue 
+      return ""
+    end
+  end
+end
+

data/lib/sinatra/orthor.rb

@@ -0,0 +1,82 @@
+require 'sinatra/base'
+require 'erb'
+
+module Sinatra
+  module OrthorRequestHelpers
+    def handle_request(resource)
+      @name = resource.name
+      @meta_keywords = resource.keywords
+      @meta_description = resource.description
+      @orthor_feeds = resource.respond_to?(:feeds) ? resource.feeds : []
+      headers['Cache-Control'] = "public, max-age=#{resource.cache_for}"
+      erb :orthor_content, { :layout => ::Orthor::Site.layout }      
+    end
+  end
+  
+  module Orthor
+    def self.registered(app)
+      app.helpers ::OrthorHelper
+      app.helpers Sinatra::OrthorRequestHelpers
+      
+      ::Orthor::Site.resources.each do |resource|
+        if resource.is_a?(::Orthor::Category) && !resource.page_path.nil?
+          get resource.page_path do |id|
+            @orthor_content = orthor_content(id)
+            handle_request(resource)
+          end
+        end
+        
+        if resource.is_a?(::Orthor::Feed)
+          get resource.path do
+            headers['Cache-Control'] = "public, max-age=#{resource.cache_for}"
+            resource.content
+          end
+        else
+          get resource.path do
+            @orthor_content = resource.content
+            handle_request(resource)
+          end
+        end
+      end
+    end
+  end  
+  register Orthor
+end
+
+template :orthor_layout do
+%{<html>
+  <head>
+    <title><%= @name %> | Orthorings Default Layout</title>
+    <%= keywords %>
+    <%= description %>
+    <%= orthor_feed_tags %>
+    <style>
+    * { margin: 0; }
+    body { margin: 20px; font-family: helvetica,arial,sans-serif; color: #333; background-color: #fff; }
+    div, p { margin: 10px 0px; }
+    div.template-explanation { float: right; margin-left: 20px; }
+    div.template-explanation p { margin: 0; }
+    div.template-explanation pre { padding: 5px; background-color: #ccc; }
+    </style>
+  </head>
+  <body>
+    <div class="template-explanation">
+      <p>Tell Orthor about your own template:</p>
+<pre>
+  Orthor::Site.define do
+    layout :application
+    ...
+  end
+</pre>
+    </div>
+
+    <div class="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>}
+end
+
+template :orthor_content do
+  '<div class="orthor_content"><%= @orthor_content %></div>'
+end

data/orthorings.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{orthorings}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anthony Langhorne"]
+  s.date = %q{2009-09-28}
+  s.email = %q{anthony@orthor.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/orthor/content_controller.rb",
+     "app/views/layouts/orthor_layout.html.erb",
+     "app/views/orthor/content/orthor_content.html.erb",
+     "config/routes.rb",
+     "lib/core_ext/dsl_accessor.rb",
+     "lib/orthor.rb",
+     "lib/orthor/category.rb",
+     "lib/orthor/collections.rb",
+     "lib/orthor/feed.rb",
+     "lib/orthor/http_caching.rb",
+     "lib/orthor/meta_data.rb",
+     "lib/orthor/object.rb",
+     "lib/orthor/page.rb",
+     "lib/orthor/site.rb",
+     "lib/orthor/static_page.rb",
+     "lib/orthor_helper.rb",
+     "lib/orthorings.rb",
+     "lib/sinatra/orthor.rb",
+     "orthorings.gemspec",
+     "spec/orthor/dsl_spec.rb",
+     "spec/orthor_helper_spec.rb",
+     "spec/orthorings_spec.rb",
+     "spec/resources/homepage.html",
+     "spec/resources/latest-news-items.html",
+     "spec/resources/news.html",
+     "spec/sinatra/orthor_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/anthony/orthorings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Orthorings is a gem for displaying content from orthor.com}
+  s.test_files = [
+    "spec/orthor/dsl_spec.rb",
+     "spec/orthor_helper_spec.rb",
+     "spec/orthorings_spec.rb",
+     "spec/sinatra/orthor_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<moneta>, ["= 0.6.0"])
+    else
+      s.add_dependency(%q<moneta>, ["= 0.6.0"])
+    end
+  else
+    s.add_dependency(%q<moneta>, ["= 0.6.0"])
+  end
+end

data/spec/orthor/dsl_spec.rb

@@ -0,0 +1,362 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Orthor::Site, "orthor site dsl" do
+  describe "base attributes" do
+    before(:all) do
+      Orthor::Site.define do
+        cache_for 7200
+        layout :application
+      end
+    end
+    
+    it 'should allow a http cache time to be set' do
+      Orthor::Site.cache_for.should == 7200
+    end
+    
+    it 'should allow setting of a layout' do
+      Orthor::Site.layout.should == :application
+    end
+    
+    [ :categories, :feeds, :pages, :static_pages ].each do |collection|
+      it "should have a #{collection} array" do
+        Orthor::Site.send(collection).should == []
+      end
+    end
+  end
+  
+  describe "default values" do
+    before(:all) do
+      Orthor::Site.define do
+      end
+    end
+    
+    it 'should set a default cache for time' do
+      Orthor::Site.cache_for.should == 0
+    end
+    
+    it 'should set a default layout' do
+      Orthor::Site.layout.should == :orthor_layout
+    end
+  end
+  
+  describe "children" do
+    before(:all) do
+      Orthor::Site.define do
+        page "/", "Home"
+        
+        category "/writings" do
+          page "/writings/why", "Why we write"
+
+          feed "/writings.rss" do
+            id "our-writings"
+            name "Our Writings"
+          end
+
+          category "/writings/announcements" do
+            page "/3rd-level", "3rd level"
+          end
+        end
+      end  
+      @category_1 = Orthor::Site.categories.first
+      @category_2 = @category_1.categories.first
+      @feed = @category_1.feeds.first
+      @page_1 = Orthor::Site.pages.first
+      @page_2 = @category_1.pages.first
+      @page_3 = @category_2.pages.first
+    end
+    
+    it 'should return all resources defined in the dsl' do
+      Orthor::Site.resources.length.should == 6
+      
+      Orthor::Site.resources.should include(@category_1)
+      Orthor::Site.resources.should include(@category_2)
+      Orthor::Site.resources.should include(@feed)
+      Orthor::Site.resources.should include(@page_1)
+      Orthor::Site.resources.should include(@page_2)
+      Orthor::Site.resources.should include(@page_3)  
+    end
+  end
+  
+  describe "categories" do
+    before(:all) do
+      Orthor::Site.define do
+        category "/writings" do
+          page_path "/writings/:id"
+          name "Writings"
+          id "blog-writings"
+          cache_for 900
+
+          page "/writings/why" do
+            name "Why we write"
+          end
+
+          feed "/writings.rss" do
+            id "our-writings"
+            name "Our Writings"
+          end
+
+          category "/writings/announcements" do
+            page_path "/writings/announcements/:id"
+            name "Announcements"
+            cache_for 300
+            
+            page "/3rd-level" do
+              name "3rd level"
+            end
+          end
+        end
+      end
+      @category = Orthor::Site.categories.first
+      @category_2 = Orthor::Site.categories.first.categories.first
+    end
+  
+    it "should have one categories" do
+      Orthor::Site.categories.length.should == 1
+      @category.name.should == "Writings"
+    end
+    
+    it "should support categories in categories" do
+      @category.categories.length.should == 1
+      @category_2.name.should == "Announcements"
+    end
+    
+    it "should support pages in categories" do
+      @category.pages.length.should == 1
+      @category.pages.first.name.should == "Why we write"
+    end
+    
+    it "id should be inferred from the path if none is given" do
+      @category_2.id.should == "announcements"
+    end
+    
+    it "should support pages in categories in categories" do
+      @category_2.pages.length.should == 1
+      @category_2.pages.first.name.should == "3rd level"
+    end
+    
+    it "should support a child page path attribute" do
+      @category.page_path.should == "/writings/:id"
+    end
+    
+    it "should support setting the orthor id" do
+      @category.id.should == "blog-writings"
+    end
+    
+    it "should support specifying http cache time" do
+      @category.cache_for.should == 900
+      @category_2.cache_for.should == 300
+    end
+    
+    it "should support feeds specific to categories" do
+      @category.feeds.length.should == 1
+      @category.feeds.first.name.should == "Our Writings"
+    end
+  end
+  
+  describe "pages" do
+    before(:all) do
+      Orthor::Site.define do
+        page "/about-us", "About us"
+        page "/contact", "Contact Us"
+        page "/" do
+          name "Home"
+          cache_for 3600
+          id "homepage"
+        end
+      end
+      @page_1 = Orthor::Site.pages[0]
+      @page_2 = Orthor::Site.pages[1]
+      @page_3 = Orthor::Site.pages[2]
+    end
+      
+    it 'should support multiple pages' do
+      Orthor::Site.pages.length.should == 3
+    end
+    
+    it 'should support specifying pages with or without a block' do
+      @page_1.name.should == "About us"
+      @page_1.path.should == "/about-us"
+      
+      @page_3.name.should == "Home"
+      @page_3.path.should == "/"
+    end
+    
+    it "id should be inferred from the path if none is given" do
+      @page_1.id.should == "about-us"
+      @page_2.id.should == "contact"
+    end
+    
+    it 'should allow setting specific http cache lengths' do
+      @page_1.cache_for.should == 0 # sites default
+      @page_3.cache_for.should == 3600
+    end
+    
+    it 'should support setting an id' do
+      @page_3.id.should == "homepage"
+    end
+  end
+  
+  describe "feeds" do
+    before(:all) do
+      Orthor::Site.define do
+        feed "/blog.rss" do
+          id "orthor-blog"
+          name "Our blag"
+        end
+        
+        feed "/bookmarks.rss" do
+          name "Our bookmarks"
+        end
+      end
+      
+      @feed_1 = Orthor::Site.feeds.first
+      @feed_2 = Orthor::Site.feeds.last
+    end
+    
+    it "should support multiple feeds" do
+      Orthor::Site.feeds.length.should == 2
+    end
+    
+    it "should support setting a feeds id" do
+      @feed_1.id.should == "orthor-blog"
+    end
+    
+    it "id should be inferred from the path if none is given" do
+      @feed_2.id.should == "bookmarks.rss"
+    end
+    
+    it 'should support setting a feeds name' do
+      @feed_1.name.should == "Our blag"
+      @feed_2.name.should == "Our bookmarks"
+    end
+    
+    it 'should store the given path' do
+      @feed_1.path.should == "/blog.rss"
+      @feed_2.path.should == "/bookmarks.rss"
+    end
+  end
+  
+  describe 'static pages' do
+    before(:all) do
+      Orthor::Site.define do
+        static_page "/about-us", "About us"
+        static_page "/contact", "Contact Us"
+        static_page "/" do
+          name "Home"
+          cache_for 3600
+        end
+      end
+      @page_1 = Orthor::Site.static_pages[0]
+      @page_2 = Orthor::Site.static_pages[1]
+      @page_3 = Orthor::Site.static_pages[2]
+    end
+      
+    it 'should support multiple pages' do
+      Orthor::Site.static_pages.length.should == 3
+    end
+    
+    it 'should support specifying pages with or without a block' do
+      @page_1.name.should == "About us"
+      @page_1.path.should == "/about-us"
+      
+      @page_3.name.should == "Home"
+      @page_3.path.should == "/"
+    end
+    
+    it 'should allow setting specific http cache lengths' do
+      @page_3.cache_for.should == 3600
+    end
+  end
+  
+  describe 'finding by path' do
+    before(:all) do
+      Orthor::Site.define do
+        page "/", "Home"
+        
+        category "/writings" do
+          page_path "/writings/:id"
+          page "/writings/why", "Why we write"
+
+          feed "/writings.rss" do
+            id "our-writings"
+            name "Our Writings"
+          end
+
+          category "/writings/announcements" do
+            page_path "/writings/announcements/:id"
+            page "/3rd-level", "3rd level"
+          end
+        end
+      end
+      @home = Orthor::Site.pages.first
+      @writings = Orthor::Site.categories.first
+      @feed = @writings.feeds.first
+      @announcements = @writings.categories.first
+      @third_level = @announcements.pages.first
+    end
+    
+    it 'should be able to find pages by path' do
+      Orthor::Site.find_resource_by_path("/").should == @home
+      Orthor::Site.find_resource_by_path("/3rd-level").should == @third_level
+    end
+    
+    it 'should be able to find feeds by path' do
+      Orthor::Site.find_resource_by_path("/writings.rss").should == @feed
+    end
+    
+    it 'should be able to find categories by path' do
+      Orthor::Site.find_resource_by_path("/writings").should == @writings
+      Orthor::Site.find_resource_by_path("/writings/announcements").should == @announcements
+    end
+    
+    it 'should find the parent category by page path' do
+      Orthor::Site.find_resource_by_page_path("/writings/announcements/first-entry", "first-entry").should == @announcements
+      Orthor::Site.find_resource_by_page_path("/writings/first-writing", "first-writing").should == @writings
+    end
+  end
+  
+  describe 'meta data' do
+    before(:all) do
+      Orthor::Site.define do
+        keywords "asdf, bob, frank"
+        description "a site being defined"
+        
+        page "/features", "Features" do
+          keywords "features"
+          description "feature page description"
+        end
+        
+        category "/news", "News" do
+          keywords "category"
+          description "category description"
+        end
+        
+        page "/ihavenothing"
+      end
+      
+      @page_with_meta = Orthor::Site.pages.first
+      @category = Orthor::Site.categories.first
+      @page_no_meta = Orthor::Site.pages.last
+    end
+    
+    it 'should allow setting of meta data at a site level' do
+      Orthor::Site.keywords.should == "asdf, bob, frank"
+      Orthor::Site.description.should == "a site being defined"
+    end
+    
+    it 'should allow setting of meta data at a page level' do
+      @page_with_meta.keywords.should == "features"
+      @page_with_meta.description.should == "feature page description"
+    end
+    
+    it 'should allow setting of meta data at a category level' do
+      @category.keywords.should == "category"
+      @category.description.should == "category description"
+    end
+    
+    it 'should default to sites meta data if none given' do
+      @page_no_meta.keywords.should == "asdf, bob, frank"
+      @page_no_meta.description.should == "a site being defined"
+    end
+  end
+end

data/spec/orthor_helper_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe OrthorHelper do
+  include OrthorHelper
+  
+  describe 'default meta tag handling' do
+    before(:all) do
+      Orthor::Site.define do
+        keywords "site keywords"
+        description "site description"
+      end  
+    end
+  
+    it 'should return a meta tag for keywords' do
+      keywords.should == %Q(<meta content="site keywords" name="keywords" />)
+    end
+  
+    it 'should return a meta tag for description' do
+      description.should == %Q(<meta content="site description" name="description" />)
+    end
+    
+    it 'should use @meta_keywords when exists' do
+      @meta_keywords = "asdf"
+      keywords.should == %Q(<meta content="asdf" name="keywords" />)
+    end
+    
+    it 'should use @meta_description when exists' do
+      @meta_description = "asdf"
+      description.should == %Q(<meta content="asdf" name="description" />)
+    end
+  end
+  
+  describe 'feed links' do
+    before(:all) do
+      Orthor::Site.define do
+        keywords "site keywords"
+        description "site description"
+
+        feed "/news.rss", "News"
+
+        category "/writings" do
+          feed "/writings.rss" do
+            id "our-writings"
+            name "Writings"
+          end
+        end
+      end  
+      @feed_2 = Orthor::Site.categories.first.feeds.first
+      @feed = Orthor::Site.feeds.first
+    end
+    
+    it 'should generate a list of link tags rss feeds' do
+      orthor_feed_tags.should == %Q(<link rel="alternate" type="application/rss+xml" title="News" href="/news.rss" />)
+    end
+    
+    it 'should generate additional links when @orthor_feeds is set' do
+      @orthor_feeds = [ @feed_2 ]
+      orthor_feed_tags.should == %Q(<link rel="alternate" type="application/rss+xml" title="News" href="/news.rss" /><link rel="alternate" type="application/rss+xml" title="Writings" href="/writings.rss" />)
+    end
+  end
+end

data/spec/orthorings_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'moneta/memory'
+
+describe Orthorings, "fetching content" do
+  before(:all) do
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/content_items/homepage.html", :body => File.join(SPEC_DIR, 'resources', 'homepage.html'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/queries/latest-news-items.html", :body => File.join(SPEC_DIR, 'resources', 'latest-news-items.html'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/news.html", :body => File.join(SPEC_DIR, 'resources', 'news.html'))
+    
+    Orthorings.setup do |config|
+      config.account_id = "orthor"
+    end
+  end
+  
+  it 'should be able to fetch content items' do
+    Orthorings.content("homepage").include?("<h2>So what is Orthor anyway?</h2>").should be_true
+  end
+  
+  it 'should be able to fetch queries' do
+    Orthorings.query("latest-news-items").include?("Comparisons to traditional Content Management").should be_true
+  end
+  
+  it 'should be able to fetch categories' do
+    Orthorings.category("news").include?("<h2>Orthor's Features </h2>").should be_true
+  end
+  
+  it 'should not cache content if no config is given' do
+    Orthorings.cache.should == false
+  end
+end
+
+describe Orthorings, "caching content" do
+  before(:all) do
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/content_items/homepage.html", :body => File.join(SPEC_DIR, 'resources', 'homepage.html'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/queries/latest-news-items.html", :body => File.join(SPEC_DIR, 'resources', 'latest-news-items.html'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/news.html", :body => File.join(SPEC_DIR, 'resources', 'news.html'))
+    
+    Orthorings.setup do |config|
+      config.account_id = "orthor"
+      config.caching :memory
+    end
+  end
+  
+  it 'expiry should default to 300 seconds if none is given' do
+    Orthorings.cache_expiry.should == 300
+  end
+  
+  it 'should add content to the cache after requests' do
+    Orthorings.cache["homepage"].should be_empty
+    Orthorings.content("homepage")
+    Orthorings.cache["homepage"].should_not be_empty
+    
+    Orthorings.should_not_receive(:cache_content)
+    Orthorings.content("homepage")
+  end
+end

data/spec/resources/homepage.html

@@ -0,0 +1,11 @@
+<h2>So what is Orthor anyway?</h2>
+<p>Orthor is a web content management system that requires no additional software installation!. You can get up and running in a matter of minutes. Orthor is built to be reliable, priced to be affordable and above all - it's real easy to use. Designed from the ground up to fit the Software as a Service model, Orthor gives you all the tools you need to manage content on your new or existing site.</p>
+<p>With Orthor you dont have to install complicated software or buy any hardware</p>
+<p>&nbsp;</p>
+<h2>Comparisons to Traditional Content Management</h2>
+<p>Jarrod has recently written a great overview of how Orthor contrasts to existing Content management systems, its a great <a href="http://blog.orthor.com/2009/06/15/comparisons-to-traditional-content-management/" title="Orthor - Simple content management">overview</a>.</p>
+<p>With all the growth and change in this market many CMS products still follow the principle of &lsquo;complete ownership&lsquo;. This principle mandates that the CMS will control the life cycle of each page, asset, and content item presented on your site. This results in you having to define content types, presentation templates, navigational structures inside of the CMS. You may also need to force your development staff (or development agency) to build custom site functions using technologies that the CMS vendor tells you to. For me that is way too much control to hand over to someone else (but then again maybe Im just a control freak).</p>
+
+<p>It is on this point of &lsquo;complete control&lsquo; that Orthor strays from the pack. We do not attempt to own your site and we certainly don&rsquo;t dictate how you go about building your custom functions. Orthor focuses completely on only managing the content that is presented on your site. To put it more simply, you control the web pages and Orthor controls the content that is presented on those pages.</p>
+<p>Read the whole post <a href="http://blog.orthor.com/2009/06/15/comparisons-to-traditional-content-management/" title="Orthor - Simple content management">here</a></p>
+<p>&nbsp;</p>

data/spec/resources/latest-news-items.html

@@ -0,0 +1 @@
+<div><a href="http://blog.orthor.com/2009/06/15/comparisons-to-traditional-content-management/" title="Comparisons to traditional Content Management">Comparisons to traditional Content Management</a></div><div><a href="http://blog.orthor.com/2009/06/21/orthors-features/" title="Orthor's Features">Orthor's Features</a></div><div><a href="http://blog.orthor.com/2009/06/29/we-are-live/" title="Orthor is live and accepting signups!">Orthor is live and accepting signups!</a></div>

data/spec/resources/news.html

@@ -0,0 +1,5 @@
+<h2>Orthor's Features </h2><div><p>So today I thought we should take a quick tour of Orthor&rsquo;s features. In a series of upcoming posts I will explain each feature in more detail and present ideas and suggestions how each can be used to benefit you. If you have read previous posts you&rsquo;ll have picked up that Orthor is built with a single purpose, &lsquo;<em>to manage your content and not your site</em>&lsquo;. That means you wont find any fancy features to alter site navigation, add sub-sites, build custom forms etc. All Orthor&rsquo;s features are specific to creating, managing, publishing and retrieving content.</p>
+<p>Read the whole article <a href="http://blog.orthor.com/2009/06/21/orthors-features/">here</a>.</p>
+ </div><h2>Orthor is live and accepting signups! </h2><div><p>Just a quick note to announce that we are now officially live. All our plans are now available <a href="https://orthor.com/pricing_signup" title="Orthor subscription plans">here</a>. This marks a small milestone for us in getting Orthor up and running. We can now move onto implementing some more great features that we have on our road map.</p> </div><h2>Comparisons to traditional Content Management </h2><div><p>Over the last five plus years it seems that a new CMS has popped into the scene on an almost daily basis. The CMS market is completely saturated with products and services, so much so that it is quite an ordeal to select one. I firmly believe that a saturated market is a good thing for the consumer, just look at the amount of choice you have. Regardless of what web technology underpins your organization, what your budget constraints are, what your in-house skills are there is bound to be a CMS out there for you</p>
+
+          <p>Read the whole article <a href="http://blog.orthor.com/2009/06/15/comparisons-to-traditional-content-management/">here</a>.</p> </div>

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'spec'
+require 'fake_web'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'orthor')
+
+SPEC_DIR = File.dirname(__FILE__) unless defined? SPEC_DIR

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: orthorings
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anthony Langhorne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-28 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: moneta
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+description: 
+email: anthony@orthor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- app/controllers/orthor/content_controller.rb
+- app/views/layouts/orthor_layout.html.erb
+- app/views/orthor/content/orthor_content.html.erb
+- config/routes.rb
+- lib/core_ext/dsl_accessor.rb
+- lib/orthor.rb
+- lib/orthor/category.rb
+- lib/orthor/collections.rb
+- lib/orthor/feed.rb
+- lib/orthor/http_caching.rb
+- lib/orthor/meta_data.rb
+- lib/orthor/object.rb
+- lib/orthor/page.rb
+- lib/orthor/site.rb
+- lib/orthor/static_page.rb
+- lib/orthor_helper.rb
+- lib/orthorings.rb
+- lib/sinatra/orthor.rb
+- orthorings.gemspec
+- spec/orthor/dsl_spec.rb
+- spec/orthor_helper_spec.rb
+- spec/orthorings_spec.rb
+- spec/resources/homepage.html
+- spec/resources/latest-news-items.html
+- spec/resources/news.html
+- spec/sinatra/orthor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/anthony/orthorings
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Orthorings is a gem for displaying content from orthor.com
+test_files: 
+- spec/orthor/dsl_spec.rb
+- spec/orthor_helper_spec.rb
+- spec/orthorings_spec.rb
+- spec/sinatra/orthor_spec.rb
+- spec/spec_helper.rb