tiny_dyno 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e189c01a3f68cd0b380b35eaea4a0edbfa52578c
+  data.tar.gz: 5be36bd2c1f97a3a7a7edf4be34581b3b3de09cd
+SHA512:
+  metadata.gz: 25161a1faf09b898f40894dce7234accc7aa1d35b2d072fa17b0e5d09fbc8c41e15629d454ea6743fb079b08b5925f902acc4b90de8ccf1b440ac42a7dda5bd7
+  data.tar.gz: bc56b228fc8ed10ea00eecef27d6536e77dbe323d994bb3387a99ef80f0c2450a015ff1a9bda363d5bc97adbdcba3220c166ff4f63bc07b0d0f0658a749c8d02

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.simplecov

@@ -0,0 +1,2 @@
+SimpleCov.start
+SimpleCov.minimum_coverage 85

data/.travis.yml

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib spec) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec spec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE

@@ -0,0 +1,41 @@
+Copyright (c) 2015 Tobias Gerschner, RataWorks
+
+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.
+
+Copyright (c) 2009-2013 Durran Jordan
+
+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,121 @@
+Minimalist ODM for commonly used operations with dynamodb.
+==========================================================
+
+This is not a complete ODM for DynamoDB!
+Check https://gitter.im/aws/aws-sdk-ruby or http://ruby.awsblog.com/ for that instead, rumour has it one might be appearing soon.
+
+This work is heavily influenced in layout by the awesome mongoid gem, which I have used for years. Since I shouldn't be writing a full ODM I have borrowed as much as needed, especially to implement ActiveSupport::Concern way of module dependency resolution.
+I also shied away from reinventing perfectly valid methods if they were in Mongoid. So, if code looks familiar to you, it probably is.
+
+So, thanks goes to Durran Jordan @ mongoid/mongoid. 
+
+Beyond that, TinyDyno is a <working>, no frills abstraction to work with DynamoDB on EC2 within ruby apps.
+
+If you're new to DynamoDB, it is highly recommended to read the following:
+
+[GettingStartedDynamoDB](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GettingStartedDynamoDB.html)
+
+[GuidelinesForTables](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GuidelinesForTables.html)
+
+Supported Operations
+--------------------
+
+create_table
+------------
+
+Indexes in dynamo are created at table creation time.
+
+either Model.create_table
+
+rake tiny_dyno:create_tables
+
+delete_table
+------------
+
+Model.delete_table
+
+put_item
+--------
+
+http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method
+Invoked upon create/create!
+
+supported keys;
+
+* table_name
+* item
+
+update_item
+-----------
+
+http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method
+Invoked upon save on existing objects.
+
+supported_keys;
+
+* table_name
+* key
+* attribute_updates
+
+delete_item
+------------
+
+* hash_key
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_dyno'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_dyno
+
+## Usage
+
+```
+
+require 'tiny_dyno'
+class Person
+  include TinyDyno::Document
+
+  hash_key :id, type: Integer
+
+  field :first_name, type: String
+  field :last_name, type: String
+  field :age, type: Integer
+
+end
+
+require 'fabrication'
+
+Fabricator(:person) do
+  id { Faker::Number.number(10) }
+  first_name { Faker::Name.first_name }
+  last_name { Faker::Name.last_name }
+  age { Faker::Number.number(2) }
+end
+
+person = Fabricate(:person)
+
+```
+
+## Development
+
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/RataWorks/tiny_dyno.
+

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,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tiny_dyno"
+
+require 'pry'
+
+Pry.start

data/bin/fastcheck

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tiny_dyno'
+require 'faker'
+require 'fabrication'
+
+
+Dir.glob(File.join(ENV['PWD'],  'spec/models/*.rb')).each do |f|
+  p "loading #{ f }"
+  require f
+end
+
+Fabrication.configure do |config|
+  config.fabricator_path = 'spec/fabricators'
+  config.sequence_start = 10000
+end
+
+Fabrication.manager.load_definitions
+
+require 'pry'
+
+Aws.config[:endpoint] = 'http://172.17.42.1:8000'
+
+Pry.start

data/bin/setup

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

data/bin/tracer

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tiny_dyno"
+
+class SmallPerson
+  include TinyDyno::Document
+
+  hash_key :some_random, type: String
+
+  field :first_name, type: String
+  field :age, type: Integer
+
+end
+
+require 'tracer'
+Tracer.on
+sm = SmallPerson.new(first_name: 'peter_parker')
+

data/ci/tests.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+set -x
+
+setup_dynamodb_local() {
+
+    dynamodb_tar_file="dynamodb_local_2015-04-27_1.0.tar.gz"
+    dynamodb_dir=$HOME/dynamodb_local
+
+    if ! test -f "$HOME/$dynamodb_tar_file"
+    then
+      wget --continue --directory-prefix=$HOME -- "http://dynamodb-local.s3-website-us-west-2.amazonaws.com/${dynamodb_tar_file}"
+    fi
+    mkdir -p "$dynamodb_dir"
+    tar -xf $HOME/$dynamodb_tar_file -C ${dynamodb_dir}
+
+}
+
+test "$SNAP_CI" == "true" && setup_dynamodb_local
+
+export AWS_ACCESS_KEY_ID='foo'
+export AWS_SECRET_ACCESS_KEY='bar'
+export AWS_REGION="us-west-2"
+
+export BUNDLE_PATH="${SNAP_CACHE_DIR}/bundle-cache/tiny_ddb"
+
+export JRUBY_OPTS=" -Xcli.debug=true --debug "
+
+bundle install --clean
+
+#bundle exec rspec spec/dynamodb_unavailable/ ; unavail_exit_status=$?
+#test "$unavail_exit_status" -eq 0 || exit $unavail_exit_status
+
+pushd $dynamodb_dir
+    java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb -inMemory & dynamodb_pid=$!
+popd
+
+sleep 10
+curl -s http://127.0.0.1:8000 ; dynamodb_local=$?
+
+if test "$dynamodb_local" -eq 0
+then
+    echo "DynamoDB_Local is up, all tests should pass"
+else
+    echo "DynamoDB_Local setup failed, persistence tests will fail" 1>&2
+fi
+
+bundle exec rspec spec/tiny_dyno ; avail_exit_status=$?
+
+test "$SNAP_CI" == "true" && test -n "$dynamodb_pid" && kill -15 $dynamodb_pid
+
+exit $avail_exit_status

data/lib/config/locales/en.yml

@@ -0,0 +1,168 @@
+en:
+  tiny_dyno:
+    errors:
+      messages:
+        blank_in_locale:
+          "can't be blank in %{location}"
+        callbacks:
+          message: "Calling %{method} on %{klass} resulted in a false return
+            from a callback."
+          summary: "If a before callback returns false when using Document.create!,
+            Document#save!, or Document#update_attributes! this error will get raised
+            since the document did not actually get saved."
+          resolution: "Double check all before callbacks to make sure they are
+            not unintentionally returning false."
+        document_not_destroyed:
+          message: "%{klass} with id %{id} was not destroyed."
+          summary: "When calling %{klass}#destroy! and a callback halts the destroy
+            callback chain by returning a false value, the deletion will not
+            actually occur."
+          resolution: "Check the before/after destroy callbacks to ensure that the
+            return values are truthy for the chain to continue."
+        document_not_found:
+          message: "Document(s) not found for class %{klass} with id(s) %{missing}."
+          summary: "When calling %{klass}.find with an id or array of ids, each
+            parameter must match a document in the database or this error will be
+            raised. The search was for the id(s): %{searched} (%{total} total)
+            and the following ids were not found: %{missing}."
+          resolution: "Search for an id that is in the database or set
+            the Mongoid.raise_not_found_error configuration option to false,
+            which will cause a nil to be returned instead of raising this error when
+            searching for a single id, or only the matched documents when searching
+            for multiples."
+        invalid_field:
+          message: "Defining a field named '%{name}' is not allowed."
+          summary: "Defining this field would override the method '%{name}',
+            which would cause issues with expectations around the original
+            method and cause extremely hard to debug issues. The original
+            method was defined in:\n
+            \_\_Object: %{origin}\n
+            \_\_File: %{file}\n
+            \_\_Line: %{line}"
+          resolution: "Use Mongoid.destructive_fields to see what names are not
+            allowed, and don't use these names. These include names that also
+            conflict with core Ruby methods on Object, Module, Enumerable, or
+            included gems that inject methods into these or Mongoid internals."
+        hash_keys_only:
+          message: "You can only search by defined hash_keys"
+          summary: 'Only searches which use a hash key are permitted.
+             Queries that do not use a hash key are highly inefficient and not
+             advisable in production use.'
+          resolution: 'Document and analyse your access patterns and amend your document
+             model accordingly.'
+        invalid_field_option:
+          message: "Invalid option :%{option} provided for field :%{name}."
+          summary: "Mongoid requires that you only provide valid options on each
+            field definition in order to prevent unexpected behaviour later on."
+          resolution: "When defining the field :%{name} on '%{klass}', please provide
+            valid options for the field. These are currently: %{valid}. If you
+            meant to define a custom field option, please do so first like so:\n\n
+            \_\_Mongoid::Fields.option :%{option} do |model, field, value|\n
+            \_\_\_\_# Your logic here...\n
+            \_\_end\n
+            \_\_class %{klass}\n
+            \_\_\_\_include Mongoid::Document\n
+            \_\_\_\_field :%{name}, %{option}: true\n
+            \_\_end\n\n"
+        invalid_index:
+          message: "Invalid index specification on %{klass}: %{spec}, %{options}"
+          summary: "Indexes in Mongoid are defined as a hash of field name and
+            direction/2d pairs, with a hash for any additional options."
+          resolution: "Ensure that the index conforms to the correct syntax and
+            has the correct options.\n\n
+            Valid options are:\n
+            \_\_background: true|false\n
+            \_\_database: 'database_name'\n
+            \_\_drop_dups: true|false\n
+            \_\_name: 'index_name'\n
+            \_\_sparse: true|false\n
+            \_\_unique: true|false\n
+            \_\_min: 1\n
+            \_\_max: 1\n
+            \_\_bits: 26\n
+            \_\_bucket_size : 1\n
+            \_\_weights: { content: 1, title: 2 }\n
+            \_\_expire_after_seconds: number_of_seconds\n
+            Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack', 'text', 'hashed'\n\n
+            Example:\n
+            \_\_class Band\n
+            \_\_\_\_include Mongoid::Document\n
+            \_\_\_\_index({ name: 1, label: -1 }, { sparse: true })\n
+            \_\_\_\_index({ location: '2d' }, { background: true })\n
+            \_\_end\n\n"
+        invalid_options:
+          message: "Invalid option :%{invalid} provided to relation :%{name}."
+          summary: "Mongoid checks the options that are passed to the relation
+            macros to ensure that no ill side effects occur by letting something
+            slip by."
+          resolution: "Valid options are: %{valid}, make sure these are the ones
+            you are using."
+        invalid_time:
+          message: "'%{value}' is not a valid Time."
+          summary: "Mongoid tries to serialize the values for Date, DateTime, and
+            Time into proper UTC times to store in the database. The provided
+            value could not be parsed."
+          resolution: "Make sure to pass parsable values to the field setter
+            for Date, DateTime, and Time objects. When this is a String it needs
+            to be valid for Time.parse. Other objects must be valid to pass to
+            Time.local."
+        invalid_value:
+          message: "Value of type %{value_class} cannot be written to a field of type %{field_class}"
+          summary: "Tried to set a value of type %{value_class} to a field of type %{field_class}"
+          resolution: "Verify if the value to be set correspond to field definition"
+        no_environment:
+          message: "Could not load the configuration since no environment
+            was defined."
+          summary: "Mongoid attempted to find the appropriate environment
+            but no Rails.env, Sinatra::Base.environment, RACK_ENV, or
+            MONGOID_ENV could be found."
+          resolution: "Make sure some environment is set from the mentioned
+            options. Mongoid cannot load configuration from the yaml without
+            knowing which environment it is in, and we have considered
+            defaulting to development an undesireable side effect of this not
+            being defined."
+        readonly_attribute:
+          message: "Attempted to set the readonly attribute '%{name}' with
+            the value: %{value}."
+          summary: "Attributes flagged as readonly via Model.attr_readonly
+            can only have values set when the document is a new record."
+          resolution: "Don't define '%{name}' as readonly, or do not attempt
+            to update its value after the document is persisted."
+        readonly_document:
+          message: "Attempted to persist the readonly document '%{klass}'."
+          summary: "Documents loaded from the database using #only
+            cannot be persisted."
+          resolution: "Don't attempt to persist documents that are flagged as
+            readonly."
+        taken:
+          "is already taken"
+        unknown_attribute:
+          message: "Attempted to set a value for '%{name}' which you did not
+            define on the model %{klass}."
+          summary: "Setting Attributes without first specifying is not permitted.
+            This is also triggered by passing the attribute to any method that
+            accepts an attributes hash, and is raised instead of getting a NoMethodError."
+          resolution: "Review your access pattern and your document structure,
+            and either add a field, store the attribute in a nested structure or
+            add a range key, if you need to use this attribute to retrieve this
+             type of document."
+        unsaved_document:
+          message: "Attempted to save %{document} before the parent %{base}."
+          summary: "You cannot call create or create! through the
+            relation (%{document}) who's parent (%{base}) is
+            not already saved. This would case the database to be out of sync
+            since the child could potentially reference a nonexistant parent."
+          resolution: "Make sure to only use create or create! when the parent
+            document %{base} is persisted."
+        validations:
+          message: "Validation of %{document} failed."
+          summary: "The following errors were found: %{errors}"
+          resolution: "Try persisting the document with valid data or remove
+            the validations."
+        delete_restriction:
+          message: "Cannot delete %{document} because of dependent '%{relation}'."
+          summary: "When defining '%{relation}' with a :dependent => :restrict,
+            Mongoid will raise an error when attempting to delete the
+            %{document} when the child '%{relation}' still has documents in it."
+          resolution: "Don't attempt to delete the parent %{document} when
+            it has children, or change the dependent option on the relation."