aweplug 1.0.0.a16 → 1.0.0.a17

data/lib/aweplug/cache/yaml_file_cache.rb

@@ -1,95 +1,98 @@
 require 'yaml/store'
 require 'fileutils'
 
-module Aweplug::Cache
-  # Public: A simple caching implementation.
-  #         Internally it using a YAML::Store for a file backing. It also saves
-  #         data in a hash for the life of the object. Any keys which are 
-  #         Strings are frozen before being used.
-  class YamlFileCache
-    # Public: Initialization method.
-    #
-    # opts - A Hash of options
-    #         filename: Name of the File used for caching. Defaults to 
-    #         'tmp/cache.store'.
-    #
-    # Examples
-    #
-    #   store = Aweplug::Cache::YamlFileCache.new
-    #   store.write('key', 'data')
-    #   # => 'data'
-    #   store.read('key')
-    #   # => 'data'
-    #
-    # Returns a new instance of the cache.
-    def initialize(opts = {})
-      opts.merge!({filename: '_tmp/cache.store'})
-      FileUtils.mkdir_p(File.dirname opts[:filename])
-      @file_store = YAML::Store.new opts[:filename]
-      @memory_store = {}
-    end
+module Aweplug
+  module Cache
+    # Public: A simple caching implementation.
+    #         Internally it using a YAML::Store for a file backing. It also saves
+    #         data in a hash for the life of the object. Any keys which are 
+    #         Strings are frozen before being used.
+    class YamlFileCache
+      # Public: Initialization method.
+      #
+      # opts - A Hash of options
+      #         filename: Name of the File used for caching. Defaults to 
+      #         'tmp/cache.store'.
+      #
+      # Examples
+      #
+      #   store = Aweplug::Cache::YamlFileCache.new
+      #   store.write('key', 'data')
+      #   # => 'data'
+      #   store.read('key')
+      #   # => 'data'
+      #
+      # Returns a new instance of the cache.
+      def initialize(opts = {})
+        opts.merge!({filename: '_tmp/cache.store'})
+        FileUtils.mkdir_p(File.dirname opts[:filename])
+        @file_store = YAML::Store.new opts[:filename]
+        @memory_store = {}
+      end
 
-    # Public: Retrieves the data stored previously under the given key.
-    #
-    # key - key part of a key value pair
-    #
-    # Examples
-    #
-    #   store.read('my_key')
-    #   # => 'my_data'
-    #
-    # Returns the data associated with the key.
-    def read(key)
-      key.freeze if key.is_a? String
+      # Public: Retrieves the data stored previously under the given key.
+      #
+      # key - key part of a key value pair
+      #
+      # Examples
+      #
+      #   store.read('my_key')
+      #   # => 'my_data'
+      #
+      # Returns the data associated with the key.
+      def read(key)
+        key.freeze if key.is_a? String
 
-      if @memory_store.has_key? key
-        @memory_store[key]
-      else
-        @file_store.transaction do
-          @memory_store[key] = @file_store[key]
+        if @memory_store.has_key? key
+          @memory_store[key]
+        else
+          @file_store.transaction do
+            @memory_store[key] = @file_store[key]
+          end
+          @memory_store[key]
         end
-        @memory_store[key]
       end
-    end
 
-    # Public: Adds data to the cache.
-    #
-    # key   - A key for the cache, strings or symbols should be used
-    # value - Data to store in the cache
-    #
-    # Examples
-    #   
-    #   store.write(:pi, 3.14)
-    #   # => 3.14
-    #
-    # Returns the data just saved.
-    def write(key, value)
-      key.freeze if key.is_a? String
+      # Public: Adds data to the cache.
+      #
+      # key   - A key for the cache, strings or symbols should be used
+      # value - Data to store in the cache
+      #
+      # Examples
+      #   
+      #   store.write(:pi, 3.14)
+      #   # => 3.14
+      #
+      # Returns the data just saved.
+      def write(key, value)
+        key.freeze if key.is_a? String
 
-      @memory_store[key] = value
-      @file_store.transaction do
-        @file_store[key] = value
+        @memory_store[key] = value
+        @file_store.transaction do
+          @file_store[key] = value
+        end
       end
-    end
 
-    # Public: Retreives the value from the cache, or the return of the Block.
-    #
-    # key   - Key in the cache to retreive.
-    # block - The block to be evaluated for a default value.
-    #
-    # Examples
-    #
-    #   store.fetch(key) { 'new data' }
-    #   # => 'new data'
-    #   store.write(key, 23)
-    #   store.fetch(key) { 'new data' }
-    #   # => 23
-    #
-    # Returns the value in the cache, or the default supplied from the block.
-    def fetch(key) 
-      key.freeze if key.is_a? String
+      # Public: Retreives the value from the cache, or the return of the Block.
+      #
+      # key   - Key in the cache to retreive.
+      # block - The block to be evaluated for a default value.
+      #
+      # Examples
+      #
+      #   store.fetch(key) { 'new data' }
+      #   # => 'new data'
+      #   store.write(key, 23)
+      #   store.fetch(key) { 'new data' }
+      #   # => 23
+      #
+      # Returns the value in the cache, or the default supplied from the block.
+      def fetch(key) 
+        key.freeze if key.is_a? String
 
-      read(key) || yield.tap { |data| write(key, data) }
+        read(key) || yield.tap { |data| write(key, data) }
+      end
     end
   end
 end
+

data/lib/aweplug/extensions/asciidoc_example.rb

@@ -5,125 +5,126 @@ require 'aweplug/helpers/searchisko'
 require 'json'
 require 'pry'
 
-module Aweplug::Extensions
-  # Public: An awestruct extension for guides / examples written in AsciiDoc.
-  #         Files with the .asciidoc or .adoc extension are considered to be
-  #         AsciiDoc files. This extension makes use of asciidoctor to 
-  #         render the files.
-  #
-  # Example
-  #
-  #   extension Aweplug::Extensions::AsciidocExample({...})
-  class AsciidocExample 
-    include Aweplug::Helper::Git::Commit::Metadata
-    include Aweplug::Helper::Git::Repository
-
-    # Public: Initialization method, used in the awestruct pipeline.
+module Aweplug
+  module Extensions
+    # Public: An awestruct extension for guides / examples written in AsciiDoc.
+    #         Files with the .asciidoc or .adoc extension are considered to be
+    #         AsciiDoc files. This extension makes use of asciidoctor to 
+    #         render the files.
+    #
+    # Example
     #
-    # opts - A Hash of options, some being required, some not (default: {}). 
-    #        :repository               - The String name of the directory 
-    #                                    containing the repository (required).
-    #        :directory                - The String directory name, within the
-    #                                    :respository, containing the files 
-    #                                    (required).
-    #        :layout                   - The String name of the layout to use, 
-    #                                    omitting the extension (required).
-    #        :output_dir               - The String or Pathname of the output 
-    #                                    directory for the files (required).
-    #        :additional_excludes      - An Array of Strings containing 
-    #                                    additional base file names to exclude 
-    #                                    (default: []).
-    #        :recurse_subdirectories   - Boolean flag indicating to continue 
-    #                                    searching subdirectories (default: 
-    #                                    true).
-    #        :additional_metadata_keys - An Array of String keys from the 
-    #                                    AsciiDoc metadata to include in the 
-    #                                    searchisko payload (default: []).
-    #        :site_variable            - String name of the key within the site
-    #                                    containing additional metadata about 
-    #                                    the guide (default: value of 
-    #                                    :output_dir).
-    # Returns the created extension.
-    def initialize(opts = {})
-      required_keys = [:repository, :directory, :layout, :output_dir, :site_variable]
-      opts = {additional_excludes: [], recurse_subdirectories: true, 
-              additional_metadata_keys: [], site_variable: opts[:output_dir]}.merge opts
-      missing_required_keys = required_keys - opts.keys
+    #   extension Aweplug::Extensions::AsciidocExample({...})
+    class AsciidocExample 
+      include Aweplug::Helper::Git::Commit::Metadata
+      include Aweplug::Helper::Git::Repository
 
-      raise ArgumentError.new "Missing required arguments #{missing_required_keys.join ', '}" unless missing_required_keys.empty?
+      # Public: Initialization method, used in the awestruct pipeline.
+      #
+      # opts - A Hash of options, some being required, some not (default: {}). 
+      #        :repository               - The String name of the directory 
+      #                                    containing the repository (required).
+      #        :directory                - The String directory name, within the
+      #                                    :respository, containing the files 
+      #                                    (required).
+      #        :layout                   - The String name of the layout to use, 
+      #                                    omitting the extension (required).
+      #        :output_dir               - The String or Pathname of the output 
+      #                                    directory for the files (required).
+      #        :additional_excludes      - An Array of Strings containing 
+      #                                    additional base file names to exclude 
+      #                                    (default: []).
+      #        :recurse_subdirectories   - Boolean flag indicating to continue 
+      #                                    searching subdirectories (default: 
+      #                                    true).
+      #        :additional_metadata_keys - An Array of String keys from the 
+      #                                    AsciiDoc metadata to include in the 
+      #                                    searchisko payload (default: []).
+      #        :site_variable            - String name of the key within the site
+      #                                    containing additional metadata about 
+      #                                    the guide (default: value of 
+      #                                    :output_dir).
+      # Returns the created extension.
+      def initialize(opts = {})
+        required_keys = [:repository, :directory, :layout, :output_dir, :site_variable]
+        opts = {additional_excludes: [], recurse_subdirectories: true, 
+                additional_metadata_keys: [], site_variable: opts[:output_dir]}.merge opts
+        missing_required_keys = required_keys - opts.keys
 
-      @repo = opts[:repository]
-      @output_dir = Pathname.new opts[:output_dir]
-      @layout = opts[:layout]
-      @recurse_subdirectories = opts[:recurse_subdirectories]
-      @additional_metadata_keys = opts[:additional_metadata_keys]
-      @additional_excludes = opts[:additional_excludes]
-      @directory = File.join opts[:repository], opts[:directory]
-      @site_variable = opts[:site_variable]
-    end
+        raise ArgumentError.new "Missing required arguments #{missing_required_keys.join ', '}" unless missing_required_keys.empty?
 
-    # Internal: Execute method required by awestruct. Called during the
-    # pipeline execution. No return.
-    #
-    # site - The site instance from awestruct.
-    #
-    # Returns nothing.
-    def execute site
-      searchisko = Aweplug::Helpers::Searchisko.new({:base_url => site.dcp_base_url, 
-                                                     :authenticate => true, 
-                                                     :searchisko_username => ENV['dcp_user'], 
-                                                     :searchisko_password => ENV['dcp_password'], 
-                                                     :logger => site.profile == 'developement'})
-      Find.find @directory do |path|
-        Find.prune if File.directory?(path) && !@recurse_subdirectories
+        @repo = opts[:repository]
+        @output_dir = Pathname.new opts[:output_dir]
+        @layout = opts[:layout]
+        @recurse_subdirectories = opts[:recurse_subdirectories]
+        @additional_metadata_keys = opts[:additional_metadata_keys]
+        @additional_excludes = opts[:additional_excludes]
+        @directory = File.join opts[:repository], opts[:directory]
+        @site_variable = opts[:site_variable]
+      end
 
-        next if File.directory?(path) # If it's a directory, start recursing
+      # Internal: Execute method required by awestruct. Called during the
+      # pipeline execution. No return.
+      #
+      # site - The site instance from awestruct.
+      #
+      # Returns nothing.
+      def execute site
+        searchisko = Aweplug::Helpers::Searchisko.new({:base_url => site.dcp_base_url, 
+                                                       :authenticate => true, 
+                                                       :searchisko_username => ENV['dcp_user'], 
+                                                       :searchisko_password => ENV['dcp_password'], 
+                                                       :logger => site.profile == 'developement'})
+        Find.find @directory do |path|
+          Find.prune if File.directory?(path) && !@recurse_subdirectories
 
-        Find.prune if File.extname(path) !~ /\.a(scii)?doc/ || @additional_excludes.include?(File.basename path)
+          next if File.directory?(path) # If it's a directory, start recursing
 
-        page = site.engine.load_site_page path
-        page.layout = @layout
-        page.output_path = File.join(@output_dir, File.basename(page.output_path))
+          Find.prune if File.extname(path) !~ /\.a(scii)?doc/ || @additional_excludes.include?(File.basename path)
 
-        doc = Asciidoctor.load_file path
-        metadata = {:author => doc.author, :commits => commit_info(@repo, path), 
-                    :title => doc.doctitle, :tags => doc.attributes['tags'],
-                    :toc => doc.sections.inject([]) {|result, elm| result << {:id => elm.id, :text => elm.title}; result},
-                    :github_repo_url => repository_url(@repo),
-                    # Will need to strip html tags for summary
-                    :summary => doc.sections.first.render}
+          page = site.engine.load_site_page path
+          page.layout = @layout
+          page.output_path = File.join(@output_dir, File.basename(page.output_path))
 
-        page.send('metadata=', metadata)
-        site.pages << page
+          doc = Asciidoctor.load_file path
+          metadata = {:author => doc.author, :commits => commit_info(@repo, path), 
+                      :title => doc.doctitle, :tags => doc.attributes['tags'],
+                      :toc => doc.sections.inject([]) {|result, elm| result << {:id => elm.id, :text => elm.title}; result},
+                      :github_repo_url => repository_url(@repo),
+                      # Will need to strip html tags for summary
+                      :summary => doc.sections.first.render}
 
-        searchisko_hash = {
-          :sys_title => metadata[:title], 
-          :sys_content_id => Digest::SHA1.hexdigest(metadata[:title])[0..7], # maybe change?
-          :sys_description => metadata[:summary],
-          :sys_content => doc.render, 
-          :sys_url_view => "#{site.base_url}#{site.ctx_root.nil? ? '/' : '/' + site.ctx_root + '/'}#{page.output_path}",
-          :"sys_content_content-type" => 'text/html',
-          :sys_type => 'jbossdeveloper_example',
-          :sys_content_type => 'example',
-          :sys_content_provider => 'jboss-developer',
-          :contributors => metadata[:commits].collect { |c| c[:author] }.unshift(metadata[:author]).uniq,
-          :sys_created => metadata[:commits].collect { |c| DateTime.parse c[:date] }.last,
-          :sys_activity_dates => metadata[:commits].collect { |c| DateTime.parse c[:date] },
-          :sys_updated => metadata[:commits].collect { |c| DateTime.parse c[:date] }.first
-        } 
+          page.send('metadata=', metadata)
+          site.pages << page
 
-        @additional_metadata_keys.inject(searchisko_hash) do |hash, key|
-          hash[key.to_sym] = doc.attributes[key]
-          hash
-        end
+          searchisko_hash = {
+            :sys_title => metadata[:title], 
+            :sys_content_id => Digest::SHA1.hexdigest(metadata[:title])[0..7], # maybe change?
+            :sys_description => metadata[:summary],
+            :sys_content => doc.render, 
+            :sys_url_view => "#{site.base_url}#{site.ctx_root.nil? ? '/' : '/' + site.ctx_root + '/'}#{page.output_path}",
+            :"sys_content_content-type" => 'text/html',
+            :sys_type => 'jbossdeveloper_example',
+            :sys_content_type => 'example',
+            :sys_content_provider => 'jboss-developer',
+            :contributors => metadata[:commits].collect { |c| c[:author] }.unshift(metadata[:author]).uniq,
+            :sys_created => metadata[:commits].collect { |c| DateTime.parse c[:date] }.last,
+            :sys_activity_dates => metadata[:commits].collect { |c| DateTime.parse c[:date] },
+            :sys_updated => metadata[:commits].collect { |c| DateTime.parse c[:date] }.first
+          } 
 
-        unless site.profile =~ /development/
-          searchisko.push_content(searchisko_hash[:sys_type], 
-                                  searchisko_hash[:sys_content_id], 
-                                  searchisko_hash.to_json)
+          @additional_metadata_keys.inject(searchisko_hash) do |hash, key|
+            hash[key.to_sym] = doc.attributes[key]
+            hash
+          end
+
+          unless site.profile =~ /development/
+            searchisko.push_content(searchisko_hash[:sys_type], 
+                                    searchisko_hash[:sys_content_id], 
+                                    searchisko_hash.to_json)
+          end
         end
       end
     end
   end
 end
-

data/lib/aweplug/extensions/kramdown_quickstart.rb

@@ -33,6 +33,8 @@ module Aweplug
         #                         containing additional metadata about 
         #                         the guide (default: value of 
         #                         :output_dir).
+        #        :excludes     -  Array of Strings containing additional 
+        #                         directory names to exclude. Defaults to [].
         # Returns the created extension.
         def initialize opts = {}
           required_keys = [:repository, :layout, :output_dir]
@@ -43,6 +45,7 @@ module Aweplug
           @output_dir = Pathname.new opts[:output_dir]
           @layout = opts[:layout]
           @site_variable = opts[:site_variable] || opts[:output_dir]
+          @excludes = opts[:excludes] || []
         end
 
         # Internal: Execute method required by awestruct. Called during the
@@ -60,6 +63,8 @@ module Aweplug
                                                          :searchisko_password => ENV['dcp_password'], 
                                                          :logger => site.profile == 'developement'})
           Dir["#{@repo}/**/README.md"].each do |file|
+            next if @excludes.include?(File.dirname(file))
+            
             page = add_to_site site, file
 
             metadata = extract_metadata(file)

data/lib/aweplug/extensions/vimeo.rb

@@ -0,0 +1,76 @@
+require 'aweplug/helpers/vimeo'
+require 'json'
+
+module Aweplug
+  module Extensions
+    module Video
+      # Public: Awestruct Extension which iterates over a site variable which 
+      # contains vimeo URLs and creates pages out of them, also sends the info 
+      # over to a searchisko instance for indexing.
+      class Vimeo
+        include Aweplug::Helpers::Vimeo
+
+        # Public: Creates a new instance of this Awestruct plugin.
+        #
+        # variable_name - Name of the variable in the Awestruct Site containing
+        #                 the list of vimeo videos.
+        # layout        - Name of the layout to be used for the generated Pages.
+        #
+        # Returns a new instance of this extension.                
+        def initialize variable_name, layout
+          @variable = variable_name
+          @layout = layout
+        end
+
+        def execute site 
+          @site = site
+          searchisko = Aweplug::Helpers::Searchisko.new({:base_url => site.dcp_base_url, 
+                                                         :authenticate => true, 
+                                                         :searchisko_username => ENV['dcp_user'], 
+                                                         :searchisko_password => ENV['dcp_password'], 
+                                                         :logger => site.profile == 'developement'})
+
+          site[@variable].each do |url|
+            id = url.match(/^.*\/(\d*)$/)[1] 
+            page_path = Pathname.new(File.join 'video', 'vimeo', "#{id}.html")
+            page = ::Awestruct::Page.new(site,
+                     ::Awestruct::Handlers::LayoutHandler.new(site,
+                       ::Awestruct::Handlers::TiltHandler.new(site,
+                         ::Aweplug::Handlers::SyntheticHandler.new(site, '', page_path))))
+            page.layout = @layout
+            page.output_path = File.join 'video', 'vimeo', id,'index.html'
+            video = Aweplug::Helpers::Vimeo::Video.new url, access_token, site
+            page.send('video=', video)
+            page.send('video_url=', url)
+            site.pages << page 
+
+            unless video.fetch_info['title'].include? 'Unable to fetch'
+              searchisko_payload = {
+                :sys_type => 'jbossdeveloper_video',
+                :sys_content_provider => 'jboss-developer',
+                :sys_content_type => 'video',
+                :sys_content_id => video.id,
+                :sys_updated => video.modified_date,
+                :sys_contributors => video.cast,
+                :sys_activity_dates => [video.modified_date, video.upload_date],
+                :sys_created => video.upload_date,
+                :sys_title => video.title,
+                :sys_url_view => "http://vimeo.com/#{video.id}",
+                :sys_description => video.description,
+                :duration => video.duration,
+                :thumbnail => video.thumb_url,
+                :tag => video.tags
+              }
+
+              unless site.profile =~ /development/
+                searchisko.push_content(searchisko_payload[:sys_type], 
+                  searchisko_payload[:sys_content_id], 
+                  searchisko_payload.to_json)
+              end 
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aweplug/helpers/searchisko.rb

@@ -2,103 +2,106 @@ require 'faraday'
 require 'faraday_middleware' 
 require 'aweplug/cache/yaml_file_cache'
 
-module Aweplug::Helpers
-  # Public: A helper class for using Searchisko.
-  class Searchisko 
-    # Public: Initialization of the object, keeps a Faraday connection cached.
-    #
-    # opts - symbol keyed hash. Current keys used:
-    #        :base_url - base url for the searchisko instance
-    #        :authenticate - boolean flag for authentication
-    #        :searchisko_username - Username to use for auth
-    #        :searchisko_password - Password to use for auth
-    #        :logging - Boolean to log responses
-    #        :raise_error - Boolean flag if 404 and 500 should raise exceptions
-    #        :adapter - faraday adapter to use, defaults to :net_http
-    #
-    # Returns a new instance of Searchisko.
-    def initialize opts={} 
-      @faraday = Faraday.new(:url => opts[:base_url]) do |builder|
-        if opts[:authenticate]
-          if opts[:searchisko_username] && opts[:searchisko_password]
-            builder.request :basic_auth, opts[:searchisko_username], opts[:searchisko_password]
-          else
-            $LOG.warn 'Missing username and / or password for searchisko'
+module Aweplug
+  module Helpers
+    # Public: A helper class for using Searchisko.
+    class Searchisko 
+      # Public: Initialization of the object, keeps a Faraday connection cached.
+      #
+      # opts - symbol keyed hash. Current keys used:
+      #        :base_url - base url for the searchisko instance
+      #        :authenticate - boolean flag for authentication
+      #        :searchisko_username - Username to use for auth
+      #        :searchisko_password - Password to use for auth
+      #        :logging - Boolean to log responses
+      #        :raise_error - Boolean flag if 404 and 500 should raise exceptions
+      #        :adapter - faraday adapter to use, defaults to :net_http
+      #
+      # Returns a new instance of Searchisko.
+      def initialize opts={} 
+        @faraday = Faraday.new(:url => opts[:base_url]) do |builder|
+          if opts[:authenticate]
+            if opts[:searchisko_username] && opts[:searchisko_password]
+              builder.request :basic_auth, opts[:searchisko_username], opts[:searchisko_password]
+            else
+              $LOG.warn 'Missing username and / or password for searchisko'
+            end
           end
+          builder.response :logger if opts[:logging]
+          builder.response :raise_error if opts[:raise_error]
+          builder.use FaradayMiddleware::Caching, Aweplug::Cache::YamlFileCache.new, {}
+          #builder.response :json, :content_type => /\bjson$/
+          builder.adapter opts[:adapter] || :net_http
         end
-        builder.response :logger if opts[:logging]
-        builder.response :raise_error if opts[:raise_error]
-        builder.use FaradayMiddleware::Caching, Aweplug::Cache::YamlFileCache.new, {}
-        #builder.response :json, :content_type => /\bjson$/
-        builder.adapter opts[:adapter] || :net_http
       end
-    end
 
-    # Public: Performs a GET search against the Searchisko instance using 
-    # provided parameters.
-    #
-    # params - Hash of parameters to use as query string. See
-    #          http://docs.jbossorg.apiary.io/#searchapi for more information
-    #          about parameters and how they affect the search.
-    #
-    # Example
-    #
-    #   searchisko.search {:query => 'Search query'}
-    #   # => {...}
-    #
-    # Returns the String result of the search.
-    def search params = {}
-      get '/search', params
-    end
+      # Public: Performs a GET search against the Searchisko instance using 
+      # provided parameters.
+      #
+      # params - Hash of parameters to use as query string. See
+      #          http://docs.jbossorg.apiary.io/#searchapi for more information
+      #          about parameters and how they affect the search.
+      #
+      # Example
+      #
+      #   searchisko.search {:query => 'Search query'}
+      #   # => {...}
+      #
+      # Returns the String result of the search.
+      def search params = {}
+        get '/search', params
+      end
 
-    # Public: Makes an HTTP GET to host/v1/rest/#{path} and returns the 
-    # result from the Faraday request.
-    #
-    # path   - String containing the rest of the path.
-    # params - Hash containing query string parameters.
-    #
-    # Example
-    #   
-    #   searchisko.get 'feed', {:query => 'Search Query'}
-    #   # => Faraday Response Object
-    #
-    # Returns the Faraday Response for the request.
-    def get path, params = {}
-      @faraday.get "/v1/rest/" + path, params
-    end
+      # Public: Makes an HTTP GET to host/v1/rest/#{path} and returns the 
+      # result from the Faraday request.
+      #
+      # path   - String containing the rest of the path.
+      # params - Hash containing query string parameters.
+      #
+      # Example
+      #   
+      #   searchisko.get 'feed', {:query => 'Search Query'}
+      #   # => Faraday Response Object
+      #
+      # Returns the Faraday Response for the request.
+      def get path, params = {}
+        @faraday.get "/v1/rest/" + path, params
+      end
 
-    # Public: Posts content to Searchisko.
-    #
-    # content_type - String of the Searchisko sys_content_type for the content 
-    #                being posted.
-    # content_id   - String of the Searchisko sys_content_id for the content.
-    # params       - Hash containing the content to push.
-    #
-    # Examples
-    #
-    #   searchisko.push_content 'jbossdeveloper_bom', id, content_hash
-    #   # => Faraday Response
-    #
-    # Returns a Faraday Response from the POST.
-    def push_content content_type, content_id, params = {}
-      post "/content/#{content_type}/#{content_id}", params
-    end
+      # Public: Posts content to Searchisko.
+      #
+      # content_type - String of the Searchisko sys_content_type for the content 
+      #                being posted.
+      # content_id   - String of the Searchisko sys_content_id for the content.
+      # params       - Hash containing the content to push.
+      #
+      # Examples
+      #
+      #   searchisko.push_content 'jbossdeveloper_bom', id, content_hash
+      #   # => Faraday Response
+      #
+      # Returns a Faraday Response from the POST.
+      def push_content content_type, content_id, params = {}
+        post "/content/#{content_type}/#{content_id}", params
+      end
 
-    # Public: Perform an HTTP POST to Searchisko.
-    #
-    # path   - String containing the rest of the path.
-    # params - Hash containing the POST body.
-    #
-    # Examples
-    #
-    #   searchisko.post "rating/#{searchisko_document_id}", {rating: 3}
-    #   # => Faraday Response
-    def post path, params = {}
-      @faraday.post do |req|
-        req.url "/v1/rest/" + path
-        req.headers['Content-Type'] = 'application/json'
-        req.body = params
+      # Public: Perform an HTTP POST to Searchisko.
+      #
+      # path   - String containing the rest of the path.
+      # params - Hash containing the POST body.
+      #
+      # Examples
+      #
+      #   searchisko.post "rating/#{searchisko_document_id}", {rating: 3}
+      #   # => Faraday Response
+      def post path, params = {}
+        @faraday.post do |req|
+          req.url "/v1/rest/" + path
+          req.headers['Content-Type'] = 'application/json'
+          req.body = params
+        end
       end
     end
   end
 end
+

data/lib/aweplug/helpers/vimeo.rb

@@ -59,11 +59,12 @@ module Aweplug
       #
       # full_name - the full name, e.g. Pete Muir
       def first_name(full_name)
-        full_name.split[0]
+        full_name.split[0] || full_name
       end
 
       # Internal: Data object to hold and parse values from the Vimeo API.
       class Video 
+        include Aweplug::Helpers::Vimeo
         def initialize(url, access_token, site)
           @id = url.match(/^.*\/(\d*)$/)[1]
           @site = site
@@ -106,23 +107,42 @@ module Aweplug
               end
             end
           end
-          out
+          out || ''
         end
 
         def author
           if @cast[0]
             @cast[0]
           else
-            @cast = Openstruct.new({"realname" => "Unknown"})
+            @cast = OpenStruct.new({"realname" => "Unknown"})
           end
         end
 
         def cast
-          @cast
+          @cast || ''
+        end
+
+        def modified_date
+          if @video["upload_date"]
+            DateTime.parse(@video["upload_date"]).strftime("%F %T")
+          else
+            "UNKOWN DATE"
+          end
+        end
+
+        def tags
+          if @video['tags'].is_a? Hash
+            @video['tags']['tag'].inject([]) do |result, element|
+              result << element['normalized']
+              result
+            end
+          else
+            ''
+          end
         end
 
         def thumb_url
-          @thumb["_content"]
+          @thumb["_content"] || ''
         end
 
         def fetch_info
@@ -135,22 +155,27 @@ module Aweplug
         end
 
         def fetch_thumb_url
-          body = exec_method "vimeo.videos.getThumbnailUrls", @id
-          if body
-            @thumb = JSON.parse(body)["thumbnails"]["thumbnail"][1]
+          if @video['thumbnails']
+            @thumb = @video["thumbnails"]["thumbnail"][1]
           else
             @thumb = {"_content" => ""}
           end
         end
 
         def fetch_cast
-          body = exec_method "vimeo.videos.getCast", @id
           @cast = []
-          if body
-            JSON.parse(body)["cast"]["member"].each do |c|
-              o = OpenStruct.new(c)
-              if o.username != "jbossdeveloper"
-                @cast << o
+          if @video['cast']
+            cast = @video["cast"]
+            if cast['total'] != '1'
+              cast["member"].each do |c|
+                o = OpenStruct.new(c)
+                if o.username != "jbossdeveloper"
+                  @cast << o
+                end
+              end 
+            else
+              if cast['member']['username'] != 'jbossdeveloper'
+                @cast << OpenStruct.new(cast['member'])
               end
             end
           end
@@ -163,44 +188,28 @@ module Aweplug
         #
         # Returns JSON retreived from the Vimeo API
         def exec_method(method, video_id)
+          # TODO: Look at switching this to faraday
           if access_token
             query = "http://vimeo.com/api/rest/v2?method=#{method}&video_id=#{video_id}&format=json"
             access_token.get(query).body
           end
         end
+      end
 
-        # Internal: Obtains an OAuth::AcccessToken for the Vimeo API, using the 
-        # vimeo_client_id and vimeo_access_token defined in site/config.yml and
-        # vimeo_client_secret and vimeo_access_token_secret defined in environment
-        # variables
-        #
-        # site - Awestruct Site instance
-        # 
-        # Returns an OAuth::AccessToken for the Vimeo API 
-        def access_token
-          if @access_token
-            @access_token
-          else
-            if not ENV['vimeo_client_secret']
-              puts 'Cannot fetch video info from vimeo, vimeo_client_secret is missing from environment variables'
-              return
-            end
-            if not @site.vimeo_client_id
-              puts 'Cannot fetch video info vimeo, vimeo_client_id is missing from _config/site.yml'
-              return
-            end
-            if not ENV['vimeo_access_token_secret']
-              puts 'Cannot fetch video info from vimeo, vimeo_access_token_secret is missing from environment variables'
-              return
-            end
-            if not @site.vimeo_access_token
-              puts 'Cannot fetch video info from vimeo, vimeo_access_token is missing from _config/site.yml'
-              return
-            end
-            consumer = OAuth::Consumer.new(@site.vimeo_client_id, ENV['vimeo_client_secret'],
-                                           { :site => "https://vimeo.com",
-                                             :scheme => :header
-            })
+      # Internal: Obtains an OAuth::AcccessToken for the Vimeo API, using the 
+      # vimeo_client_id and vimeo_access_token defined in site/config.yml and
+      # vimeo_client_secret and vimeo_access_token_secret defined in environment
+      # variables
+      #
+      # site - Awestruct Site instance
+      # 
+      # Returns an OAuth::AccessToken for the Vimeo API 
+      def access_token
+        if @access_token
+          @access_token
+        else
+          if not ENV['vimeo_client_secret']
+            puts 'Cannot fetch video info from vimeo, vimeo_client_secret is missing from environment variables'
             # now create the access token object from passed values
             token_hash = { :oauth_token => @site.vimeo_access_token,
                            :oauth_token_secret => ENV['vimeo_access_token_secret']

data/lib/aweplug/version.rb

@@ -1,4 +1,4 @@
 module Aweplug
-  VERSION='1.0.0.a16'
+  VERSION='1.0.0.a17'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aweplug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.a16
+  version: 1.0.0.a17
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -166,6 +166,7 @@ files:
 - lib/aweplug/extensions/asciidoc_example.rb
 - lib/aweplug/extensions/kramdown_quickstart.rb
 - lib/aweplug/extensions/sections.rb
+- lib/aweplug/extensions/vimeo.rb
 - lib/aweplug/handlers/synthetic_handler.rb
 - lib/aweplug/helpers/.gitkeep
 - lib/aweplug/helpers/git_metadata.rb
@@ -190,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3016901967987087946
+      hash: -3243289337858499691
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: