kiosk 0.0.1 → 0.0.2

data/README.rdoc

@@ -16,7 +16,23 @@ license.
 
 == Configuration
 
-(Documentation is forthcoming.)
+CMS integration requires a WordPress installation that includes the {JSON
+API Plugin}[http://wordpress.org/extend/plugins/json-api/].
+
+Once the WP site is up and running, the site endpoint should be specified as
+the +origin+ content server in `config/kiosk.yml` of your Rails application.
+Different configurations may be specified for each Rails environment, along
+with a default.
+
+    origins:
+      default:
+        site: 'http://dev.cms.example/site_name'
+      production:
+        site: 'http://cms.example/site_name'
+
+Localization of content resources depends further on the installation of the
+{WPML Multilingual CMS}[http://wpml.org/] (non-free) and {WPML JSON
+API}[http://wordpress.org/extend/plugins/wpml-json-api/] plugins.
 
 == Roadmap
 

data/lib/kiosk.rb

@@ -13,6 +13,7 @@ module Kiosk
   autoload :Cdn, 'kiosk/cdn'
   autoload :Claim, 'kiosk/claim'
   autoload :ClaimedNode, 'kiosk/claimed_node'
+  autoload :ContentTeaser, 'kiosk/content_teaser'
   autoload :Controller, 'kiosk/controller'
   autoload :Document, 'kiosk/document'
   autoload :Indexer, 'kiosk/indexer'
@@ -20,11 +21,12 @@ module Kiosk
   autoload :Origin, 'kiosk/origin'
   autoload :ProspectiveNode, 'kiosk/prospective_node'
   autoload :Prospector, 'kiosk/prospector'
-  autoload :Resource, 'kiosk/resource'
+  autoload :ResourceController, 'kiosk/resource_controller'
   autoload :ResourceURI, 'kiosk/resource_uri'
   autoload :Rewrite, 'kiosk/rewrite'
   autoload :Rewriter, 'kiosk/rewriter'
   autoload :Searchable, 'kiosk/searchable'
+  autoload :WordPress, 'kiosk/word_press'
 
   ##############################################################################
   # Module methods

data/lib/kiosk/cacheable/resource.rb

@@ -4,6 +4,29 @@ module Kiosk
   module Cacheable::Resource
     extend ActiveSupport::Concern
 
+    included do
+      def self.inherited(sub)
+        super
+
+        sub.module_exec do
+          protected
+
+          # Returns expireable connection keys set by derived class and all
+          # parent classes.
+          #
+          def self.all_connection_keys_to_expire
+            keys = @connection_keys_to_expire || []
+
+            if superclass.respond_to?(:all_connection_keys_to_expire)
+              superclass.all_connection_keys_to_expire | keys
+            else
+              keys
+            end
+          end
+        end
+      end
+    end
+
     module ClassMethods
       # Specifies the length of time for which a resource should stay cached.
       # Either a +Fixnum+ (time in seconds) or block can be given. The block
@@ -46,11 +69,9 @@ module Kiosk
         expire(resource.id)
         expire_by_slug(resource.slug)
 
-        if @connection_keys_to_expire
-          begin
-            @connection_keys_to_expire.each { |key| connection.cache_expire_by_pattern(key) }
-          rescue NotImplementedError
-          end
+        begin
+          all_connection_keys_to_expire.each { |key| connection.cache_expire_by_pattern(key) }
+        rescue NotImplementedError
         end
 
         notify_observers(:after_expire, resource)

data/lib/kiosk/content_teaser.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/string'
+
+module Kiosk
+  module ContentTeaser
+    # Returns a teaser of the content with roughly the given length.
+    #
+    # The content is parsed as an HTML fragment and only text nodes are
+    # considered to have length in this context. As a result, the returned
+    # string will not have a length matching the given +horizon+ exactly, but
+    # should render as such.
+    #
+    def teaser(horizon, options = {})
+      if doc = content_document
+
+        # Traverse all text nodes until we reach the limit
+        length = 0
+
+        # Find the boundary node, where the text length crosses the horizon
+        node = doc.xpath('descendant::text()').detect do |n|
+          (length += n.content.length) >= horizon
+        end
+
+        if node
+          # Truncate the content of the boundary text node
+          node.content = node.content.truncate(node.content.length - (length - horizon), options)
+
+          # Remove all following nodes from the document
+          # Note that this mark-and-sweep method is due to the catch 22 of
+          # relative DOM traversal (next, parent, etc.) and node removal.
+          nodes_to_remove = []
+          nodes_to_remove << node while node = (node.next || (node.parent && node.parent.next))
+          nodes_to_remove.each { |n| n.remove if n.parent }
+        end
+
+        doc.to_html
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/kiosk/resource_controller.rb

@@ -0,0 +1,49 @@
+module Kiosk
+  module ResourceController
+    def show
+      self.resource = resource_model.find_by_slug(params[:id] || params[:slug])
+    end
+
+    # Can be used as an endpoint for the CMS to expire the cache.
+    #
+    def update
+      model = resource_model
+
+      if model.respond_to?(:expire)
+        resource = model.new(params)
+
+        # Expire for all target locales if the resource is localizable
+        if model.respond_to?(:localized_to)
+          I18n.available_locales.each do |locale|
+            model.localized_to(locale) do
+              resource.expire
+            end
+          end
+        else
+          resource.expire
+        end
+      end
+
+      render :nothing => true
+    end
+
+    private
+
+    # Resolves the model from the controller name.
+    #
+    def resource_model
+      names = self.class.name.split('::')
+      controller = names.pop
+      (names.join('::') + '::' + controller.sub('Controller', '').singularize).constantize
+    end
+
+    def resource_name
+      resource_model.name.split('::').last.underscore
+    end
+
+    def resource=(resource)
+      instance_variable_set("@#{resource_name}".to_sym, resource)
+      @resource = resource
+    end
+  end
+end

data/lib/kiosk/rewriter.rb

@@ -44,10 +44,16 @@ module Kiosk
       @rewrites.clear
     end
 
+    # Returns the rewriten document from +rewrite_to_document+ as a string.
+    #
+    def rewrite(content)
+      rewrite_to_document(content).to_html
+    end
+
     # Runs on claims on the given content, incorporates all controller
     # rewrites, and returns the resulting content.
     #
-    def rewrite(content)
+    def rewrite_to_document(content)
       document = Document.parse(content)
 
       # Claims are grouped by priority. Process them in order.
@@ -66,7 +72,7 @@ module Kiosk
         end
       end
 
-      document.to_html
+      document
     end
   end
 end

data/lib/kiosk/version.rb

@@ -1,3 +1,3 @@
 module Kiosk
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/kiosk/word_press.rb

@@ -0,0 +1,14 @@
+module Kiosk
+  module WordPress
+    autoload :Attachment, 'kiosk/word_press/attachment'
+    autoload :Author, 'kiosk/word_press/author'
+    autoload :Category, 'kiosk/word_press/category'
+    autoload :Comment, 'kiosk/word_press/comment'
+    autoload :Images, 'kiosk/word_press/images'
+    autoload :Page, 'kiosk/word_press/page'
+    autoload :Post, 'kiosk/word_press/post'
+    autoload :Resource, 'kiosk/word_press/resource'
+    autoload :Tag, 'kiosk/word_press/tag'
+    autoload :Video, 'kiosk/word_press/video'
+  end
+end

data/lib/kiosk/word_press/attachment.rb

@@ -0,0 +1,7 @@
+module Kiosk
+  module WordPress
+    class Attachment < Resource
+      claims_path_content(:selector => 'a, img', :pattern => 'files/\d{4}/\d{2}/:slug')
+    end
+  end
+end

data/lib/kiosk/word_press/author.rb

@@ -0,0 +1,9 @@
+module Kiosk
+  module WordPress
+    class Author < Resource
+      schema do
+        attribute 'name', :string
+      end
+    end
+  end
+end

data/lib/kiosk/word_press/category.rb

@@ -0,0 +1,18 @@
+module Kiosk
+  module WordPress
+    class Category < Resource
+      schema do
+        attribute 'title', :string
+      end
+
+      # Retrieves a specific category by its slug. This can't be done directly
+      # through the WordPress JSON API, so all categories are traversed instead.
+      #
+      def self.find_by_slug(slug)
+        category = all.detect { |category| category.slug == slug }
+        raise ResourceNotFound.new("unknown category `#{slug}'") unless category
+        category
+      end
+    end
+  end
+end

data/lib/kiosk/word_press/comment.rb

@@ -0,0 +1,13 @@
+module Kiosk
+  module WordPress
+    class Comment < Resource
+      schema do
+        attribute 'name', :string
+        attribute 'url', :string
+        attribute 'date', :string
+        attribute 'content', :string
+        attribute 'parent', :integer
+      end
+    end
+  end
+end

data/lib/kiosk/word_press/images.rb

@@ -0,0 +1,6 @@
+module Kiosk
+  module WordPress
+    class Images < Resource
+    end
+  end
+end

data/lib/kiosk/word_press/page.rb

@@ -0,0 +1,57 @@
+module Kiosk
+  module WordPress
+    class Page < Resource
+      include Searchable::Resource
+
+      ##############################################################################
+      # Content integration
+      ##############################################################################
+      schema do
+        attribute 'title', :string
+        attribute 'title_plain', :string
+        attribute 'content', :string
+        attribute 'excerpt', :string
+      end
+
+      claims_path_content(:selector => 'a',
+                          :pattern => ':slug',
+                          :shims => {:slug => /[^\?]+/},
+                          :priority => :low)
+
+      ##############################################################################
+      # Indexes
+      ##############################################################################
+      define_index(:content_page) do
+        indexes :title, :content
+      end
+
+      ##############################################################################
+      # Instance methods
+      ##############################################################################
+
+      # Returns the leading portion of the slug.
+      #
+      def section
+        (s = slug.to_s).empty? ? nil : s.split('/').first
+      end
+
+      # Returns the full page slug. This differs in cases where the page is a
+      # child of another in the hierarchy. E.g. where a parent page has slug
+      # 'p1' and the child page has slug 'c1', 'p1/c1' would be returned, not
+      # simply 'c1'.
+      #
+      def slug
+        begin
+          #parse the url
+          uri = URI.parse(url)
+          #get the route from the original site uri
+          route = uri.route_from(Kiosk.origin.site_uri)
+          #return just the path
+          route.path
+        rescue
+          attributes[:slug]
+        end
+      end
+    end
+  end
+end

data/lib/kiosk/word_press/post.rb

@@ -0,0 +1,96 @@
+module Kiosk
+  module WordPress
+    class Post < Resource
+      include Searchable::Resource
+      include ContentTeaser
+
+      ##############################################################################
+      # Content integration
+      ##############################################################################
+      schema do
+        attribute 'title', :string
+        attribute 'title_plain', :string
+        attribute 'content', :string
+        attribute 'excerpt', :string
+        attribute 'date', :string
+        attribute 'modified', :string
+      end
+
+      claims_path_content(:selector => 'a', :pattern => '\d{4}/\d{2}/\d{2}/:slug')
+
+      expires_connection_methods('get_category_posts', 'get_tag_posts', 'get_recent_posts')
+
+      ##############################################################################
+      # Indexes
+      ##############################################################################
+      define_index(:content_post) do
+        indexes :title, :content
+      end
+
+      ##############################################################################
+      # Class methods
+      ##############################################################################
+      class << self
+        def all
+          Category.all.inject([]) { |posts,cat| posts += categorized_as(cat) }.uniq { |p| p.id }
+        end
+
+        # Fetches posts for the given category.
+        #
+        def categorized_as(category, params = {})
+          category = Kiosk::WordPress::Category.find_by_slug(category) if category.is_a?(String)
+          find_by_associated(category, {:count => 100000}.merge(params))
+        rescue ResourceNotFound
+          []
+        end
+
+        # Fetches posts that were created on the given date.
+        #
+        def created_on(date)
+          find(:all, :method => :get_date_posts, :params => [:date => date])
+        end
+
+        # Fetches recently made posts.
+        #
+        def recent
+          find(:all, :method => :get_recent_posts)
+        end
+
+        # Fetches posts with the given tag.
+        #
+        def tagged_with(tag)
+          find_by_associated(tag)
+        end
+      end
+
+      ##############################################################################
+      # Instance methods
+      ##############################################################################
+
+      # Returns the post categories.
+      #
+      def categories
+        attributes[:categories] || []
+      end
+
+      # Returns the first category of the post.
+      #
+      def category
+        categories.first
+      end
+
+      # The time at which this post was authored.
+      #
+      def created_at
+        attributes[:date].to_time
+      end
+
+      # The time at which this post was modified.
+      #
+      def modified_at
+        attributes[:modified].to_time
+      end
+
+    end
+  end
+end

data/lib/kiosk/word_press/resource.rb

@@ -0,0 +1,321 @@
+require 'active_resource'
+
+# Proxy for content resources.
+#
+module Kiosk
+  module WordPress
+    class Resource < ::ActiveResource::Base
+      include Cacheable::Resource
+      include Localizable::Resource
+      include Prospector
+
+      ##############################################################################
+      # ActiveResource config
+      ##############################################################################
+      self.site = Kiosk.origin.site
+      self.format = :json
+
+      schema do
+        attribute 'slug', :string
+      end
+
+      ##############################################################################
+      # Caching
+      ##############################################################################
+      cached_expire_in { |resource| resource['status'] == 'error' ? 30.minutes : 1.day }
+
+      ##############################################################################
+      # Class methods
+      ##############################################################################
+      class << self
+        # Returns all instances of the resource.
+        #
+        def all
+          find(:all)
+        end
+
+        # Reimplements the +ActiveResource+ path constructor to work with the
+        # WordPress JSON-API plugin.
+        #
+        def element_path(id, prefix_options = {}, query_options = nil)
+          "#{api_path_to("get_#{element_name}")}#{query_string({:id => id}.merge(query_options || {}))}"
+        end
+
+        def element_path_by_slug(slug, prefix_options = {}, query_options = nil)
+          "#{api_path_to("get_#{element_name}")}#{query_string({:slug => slug}.merge(query_options || {}))}"
+        end
+
+        # Adds functionality to the +ActiveResource.find+ method to allow for
+        # specifying the WordPress JSON API method that should be used. This
+        # simplifies definition of scopes in derived models.
+        #
+        def find(*arguments)
+          scope   = arguments.slice!(0)
+          options = arguments.slice!(0) || {}
+
+          if options.key?(:method)
+            options[:from] = api_path_to(options[:method])
+            options.delete(:method)
+          end
+
+          super(scope, options)
+        end
+
+        # Finds all resources by the given related resource.
+        #
+        # Example:
+        #
+        #   Post.find_by_associated(category)
+        #
+        # Is the same as invoking:
+        #
+        #   Post.find(:all, :method => "get_category_posts", :params => {:id => category.id})
+        #
+        def find_by_associated(resource, params = {})
+          find(:all,
+               :method => "get_#{resource.class.element_name}_#{element_name.pluralize}",
+               :params => params.merge({:id => resource.id}))
+        end
+
+        # Finds the resource by the given slug.
+        #
+        def find_by_slug(slug)
+          find(:one, :method => "get_#{element_name}", :params => {:slug => slug})
+        end
+
+        # Reimplements the +ActiveResource+ path constructor to work with the
+        # WordPress JSON-API plugin.
+        #
+        def collection_path(prefix_options = {}, query_options = nil)
+          "#{api_path_to("get_#{element_name}_index")}#{query_string(query_options)}"
+        end
+
+        # Reimplements the +ActiveResource+ method to check for bad responses
+        # before instantiating a collection.
+        #
+        def instantiate_collection(collection, prefix_options = {})
+          super(normalize_response(collection, true), prefix_options)
+        end
+
+        # Reimplements the +ActiveResource+ method to check for bad responses
+        # before instantiating an object.
+        #
+        def instantiate_record(record, prefix_options = {})
+          super(normalize_response(record), prefix_options)
+        end
+
+        # Executes the given block within a scope where all requests for this
+        # content resource are appended with the given parameters.
+        #
+        #   class Post < Resource; end
+        #
+        #   Post.with_parameters(:language => 'en') do
+        #     english_posts = Post.find(:all)
+        #     english_pages = Page.find(:all)
+        #   end
+        #
+        # Scopes can be nested.
+        #
+        #   Post.with_parameters(:language => 'es') do
+        #     Post.with_parameters(:recent => true) do
+        #       recent_spanish_posts = Post.find(:all)
+        #     end
+        #   end
+        #
+        # Scopes are inherited.
+        #
+        #   Resource.with_parameters(:language => 'fr') do
+        #     french_posts = Post.find(:all)
+        #   end
+        #
+        # However, nesting is still respected.
+        #
+        #   Resource.with_parameters(:language => 'fr') do
+        #     Post.with_parameters(:language => 'en') do
+        #       english_posts = Post.find(:all)
+        #     end
+        #   end
+        #
+        # Even with this nesting inverted.
+        #
+        #   Post.with_parameters(:language => 'fr') do
+        #     Resource.with_parameters(:language => 'en') do
+        #       english_posts = Post.find(:all)
+        #     end
+        #   end
+        #
+        def with_parameters(params = {})
+          push_to_query_scope_stack(params)
+
+          begin
+            yield
+          ensure
+            pop_from_query_scope_stack
+          end
+        end
+
+        protected
+
+        # Returns the path to the given method of the WordPress API.
+        #
+        def api_path_to(method)
+          "#{site.path}api/#{method}/"
+        end
+
+        # Checks the given response for errors and normalizes its structure. A
+        # response from the API includes an envelope, which must be checked for
+        # the response status ("ok" or "error"). If an error is found, an
+        # exception is raised.
+        #
+        def normalize_response(response, collection = false)
+          response = case response['status']
+                     when 'ok'
+                       response[collection ? element_name.pluralize : element_name]
+                     when 'error'
+                       raise_error(response['error'])
+                     else
+                       # This isn't a response envelope. Just let it pass through.
+                       response
+                     end
+
+          camelcase_keys(response)
+        end
+
+        # Reimplements the parent method to include parameters of the current
+        # query scope. See +with_parameters+.
+        #
+        def query_string(options)
+          scoped_options = my_query_scope_stack.inject({}) do |scoped_options,(klass,opt_stack)|
+            if self.ancestors.include?(klass)
+              scoped_options = opt_stack.reduce(scoped_options) do |scoped_options,opts|
+                scoped_options.merge(opts)
+              end
+            else
+              scoped_options
+            end
+          end
+
+          super(scoped_options.merge(options))
+        end
+
+        # Handles errors returned by the WordPress JSON API.
+        #
+        def raise_error(error)
+          case error
+          when 'Not found.'
+            raise Kiosk::ResourceNotFound.new(error)
+          when /Un?known method '(\w+)'/ # note the possibility of a spelling error
+            raise NotImplementedError.new(error)
+          else
+            raise Kiosk::ResourceError.new(error)
+          end
+        end
+
+        private
+
+        mattr_accessor :query_scope_stack
+
+        # Filters and sorts the query-scope stack so that only scopes relevant
+        # to this class are applied and are applied in order from furthest
+        # ancestor to nearest.
+        #
+        def my_query_scope_stack
+          if query_scope_stack
+            Hash[query_scope_stack.select do |klass,stack|
+              self.ancestors.include?(klass)
+            end.sort_by do |klass,stack|
+              self.ancestors.index(klass) * -1
+            end]
+          else
+            {}
+          end
+        end
+
+        def push_to_query_scope_stack(params)
+          self.query_scope_stack ||= {}
+          self.query_scope_stack[self] ||= []
+
+          # Append stacks for this class and all descendent classes.
+          query_scope_stack.each_key do |klass|
+            query_scope_stack[klass].push(params) if klass.ancestors.include?(self)
+          end
+        end
+
+        def pop_from_query_scope_stack
+          # Pop stacks for this class and all descendent classes.
+          query_scope_stack.each_key do |klass|
+            query_scope_stack[klass].pop if klass.ancestors.include?(self)
+          end
+        end
+
+        # Recursively changes the keys of the given hash (or array of hashes)
+        # to camelcase.
+        #
+        def camelcase_keys(obj)
+          case obj
+          when Hash
+            obj.inject({}) { |hash,(k,v)| hash[k.to_s.underscore] = camelcase_keys(v); hash }
+          when Array
+            obj.map { |v| camelcase_keys(v) }
+          else
+            obj
+          end
+        end
+      end
+
+      ##############################################################################
+      # Instance methods
+      ##############################################################################
+
+      # Returns the rewritten resource content. See +raw_content+ for untouched
+      # content.
+      #
+      def content
+        @content ||= raw_content && Kiosk.rewriter.rewrite(raw_content)
+      end
+
+      # Returns the rewritten resource content as a +Document+.
+      #
+      def content_document
+        raw_content && Kiosk.rewriter.rewrite_to_document(raw_content)
+      end
+
+      # Returns the rewritten resource excerpt. See +raw_excerpt+ for untouched
+      # content.
+      #
+      def excerpt
+        @excerpt ||= raw_excerpt && Kiosk.rewriter.rewrite(raw_excerpt)
+      end
+
+      # Destroying is not supported.
+      #
+      def destroy
+        raise NotImplementedError
+      end
+
+      # Returns the resource content, untouched by the content rewriter.
+      #
+      def raw_content
+        attributes[:content]
+      end
+
+      # Returns the resource excerpt, untouched by the content rewriter.
+      #
+      def raw_excerpt
+        attributes[:excerpt]
+      end
+
+      # Saving is not supported.
+      #
+      def save
+        raise NotImplementedError
+      end
+
+      # Returns the value used in constructing a URL to this object.
+      #
+      def to_param
+        attributes[:slug] || attributes[:id]
+      end
+    end
+  end
+end

data/lib/kiosk/word_press/tag.rb

@@ -0,0 +1,6 @@
+module Kiosk
+  module WordPress
+    class Tag < Resource
+    end
+  end
+end

data/lib/kiosk/word_press/video.rb

@@ -0,0 +1,36 @@
+module Kiosk
+  module WordPress
+    class Video < Resource
+      schema do
+        attribute 'id', :string
+        attribute 'slug', :string
+        attribute 'classid', :string
+      end
+
+      claims_content(:selector => 'object') do |object|
+        if object['id'] && (match = object['id'].match(/^viddler(?:player)?-(\w+)/))
+          {:slug => object['id'], :classid => object['classid']}
+        end
+      end
+
+      # Returns the video ID, which is either an explicitly set attribute or the
+      # trailing string identifier from the slug (following the last "-").
+      #
+      def id
+        attributes[:id] || (attributes[:slug] && attributes[:slug].match(/-(\w+)$/)[1])
+      end
+
+      # Returns the path to the "thumbnail" version of the movie.
+      #
+      def thumbnail_url
+        "http://www.viddler.com/simple/#{id}/"
+      end
+
+      # Returns the path to the "full" version of the movie.
+      #
+      def url
+        "http://www.viddler.com/player/#{id}/"
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: kiosk
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Daniel Duvall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-27 00:00:00 Z
+date: 2012-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -75,6 +75,7 @@ files:
 - lib/kiosk/claim/path_claim.rb
 - lib/kiosk/claim.rb
 - lib/kiosk/claimed_node.rb
+- lib/kiosk/content_teaser.rb
 - lib/kiosk/controller.rb
 - lib/kiosk/document.rb
 - lib/kiosk/indexer/adapter/base.rb
@@ -87,7 +88,7 @@ files:
 - lib/kiosk/origin.rb
 - lib/kiosk/prospective_node.rb
 - lib/kiosk/prospector.rb
-- lib/kiosk/resource.rb
+- lib/kiosk/resource_controller.rb
 - lib/kiosk/resource_error.rb
 - lib/kiosk/resource_not_found.rb
 - lib/kiosk/resource_uri.rb
@@ -100,6 +101,17 @@ files:
 - lib/kiosk/searchable.rb
 - lib/kiosk/tasks/kiosk.rake
 - lib/kiosk/version.rb
+- lib/kiosk/word_press/attachment.rb
+- lib/kiosk/word_press/author.rb
+- lib/kiosk/word_press/category.rb
+- lib/kiosk/word_press/comment.rb
+- lib/kiosk/word_press/images.rb
+- lib/kiosk/word_press/page.rb
+- lib/kiosk/word_press/post.rb
+- lib/kiosk/word_press/resource.rb
+- lib/kiosk/word_press/tag.rb
+- lib/kiosk/word_press/video.rb
+- lib/kiosk/word_press.rb
 - lib/kiosk.rb
 - MIT-LICENSE
 - Rakefile

data/lib/kiosk/resource.rb

@@ -1,313 +0,0 @@
-require 'active_resource'
-
-# Proxy for content resources.
-#
-module Kiosk
-  class Resource < ::ActiveResource::Base
-    include Cacheable::Resource
-    include Localizable::Resource
-    include Prospector
-
-    ##############################################################################
-    # ActiveResource config
-    ##############################################################################
-    self.site = Kiosk.origin.site
-    self.format = :json
-
-    schema do
-      attribute 'slug', :string
-    end
-
-    ##############################################################################
-    # Caching
-    ##############################################################################
-    cached_expire_in { |resource| resource['status'] == 'error' ? 30.minutes : 1.day }
-
-    ##############################################################################
-    # Class methods
-    ##############################################################################
-    class << self
-      # Returns all instances of the resource.
-      #
-      def all
-        find(:all)
-      end
-
-      # Reimplements the +ActiveResource+ path constructor to work with the
-      # WordPress JSON-API plugin.
-      #
-      def element_path(id, prefix_options = {}, query_options = nil)
-        "#{api_path_to("get_#{element_name}")}#{query_string({:id => id}.merge(query_options || {}))}"
-      end
-
-      def element_path_by_slug(slug, prefix_options = {}, query_options = nil)
-        "#{api_path_to("get_#{element_name}")}#{query_string({:slug => slug}.merge(query_options || {}))}"
-      end
-
-      # Adds functionality to the +ActiveResource.find+ method to allow for
-      # specifying the WordPress JSON API method that should be used. This
-      # simplifies definition of scopes in derived models.
-      #
-      def find(*arguments)
-        scope   = arguments.slice!(0)
-        options = arguments.slice!(0) || {}
-
-        if options.key?(:method)
-          options[:from] = api_path_to(options[:method])
-          options.delete(:method)
-        end
-
-        super(scope, options)
-      end
-
-      # Finds all resources by the given related resource.
-      #
-      # Example:
-      #
-      #   Post.find_by_associated(category)
-      #
-      # Is the same as invoking:
-      #
-      #   Post.find(:all, :method => "get_category_posts", :params => {:id => category.id})
-      #
-      def find_by_associated(resource, params = {})
-        find(:all,
-             :method => "get_#{resource.class.element_name}_#{element_name.pluralize}",
-             :params => params.merge({:id => resource.id}))
-      end
-
-      # Finds the resource by the given slug.
-      #
-      def find_by_slug(slug)
-        find(:one, :method => "get_#{element_name}", :params => {:slug => slug})
-      end
-
-      # Reimplements the +ActiveResource+ path constructor to work with the
-      # WordPress JSON-API plugin.
-      #
-      def collection_path(prefix_options = {}, query_options = nil)
-        "#{api_path_to("get_#{element_name}_index")}#{query_string(query_options)}"
-      end
-
-      # Reimplements the +ActiveResource+ method to check for bad responses
-      # before instantiating a collection.
-      #
-      def instantiate_collection(collection, prefix_options = {})
-        super(normalize_response(collection, true), prefix_options)
-      end
-
-      # Reimplements the +ActiveResource+ method to check for bad responses
-      # before instantiating an object.
-      #
-      def instantiate_record(record, prefix_options = {})
-        super(normalize_response(record), prefix_options)
-      end
-
-      # Executes the given block within a scope where all requests for this
-      # content resource are appended with the given parameters.
-      #
-      #   class Post < Resource; end
-      #
-      #   Post.with_parameters(:language => 'en') do
-      #     english_posts = Post.find(:all)
-      #     english_pages = Page.find(:all)
-      #   end
-      #
-      # Scopes can be nested.
-      #
-      #   Post.with_parameters(:language => 'es') do
-      #     Post.with_parameters(:recent => true) do
-      #       recent_spanish_posts = Post.find(:all)
-      #     end
-      #   end
-      #
-      # Scopes are inherited.
-      #
-      #   Resource.with_parameters(:language => 'fr') do
-      #     french_posts = Post.find(:all)
-      #   end
-      #
-      # However, nesting is still respected.
-      #
-      #   Resource.with_parameters(:language => 'fr') do
-      #     Post.with_parameters(:language => 'en') do
-      #       english_posts = Post.find(:all)
-      #     end
-      #   end
-      #
-      # Even with this nesting inverted.
-      #
-      #   Post.with_parameters(:language => 'fr') do
-      #     Resource.with_parameters(:language => 'en') do
-      #       english_posts = Post.find(:all)
-      #     end
-      #   end
-      #
-      def with_parameters(params = {})
-        push_to_query_scope_stack(params)
-
-        begin
-          yield
-        ensure
-          pop_from_query_scope_stack
-        end
-      end
-
-      protected
-
-      # Returns the path to the given method of the WordPress API.
-      #
-      def api_path_to(method)
-        "#{site.path}api/#{method}/"
-      end
-
-      # Checks the given response for errors and normalizes its structure. A
-      # response from the API includes an envelope, which must be checked for
-      # the response status ("ok" or "error"). If an error is found, an
-      # exception is raised.
-      #
-      def normalize_response(response, collection = false)
-        response = case response['status']
-                   when 'ok'
-                     response[collection ? element_name.pluralize : element_name]
-                   when 'error'
-                     raise_error(response['error'])
-                   else
-                     # This isn't a response envelope. Just let it pass through.
-                     response
-                   end
-
-        camelcase_keys(response)
-      end
-
-      # Reimplements the parent method to include parameters of the current
-      # query scope. See +with_parameters+.
-      #
-      def query_string(options)
-        scoped_options = my_query_scope_stack.inject({}) do |scoped_options,(klass,opt_stack)|
-          if self.ancestors.include?(klass)
-            scoped_options = opt_stack.reduce(scoped_options) do |scoped_options,opts|
-              scoped_options.merge(opts)
-            end
-          else
-            scoped_options
-          end
-        end
-
-        super(scoped_options.merge(options))
-      end
-
-      # Handles errors returned by the WordPress JSON API.
-      #
-      def raise_error(error)
-        case error
-        when 'Not found.'
-          raise Kiosk::ResourceNotFound.new(error)
-        when /Un?known method '(\w+)'/ # note the possibility of a spelling error
-          raise NotImplementedError.new(error)
-        else
-          raise Kiosk::ResourceError.new(error)
-        end
-      end
-
-      private
-
-      mattr_accessor :query_scope_stack
-
-      # Filters and sorts the query-scope stack so that only scopes relevant
-      # to this class are applied and are applied in order from furthest
-      # ancestor to nearest.
-      #
-      def my_query_scope_stack
-        if query_scope_stack
-          Hash[query_scope_stack.select do |klass,stack|
-            self.ancestors.include?(klass)
-          end.sort_by do |klass,stack|
-            self.ancestors.index(klass) * -1
-          end]
-        else
-          {}
-        end
-      end
-
-      def push_to_query_scope_stack(params)
-        self.query_scope_stack ||= {}
-        self.query_scope_stack[self] ||= []
-
-        # Append stacks for this class and all descendent classes.
-        query_scope_stack.each_key do |klass|
-          query_scope_stack[klass].push(params) if klass.ancestors.include?(self)
-        end
-      end
-
-      def pop_from_query_scope_stack
-        # Pop stacks for this class and all descendent classes.
-        query_scope_stack.each_key do |klass|
-          query_scope_stack[klass].pop if klass.ancestors.include?(self)
-        end
-      end
-
-      # Recursively changes the keys of the given hash (or array of hashes)
-      # to camelcase.
-      #
-      def camelcase_keys(obj)
-        case obj
-        when Hash
-          obj.inject({}) { |hash,(k,v)| hash[k.to_s.underscore] = camelcase_keys(v); hash }
-        when Array
-          obj.map { |v| camelcase_keys(v) }
-        else
-          obj
-        end
-      end
-    end
-
-    ##############################################################################
-    # Instance methods
-    ##############################################################################
-
-    # Returns the rewritten resource content. See +raw_content+ for untouched
-    # content.
-    #
-    def content
-      @content ||= raw_content && Kiosk.rewriter.rewrite(raw_content)
-    end
-
-    # Returns the rewritten resource excerpt. See +raw_excerpt+ for untouched
-    # content.
-    #
-    def excerpt
-      @excerpt ||= raw_excerpt && Kiosk.rewriter.rewrite(raw_excerpt)
-    end
-
-    # Destroying is not supported.
-    #
-    def destroy
-      raise NotImplementedError
-    end
-
-    # Returns the resource content, untouched by the content rewriter.
-    #
-    def raw_content
-      attributes[:content]
-    end
-
-    # Returns the resource excerpt, untouched by the content rewriter.
-    #
-    def raw_excerpt
-      attributes[:excerpt]
-    end
-
-    # Saving is not supported.
-    #
-    def save
-      raise NotImplementedError
-    end
-
-    # Returns the value used in constructing a URL to this object.
-    #
-    def to_param
-      attributes[:slug] || attributes[:id]
-    end
-  end
-end