libsql-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20fc3deb5389d0d74ca8af4ad378a4c138846c0cc0e0dcff10967214de97d0f2
+  data.tar.gz: fbe8d990103294b4d699f20aac94f95ed6175a3470aa19e7f4d4cc09142bac75
+SHA512:
+  metadata.gz: 1781b3d7c2aa0ea1192305833f269c80758eda4d079ddb5d41158679ed131c20451561923588e5b77b37c6f24d0e52a23d106a06aa054c97c0e035ecdfa1736c
+  data.tar.gz: 7b03dceb06e39b77f80e90aa7eb83b3e34bf5553511021a415b54f94126c133f679a691e3313a520da633593335fbf1c9c872e7e583396c076514a5ba918360f

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Metrics:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+Style/UnlessElse:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Leon Cruz
+
+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,28 @@
+# Libsql-rb
+
+A simple wrapper around the Libsql HTTP protocol. Does not support the Libsql protocol,
+only the HTTP method based on the [documentation](https://github.com/tursodatabase/libsql/blob/main/docs/HRANA_2_SPEC.md)
+
+## Installation
+
+    $ gem install libsql-rb
+
+## Usage
+
+#### Example
+
+```ruby
+client = Libsql::Client.new host: "http://localhost:8080"
+
+client.execute "create table users(name, email, password)"
+
+# Is possible to pass positional arguments
+client.execute "insert into users(name, email, password) values(?, ?, ?)", ["User 1", "user1@email..com", "1111111"]
+
+# or named aguments
+client.execute "insert into users(name, email, password) values(:name, :email, :password)", ["User 1", "user1@email..com", "1111111"]
+
+result = client.execute "select * from users"
+
+result.rows # get the rows as Struct
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/libsql/version.rb

@@ -0,0 +1,3 @@
+module Libsql
+  VERSION = "0.0.1".freeze
+end

data/lib/libsql-rb.rb

@@ -0,0 +1 @@
+require_relative "./libsql" # rubocop:disable Naming/FileName

data/lib/libsql.rb

@@ -0,0 +1,224 @@
+require "json"
+require "net/http"
+
+module Libsql
+  class Client
+    STMT_ENDPOINT = "/v2/pipeline".freeze
+
+    def initialize(params = {})
+      @url = params[:url]
+      @host = params[:host]
+      @port = params[:port]
+
+      _build_uri
+    end
+
+    def execute(query_string, args = nil)
+      argument_builder = case args
+      in Array
+        PositionalArgBuilder.new(*args)
+      in Hash
+        NamedArgBuilder.new(**args)
+      in NilClass
+        EmptyBuilder.new
+      else
+        raise NotImplementedError
+      end
+
+      if argument_builder.empty?
+        body = {
+          requests: [
+            { type: :execute, stmt: { sql: query_string } },
+            { type: :close }
+          ]
+        }
+      else
+        body = {
+          requests: [
+            { type: :execute, stmt: { sql: query_string, argument_builder.key => argument_builder.build } },
+            { type: :close }
+          ]
+        }
+      end
+
+      response = http_client.post(STMT_ENDPOINT, body)
+
+      raise StandardError, response.results.first["error"]["message"] if response.failure?
+
+      QueryResult.new(response)
+    end
+
+    private
+
+      def http_client
+        @http_client ||= HTTPClient.new(@uri)
+      end
+
+      def _build_uri
+        unless @url
+          @uri = URI("#{@host}:#{@port}")
+        else
+          @uri = URI(@url)
+        end
+      end
+  end
+
+  class EmptyBuilder
+    def empty? = true
+
+    def key = :no_key
+  end
+
+  class PositionalArgBuilder
+    attr_reader :args
+
+    def initialize(*args)
+      @args = args
+    end
+
+    def empty? = @args.empty?
+
+    def key = :args
+
+    def build
+      args.reduce([]) do |acc, value|
+        type = case value
+        in Integer
+          "integer"
+        in NilClass
+          "null"
+        else
+          "text"
+        end
+
+        acc << { type:, value: }
+      end
+    end
+  end
+
+  class NamedArgBuilder
+    attr_reader :kwargs
+
+    def initialize(**kwargs)
+      @kwargs = kwargs
+    end
+
+    def empty? = @kwargs.empty?
+
+    def key = :named_args
+
+    def build
+      kwargs.reduce([]) do |acc, (key, value)|
+        type = case value
+        in Integer
+          "integer"
+        in NilClass
+          "null"
+        else
+          "text"
+        end
+
+        acc << { name: key, value: { type:, value: } }
+      end
+    end
+  end
+
+  class QueryResult
+    def initialize(response)
+      @results = response.results
+    end
+
+    def rows
+      @results.first["response"]["result"]["rows"].map do |register|
+        row = Row.new
+
+        register.map.with_index do |r, index|
+          row.set(cols[index]["name"], r["value"])
+        end
+
+        row
+      end.flatten
+    end
+
+    private
+
+      def cols
+        @results.first["response"]["result"]["cols"]
+      end
+
+      class Row
+        def set(column, value)
+          instance_variable_set :"@#{column}", value
+
+          self.class.class_eval do
+            define_method column.to_sym, -> { value }
+          end
+        end
+      end
+  end
+
+  class HTTPClient
+    def initialize(base_uri)
+      @base_uri = base_uri
+    end
+
+    def get(endpoint)
+      uri = base_uri.merge endpoint
+
+      request = Net::HTTP::Get.new(uri)
+
+      execute(uri, request)
+    end
+
+    def post(endpoint, body = {})
+      uri = base_uri.merge endpoint
+
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+
+      request.body = JSON.generate(body)
+
+      execute(uri, request)
+    end
+
+    private
+
+      attr_accessor :base_uri
+
+      def execute(uri, request)
+        use_ssl = uri.scheme == "https"
+        request["Content-Type"] = "application/json"
+
+        resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl:) do |http|
+          http.request(request)
+        end
+
+        Response.new(resp)
+      end
+
+      class Response
+        attr_reader :status_code
+
+        def initialize(response)
+          @json_response = response.body
+          @status_code = response.code
+        end
+
+        def body
+          @body ||= JSON.parse(@json_response)
+        end
+
+        def success?
+          body["results"].all? { |r| r["type"] == "ok" }
+        end
+
+        def failure?
+          body["results"].any? { |r| r["type"] == "error" }
+        end
+
+        def results
+          body["results"]
+        end
+      end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: libsql-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leon Cruz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-29 00:00:00.000000000 Z
+dependencies: []
+description: A Libsql client for Ruby
+email:
+- leon.cruz.teixeira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- lib/libsql-rb.rb
+- lib/libsql.rb
+- lib/libsql/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+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.5.3
+signing_key:
+specification_version: 4
+summary: A Libsql client for Ruby
+test_files: []