brick_ftp 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff0644f7601a0b205787a383d7e404ea52575f6e10d2e4ec92f2494b0b2e207
-  data.tar.gz: 89b62baafda83fc5a354a3b869bdb9779ec0ff82def20627f40412ef02f2818e
+  metadata.gz: 5a0069f587ef3fe9093bac0c8226af17eecc3634cb461bee69b2de18748b6b1f
+  data.tar.gz: 31a6d9bb6e85cfe8fec3f246c97bc38632b42fdd1a3f6191f09f4e82948c89a7
 SHA512:
-  metadata.gz: '08e939656344e02093ac1df11a0fd9f93194706eac4de105880f90177c7d67876af69cfd42694fe9260e38b4599f89a61ceb6b4ed106ef1d903c68848b20f961'
-  data.tar.gz: f441cbcf2c4e2bb5c64fecb88c2e44ec5bd3293ee6d9fc2bd77b3715635fcb707bd61e3e601e38d048c32d2c6706bcff711d418eab1610c0dbebe7264464c562
+  metadata.gz: 3ccbfa02cab23edd32e91400fc5bc3fc1a0ec75dbe9e763024249c7271d78abede39074994fe1bae73e613f7f09f6c44761bb392f16bb8d1ff92831e0da4d98d
+  data.tar.gz: 68cd755ff67fcb37d21ca17743d2df51ceceebbf54f0afb24d38459f92c848df4b8043db36345a47376107224a0f94473dbbdfc6fc2df5e43b4d47e382d7a21d

data/CHANGELOG.md

@@ -2,10 +2,10 @@ Changelog
 ====
 
 
-[unreleased](https://github.com/koshigoe/brick_ftp/compare/v0.7.0...master)
+[unreleased](https://github.com/koshigoe/brick_ftp/compare/v0.7.1...master)
 ----
 
-[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.7.0...master)
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.7.1...master)
 
 ### Enhancements:
 
@@ -14,6 +14,20 @@ Changelog
 ### Breaking Changes:
 
 
+[v0.7.1](https://github.com/koshigoe/brick_ftp/compare/v0.7.0...v0.7.1)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.7.0...v0.7.1)
+
+### Enhancements:
+
+- [#89](https://github.com/koshigoe/brick_ftp/pull/89) [Experimental] Allow to execute each steps of multi part uploading.
+
+### Fixed Bugs:
+
+### Breaking Changes:
+
+
 [v0.7.0](https://github.com/koshigoe/brick_ftp/compare/v0.6.1...v0.7.0)
 ----
 

data/lib/brick_ftp.rb

@@ -33,6 +33,8 @@ require 'brick_ftp/api/file_operation'
 require 'brick_ftp/api/file_operation/move'
 require 'brick_ftp/api/file_operation/copy'
 require 'brick_ftp/api/file_operation/upload'
+require 'brick_ftp/api/file_operation/uploading_session'
+require 'brick_ftp/api/file_operation/uploading_result'
 require 'brick_ftp/api/site_usage'
 require 'brick_ftp/webhook'
 require 'brick_ftp/webhook/request'

data/lib/brick_ftp/api/file_operation/uploading_result.rb

@@ -0,0 +1,22 @@
+module BrickFTP
+  module API
+    module FileOperation
+      class UploadingResult < BrickFTP::API::Base
+        endpoint :post, :create, '/api/rest/v1/files/%{path}'
+
+        attribute :path
+        attribute :type
+        attribute :size
+        attribute :mtime
+        attribute :crc32
+        attribute :md5
+
+        def self.create(path:, ref:)
+          api_client = BrickFTP::HTTPClient.new
+          res = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: ref })
+          new(res.symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/file_operation/uploading_session.rb

@@ -0,0 +1,85 @@
+module BrickFTP
+  module API
+    module FileOperation
+      class UploadingSession < BrickFTP::API::Base
+        include Enumerable
+
+        endpoint :post, :create, '/api/rest/v1/files/%{path}'
+
+        attribute :ref
+        attribute :http_method
+        attribute :upload_uri
+        attribute :partsize
+        attribute :part_number
+        attribute :available_parts
+        attribute :headers
+        attribute :parameters
+        attribute :send
+        attribute :path
+        attribute :action
+        attribute :ask_about_overwrites
+        attribute :expires
+        attribute :next_partsize
+        attribute :provided_mtime
+        attribute :permission
+
+        # Get uploading URL.
+        #
+        # @see https://brickftp.com/docs/rest-api/file-uploading/
+        # @param [String] path Remote file path.
+        # @return [BrickFTP::API::FileOperation::UploadingSession] A session object of uploading file.
+        #
+        def self.create(path:)
+          api_client = BrickFTP::HTTPClient.new
+          res = api_client.post(api_path_for(:create, path: path), params: { action: 'put' })
+          new(res.symbolize_keys)
+        end
+
+        # Upload data.
+        #
+        # @param [String] upload_uri A uplading URL.
+        # @param [IO] data An IO object to upload.
+        #
+        def self.upload(upload_uri:, data:)
+          uri = URI.parse(upload_uri)
+          upload_client = BrickFTP::HTTPClient.new(uri.host)
+          upload_client.put(uri.to_s, params: data)
+        end
+
+        # Get uploading URL for multi part uploading.
+        #
+        # @param [Integer] part_number The part number.
+        # @return [BrickFTP::API::FileOperation::UploadingSession] A session object of uploading file.
+        #
+        def at(part_number)
+          params = { action: 'put', ref: ref, part: part_number }
+          api_client = BrickFTP::HTTPClient.new
+          res = api_client.post(self.class.api_path_for(:create, path: path), params: params)
+          self.class.new(res.symbolize_keys)
+        end
+
+        # Get each uploading URLs.
+        #
+        # @yield [session] Gives uploading session object to the block.
+        # @yieldparam [BrickFTP::API::FileOperation::UploadingSession] session A session object of uploading file.
+        #
+        def each
+          return enum_for(__method__) unless block_given?
+
+          yield self
+          (part_number + 1).upto(available_parts) do |n|
+            yield at(n)
+          end
+        end
+
+        # Complete uploading file.
+        #
+        # @return [BrickFTP::API::FileOperation::UploadingResult] A result of uploading file.
+        #
+        def commit
+          UploadingResult.create(path: path, ref: ref)
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/version.rb

@@ -1,3 +1,3 @@
 module BrickFTP
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.7.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - koshigoe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,6 +202,8 @@ files:
 - lib/brick_ftp/api/file_operation/copy.rb
 - lib/brick_ftp/api/file_operation/move.rb
 - lib/brick_ftp/api/file_operation/upload.rb
+- lib/brick_ftp/api/file_operation/uploading_result.rb
+- lib/brick_ftp/api/file_operation/uploading_session.rb
 - lib/brick_ftp/api/folder.rb
 - lib/brick_ftp/api/folder_behavior.rb
 - lib/brick_ftp/api/group.rb