delta_sharing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25f4e8115e6fa01d01f05c01215125e8776d5ea22951cd0ad60e77eed9dbb434
+  data.tar.gz: a3b72291cea43781e9aafad280dade65cf969d9155df137ca5ac3535e268cc64
+SHA512:
+  metadata.gz: 3c7c64e3e2dfe90e1458d4b153536bb4217be4d202094fffcb1ccc59c9977067b5978067542878e3096e8931d50b3c46c7ad7d97ebfab1205e555f72560ce156
+  data.tar.gz: db27a691874474cba4833c0ec9ed4154d7a3d1d193a83cf8bb63c8c6d42b153ed2b8ea1e1b502768866b5d4c37c4420f6f1a72fa4858acb898829960e183d32c

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-28
+
+### Added
+- Initial implementation of Delta Sharing Protocol client
+- Support for reading shared Delta Lake tables in Parquet format
+- Apache Arrow integration for efficient data processing
+- Authentication via bearer tokens and profile files
+- Table discovery (list shares, schemas, tables)
+- Table data reading with filtering support
+- Change data feed support
+- Comprehensive test suite with >80% coverage
+
+### Limitations
+- Only supports Parquet response format

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+plugin 'rubygems-requirements-system'
+
+# Specify your gem's dependencies in delta-sharing.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    delta_sharing (0.1.0)
+      httparty (~> 0.21.0)
+      red-arrow (~> 19.0)
+      red-arrow-dataset (~> 19.0)
+      red-parquet (~> 19.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    bigdecimal (3.2.2)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    csv (3.3.5)
+    extpp (0.1.1)
+    fiddle (1.1.8)
+    gio2 (4.2.9)
+      fiddle
+      gobject-introspection (= 4.2.9)
+    glib2 (4.2.9)
+      native-package-installer (>= 1.0.3)
+      pkg-config (>= 1.3.5)
+    gobject-introspection (4.2.9)
+      glib2 (= 4.2.9)
+    hashdiff (1.2.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.7.6)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    multi_xml (0.6.0)
+    native-package-installer (1.1.9)
+    parallel (1.24.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pkg-config (1.6.2)
+    public_suffix (5.1.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    red-arrow (19.0.1)
+      bigdecimal (>= 3.1.0)
+      csv
+      extpp (>= 0.1.1)
+      gio2 (>= 4.2.3)
+      native-package-installer
+      pkg-config
+    red-arrow-dataset (19.0.1)
+      red-arrow (= 19.0.1)
+    red-parquet (19.0.1)
+      red-arrow (= 19.0.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.6.0)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  delta_sharing!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,93 @@
+# Delta Sharing Ruby Client
+
+A Ruby implementation of the Delta Sharing Protocol for reading shared Delta Lake tables. For now it only suports parquet format. See Todo Bellow
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delta_sharing'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install delta_sharing
+
+## Usage
+
+### Initialize the Client
+
+```ruby
+require 'delta_sharing'
+
+client = DeltaSharing::Client.new('profile.json')
+```
+or
+```ruby
+require 'delta_sharing'
+
+client = DeltaSharing::Client.new(endpoint: "https://your-delta-sharing-server/delta-sharing/", bearerToken: "your-bearer-token")
+```
+
+
+### List Shares
+
+```ruby
+shares = client.list_shares
+```
+
+### List Schemas in a Share
+
+```ruby
+schemas = client.list_schemas('share_name')
+```
+
+### List Tables
+
+```ruby
+# List tables in a specific schema
+tables = client.list_tables('share_name', 'schema_name')
+```
+
+### Read Table
+
+```ruby
+# List tables in a specific schema
+client = DeltaSharing::Client.new('profile.json')
+
+# Create a Reader json predicates hints can a string or a hash
+# Returns a Arrow:Table
+reader = DeltaSharing::Reader.new(table: "#{share_name}.#{schema_name}.#{table_name}", client: client)
+aarrow_table = reader.load_as_arrow(limit: 100, json_predicate_hints: '{ "op": "equal", "children": [ { "op": "column", "name": "active", "valueType": "int" }, { "op": "literal", "value": "1", "valueType": "int" } ] }', predicate_hints: ['active = 1'])
+
+```
+
+## Current Implementation Status
+
+🚧 **TODO:**
+- Implement table data changes reading functionality
+- Add support for reading table as delta format
+- Add documentation
+
+## Development
+- Fork the project.
+- Run bundle
+- Make your changes.
+- Run bundle exec rake(run tests)
+- Crete a PR
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samssouza/delta-sharing-ruby.
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Delta Sharing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/samssouza/delta-sharing-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: %i[]
+
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+desc "Run tests"
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'delta_sharing'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# Install Ruby dependencies
+bundle install
+
+# Run any setup tasks
+echo "Setup complete! You can now run:"
+echo "  bin/console    # for an interactive prompt"
+echo "  bundle exec rake test    # to run tests"

data/examples/client_example.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'delta_sharing'
+
+# Initialize client with profile file
+# The profile file should contain:
+# {
+#   "shareCredentialsVersion": 1,
+#   "endpoint": "https://your-delta-sharing-server/delta-sharing/",
+#   "bearerToken": "your-bearer-token"
+# }
+
+client = DeltaSharing::Client.new('config.share')
+
+shares = client.list_shares
+puts "Shares: #{shares}"
+
+share_name = shares.first[:name]
+
+schemas = client.list_schemas(share_name)
+puts "Schemas in share #{share_name}: #{schemas}"
+
+schema_name = schemas.first[:name]
+
+tables = client.list_tables(share_name, schema_name)
+puts "Tables in share #{share_name} and schema #{schema_name}: #{tables}"
+
+table_name = tables.first[:name]
+
+# Get table metadata
+metadata = client.get_table_metadata(share_name, schema_name, table_name)
+puts "Table #{table_name} metadata: #{metadata}"
+
+# Get table version
+version = client.get_table_version(share_name, schema_name, table_name)
+puts "Table #{table_name} current version: #{version}"
+
+# Read table data
+raw_response = client.read_table_data(share_name, schema_name, table_name, limit: 2)
+puts "Table #{table_name} response lines: #{raw_response.length}"
+raw_response.each_with_index do |line, i|
+  puts "  Line #{i}: #{line[0..100]}#{line.length > 100 ? '...' : ''}"
+end

data/examples/reader_example.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'delta_sharing'
+
+# Example of reading a Delta Sharing table with Apache Arrow
+
+# Initialize the client with a profile file
+profile_path = File.join(__dir__, '..', 'config.share')
+client = DeltaSharing::Client.new(profile_path)
+
+# List available shares
+share_name = client.list_shares.first[:name]
+schema_name = client.list_schemas(share_name).first[:name]
+table_name = client.list_tables(share_name, schema_name).first[:name]
+
+# Create a Table object
+reader = DeltaSharing::Reader.new(table: "#{share_name}.#{schema_name}.#{table_name}", client: client)
+
+# Read the table data as an Arrow::Table
+puts 'Reading table data...'
+arrow_table = reader.load_as_arrow(limit: 100,
+                                   json_predicate_hints: '{ "op": "equal", "children": [ { "op": "column", "name": "active", "valueType": "int" }, { "op": "literal", "value": "1", "valueType": "int" } ] }', predicate_hints: ['active = 1'])
+# Display first few rows
+if arrow_table.n_rows > 0
+  puts 'First 5 rows:'
+  arrow_table.slice(0, [5, arrow_table.n_rows].min).each_record.with_index do |record, i|
+    puts "  Row #{i}: #{record.to_h}"
+  end
+else
+  puts 'Table is empty'
+end

data/lib/delta_sharing/client.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module DeltaSharing
+  class Client
+    attr_reader :profile
+
+    # Initialize with profile file path OR direct credentials
+    def initialize(profile_file = nil, endpoint: nil, bearer_token: nil)
+      if profile_file && (endpoint || bearer_token)
+        raise ArgumentError,
+              'Must provide either profile_file path OR both endpoint and bearer_token not both'
+      end
+
+      if profile_file.nil? && (endpoint && bearer_token.nil? || endpoint.nil? && bearer_token)
+        raise ArgumentError,
+              'Must provide both endpoint and bearer_token'
+      end
+
+      if profile_file
+        @profile = load_profile_from_file(profile_file)
+      elsif endpoint && bearer_token
+        @profile = {
+          'endpoint' => endpoint,
+          'bearerToken' => bearer_token
+        }
+      end
+    end
+
+    # List all shares
+    def list_shares
+      path = '/shares'
+      response = make_request(path)
+      shares, next_page_token = parse_shares_response(response.body)
+      while next_page_token
+        response = make_request(path, params: { nextPageToken: next_page_token })
+        shares, next_page_token = parse_shares_response(response.body)
+      end
+      shares
+    end
+
+    # Get share info
+    def get_share(share_name)
+      path = "/shares/#{share_name}"
+      response = make_request(path)
+      JSON.parse(response.body)
+    end
+
+    # List all schemas in a share
+    def list_schemas(share_name)
+      path = "/shares/#{share_name}/schemas"
+      response = make_request(path)
+      schemas, next_page_token = parse_schemas_response(response.body)
+      while next_page_token
+        response = make_request(path, params: { nextPageToken: next_page_token })
+        schemas, next_page_token = parse_schemas_response(response.body)
+      end
+      schemas
+    end
+
+    # List all tables in a share and schema
+    def list_tables(share_name, schema_name = nil)
+      path = if schema_name
+               # List tables in a specific schema
+               "/shares/#{share_name}/schemas/#{schema_name}/tables"
+             else
+               # List all tables in the share (across all schemas)
+               "/shares/#{share_name}/all-tables"
+             end
+
+      response = make_request(path)
+      tables, next_page_token = parse_tables_response(response.body)
+      while next_page_token
+        response = make_request(path, params: { nextPageToken: next_page_token })
+        tables, next_page_token = parse_tables_response(response.body)
+      end
+      tables
+    end
+
+    # Query table version (HEAD request)
+    def get_table_version(share_name, schema_name, table_name)
+      path = "/shares/#{share_name}/schemas/#{schema_name}/tables/#{table_name}/version"
+      response = make_request(path, method: 'GET')
+      response.headers['delta-table-version']
+    end
+
+    # Get table metadata
+    def get_table_metadata(share_name, schema_name, table_name)
+      path = "/shares/#{share_name}/schemas/#{schema_name}/tables/#{table_name}/metadata"
+      response = make_request(path)
+      parse_metadata_response(response.body)
+    end
+
+    # Read table data using POST request
+    def read_table_data(share_name, schema_name, table_name, options = {})
+      path = "/shares/#{share_name}/schemas/#{schema_name}/tables/#{table_name}/query"
+      body = build_query_body(options)
+      response = make_request(path, method: 'POST', body: body)
+      parse_newline_delimited_json(response.body)
+    end
+
+    # Read table changes using POST request
+    def read_table_changes(share_name, schema_name, table_name, options = {})
+      path = "/shares/#{share_name}/schemas/#{schema_name}/tables/#{table_name}/changes"
+      params = build_changes_params(options)
+      response = make_request(path, params: params)
+      parse_newline_delimited_json(response.body)
+    end
+
+    private
+
+    def load_profile_from_file(profile_file)
+      raise Error, "Profile file not found: #{profile_file}" unless File.exist?(profile_file)
+
+      content = File.read(profile_file)
+      JSON.parse(content)
+    rescue JSON::ParserError => e
+      raise Error, "Invalid JSON in profile file: #{e.message}"
+    end
+
+    def make_request(path, method: 'GET', params: {}, body: nil)
+      url = @profile['endpoint'] + path
+
+      options = {
+        headers: {
+          'Authorization' => "Bearer #{@profile['bearerToken']}",
+          'Content-Type' => 'application/json',
+          'delta-sharing-capabilities' => 'responseformat=parquet'
+        },
+        timeout: 300
+      }
+
+      # Add query parameters if provided
+      unless params.empty?
+        # Filter out nil values and convert to strings
+        filtered_params = params.compact.transform_values(&:to_s)
+        options[:query] = filtered_params
+      end
+
+      # Add body for POST requests
+      options[:body] = body.to_json unless body.nil?
+
+      response = case method.upcase
+                 when 'GET'
+                   HTTParty.get(url, options)
+                 when 'HEAD'
+                   HTTParty.head(url, options)
+                 when 'POST'
+                   HTTParty.post(url, options)
+                 else
+                   raise ArgumentError, "Unsupported HTTP method: #{method}"
+                 end
+
+      handle_error_response(response, path) unless response.success?
+
+      response
+    end
+
+    def build_query_body(options)
+      body = {}
+
+      body[:predicateHints] = options[:predicate_hints] if options[:predicate_hints]
+      if options[:json_predicate_hints]
+        body[:jsonPredicateHints] = if options[:json_predicate_hints].is_a?(Hash)
+                                      JSON.dump(options[:json_predicate_hints])
+                                    else
+                                      options[:json_predicate_hints]
+                                    end
+      end
+      body[:limitHint] = options[:limit] if options[:limit]
+      body[:version] = options[:version] if options[:version]
+
+      body
+    end
+
+    def build_changes_params(options)
+      params = {}
+
+      params[:startingVersion] = options[:starting_version] if options[:starting_version]
+      params[:endingVersion] = options[:ending_version] if options[:ending_version]
+      params[:startingTimestamp] = options[:starting_timestamp] if options[:starting_timestamp]
+      params[:endingTimestamp] = options[:ending_timestamp] if options[:ending_timestamp]
+
+      params
+    end
+
+    def parse_newline_delimited_json(response_body)
+      lines = response_body.split("\n")
+      lines.reject(&:empty?)
+    end
+
+    def handle_error_response(response, path)
+      case response.code
+      when 401, 403
+        raise AuthenticationError, "Authentication failed: #{response.code} #{response.message}"
+      when 404
+        raise TableNotFoundError, "Resource not found: #{path}"
+      when 400
+        raise ProtocolError, "Bad request: #{response.body}"
+      else
+        raise Error, "HTTP request failed: #{path} #{response.code} #{response.message}"
+      end
+    end
+
+    def parse_tables_response(response)
+      response = JSON.parse(response)
+      tables = (response['items'] || []).map do |table|
+        {
+          name: table['name'],
+          share: table['share'],
+          schema: table['schema'],
+          share_id: table['shareId'],
+          id: table['id']
+        }
+      end
+      [tables, response['nextPageToken']]
+    end
+
+    def parse_shares_response(response)
+      response = JSON.parse(response)
+      shares = (response['items'] || []).map do |share|
+        {
+          name: share['name'],
+          id: share['id']
+        }
+      end
+
+      [shares, response['nextPageToken']]
+    end
+
+    def parse_schemas_response(response)
+      response = JSON.parse(response)
+      schemas = (response['items'] || []).map do |schema|
+        {
+          name: schema['name'],
+          share: schema['share']
+        }
+      end
+      [schemas, response['nextPageToken']]
+    end
+
+    def parse_metadata_response(response)
+      parsed_response = parse_newline_delimited_json(response)
+      JSON.parse(parsed_response[1])
+    rescue JSON::ParserError => e
+      # raise ProtocolError, "Invalid schema JSON in metadata: #{e.message}"
+      raise e
+    end
+  end
+end

data/lib/delta_sharing/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeltaSharing
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class TableNotFoundError < Error; end
+  class ProtocolError < Error; end
+  class NetworkError < Error; end
+  class SchemaError < Error; end
+  class ParsingError < Error; end
+end

data/lib/delta_sharing/reader.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+module DeltaSharing
+  class Reader
+    attr_reader :table, :client, :share, :schema, :name
+
+    # Table format: <share>.<schema>.<table>
+    def initialize(table:, client:, **_options)
+      validate_table_format(table)
+      @share, @schema, @name = table.split('.')
+      @client = client
+    end
+
+    # Main reading methods (to be implemented)
+    def load_as_arrow(options = {})
+      validate_query_options(options)
+      read(options)
+    end
+
+    private
+
+    def validate_table_format(table)
+      # Pattern: anything.anything.anything (where anything = one or more non-dot characters)
+      pattern = /\A[^.]+\.[^.]+\.[^.]+\z/
+
+      return if table.is_a?(String) && table.match?(pattern)
+
+      raise ArgumentError, "Invalid table format. Expected '<share>.<schema>.<table>', got: #{table}"
+    end
+
+    def validate_query_options(options)
+      validate_predicate_hints(options[:predicate_hints]) if options.key?(:predicate_hints)
+      validate_json_predicate_hints(options[:json_predicate_hints]) if options.key?(:json_predicate_hints)
+      validate_limit(options[:limit]) if options.key?(:limit)
+      validate_version(options[:version]) if options.key?(:version)
+      validate_timestamp(options[:timestamp]) if options.key?(:timestamp)
+    end
+
+    def validate_predicate_hints(hints)
+      return if hints.nil?
+
+      raise ArgumentError, "predicate_hints must be an Array, got #{hints.class}" unless hints.is_a?(Array)
+
+      return if hints.all? { |hint| hint.is_a?(String) }
+
+      raise ArgumentError, 'All predicate hints must be strings'
+    end
+
+    def validate_json_predicate_hints(hints)
+      return if hints.nil?
+
+      unless hints.is_a?(String) || hints.is_a?(Hash)
+        raise ArgumentError, "json_predicate_hints must be a String or Hash, got #{hints.class}"
+      end
+
+      # If it's a string, try to parse it as JSON to validate
+      return unless hints.is_a?(String)
+
+      begin
+        JSON.parse(hints)
+      rescue JSON::ParserError => e
+        raise ArgumentError, "Invalid JSON in predicate hints: #{e.message}"
+      end
+    end
+
+    def validate_limit(limit_value)
+      return if limit_value.nil?
+
+      return if limit_value.is_a?(Integer) && limit_value >= 0
+
+      raise ArgumentError, "limit must be a non-negative Integer, got #{limit_value}"
+    end
+
+    def validate_version(version_value)
+      return if version_value.nil?
+
+      return if version_value.is_a?(Integer) && version_value >= 0
+
+      raise ArgumentError, "version must be a non-negative Integer, got #{version_value}"
+    end
+
+    def validate_timestamp(timestamp_value)
+      return if timestamp_value.nil?
+
+      return if timestamp_value.is_a?(String) || timestamp_value.is_a?(Time) || timestamp_value.is_a?(Integer)
+
+      raise ArgumentError, "timestamp must be a String, Time, or Integer, got #{timestamp_value.class}"
+    end
+
+    # Read change data feed
+    def changes(starting_version: nil, ending_version: nil, starting_timestamp: nil, ending_timestamp: nil)
+      response = client.read_table_changes(share, schema, name, {
+                                             starting_version: starting_version,
+                                             ending_version: ending_version,
+                                             starting_timestamp: starting_timestamp,
+                                             ending_timestamp: ending_timestamp
+                                           })
+
+      process_read_response(response)
+    end
+
+    # Read table data with optional filtering
+    def read(limit: nil, predicate_hints: nil, json_predicate_hints: nil, version: nil)
+      response = client.read_table_data(share, schema, name, {
+                                          limit: limit,
+                                          predicate_hints: predicate_hints,
+                                          json_predicate_hints: json_predicate_hints,
+                                          version: version
+                                        })
+
+      process_read_response(response)
+    end
+
+    def process_read_response(response_lines)
+      metadata_line = nil
+      file_lines = []
+
+      # Parse newline-delimited JSON response
+      response_lines.each do |line|
+        line = line.strip
+        next if line.empty?
+
+        begin
+          json_obj = JSON.parse(line)
+
+          if json_obj['protocol']
+            next
+          elsif json_obj['metaData']
+            metadata_line = json_obj
+          elsif json_obj['file']
+            file_lines << json_obj
+          end
+        rescue JSON::ParserError => e
+          raise ProtocolError, "Invalid JSON in response line: #{e.message}"
+        end
+      end
+      @files = file_lines
+      @metadata = metadata_line
+      arrow_schema = Schema.new(@metadata['metaData']['schemaString']).arrow_schema
+      # Download and process Parquet files
+
+      arrow_tables = []
+      file_lines.each do |file_obj|
+        file_info = file_obj['file']
+        arrow_table = download_and_read_parquet(file_info)
+        arrow_table = add_partition_columns(arrow_table, arrow_schema, file_info) if file_info['partitionValues']
+        arrow_tables << arrow_table if arrow_table
+      end
+
+      # Combine all Arrow tables
+      @arrow_table = if arrow_tables.length == 1
+                       arrow_tables.first
+                     else
+                       combine_arrow_tables(arrow_tables)
+                     end
+
+      @arrow_table
+    end
+
+    def download_and_read_parquet(file_info)
+      url = file_info['url']
+
+      # Download Parquet file
+      parquet_data = download_file(url)
+
+      # Read with Apache Arrow
+      read_parquet_data(parquet_data)
+    end
+
+    def download_file(url)
+      response = HTTParty.get(url)
+
+      unless response.success?
+        raise NetworkError,
+              "Failed to download file from #{url}: #{response.code} #{response.message}"
+      end
+
+      response.body
+    end
+
+    def read_parquet_data(data)
+      # Create a temporary file to write the Parquet data
+      Tempfile.create(['delta_sharing', '.parquet']) do |temp_file|
+        temp_file.binmode
+        temp_file.write(data)
+        temp_file.rewind
+
+        # Read using Apache Arrow
+        Arrow::Table.load(temp_file.path, format: :parquet)
+      end
+    rescue StandardError => e
+      raise ProtocolError, "Failed to read Parquet data: #{e.message}"
+    end
+
+    def add_partition_columns(arrow_table, schema, file_info)
+      partition_values = file_info['partitionValues'] || {}
+      return arrow_table if partition_values.empty?
+
+      partition_fields = []
+      partition_column_values = []
+
+      schema.fields.each do |field|
+        if partition_values.keys.include?(field.name)
+          partition_fields << field
+          partition_column_values << partition_values[field.name]
+        end
+      end
+
+      return arrow_table if partition_fields.empty?
+
+      # Create row-oriented data: each row is an array of partition values
+      partition_rows = Array.new(arrow_table.n_rows) { partition_column_values.dup }
+
+      partition_schema = Arrow::Schema.new(partition_fields)
+      partition_table = Arrow::Table.new(partition_schema, partition_rows)
+      arrow_table.merge(partition_table)
+    end
+
+    def combine_arrow_tables(tables)
+      return tables.first if tables.length == 1
+
+      # Use the first table's schema as the reference for column order
+      reference_schema = tables.first.schema
+      reference_column_order = reference_schema.fields.map(&:name)
+
+      # Align all tables to match the reference schema
+      aligned_tables = tables.map do |table|
+        current_column_order = table.schema.fields.map(&:name)
+
+        # Check if reordering is needed
+        if current_column_order == reference_column_order
+          table # Already in correct order
+        else
+          # Verify all required columns are present
+          missing_columns = reference_column_order - current_column_order
+          extra_columns = current_column_order - reference_column_order
+
+          raise ProtocolError, "Table missing required columns: #{missing_columns.join(', ')}" if missing_columns.any?
+
+          if extra_columns.any?
+            # Log warning but continue (extra columns will be ignored)
+            puts "Warning: Table has extra columns that will be ignored: #{extra_columns.join(', ')}"
+          end
+
+          # Reorder columns to match reference schema
+          reordered_columns = reference_column_order.map do |column_name|
+            table.column(column_name)
+          end
+
+          Arrow::Table.new(reference_schema, reordered_columns)
+        end
+      end
+
+      # Now combine all aligned tables
+      record_batches = aligned_tables.flat_map { |t| t.each_record_batch.to_a }
+      Arrow::Table.new(reference_schema, record_batches)
+    rescue StandardError => e
+      raise ProtocolError, "Failed to combine Arrow tables: #{e.message}"
+    end
+  end
+end

data/lib/delta_sharing/schema.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module DeltaSharing
+  class Schema
+    attr_reader :fields, :arrow_schema
+
+    def initialize(schema_string)
+      schema_json = JSON.parse(schema_string)
+      @fields = schema_json['fields'] || []
+      @arrow_schema = build_arrow_schema
+    end
+
+    def field_names
+      @fields.map { |f| f['name'] }
+    end
+
+    def field_index(name)
+      @fields.find_index { |f| f['name'] == name }
+    end
+
+    def build_arrow_schema
+      fields = @fields.map do |field|
+        arrow_type = delta_type_to_arrow_type(field['type'])
+        Arrow::Field.new(field['name'], arrow_type, field['nullable'])
+      end
+
+      Arrow::Schema.new(fields)
+    end
+
+    def delta_type_to_arrow_type(delta_type)
+      case delta_type
+      when 'boolean'
+        Arrow::BooleanDataType.new
+      when 'byte'
+        Arrow::Int8DataType.new
+      when 'short'
+        Arrow::Int16DataType.new
+      when 'integer'
+        Arrow::Int32DataType.new
+      when 'long'
+        Arrow::Int64DataType.new
+      when 'float'
+        Arrow::FloatDataType.new
+      when 'double'
+        Arrow::DoubleDataType.new
+      when 'string'
+        Arrow::StringDataType.new
+      when 'binary'
+        Arrow::BinaryDataType.new
+      when 'date'
+        Arrow::Date32DataType.new
+      when 'timestamp'
+        Arrow::TimestampDataType.new(:micro)
+      else
+        if delta_type.is_a?(Hash)
+          case delta_type['type']
+          when 'decimal'
+            Arrow::DecimalDataType.new(delta_type['precision'], delta_type['scale'])
+          when 'array'
+            element_type = delta_type_to_arrow_type(delta_type['elementType'])
+            Arrow::ListDataType.new(element_type)
+          when 'map'
+            key_type = delta_type_to_arrow_type(delta_type['keyType'])
+            value_type = delta_type_to_arrow_type(delta_type['valueType'])
+            Arrow::MapDataType.new(key_type, value_type)
+          when 'struct'
+            fields = delta_type['fields'].map do |field|
+              field_type = delta_type_to_arrow_type(field['type'])
+              Arrow::Field.new(field['name'], field_type, field['nullable'])
+            end
+            Arrow::StructDataType.new(fields)
+          else
+            Arrow::StringDataType.new # Fallback to string
+          end
+        else
+          Arrow::StringDataType.new # Fallback to string
+        end
+      end
+    end
+  end
+end

data/lib/delta_sharing/version.rb

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

data/lib/delta_sharing.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'delta_sharing/version'
+require_relative 'delta_sharing/errors'
+require_relative 'delta_sharing/client'
+require_relative 'delta_sharing/reader'
+require_relative 'delta_sharing/schema'
+require 'arrow'
+require 'parquet'
+require 'httparty'
+require 'tempfile'
+require 'json'
+
+module DeltaSharing
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: delta_sharing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Souza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: red-arrow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+- !ruby/object:Gem::Dependency
+  name: red-arrow-dataset
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+- !ruby/object:Gem::Dependency
+  name: red-parquet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: A Ruby implementation of the Delta Sharing client for reading shared
+  Delta Lake tables
+email:
+- samuel.ssouza95@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/client_example.rb
+- examples/reader_example.rb
+- lib/delta_sharing.rb
+- lib/delta_sharing/client.rb
+- lib/delta_sharing/errors.rb
+- lib/delta_sharing/reader.rb
+- lib/delta_sharing/schema.rb
+- lib/delta_sharing/version.rb
+homepage: https://github.com/samssouza/delta-sharing-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/samssouza/delta-sharing-ruby
+  source_code_uri: https://github.com/samssouza/delta-sharing-ruby
+  changelog_uri: https://github.com/samssouza/delta-sharing-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for Delta Sharing protocol
+test_files: []