attachie 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fce9a92b9b729e8d2a453178293afaf74b1658321cdbc81d4d0ec5fd95794d8
-  data.tar.gz: 3bab92b185f8d97105155c686c87153f81cb994242df9b848c30601a830283a0
+  metadata.gz: 2a6322baba1a72a9869ed2cb50a2f58a890fed49a5b1fbfb57c6e358dfcce4b2
+  data.tar.gz: 7e95e247cf920af92fd51d32b21bf2d0a82a59af022cacc1343a2bb71612d5b7
 SHA512:
-  metadata.gz: 1548848d991986d9bb32442dfe5fa5cc1c55822aa6b6e5e47f5fa7004a222cd5840cd4bac172d631c0c2085bef5eeeaeb98476f24340bde131ec244d2a068e7d
-  data.tar.gz: d3ca7add377253d86228affb874d839720c3275b8005322b84c36eab65ad517aed7d10f62a694165ca536d0ca54341d35ab9911bc7284a7beb17bc730ca93eb7
+  metadata.gz: ef797be58fb2573636f3cfc9de41fc1484cc8f6357488e7d1699ed5288a79b3c2ca0a51795ab825ce8941f05c69986dd84dd05b1861493ef74c8cc1afb5a1cd6
+  data.tar.gz: e986a15bc1a7781d4d60f620949582ae455c0dc6374c818930c7990a430bc9cbc4740d14cb2b0a60865769c084b7bc5bbce9c55f5aa1cabb0a10790704767745

data/README.md

@@ -36,6 +36,9 @@ class User
 end
 ```
 
+Please note, Attachie will interpolate colon prefixed segments like `:id` by
+replacing it with the return value of the respective method.
+
 Second, store blobs for your version:
 
 ```ruby
@@ -71,14 +74,15 @@ user.avatar(:icon).temp_url(expires_in: 2.days) # Must be supported by the drive
 
 ## Drivers
 
-The `attachie` gem ships with the following drivers:
+The `Attachie` gem ships with the following drivers:
 
 * `Attachie::FileDriver`: To store files on the local file system
 * `Attachie::FakeDriver`: To store files in memory (for testing)
 * `Attachie::S3Driver`: To store files on S3
-* `Attachie::SwiftDriver`: To store files on an Openstack Swift provider
 
-You can eg use the file system driver:
+### FileDriver
+
+To use the file driver:
 
 ```ruby
 require "attachie/file_driver"
@@ -94,6 +98,47 @@ class User
 end
 ```
 
+### S3Driver
+
+To use the s3 driver:
+
+```ruby
+require "attachie/s3_driver"
+
+Attachie.default_options[:driver] = Attachie::S3Driver.new(Aws::S3::Client.new('...'))
+```
+
+### FakeDriver
+
+To use the fake driver (useful for testing):
+
+```ruby
+require "attachie/fake_driver"
+
+Attachie.default_options[:driver] = Attache::FakeDriver.new
+```
+
+Drivers and other options can be set on an attachment level as well:
+
+```ruby
+class User
+  include Attachie
+
+  attachment :avatar, driver: MyFileDriver, versions: {
+    # ...
+  }
+end
+```
+
+## Direct S3 Uploads
+
+Attachie allows to presign s3 post requests like:
+
+```ruby
+user.avatar(:icon).presign_post(content_type: 'image/jpeg', ...)
+# => {"fields"=>{"key"=>"path/to/object","x-amz-signature"=>"..."},"headers":{},"method"=>"post","url"=>"..."}
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/mrkamel/attachie/fork )

data/attachie.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "swift_client"
   spec.add_dependency "aws-sdk-s3"
   spec.add_dependency "mime-types"
   spec.add_dependency "connection_pool"

data/lib/attachie.rb

@@ -7,6 +7,7 @@ module Attachie
   class UnknownAttachment < StandardError; end
   class NoSuchVersion < StandardError; end
   class InterpolationError < StandardError; end
+  class NotSupported < StandardError; end
 
   def self.default_options
     @default_options ||= { :protocol => "http" }
@@ -22,6 +23,10 @@ module Attachie
         self.options = options
       end
 
+      def presigned_post(options = {})
+        option(:driver).presigned_post(path, container, options)
+      end
+
       def url
         "#{interpolate option(:protocol)}://#{interpolate option(:host)}/#{interpolate(option(:url_prefix)).to_s + "/" if option(:url_prefix)}#{path}#{interpolate(option(:url_suffix)) if option(:url_suffix)}"
       end
@@ -54,6 +59,10 @@ module Attachie
         option(:driver).store(path, data_or_io, container, opts)
       end
 
+      def info
+        option(:driver).info(path, container)
+      end
+
       def store_multipart(opts = {}, &block)
         option(:driver).store_multipart(path, container, opts, &block)
       end
@@ -148,7 +157,7 @@ module Attachie
 
     raise(UnknownAttachment) unless definition
 
-    Attachment.new self, name, definition
+    Attachment.new(self, name, definition)
   end
 
   module ClassMethods

data/lib/attachie/fake_driver.rb

@@ -42,6 +42,18 @@ module Attachie
       end
     end
 
+    def info(name, bucket)
+      {
+        last_modified: nil,
+        content_length: objects(bucket)[name].size,
+        content_type: MIME::Types.of(name).first&.to_s
+      }
+    end
+
+    def presigned_post(name, bucket, options = {})
+      raise NotSupported, 'presigned_post is not supported in FakeDriver'
+    end
+
     def store(name, data_or_io, bucket, options = {})
       objects(bucket)[name] = data_or_io.respond_to?(:read) ? data_or_io.read : data_or_io
     end 

data/lib/attachie/file_driver.rb

@@ -65,6 +65,18 @@ module Attachie
       true
     end
 
+    def presigned_post(name, bucket, options = {})
+      raise NotSupported, 'presigned_post is not supported in FileDriver'
+    end
+
+    def info(name, bucket)
+      {
+        last_modified: File.mtime(path_for(name, bucket)),
+        content_type: MIME::Types.of(name).first&.to_s,
+        content_length: File.size(path_for(name, bucket))
+      }
+    end
+
     def store_multipart(name, bucket, options = {}, &block)
       path = path_for(name, bucket)
 

data/lib/attachie/s3_driver.rb

@@ -59,6 +59,12 @@ module Attachie
       self.s3_resource = Aws::S3::Resource.new(client: s3_client)
     end
 
+    def presigned_post(name, bucket, options = {})
+      res = s3_resource.bucket(bucket).object(name).presigned_post(options)
+
+      return { fields: res.fields, headers: {}, method: "post", url: res.url }
+    end
+
     def list(bucket, prefix: nil)
       return enum_for(:list, bucket, prefix: prefix) unless block_given?
 
@@ -70,6 +76,16 @@ module Attachie
       end
     end
 
+    def info(name, bucket)
+      object = s3_resource.bucket(bucket).object(name)
+
+      {
+        content_length: object.content_length,
+        last_modified: object.last_modified,
+        content_type: object.content_type
+      }
+    end
+
     def store(name, data_or_io, bucket, options = {})
       opts = options.dup
 

data/lib/attachie/version.rb

@@ -1,3 +1,3 @@
 module Attachie
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/spec/attachie/fake_driver_spec.rb

@@ -4,32 +4,36 @@ require File.expand_path("../../spec_helper", __FILE__)
 RSpec.describe Attachie::FakeDriver do
   let(:driver) { Attachie::FakeDriver.new }
 
-  it "should list objects" do
-    begin
+  after { driver.flush }
+
+  describe "#presigned_post" do
+    it "raises NotSupported" do
+      expect { driver.presigned_post("path", "bucket") }.to raise_error(Attachie::NotSupported)
+    end
+  end
+
+  describe "#list" do
+    it "lists objects" do
       driver.store("object1", "blob", "bucket1")
       driver.store("object2", "blob", "bucket1")
       driver.store("other", "blob", "bucket1")
       driver.store("object", "blob", "bucket3")
 
       expect(driver.list("bucket1", prefix: "object").to_a).to eq(["object1", "object2"])
-    ensure
-      driver.flush
     end
   end
 
-  it "should store a blob" do
-    begin
+  describe "#store" do
+    it "stores a blob" do
       driver.store("name", "blob", "bucket")
 
       expect(driver.exists?("name", "bucket")).to be(true)
       expect(driver.value("name", "bucket")).to eq("blob")
-    ensure
-      driver.flush
     end
   end
 
-  it "should store a blob via multipart upload" do
-    begin
+  describe "#store_multipart" do
+    it "stores a blob via multipart upload" do
       driver.store_multipart("name", "bucket") do |upload|
         upload.upload_part("chunk1")
         upload.upload_part("chunk2")
@@ -37,25 +41,35 @@ RSpec.describe Attachie::FakeDriver do
 
       expect(driver.exists?("name", "bucket")).to be(true)
       expect(driver.value("name", "bucket")).to eq("chunk1chunk2")
-    ensure
-      driver.flush
     end
   end
 
-  it "should delete a blob" do
-    begin
+  describe "#delete" do
+    it "deletes a blob" do
       driver.store("name", "blob", "bucket")
       expect(driver.exists?("name", "bucket")).to be(true)
 
       driver.delete("name", "bucket")
       expect(driver.exists?("name", "bucket")).to be(false)
-    ensure
-      driver.flush
     end
   end
 
-  it "should generate a temp_url" do
-    expect(driver.temp_url("name", "bucket")).to eq("https://example.com/bucket/name?signature=signature&expires=expires")
+  describe "#temp_url" do
+    it "generates a temp_url" do
+      expect(driver.temp_url("name", "bucket")).to eq("https://example.com/bucket/name?signature=signature&expires=expires")
+    end
+  end
+
+  describe "#info" do
+    it "returns info about the object" do
+      driver.store("name.txt", "blob", "bucket")
+
+      expect(driver.info("name.txt", "bucket")).to eq(
+        content_length: 4,
+        content_type: "text/plain",
+        last_modified: nil
+      )
+    end
   end
 end
 

data/spec/attachie/file_driver_spec.rb

@@ -4,40 +4,68 @@ require File.expand_path("../../spec_helper", __FILE__)
 RSpec.describe Attachie::FileDriver do
   let(:driver) { Attachie::FileDriver.new("/tmp/attachie") }
 
-  it "should store a blob" do
-    begin
-      driver.store("name", "blob", "bucket")
-
-      expect(driver.exists?("name", "bucket")).to be(true)
-      expect(driver.value("name", "bucket")).to eq("blob")
-    ensure
-      driver.delete("name", "bucket")
+  describe "#presigned_post" do
+    it "raises NotSupported" do
+      expect { driver.presigned_post("path", "bucket") }.to raise_error(Attachie::NotSupported)
     end
   end
 
-  it "should store a blob via multipart upload" do
-    begin
-      driver.store_multipart("name", "bucket") do |upload|
-        upload.upload_part("chunk1")
-        upload.upload_part("chunk2")
+  describe "#store" do
+    it "stores a blob" do
+      begin
+        driver.store("name", "blob", "bucket")
+
+        expect(driver.exists?("name", "bucket")).to be(true)
+        expect(driver.value("name", "bucket")).to eq("blob")
+      ensure
+        driver.delete("name", "bucket")
       end
+    end
+  end
 
-      expect(driver.exists?("name", "bucket")).to be(true)
-      expect(driver.value("name", "bucket")).to eq("chunk1chunk2")
-    ensure
-      driver.delete("name", "bucket")
+  describe" #store_multipart" do
+    it "stores a blob via multipart upload" do
+      begin
+        driver.store_multipart("name", "bucket") do |upload|
+          upload.upload_part("chunk1")
+          upload.upload_part("chunk2")
+        end
+
+        expect(driver.exists?("name", "bucket")).to be(true)
+        expect(driver.value("name", "bucket")).to eq("chunk1chunk2")
+      ensure
+        driver.delete("name", "bucket")
+      end
     end
   end
 
-  it "should delete a blob" do
-    begin
-      driver.store("name", "blob", "bucket")
-      expect(driver.exists?("name", "bucket")).to be(true)
+  describe "#delete" do
+    it "deletes a blob" do
+      begin
+        driver.store("name", "blob", "bucket")
+        expect(driver.exists?("name", "bucket")).to be(true)
 
-      driver.delete("name", "bucket")
-      expect(driver.exists?("name", "bucket")).to be(false)
-    ensure
-      driver.delete("name", "bucket")
+        driver.delete("name", "bucket")
+        expect(driver.exists?("name", "bucket")).to be(false)
+      ensure
+        driver.delete("name", "bucket")
+      end
+    end
+  end
+
+  describe "#info" do
+    it "returns info about the object" do
+      begin
+        driver.store("name.txt", "blob", "bucket")
+
+        expect(driver.info("name.txt", "bucket")).to match(
+          content_length: 4,
+          content_type: "text/plain",
+          last_modified: anything
+        )
+      ensure
+        driver.delete("name.txt", "bucket")
+      end
     end
   end
 end

data/spec/attachie/s3_driver_spec.rb

@@ -11,59 +11,109 @@ RSpec.describe Attachie::S3Driver do
     ))
   end
 
-  it "should list objects" do
-    begin
-      driver.store("object1", "blob", "bucket")
-      driver.store("object2", "blob", "bucket")
-      driver.store("other", "blob", "bucket")
-
-      expect(driver.list("bucket", prefix: "object").to_a).to eq(["object1", "object2"])
-    ensure
-      driver.delete("object1", "bucket")
-      driver.delete("object2", "bucket")
-      driver.delete("other", "bucket")
+  describe "#list" do
+    it "lists objects" do
+      begin
+        driver.store("object1", "blob", "bucket")
+        driver.store("object2", "blob", "bucket")
+        driver.store("other", "blob", "bucket")
+
+        expect(driver.list("bucket", prefix: "object").to_a).to eq(["object1", "object2"])
+      ensure
+        driver.delete("object1", "bucket")
+        driver.delete("object2", "bucket")
+        driver.delete("other", "bucket")
+      end
     end
   end
 
-  it "should store a blob" do
-    begin
-      driver.store("name", "blob", "bucket")
+  describe "#store" do
+    it "stores a blob" do
+      begin
+        driver.store("name", "blob", "bucket")
 
-      expect(driver.exists?("name", "bucket")).to be(true)
-      expect(driver.value("name", "bucket")).to eq("blob")
-    ensure
-      driver.delete("name", "bucket")
+        expect(driver.exists?("name", "bucket")).to be(true)
+        expect(driver.value("name", "bucket")).to eq("blob")
+      ensure
+        driver.delete("name", "bucket")
+      end
     end
   end
 
-  it "should store a blob via multipart upload" do
-    begin
-      driver.store_multipart("name", "bucket") do |upload|
-        upload.upload_part("chunk1")
-        upload.upload_part("chunk2")
+  describe "#store_multipart" do
+    it "stores a blob via multipart upload" do
+      begin
+        driver.store_multipart("name", "bucket") do |upload|
+          upload.upload_part("chunk1")
+          upload.upload_part("chunk2")
+        end
+
+        expect(driver.exists?("name", "bucket")).to be(true)
+        expect(driver.value("name", "bucket")).to eq("chunk1chunk2")
+      ensure
+        driver.delete("name", "bucket")
+      end
+    end
+  end
+
+  describe "#delete" do
+    it "deletes a blob" do
+      begin
+        driver.store("name", "blob", "bucket")
+        expect(driver.exists?("name", "bucket")).to be(true)
+
+        driver.delete("name", "bucket")
+        expect(driver.exists?("name", "bucket")).to be(false)
+      ensure
+        driver.delete("name", "bucket")
       end
+    end
+  end
 
-      expect(driver.exists?("name", "bucket")).to be(true)
-      expect(driver.value("name", "bucket")).to eq("chunk1chunk2")
-    ensure
-      driver.delete("name", "bucket")
+  describe "#temp_url" do
+    it "generates a temp_url" do
+      expect(driver.temp_url("name", "bucket")).to be_url
     end
   end
 
-  it "should delete a blob" do
-    begin
-      driver.store("name", "blob", "bucket")
-      expect(driver.exists?("name", "bucket")).to be(true)
+  describe "#presigned_post" do
+    it "generates a presign response" do
+      expect(driver.presigned_post("path/to/object", "bucket")).to match(
+        fields: hash_including("key" => "path/to/object"),
+        headers: {},
+        method: "post",
+        url: "http://bucket.localhost:4569"
+      )
+    end
+
+    it "supports and passes additional options" do
+      bucket = double
+      object = double
+
+      allow(bucket).to receive(:object).and_return(object)
+      allow(object).to receive(:presigned_post).and_return(OpenStruct.new)
+      allow(driver.s3_resource).to receive(:bucket).and_return(bucket)
 
-      driver.delete("name", "bucket")
-      expect(driver.exists?("name", "bucket")).to be(false)
-    ensure
-      driver.delete("name", "bucket")
+      driver.presigned_post("path", "bucket", { key: "value" })
+
+      expect(object).to have_received(:presigned_post).with(hash_including(key: "value"))
     end
   end
 
-  it "should generate a temp_url" do
-    expect(driver.temp_url("name", "bucket")).to be_url
+  describe "#info" do
+    it "returns info about the object" do
+      begin
+        driver.store("name.txt", "blob", "bucket")
+
+        expect(driver.info("name.txt", "bucket")).to match(
+          content_length: 4,
+          content_type: "text/plain",
+          last_modified: anything
+        )
+      ensure
+        driver.delete("name.txt", "bucket")
+      end
+    end
   end
 end
 

data/spec/attachie_spec.rb

@@ -17,32 +17,32 @@ class TestModel
 end
 
 RSpec.describe TestModel do
-  it "should interpolate the path" do
+  it "interpolates the path" do
     test_model = TestModel.new(filename: "file.jpg")
 
     expect(test_model.file(:small).path).to eq("path/to/small/file.jpg")
   end
 
-  it "should allow arbitrary version methods" do
+  it "allows arbitrary version methods" do
     test_model = TestModel.new(filename: "file.jpg")
 
     expect(test_model.file(:small).attribute).to eq("value")
   end
 
-  it "should espect the host" do
+  it "respects the host" do
     test_model = TestModel.new(filename: "file.jpg")
 
     expect(test_model.file(:large).url).to eq("http://www.example.com/path/to/large/file.jpg")
   end
 
-  it "should correctly use the driver" do
+  it "correctly uses the driver" do
     test_model = TestModel.new(filename: "blob.txt")
     test_model.file(:large).store "blob"
 
     expect(test_model.file(:large).value).to eq("blob")
   end
 
-  it "should set updated_at" do
+  it "sets updated_at" do
     test_model = TestModel.new(filename: "file.jpg")
     test_model.file = "file"
 
@@ -53,5 +53,38 @@ RSpec.describe TestModel do
 
     expect(test_model.updated_at).to be_nil
   end
-end
 
+  describe "#info" do
+    it "returns info about the attachment" do
+      test_model = TestModel.new(filename: "blob.txt")
+      test_model.file(:large).store("blob")
+
+      expect(test_model.file(:large).info).to match(
+        last_modified: anything,
+        content_type: anything,
+        content_length: anything
+      )
+    end
+  end
+
+  describe "#presigned_post" do
+    let(:attachment) { TestModel.new(filename: "file.jpg").file(:large) }
+    let(:driver) { TestModel.attachments[:file][:driver] }
+
+    before do
+      allow(driver).to receive(:presigned_post)
+    end
+
+    it "delegates to the driver" do
+      attachment.presigned_post
+
+      expect(driver).to have_received(:presigned_post).with(attachment.path, attachment.bucket, {})
+    end
+
+    it "passes the supplied options" do
+      attachment.presigned_post(key: "value")
+
+      expect(driver).to have_received(:presigned_post).with(attachment.path, attachment.bucket, { key: "value" })
+    end
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: attachie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: swift_client
-  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-s3
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +142,6 @@ files:
 - lib/attachie/file_driver.rb
 - lib/attachie/interpolation.rb
 - lib/attachie/s3_driver.rb
-- lib/attachie/swift_driver.rb
 - lib/attachie/version.rb
 - spec/attachie/fake_driver_spec.rb
 - spec/attachie/file_driver_spec.rb

data/lib/attachie/swift_driver.rb

@@ -1,66 +0,0 @@
-
-require "swift_client"
-require "connection_pool"
-
-module Attachie
-  class SwiftDriver
-    attr_accessor :swift_client_pool
-
-    def initialize(swift_client_pool)
-      self.swift_client_pool = swift_client_pool
-    end
-
-    def list(container, prefix: nil)
-      return enum_for(:list, container, prefix: prefix) unless block_given?
-
-      swift_client_pool.with do |swift_client|
-        swift_client.paginate_objects(container, prefix: prefix) do |response|
-          response.parsed_response.each do |source_object|
-            yield source_object["name"]
-          end
-        end
-      end
-    end
-
-    def store(name, data_or_io, container, headers = {})
-      swift_client_pool.with do |swift_client|
-        swift_client.put_object name, data_or_io, container, headers
-      end
-    end 
-
-    def value(name, container)
-      swift_client_pool.with do |swift_client|
-        swift_client.get_object(name, container).body
-      end
-    end 
-
-    def delete(name, container)
-      swift_client_pool.with do |swift_client|
-        swift_client.delete_object name, container
-      end
-    rescue SwiftClient::ResponseError => e
-      return true if e.code == 404
-
-      raise e
-    end 
-
-    def exists?(name, container)
-      swift_client_pool.with do |swift_client|
-        swift_client.head_object name, container
-      end
-
-      true
-    rescue SwiftClient::ResponseError => e
-      return false if e.code == 404
-
-      raise e
-    end 
-
-    def temp_url(name, container, options = {})
-      swift_client_pool.with do |swift_client|
-        swift_client.temp_url name, container, options
-      end
-    end
-  end
-end
-