s3_index 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4f63000b5995db2c888de5d831f9093a23c649c
+  data.tar.gz: 8b39ba99f902b526f4522b0c4a23a2e16178bbea
+SHA512:
+  metadata.gz: ea451266427f5991cedae6aef52c9f7c221d60943b813076557df7a18915be18f88bfc33bda2620e20366bd775b4deaaeaf27ba5e8394896c2eb4fa3c356feb3
+  data.tar.gz: c3f659f71fdbf93e7bba0609e12a995e6a384865e5d4ffbba97fe55d1ca7e8a21c293cf95059df23ed0ee3e9db5132c4171709a670bead751206145cd39bd928

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+dev.db*
+test.db*
+log/*
+spec/dummy.txt
+.rubocop.yml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3_index.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Pierce
+
+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 @@
+# S3Index
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/s3_index`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_index'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_index
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/s3_index.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "s3_index"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

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

data/config/database.yml

@@ -0,0 +1,7 @@
+development:
+  adapter: sqlite3
+  database: dev.db
+
+test:
+  adapter: sqlite3
+  database: test.db

data/db/migrate/20161109000001_init_s3_index.rb

@@ -0,0 +1,15 @@
+# Create index table
+class InitS3Index < ActiveRecord::Migration
+  def change
+    create_table :s3_index, force: true do |t|
+      t.string :origin_url,   index: true
+      t.string :file_name,    index: true
+      t.string :content_type, index: true
+      t.string :md5,          index: true
+      t.integer :size
+      t.string :s3_url, index: true, unique: true
+      t.string :s3_bucket
+      t.timestamps null: false
+    end
+  end
+end

data/db/schema.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20161109000001) do
+
+  create_table "s3_index", force: :cascade do |t|
+    t.string   "origin_url"
+    t.string   "file_name"
+    t.string   "content_type"
+    t.string   "md5"
+    t.integer  "size"
+    t.string   "s3_url"
+    t.string   "s3_bucket"
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+
+  add_index "s3_index", ["content_type"], name: "index_s3_index_on_content_type"
+  add_index "s3_index", ["file_name"], name: "index_s3_index_on_file_name"
+  add_index "s3_index", ["md5"], name: "index_s3_index_on_md5"
+  add_index "s3_index", ["origin_url"], name: "index_s3_index_on_origin_url"
+  add_index "s3_index", ["s3_url"], name: "index_s3_index_on_s3_url"
+
+end

data/lib/environment.rb

@@ -0,0 +1,15 @@
+# Set up default ENV values
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['S3_INDEX_ENV'] ||= ENV['RAILS_ENV'] || 'development'
+
+# Bundler stuff
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, ENV['S3_INDEX_ENV'])
+
+require 'active_record'
+require 'active_support/all'
+require 'aws-sdk'
+require 'mime-types'
+
+ActiveRecord::Base.raise_in_transactional_callbacks = true

data/lib/s3_index/index.rb

@@ -0,0 +1,12 @@
+module S3Index
+  # Model containing S3 file metadata.
+  # All files uploaded by `S3Index.upload!` will be registered
+  # here for easy querying.
+  class Index < ActiveRecord::Base
+    self.table_name = 's3_index'
+
+    def download!(**args)
+      ::S3Index.download!(index: self, **args)
+    end
+  end
+end

data/lib/s3_index/version.rb

@@ -0,0 +1,3 @@
+module S3Index
+  VERSION = "0.1.0"
+end

data/lib/s3_index.rb

@@ -0,0 +1,103 @@
+require 's3_index/version'
+require_relative '../lib/environment'
+
+# Namespaces
+module S3Index
+  extend ActiveSupport::Autoload
+
+  autoload :Index
+
+  module_function
+
+  def env
+    @env ||= ActiveSupport::StringInquirer.new(ENV['S3_INDEX_ENV'])
+  end
+
+  # Use like `Rails.root`
+  # @return [Pathname]
+  def root
+    @root ||= Pathname(File.expand_path('../..', __FILE__))
+  end
+
+  def logger
+    @logger ||= ActiveRecord::Base.logger
+  end
+
+  def logger=(logger)
+    @logger = logger
+  end
+
+  # Upload file to s3 bucket and register it to the Index model.
+  def upload!(s3: default_client, bucket:, src:, dst: src)
+    obj = s3.bucket(bucket).object(dst)
+
+    index = index_for_src(src)
+    index_attrs = index_attributes_for(src)
+
+    # nothing to do, file is registered and the same as before
+    return index if index.md5 == index_attrs[:md5]
+
+    # try to get the data to s3 first, then save in index.
+    # order is important, we don't want to make the row until
+    # S3 gets the file.
+    obj.upload_file(
+      src,
+      content_type: index_attrs[:content_type],
+      content_length: index_attrs[:size]
+    )
+
+    index.s3_url = obj.public_url
+    index.s3_bucket = obj.bucket_name
+    index.update!(index_attrs)
+    index
+  end
+
+  # Download file from s3 bucket back on Index model.
+  # src and s3_url are quick options to find an Index model to download.
+  def download!(s3: default_client, src: nil, s3_url: nil, index: nil, dst: nil)
+    src || s3_url || index ||
+      raise(ArgumentError, 'src:, s3_url:, or index: must be provided!')
+
+    index ||=
+      begin
+        finder = src ? { origin_url: src } : { s3_url: s3_url }
+        Index.find_by(finder) || raise(ActiveRecord::RecordNotFound, "S3Index::Index not found by #{finder}")
+      end
+
+    obj = s3.bucket(index.s3_bucket).object(index.origin_url)
+    obj.get(response_target: dst || index.origin_url)
+  end
+
+  def index_for_src(src)
+    Index.where(origin_url: src).first_or_initialize
+  end
+
+  def index_attributes_for(path)
+    {
+      md5: Digest::MD5.file(path).to_s,
+      file_name: File.basename(path),
+      content_type: MIME::Types.type_for(path).first.try(:content_type),
+      size: File.size(path)
+    }
+  end
+
+  def default_client
+    @s3_client ||= new_client
+  end
+
+  def new_client
+    credentials = Aws::SharedCredentials.new(profile_name: 'default')
+    client = Aws::S3::Client.new(
+      credentials: credentials,
+      http_wire_trace: $DEBUG,
+      logger: logger
+    )
+    Aws::S3::Resource.new(client: client)
+  end
+
+  def default_client=(client)
+    @s3_client = client
+  end
+end
+
+S3Index.eager_load!

data/lib/tasks/db.rake

@@ -0,0 +1,27 @@
+require 's3_index'
+
+# Load tasks from ActiveRecord
+spec = Gem::Specification.find_by_name 'activerecord'
+load "#{spec.gem_dir}/lib/active_record/railties/databases.rake"
+
+class SeedLoader
+  def load_seed
+    load 'db/seeds.rb'
+  end
+end
+
+# @see //gems/activerecord-4.2.5/lib/active_record/tasks/database_tasks.rb
+include ActiveRecord::Tasks
+db_config = YAML.load(ERB.new(File.read('config/database.yml')).result)
+
+DatabaseTasks.database_configuration = db_config
+DatabaseTasks.env = S3Index.env
+DatabaseTasks.db_dir = 'db'
+DatabaseTasks.migrations_paths = ['db/migrate']
+DatabaseTasks.root = Dir.pwd
+DatabaseTasks.seed_loader = SeedLoader.new
+
+task :environment do
+  ActiveRecord::Base.establish_connection(db_config[S3Index.env])
+  ActiveRecord::Base.logger = Logger.new(S3Index.root.join('log', "#{S3Index.env}.log"))
+end

data/s3_index.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_index/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 's3_index'
+  spec.version       = S3Index::VERSION
+  spec.authors       = ['Scott Pierce']
+  spec.email         = ['ddrscott@gmail.com']
+
+  spec.summary       = 'Maintain an index of s3 files in the database.'
+  spec.homepage      = 'https://ddrscott.github.com/s3_index'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'mime-types'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: s3_index
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Pierce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 
+email:
+- ddrscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/database.yml
+- db/migrate/20161109000001_init_s3_index.rb
+- db/schema.rb
+- lib/environment.rb
+- lib/s3_index.rb
+- lib/s3_index/index.rb
+- lib/s3_index/version.rb
+- lib/tasks/db.rake
+- s3_index.gemspec
+homepage: https://ddrscott.github.com/s3_index
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Maintain an index of s3 files in the database.
+test_files: []