s3_sign 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 447a0d533f6b48c8ba047c28404ed883505f2433
+  data.tar.gz: 459ba0f3170e825a39555cfb43bac368c329ee44
+SHA512:
+  metadata.gz: c3cc28ad515aa2542735e63e49e5843aa0ca4ccdd7a15374a073c2b0c2cbee06c28293ff62dcbde7f2ba02cc5c24c90f96104b93e088436dacf9f8f39ac569e8
+  data.tar.gz: 7672f0e87dc8023452fc00342ec8a5013599cb7f642f7d954e19fb5032dde26371bd9807e505693857d7f8ec6caeb427afa243224b83c51ba7e8f2f30be2a3e5

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kajabi
+
+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,69 @@
+# S3Sign
+
+S3Sign allows easy signing of already formatted s3 urls.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_sign'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_sign
+
+## Usage
+
+Initialize the `bucket_name` for for `S3Sign`.  In rails for instance,
+you might add an initializer for this.
+
+### Setup
+```ruby
+S3Sign.bucket_name = "super_s3_bucket"
+```
+
+The gem assumes you already have AWS (via aws-sdk) configured globally,
+something like this:
+
+```ruby
+AWS.config(
+  :access_key_id     => AppConfig.aws.access_key,
+  :secret_access_key => AppConfig.aws.secret_key
+)
+```
+
+### API
+
+The `S3Sign` module itself provides `.url`:
+
+```ruby
+# Pass a full s3 url and 1 hour expiration
+S3Sign.url "http://s3.amazonaws.com/bucket/foo.png", 3600
+# => "https://bucket.s3.amazonaws.com/foo.png?AWSAccessKeyId=access_key_id&Expires=1427243780&Signature=a3RzDgElxDpSZLgxurZLiw1a6Ny%3D"
+
+# Pass a 'key' portion found under the bucket with default expiration
+S3Sign.url "images/foo.png"
+```
+
+The gem also provides a `S3Sign::Helper` module, useful to mixin to rails
+controllers.  It will add two helper methods to your controllers and views.
+
+`s3_signed_url_for_key` - Takes a key/url and optional expires
+
+`stable_s3_signed_url` - Takes a url and optional reference time.  Used for
+generting signatures that expire in the far future year 2036.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/s3_sign/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,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 "s3_sign"
+
+# 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/lib/s3_sign/helper.rb

@@ -0,0 +1,50 @@
+module S3Sign
+  module Helper
+    def self.included(base)
+      if base.respond_to?(:helper_method)
+        base.helper_method :stable_s3_signed_url
+        base.helper_method :s3_signed_url_for_key
+      end
+
+      if base.respond_to?(:hide_action)
+        base.hide_action :stable_s3_signed_url
+        base.hide_action :s3_signed_url_for_key
+      end
+    end
+
+    # A pure "time from now" signed s3 asset url.  Good for non-visual elements
+    # like attachments, and not thumbnails, that don't have the same caching concerns
+    def s3_signed_url_for_key(key, expires_in = 86_400)
+      S3Sign.url key, expires_in
+    end
+
+    # Uses a far-future date so that the expires and signature on
+    # the url doesn't change for every request.  This lets us still
+    # protect assets but the browser can cache them because the url
+    # isn't constantly changing.
+    #
+    # Use for assets we want browser cached that don't need higher
+    # level protection, such as thumbnails.  Other more central assets
+    # like downloads for a course or videos should have short expiration
+    # because they generally don't benefit as much from caching and need
+    # better time-based protection.
+    #
+    # If a reference_time is given, that will use the time given but in the
+    # far future stable year.  This is useful to cache-bust the url from
+    # an updated_at timestamp where some browsers/proxies may try to use
+    # the cached asset even though it was updated.
+    def stable_s3_signed_url(url, reference_time = nil)
+      @stable_s3_expire_at ||= Time.parse("2036-1-1 00:00:00 UTC")
+
+      if reference_time
+        # The time given but in the year 2036
+        year       = @stable_s3_expire_at.year
+        expires_at = Time.parse(reference_time.utc.strftime("#{year}-%m-%d %T UTC"))
+      else
+        expires_at = @stable_s3_expire_at
+      end
+
+      s3_signed_url_for_key(url, expires_at)
+    end
+  end
+end

data/lib/s3_sign/version.rb

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

data/lib/s3_sign.rb

@@ -0,0 +1,29 @@
+require "s3_sign/version"
+require "s3_sign/helper"
+require "aws"
+
+module S3Sign
+  SEVEN_DAYS = 60 * 60 * 24 * 7
+
+  class << self
+    attr_writer :bucket_name
+    def bucket_name
+      @bucket_name or raise "No S3Sign.bucket_name is set"
+    end
+  end
+
+  def self.url(s3_url, expires = SEVEN_DAYS)
+    s3 = AWS::S3.new
+    bucket = s3.buckets[bucket_name]
+
+    path = path_from_s3_url(s3_url)
+
+    AWS::S3::S3Object.new(bucket, path).url_for(:read, expires: expires).to_s
+  end
+
+  protected
+
+  def self.path_from_s3_url(s3_url)
+    s3_url.sub(%r{^.+?/#{bucket_name}/}, '')
+  end
+end

data/s3_sign.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_sign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_sign"
+  spec.version       = S3Sign::VERSION
+  spec.authors       = ["Brendon Murphy"]
+  spec.email         = ["xternal1+github@gmail.com"]
+
+  spec.summary       = %q{A quick a dirty way to s3 sign string s3 urls using the aws-sdk}
+  spec.description   = %q{A quick a dirty way to s3 sign string s3 urls using the aws-sdk}
+  spec.homepage      = "https://github.com/Kajabi/s3_sign"
+  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 "aws-sdk", "~> 1.36"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: s3_sign
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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
+description: A quick a dirty way to s3 sign string s3 urls using the aws-sdk
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/s3_sign.rb
+- lib/s3_sign/helper.rb
+- lib/s3_sign/version.rb
+- s3_sign.gemspec
+homepage: https://github.com/Kajabi/s3_sign
+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
+signing_key: 
+specification_version: 4
+summary: A quick a dirty way to s3 sign string s3 urls using the aws-sdk
+test_files: []