alephant-storage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eba0e664cd299e269713a3583951e006b67cae4c
+  data.tar.gz: d106ca2ef7faaaf819aa0ed95638f847ccae9450
+SHA512:
+  metadata.gz: 83f1ff920e034f195e8b946e6fbad9ab9c15daa2189f29d2427d22b6faf7bc512954ffaf6a79fca6ad7a09ceeb40a80231ba192485c62de497e2080b6883affe
+  data.tar.gz: 647605f9c7a5e6bd27697f5fe2ef6afa8c6b7dda9d0b1ffbc89f01d6768b9281210bb2d8262a241254a721729b609c26822857d3ed0ad24b376254057a4d345a

data/.gitignore

@@ -0,0 +1,10 @@
+/config/*.yaml
+/config/*.yml
+Gemfile.lock
+.rspec
+*.gem
+
+/pkg
+/tmp
+/components
+

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.17

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "jruby"
+notifications:
+  email:
+    recipients:
+      - DigitalNewsFrameworksTeam@bbc.co.uk
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Kenny
+
+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,42 @@
+# Alephant::Storage
+
+Simple abstraction layer over S3 for get/put.
+
+[![Build
+Status](https://travis-ci.org/BBC-News/alephant-storage.png)](https://travis-ci.org/BBC-News/alephant-storage)
+
+[![Gem Version](https://badge.fury.io/rb/alephant-storage.png)](http://badge.fury.io/rb/alephant-storage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alephant-storage'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-storage
+
+## Usage
+
+```rb
+require 'alephant/storage'
+
+storage = Alephant::Storage.new('bucket_id', 'base/path')
+storage.put('id', "string data")
+storage.get('id')
+
+# => "string data"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/BBC-News/alephant-storage/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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/storage'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alephant-cache.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/storage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-storage"
+  spec.version       = Alephant::Storage::VERSION
+  spec.authors       = ["BBC News"]
+  spec.email         = ["FutureMediaNewsRubyGems@bbc.co.uk"]
+  spec.summary       = "Simple abstraction layer over S3 for get/put."
+  spec.homepage      = "https://github.com/BBC-News/alephant-storage"
+  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 "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
+  spec.add_runtime_dependency 'alephant-logger'
+end

data/lib/alephant/storage.rb

@@ -0,0 +1,74 @@
+require 'alephant/storage/version'
+require 'alephant/logger'
+require 'aws-sdk'
+
+module Alephant
+  class Storage
+    include Logger
+    attr_reader :id, :bucket, :path
+
+    def initialize(id, path)
+      @id = id
+      @path = path
+      @bucket = AWS::S3.new.buckets[id]
+
+      logger.info(
+        "event"  => "StorageInitialized",
+        "id"     => id,
+        "path"   => path,
+        "method" => "#{self.class}#initialize",
+      )
+    end
+
+    def clear
+      bucket.objects.with_prefix(path).delete_all
+      logger.info(
+        "event"  => "StorageCleared",
+        "path"   => path,
+        "method" => "#{self.class}#clear"
+      )
+    end
+
+    def put(id, data, content_type = 'text/plain', meta = {})
+      bucket.objects["#{path}/#{id}"].write(
+        data,
+        {
+          :content_type => content_type,
+          :metadata     => meta
+        }
+      )
+
+      logger.metric "StoragePuts"
+      logger.info(
+        "event"  => "StorageObjectStored",
+        "path"   => path,
+        "id"     => id,
+        "method" => "#{self.class}#put"
+      )
+    end
+
+    def get(id)
+      object       = bucket.objects["#{path}/#{id}"]
+      content      = object.read
+      content_type = object.content_type
+      meta_data    = object.metadata.to_h
+
+      logger.metric "StorageGets"
+      logger.info(
+        "event"       => "StorageObjectRetrieved",
+        "path"        => path,
+        "id"          => id,
+        "content"     => content,
+        "contentType" => content_type,
+        "metadata"    => meta_data,
+        "method"      => "#{self.class}#get"
+      )
+
+      {
+        :content      => content,
+        :content_type => content_type,
+        :meta         => meta_data
+      }
+    end
+  end
+end

data/lib/alephant/storage/version.rb

@@ -0,0 +1,5 @@
+module Alephant
+  class Storage
+    VERSION = "1.0.0"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$: << File.join(File.dirname(__FILE__),"..", "lib")
+
+require 'pry'
+require 'alephant/storage'
+

data/spec/storage_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'pry'
+
+describe Alephant::Storage do
+  let(:id)   { :id }
+  let(:path) { :path }
+  let(:data) { :data }
+  subject { Alephant::Storage }
+
+  describe "initialize(id, path)" do
+    it "sets and exposes id, path instance variables " do
+      instance = subject.new(id, path)
+      expect(instance.id).to eq(id)
+      expect(instance.path).to eq(path)
+    end
+
+    it "sets bucket instance variable as S3 bucket with id" do
+      instance = subject.new(id, path)
+
+      expect(instance.bucket).to be_an AWS::S3::Bucket
+      expect(instance.bucket.name).to eq('id')
+    end
+  end
+
+  describe "clear" do
+    let(:num_object_in_path) { 100 }
+    it "deletes all objects for a path" do
+      filtered_object_collection = double()
+      expect(filtered_object_collection)
+        .to receive(:delete_all)
+
+      s3_object_collection = double()
+      expect(s3_object_collection)
+        .to receive(:with_prefix)
+        .with(path)
+        .and_return(filtered_object_collection)
+
+      s3_bucket = double()
+      expect(s3_bucket).to receive(:objects).and_return(s3_object_collection)
+
+      expect_any_instance_of(AWS::S3).to receive(:buckets).and_return({ id => s3_bucket })
+
+      instance = subject.new(id, path)
+      instance.clear
+    end
+  end
+
+  describe "put(id, data)" do
+    it "sets bucket path/id content data" do
+      s3_object_collection = double()
+      expect(s3_object_collection).to receive(:write).with(:data, { :content_type => 'foo/bar', :metadata=>{} })
+
+      s3_bucket = double()
+      expect(s3_bucket).to receive(:objects).and_return(
+        {
+          "path/id" => s3_object_collection
+        }
+      )
+
+      expect_any_instance_of(AWS::S3).to receive(:buckets).and_return({ id => s3_bucket })
+      instance = subject.new(id, path)
+
+      instance.put(id, data, 'foo/bar')
+    end
+  end
+
+  describe "get(id)" do
+    it "gets bucket path/id content data" do
+      s3_object_collection = double()
+      expect(s3_object_collection).to receive(:read).and_return("content")
+      expect(s3_object_collection).to receive(:content_type).and_return("foo/bar")
+      expect(s3_object_collection).to receive(:metadata).and_return({ :foo => :bar})
+
+      s3_bucket = double()
+      expect(s3_bucket).to receive(:objects).and_return(
+        {
+          "path/id" => s3_object_collection
+        }
+      )
+
+      expect_any_instance_of(AWS::S3).to receive(:buckets).and_return({ id => s3_bucket })
+
+      instance = subject.new(id, path)
+      object_hash = instance.get(id)
+
+      expected_hash = {
+        :content      => "content",
+        :content_type => "foo/bar",
+        :meta         => { :foo => :bar }
+      }
+
+      expect(object_hash).to eq(expected_hash)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: alephant-storage
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BBC News
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec-nc
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: guard
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: guard-rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry-remote
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry-nav
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: aws-sdk
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: alephant-logger
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- FutureMediaNewsRubyGems@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-cache.gemspec
+- lib/alephant/storage.rb
+- lib/alephant/storage/version.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+homepage: https://github.com/BBC-News/alephant-storage
+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.1.9
+signing_key:
+specification_version: 4
+summary: Simple abstraction layer over S3 for get/put.
+test_files:
+- spec/spec_helper.rb
+- spec/storage_spec.rb