letter_opener_web_s3 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc475bf5a48817f23ffb3ee63d8cc9c3fc97d3dd
+  data.tar.gz: cc61d16ae357d63304c91489a74d8382bc27d5ee
+SHA512:
+  metadata.gz: fa662c854c7dbf3a32586ad324ebabc4f2190eb4a89baccb080b18313002886dce85850d873f8622755ebc99e7ffe15fe9e7f339763f3695bb8b7f0410d2c0e2
+  data.tar.gz: 8fad276e7d5cd4ff8453ccad4b57bee647905e20d5f467f69ccedee6d955e637865e1a6c5b59dfc5087710fc9b4ea4469c5a4ba3049834b18f2b154e875eab12

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-gemset
+.ruby-version
+
+.idea
+
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vital.ryabchinskiy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vital Ryabchinskiy
+
+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,49 @@
+# LetterOpenerWebS3
+
+Addon for `letter_opener_web` and `letter_opener` gems to store files on Amazon S3 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'letter_opener_web_s3'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install letter_opener_web_s3
+
+## Usage
+
+Configure AWS credentials and domain to rails app assets
+
+```ruby
+LetterOpenerWebS3.configure do |spec|
+  spec.s3_config = {
+      region: AWS_S3_REGION,
+      bucket_name: AWS_S3_BUCKET,
+      access_key_id: AWS_S3_KEY_ID,
+      secret_access_key: AWS_S3_ACCESS_KEY
+  }
+  spec.domain = APP_DOMAIN
+end
+```
+
+## TODO
+
+Need check letters with attachments 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/letter_opener_web_s3. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "letter_opener_web_s3"
+
+# 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(__FILE__)

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/letter_opener_web_s3.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'letter_opener_web_s3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "letter_opener_web_s3"
+  spec.version       = LetterOpenerWebS3::VERSION
+  spec.authors       = ["Vital Ryabchinskiy"]
+  spec.email         = ["vital.ryabchinskiy@gmail.com"]
+
+
+  spec.description   = "Gives letter_opener and letter_opener_web work with S3"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/vitalinfo/letter_opener_web_s3"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails", '~> 3.5'
+  spec.add_development_dependency "sqlite3", '~> 1.3'
+  spec.add_development_dependency "rails", "~> 4.0"
+  spec.add_dependency "letter_opener_web", "~> 1.3"
+  spec.add_dependency "aws-sdk", "~> 2"
+end

data/lib/letter_opener_web_s3/letter_extension.rb

@@ -0,0 +1,59 @@
+module LetterOpenerWebS3::LetterExtension
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_accessor :letters_location do
+      "#{%w(tmp letter_opener).join('/')}/"
+    end
+
+    class << self
+      def search
+        letters = LetterOpenerWebS3.bucket.client.list_objects(bucket: LetterOpenerWebS3.bucket.name,
+                                                               delimiter: '/',
+                                                               prefix: letters_location)
+            .common_prefixes.map(&:prefix).map do |folder|
+          name = folder.gsub(letters_location, '')[0..-2]
+          new id: name, sent_at: Time.at(name.gsub(/\_.+/, '').to_i)
+        end
+        letters.sort_by(&:sent_at).reverse
+      end
+
+      def destroy_all
+        LetterOpenerWebS3.bucket.objects(prefix: letters_location).each(&:delete)
+      end
+    end
+
+    def attachments
+      @attachments ||= LetterOpenerWebS3.bucket.objects(prefix: File.join(base_dir, 'attachments'))
+                           .each_with_object({}) do |file, hash|
+        hash[File.basename(file)] = File.expand_path(file)
+      end
+    end
+
+    def delete
+      LetterOpenerWebS3.bucket.objects(prefix: base_dir).each(&:delete)
+    end
+
+    def exists?
+      LetterOpenerWebS3.bucket.objects(prefix: base_dir).count > 0
+    end
+
+    private
+
+    def base_dir
+      "#{letters_location}#{id}"
+    end
+
+    def read_file(style)
+      Kernel.open(LetterOpenerWebS3.bucket
+                      .object(File.join(base_dir, "#{style}.html")).presigned_url(:get)).read
+    rescue
+      ''
+    end
+
+    def style_exists?(style)
+      LetterOpenerWebS3.bucket.object(File.join(base_dir, "#{style}.html")).exists?
+    end
+
+  end
+end

data/lib/letter_opener_web_s3/message_extension.rb

@@ -0,0 +1,55 @@
+module LetterOpenerWebS3::MessageExtension
+  extend ActiveSupport::Concern
+
+  included do
+    def initialize(location, mail, part = nil)
+      @location = location.gsub("#{Rails.root.to_s}/", '')
+      @mail = mail
+      @part = part
+      @attachments = []
+    end
+
+    def render
+      if mail.attachments.any?
+        attachments_dir = File.join(@location, 'attachments')
+        # TODO: need check render with attachment
+        mail.attachments.each do |attachment|
+          filename = attachment.filename.gsub(/[^\w.]/, '_')
+          path = File.join(attachments_dir, filename)
+
+          object(path).put(body: attachment.body.raw_source, content_length: attachment.body.raw_source.size)
+
+          @attachments << [attachment.filename, "attachments/#{URI.escape(filename)}"]
+        end
+      end
+
+      str = ERB.new(template).result(binding)
+      object(filepath).put(body: str, content_length: str.size)
+    end
+
+    def template
+      letter_opener_path = $".select{|f| f.match(/letter_opener\/message.rb/)}.first
+      File.read(File.join(letter_opener_path.gsub('message.rb', ''), 'message.html.erb'))
+    end
+
+    def body
+      @body ||= begin
+        body = (@part || @mail).decoded
+
+        mail.attachments.each do |attachment|
+          body.gsub!(attachment.url, "attachments/#{attachment.filename}")
+        end
+
+        body.gsub!(/=\"\/assets/, "=\"#{URI::join(LetterOpenerWebS3.domain, 'assets')}") if LetterOpenerWebS3.domain
+
+        body
+      end
+    end
+
+    private
+
+    def object(filepath)
+      LetterOpenerWebS3.bucket.object(filepath)
+    end
+  end
+end

data/lib/letter_opener_web_s3/version.rb

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

data/lib/letter_opener_web_s3.rb

@@ -0,0 +1,54 @@
+require 'active_support'
+require 'aws-sdk'
+require 'letter_opener'
+require 'letter_opener_web'
+require "letter_opener_web_s3/version"
+require "letter_opener_web_s3/message_extension"
+require "letter_opener_web_s3/letter_extension"
+
+module LetterOpenerWebS3
+  mattr_accessor :s3_config
+  mattr_accessor :domain
+
+  # @api private
+  class S3ConfigError < StandardError; end
+
+  # @api private
+  class S3CredentialsError < StandardError
+    def message
+      "Credentials not found"
+    end
+  end
+
+  class << self
+    # Sets up an S3 backend
+    #
+    # @s3_config [String] region            The AWS region to connect to
+    # @s3_config [String] bucket_name       The name of the bucket where files will be stored
+    # @s3_config [String] access_key_id     Access key ID
+    # @s3_config [String] secret_access_key Secret access key
+    # @domain    [String]                   Domain to assets link
+    # @see http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/Core/Configuration.html
+    # @see http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/S3.html
+    def configure
+      yield self
+    end
+
+    def bucket
+      raise S3ConfigError if !s3_config.is_a?(Hash) ||
+          (s3_config.keys & [:region, :bucket_name, :access_key_id, :secret_access_key]).size != 4
+      return @bucket if @bucket
+      @s3 = Aws::S3::Resource.new s3_config.slice(:region, :access_key_id, :secret_access_key)
+      credentials = @s3.client.config.credentials
+      raise S3CredentialsError unless credentials
+      @bucket = @s3.bucket s3_config[:bucket_name]
+    end
+
+  end
+
+end
+
+ActionDispatch::Reloader.to_prepare(prepend: true) do
+  LetterOpener::Message.send :include, LetterOpenerWebS3::MessageExtension
+  LetterOpenerWeb::Letter.send :include, LetterOpenerWebS3::LetterExtension
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: letter_opener_web_s3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vital Ryabchinskiy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: letter_opener_web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Gives letter_opener and letter_opener_web work with S3
+email:
+- vital.ryabchinskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- letter_opener_web_s3.gemspec
+- lib/letter_opener_web_s3.rb
+- lib/letter_opener_web_s3/letter_extension.rb
+- lib/letter_opener_web_s3/message_extension.rb
+- lib/letter_opener_web_s3/version.rb
+homepage: https://github.com/vitalinfo/letter_opener_web_s3
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Gives letter_opener and letter_opener_web work with S3
+test_files: []