orthor 0.1.3 → 0.1.4

data/README.md

@@ -11,7 +11,7 @@ The Orthor gem is used to fetch and display your content from orthor.com
 Add the below to a file and require it:
 
     Orthor.setup do
-      site "orthor"                             # your orthor site/account id
+      site "orthor"                             # your orthor site id
       caching :basic_file, 300, :path => "tmp/" # cache content in tmp/ for 5 mins
     end
 
@@ -19,29 +19,53 @@ You can specify any Moneta cache store you like, e.g. basic_file, memory, memcac
 
 ## Usage
 
+The following with_orthor_* helper methods are defined in the OrthorHelper module. This is automatically included in ActionView::Base if you're in a Rails app.
+
 #### Content
 
+    with_orthor_content("id") do 
+      <h2>{{title}}</h2>
+      <span>{{published_on}}</span>
+      <div class="content">{{article_content}}</div>
+    end
+
+    OR
+
     Orthor.content("id", :template_name)
 
 #### Queries
 
+    with_orthor_query("id") do 
+      <h2>{{title}}</h2>
+      <span>{{published_on}}</span>
+      <div class="content">{{article_content}}</div>
+    end
+
+    OR
+
     Orthor.query("id", :template_name)
 
 #### Categories
 
+    with_orthor_category("id") do 
+      <h2>{{title}}</h2>
+      <span>{{published_on}}</span>
+      <div class="content">{{article_content}}</div>
+    end
+
+    OR
+
     Orthor.category("id", :template_name)
 
 #### 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.
+The second argument in the Orthor class methods is a symbol to indicate 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 easier, we provide some templating help:
+If you don't want to use the with_orthor_* helpers you can use named templates:
 
     Orthor::Templates.define do
       template :basic_content, %(<div>{{content}}</div>)
@@ -71,7 +95,7 @@ Orthor returns all of your content in JSON so to make the job of translating JSO
       }
     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.
+Now any call you make to Orthor.content/category/query can be given a 2nd argument of a template name (or template mapping) as a symbol and rather than receiving parsed JSON, you will be returned a HTML string.
 
 ### Named template mappings
 

data/lib/orthor.rb

@@ -6,10 +6,11 @@ require 'json'
 require 'net/http'
 
 require 'orthor/templates'
+require 'orthor_helper'
 
 class Orthor
   class << self
-    attr_accessor :cache, :cache_expiry, :account_id
+    attr_accessor :cache, :cache_expiry, :site_id
   end
 
   def self.load_content
@@ -21,7 +22,7 @@ class Orthor
       cat["content"].each  { |item| content(item["id"]) } if cat["content"]
     end
 
-    JSON.parse(get_response("/#{account_id}.json")).each do |item|
+    JSON.parse(get_response("/#{site_id}.json")).each do |item|
       if item["type"] == "category"
         load_category[item["id"]]
       else
@@ -59,12 +60,8 @@ class Orthor
     self.cache_expiry = expiry
   end
 
-  def self.account(id)
-    self.account_id = id
-  end
-
   def self.site(id)
-    self.account_id = id
+    self.site_id = id
   end
 
   def self.setup(&block)
@@ -76,12 +73,12 @@ class Orthor
 
 private
   def self.get(type, id)
-    raise "No orthor account given... Please add one to your Orthor setup block" unless account_id
+    raise "No orthor site given... Please add one to your Orthor setup block" unless site_id
 
     begin
       suffix = type == :feeds ? "rss" : "json"
       key = "#{id}-#{type}"
-      path = "/#{account_id}/#{type}/#{id}.#{suffix}"
+      path = "/#{site_id}/#{type}/#{id}.#{suffix}"
 
       resp = cache ? get_cached_content(key, path) : get_response(path)
 

data/lib/orthor/templates.rb

@@ -70,7 +70,9 @@ class Orthor
     end
 
     def self.template_for(item, template_name_or_mapping)
-      if [String, Symbol].include?(template_name_or_mapping.class)
+      if template_name_or_mapping.is_a?(String)
+        return template_name_or_mapping
+      elsif template_name_or_mapping.is_a?(Symbol)
         markup = self[template_name_or_mapping]
 
         if !markup && self.mappings[template_name_or_mapping]

data/lib/orthor_helper.rb

@@ -0,0 +1,26 @@
+module OrthorHelper
+  def with_orthor_content(id, &blk)
+    return unless block_given?
+    render_orthor_result(:content, id, &blk)
+  end
+  
+  def with_orthor_category(id, &blk)
+    return unless block_given?
+    render_orthor_result(:category, id, &blk)
+  end
+
+  def with_orthor_query(id, &blk)
+    return unless block_given?
+    render_orthor_result(:query, id, &blk)
+  end
+
+private
+  def render_orthor_result(method, id, &blk)
+    html = defined?(capture) ? capture(&blk) : yield
+    parsed_html = Orthor.send(method, id, html)
+    defined?(concat) ? concat(parsed_html) : parsed_html
+  end
+end
+
+ActionView::Base.send(:include, OrthorHelper) if defined?(ActionView::Base)
+

data/spec/orthor/templates_spec.rb

@@ -18,7 +18,7 @@ describe Orthor::Templates do
                          :body => "")
 
     Orthor.setup do
-      account "orthor"
+      site "orthor"
     end
 
     Orthor::Templates.define do

data/spec/orthor_spec.rb

@@ -29,11 +29,11 @@ describe Orthor do
   describe "setup" do
     before(:all) do
       Orthor.setup do
-        account nil
+        site nil
       end
     end
 
-    it "should raise an error if no account id is present" do
+    it "should raise an error if no site id is present" do
       lambda { Orthor.content("content") }.should raise_error
     end
   end
@@ -45,15 +45,15 @@ describe Orthor do
       end
     end
 
-    it "should use the site id as the account id" do
-      Orthor.account_id.should == "bob"
+    it "should set the site id" do
+      Orthor.site_id.should == "bob"
     end
   end
 
   describe "getting" do
     before(:all) do
       Orthor.setup do
-        account "orthor"
+        site "orthor"
       end
     end
 
@@ -89,7 +89,7 @@ describe Orthor do
   describe "loading cache" do
     describe "without cache setting" do
       before do
-        Orthor.setup { account "orthor" }
+        Orthor.setup { site "orthor" }
       end
 
       it "should raise an error" do
@@ -100,7 +100,7 @@ describe Orthor do
     describe "with cache setting" do
       before do
         Orthor.setup do
-          account "orthor"
+          site "orthor"
           caching :memory, 20
         end
       end
@@ -117,7 +117,7 @@ describe Orthor do
     describe "no config" do
       before(:all) do
         Orthor.setup do
-          account "orthor"
+          site "orthor"
         end
       end
 
@@ -130,7 +130,7 @@ describe Orthor do
       describe "memory" do
         before(:all) do
           Orthor.setup do
-            account "orthor"
+            site "orthor"
             caching :memory, 600
           end
         end
@@ -156,7 +156,7 @@ describe Orthor do
       describe "basic file store" do
         before(:all) do
           Orthor.setup do
-            account "orthor"
+            site "orthor"
             caching :basic_file, 300, :path => "tmp/"
           end
         end
@@ -169,7 +169,7 @@ describe Orthor do
       describe "optinal expiry time argument" do
         before(:all) do
           Orthor.setup do
-            account "orthor"
+            site "orthor"
             caching :basic_file, :path => "tmp/"
           end
         end
@@ -184,7 +184,7 @@ describe Orthor do
   describe "failover" do
     before(:all) do
       Orthor.setup do
-        account "orthor"
+        site "orthor"
       end
     end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: orthor
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Anthony Langhorne
@@ -18,28 +19,32 @@ date: 2010-06-10 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  name: moneta
-  prerelease: false
   requirement: *id001
+  name: moneta
   type: :runtime
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  name: json
-  prerelease: false
   requirement: *id002
+  name: json
   type: :runtime
 description: 
 email: anthony@orthor.com
@@ -52,9 +57,13 @@ extra_rdoc_files:
 - README.md
 files: 
 - lib/orthor.rb
+- lib/orthor_helper.rb
 - lib/orthor/templates.rb
 - LICENSE
 - README.md
+- spec/orthor/templates_spec.rb
+- spec/orthor_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/anthony/orthor-client
 licenses: []
@@ -65,23 +74,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A gem for displaying content from orthor.com