opendal 0.1.6.pre.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d983d275e4439666d0743b2b7235ff1de73e69c1ddfe7662bb2a5c55a2c34b03
+  data.tar.gz: 52ad8a29ed29dba8ec832588066400de35d1c7a83979c70a4e61ed88aee27436
+SHA512:
+  metadata.gz: acf47f94f8392c5e6766f690059dbe7f3b9822959f3fc17de7f63cd0ad12ee3cdd9e74149cf42585a12637525e250b3a8709d840d931c89654b977d9fb0f9156
+  data.tar.gz: c5738ac2a54a2db90929bc72f0a31e9e64e6e2a08de9fbe0a8cbc9193e3280f8ac45116826279ca8bd6d966a8f71e2cf258e7e36a6ecc2a7ddb3fbeefe8d8362

data/.standard.yml

@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Cargo.toml

@@ -0,0 +1,65 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[package]
+name = "opendal-ruby"
+publish = false
+
+authors = ["Apache OpenDAL <dev@opendal.apache.org>"]
+edition = "2021"
+homepage = "https://opendal.apache.org/"
+license = "Apache-2.0"
+repository = "https://github.com/apache/opendal"
+rust-version = "1.82"
+version = "0.1.6-rc.1"
+
+[lib]
+crate-type = ["cdylib"]
+doc = false
+name = "opendal_ruby"
+
+[dependencies]
+magnus = { version = "0.8", features = ["bytes", "io"] }
+# 1. this crate won't be published, we always use the local version
+# 2. we use the symbolink to allow released gem to find core's source files.
+opendal = { version = ">=0", path = "./core", features = [
+  "blocking",
+  "layers-throttle",
+  # These are default features before v0.46. TODO: change to optional features
+  "services-azblob",
+  "services-azdls",
+  "services-cos",
+  "services-fs",
+  "services-gcs",
+  "services-ghac",
+  "services-http",
+  "services-ipmfs",
+  "services-memory",
+  "services-obs",
+  "services-oss",
+  "services-s3",
+  "services-webdav",
+  "services-webhdfs",
+  "services-azfile",
+] }
+rb-sys = { version = "0.9.110", default-features = false }
+# should be in sync with opendal
+bytes = "1.6"
+tokio = { version = "1", features = ["full"] }
+
+[build-dependencies]
+rb-sys-env = "0.1.2"

data/DEPENDENCIES.md

@@ -0,0 +1,9 @@
+# Dependencies
+
+## Rust Part Dependencies
+
+Refer to [DEPENDENCIES.rust.tsv](DEPENDENCIES.rust.tsv) for the full list.
+
+## Ruby Part Dependencies
+
+No extra runtime dependencies.

data/DEPENDENCIES.rust.tsv

@@ -0,0 +1,277 @@
+crate	0BSD	Apache-2.0	Apache-2.0 WITH LLVM-exception	BSD-2-Clause	BSD-3-Clause	BSL-1.0	CDLA-Permissive-2.0	ISC	LGPL-2.1-or-later	MIT	Unicode-3.0	Unlicense	Zlib
+addr2line@0.24.2		X								X			
+adler2@2.0.1	X	X								X			
+aes@0.8.4		X								X			
+aho-corasick@1.1.3										X		X	
+allocator-api2@0.2.21		X								X			
+android-tzdata@0.1.1		X								X			
+android_system_properties@0.1.5		X								X			
+anyhow@1.0.98		X								X			
+async-trait@0.1.88		X								X			
+autocfg@1.5.0		X								X			
+backon@1.5.1		X											
+backtrace@0.3.75		X								X			
+base64@0.22.1		X								X			
+base64ct@1.8.0		X								X			
+bindgen@0.69.5					X								
+bitflags@2.9.1		X								X			
+block-buffer@0.10.4		X								X			
+block-padding@0.3.3		X								X			
+bumpalo@3.19.0		X								X			
+byteorder@1.5.0										X		X	
+bytes@1.10.1										X			
+cbc@0.1.2		X								X			
+cc@1.2.29		X								X			
+cexpr@0.6.0		X								X			
+cfg-if@1.0.1		X								X			
+chrono@0.4.41		X								X			
+cipher@0.4.4		X								X			
+clang-sys@1.8.1		X											
+const-oid@0.9.6		X								X			
+core-foundation-sys@0.8.7		X								X			
+cpufeatures@0.2.17		X								X			
+crc32c@0.6.8		X								X			
+crossbeam-utils@0.8.21		X								X			
+crypto-common@0.1.6		X								X			
+dashmap@6.1.0										X			
+der@0.7.10		X								X			
+deranged@0.4.0		X								X			
+digest@0.10.7		X								X			
+displaydoc@0.2.5		X								X			
+either@1.15.0		X								X			
+equivalent@1.0.2		X								X			
+fastrand@2.3.0		X								X			
+fnv@1.0.7		X								X			
+foldhash@0.1.5													X
+form_urlencoded@1.2.1		X								X			
+futures@0.3.31		X								X			
+futures-channel@0.3.31		X								X			
+futures-core@0.3.31		X								X			
+futures-io@0.3.31		X								X			
+futures-macro@0.3.31		X								X			
+futures-sink@0.3.31		X								X			
+futures-task@0.3.31		X								X			
+futures-timer@3.0.3		X								X			
+futures-util@0.3.31		X								X			
+generic-array@0.14.7										X			
+getrandom@0.2.16		X								X			
+getrandom@0.3.3		X								X			
+ghac@0.2.0		X											
+gimli@0.31.1		X								X			
+glob@0.3.2		X								X			
+gloo-timers@0.3.0		X								X			
+governor@0.10.0										X			
+hashbrown@0.14.5		X								X			
+hashbrown@0.15.4		X								X			
+hex@0.4.3		X								X			
+hmac@0.12.1		X								X			
+home@0.5.11		X								X			
+http@1.3.1		X								X			
+http-body@1.0.1										X			
+http-body-util@0.1.3										X			
+httparse@1.10.1		X								X			
+hyper@1.6.0										X			
+hyper-rustls@0.27.7		X						X		X			
+hyper-util@0.1.15										X			
+iana-time-zone@0.1.63		X								X			
+iana-time-zone-haiku@0.1.2		X								X			
+icu_collections@2.0.0											X		
+icu_locale_core@2.0.0											X		
+icu_normalizer@2.0.0											X		
+icu_normalizer_data@2.0.0											X		
+icu_properties@2.0.1											X		
+icu_properties_data@2.0.1											X		
+icu_provider@2.0.0											X		
+idna@1.0.3		X								X			
+idna_adapter@1.2.1		X								X			
+inout@0.1.4		X								X			
+io-uring@0.7.8		X								X			
+ipnet@2.11.0		X								X			
+iri-string@0.7.8		X								X			
+itertools@0.12.1		X								X			
+itertools@0.14.0		X								X			
+itoa@1.0.15		X								X			
+js-sys@0.3.77		X								X			
+jsonwebtoken@9.3.1										X			
+lazy_static@1.5.0		X								X			
+lazycell@1.3.0		X								X			
+libc@0.2.174		X								X			
+libloading@0.8.8								X					
+libm@0.2.15										X			
+litemap@0.8.0											X		
+lock_api@0.4.13		X								X			
+log@0.4.27		X								X			
+magnus@0.8.0										X			
+magnus-macros@0.8.0										X			
+md-5@0.10.6		X								X			
+memchr@2.7.5										X		X	
+minimal-lexical@0.2.1		X								X			
+miniz_oxide@0.8.9		X								X			X
+mio@1.0.4										X			
+nom@7.1.3										X			
+nonzero_ext@0.3.0		X											
+num-bigint@0.4.6		X								X			
+num-bigint-dig@0.8.4		X								X			
+num-conv@0.1.0		X								X			
+num-integer@0.1.46		X								X			
+num-iter@0.1.45		X								X			
+num-traits@0.2.19		X								X			
+object@0.36.7		X								X			
+once_cell@1.21.3		X								X			
+opendal@0.54.1		X											
+opendal-ruby@0.0.0		X											
+parking_lot@0.12.4		X								X			
+parking_lot_core@0.9.11		X								X			
+pbkdf2@0.12.2		X								X			
+pem@3.0.5										X			
+pem-rfc7468@0.7.0		X								X			
+percent-encoding@2.3.1		X								X			
+pin-project-lite@0.2.16		X								X			
+pin-utils@0.1.0		X								X			
+pkcs1@0.7.5		X								X			
+pkcs5@0.7.1		X								X			
+pkcs8@0.10.2		X								X			
+portable-atomic@1.11.1		X								X			
+potential_utf@0.1.2											X		
+powerfmt@0.2.0		X								X			
+ppv-lite86@0.2.21		X								X			
+proc-macro2@1.0.95		X								X			
+prost@0.13.5		X											
+prost-derive@0.13.5		X											
+quanta@0.12.6										X			
+quick-xml@0.37.5										X			
+quick-xml@0.38.3										X			
+quote@1.0.40		X								X			
+r-efi@5.3.0		X							X	X			
+rand@0.8.5		X								X			
+rand@0.9.1		X								X			
+rand_chacha@0.3.1		X								X			
+rand_chacha@0.9.0		X								X			
+rand_core@0.6.4		X								X			
+rand_core@0.9.3		X								X			
+raw-cpuid@11.5.0										X			
+rb-sys@0.9.116		X								X			
+rb-sys-build@0.9.116		X								X			
+rb-sys-env@0.1.2		X								X			
+rb-sys-env@0.2.2		X								X			
+redox_syscall@0.5.13										X			
+regex@1.11.1		X								X			
+regex-automata@0.4.9		X								X			
+regex-syntax@0.8.5		X								X			
+reqsign@0.16.5		X											
+reqwest@0.12.22		X								X			
+ring@0.17.14		X						X					
+rsa@0.9.8		X								X			
+rustc-demangle@0.1.25		X								X			
+rustc-hash@1.1.0		X								X			
+rustc_version@0.4.1		X								X			
+rustls@0.23.29		X						X		X			
+rustls-pki-types@1.12.0		X								X			
+rustls-webpki@0.103.4								X					
+rustversion@1.0.21		X								X			
+ryu@1.0.20		X				X							
+salsa20@0.10.2		X								X			
+scopeguard@1.2.0		X								X			
+scrypt@0.11.0		X								X			
+semver@1.0.26		X								X			
+seq-macro@0.3.6		X								X			
+serde@1.0.219		X								X			
+serde_derive@1.0.219		X								X			
+serde_json@1.0.140		X								X			
+serde_urlencoded@0.7.1		X								X			
+sha1@0.10.6		X								X			
+sha2@0.10.9		X								X			
+shell-words@1.1.0		X								X			
+shlex@1.3.0		X								X			
+signal-hook-registry@1.4.5		X								X			
+signature@2.2.0		X								X			
+simple_asn1@0.6.3								X					
+slab@0.4.10										X			
+smallvec@1.15.1		X								X			
+socket2@0.5.10		X								X			
+socket2@0.6.0		X								X			
+spin@0.9.8										X			
+spinning_top@0.3.0		X								X			
+spki@0.7.3		X								X			
+stable_deref_trait@1.2.0		X								X			
+subtle@2.6.1					X								
+syn@2.0.104		X								X			
+sync_wrapper@1.0.2		X											
+synstructure@0.13.2										X			
+thiserror@2.0.12		X								X			
+thiserror-impl@2.0.12		X								X			
+time@0.3.41		X								X			
+time-core@0.1.4		X								X			
+time-macros@0.2.22		X								X			
+tinystr@0.8.1											X		
+tokio@1.47.1										X			
+tokio-macros@2.5.0										X			
+tokio-rustls@0.26.2		X								X			
+tokio-util@0.7.15										X			
+tower@0.5.2										X			
+tower-http@0.6.6										X			
+tower-layer@0.3.3										X			
+tower-service@0.3.3										X			
+tracing@0.1.41										X			
+tracing-core@0.1.34										X			
+try-lock@0.2.5										X			
+typenum@1.18.0		X								X			
+unicode-ident@1.0.18		X								X	X		
+untrusted@0.9.0								X					
+url@2.5.4		X								X			
+utf8_iter@1.0.4		X								X			
+uuid@1.17.0		X								X			
+version_check@0.9.5		X								X			
+want@0.3.1										X			
+wasi@0.11.1+wasi-snapshot-preview1		X	X							X			
+wasi@0.14.2+wasi-0.2.4		X	X							X			
+wasm-bindgen@0.2.100		X								X			
+wasm-bindgen-backend@0.2.100		X								X			
+wasm-bindgen-futures@0.4.50		X								X			
+wasm-bindgen-macro@0.2.100		X								X			
+wasm-bindgen-macro-support@0.2.100		X								X			
+wasm-bindgen-shared@0.2.100		X								X			
+wasm-streams@0.4.2		X								X			
+web-sys@0.3.77		X								X			
+web-time@1.1.0		X								X			
+webpki-roots@1.0.1							X						
+winapi@0.3.9		X								X			
+winapi-i686-pc-windows-gnu@0.4.0		X								X			
+winapi-x86_64-pc-windows-gnu@0.4.0		X								X			
+windows-core@0.61.2		X								X			
+windows-implement@0.60.0		X								X			
+windows-interface@0.59.1		X								X			
+windows-link@0.1.3		X								X			
+windows-result@0.3.4		X								X			
+windows-strings@0.4.2		X								X			
+windows-sys@0.52.0		X								X			
+windows-sys@0.59.0		X								X			
+windows-targets@0.52.6		X								X			
+windows-targets@0.53.2		X								X			
+windows_aarch64_gnullvm@0.52.6		X								X			
+windows_aarch64_gnullvm@0.53.0		X								X			
+windows_aarch64_msvc@0.52.6		X								X			
+windows_aarch64_msvc@0.53.0		X								X			
+windows_i686_gnu@0.52.6		X								X			
+windows_i686_gnu@0.53.0		X								X			
+windows_i686_gnullvm@0.52.6		X								X			
+windows_i686_gnullvm@0.53.0		X								X			
+windows_i686_msvc@0.52.6		X								X			
+windows_i686_msvc@0.53.0		X								X			
+windows_x86_64_gnu@0.52.6		X								X			
+windows_x86_64_gnu@0.53.0		X								X			
+windows_x86_64_gnullvm@0.52.6		X								X			
+windows_x86_64_gnullvm@0.53.0		X								X			
+windows_x86_64_msvc@0.52.6		X								X			
+windows_x86_64_msvc@0.53.0		X								X			
+wit-bindgen-rt@0.39.0		X	X							X			
+writeable@0.6.1											X		
+yoke@0.8.0											X		
+yoke-derive@0.8.0											X		
+zerocopy@0.8.26		X		X						X			
+zerofrom@0.1.6											X		
+zerofrom-derive@0.1.6											X		
+zeroize@1.8.1		X								X			
+zerotrie@0.2.2											X		
+zerovec@0.11.2											X		
+zerovec-derive@0.11.1											X		

data/Gemfile

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Includes runtime dependencies from opendal.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", ">= 13.2"
+  gem "rb_sys", "~> 0.9.110" # for Makefile generation in extconf.rb
+  gem "rake-compiler", "~> 1.2.9" # to build a debug build
+  gem "minitest", "~> 5.25.0" # test library
+  gem "minitest-reporters", "~> 1.7.1" # better test output
+  gem "activesupport", "~> 8.0.1" # testing support
+  gem "standard", "~> 1.44" # linter with pre-specified rules
+  gem "redcarpet", "~> 3.6" # for documentation markdown parsing
+  gem "yard-rustdoc", "~> 0.4.1" # to generate YARD documentation from Ruby and Rust source
+end

data/README.md

@@ -0,0 +1,159 @@
+# Apache OpenDAL™ Ruby Binding
+
+[![Gem Version](https://img.shields.io/gem/v/opendal)](https://rubygems.org/gems/opendal)
+[![Gem Downloads (for latest version)](https://img.shields.io/gem/dtv/opendal)](https://rubygems.org/gems/opendal)
+
+OpenDAL's Ruby [gem](https://rubygems.org/gems/opendal).
+
+![](https://github.com/apache/opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
+
+Read OpenDAL's [ruby](https://opendal.apache.org/docs/ruby/) documentation.
+
+You can find Rust documentation [here](https://docs.rs/opendal/latest/opendal/index.html).
+
+## Get started
+
+### Installation
+
+Install gem:
+
+```shell
+bundle add opendal
+```
+
+or add it in Gemfile:
+
+```ruby
+# Gemfile
+
+source "https://rubygems.org"
+
+gem 'opendal'
+```
+
+### Examples
+
+#### File operations with an in-memory storage 
+
+```ruby
+require 'opendal'
+
+op = OpenDal::Operator.new("memory", {})
+op.write("file", "hello world")
+puts op.read("file") # => "hello world"
+puts ""
+
+puts "List:", op.list("").map { |e| e.path }
+puts ""
+
+puts "Stat"
+puts op.stat("file").inspect # => #<OpenDal::Metadata mode: File,         content_type: ,         content_length: 11>
+puts ""
+
+puts "Deleting 'file'"
+op.delete("/file")
+puts ""
+
+puts "Exist?", op.exist?("/file") # => false
+puts ""
+
+puts "Info:", op.info.inspect # => #<OpenDal::OperatorInfo scheme: "memory", root: "/">
+```
+
+#### A S3 operator
+
+```ruby
+require 'opendal'
+
+op = OpenDal::Operator.new("s3", {
+  "endpoint" => "http://localhost:9000",
+  "access_key_id" => "minioadmin" ,
+  "secret_access_key" => "minioadmin",
+  "bucket" => "test",
+  "region" => "us-east-1",
+})
+op.write("file", "hello world")
+puts op.read("file") # => "hello world"
+puts ""
+
+puts "List:", op.list("").map { |e| e.path }
+puts ""
+
+puts "Stat"
+puts op.stat("file").inspect # => #<OpenDal::Metadata mode: File,         content_type: binary/octet-stream,         content_length: 11>
+puts ""
+
+puts "Deleting 'file'"
+op.delete("file")
+puts ""
+
+puts "Exist?", op.exist?("file") # => false
+puts ""
+
+puts "Info:", op.info.inspect # => #<OpenDal::OperatorInfo scheme: "s3", root: "/">
+```
+
+#### Use middleware
+
+```ruby
+require 'opendal'
+
+op = OpenDal::Operator.new("s3", {
+  "endpoint" => "http://localhost:9000",
+  "access_key_id" => "minioadmin" ,
+  "secret_access_key" => "minioadmin",
+  "bucket" => "test",
+  "region" => "us-east-1",
+})
+
+op.middleware(OpenDal::Middleware::ConcurrentLimit.new(5))
+op.middleware(OpenDal::Middleware::Retry.new)
+op.middleware(OpenDal::Middleware::Timeout.new(1, 2))
+
+op.list("/").map do |e|
+  puts e.inspect
+end
+```
+
+## Documentation
+
+More detailed documentation is a work in progress.
+
+- OpenDAL's [ruby](https://opendal.apache.org/docs/ruby/) documentation
+- Rust [documentation](https://docs.rs/opendal/latest/opendal/index.html)
+- Rust documentation for [services](https://docs.rs/opendal/latest/opendal/services/index.html)
+- Rust documentation for [layers](https://docs.rs/opendal/latest/opendal/layers/index.html) (middlewares in Ruby)
+
+## Development
+
+Install gem and its dependencies:
+
+```shell
+bundle
+```
+
+Build bindings:
+
+```shell
+bundle exec rake compile
+```
+
+Run tests:
+
+```shell
+bundle exec rake test
+```
+
+Run linters:
+
+```shell
+bundle exec rake standard:fix
+rustfmt --config-path ../../rustfmt.toml src/*.rs # Run rustfmt for Rust files
+cargo clippy --fix --all-targets # Run rust linter clippy
+```
+
+## License and Trademarks
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
+
+Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation.