dynamini 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b9099abc1be34863020585c0b6a7da041d06d81
+  data.tar.gz: 0f01450cdfbc3c4c4d09e18641bb87b6fd20666e
+SHA512:
+  metadata.gz: 4aef240c1f66a73a6eb9bbbb3825800b9da44becf37b223174c19965e56ea4e9f965b5db37f1e13f106b23d180642ceabc513bd27898fcd3d8d9bcc83fed0326
+  data.tar.gz: 0ecddfe0e5fad8dcf8fd8357a19f6f0e226477ccf1d0e8cd448a63a92547fdf7874ce597b9455727acc2344f0dfeab249c4a7bc259c5d69c3fa299f7486a0596

data/lib/dynamini.rb

@@ -0,0 +1,25 @@
+module Dynamini
+  require 'active_model'
+  require 'dynamini/base'
+  require 'dynamini/configuration'
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+
+
+# Dynamini.configure do |config|
+#   config.aws_region = 'eu-west-1'
+#   config.access_key_id =
+#   config.secret_access_key =
+# end

data/lib/dynamini/base.rb

@@ -0,0 +1,237 @@
+module Dynamini
+  class Base
+    include ActiveModel::Validations
+    attr_reader :attributes
+
+    BATCH_SIZE = 25
+
+    class << self
+      attr_writer :hash_key, :table_name, :batch_write_queue
+
+      def table_name
+        @table_name || name.demodulize.downcase.pluralize
+      end
+
+      def hash_key
+        @hash_key || :id
+      end
+
+      def batch_write_queue
+        @batch_write_queue ||= []
+      end
+
+      def client
+        @client ||= Aws::DynamoDB::Client.new(
+            region: Dynamini.configuration.region,
+            access_key_id: Dynamini.configuration.access_key_id,
+            secret_access_key: Dynamini.configuration.secret_access_key)
+      end
+
+      def create(attributes, options={})
+        model = self.new(attributes, true)
+        model if model.save(options)
+      end
+
+      def create!(attributes, options={})
+        model = self.new(attributes, true)
+        model if model.save!(options)
+      end
+
+      def find(key)
+        response = client.get_item(table_name: table_name, key: {hash_key => key})
+        raise 'Item not found.' unless response.item
+        self.new(response.item.symbolize_keys, false)
+      end
+
+      def find_or_new(key)
+        response = client.get_item(table_name: table_name, key: {hash_key => key})
+        if response.item
+          self.new(response.item.symbolize_keys, false)
+        else
+          self.new(hash_key => key)
+        end
+      end
+
+      def batch_find(ids = [])
+        return [] if ids.length < 1
+        raise StandardError, 'Batch find is limited to 100 items' if ids.length > 100
+        key_structure = ids.map { |i| {hash_key => i} }
+        response = self.dynamo_batch_get(key_structure)
+        response.responses[table_name]
+      end
+
+      def enqueue_for_save(attributes, options = {})
+        model = self.new(attributes, true)
+        model.generate_timestamps! unless options[:skip_timestamps]
+        if model.valid?
+          batch_write_queue << model
+          flush_queue! if batch_write_queue.length == BATCH_SIZE
+          return true
+        end
+        false
+      end
+
+      def flush_queue!
+        response = self.dynamo_batch_save(batch_write_queue)
+        self.batch_write_queue = []
+        response
+      end
+
+    end
+
+    def initialize(attributes={}, new_record = true)
+      @attributes = attributes
+      @changed = Set.new
+      @new_record = new_record
+      add_changed(attributes)
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |key, value|
+        record_change(key, read_attribute(key), value)
+      end
+      @attributes.merge!(attributes)
+      nil
+    end
+
+    def save(options = {})
+      @changed.empty? || valid? && trigger_save(options)
+    end
+
+    def save!(options = {})
+
+      options[:validate]= true if options[:validate].nil?
+
+      unless @changed.empty?
+        if (options[:validate] && valid?) || !options[:validate]
+          trigger_save(options)
+        else
+          raise StandardError, errors.full_messages
+        end
+      end
+    end
+
+    def touch(options = {validate: true})
+      raise RuntimeError, 'Cannot touch a new record.' if new_record?
+      if (options[:validate] && valid?) || !options[:validate]
+        trigger_touch
+      else
+        raise StandardError, errors.full_messages
+      end
+    end
+
+    def changes
+      @attributes.select { |attribute| @changed.include?(attribute.to_s) && attribute != self.class.hash_key }
+    end
+
+    def changed
+      @changed.to_a
+    end
+
+    def new_record?
+      @new_record
+    end
+
+    private
+
+    def add_changed(attributes)
+      @changed += attributes.keys.map(&:to_s)
+    end
+
+    def trigger_save(options = {})
+      generate_timestamps! unless options[:skip_timestamps]
+      save_to_dynamo
+      clear_changes
+      @new_record = false
+      true
+    end
+
+    def trigger_touch
+      generate_timestamps!
+      touch_to_dynamo
+      true
+    end
+
+    def generate_timestamps!
+      self.updated_at= Time.now.to_f
+      self.created_at= Time.now.to_f if new_record?
+    end
+
+    def save_to_dynamo
+      Base.client.update_item(table_name: self.class.table_name, key: key, attribute_updates: attribute_updates)
+    end
+
+    def touch_to_dynamo
+      Base.client.update_item(table_name: self.class.table_name, key: key, attribute_updates: {updated_at: {value: updated_at, action: 'PUT'}})
+    end
+
+    def self.dynamo_batch_get(key_structure)
+      client.batch_get_item(request_items: {table_name => {keys: key_structure}})
+    end
+
+    def self.dynamo_batch_save(model_array)
+      put_requests = []
+      model_array.each do |model|
+        put_requests << {put_request: {item: model.attributes.reject{|k, v| v.blank?}.stringify_keys}}
+      end
+      request_options = {request_items: {
+          "#{table_name}" => put_requests}
+      }
+      client.batch_write_item(request_options)
+    end
+
+    def key
+      {self.class.hash_key => @attributes[self.class.hash_key]}
+    end
+
+    def attribute_updates
+      changes.reduce({}) do |updates, (key, value)|
+        updates[key] = {value: value, action: 'PUT'} unless value.blank?
+        updates
+      end
+    end
+
+    def clear_changes
+      @changed = Set.new
+    end
+
+    def method_missing(name, *args, &block)
+      if write_method?(name)
+        attribute = name[0..-2].to_sym
+        new_value = args.first
+        write_attribute(attribute, new_value)
+      elsif read_method?(name)
+        read_attribute(name)
+      else
+        super
+      end
+    end
+
+    def read_method?(name)
+      name =~ /^([a-zA-Z][-_\w]*)[^=?]*$/
+    end
+
+    def write_method?(name)
+      name =~ /^([a-zA-Z][-_\w]*)=.*$/
+    end
+
+    def respond_to_missing?(name, include_private=false)
+      @attributes.keys.include?(name) || write_method?(name) || super
+    end
+
+    def write_attribute(attribute, new_value)
+      raise StandardError, 'Cannot edit hash key, create a new object instead.' if attribute == self.class.hash_key
+      old_value = @attributes[attribute]
+      @attributes[attribute] = new_value
+      record_change(attribute, new_value, old_value)
+    end
+
+    def record_change(attribute, new_value, old_value)
+      @changed << attribute.to_s if new_value != old_value
+    end
+
+    def read_attribute(name)
+      @attributes[name]
+    end
+  end
+end

data/lib/dynamini/configuration.rb

@@ -0,0 +1,5 @@
+module Dynamini
+  class Configuration
+    attr_accessor :region, :access_key_id, :secret_access_key
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: dynamini
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Greg Ward
+- David McHoull
+- Alishan Ladhani
+- Emily Fan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Lightweight DynamoDB interface designed as a drop-in replacement for
+  ActiveRecord.
+email: dev@retailcommon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dynamini.rb
+- lib/dynamini/base.rb
+- lib/dynamini/configuration.rb
+homepage: https://github.com/47colborne/dynamini
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: DynamoDB interface
+test_files: []