orthor 0.1.0 → 0.1.1

data/README.md

@@ -4,8 +4,6 @@ The Orthor gem is used to fetch and display your content from orthor.com
 
 ## Installation
 
-Is easy
-
     gem install orthor
 
 ## Configuration
@@ -14,41 +12,36 @@ Add the below to a file and require it:
 
     Orthor.setup do
       account "orthor"     # your orthor account id
-      caching :memory, 600 # cache content in memory for 10 minutes
+      caching :basic_file, 300, :path => "tmp/" # cache content in tmp/ for 5 mins
     end
 
-You can specify any Moneta cache store class name, e.g. basic_file, memcache etc. The (optional) second argument is cache expiry in seconds, you can provide any initialize options you want as the 3rd arg, e.g.:
-
-    Orthor.setup do
-      account "bob"
-      caching :basic_file, 300, :path => "tmp/"
-    end
+You can specify any Moneta cache store you like, e.g. basic_file, memcache etc. The (optional) second argument is cache expiry in seconds, you can provide any initialize options required by your cache store as the 3rd arg.
 
 ## Usage
 
-The first argument to all these methods is the orthor-id of your piece of content/category etc. The second argument is the name of a template (see below) to use to render the returned content.
-
-If you do not provide a template_name to render your content with, you will get the parsed JSON back.
-
-### Content
+#### Content
 
     Orthor.content("id", :template_name)
 
-### Queries
+#### Queries
 
     Orthor.query("id", :template_name)
 
-### Categories
+#### Categories
 
     Orthor.category("id", :template_name)
 
-### Feeds
+#### Feeds
 
     Orthor.feed("id")
 
+The first argument to all these methods is the orthor-id of your piece of content/category etc. The second argument is the name of a template (see below) to use to render the returned content.
+
+If you do not provide a template_name to render your content with, you will get the parsed JSON back.
+
 ## Templates
 
-Orthor returns all of your content in JSON so to make the job of translating JSON -> HTML, we provide some templating help:
+Orthor returns all of your content in JSON so to make the job of translating JSON -> HTML easier, we provide some templating help:
 
     Orthor::Templates.define do
       template :basic_content, %(<div>{{Content}}</div>)
@@ -71,10 +64,28 @@ Orthor returns all of your content in JSON so to make the job of translating JSO
           <p class="last-updated">Last updated: {{Updated on}}</p>
           <div class="content">{{Wysiwyg}}</div>
         </div>)
+
+      mapping :detail_templates, {
+        "Blog Post"   => :blog_entry,
+        "User Manual" => :user_manual
+      }
     end
 
 Now any call you make to Orthor.content/category/query can be given a 2nd argument of a template name and rather than receiving parsed JSON, you will be returned a HTML string.
 
+### Named template mappings
+
+For the times when you have a category or query that returns multiple types of content (e.g. a tumblr like blog with bookmarks, quotes etc), you can provide a named template mapping.
+
+As an example if this was your template mapping:
+
+    mapping :blog_types, {
+      "Bookmark" => :bookmark_detail,
+      "Quote"    => :quote_detail
+    }
+
+A call to Orthor.category("blog", :blog_types) means that any content item using the "Bookmark" template will render using the bookmark_detail template.
+
 ### Default template tags
 
 These tags are available to all content:
@@ -105,5 +116,5 @@ anthony@orthor.com
 
 [Orthor demo site](http://github.com/anthony/orthor-demo)
 
-Copyright (c) 2009 Robotic Foo, released under the MIT license
+Copyright (c) 2010 Robotic Foo, released under the MIT license
 

data/lib/orthor.rb

@@ -1,3 +1,6 @@
+# setup utf-8 support
+$KCODE = 'u' if RUBY_VERSION < '1.9'
+
 require 'moneta'
 require 'json'
 

data/spec/orthor/templates_spec.rb

@@ -8,10 +8,12 @@ describe Orthor::Templates do
                          :body => File.join(SPEC_DIR, 'resources', 'query.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/category.json",
                          :body => File.join(SPEC_DIR, 'resources', 'category.json'))
-    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/varied.json",
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/queries/varied.json",
                          :body => File.join(SPEC_DIR, 'resources', 'varied_content.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/feeds/feed.rss",
                          :body => File.join(SPEC_DIR, 'resources', 'feed.rss'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/content_items/utf8.json",
+                         :body => File.join(SPEC_DIR, 'resources', 'utf8.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/content_items/missing.json",
                          :body => "")
 
@@ -20,15 +22,21 @@ describe Orthor::Templates do
     end
 
     Orthor::Templates.define do
-      template :basic, %!<h2>{{Title}}</h2><div class="content">{{Content}}</div>!
-      template :brief, %!<h2>{{Title}}</h2>!
-      template :blurb, %!<div>{{Content.blurb}}</div>!
-      template :user, %!<div>{{Creator.Email}}</div><div>{{Creator.First name}} {{Creator.Last name}}</div>!
+      template :basic, %!<h2>{{title}}</h2><div class="content">{{content}}</div>!
+      template :brief, %!<h2>{{title}}</h2>!
+      template :blurb, %!<div>{{content.blurb}}</div>!
+      template :user, %!<div>{{author.email}}</div><div>{{author.first_name}} {{author.last_name}}</div>!
 
       mapping :listing, { "Text Block" => :brief }
     end
   end
 
+  describe "utf8" do
+    it "should be able to parse utf8" do
+      Orthor.content("utf8", :brief).should == "<h2>Q&A with Tobias Lütke of Shopify - (37signals)</h2>"
+    end
+  end
+
   describe "with no content returned" do
     it "should return an empty string" do
       Orthor.content("missing").should be_empty
@@ -41,7 +49,7 @@ describe Orthor::Templates do
     end
 
     it "should return templates by name" do
-      Orthor::Templates[:basic].should == %!<h2>{{Title}}</h2><div class="content">{{Content}}</div>!
+      Orthor::Templates[:basic].should == %!<h2>{{title}}</h2><div class="content">{{content}}</div>!
     end
   end
 
@@ -101,11 +109,11 @@ describe Orthor::Templates do
 
   describe "template mapping" do
     before(:all) do
-      @json = Orthor.category("varied")
+      @json = Orthor.query("varied")
     end
 
     it "should allow you to pass a hash of orthor template names" do
-      Orthor.render(@json["content"], { "Brief News Item" => :basic, "Link" => :brief, "Bookmark" => :blurb }).should == "<h2>User Manual updated</h2><div class=\"content\">The User Manual has recently had a big overhaul with increased documentation for lots of Orthor's great features, including Content Queries, RSS Feeds, Custom CSS and more!</div><div>All accounts now have access to event tracking, use this to gain a snapshot of what everyone in your account has been doing, for example, what were the...</div><h2>Tutorials have been updated</h2><div class=\"content\">We've recently made the tutorials section of the site public, stay tuned for some more language examples + increased detail of the existing languages. </div><h2>Content Queries have landed in Orthor</h2>"
+      Orthor.render(@json, { "Brief News Item" => :basic, "Link" => :brief, "Bookmark" => :blurb }).should == "<div>The User Manual has recently had a big overhaul with increased documentation for lots of Orthor's great features, including Content Queries, RSS Feeds,...</div><h2>Account event tracking</h2><h2>Tutorials have been updated</h2><div class=\"content\">We've recently made the tutorials section of the site public, stay tuned for some more language examples + increased detail of the existing languages. </div><h2>Tutorials have been updated</h2><div class=\"content\">We've recently made the tutorials section of the site public, stay tuned for some more language examples + increased detail of the existing languages. </div>"
     end
 
     describe "with a named map" do
@@ -117,7 +125,7 @@ describe Orthor::Templates do
     describe "when a mapping is missing" do
       it "should raise an Unknown template exception" do
         lambda do
-          Orthor.render(@json["content"], { "Brief News Item" => :basic, "Link" => :brief })
+          Orthor.render(@json, { "Brief News Item" => :basic, "Link" => :brief })
         end.should raise_error(Orthor::Templates::Unknown)
       end
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Anthony Langhorne