rollout-dynamodb 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fec540bc701467a7e30414f581699009230e0185
+  data.tar.gz: 28dff4465caca5250270c6216cc104de4efa8312
+SHA512:
+  metadata.gz: e8b2c4128eb2c427ec632c90219d4fa5d86f8fd9c828196e27b3aeec9315a0d01d0c0d2dcb331c5d2b95db420bd7a2d95337311eaa37033e6f9f94816592d21d
+  data.tar.gz: 380f702669187f9dd65bd83e71baf2583b256aafc7cc7cf1f8dd78d4a4b1535705f4b81ee3c48932d7d1fc29a617ce79c7b0907a59e99a22a5f7d452c3a215a1

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+bin/test*
+.env
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby "2.1.3"
+# Specify your gem's dependencies in rollout-dynamo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Charles Hooper <charles@heroku.com>
+
+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,50 @@
+# DynamoDB storage adapter for Rollout
+
+This is a storage adapter for
+[Rollout](https://github.com/FetLife/rollout) that uses DynamoDB.
+Rollout allows you to flip feature flags around in a sane way.
+
+I wrote this adapter for those who either don't want to stand up a new
+redis instance or introduce a new single point of failure into their
+architecture.
+
+[![Build Status](https://travis-ci.org/chooper/rollout-dynamodb.svg?branch=master)](https://travis-ci.org/chooper/rollout-dynamodb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rollout-dynamodb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rollout-dynamodb
+
+## Usage
+
+```ruby
+$storage = Rollout::DynamoDB::Storage.new(aws_access_key, aws_secret_key, aws_table_name, aws_region)
+$rollout = Rollout.new($storage)
+
+$rollout.active?(:chat)
+# -> false
+$rollout.activate(:chat)
+# -> {}
+$rollout.active?(:chat)
+# -> true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/chooper/rollout-dynamodb/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,92 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  #head, manifest, tail = spec,split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(spec, :name)
+  replace_header(spec, :version)
+  replace_header(spec, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(spec, :rubyforge_project)
+
+  # piece file back together and write
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  prefix = name[/^([^-]*)/, 1]
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/#{prefix}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end
+

data/lib/rollout/dynamodb/storage.rb

@@ -0,0 +1,51 @@
+
+require 'fog'
+
+module Rollout::DynamoDB
+  class Storage
+    def initialize(aws_access_key, aws_secret_key, table_name, region, options = {})
+      @aws_access_key   = aws_access_key
+      @aws_secret_key   = aws_secret_key
+      @table_name       = table_name
+      @region           = region
+      @options          = options
+
+      # timeouts are expressed in seconds
+      @options[:connection_options] ||= {}
+      @options[:connection_options][:connect_timeout] ||= 3
+      @options[:connection_options][:read_timeout]    ||= 3
+      @options[:connection_options][:write_timeout]   ||= 3
+      @options[:connection_options][:retry_limit]     ||= 4
+    end
+
+    def get(key)
+      response = db.get_item(@table_name, {'HashKeyElement' => {'S' => key}})
+      get_item_from_body(response.body)
+    end
+
+    def set(key, value)
+      response = db.put_item(@table_name, {'id' => {'S' => key}, 'value' => {'S' => value}})
+      true
+    end
+
+    def del(key)
+      response = db.delete_item(@table_name, {'HashKeyElement' => {'S' => key}})
+      true
+    end
+
+    private
+
+    def db
+      @db ||= Fog::AWS::DynamoDB.new(
+        @options.merge(
+          :aws_access_key_id => @aws_access_key,
+          :aws_secret_access_key => @aws_secret_key,
+          :region => @region))
+    end
+
+    def get_item_from_body(body)
+      body.fetch('Item', {}).fetch('value', {}).fetch('S', nil)
+    end
+  end
+end
+

data/lib/rollout-dynamodb.rb

@@ -0,0 +1,5 @@
+class Rollout
+  module DynamoDB
+    VERSION = "0.0.3"
+  end
+end

data/rollout-dynamodb.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/rollout-dynamodb.rb"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rollout-dynamodb"
+  spec.version       = Rollout::DynamoDB::VERSION
+  spec.authors       = ["Charles Hooper"]
+  spec.email         = ["charles@heroku.com"]
+  spec.summary       = "DynamoDB storage adapter for Rollout"
+  spec.description   = "DynamoDB storage adapter for Rollout"
+  spec.homepage      = "https://github.com/chooper/rollout-dynamodb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "foreman", "~> 0.77"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_dependency 'rollout', "~> 2.0"
+  spec.add_dependency "fog", "~> 1.28"
+end

data/spec/dynamodb_spec.rb

@@ -0,0 +1,89 @@
+#require "rollout/storage/dynamodb"
+require "spec_helper"
+
+describe Rollout::DynamoDB do
+  before do
+    @storage = Rollout::DynamoDB::Storage.new("access-key", "secret-key", "table", "us-east-99")
+    @dynamo_url = "https://dynamodb.us-east-99.amazonaws.com/"
+  end
+
+  describe "#initialize" do
+    it "sets default options" do
+      defaults = {
+        :connection_options => {
+          :connect_timeout  => 3,
+          :read_timeout     => 3,
+          :write_timeout    => 3,
+          :retry_limit      => 4}}
+
+      assert_equal @storage.instance_variable_get(:@options), defaults
+    end
+
+    it "sets AWS/DynamoDB instance variables" do
+      assert_equal @storage.instance_variable_get(:@aws_access_key), "access-key"
+      assert_equal @storage.instance_variable_get(:@aws_secret_key), "secret-key"
+      assert_equal @storage.instance_variable_get(:@table_name),     "table"
+      assert_equal @storage.instance_variable_get(:@region),         "us-east-99"
+    end
+  end
+
+  describe "#get" do
+    it "sends a valid post and returns valid data when key exists" do
+      stub_request(:post, @dynamo_url).
+        to_return(:body => "{\"ConsumedCapacityUnits\":0.5,\"Item\":{\"value\":{\"S\":\"my-value\"},\"id\":{\"S\":\"my-key\"}}}")
+
+      value = @storage.get("my-key")
+      assert_requested(:post, @dynamo_url) do |req|
+        body = MultiJson.decode(req.body)
+        body == {"Key"=>{"HashKeyElement"=>{"S"=>"my-key"}}, "TableName"=>"table"} &&
+          req.headers["X-Amz-Target"] == "DynamoDB_20111205.GetItem"
+      end
+      assert_equal value, "my-value"
+    end
+
+    it "returns valid data when key does not exist" do
+      stub_request(:post, @dynamo_url).
+        to_return(:body => "{\"ConsumedCapacityUnits\":0.5}")
+
+      response = @storage.get("my-nonexistent-key")
+      assert_requested(:post, @dynamo_url) do |req|
+        body = MultiJson.decode(req.body)
+        body == {"Key"=>{"HashKeyElement"=>{"S"=>"my-nonexistent-key"}}, "TableName"=>"table"} &&
+          req.headers["X-Amz-Target"] == "DynamoDB_20111205.GetItem"
+      end
+      assert_nil response
+    end
+  end
+
+  describe "#set" do
+    it "sends a valid post when called" do
+      stub_request(:post, @dynamo_url).
+        to_return(:body => "{\"Key\":{\"HashKeyElement\":{\"S\":\"my-key\"}},\"TableName\":\"table\"}")
+
+      response = @storage.set("my-key", "my-value")
+      assert_requested(:post, @dynamo_url) do |req|
+        body = MultiJson.decode(req.body)
+        body == {"Item"=>{"id"=>{"S"=>"my-key"}, "value"=>{"S"=>"my-value"}}, "TableName"=>"table"} &&
+          req.headers["X-Amz-Target"] == "DynamoDB_20120810.PutItem"
+      end
+      assert response
+    end
+  end
+
+  describe "#del" do
+    it "sends a valid post when called" do
+      stub_request(:post, @dynamo_url).
+        to_return(:body => "{\"ConsumedCapacityUnits\":1.0}")
+
+      response = @storage.del("my-key")
+      assert_requested(:post, @dynamo_url) do |req|
+        body = MultiJson.decode(req.body)
+        body == {"Key"=>{"HashKeyElement"=>{"S"=>"my-key"}}, "TableName"=>"table"} &&
+          req.headers["X-Amz-Target"] == "DynamoDB_20111205.DeleteItem"
+      end
+      assert response
+    end
+  end
+  # ...
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require(:default, :development)
+
+require "webmock/rspec"
+
+require "rollout/dynamodb/storage"
+
+RSpec.configure do |config|
+  config.expect_with :test_unit
+end

data/spec/version_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Rollout::DynamoDB do
+  it "has a VERSION constant set to a string" do
+    Rollout::DynamoDB::VERSION.is_a?(String)
+  end
+end
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rollout-dynamodb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Charles Hooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !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: foreman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rollout
+  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: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+description: DynamoDB storage adapter for Rollout
+email:
+- charles@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rollout-dynamodb.rb
+- lib/rollout/dynamodb/storage.rb
+- rollout-dynamodb.gemspec
+- spec/dynamodb_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+homepage: https://github.com/chooper/rollout-dynamodb
+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: DynamoDB storage adapter for Rollout
+test_files:
+- spec/dynamodb_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb