notebook 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3b29fcabdf77d11419e6d32a2de2d043a477dee
-  data.tar.gz: b858be60c3f58783f527a18f97505cd316406445
+  metadata.gz: 93d99b18119b52915e0cf4e3537fc47802cd19c4
+  data.tar.gz: 32b733d24e46eb657cc31b04055dd51f49b9927d
 SHA512:
-  metadata.gz: 245f639d4f1a9e72c6b1f91a7b62424ba54d3b68103bbe042ae675bc8dc0e53c7415ebdfb80973435a9863a9fd45cd1acda8c05a000a31e53823e571d32dfe07
-  data.tar.gz: 4b2dacc69de34a410005c9ce54a9636e1f964581154aa193ba2c17cedbfbdbe661af8efd48309807053259570baf787b6908dd253f16ed5d915bf26e0bd7df8b
+  metadata.gz: c53b194da80483921fa0595629de5d8a91b2befd0244f5fde87ffb7312c881a0fe9ded8215c275a25813b5abdc2fc4760877bc0fc0affe048f5eaf6dd2783146
+  data.tar.gz: fbe03a05fc9c7633b27d41e0a6ed4fd7de8055c8c500b017d0b1ce261fb4b58e27c60d2a2a2328563604d4d48ceb1c1d7f2ab67d1f778622eb3335d0d9dba263

data/README.md

@@ -79,6 +79,17 @@ To use a different storage location than /public, create a
 Notebook.public_directory = 'hi'
 ```
 
+To store your upload files in a different place than the filesystem,
+create a `config/initializers/notebook.rb`, then set the following:
+
+```ruby
+# these are the two out of the box storage adapters
+# to use one from another source, just place the constant of a
+compliant adapter here.
+Notebook.adapter = Notebook::StorageAdapters::Filesystem
+Notebook.adapter = Notebook::StorageAdapters::S3
+```
+
 ## Plain Old Ruby
 
 It's awesome you want to use plain Ruby without Rails with Notebook!

data/lib/notebook.rb

@@ -7,12 +7,22 @@ module Notebook
   autoload :Attachment, 'notebook/attachment'
   autoload :StorageAdapters, 'notebook/storage_adapters'
 
+  # Return the current storage adapter in use
+  def self.adapter
+    @adapter || Notebook::StorageAdapters::Filesystem
+  end
+
+  # Set the storage adapter constant (ex: Notebook::StorageAdapters::Filesystem) to use
+  def self.adapter=(adapter)
+    @adapter = adapter
+  end
+
   # Return the current filesystem storage directory in use
   def self.public_directory
     @public_directory || (Pathname.pwd + 'public')
   end
 
-  # Set the  storage filesystem directory to use
+  # Set the storage filesystem directory to use
   def self.public_directory=(directory)
     @public_directory = directory
   end

data/lib/notebook/attachment.rb

@@ -21,7 +21,7 @@ module Notebook
     private
 
     def adapter
-      StorageAdapters::Filesystem.new(self)
+      Notebook.adapter.new(self)
     end
   end
 end

data/lib/notebook/storage_adapters.rb

@@ -2,5 +2,6 @@ module Notebook
   module StorageAdapters
     autoload :Base, 'notebook/storage_adapters/base'
     autoload :Filesystem, 'notebook/storage_adapters/filesystem'
+    autoload :S3, 'notebook/storage_adapters/s3'
   end
 end

data/lib/notebook/storage_adapters/s3.rb

@@ -0,0 +1,59 @@
+require 'aws-sdk'
+require 'securerandom'
+
+module Notebook
+  # Return the current S3 options
+  def self.s3_options
+    @s3_options || {}
+  end
+
+  # Allow the user to specify S3 options
+  def self.s3_options=(s3_options)
+    @s3_options = s3_options
+  end
+
+  module StorageAdapters
+    class S3 < Base
+      attr_reader :s3_file_key
+
+      def initialize(attachment, options = {})
+        super
+        #--
+        check_valid_credentials
+        setup_s3
+      end
+
+      def delete
+        @bucket.object(@s3_file_key).delete
+      end
+
+      def upload
+        @s3_file_key = "#{SecureRandom.uuid}/#{File.basename(attachment.file)}"
+        @file_object = @bucket.object(@s3_file_key)
+        @file_object.upload_file(attachment.file.path)
+      end
+
+      def url
+        @bucket.object(@s3_file_key).presigned_url(:get)
+      end
+
+      private
+
+      def check_valid_credentials
+        credentials = Notebook.s3_options
+        required_credential_keys = [:access_key_id, :bucket, :region, :secret_access_key]
+        contains_credentials = required_credential_keys.all? { |k| credentials.key?(k) }
+
+        return if contains_credentials
+        fail 'Proper credentials are not defined'
+      end
+
+      def setup_s3
+        @s3_options = Notebook.s3_options
+        @credentials = Aws::Credentials.new(@s3_options[:access_key_id], @s3_options[:secret_access_key])
+        @s3 = Aws::S3::Resource.new(credentials: @credentials, region: @s3_options[:region])
+        @bucket = @s3.bucket(@s3_options[:bucket])
+      end
+    end
+  end
+end

data/lib/notebook/version.rb

@@ -1,3 +1,3 @@
 module Notebook
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/notebook.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'aws-sdk'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notebook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jon Moss
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - lib/notebook/storage_adapters.rb
 - lib/notebook/storage_adapters/base.rb
 - lib/notebook/storage_adapters/filesystem.rb
+- lib/notebook/storage_adapters/s3.rb
 - lib/notebook/version.rb
 - notebook.gemspec
 - roadmap.txt