alipan-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 391e43dcbc839df82035ba6a730fe7d274054d5fa8147fc8742847668cca0b46
+  data.tar.gz: 96afad1647af9260c3340f6bd9ecde58c593db444ad0cce301e0e1285dc0124f
+SHA512:
+  metadata.gz: 95e7da78fb03144dc9c1b26843b0e0d8733391b1ee28a6dbb363964cc39257d1d07ffc5ecbe575cedc4eb46e695ea088791d5275f1d4be0c9fa7e00e0ebbbcb2
+  data.tar.gz: '08f4d6470a21d3f7ec5f5e8e37ea45c52834a3baf8c7953715ee8d190114a5fb6d7244737c7f3be9d640f110c76795b78812e35adf6740a56a764234fb08f18f'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 freeshenls
+
+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,39 @@
+# Alipan SDK for Ruby
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/alipan`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/alipan.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/alipan/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Alipan
+	class Client
+		
+		def initialize(opts)
+			fail ArgumentError, "Argument access_token must be provided" unless opts[:access_token]
+
+			@config = Config.new(opts)
+			@protocol = Protocol.new(@config)
+		end
+
+		def get_drive(opts = {})
+			@protocol.get_drive
+		end
+	end
+end

data/lib/alipan/common/logging.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Alipan
+	module Common
+		module Logging
+			
+			MAX_NUM_LOG = 100
+      ROTATE_SIZE = 10 * 1024 * 1024
+
+			# level = Logger::DEBUG | Logger::INFO | Logger::ERROR | Logger::FATAL
+      def self.set_log_level(level)
+        Logging.logger.level = level
+      end
+
+      def self.set_log_file(file)
+        @log_file = file
+      end
+
+      def logger
+        Logging.logger
+      end
+
+			private
+
+      def self.logger
+        unless @logger
+          # Environment parameter ALIPAN_SDK_LOG_PATH used to set output log to a file,do not output log if not set
+          @log_file ||= ENV["ALIPAN_SDK_LOG_PATH"]
+          @logger = Logger.new(
+              @log_file, MAX_NUM_LOG, ROTATE_SIZE)
+          @logger.level = get_env_log_level || Logger::INFO
+        end
+        @logger
+      end
+
+      def self.get_env_log_level
+        return unless ENV["ALIPAN_SDK_LOG_LEVEL"]
+        case ENV["ALIPAN_SDK_LOG_LEVEL"].upcase
+        when "DEBUG"
+          Logger::DEBUG
+        when "WARN"
+          Logger::WARN
+        when "ERROR"
+          Logger::ERROR
+        when "FATAL"
+          Logger::FATAL
+        when "UNKNOWN"
+          Logger::UNKNOWN
+        end
+      end
+		end
+	end
+end

data/lib/alipan/common/struct.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Alipan
+	module Common
+		class Struct
+			
+			def self.attrs(*s)
+				define_method(:attrs) {s}
+				attr_reader(*s)
+			end
+
+			def initialize(opts = {})
+	      extra_keys = opts.keys - attrs
+	      unless extra_keys.empty?
+	        fail NameError,
+	             "Unexpected extra keys: #{extra_keys.join(', ')}"
+	      end
+
+	      attrs.each do |attr|
+	        instance_variable_set("@#{attr}", opts[attr])
+	      end
+	    end
+		end
+	end
+end

data/lib/alipan/common.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "common/struct"
+require_relative "common/logging"

data/lib/alipan/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Alipan
+	class Config < Alipan::Common::Struct
+
+		attrs :access_token, :open_timeout, :read_timeout
+
+		def initialize(opts = {})
+			super(opts)
+
+			@access_token = @access_token.strip if @access_token
+		end
+	end
+end

data/lib/alipan/drive.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Alipan
+	class Drive < Common::Struct
+		
+		attrs :user_id, :name, :avatar, :default_drive_id, :resource_drive_id, :backup_drive_id, :folder_id
+
+		def initialize(opts = {}, protocol = nil)
+			super(opts)
+			@protocol = protocol
+		end
+
+		def list_objects(opts = {})
+			Iterator::Objects.new(@protocol, resource_drive_id, 'root', opts).to_enum
+		end
+	end
+end

data/lib/alipan/http.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module Alipan
+	class HTTP
+		
+		DEFAULT_CONTENT_TYPE = 'application/json'
+		AUTH_HEADER = 'Authorization'
+		OPEN_TIMEOUT = 10
+		READ_TIMEOUT = 120
+
+		include Common::Logging
+
+		def initialize(config)
+			@config = config
+    end
+
+		def get(resources = {}, http_options = {}, &block)
+      do_request('GET', resources, http_options, &block)
+    end
+
+    def put(resources = {}, http_options = {}, &block)
+      do_request('PUT', resources, http_options, &block)
+    end
+
+    def post(resources = {}, http_options = {}, &block)
+      do_request('POST', resources, http_options, &block)
+    end
+
+    def delete(resources = {}, http_options = {}, &block)
+      do_request('DELETE', resources, http_options, &block)
+    end
+
+    def head(resources = {}, http_options = {}, &block)
+      do_request('HEAD', resources, http_options, &block)
+    end
+
+    def options(resources = {}, http_options = {}, &block)
+      do_request('OPTIONS', resources, http_options, &block)
+    end
+
+    private
+
+    def do_request(verb, resources = {}, http_options = {}, &block)
+    	sub_res = resources[:sub_res]
+
+      headers = http_options[:headers] || {}
+      headers['Content-Type'] ||= DEFAULT_CONTENT_TYPE
+      headers[AUTH_HEADER] = @config.access_token if @config.access_token
+
+      logger.debug("Send HTTP request, verb: #{verb}, resources: " \
+                    "#{resources}, http options: #{http_options}")
+
+      block_response = ->(r) { handle_response(r, &block) } if block
+      request = RestClient::Request.new(
+        :method => verb,
+        :url => "https://open.aliyundrive.com#{sub_res}",
+        :headers => headers,
+        :payload => http_options[:body],
+        :block_response => block_response,
+        :open_timeout => @config.open_timeout  || OPEN_TIMEOUT,
+        :read_timeout => @config.read_timeout || READ_TIMEOUT
+      )
+      response = request.execute do |resp, &blk|
+        if resp.code >= 300
+          logger.error(e.to_s)
+          raise e
+        else
+          resp.return!(&blk)
+        end
+      end
+
+      logger.debug("Received HTTP response, code: #{response.code}, headers: " \
+                    "#{response.headers}, body: #{response.body}")
+
+      response
+    end
+	end
+end

data/lib/alipan/iterator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Alipan
+  module Iterator
+    class Base
+      
+      def initialize(protocol, opts = {})
+        @protocol = protocol
+        @results, @more = [], opts
+      end
+
+      def next
+        loop do
+          fetch_more if @results.empty?
+
+          r = @results.shift
+          break unless r
+
+          yield r
+        end
+      end
+
+      def to_enum
+        self.enum_for(:next)
+      end
+
+      private
+      def fetch_more
+        return if @more[:truncated] == false
+        fetch(@more)
+      end
+    end
+
+    class Objects < Base
+      def initialize(protocol, drive_id, parent_file_id, opts = {})
+        super(protocol, opts)
+        @drive_id = drive_id
+        @parent_file_id = parent_file_id
+      end
+
+      def fetch(more)
+        @results, cont = @protocol.list_objects(@drive_id, @parent_file_id, more)
+        @more[:marker] = cont[:marker]
+        @more[:truncated] = !cont[:marker].empty?
+      end
+    end
+  end
+end

data/lib/alipan/object.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Alipan
+	class Object < Common::Struct
+		
+		attrs :drive_id, :file_id, :parent_file_id,
+		:name, :size, :file_extension, :content_hash, 
+		:category, :type, :thumbnail, :url, :created_at, 
+		:updated_at, :play_cursor, :video_media_metadata, 
+		:video_preview_metadata
+
+		def initialize(opts = {}, protocol = nil)
+			super(opts)
+			@protocol = protocol
+		end
+	end
+end

data/lib/alipan/protocol.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Alipan
+	class Protocol
+		include Common::Logging
+
+		def initialize(config)
+			@config = config
+			@http = HTTP.new(config)
+		end
+
+		def get_drive(opts = {})
+			logger.info("Begin get drive, options: #{opts}")
+
+			r = @http.post( {:sub_res => "/adrive/v1.0/user/getDriveInfo"}, {})
+			body = JSON.parse(r.body)
+
+			drive = Drive.new(
+			{
+				:user_id => body.fetch(:user_id.to_s),
+				:name => body.fetch(:name.to_s),
+				:avatar => body.fetch(:avatar.to_s),
+				:default_drive_id => body.fetch(:default_drive_id.to_s),
+				:resource_drive_id => body.fetch(:resource_drive_id.to_s),
+				:backup_drive_id => body.fetch(:backup_drive_id.to_s),
+				:folder_id => body.fetch(:folder_id.to_s)
+			}, self)
+			logger.info("Done get drive, drive: #{drive}")
+
+			drive
+		end
+
+		def list_objects(drive_id, parent_file_id, opts = {})
+			logger.info("Begin list objects, options: #{opts}")
+
+			payload = {
+				:drive_id => drive_id,
+				:parent_file_id => parent_file_id,
+				:marker => opts[:marker]
+			}
+
+			r = @http.post( {:sub_res => "/adrive/v1.0/openFile/list"}, {:body => payload.to_json})
+			body = JSON.parse(r.body)
+
+			objects = body[:items.to_s].map do |item|
+				Object.new(item, self)
+			end
+
+			more = {
+				:marker => body[:next_marker.to_s]
+			}
+
+			logger.debug("Done list object. objects: #{objects}, more: #{more}")
+
+			[objects, more]
+		end
+	end
+end

data/lib/alipan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Alipan
+  VERSION = "0.1.0"
+end

data/lib/alipan.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'pry'
+require_relative "alipan/common"
+require_relative "alipan/config"
+require_relative "alipan/client"
+require_relative "alipan/http"
+require_relative "alipan/protocol"
+require_relative "alipan/iterator"
+require_relative "alipan/drive"
+require_relative "alipan/object"

data/sig/alipan.rbs

@@ -0,0 +1,4 @@
+module Alipan
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: alipan-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- freeshenls
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A Ruby program to facilitate accessing Alipan Service
+email:
+- freeshenls@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/alipan.rb
+- lib/alipan/client.rb
+- lib/alipan/common.rb
+- lib/alipan/common/logging.rb
+- lib/alipan/common/struct.rb
+- lib/alipan/config.rb
+- lib/alipan/drive.rb
+- lib/alipan/http.rb
+- lib/alipan/iterator.rb
+- lib/alipan/object.rb
+- lib/alipan/protocol.rb
+- lib/alipan/version.rb
+- sig/alipan.rbs
+homepage: https://github.com/freeshenls/alipan-ruby-sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/freeshenls/alipan-ruby-sdk
+  source_code_uri: https://github.com/freeshenls/alipan-ruby-sdk
+  changelog_uri: https://github.com/freeshenls/alipan-ruby-sdk/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Alipan SDK for Ruby
+test_files: []