right_scraper 5.0.1 → 5.1.1

data/lib/right_scraper/scanners/workflow_manifest.rb

@@ -1,87 +0,0 @@
-#--
-# Copyright: Copyright (c) 2010-2013 RightScale, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# 'Software'), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-# ancestor
-require 'right_scraper/scanners'
-
-require 'digest/sha1'
-
-module RightScraper::Scanners
-
-  # Build manifests from a filesystem.
-  class WorkflowManifest < ::RightScraper::Scanners::Base
-    # Create a new manifest scanner.  Does not accept any new arguments.
-    def initialize(*args)
-      super
-      @manifest = {}
-    end
-
-    # Retrieve relative workflow files positions
-    #
-    # === Parameters
-    # workflow(Resources::Workflow):: Workflow whose manifest is being built
-    def begin(workflow)
-      @workflow = workflow
-      @metadata_filename = File.basename(@workflow.metadata_path)
-      @definition_filename = File.basename(@workflow.definition_path)
-    end
-
-    # Complete a scan for the given resource.
-    #
-    # === Parameters ===
-    # resource(RightScraper::Resources::Base):: resource to scan
-    def end(resource)
-      resource.manifest = @manifest
-      @manifest = {}
-    end
-
-    # Notice a file during scanning.
-    #
-    # === Block ===
-    # Return the data for this file.  We use a block because it may
-    # not always be necessary to read the data.
-    #
-    # === Parameters ===
-    # relative_position(String):: relative pathname for file from root of resource
-    def notice(relative_position)
-      if [ @metadata_filename, @definition_filename ].include?(relative_position)
-        @manifest[relative_position] = Digest::SHA1.hexdigest(yield)
-      end
-    end
-
-    # Notice a directory during scanning.  Since the workflow definition and
-    # metadata live in the root directory we don't need to recurse,
-    # but we do need to go into the first directory (identified by
-    # +relative_position+ being +nil+).
-    #
-    # === Parameters
-    # relative_position(String):: relative pathname for the directory from root of workflow
-    #
-    # === Returns
-    # Boolean:: should the scanning recurse into the directory
-    def notice_dir(relative_position)
-      relative_position == nil
-    end
-
-  end
-end

data/lib/right_scraper/scanners/workflow_s3_upload.rb

@@ -1,89 +0,0 @@
-#--
-# Copyright: Copyright (c) 2010-2013 RightScale, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# 'Software'), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-# ancestor
-require 'right_scraper/scanners'
-
-require 'right_aws'
-require 'json'
-
-module RightScraper::Scanners
-
-  # Upload workflow definition and metadata to an S3 bucket.
-  class WorkflowS3Upload < ::RightScraper::Scanners::Base
-
-    # Create a new S3Upload.  In addition to the options recognized
-    # by Scanner, this class recognizes <tt>:s3_key</tt>,
-    # <tt>:s3_secret</tt>, and <tt>:s3_bucket</tt> and requires all
-    # of those.
-    #
-    # === Options
-    # <tt>:s3_key</tt>:: Required.  S3 access key.
-    # <tt>:s3_secret</tt>:: Required.  S3 secret key.
-    # <tt>:s3_bucket</tt>:: Required.  Bucket to upload workflows to.
-    #
-    # === Parameters
-    # options(Hash):: scanner options
-    def initialize(options={})
-      super
-      s3_key = options.fetch(:s3_key)
-      s3_secret = options.fetch(:s3_secret)
-      s3 = RightAws::S3.new(aws_access_key_id=s3_key,
-                            aws_secret_access_key=s3_secret,
-                            :logger => @logger)
-      @bucket = s3.bucket(options.fetch(:s3_bucket))
-      raise "Need an actual, existing S3 bucket!" if @bucket.nil?
-    end
-
-    # Upon ending a scan for a workflows, upload the workflows
-    # contents to S3.
-    #
-    # === Parameters
-    # workflows(RightScraper::Workflows):: Workflow to scan
-    def end(workflow)
-      @bucket.put(File.join('Workflows', workflow.resource_hash),
-                  {
-                    :metadata => workflow.metadata,
-                    :manifest => workflow.manifest
-                  }.to_json)
-    end
-
-    # Upload a file during scanning.
-    #
-    # === Block
-    # Return the data for this file.  We use a block because it may
-    # not always be necessary to read the data.
-    #
-    # === Parameters
-    # relative_position(String):: relative pathname for file from root of cookbook
-    def notice(relative_position)
-      # TBD: Only uplad definition and metadata, will there be more files?
-      contents = yield
-      name = Digest::SHA1.hexdigest(contents)
-      path = File.join('Files', name)
-      unless @bucket.key(path).exists?
-        @bucket.put(path, contents)
-      end
-    end
-  end
-end

data/lib/right_scraper/scrapers/workflow.rb

@@ -1,94 +0,0 @@
-#--
-# Copyright: Copyright (c) 2010-2013 RightScale, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# 'Software'), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
-
-# ancestor
-require 'right_scraper/scrapers'
-
-module RightScraper::Scrapers
-
-  # Workflow scraper
-  class Workflow < ::RightScraper::Scrapers::Base
-
-   # Initialize list of known workflows on top of
-    def initialize(options)
-      @known_workflows = []
-      super(options)
-    end
-
-    # Find the next workflows, starting in dir.
-    #
-    # === Parameters
-    # dir(Dir):: directory to begin search in
-    def find_next(dir)
-      @logger.operation(:finding_next_workflow, "in #{dir.path}") do
-
-        # Note: there could be multiple workflow definitions in one directory
-        # so we need to record the current position whether we found a workflow
-        # or not. The next iteration will search again in the current directory
-        # event if we found one. If we don't find one then we call
-        # 'search_dirs' which will recurse in the sub-directories.
-        @stack << dir
-
-        def_ext = RightScraper::Resources::Workflow::DEFINITION_EXT
-        meta_ext = RightScraper::Resources::Workflow::METADATA_EXT
-        potentials = Dir[File.join(dir.path, "*#{def_ext}")]
-        potentials.reject! { |wdef| !File.exists?(wdef.chomp(File.extname(wdef)) + meta_ext) }
-        potentials.reject! { |wdef| @known_workflows.include?(wdef) }
-        unless potentials.empty?
-          wdef = potentials.first
-          relative_def = strip_repo_dir(wdef)
-          @logger.operation(:reading_workflow, "#{relative_def}") do
-            workflow = RightScraper::Resources::Workflow.new(@repository, relative_def)
-            @builder.go(File.dirname(wdef), workflow)
-            @known_workflows << wdef
-            workflow
-          end
-        else
-          search_dirs
-        end
-      end
-    end
-
-    # List of default scanners for this scaper
-    #
-    # === Return
-    # Array<Scanner>:: Default scanners
-    def default_scanners
-      [RightScraper::Scanners::WorkflowMetadata,
-        RightScraper::Scanners::WorkflowManifest]
-    end
-
-    # List of default builders for this scaper
-    #
-    # === Return
-    # Array<Builder>:: Default builders
-    def default_builders
-      [RightScraper::Builders::Filesystem]
-    end
-
-    # self-register
-    register_self
-  end
-end