dynamodb-migration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bcbd5523525b31582b3fdc18c2d9eb567d00547
+  data.tar.gz: 2c939f83c5e65d2d92314addf257450790d16495
+SHA512:
+  metadata.gz: 550f89961218ccebc933cf2f5e5ab177ef88c49b4704bba5ea434e8237e5a6e9192521cfa7066adba920e0ae5a6681159fcc7a5bcc804cd6df06fe89bc3792ea
+  data.tar.gz: a3ca25874298df3a0423eb12957b3a9ed569b097c3015a5b21a81456418d1943d954f19fdfe305d853247af5f345cd35a406d9630a59fa84bab43d9b33f1a936

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at henry.lawson@foinq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Henry Lawson
+
+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,105 @@
+# Dynamodb::Migration
+
+Allows for the creation of simple DynamoDB commands that will be executed only once against a DynamoDB database to allow you to "migrate" the schema of the database over time. This is a simple implementation for DynamoDB, similar to tools such as FlywayDB and Active Record Migrations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynamodb-migration'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamodb-migration
+
+## Usage
+
+In a rake task or in your applications start up, simply add:
+
+```ruby
+options = {
+  client: dynamodb-client,        # an Aws::DynamoDB::Client instance
+  path: '~/my_project/migrations' # the full path to the folder where your migration classes will live
+}
+DynamoDB::Migration.run_all_migrations(options)
+```
+
+Or if you are using a Sinatra application, in your `config.ru`:
+
+```ruby
+# the full path to the folder where your migration classes will live
+# we are assuming you will place your migrations in a "migrations" folder
+# next to config.ru
+set :migrations_path, File.join(File.dirname(__FILE__), 'migrations')
+
+# registering the below requires the "dynamodb-client" gem, alternatively
+# you can return a Aws::DynamoDB::Client instance from a method named
+# `dynamodb_client`
+register DynamoDB::Client
+
+# registering this extension will automatically run migrations when the app
+# starts up
+register DynamoDB::Migration
+```
+
+To define a migration, create a class in your `migrations` folder (defined
+above with the `path` option) such as the one below:
+
+
+```ruby
+# migrations/20150215181100_create_table_users.rb
+
+class CreateTableUsers < DynamoDB::Migration::Unit
+  def update
+    client.create_table(
+      table_name: "users",
+      attribute_definitions: [
+        {
+          attribute_name: "username",
+          attribute_type: "S",
+        },
+      ],
+      key_schema: [
+        {
+          attribute_name: "username",
+          key_type: "HASH",
+        },
+      ],
+      provisioned_throughput: {
+        read_capacity_units: 1,
+        write_capacity_units: 1,
+      },
+      stream_specification: {
+        stream_enabled: true,
+        stream_view_type: "NEW_AND_OLD_IMAGES",
+      },
+    )
+  end
+end
+```
+
+DynamoDB::Migration will detect this class and execute once against your
+DynamoDB instance. It will record the execution in a table called `migrations`
+which it creates and maintains internally.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dynamodb-migration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dynamodb/migration"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dynamodb-migration.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dynamodb/migration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynamodb-migration"
+  spec.version       = Dynamodb::Migration::VERSION
+  spec.authors       = ["Henry Lawson"]
+  spec.email         = ["henry.lawson@foinq.com"]
+
+  spec.summary       = %q{A simple DynamoDB migration tool.}
+  spec.description   = %q{Allows for the creation of simple DynamoDB commands that will be executed only once against a DynamoDB database to allow you to "migrate" the schema of the database over time. This is a simple implementation for DynamoDB, similar to tools such as FlywayDB and Active Record Migrations.}
+  spec.homepage      = "https://github.com/henrylawson/dynamodb-migration"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk", "~> 2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dynamodb/migration.rb

@@ -0,0 +1,23 @@
+require "dynamodb/migration/version"
+require "dynamodb/migration/execute"
+require "dynamodb/migration/unit"
+
+module Dynamodb
+  module Migration
+    def self.registered(app)
+      options = {
+        client: app.dynamodb_client,
+        path:   app.settings.migrations_path,
+      }
+      run_all_migrations(options)
+    end
+
+    def self.run_all_migrations(options)
+      Dir.glob("#{options[:path]}/**/*.rb").each do |file|
+        require file
+      end
+      Execute.new(options[:client])
+             .update_all
+    end
+  end
+end

data/lib/dynamodb/migration/execute.rb

@@ -0,0 +1,132 @@
+module DynamoDB
+  module Migration
+    class Execute
+      def initialize(client)
+        @client = client
+      end
+
+      def update_all
+        ensure_migrations_table_exists
+        migration_classes.each do |clazz|
+          apply_migration(clazz)
+        end
+      end
+
+      private
+
+      attr_reader :client
+
+      def apply_migration(clazz)
+        return if migration_executed?(clazz)
+        record_start_migration(clazz)
+        migration = clazz.new
+        migration.client = client
+        migration.update
+        record_successful_migration(clazz)
+      rescue Aws::DynamoDB::Errors::ServiceError => e
+        record_failed_migration(clazz)
+        raise
+      end
+
+      def record_failed_migration(clazz)
+        client.delete_item({
+          table_name: "migrations",
+          key: {
+            "file" => clazz_filename(clazz),
+          },
+          condition_expression: "completed = :false",
+          expression_attribute_values: {
+            ":false" => false
+          }
+        })
+      end
+
+      def record_start_migration(clazz)
+        client.put_item({
+          table_name: "migrations",
+          item: {
+            "file" => clazz_filename(clazz),
+            "executed_at" => Time.now.iso8601,
+            "created_at" => Time.now.iso8601,
+            "updated_at" => Time.now.iso8601,
+            "completed" => false,
+          },
+          return_values: "NONE",
+        })
+      end
+
+      def record_successful_migration(clazz)
+        client.update_item({
+          table_name: "migrations",
+          key: {
+            "file" => clazz_filename(clazz),
+          },
+          update_expression: "SET completed = :true",
+          condition_expression: "completed = :false",
+          expression_attribute_values: {
+            ":false" => false,
+            ":true"  => true,
+          }
+        })
+      end
+
+      def clazz_filename(clazz)
+        full_filename = clazz.instance_methods(false)
+                             .map { |m| clazz.instance_method(m).source_location }
+                             .compact
+                             .map { |m| m.first }
+                             .uniq
+                             .first
+        File.basename(full_filename)
+      end
+
+      def migration_classes
+        ObjectSpace.each_object(Migration.singleton_class)
+                   .reject { |c| c == Migration }
+      end
+
+      def migration_executed?(clazz)
+        client.get_item({
+          table_name: "migrations",
+          key: {
+            "file" => clazz_filename(clazz),
+          },
+          attributes_to_get: ["file"],
+          consistent_read: true,
+        }).item
+      end
+
+      def ensure_migrations_table_exists
+        client.create_table(
+          table_name: "migrations",
+          attribute_definitions: [
+            {
+              attribute_name: "file",
+              attribute_type: "S",
+            },
+          ],
+          key_schema: [
+            {
+              attribute_name: "file",
+              key_type: "HASH",
+            },
+          ],
+          provisioned_throughput: {
+            read_capacity_units: 1,
+            write_capacity_units: 1,
+          },
+          stream_specification: {
+            stream_enabled: true,
+            stream_view_type: "NEW_AND_OLD_IMAGES",
+          },
+        ) unless table_exists?(client, 'migrations')
+      end
+
+      def table_exists?(client, table_name)
+        client.describe_table(table_name: table_name)
+      rescue Aws::DynamoDB::Errors::ResourceNotFoundException => e
+        false
+      end
+    end
+  end
+end

data/lib/dynamodb/migration/unit.rb

@@ -0,0 +1,11 @@
+module DynamoDB
+  module Migration
+    class Unit
+      attr_accessor :client
+
+      def update
+        raise 'Update method not implemented by migration class'
+      end
+    end
+  end
+end

data/lib/dynamodb/migration/version.rb

@@ -0,0 +1,5 @@
+module Dynamodb
+  module Migration
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dynamodb-migration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henry Lawson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allows for the creation of simple DynamoDB commands that will be executed
+  only once against a DynamoDB database to allow you to "migrate" the schema of the
+  database over time. This is a simple implementation for DynamoDB, similar to tools
+  such as FlywayDB and Active Record Migrations.
+email:
+- henry.lawson@foinq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dynamodb-migration.gemspec
+- lib/dynamodb/migration.rb
+- lib/dynamodb/migration/execute.rb
+- lib/dynamodb/migration/unit.rb
+- lib/dynamodb/migration/version.rb
+homepage: https://github.com/henrylawson/dynamodb-migration
+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.5
+signing_key: 
+specification_version: 4
+summary: A simple DynamoDB migration tool.
+test_files: []