aws-sdk-rails 2.1.0 → 3.4.0

data/lib/generators/aws_record/generated_attribute.rb

@@ -0,0 +1,129 @@
+module AwsRecord
+  module Generators
+    class GeneratedAttribute
+
+      OPTS = %w(hkey rkey persist_nil db_attr_name ddb_type default_value)
+      INVALID_HKEY_TYPES = %i(map_attr list_attr numeric_set_attr string_set_attr)
+      attr_reader :name, :type
+      attr_accessor :options
+
+      def field_type
+        case @type
+          when :integer_attr then :number_field
+          when :date_attr then :date_select
+          when :datetime_attr then :datetime_select
+          when :boolean_attr then :check_box
+          else :text_field
+        end
+      end
+
+      class << self
+
+        def parse(field_definition)
+          name, type, opts = field_definition.split(':')
+          type = "string" if not type
+          type, opts = "string", type if OPTS.any? { |opt| type.include? opt }
+
+          opts = opts.split(',') if opts
+          type, opts = parse_type_and_options(name, type, opts)
+          validate_opt_combs(name, type, opts)
+
+          new(name, type, opts)
+        end
+
+        private
+
+        def validate_opt_combs(name, type, opts)
+          if opts
+              is_hkey = opts.key?(:hash_key)
+              is_rkey = opts.key?(:range_key)
+
+              raise ArgumentError.new("Field #{name} cannot be a range key and hash key simultaneously") if is_hkey && is_rkey
+              raise ArgumentError.new("Field #{name} cannot be a hash key and be of type #{type}") if is_hkey and INVALID_HKEY_TYPES.include? type
+          end
+        end
+
+        def parse_type_and_options(name, type, opts)
+          opts = [] if not opts
+          return parse_type(name, type), opts.map { |opt| parse_option(name, opt) }.to_h
+        end
+
+        def parse_option(name, opt)
+          case opt
+
+          when "hkey"
+            return :hash_key, true
+          when "rkey"
+            return :range_key, true
+          when "persist_nil"
+            return :persist_nil, true
+          when /db_attr_name\{(\w+)\}/
+            return :database_attribute_name, '"' + $1 + '"'
+          when /ddb_type\{(S|N|B|BOOL|SS|NS|BS|M|L)\}/i
+            return :dynamodb_type, '"' + $1.upcase + '"'
+          when /default_value\{(.+)\}/
+            return :default_value, $1
+          else
+            raise ArgumentError.new("You provided an invalid option for #{name}: #{opt}")
+          end
+        end
+
+        def parse_type(name, type)
+          case type.downcase
+
+          when "bool", "boolean"
+            :boolean_attr
+          when "date"
+            :date_attr
+          when "datetime"
+            :datetime_attr
+          when "float"
+            :float_attr
+          when "int", "integer"
+            :integer_attr
+          when "list"
+            :list_attr
+          when "map"
+            :map_attr
+          when "num_set", "numeric_set", "nset"
+            :numeric_set_attr
+          when "string_set", "s_set", "sset"
+            :string_set_attr
+          when "string"
+            :string_attr
+          else
+            raise ArgumentError.new("Invalid type for #{name}: #{type}")
+          end
+        end
+      end
+
+      def initialize(name, type = :string_attr, options = {})
+        @name = name
+        @type = type
+        @options = options
+        @digest = options.delete(:digest)
+      end
+
+      # Methods used by rails scaffolding
+      def password_digest?
+        @digest
+      end
+
+      def polymorphic?
+        false
+      end
+
+      def column_name
+        if @name == "password_digest"
+          "password"
+        else
+          @name
+        end
+      end
+
+      def human_name
+        name.humanize
+      end
+    end
+  end
+end

data/lib/generators/aws_record/model/USAGE

@@ -0,0 +1,24 @@
+Description:
+    rails generator for aws-record models
+
+    Pass the name of the model (preferably in singular form), and an optional list of attributes
+
+    Attributes are declarations of the fields that you wish to store within a model. You can pass
+    a type and list of options for each attribtue in the form: `name:type:options` if you do not provide
+    a type, it is assumed that the attribute is of type `string_attr`
+
+    Each model should have an hkey, if one is not present a `uuid:hkey` will be created for you.
+
+    Timestamps are not added by default but you can add them using the `--timestamps` flag
+    More information can be found at: https://github.com/awslabs/aws-record-generator/blob/master/README.md
+    
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+Example:
+    rails generate aws_record:model Forum forum_uuid:hkey post_id:rkey post_title post_body tags:sset:default_value{Set.new} created_at:datetime:d_attr_name{PostCreatedAtTime} moderation:boolean:default_value{false}
+
+    This will create:
+        app/models/forum.rb
+        db/table_config/forum_config.rb
+        lib/tasks/table_config_migrate_task.rake # This is created once the first time the generator is run

data/lib/generators/aws_record/model/model_generator.rb

@@ -0,0 +1,21 @@
+require_relative '../base'
+
+module AwsRecord
+  module Generators
+    class ModelGenerator < Base
+      def initialize(args, *options)
+        self.class.source_root File.expand_path('../templates', __FILE__)
+        super
+      end
+
+      def create_model
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      def create_table_config
+        template "table_config.rb", File.join("db/table_config", class_path, "#{file_name}_config.rb") if options["table_config"]
+      end
+
+    end
+  end
+end

data/lib/generators/aws_record/model/templates/model.rb

@@ -0,0 +1,48 @@
+require 'aws-record'
+<% if has_validations? -%>
+require 'active_model'
+<% end -%>
+
+<% module_namespacing do -%>
+class <%= class_name %>
+  include Aws::Record
+<% if options.key? :scaffold -%>
+  extend ActiveModel::Naming
+<% end -%>
+<% if has_validations? -%>
+  include ActiveModel::Validations
+<% end -%>
+<% if options.key? :password_digest -%>
+  include ActiveModel::SecurePassword
+<% end -%>
+<% if mutation_tracking_disabled? -%>
+  disable_mutation_tracking
+<% end -%>
+
+<% attributes.each do |attribute| -%>
+  <%= attribute.type %> :<%= attribute.name %><% *opts, last_opt = attribute.options.to_a %><%= ', ' if last_opt %><% opts.each do |opt| %><%= opt[0] %>: <%= opt[1] %>, <% end %><% if last_opt %><%= last_opt[0] %>: <%= last_opt[1] %><% end %>
+<% end -%>
+<% gsis.each do |index| %>
+  global_secondary_index(
+    :<%= index.name %>,
+    hash_key: :<%= index.hash_key -%>,<%- if index.range_key %>
+    range_key: :<%= index.range_key -%>,<%- end %>
+    projection: {
+      projection_type: <%= index.projection_type %>
+    }
+  )
+<% end -%>
+<% if !required_attrs.empty? -%>
+  validates_presence_of <% *req, last_req = required_attrs -%><% req.each do |required_validation|-%>:<%= required_validation %>, <% end -%>:<%= last_req %>
+<% end -%>
+<% length_validations.each do |attribute, validation| -%>
+  validates_length_of :<%= attribute %>, within: <%= validation %>
+<% end -%>
+<% if options['table_name'] -%>
+  set_table_name "<%= options['table_name'] %>"
+<% end -%>
+<% if options.key? :password_digest -%>
+  has_secure_password
+<% end -%>
+end
+<% end -%>

data/lib/generators/aws_record/model/templates/table_config.rb

@@ -0,0 +1,18 @@
+require 'aws-record'
+
+module ModelTableConfig
+  def self.config
+    Aws::Record::TableConfig.define do |t|
+      t.model_class <%= class_name %>
+
+      t.read_capacity_units <%= primary_read_units %>
+      t.write_capacity_units <%= primary_write_units %>
+      <%- gsis.each do |index| %>
+      t.global_secondary_index(:<%= index.name %>) do |i|
+        i.read_capacity_units <%= gsi_rw_units[index.name][0] %>
+        i.write_capacity_units <%= gsi_rw_units[index.name][1] %>
+      end
+      <%- end -%>
+    end
+  end
+end

data/lib/generators/aws_record/secondary_index.rb

@@ -0,0 +1,60 @@
+module AwsRecord
+  module Generators
+    class SecondaryIndex
+
+      PROJ_TYPES = %w(ALL KEYS_ONLY INCLUDE)
+      attr_reader :name, :hash_key, :range_key, :projection_type
+
+      class << self
+        def parse(key_definition)
+          name, index_options = key_definition.split(':')
+          index_options = index_options.split(',') if index_options
+          opts = parse_raw_options(index_options)
+
+          new(name, opts)
+        end
+
+        private
+          def parse_raw_options(raw_opts)
+            raw_opts = [] if not raw_opts
+            raw_opts.map { |opt| get_option_value(opt) }.to_h
+          end
+
+          def get_option_value(raw_option)
+            case raw_option
+
+            when /hkey\{(\w+)\}/
+              return :hash_key, $1
+            when /rkey\{(\w+)\}/
+              return :range_key, $1
+            when /proj_type\{(\w+)\}/
+              return :projection_type, $1
+            else
+              raise ArgumentError.new("Invalid option for secondary index #{raw_option}")
+            end
+          end
+      end
+
+      def initialize(name, opts)
+        raise ArgumentError.new("You must provide a name") if not name
+        raise ArgumentError.new("You must provide a hash key") if not opts[:hash_key]
+
+        if opts.key? :projection_type
+          raise ArgumentError.new("Invalid projection type #{opts[:projection_type]}") if not PROJ_TYPES.include? opts[:projection_type]
+          raise NotImplementedError.new("ALL is the only projection type currently supported") if opts[:projection_type] != "ALL"
+        else
+          opts[:projection_type] = "ALL"
+        end
+
+        if opts[:hash_key] == opts[:range_key]
+          raise ArgumentError.new("#{opts[:hash_key]} cannot be both the rkey and hkey for gsi #{name}")
+        end
+
+        @name = name
+        @hash_key = opts[:hash_key]
+        @range_key = opts[:range_key]
+        @projection_type = '"' + "#{opts[:projection_type]}" + '"'
+      end
+    end
+  end
+end

data/lib/generators/dynamo_db/session_store_migration/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a migration file for deleting and a creating a DynamoDB
+    sessions table, and a configuration file for the session store.
+
+Example:
+    rails generate dynamo_db:session_store_migration <MIGRATION_NAME>
+
+    This will create:
+        db/migrate/#{VERSION}_#{MIGRATION_NAME}.rb
+        config/dynamo_db_session_store.yml
+
+    The migration will be run when the command rake db:migrate is run
+    in the command line.

data/lib/generators/dynamo_db/session_store_migration/session_store_migration_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/named_base'
+
+# This class generates a migration file for deleting and creating
+# a DynamoDB sessions table.
+module DynamoDb
+  module Generators
+    # Generates an ActiveRecord migration that creates and deletes a DynamoDB
+    # Session table.
+    class SessionStoreMigrationGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      # Desired name of migration class
+      argument :name, type: :string, default: 'create_dynamo_db_sessions_table'
+
+      # @return [Rails Migration File] migration file for creation and deletion
+      #   of a DynamoDB session table.
+      def generate_migration_file
+        migration_template(
+          'session_store_migration.rb',
+          "db/migrate/#{name.underscore}.rb"
+        )
+      end
+
+      def copy_sample_config_file
+        template(
+          'dynamo_db_session_store.yml',
+          'config/dynamo_db_session_store.yml'
+        )
+      end
+
+      # Next migration number - must be implemented
+      def self.next_migration_number(_dir = nil)
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+      private
+
+      # @return [String] activerecord migration version
+      def migration_version
+        "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+      end
+    end
+  end
+end

data/lib/generators/dynamo_db/session_store_migration/templates/dynamo_db_session_store.yml

@@ -0,0 +1,70 @@
+# Uncomment and manipulate the key value pairs below
+# in order to configure the DynamoDB Session Store Application.
+
+# [String] The secret key for HMAC encryption. This defaults to
+# `Rails.application.secret_key_base`. You can use a different key if desired.
+#
+# secret_key: SECRET_KEY
+
+# [String] Session table name.
+#
+# table_name: Sessions
+
+# [String] Session table hash key name.
+#
+# table_key: session_id
+
+# [Boolean] Define as true or false depending on if you want a strongly
+# consistent read.
+# See AWS DynamoDB documentation for table consistent_read for more
+# information on this setting.
+#
+# consistent_read: true
+
+# [Integer] Maximum number of reads consumed per second before
+# DynamoDB returns a ThrottlingException. See AWS DynamoDB documentation
+# or table read_capacity for more information on this setting.
+#
+# read_capacity: 10
+
+# [Integer] Maximum number of writes consumed per second before
+# DynamoDB returns a ThrottlingException. See AWS DynamoDB documentation
+# or table write_capacity for more information on this setting.
+#
+# write_capacity: 5
+
+# [Boolean] Define as true or false depending on whether you want all errors to be
+# raised up the stack.
+#
+# raise_errors: false
+
+# [Integer] Maximum number of seconds earlier
+# from the current time that a session was created.
+# By default this is 7 days.
+#
+# max_age: 604800
+
+# [Integer] Maximum number of seconds
+# before the current time that the session was last accessed.
+# By default this is 5 hours.
+#
+# max_stale: 18000
+
+# [Boolean] Define as true or false for whether you want to enable locking
+# for all accesses to session data.
+#
+# enable_locking: false
+
+# [Integer] Time in milleseconds after which lock will expire.
+#
+# lock_expiry_time: 500
+
+# [Integer] Time in milleseconds to wait before retrying to obtain
+# lock once an attempt to obtain lock has been made and has failed.
+#
+# lock_retry_delay: 500
+
+# [Integer] Maximum time in seconds to wait to acquire lock
+# before giving up.
+#
+# lock_max_wait_time: 1

data/lib/generators/dynamo_db/session_store_migration/templates/session_store_migration.rb

@@ -0,0 +1,9 @@
+class <%= name.camelize %> < ActiveRecord::Migration[<%= migration_version %>]
+  def up
+    Aws::SessionStore::DynamoDB::Table.create_table
+  end
+
+  def down
+    Aws::SessionStore::DynamoDB::Table.delete_table
+  end
+end