almodovar 0.7.0 → 0.8.0

data/lib/almodovar/resource_presenter/collection.rb

@@ -1,55 +1,61 @@
 module Almodovar
-  
-  class ResourcePresenter::Collection
-    
-    def initialize(resource_class, resources_args = [], options = {})
-      @resource_class = resource_class
-      @resources = resources_args.map { |arg| @resource_class.new(arg) }
+  class ResourcePresenter
+    class Collection
+
+      attr_reader :resource_class
       
-      @total = options[:total_entries]
-      @next = options[:next_link]
-      @prev = options[:prev_link]
-    end
-    
-    def to_xml(options = {})
-      # Most of the following code is borrowed from ActiveSupport's Array#to_xml.
-      # We cannot use Array#to_xml because we need to add a few custom tags for
-      # pagination.
-      require 'active_support/builder' unless defined?(Builder)
+      def initialize(resource_class, resources_args = [], options = {})
+        @resource_class = resource_class
+        @resources = resources_args.map { |arg| @resource_class.new(arg) }
+        
+        @total = options[:total_entries]
+        @next = options[:next_link]
+        @prev = options[:prev_link]
+      end
+      
+      def to_xml(options = {})
+        # Most of the following code is borrowed from ActiveSupport's Array#to_xml.
+        # We cannot use Array#to_xml because we need to add a few custom tags for
+        # pagination.
+        require 'active_support/builder' unless defined?(Builder)
 
-      options = options.dup
-      options[:indent]  ||= 2
-      options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+        options = options.dup
+        options[:indent]  ||= 2
+        options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
 
-      xml = options[:builder]
+        xml = options[:builder]
 
-      xml.instruct! unless options[:skip_instruct]
-      xml.tag! resource_type.pluralize.dasherize, :type => 'array' do
-        xml.tag!('total-entries', @total) if @total
-        xml.link :rel => 'next', :href => @next if @next
-        xml.link :rel => 'prev', :href => @prev if @prev
-        @resources.each { |value| value.to_xml(options.merge(:root => resource_type.singularize, :skip_instruct => true)) }
+        xml.instruct! unless options[:skip_instruct]
+        xml.tag! resource_type.pluralize.dasherize, :type => 'array' do
+          xml.tag!('total-entries', @total) if @total
+          xml.link :rel => 'next', :href => @next if @next
+          xml.link :rel => 'prev', :href => @prev if @prev
+          @resources.each { |value| value.to_xml(options.merge(:root => resource_type.singularize, :skip_instruct => true)) }
+        end
       end
-    end
-    
-    def as_json(options = {})
-      ActiveSupport::OrderedHash.new.tap do |message|
-        message[:total_entries] = @total if @total
-        message[:next_link] = @next if @next
-        message[:prev_link] = @prev if @prev
-        message[:entries] = @resources.map { |resource| resource.as_json(options) }
+      
+      def as_json(options = {})
+        ActiveSupport::OrderedHash.new.tap do |message|
+          message[:total_entries] = @total if @total
+          message[:next_link] = @next if @next
+          message[:prev_link] = @prev if @prev
+          message[:entries] = @resources.map { |resource| resource.as_json(options) }
+        end
+      end
+      
+      def to_json(options = {})
+        require 'yajl'
+        Yajl::Encoder.encode(as_json(options), :pretty => true) + "\n"
+      end
+
+      def to_html(options = {})
+        HtmlSerializer.new(self, options).to_html
+      end
+      
+      def resource_type
+        @resource_class.resource_type
       end
-    end
-    
-    def to_json(options = {})
-      require 'yajl'
-      Yajl::Encoder.encode(as_json(options), :pretty => true) + "\n"
-    end
-    
-    def resource_type
-      @resource_class.resource_type
-    end
 
-  end
-  
-end
+    end
+  end  
+end

data/lib/almodovar/resource_presenter/html_serializer.rb

@@ -0,0 +1,44 @@
+%w(pygments.rb github-markdown).each do |lib|
+  begin
+    require lib.gsub('-', '/')
+  rescue LoadError => ex
+    raise ex, "In order to use the HtmlSerializer you need the gem `#{lib}` in your Gemfile"
+  end
+end
+
+module Almodovar
+  class ResourcePresenter
+    class HtmlSerializer < Serializer
+
+      TEMPLATE_PATH = File.join(File.dirname(__FILE__), 'template.html.erb')
+
+      def to_html
+        template = File.read(TEMPLATE_PATH)
+        ERB.new(template).result(binding)
+      end
+
+      def metadata
+        resource.resource_class.metadata
+      end
+
+      def beautify(representation, format)
+        body = Pygments.highlight(representation, :lexer => format)
+        body = body.gsub(/&quot;(http\S+)&quot;/) { url = $1; "&quot;<a href=\"#{url}\">#{url}</a>&quot;" }
+        body.html_safe
+      end
+
+      def metadata_text(text)
+        return if text.blank?
+
+        if indentation = text[/\n\s+/]
+          text = text.gsub(indentation, "\n")
+        end
+
+        text = text.strip
+        text = GitHub::Markdown.render text
+        text.html_safe
+      end
+
+    end
+  end
+end

data/lib/almodovar/resource_presenter/json_serializer.rb

@@ -0,0 +1,31 @@
+module Almodovar
+  class ResourcePresenter
+    class JsonSerializer < Serializer
+        
+      def to_json
+        require 'yajl'
+        Yajl::Encoder.encode(as_json, :pretty => true) + "\n"
+      end
+      
+      def as_json
+        ActiveSupport::OrderedHash[:resource_type, resource.resource_type].tap do |message|
+          message.merge! attributes_as_json
+          message.merge! links_as_json
+        end
+      end
+      
+      private
+      
+      def attributes_as_json
+        resource.attributes
+      end
+
+      def links_as_json
+        resource.all_links.inject(ActiveSupport::OrderedHash.new) do |message, link|
+          message.merge! link.as_json(options_for_link)
+        end
+      end
+        
+    end
+  end
+end

data/lib/almodovar/resource_presenter/link.rb

@@ -1,103 +1,103 @@
 module Almodovar
-  
-  class ResourcePresenter::Link
-    
-    attr_reader :rel, :href, :expand_resource, :expand_args
-    
-    def initialize(*args)
-      @rel, @href, @expand_resource, @expand_args = args
-    end
-    
-    def to_xml(options = {})
-      XmlSerializer.new(self, options.merge(:skip_instruct => true)).to_xml
-    end
-    
-    def as_json(options)
-      JsonSerializer.new(self, options).as_json
-    end
-    
-    def resource
-      resource_collection? ? resource_collection : single_resource
-    end
-    
-    def resource_collection?
-      expand_args.is_a?(Array)
-    end
-    
-    def resource_collection
-      ResourcePresenter::Collection.new(expand_resource, expand_args)
-    end
-    
-    def single_resource
-      expand_resource.new(*[expand_args].compact)        
-    end
-    
-    def expand_resource?
-      expand_resource.present?
-    end
-    
-    class Serializer
+  class ResourcePresenter
+    class Link
       
-      attr_reader :link, :options
+      attr_reader :rel, :href, :expand_resource, :expand_args
       
-      def initialize(link, options)
-        @link = link
-        @options = options
+      def initialize(*args)
+        @rel, @href, @expand_resource, @expand_args = args
       end
       
-      def expands?
-        link.expand_resource? && 
-        Array(options[:expand]).include?(link.rel) && 
-        !Array(options[:dont_expand]).include?(link.href)
+      def to_xml(options = {})
+        XmlSerializer.new(self, options.merge(:skip_instruct => true)).to_xml
       end
       
-      def dont_expand_link!
-        (options[:dont_expand] ||= []) << link.href
+      def as_json(options)
+        JsonSerializer.new(self, options).as_json
       end
       
-    end
-    
-    class XmlSerializer < Serializer
-      
-      def to_xml
-        builder.link :rel => link.rel, :href => link.href, &expand_block
+      def resource
+        resource_collection? ? resource_collection : single_resource
       end
       
-      private
-      
-      def builder
-        options[:builder]
+      def resource_collection?
+        expand_args.is_a?(Array)
       end
       
-      def expand_block
-        Proc.new { expand_resource } if expands?
+      def resource_collection
+        ResourcePresenter::Collection.new(expand_resource, expand_args)
       end
-
-      def expand_resource
-        dont_expand_link!
-        link.resource.to_xml(options)
+      
+      def single_resource
+        expand_resource.new(*[expand_args].compact)        
       end
       
-    end
-    
-    class JsonSerializer < Serializer
+      def expand_resource?
+        expand_resource.present?
+      end
       
-      def as_json
-        ActiveSupport::OrderedHash.new.tap do |message|
-          message["#{link.rel}_link"] = link.href
-          message[link.rel] = expand_resource if expands?
+      class Serializer
+        
+        attr_reader :link, :options
+        
+        def initialize(link, options)
+          @link = link
+          @options = options
         end
+        
+        def expands?
+          link.expand_resource? && 
+          Array(options[:expand]).include?(link.rel) && 
+          !Array(options[:dont_expand]).include?(link.href)
+        end
+        
+        def dont_expand_link!
+          (options[:dont_expand] ||= []) << link.href
+        end
+        
       end
       
-      private
-      
-      def expand_resource
-        dont_expand_link!
-        link.resource.as_json(options)
+      class XmlSerializer < Serializer
+        
+        def to_xml
+          builder.link :rel => link.rel, :href => link.href, &expand_block
+        end
+        
+        private
+        
+        def builder
+          options[:builder]
+        end
+        
+        def expand_block
+          Proc.new { expand_resource } if expands?
+        end
+
+        def expand_resource
+          dont_expand_link!
+          link.resource.to_xml(options)
+        end
+        
       end
+      
+      class JsonSerializer < Serializer
+        
+        def as_json
+          ActiveSupport::OrderedHash.new.tap do |message|
+            message["#{link.rel}_link"] = link.href
+            message[link.rel] = expand_resource if expands?
+          end
+        end
+        
+        private
+        
+        def expand_resource
+          dont_expand_link!
+          link.resource.as_json(options)
+        end
 
+      end
+      
     end
-    
   end
-
-end
+end

data/lib/almodovar/resource_presenter/metadata.rb

@@ -0,0 +1,27 @@
+module Almodovar
+  class ResourcePresenter
+    module Metadata
+
+      def inherited(base)
+        base.metadata[:name] = base.name.demodulize.titleize
+      end
+
+      def desc(description)
+        metadata[:desc] = description
+      end
+
+      def link(name, options)
+        metadata[:links][name] = options
+      end
+
+      def attribute(name, options)
+        metadata[:attributes][name] = options
+      end
+
+      def metadata
+        @metadata ||= Hash.new {|h,a| h[a] = ActiveSupport::OrderedHash.new}
+      end
+
+    end
+  end
+end

data/lib/almodovar/resource_presenter/serializer.rb

@@ -0,0 +1,18 @@
+module Almodovar
+  class ResourcePresenter
+    class Serializer
+      
+      attr_reader :resource, :options
+      
+      def initialize(resource, options = {})
+        @resource = resource
+        @options  = options
+      end
+
+      def options_for_link
+        options.merge(:dont_expand => Array(options[:dont_expand]) << resource.url)
+      end
+
+    end
+  end
+end

data/lib/almodovar/resource_presenter/template.html.erb

@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html lang='en'>
+  <head>
+    <meta charset='utf-8'/>
+    <style type='text/css'>
+      .highlight .hll { background-color: #ffffcc }
+      .highlight  { background: #f8f8f8; }
+      .highlight .c { color: #408080; font-style: italic } /* Comment */
+      .highlight .err { border: 1px solid #FF0000 } /* Error */
+      .highlight .k { color: #008000; font-weight: bold } /* Keyword */
+      .highlight .o { color: #666666 } /* Operator */
+      .highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+      .highlight .cp { color: #BC7A00 } /* Comment.Preproc */
+      .highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
+      .highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
+      .highlight .gd { color: #A00000 } /* Generic.Deleted */
+      .highlight .ge { font-style: italic } /* Generic.Emph */
+      .highlight .gr { color: #FF0000 } /* Generic.Error */
+      .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+      .highlight .gi { color: #00A000 } /* Generic.Inserted */
+      .highlight .go { color: #808080 } /* Generic.Output */
+      .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+      .highlight .gs { font-weight: bold } /* Generic.Strong */
+      .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+      .highlight .gt { color: #0040D0 } /* Generic.Traceback */
+      .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+      .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+      .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+      .highlight .kp { color: #008000 } /* Keyword.Pseudo */
+      .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+      .highlight .kt { color: #B00040 } /* Keyword.Type */
+      .highlight .m { color: #666666 } /* Literal.Number */
+      .highlight .s { color: #BA2121 } /* Literal.String */
+      .highlight .na { color: #7D9029 } /* Name.Attribute */
+      .highlight .nb { color: #008000 } /* Name.Builtin */
+      .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+      .highlight .no { color: #880000 } /* Name.Constant */
+      .highlight .nd { color: #AA22FF } /* Name.Decorator */
+      .highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+      .highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+      .highlight .nf { color: #0000FF } /* Name.Function */
+      .highlight .nl { color: #A0A000 } /* Name.Label */
+      .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+      .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+      .highlight .nv { color: #19177C } /* Name.Variable */
+      .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+      .highlight .w { color: #bbbbbb } /* Text.Whitespace */
+      .highlight .mf { color: #666666 } /* Literal.Number.Float */
+      .highlight .mh { color: #666666 } /* Literal.Number.Hex */
+      .highlight .mi { color: #666666 } /* Literal.Number.Integer */
+      .highlight .mo { color: #666666 } /* Literal.Number.Oct */
+      .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+      .highlight .sc { color: #BA2121 } /* Literal.String.Char */
+      .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+      .highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+      .highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+      .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+      .highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+      .highlight .sx { color: #008000 } /* Literal.String.Other */
+      .highlight .sr { color: #BB6688 } /* Literal.String.Regex */
+      .highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+      .highlight .ss { color: #19177C } /* Literal.String.Symbol */
+      .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+      .highlight .vc { color: #19177C } /* Name.Variable.Class */
+      .highlight .vg { color: #19177C } /* Name.Variable.Global */
+      .highlight .vi { color: #19177C } /* Name.Variable.Instance */
+      .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
+
+      body {
+        padding-top: 30px;
+      }
+    </style>
+    <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet">
+  </head>
+  <body>
+    <div class='container'>
+
+      <ul class="nav nav-tabs">
+        <li><a href="#xml"  data-toggle="tab">XML</a> </li>
+        <li><a href="#json" data-toggle="tab">JSON</a> </li>
+        <li><a href="#help" data-toggle="tab">Reference</a> </li>
+      </ul>
+
+      <div class="tab-content">
+        <div class="tab-pane" id="xml">
+          <%= beautify resource.to_xml(options),  :xml %>
+        </div>
+        <div class="tab-pane" id="json">
+          <p><em>JSON support is experimental and it's subject to change in the future</em></p>
+          <%= beautify resource.to_json(options), :json %>
+        </div>
+        <div class="tab-pane" id="help">
+          <h2><%= metadata[:name] %></h2>
+          <%= metadata_text metadata[:desc] %>
+          <% if metadata[:attributes].present? %>
+          <h3>Attributes</h3>
+          <dl>
+            <% metadata[:attributes].each do |name, options| %>
+              <dt><%= name %></dt>
+              <dd><%= metadata_text options[:desc] %></dd>
+            <% end %> 
+          </dl>
+          <% end %>
+          <% if metadata[:links].present? %>
+          <h3>Links</h3>
+          <dl>
+            <% metadata[:links].each do |name, options| %>
+              <dt><%= name %></dt>
+              <dd><%= metadata_text options[:desc] %></dd>
+            <% end %> 
+          </dl>
+          <% end %>
+        </div>
+      </div>
+
+      <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
+      <script src="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
+      <script>
+      $(function () {
+        var currentTab = localStorage.currentTab || '#xml'
+        $('ul.nav a[href="' + currentTab + '"]').tab('show')
+
+        $('a[data-toggle="tab"]').on('shown', function (e) {
+          localStorage.currentTab = $(e.target).attr('href')
+        })
+      })
+      </script>
+    </div>
+  </body>
+</html>

data/lib/almodovar/resource_presenter/xml_serializer.rb

@@ -0,0 +1,25 @@
+module Almodovar
+  class ResourcePresenter
+    class XmlSerializer < Serializer
+        
+      def to_xml
+        attributes_to_xml do |builder|
+          links_to_xml builder
+        end
+      end
+      
+      private
+      
+      def attributes_to_xml(&block)
+        resource.attributes.to_xml(options.merge(:root => resource.resource_type), &block)
+      end
+
+      def links_to_xml(builder)
+        resource.all_links.each do |link|
+          link.to_xml(options_for_link.merge(:builder => builder))
+        end
+      end
+
+    end
+  end
+end

data/lib/almodovar/resource_presenter.rb

@@ -2,6 +2,14 @@ module Almodovar
   
   class ResourcePresenter
     
+    autoload :Serializer,     'almodovar/resource_presenter/serializer'
+    autoload :XmlSerializer,  'almodovar/resource_presenter/xml_serializer'
+    autoload :JsonSerializer, 'almodovar/resource_presenter/json_serializer'
+    autoload :HtmlSerializer, 'almodovar/resource_presenter/html_serializer'
+    autoload :Metadata,       'almodovar/resource_presenter/metadata'
+
+    extend Metadata
+
     attr_accessor :url
     
     def attributes
@@ -16,8 +24,12 @@ module Almodovar
       name.gsub(/Resource$/, '').underscore
     end
     
+    def resource_class
+      self.class
+    end
+
     def resource_type
-      self.class.resource_type
+      resource_class.resource_type
     end
 
     def to_xml(options = {})
@@ -31,6 +43,10 @@ module Almodovar
     def as_json(options = {})
       JsonSerializer.new(self, options).as_json
     end
+
+    def to_html(options = {})
+      HtmlSerializer.new(self, options).to_html
+    end
     
     def all_links
       ([link_to_self] + links).compact
@@ -39,71 +55,6 @@ module Almodovar
     def link_to_self
       Link.new(:self, @url) if @url
     end
-    
-    class Serializer
-      
-      attr_reader :resource, :options
-      
-      def initialize(resource, options)
-        @resource = resource
-        @options  = options
-      end
-
-      def options_for_link
-        options.merge(:dont_expand => Array(options[:dont_expand]) << resource.url)
-      end
-      
-    end
-    
-    class XmlSerializer < Serializer
-      
-      def to_xml
-        attributes_to_xml do |builder|
-          links_to_xml builder
-        end
-      end
-      
-      private
-      
-      def attributes_to_xml(&block)
-        resource.attributes.to_xml(options.merge(:root => resource.resource_type), &block)
-      end
-
-      def links_to_xml(builder)
-        resource.all_links.each do |link|
-          link.to_xml(options_for_link.merge(:builder => builder))
-        end
-      end
-
-    end
-    
-    class JsonSerializer < Serializer
-      
-      def to_json
-        require 'yajl'
-        Yajl::Encoder.encode(as_json, :pretty => true) + "\n"
-      end
-      
-      def as_json
-        ActiveSupport::OrderedHash[:resource_type, resource.resource_type].tap do |message|
-          message.merge! attributes_as_json
-          message.merge! links_as_json
-        end
-      end
-      
-      private
-      
-      def attributes_as_json
-        resource.attributes
-      end
-
-      def links_as_json
-        resource.all_links.inject(ActiveSupport::OrderedHash.new) do |message, link|
-          message.merge! link.as_json(options_for_link)
-        end
-      end
-      
-    end
 
   end
   

data/lib/almodovar/version.rb

@@ -1,3 +1,3 @@
 module Almodovar
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: almodovar
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - BeBanjo S.L.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-10 00:00:00 Z
+date: 2013-03-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: patron
@@ -117,7 +117,13 @@ files:
 - lib/almodovar/resource.rb
 - lib/almodovar/resource_collection.rb
 - lib/almodovar/resource_presenter/collection.rb
+- lib/almodovar/resource_presenter/html_serializer.rb
+- lib/almodovar/resource_presenter/json_serializer.rb
 - lib/almodovar/resource_presenter/link.rb
+- lib/almodovar/resource_presenter/metadata.rb
+- lib/almodovar/resource_presenter/serializer.rb
+- lib/almodovar/resource_presenter/template.html.erb
+- lib/almodovar/resource_presenter/xml_serializer.rb
 - lib/almodovar/resource_presenter.rb
 - lib/almodovar/single_resource.rb
 - lib/almodovar/to_xml.rb
@@ -153,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: BeBanjo API client