cumulus-aws 0.11.1

data/lib/s3/models/GrantConfig.rb

@@ -0,0 +1,189 @@
+require "s3/models/GrantDiff"
+
+module Cumulus
+  module S3
+    class GrantConfig
+      @@all_permissions = ["list", "update", "view-permissions", "edit-permissions"].sort
+
+      attr_reader :email
+      attr_reader :name
+      attr_reader :permissions
+
+
+      # Public: A static method that will produce the Cumulus version of the permission
+      # so that the names we use in Cumulus are a little closer to the names
+      # in the AWS console.
+      #
+      # aws_permission - the string permission to convert
+      #
+      # Returns an array of the Cumulus version of the permission
+      def self.to_cumulus_permission(aws_permission)
+        case aws_permission
+        when "FULL_CONTROL"
+          @@all_permissions
+        when "WRITE"
+          ["update"]
+        when "READ"
+          ["list"]
+        when "WRITE_ACP"
+          ["edit-permissions"]
+        when "READ_ACP"
+          ["view-permissions"]
+        end
+      end
+
+      # Public: A static method that will produce the AWS version of the
+      # permission.
+      #
+      # cumulus_permission - the string permission to convert
+      #
+      # Returns the converted permission string
+      def self.to_aws_permission(cumulus_permission)
+        case cumulus_permission
+        when "update"
+          "WRITE"
+        when "list"
+          "READ"
+        when "edit-permissions"
+          "WRITE_ACP"
+        when "view-permissions"
+          "READ_ACP"
+        end
+      end
+
+      # Public: Constructor
+      #
+      # json - a hash representing the JSON configuration. Expects to be passed
+      #        an object from the "grants" array of S3 bucket configuration.
+      def initialize(json = nil)
+        if json
+          @name = json["name"]
+          @email = json["email"]
+          @id = json["id"]
+          @permissions = json["permissions"].sort
+          if @permissions.include?("all")
+            @permissions = @@all_permissions
+          end
+        end
+      end
+
+      # Public: Populate this GrantConfig from the avlues in an
+      # Aws::S3::Types::Grant
+      #
+      # aws - the aws object to populate from
+      def populate!(aws)
+        @name = if aws.grantee.type == "CanonicalUser"
+          aws.grantee.display_name
+        else
+          case aws.grantee.uri
+          when "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
+            "AuthenticatedUsers"
+          when "http://acs.amazonaws.com/groups/global/AllUsers"
+            "Everyone"
+          when "http://acs.amazonaws.com/groups/s3/LogDelivery"
+            "LogDelivery"
+          end
+        end
+        @email = aws.grantee.email_address
+        @permissions = GrantConfig.to_cumulus_permission(aws.permission)
+        @id = aws.grantee.id
+      end
+
+      # Public: Produce an AWS compatible array of hashes representing this
+      # GrantConfig.
+      #
+      # Returns the array of hashes.
+      def to_aws
+        @permissions.map do |permission|
+          if @name == "AuthenticatedUsers"
+            type = "Group"
+            uri = "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
+          elsif @name == "Everyone"
+            type = "Group"
+            uri = "http://acs.amazonaws.com/groups/global/AllUsers"
+          elsif @name == "LogDelivery"
+            type = "Group"
+            uri = "http://acs.amazonaws.com/groups/s3/LogDelivery"
+          elsif @email
+            type = "AmazonCustomerByEmail"
+          else
+            type = "CanonicalUser"
+            display_name = @name
+          end
+
+          {
+            grantee: {
+              display_name: if !@email then @name end,
+              email_address: if @email then @email end,
+              id: if !@email then @id end,
+              type: type,
+              uri: uri,
+            }.reject { |k, v| v.nil? },
+            permission: GrantConfig.to_aws_permission(permission)
+          }
+        end
+      end
+
+      # Public: Converts this GrantConfig to a hash that matches Cumulus
+      # configuration.
+      #
+      # Returns the hash
+      def to_h
+        {
+          name: @name,
+          id: @id,
+          email: @email,
+          permissions: if @permissions.sort == @@all_permissions then ["all"] else @permissions.sort end,
+        }.reject { |k, v| v.nil? }
+      end
+
+      # Public: Produce an array of differences between this local configuration
+      # and the configuration in AWS
+      #
+      # aws - the AWS resource
+      #
+      # Returns an array of the GrantDiffs that were found
+      def diff(aws)
+        diffs = []
+
+        if @permissions != aws.permissions
+          diffs << GrantDiff.new(GrantChange::PERMISSIONS, aws, self)
+        end
+
+        diffs
+      end
+
+      # Public: Add permissions to the permissions of this Grant.
+      #
+      # permissions - an Array of the permissions to add
+      def add_permissions!(permissions)
+        @permissions = (@permissions + permissions).uniq.sort
+      end
+
+      # Public: Check GrantConfig equality with other objects.
+      #
+      # other - the other object to check
+      #
+      # Returns whether this GrantConfig is equal to `other`
+      def ==(other)
+        if !other.is_a? GrantConfig or
+            @name != other.name or
+            @email != other.email or
+            @permissions.sort != other.permissions.sort
+          false
+        else
+          true
+        end
+      end
+
+      # Public: Check if this GrantConfig is not equal to the other object
+      #
+      # other - the other object to check
+      #
+      # Returns whether this GrantConfig is not equal to `other`
+      def !=(other)
+        !(self == other)
+      end
+    end
+  end
+end

data/lib/s3/models/GrantDiff.rb

@@ -0,0 +1,50 @@
+require "common/models/Diff"
+require "common/models/ListChange"
+require "util/Colors"
+
+module Cumulus
+  module S3
+    # Public: The types of changes that can be made to a Grant
+    module GrantChange
+      include Common::DiffChange
+
+      PERMISSIONS = Common::DiffChange.next_change_id
+    end
+
+    # Public: Represents a single difference between local configuration and
+    # an AWS Grant.
+    class GrantDiff < Common::Diff
+      include GrantChange
+
+      def initialize(type, aws = nil, local = nil)
+        super(type, aws, local)
+
+        if aws and local
+          @permissions = Common::ListChange.new(
+            local.permissions - aws.permissions,
+            aws.permissions - local.permissions
+          )
+        end
+      end
+
+      def asset_type
+        "Grant"
+      end
+
+      def aws_name
+        @aws.name
+      end
+
+      def diff_string
+        case @type
+        when PERMISSIONS
+          [
+            "#{@local.name}:",
+            @permissions.removed.map { |p| Colors.removed("\t#{p}") },
+            @permissions.added.map { |p| Colors.added("\t#{p}") },
+          ].flatten.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/s3/models/LifecycleConfig.rb

@@ -0,0 +1,142 @@
+require "s3/models/LifecycleDiff"
+
+module Cumulus
+  module S3
+    class LifecycleConfig
+      attr_reader :name
+      attr_reader :prefix
+      attr_reader :days_until_glacier
+      attr_reader :days_until_delete
+      attr_reader :past_days_until_glacier
+      attr_reader :past_days_until_delete
+
+      # Public: Constructor
+      #
+      # json - a hash representing the JSON configuration. Expects to be passed
+      #        an object from the "lifecycle" array of S3 bucket configuration.
+      def initialize(json = nil)
+        if json
+          @name = json["name"]
+          @prefix = json["prefix"]
+          @days_until_glacier = json["days-until-glacier"]
+          @days_until_delete = json["days-until-delete"]
+          if json["past-versions"]
+            @past_days_until_glacier = json["past-versions"]["days-until-glacier"]
+            @past_days_until_delete = json["past-versions"]["days-until-delete"]
+          end
+        end
+      end
+
+      # Public: Populate this LifecycleConfig with the values in an AWS
+      # Configuration object.
+      #
+      # aws - the aws object to populate from
+      def populate!(aws)
+        @name = aws.id
+        @prefix = aws.prefix
+        @days_until_glacier = (aws.transition.days unless aws.transition.storage_class.downcase != "glacier") rescue nil
+        @days_until_delete = aws.expiration.days rescue nil
+        @past_days_until_glacier = (aws.noncurrent_version_transition.noncurrent_days unless aws.noncurrent_version_transition.storage_class.downcase != "glacier") rescue nil
+        @past_days_until_delete = aws.noncurrent_version_expiration.noncurrent_days rescue nil
+      end
+
+      # Public: Produce an AWS hash representing this LifecycleConfig.
+      #
+      # Returns the hash.
+      def to_aws
+        {
+          id: @name,
+          prefix: @prefix,
+          status: "Enabled",
+          transition: if @days_until_glacier then {
+            days: @days_until_glacier,
+            storage_class: "GLACIER"
+          } end,
+          expiration: if @days_until_delete then {
+            days: @days_until_delete
+          } end,
+          noncurrent_version_transition: if @past_days_until_glacier then {
+            noncurrent_days: @past_days_until_glacier,
+            storage_class: "GLACIER"
+          } end,
+          noncurrent_version_expiration: if @past_days_until_delete then {
+            noncurrent_days: @past_days_until_delete
+          } end
+        }.reject { |k, v| v.nil? }
+      end
+
+      # Public: Converts this LifecycleConfig to a hash that matches Cumulus
+      # configuration.
+      #
+      # Returns the hash.
+      def to_h
+        {
+          "name" => @name,
+          "prefix" => @prefix,
+          "days-until-glacier" => @days_until_glacier,
+          "days-until-delete" => @days_until_delete,
+          "past-versions" => if @past_days_until_glacier or @past_days_until_delete then {
+            "days-until-glacier" => @past_days_until_glacier,
+            "days-until-delete" => @past_days_until_delete,
+          }.reject { |k, v| v.nil? } end,
+        }.reject { |k, v| v.nil? }
+      end
+
+      # Public: Produce an array of differences between this local configuration
+      # and the configuration in AWS
+      #
+      # aws - the AWS resource
+      #
+      # Returns an array of LifecycleDiffs that were found
+      def diff(aws)
+        diffs = []
+
+        if @prefix != aws.prefix
+          diffs << LifecycleDiff.new(LifecycleChange::PREFIX, aws, self)
+        end
+        if @days_until_glacier != aws.days_until_glacier
+          diffs << LifecycleDiff.new(LifecycleChange::DAYS_UNTIL_GLACIER, aws, self)
+        end
+        if @days_until_delete != aws.days_until_delete
+          diffs << LifecycleDiff.new(LifecycleChange::DAYS_UNTIL_DELETE, aws, self)
+        end
+        if @past_days_until_glacier != aws.past_days_until_glacier
+          diffs << LifecycleDiff.new(LifecycleChange::PAST_UNTIL_GLACIER, aws, self)
+        end
+        if @past_days_until_delete != aws.past_days_until_delete
+          diffs << LifecycleDiff.new(LifecycleChange::PAST_UNTIL_DELETE, aws, self)
+        end
+
+        diffs
+      end
+
+      # Public: Check LifecycleConfig equality with other objects.
+      #
+      # other - the other object to check
+      #
+      # Returns whether this LifecycleConfig is equal to `other`
+      def ==(other)
+        if !other.is_a? LifecycleConfig or
+            @name != other.name or
+            @prefix != other.prefix or
+            @days_until_glacier != other.days_until_glacier or
+            @days_until_delete != other.days_until_delete or
+            @past_days_until_glacier != other.past_days_until_glacier or
+            @past_days_until_delete != other.past_days_until_delete
+          false
+        else
+          true
+        end
+      end
+
+      # Public: Check if this LifecycleConfig is not equal to the other object
+      #
+      # other - the other object to check
+      #
+      # Returns whether this LifecycleConfig is not equal to `other`
+      def !=(other)
+        !(self == other)
+      end
+    end
+  end
+end

data/lib/s3/models/LifecycleDiff.rb

@@ -0,0 +1,46 @@
+require "common/models/Diff"
+require "util/Colors"
+
+module Cumulus
+  module S3
+    # Public: The types of changes that cna be made to an S3 Lifecycle Rule
+    module LifecycleChange
+      include Common::DiffChange
+
+      DAYS_UNTIL_DELETE = Common::DiffChange.next_change_id
+      DAYS_UNTIL_GLACIER = Common::DiffChange.next_change_id
+      PAST_UNTIL_DELETE = Common::DiffChange.next_change_id
+      PAST_UNTIL_GLACIER = Common::DiffChange.next_change_id
+      PREFIX = Common::DiffChange.next_change_id
+    end
+
+    # Public: Represents a single difference between local configuration and AWS
+    # lifecycle rule configuration
+    class LifecycleDiff < Common::Diff
+      include LifecycleChange
+
+      def asset_type
+        "Lifecycle rule"
+      end
+
+      def aws_name
+        @aws.name
+      end
+
+      def diff_string
+        case @type
+        when DAYS_UNTIL_DELETE
+          "Days before objects are deleted: AWS - #{Colors.aws_changes(@aws.days_until_delete)}, Local - #{Colors.local_changes(@local.days_until_delete)}"
+        when DAYS_UNTIL_GLACIER
+          "Days before transition to Glacier: AWS - #{Colors.aws_changes(@aws.days_until_glacier)}, Local - #{Colors.local_changes(@local.days_until_glacier)}"
+        when PAST_UNTIL_DELETE
+          "Days before past version objects are deleted: AWS - #{Colors.aws_changes(@aws.past_days_until_delete)}, Local - #{Colors.local_changes(@local.past_days_until_delete)}"
+        when PAST_UNTIL_GLACIER
+          "Days before past version transition to Glacier: AWS - #{Colors.aws_changes(@aws.past_days_until_glacier)}, Local - #{Colors.local_changes(@local.past_days_until_glacier)}"
+        when PREFIX
+          "Prefix - AWS #{Colors.aws_changes(@aws.prefix)}, Local - #{Colors.local_changes(@local.prefix)}"
+        end
+      end
+    end
+  end
+end

data/lib/s3/models/LoggingConfig.rb

@@ -0,0 +1,81 @@
+module Cumulus
+  module S3
+    class LoggingConfig
+      attr_reader :target_bucket
+      attr_reader :prefix
+
+      # Public: Constructor
+      #
+      # json - a hash representing the JSON configuration. Expects to be handed
+      #        the 'logging' node of S3 configuration.
+      def initialize(json = nil)
+        if json
+          @target_bucket = json["target-bucket"]
+          @prefix = json["prefix"] || ""
+        end
+      end
+
+      # Public: Populate this LoggingConfig with the values in an AWS BucketLogging
+      # object.
+      #
+      # aws - the aws object to populate from
+      def populate!(aws)
+        @target_bucket = aws.logging_enabled.target_bucket
+        @prefix = aws.logging_enabled.target_prefix
+      end
+
+      # Public: Produce a hash that is compatible with AWS logging configuration.
+      #
+      # Returns the logging configuration in AWS format
+      def to_aws
+        {
+          target_bucket: @target_bucket,
+          target_prefix: @prefix
+        }
+      end
+
+      # Public: Convert this LoggingConfig to a hash that matches Cumulus
+      # configuration.
+      #
+      # Returns the hash
+      def to_h
+        {
+          "target-bucket" => @target_bucket,
+          "prefix" => @prefix,
+        }.reject { |k, v| v.nil? }
+      end
+
+      # Public: Check LoggingConfig equality with other objects
+      #
+      # other - the other object to check
+      #
+      # Returns whether this LoggingConfig is equal to `other`
+      def ==(other)
+        if !other.is_a? LoggingConfig or
+            @target_bucket != other.target_bucket or
+            @prefix != other.prefix
+          false
+        else
+          true
+        end
+      end
+
+      # Public: Check if this LoggingConfig is not equal to the other object
+      #
+      # other - the other object to check
+      #
+      # Returns whether this LoggingConfig is not equal to `other`
+      def !=(other)
+        !(self == other)
+      end
+
+      def to_s
+        if @target_bucket and @prefix
+          "Target bucket: #{@target_bucket} with prefix #{@prefix}"
+        elsif @target_bucket
+          "Target bucket: #{@target_bucket}"
+        end
+      end
+    end
+  end
+end