mara 0.1.0

data/lib/mara/primary_key.rb

@@ -0,0 +1,117 @@
+require 'base64'
+require 'json'
+
+module Mara
+  ##
+  # Wraps a primary key.
+  #
+  # @author Maddie Schipper
+  # @since 1.0.0
+  class PrimaryKey
+    class << self
+      ##
+      # Create a primary key from a model.
+      #
+      # @param model [Mara::PrimaryKey,  Mara::Model::Base] The object to
+      #   stringify.
+      #
+      # @return [String]
+      def generate(model)
+        case model
+        when  Mara::PrimaryKey
+          model.to_s
+        when  Mara::Model::Base
+          new(model: model).to_s
+        else
+          raise ArgumentError, "The value passed into generate isn't expected <#{model}>"
+        end
+      end
+
+      ##
+      # Parse a primary key string.
+      #
+      # @param key_str [String] The primary key string to return.
+      #
+      # @return [Mara::PrimaryKey]
+      def parse(key_str)
+        parts = JSON.parse(decode(key_str))
+        new(
+          class_name: parts[0],
+          partition_key: parts[1],
+          sort_key: parts[2]
+        )
+      end
+
+      private
+
+      def decode(str)
+        str = str.tr('-_', '+/')
+        str = str.ljust((str.length + 3) & ~3, '=')
+        Base64.strict_decode64(str)
+      end
+    end
+
+    ##
+    # The classname of the model that the primary key represents.
+    #
+    # @return [String]
+    attr_reader :class_name
+
+    ##
+    # The partion key
+    #
+    # @return [String]
+    attr_reader :partition_key
+
+    ##
+    # The sort key
+    #
+    # @return [String]
+    attr_reader :sort_key
+
+    ##
+    # Create a new primary key.
+    #
+    # @note If +:model+ is not present the other three options are required.
+    #
+    # @param opts [Hash] The options param
+    # @option opts [ Mara::Model::Base] :model The model this key will represent.
+    # @option opts [String] :class_name The class name of the model.
+    # @option opts [String] :partition_key The partition key value.
+    # @option opts [String] :sort_key The sort key value.
+    def initialize(opts)
+      if (model = opts.delete(:model)).present?
+        @class_name = model.class.name
+        @partition_key = if model.class.partition_key.present?
+                           model.partition_key
+                         end
+        @sort_key = if model.class.sort_key.present?
+                      model.sort_key
+                    end
+      else
+        @class_name = opts.fetch(:class_name).camelize
+        @partition_key = opts.fetch(:partition_key)
+        @sort_key = opts.fetch(:sort_key, nil).presence
+      end
+    end
+
+    ##
+    # Convert the primary key into a URL safe representation.
+    #
+    # @return [String]
+    def to_s
+      payload = JSON.dump([
+                            (class_name.presence || '').underscore,
+                            partition_key.presence || '',
+                            sort_key.presence || ''
+                          ])
+      encode(payload)
+    end
+
+    private
+
+    def encode(bin)
+      Base64.strict_encode64(bin).tr('+/', '-_').tr('=', '')
+    end
+  end
+end

data/lib/mara/query.rb

@@ -0,0 +1,90 @@
+require_relative 'client'
+require_relative 'configure'
+require_relative 'instrument'
+require_relative 'attribute_formatter'
+require_relative 'dynamo_helpers'
+
+module Mara
+  ##
+  # @private
+  #
+  # Perform calls to DynamoDB for fetching
+  #
+  # @author Maddie Schipper
+  # @since 1.0.0
+  class Query
+    include DynamoHelpers
+
+    ##
+    # The response from DynamoDB
+    #
+    # @!attribute [r] items
+    #   The items returned by DynamoDB
+    #
+    #   @return [Array<Hash>]
+    #
+    # @!attribute [r] consumed_capacity
+    #   The capacity DyanmoDB used to perform the request.
+    #
+    #   @return [Float]
+    Result = Struct.new(:items, :consumed_capacity)
+
+    class << self
+      ##
+      # Perform a single item get request by the primary key.
+      #
+      # @param query_params [Hash] The query items.
+      #
+      # @return [ Mara::Query::Result]
+      def get_item(query_params)
+        client, table_name = config_params(query_params)
+        primary_key = query_params.fetch(:key)
+        projection_expression = query_params.fetch(:projection_expression, nil).presence
+
+        params = {
+          key: primary_key,
+          table_name: table_name,
+          return_consumed_capacity: 'TOTAL',
+          projection_expression: projection_expression
+        }
+
+        result =  Mara.instrument('get_item', params) do
+          client.get_item(params)
+        end
+
+        return nil if result.item.nil?
+
+        item = format_item(result.item)
+        cc = calculate_consumed_capacity(result.consumed_capacity, table_name)
+
+        Result.new(
+          [item],
+          cc
+        )
+      end
+
+      private
+
+      def format_item(item)
+        item.map do |key, value|
+          [key,  Mara::AttributeFormatter.flatten(value)]
+        end.to_h
+      end
+
+      def wrap_items(result)
+        if result.responses
+          result.responses
+        else
+          [result.item]
+        end
+      end
+
+      def config_params(params)
+        [
+          params.fetch(:client,  Mara::Client.shared),
+          params.fetch(:table_name,  Mara.config.dynamodb.table_name)
+        ]
+      end
+    end
+  end
+end

data/lib/mara/table.rb

@@ -0,0 +1,141 @@
+require_relative 'client'
+require_relative 'configure'
+
+module Mara
+  ##
+  # Manage Dev/Test tables.
+  #
+  # While this _can_ be used to create real tables, we don't recommend it.
+  #
+  # @author Maddie Schipper
+  # @since 1.0.0
+  class Table
+    class << self
+      ##
+      # @private
+      #
+      # Default supported environments
+      SUPPORTED_ENVS = %w[development test].freeze
+
+      ##
+      # Create a new table if it doesn't exist.
+      #
+      # @note If the table_params do not include the table name, The default
+      #   table name from the config will be used.
+      #
+      # @param table_params [Hash] DynamoDB create table params hash.
+      #
+      # @return [true, false]
+      def prepare!(table_params)
+        prepare_table!(table_params, SUPPORTED_ENVS, true)
+      end
+
+      ##
+      # Teardown the table if it exists.
+      #
+      # @note If the table_params do not include the table name, The default
+      #   table name from the config will be used.
+      #
+      # @param table_params [Hash] DynamoDB table name params.
+      #
+      # @return [true, false]
+      def teardown!(table_params = {})
+        teardown_table!(table_params, SUPPORTED_ENVS, true)
+      end
+
+      ##
+      # Check if a table exists.
+      #
+      # @param table_name [String] the name of the table to check if it exists.
+      #
+      # @return [true, false]
+      def table_exists?(table_name)
+         Mara::Client.shared.list_tables.table_names.include?(table_name)
+      end
+
+      ##
+      # @private
+      #
+      # Prepare the table with extra options.
+      #
+      # @param table_params [Hash] DynamoDB create table params hash.
+      # @param envs [Array<String>] The environments that are allowed to check
+      #   if this action is allowed.
+      # @param wait [true, false] Should this function wait for the table to
+      #   become fully available before returning.
+      #
+      # @return [true, false]
+      def prepare_table!(table_params, envs, wait)
+        env =  Mara.config.env
+        unless Array(envs).include?(env)
+          raise ArgumentError, "Can't prepare table outside of #{envs.join('/')}"
+        end
+
+        table_name = table_params.fetch(:table_name,  Mara.config.dynamodb.table_name)
+
+        if table_exists?(table_name)
+          return true
+        end
+
+        table_params = normalize_table_params(table_params, table_name)
+
+        log(" Mara create_table(\"#{table_name}\")")
+
+         Mara::Client.shared.create_table(table_params)
+         Mara::Client.shared.wait_until(:table_exists, table_name: table_name) if wait
+
+        true
+      end
+
+      ##
+      # @private
+      #
+      # Teardown the table with extra options.
+      #
+      # @param table_params [Hash] DynamoDB create table params hash.
+      # @param envs [Array<String>] The environments that are allowed to check
+      #   if this action is allowed.
+      # @param wait [true, false] Should this function wait for the table to
+      #   become fully available before returning.
+      #
+      # @return [true, false]
+      def teardown_table!(table_params, envs, wait)
+        env =  Mara.config.env
+        unless envs.include?(env)
+          raise ArgumentError, "Can't prepare table outside of #{envs.join('/')}"
+        end
+
+        table_name = table_params.fetch(:table_name,  Mara.config.dynamodb.table_name)
+
+        unless  Mara::Client.shared.list_tables.table_names.include?(table_name)
+          return true
+        end
+
+        log(" Mara destroy_table(\"#{table_name}\")")
+
+         Mara::Client.shared.delete_table(table_name: table_name)
+         Mara::Client.shared.wait_until(:table_not_exists, table_name: table_name) if wait
+
+        true
+      end
+
+      private
+
+      def log(msg)
+        STDERR.puts msg
+      end
+
+      def normalize_table_params(table_params, table_name)
+        provisioned_throughput = table_params.fetch(:provisioned_throughput,
+                                                    read_capacity_units: 10,
+                                                    write_capacity_units: 10)
+
+        table_params.delete(:billing_mode)
+        table_params[:table_name] = table_name
+        table_params[:provisioned_throughput] = provisioned_throughput
+
+        table_params
+      end
+    end
+  end
+end

data/lib/mara/version.rb

@@ -0,0 +1,5 @@
+module Mara
+  ##
+  # The current version of  Mara
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: mara
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maddie Schipper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: DynamoDB Client Wrapper
+email:
+- me@maddiesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/mara.rb
+- lib/mara/attribute_formatter.rb
+- lib/mara/batch.rb
+- lib/mara/client.rb
+- lib/mara/configure.rb
+- lib/mara/dynamo_helpers.rb
+- lib/mara/error.rb
+- lib/mara/instrument.rb
+- lib/mara/model.rb
+- lib/mara/model/attributes.rb
+- lib/mara/model/base.rb
+- lib/mara/model/dsl.rb
+- lib/mara/model/persistence.rb
+- lib/mara/model/query.rb
+- lib/mara/null_value.rb
+- lib/mara/persistence.rb
+- lib/mara/primary_key.rb
+- lib/mara/query.rb
+- lib/mara/table.rb
+- lib/mara/version.rb
+homepage: https://github.com/maddiesch/mara
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: DynamoDB Client Wrapper
+test_files: []