orthorings 0.3.1 → 0.4.0

data/README.markdown

@@ -5,13 +5,13 @@ 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
+* Display content on any page in your app using the included helper methods
 
 ## Installation
 
-As a gem 
-    
-    gem install orthorings 
+As a gem
+
+    gem install orthorings
 
 ## Configuration
 
@@ -31,63 +31,128 @@ To make creating a new site backed by Orthor super easy, we've included a DSL th
 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"
-
-      feed "/blog.rss", "our-blog" do
-        name "Our Blog Feed"
-      end
-      
-      static_page "/about-us" do
-        view "public/about_us"
+      layout :layout
+      keywords "cms, content management, pluggable"
+      description "pluggable content management service"
+
+      with_template :basic_content do
+        page "/",        :id => "what-is-orthor", :view => :home
+        page "/about"
+        page "/terms"
+        page "/contact", :view => :contact
       end
 
-      query "/latest-news"
-  
-      category "/writings" do
-        keywords "lets, do, some, seo"
-        description "a more apt description for this section of the site"
-        view "writings/index"
-        
-        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
-          view "writings/announcements"
-          page_path "/writings/announcements/:id"
-        end
-      end
+      feed "/news_and_blog.rss", :id => "news-blog-entries"
+      feed "/news.rss",          :id => "news"
+      feed "/blog.rss",          :id => "blog"
+      feed "/manual.rss",        :id => "manual"
+
+      category "/manual", :page_path => "/manual/:id",
+                          :template  => :user_manual
+      category "/news", :template      => :news_item
+      category "/blog", :template      => :blog_entry_brief,
+                        :page_path     => "/blog/:id",
+                        :page_template => :blog_entry
     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. 
+### Options
+
+    :id           - the orthor id of your element
+    :view         - specify the path to a view file you'd like to render this content with
+    :template     - the template to use when rendering your content
+    :keywords     - what meta keywords you'd like to use on this page
+    :description  - what meta description you'd like shown on this page
+
+#### Category specific
+
+    :page_path     - what path to use for your pages inside a category
+    :page_template - what template to use to display a page inside a category
+
+#### Feed specific
+
+    :name         - The name of your feed, used in the feed_helpers
+
+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.
+## Templates
+
+Your content from Orthor comes down in JSON, so for every piece of content you want to display, you need to provide a HTML template. Some example templates are shown below. Every piece of content you get back has the same attributes (e.g. "Published on", "Created by") plus every content widget on your template indexed by name.
+
+When you define your pages etc, you can tell it which template to use with a :template argument. If you use the helper methods (explained below) you can pass in the template name.
+
+    Orthor::Templates.define do
+      template :basic_content, %(<div>{{Content}}</div>)
+
+      template :blog_entry, %(
+        <div class="blog-entry">
+          <h2>{{Title}}</h2>
+          <div class="blog-content">{{Wysiwyg}}</div>
+        </div>)
+      template :blog_entry_brief, %(
+        <div class="blog-entry">
+          <h2><a href="{{URL}}">{{Title}}</a></h2>
+          <div class="blog-content">{{Wysiwyg.blurb}}</div>
+        </div>)
+
+      template :user_manual, %(
+        <div class="user-manual-entry">
+          <h2>{{Title}}</h2>
+          <p class="last-updated">Last updated: {{Updated on}}</p>
+          <div class="content">{{Wysiwyg}}</div>
+        </div>)
+    end
 
-## TODO
 
-Things that are being mulled over
+### Template tags
+
+These tags are available to all content:
+
+    {{Title}}        - your content title
+    {{Created on}}   - the date your content was created
+    {{Updated on}}   - the date your content was last updated
+    {{Created by}}   - a hash of the creator details
+    {{Updated by}}   - a hash of the updater details
+    {{Published on}} - the date your content was published
+    {{URL}}          - the URL for your content as defined in Orthor, or auto generated as /category-id/content-id
+
+Other attributes that will be present on a per item specific basis are the names of your template elements, e.g.
+
+    {{Content}}
+    {{Featured News Item}}
+    {{Supporting Image}}
+    {{Markdown body}}
 
-* Nav helpers (generate navigation based off of the DSL structure)
-* ...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")
+In all the methods below, if you don't provide a template name, you will get the parsed JSON array/hash back.
+
+### Content
+
+    orthor_content("content-item-id", :template_name)
+    Orthorings.content("id", :template_name)
+
+### Queries
+
+    orthor_query("query-id", :template_name)
+    Orthorings.query("id", :template_name)
+
+### Categories
+
+    orthor_category("category-id", :template_name)
+    Orthorings.category("id", :template_name)
+
+### Feeds
+
     orthor_feed("feed-id") or Orthorings.feed("id")
 
+### Meta data
+
+    keywords         - render a <meta> keywords tag for the current piece of content (or the default site keywords)
+    description      - render a <meta> description tag for the current piece of content (or the default site description)
+    orthor_feed_tags - render a <link> tag for all of your defined feeds
+
 
 Copyright (c) 2009 Robotic Foo, released under the MIT license

data/Rakefile

@@ -6,11 +6,12 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "orthorings"
-    gem.summary = "Orthorings is a gem for displaying content from orthor.com"
+    gem.summary = "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")
+    gem.add_dependency("json")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -21,4 +22,4 @@ 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
+end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/app/controllers/orthor_content_controller.rb

@@ -1,15 +1,15 @@
 class OrthorContentController < 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 
+      @orthor_content = Orthorings.content(params[:id], (resource.page_template || resource.template))
+    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
@@ -17,7 +17,7 @@ class OrthorContentController < ApplicationController
       @meta_keywords = resource.keywords
       @meta_description = resource.description
       @orthor_feeds = resource.respond_to?(:feeds) ? resource.feeds : []
-      
+
       render :action => (resource.view || "orthor_content"), :layout => Orthor::Site.layout.to_s
     end
   end

data/lib/orthor/category.rb

@@ -2,15 +2,18 @@ module Orthor
   class Category < Orthor::Object
     include Orthor::Collections
 
-    dsl_accessor :page_path
+    dsl_accessor :page_path, :page_template
 
-    def initialize(path, category_name, &block)
+    def initialize(path, options = {}, &blk)
       @feeds, @categories, @pages, @static_pages, @queries = [], [], [], [], []
-      super path, category_name, &block
+      super path, options
+
+      # categories can give blocks
+      instance_eval &blk if block_given?
     end
-    
+
     def fetch_content
-      Orthorings.category(@id)
+      Orthorings.category(@id, @template)
     end
   end
 end

data/lib/orthor/collections.rb

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

data/lib/orthor/object.rb

@@ -4,24 +4,25 @@ module Orthor
     include Orthor::MetaData
 
     attr_accessor :path
-    dsl_accessor :name, :id, :view
+    dsl_accessor :id, :view, :template, :name
 
-    def initialize(path, id = nil, &block)
+    def initialize(path, options = {})
       @path = path
-      raise "Path required" unless @path
-      @id = id || @path.split("/").last
+      raise ArgumentError, "Path required" unless @path
 
-      instance_eval &block if block_given?
+      options.each { |key, val| send(key, val) }
+      @id ||= @path.split("/").last
+      @template ||= Orthor::Site.current_template
     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

data/lib/orthor/page.rb

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

data/lib/orthor/query.rb

@@ -1,7 +1,7 @@
 module Orthor
   class Query < Orthor::Object
     def fetch_content
-      Orthorings.query(@id)
+      Orthorings.query(@id, @template)
     end
   end
 end

data/lib/orthor/site.rb

@@ -4,23 +4,31 @@ module Orthor
       include Orthor::Collections
       include Orthor::HttpCaching
       include Orthor::MetaData
-      
+
       dsl_accessor :layout
+      attr_accessor :current_template
 
-      def define(&block)
+      def define(&blk)
         @feeds, @categories, @pages, @static_pages, @queries = [], [], [], [], []
-        layout(:orthor_layout) 
+        layout(:orthor_layout)
         cache_for 0
         keywords ""
         description ""
 
-        class_eval &block
+        class_eval &blk
+      end
+
+      def with_template(name, &blk)
+        raise ArgumentError, "block required" unless block_given?
+        @current_template = name
+        class_eval &blk
+        @current_template = nil
       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

data/lib/orthor/static_page.rb

@@ -4,14 +4,13 @@ module Orthor
     include Orthor::MetaData
 
     attr_accessor :path
-    dsl_accessor :name, :view, :controller
+    dsl_accessor :view, :controller
 
-    def initialize(path, page_name, &block)
+    def initialize(path, options = {})
       @path = path
-      name(page_name)
-      raise "Path required" unless @path
+      raise ArgumentError, "Path required" unless @path
 
-      instance_eval &block if block_given?
+      options.each { |key, val| send(key, val) }
     end
 
     def path_name

data/lib/orthor/templates.rb

@@ -0,0 +1,22 @@
+module Orthor
+  class Templates
+    class << self
+      attr_accessor :templates
+
+      def define(&blk)
+        @templates = {}
+        class_eval &blk
+      end
+
+      def template(name, markup)
+        @templates[name.to_s] = markup
+      end
+      alias :add :template
+
+      def [](key)
+        @templates ||= {}
+        @templates[key.to_s]
+      end
+    end
+  end
+end

data/lib/orthor_helper.rb

@@ -1,32 +1,32 @@
 module OrthorHelper
-  def orthor_content(id)
-    return Orthorings.content(id)
+  def orthor_content(id, template = nil)
+    return Orthorings.content(id, template)
   end
-  
-  def orthor_category(id)
-    return Orthorings.category(id)
+
+  def orthor_category(id, template = nil)
+    return Orthorings.category(id, template)
   end
-  
-  def orthor_query(id)
-    return Orthorings.query(id)
+
+  def orthor_query(id, template = nil)
+    return Orthorings.query(id, template)
   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}" />)

data/lib/orthorings.rb

@@ -1,33 +1,44 @@
-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 orthor/query).each { |r| require File.join(File.dirname(__FILE__), r) }
+require 'core_ext/dsl_accessor'
+
+require 'orthor/http_caching'
+require 'orthor/templates'
+require 'orthor/meta_data'
+require 'orthor/collections'
+require 'orthor/site'
+require 'orthor/object'
+require 'orthor/category'
+require 'orthor/feed'
+require 'orthor/page'
+require 'orthor/static_page'
+require 'orthor/query'
+require 'orthor_helper'
 
-require File.join(File.dirname(__FILE__), 'orthorings')
-require File.join(File.dirname(__FILE__), 'orthor_helper')
 require 'moneta'
+require 'json'
 
 class Orthorings
   require 'net/http'
-  
+
   class << self
     dsl_accessor :account_id
     attr_accessor :cache, :cache_expiry
 
-    def content(id)
-      get_content("content:#{id}", "http://content.orthor.com/#{@account_id}/content_items/#{id}.html")
+    def content(id, template = nil)
+      render(:content_items, id, template)
     end
-  
-    def query(id)
-      get_content("query#{id}", "http://content.orthor.com/#{@account_id}/queries/#{id}.html")
+
+    def query(id, template = nil)
+      render(:queries, id, template)
     end
-  
-    def category(id)
-      get_content("category#{id}", "http://content.orthor.com/#{@account_id}/categories/#{id}.html")
+
+    def category(id, template = nil)
+      render(:categories, id, template)
     end
-    
+
     def feed(id)
-      get_content("feed#{id}", "http://content.orthor.com/#{@account_id}/feeds/#{id}.rss")
+      render(:feeds, id)
     end
-    
+
     def caching(file, expiry = 300, options = {})
       klass = file.to_s.split('_').collect { |e| e.capitalize }.join
       Moneta.autoload(klass.to_sym, "moneta/#{file}")
@@ -36,7 +47,7 @@ class Orthorings
     end
 
     def setup(&block)
-      raise "Block required" unless block_given?
+      raise ArgumentError unless block_given?
       @cache = false # default
 
       class_eval &block
@@ -44,7 +55,7 @@ class Orthorings
       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
@@ -53,7 +64,7 @@ class Orthorings
         get_response(url)
       end
     end
-    
+
     def get_cached_content(id, url)
       content = @cache[id]
       if content.empty?
@@ -62,17 +73,54 @@ class Orthorings
       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 ""
+      r.code.to_i == 200 ? r.body : ""
+    rescue => e
+      ""
+    end
+
+    def render(type, id, template = nil)
+      suffix = type == :feeds ? "rss" : "json"
+      resp = get_content(id, "http://content.orthor.com/#{@account_id}/#{type}/#{id}.#{suffix}")
+
+      return resp unless suffix == "json"
+
+      begin
+        json = JSON.parse(resp)
+
+        template = Orthor::Templates[template]
+        return json unless template
+
+        # ensure we're dealing with an array
+        unless json.is_a?(Array)
+          if json["type"] == "category"
+            json = json["content"]
+          else
+            json = [json]
+          end
+        end
+        json.collect do |c|
+          c.inject(template) do |html, (key, val)|
+            # if val.is_a?(Hash)
+            if html.include?("{{#{key}.blurb}}")
+              val = "#{val.to_s.gsub(/<\/?[^>]*>/, "")[0..150]}..."
+              key = "#{key}.blurb"
+            end
+
+            html = html.gsub("{{#{key}}}", val.to_s)
+          end
+        end.join("")
+      rescue => e
+        return ""
+      end
     end
   end
 end
 
+