dynamo-local-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d88cfeb4d699b0b86c215120b9271c36bdea10eb
+  data.tar.gz: 7c90f7cf23759d34b451d5f0b3b09cdf559f8e60
+SHA512:
+  metadata.gz: ad4e37aa7c504f170b0f48b4031a045fd811d61e8250d66e5d2f7afa48a741e39485dcbac8c17e066a3653cb470c4185bd21543c368e78dfdf2652a8fc7374c8
+  data.tar.gz: 5d3650733ef2f4b1e81d636e8dc56adbb7e3722854322021e5b8f5c4aba11279968daa093b05600c815ddf578538166f2a541e47a36ec026c5ab0b47b7415616

data/.gitignore

@@ -0,0 +1,15 @@
+/vendor/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,7 @@
+# This is the configuration used to check the rubocop source code.
+
+Style/Encoding:
+  Enabled: true
+
+Style/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dynamo-local-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Peak Xu
+
+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,41 @@
+# DynamoLocalRuby
+
+Ruby wrapper around DynamoLocal to enable easier testing of your Ruby code that uses Dynamo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynamo-local-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamo-local-ruby
+
+## Usage
+
+In your application code, initialize Dynamo clients with
+
+    Aws::DynamoDB::Client.new(endpoint: DynamoLocalRuby::DynamoDBLocal::ENDPOINT)
+
+Before the test suite starts (for instance in RSpec's `config.before(:suite)`). Where `<build directory>` is accessible path in your project's path for build process artifacts.
+
+    DynamoLocalRuby::DynamoDBLocal.up(<build_directory>)
+
+When cleaning up test suite (for instance in RSpec's `config.after(:suite)`)
+
+    DynamoLocalRuby::DynamoDBLocal.down
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dynamo-local-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/dynamo-local-ruby.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dynamo-local-ruby'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dynamo-local-ruby'
+  spec.version       = DynamoLocalRuby::VERSION
+  spec.authors       = ['Peak Xu']
+  spec.email         = ['peak.xu@gmail.com']
+  spec.summary       = 'Ruby wrapper around DynamoDB Local for use with AWS-SDK'
+  spec.description   = 'Ruby wrapper around DynamoDB Local for use with AWS-SDK'
+  spec.homepage      = 'https://github.com/peakxu/dynamo-local-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/dynamo-local-ruby.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'dynamo-local-ruby/version'
+require 'dynamo-local-ruby/dynamo_db_local'
+require 'dynamo-local-ruby/schema_loader'

data/lib/dynamo-local-ruby/dynamo_db_local.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+# Start dynamo DB local
+module DynamoLocalRuby
+  # Wrapper around Dynamo DB local process
+  class DynamoDBLocal
+    PORT = 9389
+    ENDPOINT = "http://localhost:#{PORT}"
+    LATEST_WEB_TGZ = 'http://dynamodb-local.s3-website-us-west-2.amazonaws.com'\
+                     '/dynamodb_local_latest.tar.gz'
+
+    def initialize(pid)
+      @pid = pid
+    end
+
+    class << self
+      def ensure_dynamo_local_exists(local_path)
+        jar_path = File.join(local_path, 'DynamoDBLocal.jar')
+        return if File.exist?(jar_path)
+        `mkdir -p #{local_path}`
+        latest = File.join(local_path, 'dynamodb_local_latest.tar.gz')
+        `wget #{LATEST_WEB_TGZ} -o #{latest}` unless File.exist?(latest)
+        `tar xzf #{latest} -C #{local_path}`
+      end
+
+      def up(build_path)
+        local_path = File.join(build_path, 'dynamo_db_local')
+        ensure_dynamo_local_exists(local_path)
+        lib_path = File.join(local_path, 'DynamoDBLocal_lib')
+        jar_path = File.join(local_path, 'DynamoDBLocal.jar')
+        pid = spawn("java -Djava.library.path=#{lib_path} -jar #{jar_path} "\
+                    "-sharedDb -inMemory -port #{PORT}")
+        @instance = DynamoDBLocal.new(pid)
+
+        @instance
+      end
+
+      def down
+        @instance.down if defined? @instance
+      end
+    end
+
+    def down
+      return unless @pid
+      Process.kill('SIGINT', @pid)
+      Process.waitpid2(@pid)
+      @pid = nil
+    end
+  end
+end

data/lib/dynamo-local-ruby/schema_loader.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'aws-sdk'
+
+# Start dynamo DB local
+module DynamoLocalRuby
+  # Helper for creating tables from a schema definition
+  class SchemaLoader
+    def initialize(dynamo_client)
+      @dynamo = Aws::DynamoDB::Resource.new(client: dynamo_client)
+    end
+
+    # Expect schema to have form
+    # {
+    #   'table_name' => {
+    #     keys: {
+    #       'foo' => { attribute_type: 'S', key_type: 'HASH' }
+    #     },
+    #     capacity: { read: 1, write: 1 }  # optional
+    #   }
+    # }
+    def load(schema)
+      schema.each { |name, table_schema| load_table(name, table_schema) }
+    end
+
+    private
+
+    def load_table(name, schema)
+      @dynamo.table(name).table_status
+    rescue Aws::DynamoDB::Errors::ResourceNotFoundException
+      opts = { table_name: name, attribute_definitions: [],
+               key_schema: [], provisioned_throughput: {} }
+      load_keys_to_opts(opts, schema)
+      load_capacity_to_opts(opts, schema)
+      @dynamo.create_table(opts)
+    end
+
+    def load_keys_to_opts(opts, schema)
+      schema[:keys].each do |key, payload|
+        opts[:attribute_definitions] << {
+          attribute_name: key.to_s, attribute_type: payload[:attribute_type] }
+        opts[:key_schema] << {
+          attribute_name: key.to_s, key_type: payload[:key_type] }
+      end
+    end
+
+    def load_capacity_to_opts(opts, schema)
+      read = schema[:capacity] ? schema[:capacity][:read] : 1
+      write = schema[:capacity] ? schema[:capacity][:write] : 1
+      opts[:provisioned_throughput] = {
+        read_capacity_units: read, write_capacity_units: write }
+    end
+  end
+end

data/lib/dynamo-local-ruby/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+# Dynamo local ruby namespace
+module DynamoLocalRuby
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dynamo-local-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Peak Xu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rubocop
+  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: Ruby wrapper around DynamoDB Local for use with AWS-SDK
+email:
+- peak.xu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dynamo-local-ruby.gemspec
+- lib/dynamo-local-ruby.rb
+- lib/dynamo-local-ruby/dynamo_db_local.rb
+- lib/dynamo-local-ruby/schema_loader.rb
+- lib/dynamo-local-ruby/version.rb
+homepage: https://github.com/peakxu/dynamo-local-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around DynamoDB Local for use with AWS-SDK
+test_files: []