dyna_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca4e3bd3b871756a2b5fad4bf362c334bbf804af
+  data.tar.gz: ac13badc8bca36d88787d6cbdb6134af19c69a93
+SHA512:
+  metadata.gz: 23243b46398ab0517a2f6a7c57e1fdbbe3f4f63c8d55b8c1a8a73abe8de75a297395ad8554d06101c02cb472de16a696e738a509b46002427812b4efa6279e49
+  data.tar.gz: 32f20b9e28c107825230eb53dfd18b092f6626e91e66a4b1fd859b0523c4f5c38c1566d2e77e9417ec80b8612c4c91ba24269f47a74379eecc1611ee37b0b38a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dyna_model.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cary Dunn
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,81 @@
+# DynaModel
+
+AWS DynamoDB ORM for Rails based on AWS::Record in the aws-sdk gem. Still a work in progress but very functional.
+
+## Installation
+```
+gem 'dyna_model'
+```
+
+## Sample Model
+```
+class Dude
+
+  include DynaModel::Document
+  
+  string_attr :hashy
+  integer_attr :ranger, default_value: 2
+  string_attr :name, default_value: lambda { "dude" }
+  boolean_attr :is_dude
+  datetime_attr :born
+  serialized_attr :cereal
+  timestamps
+
+  hash_key :hashy
+  range_key :ranger
+
+  set_shard_name "usery"
+
+  local_secondary_index :name
+  global_secondary_index(:name_index, { hash_key: :name, projection: [:name] })
+
+  read_provision 4
+  write_provision 4
+  guid_delimiter "!"
+
+  validates_presence_of :name
+  
+  before_create :do_something
+  before_validation on: :create do
+    do_something
+  end
+
+end
+```
+
+## Sample Methods
+```
+# Read a single object by Hash and (optionally) Range keys
+Dude.read
+
+# Query by Hash and (optionally) Range keys (compatible with Local and Global Secondary Indexes)
+Dude.read_range
+
+# Batch read
+Dude.read_multiple
+
+# Read by guid (helper for hash + guid_delimiter + range)
+Dude.read_guid
+
+# Get count of query
+Dude.count_range
+
+# Table scan with more complex filters
+Dude.scan
+
+# Create Table
+Dude.create_table
+
+# Delete Table
+Dude.delete_table
+
+# Rake tasks
+rake ddb:create CLASS=Dude
+rake ddb:create CLASS=all
+rake ddb:destroy CLASS=Dude
+rake ddb:destroy CLASS=all
+```
+
+# AWS::Record
+* http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/Record.html
+* https://github.com/aws/aws-sdk-ruby/blob/master/lib/aws/record/abstract_base.rb

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/dyna_model.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dyna_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dyna_model"
+  spec.version       = DynaModel::VERSION
+  spec.authors       = ["Cary Dunn"]
+  spec.email         = ["cary.dunn@gmail.com"]
+  spec.summary       = %q{DyanmoDB ORM on AWS::Record}
+  spec.description   = %q{DyanmoDB ORM on AWS::Record}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'activemodel', '>= 4.0.0'
+  spec.add_dependency 'rails', '>= 4.0.0'
+  spec.add_dependency 'aws-sdk', '>= 1.38.0'
+end
+  

data/lib/dyna_model/attributes.rb

@@ -0,0 +1,187 @@
+module DynaModel
+  module Attributes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Adds a string attribute to this class.
+      #
+      # @example A standard string attribute
+      #
+      #   class Recipe < AWS::Record::HashModel
+      #     string_attr :name
+      #   end
+      #
+      #   recipe = Recipe.new(:name => "Buttermilk Pancakes")
+      #   recipe.name #=> 'Buttermilk Pancakes'
+      #
+      # @example A string attribute with `:set` set to true
+      #
+      #   class Recipe < AWS::Record::HashModel
+      #     string_attr :tags, :set => true
+      #   end
+      #
+      #   recipe = Recipe.new(:tags => %w(popular dessert))
+      #   recipe.tags #=> #<Set: {"popular", "desert"}>
+      #
+      # @param [Symbol] name The name of the attribute.
+      # @param [Hash] options
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple values.
+      def string_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::StringAttr.new(name, options))
+      end
+
+      # Adds an integer attribute to this class.
+      #
+      #     class Recipe < AWS::Record::HashModel
+      #       integer_attr :servings
+      #     end
+      #
+      #     recipe = Recipe.new(:servings => '10')
+      #     recipe.servings #=> 10
+      #
+      # @param [Symbol] name The name of the attribute.
+      # @param [Hash] options
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple values.
+      def integer_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::IntegerAttr.new(name, options))
+      end
+
+      # Adds a float attribute to this class.
+      #
+      #     class Listing < AWS::Record::HashModel
+      #       float_attr :score
+      #     end
+      #
+      #     listing = Listing.new(:score => '123.456')
+      #     listing.score # => 123.456
+      #
+      # @param [Symbol] name The name of the attribute.
+      # @param [Hash] options
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple values.
+      def float_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::FloatAttr.new(name, options))
+      end
+
+      # Adds a boolean attribute to this class.
+      #
+      # @example
+      #
+      #   class Book < AWS::Record::HashModel
+      #     boolean_attr :read
+      #   end
+      #
+      #   b = Book.new
+      #   b.read? # => false
+      #   b.read = true
+      #   b.read? # => true
+      #
+      #   listing = Listing.new(:score => '123.456'
+      #   listing.score # => 123.456
+      #
+      # @param [Symbol] name The name of the attribute.
+      def boolean_attr name, options = {}
+
+        attr = add_attribute(AWS::Record::Attributes::BooleanAttr.new(name, options))
+
+        # add the boolean question mark method
+        define_method("#{attr.name}?") do
+          !!__send__(attr.name)
+        end
+
+      end
+
+      # Adds a datetime attribute to this class.
+      #
+      # @example A standard datetime attribute
+      #
+      #   class Recipe < AWS::Record::HashModel
+      #     datetime_attr :invented
+      #   end
+      #
+      #   recipe = Recipe.new(:invented => Time.now)
+      #   recipe.invented #=> <DateTime ...>
+      #
+      # If you add a datetime_attr for `:created_at` and/or `:updated_at` those
+      # will be automanaged.
+      #
+      # @param [Symbol] name The name of the attribute.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple date times.
+      #
+      def datetime_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::DateTimeAttr.new(name, options))
+      end
+
+      # Adds a date attribute to this class.
+      #
+      # @example A standard date attribute
+      #
+      #   class Person < AWS::Record::HashModel
+      #     date_attr :birthdate
+      #   end
+      #
+      #   baby = Person.new
+      #   baby.birthdate = Time.now
+      #   baby.birthdate #=> <Date: ....>
+      #
+      # @param [Symbol] name The name of the attribute.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple dates.
+      #
+      def date_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::DateAttr.new(name, options))
+      end
+
+      # Adds a DynamoDB binary attribute to this class.  A binary
+      # attribute acts the same as a string attribute, except
+      #
+      # @param [Symbol] name The name of the attribute.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Boolean] :set (false) When true this attribute
+      #   can have multiple values.
+      #
+      # @note This should not be used for large objects.
+      #
+      def binary_attr name, options = {}
+      end
+
+      def serialized_attr name, options = {}
+        add_attribute(AWS::Record::Attributes::SerializedAttr.new(name, options))
+      end
+
+      # A convenience method for adding the standard two datetime attributes
+      # `:created_at` and `:updated_at`.
+      #
+      # @example
+      #
+      #   class Recipe < AWS::Record::HashModel
+      #     timestamps
+      #   end
+      #
+      #   recipe = Recipe.new
+      #   recipe.save
+      #   recipe.created_at #=> <DateTime ...>
+      #   recipe.updated_at #=> <DateTime ...>
+      #
+      def timestamps
+        c = datetime_attr :created_at
+        u = datetime_attr :updated_at
+        [c, u]
+      end
+
+    end
+
+  end
+end

data/lib/dyna_model/aws/record/attributes/serialized_attr.rb

@@ -0,0 +1,33 @@
+module AWS
+  module Record
+    module Attributes
+      class SerializedAttr < BaseAttr
+
+        def self.type_cast raw_value, options = {}
+          case raw_value
+          when nil      then nil
+          when ''       then nil
+          when String # assume binary
+            begin
+              Marshal.load(raw_value)
+            rescue
+              raw_value
+            end
+          else # object to serialize
+            raw_value
+          end
+        end
+
+        def self.serialize obj, options = {}
+          AWS::DynamoDB::Binary.new(Marshal.dump(obj))
+        end
+
+        # @api private
+        def self.allow_set?
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/dyna_model/config/options.rb

@@ -0,0 +1,78 @@
+# Shamelessly stolen from Mongoid (and Dynamoid)!
+module DynaModel #:nodoc
+  module Config
+
+    # Encapsulates logic for setting options.
+    module Options
+
+      # Get the defaults or initialize a new empty hash.
+      #
+      # @example Get the defaults.
+      #   options.defaults
+      #
+      # @return [ Hash ] The default options.
+      #
+      # @since 0.2.0
+      def defaults
+        @defaults ||= {}
+      end
+
+      # Define a configuration option with a default.
+      #
+      # @example Define the option.
+      #   Options.option(:persist_in_safe_mode, :default => false)
+      #
+      # @param [ Symbol ] name The name of the configuration option.
+      # @param [ Hash ] options Extras for the option.
+      #
+      # @option options [ Object ] :default The default value.
+      #
+      # @since 0.2.0
+      def option(name, options = {})
+        defaults[name] = settings[name] = options[:default]
+
+        class_eval <<-RUBY
+          def #{name}
+            settings[#{name.inspect}]
+          end
+
+          def #{name}=(value)
+            settings[#{name.inspect}] = value
+          end
+
+          def #{name}?
+            #{name}
+          end
+          
+          def reset_#{name}
+            settings[#{name.inspect}] = defaults[#{name.inspect}]
+          end
+        RUBY
+      end
+
+      # Reset the configuration options to the defaults.
+      #
+      # @example Reset the configuration options.
+      #   config.reset
+      #
+      # @return [ Hash ] The defaults.
+      #
+      # @since 0.2.0
+      def reset
+        settings.replace(defaults)
+      end
+
+      # Get the settings or initialize a new empty hash.
+      #
+      # @example Get the settings.
+      #   options.settings
+      #
+      # @return [ Hash ] The setting options.
+      #
+      # @since 0.2.0
+      def settings
+        @settings ||= {}
+      end
+    end
+  end
+end

data/lib/dyna_model/config.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require "uri"
+require "dyna_model/config/options"
+
+# Shamelessly stolen from Dynamoid
+module DynaModel
+
+  # Contains all the basic configuration information required for Dynamoid: both sensible defaults and required fields.
+  module Config
+    extend self
+    extend Options
+
+    # All the default options.
+    option :logger, :default => defined?(Rails)
+    option :read_provision, :default => 50
+    option :write_provision, :default => 10
+    # TODO - default adapter client based on config
+    #option :namespace, :default => defined?(Rails) ? "#{Rails.application.class.parent_name}_#{Rails.env}" : ""
+    option :endpoint, :default => 'dynamodb.us-west-2.amazonaws.com'
+    option :port, :default => 443
+    option :use_ssl, :default => true
+    option :default_guid_delimiter, :default => ":"
+    option :namespace, :default => ""
+
+    # The default logger: either the Rails logger or just stdout.
+    def default_logger
+      defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new($stdout)
+    end
+
+    # Returns the assigned logger instance.
+    def logger
+      @logger ||= default_logger
+    end
+
+    # If you want to, set the logger manually to any output you'd like. Or pass false or nil to disable logging entirely.
+    def logger=(logger)
+      case logger
+      when false, nil then @logger = nil
+      when true then @logger = default_logger
+      else
+        @logger = logger if logger.respond_to?(:info)
+      end
+    end
+
+  end
+end

data/lib/dyna_model/document.rb

@@ -0,0 +1,169 @@
+module DynaModel
+  module Document
+
+    MAX_ITEM_SIZE = 65_536
+    # These delimiters are also reserved characters and should not be used in
+    # hash or range keys
+    GUID_DELIMITER_PRECEDENCE = ["_", ":", "|", ",", "!", "~", "@", "^"]
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :read_only_attributes, :base_class
+      self.base_class = self
+
+      AWS::Record.table_prefix = "#{DynaModel::Config.namespace}#{Rails.application.class.parent_name.to_s.underscore.dasherize}-#{Rails.env}-"
+
+      extend ActiveModel::Translation
+      extend ActiveModel::Callbacks
+      extend AWS::Record::AbstractBase
+      include DynaModel::Persistence
+      include DynaModel::Validations
+
+      define_model_callbacks :create, :save, :destroy, :initialize, :update, :validation
+
+      # OVERRIDE
+      # https://github.com/aws/aws-sdk-ruby/blob/master/lib/aws/record/abstract_base.rb#L258
+      # AWS::Record::AbstractBase for :select attributes
+      protected
+      def [] attribute_name
+        # Warn if using attributes that were not part of the :select (common with GSI/LSI projections)
+        #   we do not want to give the impression they are nil
+        if (selected_attrs = self.instance_variable_get("@_selected_attributes"))
+          raise "Attribute '#{attribute_name}' was not part of the select '#{self.instance_variable_get("@_select")}' (available attributes: #{selected_attrs})" unless selected_attrs.include?(attribute_name)
+        end
+        super
+      end
+    end
+
+    include ActiveModel::Conversion
+    include ActiveModel::MassAssignmentSecurity if defined?(ActiveModel::MassAssignmentSecurity)
+    include ActiveModel::Naming
+    include ActiveModel::Observing if defined?(ActiveModel::Observing)
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::Serializers::Xml
+    
+    include DynaModel::Attributes
+    include DynaModel::Schema
+    include DynaModel::Query
+
+    def to_param
+      self.dynamo_db_guid
+    end
+
+    def dynamo_db_guid
+      _guid = [self.dynamo_db_item_key_values[:hash_value]]
+      _guid << self.dynamo_db_item_key_values[:range_value] if self.dynamo_db_item_key_values[:range_value]
+      _guid.join(self.class.guid_delimiter)
+    end
+
+    def dynamo_db_item_key_values
+      key_values = { hash_value: self[self.class.hash_key[:attribute_name]] }
+      key_values.merge!(range_value: self[self.class.range_key[:attribute_name]]) if self.class.range_key
+      key_values
+    end
+
+    def all_attributes_loaded?
+      self.instance_variable_get("@_select") == :all
+    end
+
+    # When only partial attributes were selected (via GSI or projected attributes on an index)
+    def load_attributes!
+      raise "All attributes already loaded!" if self.instance_variable_get("@_select") == :all
+      options = { shard_name: self.shard }
+      if self.class.range_key
+        obj = self.class.read(dynamo_db_item_key_values[:hash_value], dynamo_db_item_key_values[:range_value], options)
+      else
+        obj = self.class.read(dynamo_db_item_key_values[:hash_value], options)
+      end
+      raise "Could not find object" unless obj
+      self.instance_variable_set("@_select", :all)
+      self.remove_instance_variable("@_selected_attributes")
+      self.instance_variable_set("@_data", obj.instance_variable_get("@_data"))
+      self
+    end
+
+    def touch
+      self.send(:touch_timestamps, "updated_at")
+    end
+
+    def touch!
+      self.touch
+      self.save
+    end
+
+    module ClassMethods
+
+      def create_table options = {}
+        table_name = self.dynamo_db_table_name(options[:shard_name])
+        if self.dynamo_db_client.list_tables[:table_names].include?(table_name)
+          puts "Table #{table_name} already exists"
+          return false
+        end
+        self.dynamo_db_client.create_table(self.table_schema.merge({
+          table_name: table_name
+        }))
+        while (table_metadata = self.describe_table(options))[:table][:table_status] == "CREATING"
+          sleep 1
+        end
+        table_metadata
+      end
+
+      def describe_table(options={})
+        self.dynamo_db_client.describe_table(table_name: self.dynamo_db_table_name(options[:shard_name]))
+      end
+
+      def delete_table(options={})
+        table_name = self.dynamo_db_table_name(options[:shard_name])
+        return false unless self.dynamo_db_client.list_tables[:table_names].include?(table_name)
+        self.dynamo_db_client.delete_table(table_name: table_name)
+        begin
+          while (table_metadata = self.describe_table) && table_metadata[:table][:table_status] == "DELETING"
+            sleep 1
+          end
+        rescue AWS::DynamoDB::Errors::ResourceNotFoundException => e
+          DynaModel::Config.logger.info "Table deleted"
+        end
+        true
+      end
+
+      def resize_table(options={})
+        table_name = self.dynamo_db_table_name(options[:shard_name])
+        return false unless self.dynamo_db_client.list_tables[:table_names].include?(table_name)
+        self.dynamo_db_client.update_table({
+          provisioned_throughput: {
+            read_capacity_units: (options[:read_capacity_units] || self.table_schema[:provisioned_throughput][:read_capacity_units]).to_i,
+            write_capacity_units: (options[:write_capacity_units] || self.table_schema[:provisioned_throughput][:write_capacity_units]).to_i
+          },
+          table_name: table_name
+        })
+        while (table_metadata = self.describe_table) && table_metadata[:table][:table_status] == "UPDATING"
+          sleep 1
+        end
+        DynaModel::Config.logger.info "Table resized to #{table_metadata[:table][:provisioned_throughput]}"
+        true
+      end
+
+      def dynamo_db_table(shard_name = nil)
+        @table_map ||= {}
+        @table_map[self.dynamo_db_table_name(shard_name)] ||= Table.new(self)
+      end
+
+      def dynamo_db_table_name(shard_name = nil)
+        "#{AWS::Record.table_prefix}#{self.shard_name(shard_name)}"
+      end
+
+      def dynamo_db_client(config={})
+        options = {}
+        options[:use_ssl] = DynaModel::Config.use_ssl
+        options[:use_ssl] = config[:use_ssl] if config.has_key?(:use_ssl)
+        options[:dynamo_db_endpoint] = config[:endpoint] || DynaModel::Config.endpoint
+        options[:dynamo_db_port] = config[:port] || DynaModel::Config.port
+        options[:api_version] ||= config[:api_version] || '2012-08-10'
+
+        @dynamo_db_client ||= AWS::DynamoDB::Client.new(options)
+      end
+
+    end
+  end
+end