rb1drv 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feafbb64ce01c80b2c8f55c4d62dbed44aa6bca0d908965d94700a01def35f8a
-  data.tar.gz: 1b31de1595f55f7ecc4f40da51979a87fc72cb0ee6602768af2a6f7a08319661
+  metadata.gz: 554c9b9b3a7969cffb6d024ca89d77fd2725a449bdc1fec2d06eeec87ecba026
+  data.tar.gz: 6a4e906dbb95f1036cea931b0748b404e3ad9f5a42cfd40fa9a29773ab25fd19
 SHA512:
-  metadata.gz: 9a09646c4cbb6c1afc6e65f7bf2332865a5eae3afe32028b053908c21bacbeec8338e6b31f47176632c6939502971e9962627602528fd6f9eb68765ab9ebeaa2
-  data.tar.gz: 37cf356d74830003591bf77c5d3328d354cdfdd46f112b31fddf7baaf029f9ca23318cf782a1a228fd2c4e9842971fcef7f38d39bea5151fb4afb38f64321b31
+  metadata.gz: 331d44af9844787776f36f3ba638a7d8e65e1761875189bcb482a78ea7276559456711b945c4d29085a7aac34c7cf6fdb05f5d16d2c39265c75e568781f77cb1
+  data.tar.gz: 9a2bc0126d20e02ed2d35ccd0ec3ca620a92404e634d424c2e1289314ae021e88697a9296c68860324c1dde02d013637ddf089f6c118325583d1c0b520bb2336

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rb1drv (0.1.1)
+    rb1drv (0.1.4)
       excon (~> 0.62)
       oauth2 (~> 1.4)
 

data/lib/rb1drv/auth.rb

@@ -25,5 +25,9 @@ module Rb1drv
       @access_token = @access_token.refresh! if @access_token.expired?
       @access_token
     end
+
+    def auth_check
+      @access_token = @access_token.refresh! if @access_token.expired?
+    end
   end
 end

data/lib/rb1drv/onedrive.rb

@@ -9,6 +9,8 @@ module Rb1drv
 
     # Get an object by an arbitary path.
     #
+    # TODO: API endpoint does not play well with remote files
+    #
     # @return [OneDriveDir,OneDriveFile] the drive item you asked
     def get(path)
       path = "/#{path}" unless path[0] == '/'

data/lib/rb1drv/onedrive_404.rb

@@ -0,0 +1,16 @@
+module Rb1drv
+  class OneDrive404 < OneDriveItem
+    def initialize(*_)
+    end
+
+    # No
+    def dir?
+      false
+    end
+
+    # No
+    def file?
+      false
+    end
+  end
+end

data/lib/rb1drv/onedrive_dir.rb

@@ -1,3 +1,4 @@
+require 'time'
 require 'rb1drv/sliced_io'
 
 module Rb1drv
@@ -6,6 +7,7 @@ module Rb1drv
     def initialize(od, api_hash)
       super
       @child_count = api_hash.dig('folder', 'childCount')
+      @cached_gets = {}
     end
 
     # Lists contents of current directory.
@@ -13,21 +15,31 @@ module Rb1drv
     # @return [Array<OneDriveDir,OneDriveFile>] directories and files whose parent is current directory
     def children
       return [] if child_count <= 0
-      @od.request("drive/items/#{@id}/children")['value'].map do |child|
+      @cached_children ||= @od.request("#{api_path}/children")['value'].map do |child|
         OneDriveItem.smart_new(@od, child)
       end
     end
 
+    # Get a child object by name inside current directory.
+    #
+    # @param path [String] name of a child
+    #
+    # @return [OneDriveDir,OneDriveFile,OneDrive404] the drive item you asked
+    def get_child(path)
+      children.find { |child| child.name == path } || OneDrive404.new
+    end
+
     # Get an object by an arbitary path related to current directory.
     #
     # To get an absolute path, make use of OneDrive#get and not this.
     #
     # @param path [String] path relative to current directory
     #
-    # @return [OneDriveDir,OneDriveFile] the drive item you asked
+    # @return [OneDriveDir,OneDriveFile,OneDrive404] the drive item you asked
     def get(path)
       path = "/#{path}" unless path[0] == '/'
-      OneDriveItem.smart_new(self, @od.request("drive/items/#{@id}:#{path}"))
+      @cached_gets[path] ||=
+        OneDriveItem.smart_new(@od, @od.request("#{api_path}:#{path}"))
     end
 
     # Yes
@@ -54,83 +66,149 @@ module Rb1drv
     # @param name [String] directories you'd like to create
     # @return [OneDriveDir] the directory you created
     def mkdir(name)
+      return self if name == '.'
+      name = name[1..-1] if name[0] == '/'
       newdir, *remainder = name.split('/')
-      subdir = @od.request("drive/items/#{@id}:/#{newdir}") rescue nil
-      unless subdir
-        subdir = @od.request("drive/items/#{@id}/children",
+      subdir = get(newdir)
+      unless subdir.dir?
+        result = @od.request("#{api_path}/children",
           name: newdir,
           folder: {},
           '@microsoft.graph.conflictBehavior': 'rename'
         )
+        subdir = OneDriveDir.new(@od, result)
       end
-      subdir = OneDriveDir.new(@od, subdir)
       remainder.any? ? subdir.mkdir(remainder.join('/')) : subdir
     end
 
-    # Uploads a local file into current remote directory using large file uploading mode.
+    # Uploads a local file into current remote directory.
+    # For files no larger than 4000KiB, uses simple upload mode.
+    # For larger files, uses large file upload mode.
     #
     # Unfinished download is stored as +target_name.incomplete+ and renamed upon completion.
     #
     # @param filename [String] local filename you'd like to upload
-    # @param overwrite [Boolean] whether to overwrite remote file, or rename this
+    # @param overwrite [Boolean] whether to overwrite remote file, or not
+    #   If false:
+    #   For larger files, it renames the uploaded file
+    #   For small files, it skips the file
+    #   Always check existence beforehand if you need consistant behavior
     # @param fragment_size [Integer] fragment size for each upload session, recommended to be multiple of 320KiB
     # @param chunk_size [Integer] IO size for each disk read request and progress notification
     # @param target_name [String] desired remote filename, a relative path to current directory
+    # @return [OneDriveFile,nil] uploaded file
     #
     # @yield [event, status] for receive progress notification
     # @yieldparam event [Symbol] event of this notification
     # @yieldparam status [{Symbol => String,Integer}] details
     def upload(filename, overwrite: false, fragment_size: 41_943_040, chunk_size: 1_048_576, target_name: nil, &block)
       raise ArgumentError.new('File not found') unless File.exist?(filename)
+      conn = nil
       file_size = File.size(filename)
+      target_name ||= File.basename(filename)
+      return upload_simple(filename, overwrite: overwrite, target_name: target_name) if file_size <= 4_096_000
+
       resume_file = "#{filename}.1drv_upload"
       resume_session = JSON.parse(File.read(resume_file)) rescue nil if File.exist?(resume_file)
 
-      if resume_session && resume_session['session_url']
-        conn = Excon.new(resume_session['session_url'])
-        result = JSON.parse(conn.get.body)
-        resume_position = result.dig('nextExpectedRanges', 0)&.split('-')&.first&.to_i or resume_session = nil
-      end
+      result = nil
+      loop do
+        catch :restart do
+          if resume_session && resume_session['session_url']
+            conn = Excon.new(resume_session['session_url'], idempotent: true)
+            loop do
+              result = JSON.parse(conn.get.body)
+              break unless result.dig('error', 'code') == 'accessDenied'
+              sleep 5
+            end
+            resume_position = result.dig('nextExpectedRanges', 0)&.split('-')&.first&.to_i or resume_session = nil
+          end
 
-      resume_position ||= 0
+          resume_position ||= 0
 
-      if resume_session
-        file_size == resume_session['source_size'] or resume_session = nil
-      end
+          if resume_session
+            file_size == resume_session['source_size'] or resume_session = nil
+          end
 
-      unless resume_session
-        target_name ||= File.basename(filename)
-        result = @od.request("drive/items/#{@id}:/#{target_name}:/createUploadSession", item: {'@microsoft.graph.conflictBehavior': overwrite ? 'replace' : 'rename'})
-        resume_session = {
-          'session_url' => result['uploadUrl'],
-          'source_size' => File.size(filename),
-          'fragment_size' => fragment_size
-        }
-        File.write(resume_file, JSON.pretty_generate(resume_session))
-      end
+          unless resume_session
+            result = @od.request("#{api_path}:/#{target_name}:/createUploadSession", item: {'@microsoft.graph.conflictBehavior': overwrite ? 'replace' : 'rename'})
+            resume_session = {
+              'session_url' => result['uploadUrl'],
+              'source_size' => File.size(filename),
+              'fragment_size' => fragment_size
+            }
+            File.write(resume_file, JSON.pretty_generate(resume_session))
+            conn = Excon.new(resume_session['session_url'], idempotent: true)
+          end
 
-      new_file = nil
-      File.open(filename, mode: 'rb', external_encoding: Encoding::BINARY) do |f|
-        resume_position.step(file_size, resume_session['fragment_size']) do |from|
-          to = [from + resume_session['fragment_size'], file_size].min - 1
-          len = to - from + 1
-          headers = {
-            'Content-Length': len.to_s,
-            'Content-Range': "bytes #{from}-#{to}/#{file_size}"
-          }
-          @od.logger.info "Uploading #{from}-#{to}/#{file_size}"
-          yield :new_segment, file: filename, from: from, to: to if block_given?
-          sliced_io = SlicedIO.new(f, from, to) do |progress, total|
-            yield :progress, file: filename, from: from, to: to, progress: progress, total: total if block_given?
+          new_file = nil
+          File.open(filename, mode: 'rb', external_encoding: Encoding::BINARY) do |f|
+            resume_position.step(file_size - 1, resume_session['fragment_size']) do |from|
+              to = [from + resume_session['fragment_size'], file_size].min - 1
+              len = to - from + 1
+              headers = {
+                'Content-Length': len.to_s,
+                'Content-Range': "bytes #{from}-#{to}/#{file_size}"
+              }
+              @od.logger.info "Uploading #{from}-#{to}/#{file_size}" if @od.logger
+              yield :new_segment, file: filename, from: from, to: to if block_given?
+              sliced_io = SlicedIO.new(f, from, to) do |progress, total|
+                yield :progress, file: filename, from: from, to: to, progress: progress, total: total if block_given?
+              end
+              begin
+                result = conn.put headers: headers, chunk_size: chunk_size, body: sliced_io, read_timeout: 15, write_timeout: 15, retry_limit: 2
+                raise IOError if result.body.include? 'accessDenied'
+              rescue Excon::Error::Timeout, IOError
+                conn = Excon.new(resume_session['session_url'], idempotent: true)
+                yield :retry, file: filename, from: from, to: to if block_given?
+                sleep 60
+                retry
+              end
+              yield :finish_segment, file: filename, from: from, to: to if block_given?
+              throw :restart if result.body.include?('</html>')
+              result = JSON.parse(result.body)
+              new_file = OneDriveFile.new(@od, result) if result.dig('file')
+            end
           end
-          result = conn.put headers: headers, chunk_size: chunk_size, body: sliced_io
-          yield :finish_segment, file: filename, from: from, to: to if block_given?
-          result = JSON.parse(result.body)
-          new_file = OneDriveFile.new(@od, result) if result.dig('file')
+          throw :restart unless new_file&.file?
+          File.unlink(resume_file)
+          return set_mtime(new_file, File.mtime(filename))
         end
-        File.unlink(resume_file)
+        # catch :restart here
+        sleep 60 # and retry the whole process
       end
-      new_file
+    end
+
+    # Uploads a local file into current remote directory using simple upload mode.
+    #
+    # @return [OneDriveFile,nil] uploaded file
+    def upload_simple(filename, overwrite:, target_name:)
+      target_file = get(filename)
+      exist = target_file.file?
+      return if exist && !overwrite
+      path = nil
+      if exist
+        path = "#{target_file.api_path}/content"
+      else
+        path = "#{api_path}:/#{target_name}:/content"
+      end
+
+      query = {
+        path: File.join('v1.0/me/', path),
+        headers: {
+          'Authorization': "Bearer #{@od.access_token.token}",
+          'Content-Type': 'application/octet-stream'
+        },
+        body: File.read(filename)
+      }
+      result = @od.conn.put(query)
+      result = JSON.parse(result.body)
+      file = OneDriveFile.new(@od, result)
+      set_mtime(file, File.mtime(filename))
+    end
+
+    def set_mtime(file, time)
+      OneDriveFile.new(@od, @od.request(file.api_path, {fileSystemInfo: {lastModifiedDateTime: time.utc.iso8601}}, :patch))
     end
   end
 end

data/lib/rb1drv/onedrive_item.rb

@@ -1,24 +1,41 @@
 module Rb1drv
   class OneDriveItem
-    attr_reader :id, :name, :eTag, :size, :mtime, :ctime, :muser, :cuser, :parent_path
+    attr_reader :id, :name, :eTag, :size, :mtime, :ctime, :muser, :cuser, :parent_path, :remote_id, :remote_drive_id
     protected
     def initialize(od, api_hash)
+      raise api_hash.inspect unless api_hash['createdDateTime']
       @od = od
       %w(id name eTag size).each do |key|
         instance_variable_set("@#{key}", api_hash[key])
       end
-      @mtime = Time.iso8601(api_hash.dig('lastModifiedDateTime'))
-      @ctime = Time.iso8601(api_hash.dig('createdDateTime'))
+      @remote_drive_id = api_hash.dig('remoteItem', 'parentReference', 'driveId')
+      @remote_id = api_hash.dig('remoteItem', 'id')
+      @mtime = Time.iso8601(api_hash['lastModifiedDateTime'])
+      @ctime = Time.iso8601(api_hash['createdDateTime'])
       @muser = api_hash.dig('lastModifiedBy', 'user', 'displayName') || 'N/A'
       @cuser = api_hash.dig('createdBy', 'user', 'displayName') || 'N/A'
       @parent_path = api_hash.dig('parentReference', 'path')
+      @remote = api_hash.has_key?('remoteItem')
     end
 
     # Create subclass instance by checking the item type
     #
     # @return [OneDriveFile, OneDriveDir] instanciated drive item
     def self.smart_new(od, item_hash)
-      item_hash['file'] ? OneDriveFile.new(od, item_hash) : OneDriveDir.new(od, item_hash)
+      if item_hash['remoteItem']
+        item_hash['remoteItem'].each do |key, value|
+          item_hash[key] ||= value
+        end
+      end
+      if item_hash['file']
+        OneDriveFile.new(od, item_hash)
+      elsif item_hash['folder']
+        OneDriveDir.new(od, item_hash)
+      elsif item_hash.dig('error', 'code') == 'itemNotFound'
+        OneDrive404.new
+      else
+        item_hash
+      end
     end
 
     # @return [String] absolute path of current item
@@ -29,5 +46,23 @@ module Rb1drv
         @name
       end
     end
+
+    # TODO: API endpoint does not play well with remote files
+    #
+    # @return [String] api reference path of current object
+    def api_path
+      if remote?
+        "drives/#{@remote_drive_id}/items/#{@remote_id}"
+      else
+        "drive/items/#{@id}"
+      end
+    end
+
+    # TODO: API endpoint does not play well with remote files
+    #
+    # @return [Boolean] whether it's shared by others
+    def remote?
+      @remote
+    end
   end
 end

data/lib/rb1drv/sliced_io.rb

@@ -5,11 +5,11 @@ class SlicedIO
     @from = from
     @to = to
     @block = block
-    @current = 0
+    rewind
   end
 
   def rewind
-    io.seek(from)
+    @io.seek(@from)
     @current = 0
   end
 
@@ -19,10 +19,19 @@ class SlicedIO
 
   def read(len)
     return nil if @current >= size
-    len = [len, @to - @current + 1].min
+    len = [len, size - @current].min
     # Notify before we read
     @block.call(@current, size)
-    @io.read(len)
+    failed_count = 0
+    begin
+      @io.read(len)
+    rescue Errno::EIO
+      @io.seek(@from + @current)
+      sleep 1
+      failed_count += 1
+      retry unless failed_count > 5
+      raise
+    end
   ensure
     @current += len
   end

data/lib/rb1drv/version.rb

@@ -1,3 +1,3 @@
 module Rb1drv
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/rb1drv.rb

@@ -7,9 +7,9 @@ module Rb1drv
   #
   # Call +#root+ or +#get+ to get an +OneDriveDir+ or +OneDriveFile+ to wotk with.
   class OneDrive
-    attr_reader :oauth2_client, :logger, :access_token
+    attr_reader :oauth2_client, :logger, :access_token, :conn
     # Instanciates with app id and secret.
-    def initialize(client_id, client_secret, callback_url, logger=Logger.new(STDERR))
+    def initialize(client_id, client_secret, callback_url, logger=nil)
       @client_id = client_id
       @client_secret = client_secret
       @callback_url = callback_url
@@ -17,8 +17,8 @@ module Rb1drv
       @oauth2_client = OAuth2::Client.new client_id, client_secret,
         authorize_url: 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize',
         token_url: 'https://login.microsoftonline.com/common/oauth2/v2.0/token'
-      @conn = Excon.new('https://graph.microsoft.com/', persistent: true)
-      @conn.logger = @logger
+      @conn = Excon.new('https://graph.microsoft.com/', persistent: true, idempotent: true)
+      @conn.logger = @logger if @logger
     end
 
     # Issues requests to API endpoint.
@@ -29,9 +29,10 @@ module Rb1drv
     #
     # @return [Hash] response from API.
     def request(uri, data=nil, verb=:post)
-      @logger.info(uri)
+      @logger.info(uri) if @logger
+      auth_check
       query = {
-        path: File.join('v1.0/me/', uri),
+        path: File.join('v1.0/me/', URI.escape(uri)),
         headers: {
           'Authorization': "Bearer #{@access_token.token}"
         }
@@ -39,8 +40,8 @@ module Rb1drv
       if data
         query[:body] = JSON.generate(data)
         query[:headers]['Content-Type'] = 'application/json'
-        @logger.info(query[:body])
-        verb = :post unless [:post, :put, :delete].include?(verb)
+        @logger.info(query[:body]) if @logger
+        verb = :post unless [:post, :put, :patch, :delete].include?(verb)
         response = @conn.send(verb, query)
       else
         response = @conn.get(query)
@@ -55,3 +56,4 @@ require 'rb1drv/onedrive'
 require 'rb1drv/onedrive_item'
 require 'rb1drv/onedrive_dir'
 require 'rb1drv/onedrive_file'
+require 'rb1drv/onedrive_404'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb1drv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Xinyue Lu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -82,6 +82,7 @@ files:
 - lib/rb1drv.rb
 - lib/rb1drv/auth.rb
 - lib/rb1drv/onedrive.rb
+- lib/rb1drv/onedrive_404.rb
 - lib/rb1drv/onedrive_dir.rb
 - lib/rb1drv/onedrive_file.rb
 - lib/rb1drv/onedrive_item.rb