rb1drv 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: feafbb64ce01c80b2c8f55c4d62dbed44aa6bca0d908965d94700a01def35f8a
+  data.tar.gz: 1b31de1595f55f7ecc4f40da51979a87fc72cb0ee6602768af2a6f7a08319661
+SHA512:
+  metadata.gz: 9a09646c4cbb6c1afc6e65f7bf2332865a5eae3afe32028b053908c21bacbeec8338e6b31f47176632c6939502971e9962627602528fd6f9eb68765ab9ebeaa2
+  data.tar.gz: 37cf356d74830003591bf77c5d3328d354cdfdd46f112b31fddf7baaf029f9ca23318cf782a1a228fd2c4e9842971fcef7f38d39bea5151fb4afb38f64321b31

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+script: bundle exec ruby -I lib lib/rb1drv.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    rb1drv (0.1.1)
+      excon (~> 0.62)
+      oauth2 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    excon (0.62.0)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    jwt (1.5.6)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.5)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rb1drv!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Xinyue Lu
+
+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,78 @@
+# Rb1drv
+
+[![Build Status](https://travis-ci.org/msg7086/rb1drv.svg?branch=master)](https://travis-ci.org/msg7086/rb1drv)
+
+Rb1drv is a Ruby SDK for Microsoft OneDrive service, providing a simple interface to access files inside OneDrive.
+
+Rb1drv allows you to list directories, upload or download files, etc.
+
+To use the command line application, install [`rb1drv-tools`](https://github.com/msg7086/rb1drv-tools) gem instead.
+
+Further functionalities can be added to the library upon requests.
+
+Rb1drv uses the latest Microsoft OAuth2 + Graph API at the time it is written, while there are not many other libraries available for reference (e.g. official OneDrive SDK still uses old OAuth2 API instead of new OAuth2 v2.0 API). Feel free to take this as an unoffical reference implementation and write your own SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb1drv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb1drv
+
+## Usage
+
+You will have to register a new application on Microsoft Application Registration Portal before using the API.
+Read more at [OneDrive API Docs](https://github.com/OneDrive/onedrive-api-docs/blob/live/docs/rest-api/getting-started/graph-oauth.md).
+
+    od = OneDrive.new('a2b3c4d5-your-app-id', 'C8V3{your-app-secret(', 'https://your-callback/url')
+
+To start using `OneDrive` library, instanciate the class with your application information.
+
+---
+
+    od.root
+    od.get('/Folder1')
+    od.get('/File1.avi')
+
+Use `OneDrive#root` or `OneDrive#get` to get a drive item.
+
+---
+
+    od.root.children
+    od.root.children.grep(OneDriveDir)
+
+Use `OneDriveDir#children` to get contents of a directory.
+
+---
+
+    od.get('/File1.avi').save_as('/tmp/test.avi', overwrite: true) do |event, stat|
+      puts "Downloaded #{stat[:progress]} of #{stat[:total]}" if event == :progress
+    end
+
+Use `OneDriveFile#save_as` to download a file.
+
+---
+
+    od.get('/Folder1').upload('/tmp/test.avi', overwrite: true, target_name: 'party.avi') do |event, stat|
+      puts "Uploading #{stat[:progress]} of #{stat[:total]} for segment #{stat[:from]}-#{stat[:to]}" if event == :progress
+      puts "Uploaded segment #{stat[:from]}-#{stat[:to]}" if event == :finish_segment
+    end
+
+Use `OneDriveDir#upload` to upload a file to target directory.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msg7086/rb1drv.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rb1drv/auth.rb

@@ -0,0 +1,29 @@
+module Rb1drv
+  class OneDrive
+    # Gets authorize URL to start authentication process
+    #
+    # @return [String] the authorize URL
+    def auth_url
+      @oauth2_client.auth_code.authorize_url(
+        redirect_uri: @callback_url,
+        scope: 'openid offline_access https://graph.microsoft.com/Files.ReadWrite.All'
+      )
+    end
+
+    # Gets access token from authorize code
+    #
+    # @return [OAuth2::AccessToken] the access token
+    def auth_access(auth_code)
+      @access_token = @oauth2_client.auth_code.get_token(auth_code, redirect_uri: @callback_url)
+    end
+
+    # Loads previously retrieved access token from Hash
+    #
+    # @return [OAuth2::AccessToken] the access token
+    def auth_load(access_token)
+      @access_token = OAuth2::AccessToken.from_hash(@oauth2_client, access_token)
+      @access_token = @access_token.refresh! if @access_token.expired?
+      @access_token
+    end
+  end
+end

data/lib/rb1drv/onedrive.rb

@@ -0,0 +1,18 @@
+module Rb1drv
+  class OneDrive
+    # Get root directory object.
+    #
+    # @return [OneDriveDir] your root
+    def root
+      @_root_dir ||= OneDriveDir.new(self, request('drive/root'))
+    end
+
+    # Get an object by an arbitary path.
+    #
+    # @return [OneDriveDir,OneDriveFile] the drive item you asked
+    def get(path)
+      path = "/#{path}" unless path[0] == '/'
+      OneDriveItem.smart_new(self, request("drive/root:#{path}"))
+    end
+  end
+end

data/lib/rb1drv/onedrive_dir.rb

@@ -0,0 +1,136 @@
+require 'rb1drv/sliced_io'
+
+module Rb1drv
+  class OneDriveDir < OneDriveItem
+    attr_reader :child_count
+    def initialize(od, api_hash)
+      super
+      @child_count = api_hash.dig('folder', 'childCount')
+    end
+
+    # Lists contents of current directory.
+    #
+    # @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|
+        OneDriveItem.smart_new(@od, child)
+      end
+    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
+    def get(path)
+      path = "/#{path}" unless path[0] == '/'
+      OneDriveItem.smart_new(self, @od.request("drive/items/#{@id}:#{path}"))
+    end
+
+    # Yes
+    def dir?
+      true
+    end
+
+    # No
+    def file?
+      false
+    end
+
+    # @return [String] absolute path of current item
+    def absolute_path
+      if @parent_path
+        File.join(@parent_path, @name)
+      else
+        '/'
+      end
+    end
+
+    # Recursively creates empty directories.
+    #
+    # @param name [String] directories you'd like to create
+    # @return [OneDriveDir] the directory you created
+    def mkdir(name)
+      newdir, *remainder = name.split('/')
+      subdir = @od.request("drive/items/#{@id}:/#{newdir}") rescue nil
+      unless subdir
+        subdir = @od.request("drive/items/#{@id}/children",
+          name: newdir,
+          folder: {},
+          '@microsoft.graph.conflictBehavior': 'rename'
+        )
+      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.
+    #
+    # 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 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
+    #
+    # @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)
+      file_size = File.size(filename)
+      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
+
+      resume_position ||= 0
+
+      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
+
+      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?
+          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')
+        end
+        File.unlink(resume_file)
+      end
+      new_file
+    end
+  end
+end

data/lib/rb1drv/onedrive_file.rb

@@ -0,0 +1,61 @@
+module Rb1drv
+  class OneDriveFile < OneDriveItem
+    attr_reader :download_url
+    def initialize(od, api_hash)
+      super
+      @download_url = api_hash.dig('@microsoft.graph.downloadUrl')
+    end
+
+    # No
+    def dir?
+      false
+    end
+
+    # Yes
+    def file?
+      true
+    end
+
+    # Saves current remote file as local file.
+    #
+    # Unfinished download is stored as +target_name.incomplete+ and renamed upon completion.
+    #
+    # @param target_name [String] desired local filename, a relative path to current directory or an absolute path
+    # @param overwrite [Boolean] whether to overwrite local file, or skip this
+    # @param resume [Boolean] whether to resume an unfinished download, or start over anyway
+    #
+    # @yield [event, status] for receive progress notification
+    # @yieldparam event [Symbol] event of this notification
+    # @yieldparam status [{Symbol => String,Integer}] details
+    def save_as(target_name=nil, overwrite: false, resume: true, &block)
+      target_name ||= @name
+      tmpfile = "#{target_name}.incomplete"
+
+      return if !overwrite && File.exist?(target_name)
+
+      if resume && File.size(tmpfile) > 0
+        from = File.size(tmpfile)
+        len = @size - from
+        fmode = 'ab'
+        headers = {
+          'Range': "bytes=#{from}-"
+        }
+      else
+        from = 0
+        len = @size
+        fmode = 'wb'
+        headers = {}
+      end
+
+      yield :new_segment, file: target_name, from: from if block_given?
+      File.open(tmpfile, mode: fmode, external_encoding: Encoding::BINARY) do |f|
+        Excon.get download_url, headers: headers, response_block: ->(chunk, remaining_bytes, total_bytes) do
+          f.write(chunk)
+          yield :progress, file: target_name, from: from, progress: total_bytes - remaining_bytes, total: total_bytes if block_given?
+        end
+      end
+      yield :finish_segment, file: target_name if block_given?
+      FileUtils.mv(tmpfile, filename)
+    end
+  end
+end

data/lib/rb1drv/onedrive_item.rb

@@ -0,0 +1,33 @@
+module Rb1drv
+  class OneDriveItem
+    attr_reader :id, :name, :eTag, :size, :mtime, :ctime, :muser, :cuser, :parent_path
+    protected
+    def initialize(od, api_hash)
+      @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'))
+      @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')
+    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)
+    end
+
+    # @return [String] absolute path of current item
+    def absolute_path
+      if @parent_path
+        File.join(@parent_path, @name)
+      else
+        @name
+      end
+    end
+  end
+end

data/lib/rb1drv/sliced_io.rb

@@ -0,0 +1,29 @@
+# SlicedIO slices a large File into a small portion.
+class SlicedIO
+  def initialize(io, from, to, &block)
+    @io = io
+    @from = from
+    @to = to
+    @block = block
+    @current = 0
+  end
+
+  def rewind
+    io.seek(from)
+    @current = 0
+  end
+
+  def size
+    @size ||= @to - @from + 1
+  end
+
+  def read(len)
+    return nil if @current >= size
+    len = [len, @to - @current + 1].min
+    # Notify before we read
+    @block.call(@current, size)
+    @io.read(len)
+  ensure
+    @current += len
+  end
+end

data/lib/rb1drv/version.rb

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

data/lib/rb1drv.rb

@@ -0,0 +1,57 @@
+require 'excon'
+require 'oauth2'
+require "rb1drv/version"
+
+module Rb1drv
+  # Base class to support oauth2 authentication and sending simple API requests.
+  #
+  # Call +#root+ or +#get+ to get an +OneDriveDir+ or +OneDriveFile+ to wotk with.
+  class OneDrive
+    attr_reader :oauth2_client, :logger, :access_token
+    # Instanciates with app id and secret.
+    def initialize(client_id, client_secret, callback_url, logger=Logger.new(STDERR))
+      @client_id = client_id
+      @client_secret = client_secret
+      @callback_url = callback_url
+      @logger =  logger
+      @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
+    end
+
+    # Issues requests to API endpoint.
+    #
+    # @param uri [String] relative path of the API
+    # @param data [Hash] JSON data to be post
+    # @param verb [Symbol] HTTP request verb if data is given
+    #
+    # @return [Hash] response from API.
+    def request(uri, data=nil, verb=:post)
+      @logger.info(uri)
+      query = {
+        path: File.join('v1.0/me/', uri),
+        headers: {
+          'Authorization': "Bearer #{@access_token.token}"
+        }
+      }
+      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)
+        response = @conn.send(verb, query)
+      else
+        response = @conn.get(query)
+      end
+      JSON.parse(response.body)
+    end
+  end
+end
+
+require 'rb1drv/auth'
+require 'rb1drv/onedrive'
+require 'rb1drv/onedrive_item'
+require 'rb1drv/onedrive_dir'
+require 'rb1drv/onedrive_file'

data/rb1drv.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rb1drv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rb1drv"
+  spec.version       = Rb1drv::VERSION
+  spec.authors       = ["Xinyue Lu"]
+  spec.email         = ["i@7086.in"]
+
+  spec.summary       = "Ruby OneDrive Library"
+  spec.homepage      = "https://github.com/msg7086/rb1drv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_dependency "oauth2", "~> 1.4"
+  spec.add_dependency "excon", "~> 0.62"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rb1drv
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Xinyue Lu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- i@7086.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/rb1drv.rb
+- lib/rb1drv/auth.rb
+- lib/rb1drv/onedrive.rb
+- lib/rb1drv/onedrive_dir.rb
+- lib/rb1drv/onedrive_file.rb
+- lib/rb1drv/onedrive_item.rb
+- lib/rb1drv/sliced_io.rb
+- lib/rb1drv/version.rb
+- rb1drv.gemspec
+homepage: https://github.com/msg7086/rb1drv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby OneDrive Library
+test_files: []