has_s3_attachment 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf3fce12bdcf3867528e6c4d5ac62bdd62032623
+  data.tar.gz: 66a1e9b3a64c0e0e5a79cc8325e1ffe8c8a6f643
+SHA512:
+  metadata.gz: 05ff359f71fcf101cf8208d06c5c3a35411d57cef0023cc5b13166be1851cd6680b78bad49d03bb7c078ec0bfe08532fb277a1381a1f7f70e1e1b0ce6c480529
+  data.tar.gz: 2b44b7dfa30cee2ad77eea7fd27951d9f877bfe4c9e30d0f0a76510cb9442ab03e0d274ef08762761ffe787c06022ab178624d46d4e489f3f741f8a4d7fd8c50

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,92 @@
+# HasS3Attachment
+
+A simple gem, which manages Rails model file attachments hosted on *aws s3*.
+
+## Usage
+Typical use case is when you have single paged web app backed by Rails app,
+and you upload your attachments right from the browser to **s3** via `CORS` -
+as a result you have only location of your file on **s3**. Then you may wanna link this attachment to some model in your app:
+
+```ruby
+class VideoReport < ActiveRecord::Base
+  include HasS3Attachment
+
+  has_s3_attachment(
+    :video,
+      s3_options: {
+        region: 'us-west-2',
+        key: 'key-xxx',
+        secret: 'secret-xxx'
+      },
+      host_alias: 'cdn-example.com'
+  )
+end
+```
+To get it working you must have `s3_bucket_paths` attr of type `string` declared on your model.
+Set **s3** location on an instance of your model as following (to associate your model with attachment):
+```ruby
+video_report.video_s3_bucket = 'your_bucket'
+video_report.video_s3_path = '/path/to/file.mp4'
+```
+Then you'll be able to to call the next methods:
+```ruby
+video_report.video_url # returns full attachment url
+video_report.delete_video # removes attachment from s3, may be used in conjunction with `before_destroy` ActiveRecord callback
+video_report.open_video do |f|
+  # f is an input stream of your attachment
+end
+```
+## Multiple attachments, one model
+You can add multiple attachments to your model like this:
+```ruby
+class User < ActiveRecord::Base
+  has_s3_attachment(
+    :photo,
+    s3_options: {
+      region: 'us-west-2',
+      key: 'key-xxx',
+      secret: 'secret-xxx'
+    },
+    host_alias: 'cdn-example.com'
+  )
+
+  has_s3_attachment(
+    :document,
+    s3_options: {
+      region: 'us-west-1',
+      key: 'key-xxx1',
+      secret: 'secret-xxx'
+    }
+  )
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_s3_attachment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_s3_attachment
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/pavloo/has_s3_attachment/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_s3_attachment"
+
+# 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
+
+require "irb"
+IRB.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/has_s3_attachment.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_s3_attachment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_s3_attachment"
+  spec.version       = HasS3Attachment::VERSION
+  spec.authors       = ["Pavlo Osadchyi"]
+  spec.email         = ["posadchiy@gmail.com"]
+
+  spec.summary       = %q{Gently wraps you s3 resource urls into ActiveModel::Record}
+  spec.description   = %q{Gently wraps you s3 resource urls into ActiveModel::Record}
+  spec.homepage      = "http://github.com/pavloo/has_s3_attachment"
+
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "webmock", "~> 1.21.0"
+
+  spec.add_runtime_dependency "aws-sdk", "~> 2"
+end

data/lib/has_s3_attachment/version.rb

@@ -0,0 +1,3 @@
+module HasS3Attachment
+  VERSION = "0.1.1"
+end

data/lib/has_s3_attachment.rb

@@ -0,0 +1,131 @@
+require "has_s3_attachment/version"
+require "aws-sdk"
+require "open-uri"
+require "json"
+
+module HasS3Attachment
+
+  module ClassMethods
+    def has_s3_attachment(attachment_name, options)
+      @attachment_name = attachment_name
+      set_s3_options(attachment_name, options[:s3_options])
+      host_alias = options[:host_alias]
+
+      define_method("#{attachment_name}_url".to_sym) do |*args|
+        s3_bucket = send :"#{attachment_name}_s3_bucket"
+        s3_path = send :"#{attachment_name}_s3_path"
+        host = send :"#{attachment_name}_host_alias"
+        host_alias = host || host_alias
+        if host_alias
+          ssl = args[0] && args[0].key?(:ssl) ? args[0][:ssl] : true
+          url_str = URI::HTTP.build(
+            host: host_alias,
+            path: s3_path
+          ).to_s
+
+          url_str.gsub!(/http/, 'https') if ssl
+
+          url_str
+        else
+          @s3[attachment_name].bucket(s3_bucket).object(s3_path[1..-1]).public_url if s3_path && s3_bucket
+        end
+      end
+
+
+      define_method("delete_#{attachment_name}".to_sym) do
+        s3_bucket = send :"#{attachment_name}_s3_bucket"
+        s3_path = send :"#{attachment_name}_s3_path"
+        @s3[attachment_name].bucket(s3_bucket).object(s3_path[1..-1]).delete
+      end
+
+      define_method(:"open_#{attachment_name}") do |&block|
+        url = send :"#{attachment_name}_url"
+        open(url) do |f|
+          block.call f
+        end
+      end
+
+      define_method(:"#{attachment_name}_s3_bucket=") do |bucket|
+        set_s3_paths(attachment_name, :bucket, bucket)
+      end
+
+      define_method(:"#{attachment_name}_host_alias=") do |host_alias|
+        set_s3_paths(attachment_name, :host_alias, host_alias)
+      end
+
+      define_method(:"#{attachment_name}_s3_path=") do |path|
+        fail 's3_path must be absolute and start with "/"' unless path.start_with?('/')
+        set_s3_paths(attachment_name, :path, path)
+      end
+
+      define_method(:"#{attachment_name}_s3_bucket") do
+        get_s3_paths(attachment_name, :bucket)
+      end
+
+      define_method(:"#{attachment_name}_s3_path") do
+        get_s3_paths(attachment_name, :path)
+      end
+
+      define_method(:"#{attachment_name}_host_alias") do
+        get_s3_paths(attachment_name, :host_alias)
+      end
+    end
+
+    def set_s3_options(attachment_name, options)
+      @s3_options = {} unless @s3_options
+      @s3_options[attachment_name] = options
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+    class << base
+      attr_reader :s3_options, :host_alias, :attachment_name
+    end
+
+    base.after_find :init if base.respond_to?(:after_find)
+  end
+
+  def initialize(*args)
+    super
+    init
+  end
+
+  private
+
+  def set_s3_paths(name, type, value)
+    begin
+      hash = s3_bucket_paths ? JSON.parse(s3_bucket_paths) : Hash.new
+    rescue NameError => e
+      raise NameError, 'You must create model attribute "s3_bucket_paths" of type string in order to make has_s3_attachment work'
+    end
+    hash["#{name}"] = {} unless hash.key? "#{name}"
+    hash["#{name}"][type.to_s] = value
+    self.s3_bucket_paths = JSON.generate(hash)
+  end
+
+  def get_s3_paths(name, type)
+    begin
+      hash = s3_bucket_paths ? JSON.parse(s3_bucket_paths) : Hash.new
+    rescue NameError => e
+      raise NameError, 'You must create model attribute "s3_bucket_paths" of type string in order to make has_s3_attachment work'
+    end
+    hash["#{name}"][type.to_s] if hash.key? "#{name}"
+  end
+
+  def init
+    s3_options = self.class.s3_options
+    @s3 = {}
+    s3_options.keys.each do |name|
+      options = s3_options[name]
+      if options
+        @s3[name] = Aws::S3::Resource.new(
+          region: options[:region],
+          credentials: Aws::Credentials.new(options[:key], options[:secret])
+        )
+      else
+        @s3[name] = Aws::S3::Client.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: has_s3_attachment
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Pavlo Osadchyi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Gently wraps you s3 resource urls into ActiveModel::Record
+email:
+- posadchiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_s3_attachment.gemspec
+- lib/has_s3_attachment.rb
+- lib/has_s3_attachment/version.rb
+homepage: http://github.com/pavloo/has_s3_attachment
+licenses: []
+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: Gently wraps you s3 resource urls into ActiveModel::Record
+test_files: []