aws-sessionstore-dynamodb 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e7fc34007a54a256d5ef9749bc952dcbbb9d8c1c
-  data.tar.gz: 31a61f733ce42fe5bf852ae6e7ed07e95a27066a
+SHA256:
+  metadata.gz: e17edceb1591e5e714e577d518f8c1f5f9b0b0a9c4edc6e8fbd7b275f63d33d5
+  data.tar.gz: 78cdaebe833c199b3d11a4fa0259d53fb5f770027808c55b8b96fbdece0a8401
 SHA512:
-  metadata.gz: cec7d8e8ab2bf8135ceace7a4f54647744c2b1e88d69ba20ab44dc5f83236af40cd34cb23d1b1ddc942d4ea787d2e4674ff0e3670a1a3580c0f93850060033da
-  data.tar.gz: 66d01279ddc10ed9e821045356692b73ce9de9597f454787e64c53b8ce6d77b361ca3a5f8fed8447b350aa9cf9a1f42df03668dc8938c45b0c5c38843b440de6
+  metadata.gz: 2b69bc3462d6e224f29c58d3ef8077772c8f279b1ec5502e526639c750dddceff3ba350d73c8a7070df63b8e39a0cf46371fdd3ff47407115c137c84baf0a299
+  data.tar.gz: 389006735c32ad4ed30dc1c95fd82bfaefd41b2849435bb8e49ca3b0ac6539d6a84824a5e6ceaf97a5c9e4e3b743407ba6da8f450f65f122401db2c88b798f48

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+*Issue #, if available:*
+
+*Description of changes:*
+
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

data/.gitignore

@@ -2,3 +2,4 @@ doc
 coverage
 .yardoc
 Gemfile.lock
+.release

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tasks/release"]
+	path = tasks/release
+	url = https://github.com/aws/aws-sdk-ruby-release-tools.git

data/.travis.yml

@@ -1,15 +1,26 @@
+branches:
+  only:
+    - master
+
 language: ruby
 
 rvm:
-  - 2.2.2
-  - 2.3.0
-  - 2.4.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby-9.1
+  - jruby-9.2
 
 sudo: false
 
 env:
-  - AWS_REGION=foo
+  - AWS_REGION=us-west-2
 
-script: bundle exec rake
+script: bundle exec rake test:unit
 
 bundler_args: --without docs release repl

data/.yardopts

@@ -1,3 +1,4 @@
---title "Amazon DynamoDB Session Store"
---exclude /generators/
+--title 'AWS DynamoDB Session Store'
+--template-path doc-src/templates
 --hide-api private
+--plugin sitemap

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+2.0.0 (2020-11-11)
+------------------
+
+* Remove Rails support (moved to the `aws-sdk-rails` gem).
+
+* Use V3 of Ruby SDK
+
+* Fix a `dynamo_db.scan()` incompatibility from the V1 -> V2 upgrade in the garbage collector.
+
+1.0.0 (2017-08-14)
+------------------
+
+* Use V2 of Ruby SDK (no history)
+
+
+0.5.1 (2015-08-26)
+------------------
+
+* Bug Fix (no history)
+
+0.5.0 (2013-08-27)
+------------------
+
+* Initial Release (no history)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
+opensource-codeofconduct@amazon.com with any additional questions or comments.

data/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check [existing open](https://github.com/aws/aws-sessionstore-dynamodb-ruby/issues), or [recently closed](https://github.com/aws/aws-sessionstore-dynamodb-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *master* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Fork the repository.
+2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+3. Ensure local tests pass.
+4. Commit to your fork using clear commit messages.
+5. Send us a pull request, answering any default questions in the pull request interface.
+6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-sessionstore-dynamodb-ruby/labels/help%20wanted) issues is a great place to start. 
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+
+
+## Security issue notifications
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](https://github.com/aws/aws-sessionstore-dynamodb-ruby/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

data/Gemfile

@@ -1,28 +1,16 @@
-# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake', require: false
 
-group :documentation do
-  gem 'yard', '~> 0.0'
+group :docs do
+  gem 'yard'
+  gem 'yard-sitemap', '~> 1.0'
 end
 
 group :test do
-  gem 'rspec', '~> 2.0'
-  gem 'simplecov', '~> 0.0', :require => false
-  gem 'rack-test', '~> 0.0'
+  gem 'rspec'
+  gem 'simplecov', require: false
+  gem 'rack-test'
 end

data/README.md

@@ -1,38 +1,12 @@
 # Amazon DynamoDB Session Store
 
 The **Amazon DynamoDB Session Store** handles sessions for Ruby web applications
-using a DynamoDB backend. The session store is compatible with Rails (3.x or 4.x)
-and other Rack based frameworks.
+using a DynamoDB backend. The session store is compatible with all Rack based
+frameworks. For Rails applications, use the [`aws-sdk-rails`][1] gem.
 
 ## Installation
 
-#### Rails Installation
-
-Install the session store gem by placing the following command into your
-Gemfile:
-
-    gem 'aws-sessionstore-dynamodb'
-
-You will need to have an existing Amazon DynamoDB session table in order for the
-application to work. You can generate a migration file for the session table
-with the following command:
-
-    rails generate sessionstore:dynamodb
-
-To create the table, run migrations as normal with:
-
-    rake db:migrate
-
-Change the session store to `:dynamodb_store` by editing
-`config/initializers/session_store.rb` to contain the following:
-
-    YourAppName::Application.config.session_store :dynamodb_store
-
-You can now start your Rails application with session support.
-
-#### Basic Rack Application Installation
-
-For non-Rails applications, you can create the Amazon DynamoDB table in a
+For Rack applications, you can create the Amazon DynamoDB table in a
 Ruby file using the following method:
 
     require 'aws-sessionstore-dynamodb'
@@ -66,18 +40,17 @@ discouraging sensitive data storage. It also forces strict data size
 limitations. DynamoDB takes care of these concerns by allowing for a safe and
 scalable storage container with a much larger data size limit for session data.
 
-Full API documentation of the library can be found on [RubyDoc.info][1].
+For more developer information, see the [Full API documentation][2].
 
 ### Configuration Options
 
 A number of options are available to be set in
 `Aws::SessionStore::DynamoDB::Configuration`, which is used by the
-`RackMiddleware` class. These options can be set in the YAML configuration
-file in a Rails application (located in `config/sessionstore/dynamodb.yml`),
-directly by Ruby code, or through environment variables.
+`RackMiddleware` class. These options can be set directly by Ruby code or
+through environment variables.
 
 The full set of options along with defaults can be found in the
-[Configuration class documentation][2].
+[Configuration class documentation][3].
 
 #### Environment Options
 
@@ -90,36 +63,15 @@ The example below would be a valid way to set the session table name:
 
     export DYNAMO_DB_SESSION_TABLE_NAME='sessions'
 
-### Rails Generator Details
-
-The generator command specified in the installation section will generate two
-files: a migration file, `db/migration/VERSION_migration_name.rb`, and a
-configuration YAML file, `config/sessionstore/dynamodb.yml`.
-
-You can run the command with an argument that will define the name of the
-migration file. Once the YAML file is created, you can uncomment any of the
-lines to set configuration options to your liking. The session store will pull
-options from `config/sessionstore/dynamodb.yml` by default if the file exists.
-If you do not wish to place the configuration YAML file in that location,
-you can also pass in a different file path to pull options from.
-
 ### Garbage Collection
 
-You may want to delete old sessions from your session table. The
-following examples show how to clear old sessions from your table.
-
-#### Rails
-
-A Rake task for garbage collection is provided for Rails applications.
-By default sessions do not expire. See `config/sessionstore/dynamodb.yml` to
-configure the max age or stale period of a session. Once you have configured
-those values you can clear the old sessions with:
-
-    rake dynamo_db:collect_garbage
-
-#### Outside of Rails
+You may want to delete old sessions from your session table. You can use the
+DynamoDB [Time to Live (TTL) feature][4] on the `expire_at` attribute to
+automatically delete expired items.
 
-You can create your own Rake task for garbage collection similar to below:
+If you want to take other attributes into consideration for deletion, you could
+instead use the `GarbageCollection` class. You can create your own Rake task for
+garbage collection similar to below:
 
     require "aws-sessionstore-dynamodb"
 
@@ -167,5 +119,7 @@ the default error handler to them for you. See the API documentation
 on the {Aws::SessionStore::DynamoDB::Errors::BaseHandler} class for more
 details.
 
-[1]: http://rubydoc.org/gems/aws-sessionstore-dynamodb/frames
-[2]: http://rubydoc.org/gems/aws-sessionstore-dynamodb/AWS/SessionStore/DynamoDB/Configuration#initialize-instance_method
+[1]: https://github.com/aws/aws-sdk-rails/
+[2]: https://docs.aws.amazon.com/sdk-for-ruby/aws-sessionstore-dynamodb/api/
+[3]: https://docs.aws.amazon.com/sdk-for-ruby/aws-sessionstore-dynamodb/api/Aws/SessionStore/DynamoDB/Configuration.html
+[4]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html

data/Rakefile

@@ -1,15 +1,38 @@
-# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-Dir.glob(File.dirname(__FILE__) + '/tasks/*.rake').each {|file| load file }
+$REPO_ROOT = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.join($REPO_ROOT, 'lib'))
+$VERSION = ENV['VERSION'] || File.read(File.join($REPO_ROOT, 'VERSION')).strip
+
+require 'rspec/core/rake_task'
+
+Dir.glob('**/*.rake').each do |task_file|
+  load task_file
+end
+
+task 'test:coverage:clear' do
+  sh("rm -rf #{File.join($REPO_ROOT, 'coverage')}")
+end
+
+# Override the test task definitions
+# this package uses rspec tags to define integration tests
+Rake::Task["test:unit"].clear
+desc 'Runs unit tests'
+RSpec::Core::RakeTask.new('test:unit') do |t|
+  t.rspec_opts = "-I #{$REPO_ROOT}/lib -I #{$REPO_ROOT}/spec --tag ~integration"
+  t.pattern = "#{$REPO_ROOT}/spec"
+end
+task 'test:unit' => 'test:coverage:clear'
+
+Rake::Task["test:integration"].clear
+desc 'Runs integration tests'
+RSpec::Core::RakeTask.new('test:integration') do |t|
+  t.rspec_opts = "-I #{$REPO_ROOT}/lib -I #{$REPO_ROOT}/spec --tag integration"
+  t.pattern = "#{$REPO_ROOT}/spec"
+end
+task 'test:integration' => 'test:coverage:clear'
+
+desc 'Runs unit and integration tests'
+task 'test' => ['test:unit', 'test:integration']
+
 task :default => 'test:unit'
+
+

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/aws-sessionstore-dynamodb.gemspec

@@ -1,9 +1,11 @@
-require File.dirname(__FILE__) + '/lib/aws/session_store/dynamo_db/version'
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
 
 Gem::Specification.new do |spec|
   spec.name          = "aws-sessionstore-dynamodb"
-  spec.version       = Aws::SessionStore::DynamoDB::VERSION
-  spec.authors       = ["Ruby Robinson"]
+  spec.version       = version
+  spec.authors       = ["Amazon Web Services"]
+  spec.email         = ["mamuller@amazon.com", "alexwoo@amazon.com"]
+
   spec.summary       = "The Amazon DynamoDB Session Store handles sessions " +
                        "for Ruby web applications using a DynamoDB backend."
   spec.homepage      = "http://github.com/aws/aws-sessionstore-dynamodb-ruby"
@@ -13,6 +15,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'aws-sdk', '~> 2.0'
-  spec.add_dependency 'rack', '>= 1.6.4'
+  spec.add_dependency 'aws-sdk-dynamodb', '~> 1'
+  spec.add_dependency 'rack', '~> 2'
 end

data/doc-src/templates/default/layout/html/footer.erb

@@ -0,0 +1,10 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+  <div id="awsdocs-legal-zone-copyright"></div>
+</div>
+
+<!-- Gitter chat -->
+<script>((window.gitter = {}).chat = {}).options = { room: 'aws/aws-sdk-ruby' };</script>
+<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>

data/doc-src/templates/default/layout/html/layout.erb

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= erb(:headers) %>
+    <!-- Docs Metrics + Cookie Consent Script -->
+    <meta name="guide-name" content="API Reference">
+    <meta name="service-name" content="AWS SDK For Ruby - AWS DynamoDB Session Store">
+    <script type="text/javascript" src="/assets/js/awsdocs-boot.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="<%= @nav_url %>?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <%= erb(:breadcrumb) %>
+        <%= erb(:search) %>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content">
+        <!-- REGION_DISCLAIMER_DO_NOT_REMOVE -->
+        <%= yieldall %>
+      </div>
+
+      <%= erb(:footer) %>
+    </div>
+  </body>
+</html>

data/lib/aws-sessionstore-dynamodb.rb

@@ -1,17 +1,3 @@
-# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-
 module Aws
   module SessionStore
     module DynamoDB; end
@@ -31,4 +17,3 @@ require 'aws/session_store/dynamo_db/locking/pessimistic'
 require 'aws/session_store/dynamo_db/rack_middleware'
 require 'aws/session_store/dynamo_db/table'
 require 'aws/session_store/dynamo_db/version'
-require 'aws/session_store/dynamo_db/railtie' if defined?(Rails)