sofia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a0700857a43b841018595dea20d578f1f77a59f3c5dc625836ac44faca893e7
+  data.tar.gz: 5641b7640ee6e1225b920ad683c3f3172a394b755b23740d5600659d15128371
+SHA512:
+  metadata.gz: 2ce0f5a2fc2cd5a0b06107465723399f650c1ec4cfb4a311b5a8196a4f2ca10eeffd73362e4c6bd0ac1c0a97fd29dbef173f765488e620ee4ceb33c5343e063f
+  data.tar.gz: 8f062bd2075032d046892799ae82ad336dccbee9dab7227c5b0150469fd69e67edf24b7243e764cff3127e69818f79ed0281c573589fe9e81bc93df40ba749b6

data/.byebug_history

@@ -0,0 +1,6 @@
+c
+response.status
+response.success?
+response.headers
+response.headears
+response

data/.rubocop.yml

@@ -0,0 +1,179 @@
+inherit_mode:
+  merge:
+  - Exclude
+  - Include
+
+AllCops:
+  EnabledByDefault: true
+  SuggestExtensions: false
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - vendor/bundle/**/*
+    - tmp/**/*
+    - Gemfile.lock
+    - "**/*.rbi"
+    - sorbet/**/*
+
+Layout/EmptyLines:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+Layout/ClassStructure:
+  Enabled: false
+Layout/ExtraSpacing:
+  Enabled: false
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+Layout/RedundantLineBreak:
+  Enabled: false
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - db/migrate/*
+    - test/**/*
+    - config/**/*
+Metrics/ModuleLength:
+  Max: 400
+  Exclude:
+    - db/migrate/*
+    - test/**/*
+    - config/**/*
+Metrics/CyclomaticComplexity:
+  Max: 12
+Metrics/MethodLength:
+  Max: 40
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Style/Send:
+  Enabled: false
+Style/Documentation: 
+  Enabled: false
+Style/ArrayCoercion:
+  Enabled: false
+Style/Alias:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ClassMethodsDefinitions:
+  EnforcedStyle: self_class
+Style/ConstantVisibility:
+  Enabled: false
+Style/Copyright:
+  Enabled: false
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+Style/InlineComment:
+  Enabled: false
+Style/IpAddresses:
+  Exclude:
+    - test/**/*
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+Style/RedundantArgument:
+  Enabled: false
+Style/StringHashKeys:
+  Enabled: false
+Style/RedundantConstantBase:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Style/MissingElse:
+  Enabled: false
+Style/RequireOrder:
+  Enabled: false
+Lint/NumberConversion:
+  Enabled: false
+Style/Lambda:
+  EnforcedStyle: literal
+Style/AsciiComments:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/DateTime:
+  Enabled: false
+Style/EndlessMethod:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Style/ArgumentsForwarding:
+  Enabled: false
+Style/RedundantBegin:
+  Enabled: false
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Bundler/DuplicatedGem:
+  Enabled: false
+Style/DocumentationMethod:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+Layout/FirstArrayElementLineBreak:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/NumericPredicate:
+  Enabled: false
+Lint/EmptyWhen:
+  Enabled: false
+Style/ArrayFirstLast:
+  Enabled: false
+Bundler/GemComment:
+  Enabled: false
+Bundler/GemVersion:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: false
+Lint/SuppressedException:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 KubaJadrzak
+
+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,21 @@
+# Sofia
+
+This is a personal project created for self-learning purposes. The goal is to create a simplified version of Faraday gem. For now, Sofia will support only NetHTTP as adapter, but I have plans to write my own adapter in the future. Initially wanted to name this project alice but there is already an alice gem :(
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/sofia. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sofia/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Sofia project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sofia/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = ENV['TEST'] || 'test/**/*_test.rb'
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test]

data/lib/sofia/adapter/net_http.rb

@@ -0,0 +1,67 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Adapter
+    class NetHTTP < Base
+      class << self
+
+        NET_HTTP_EXCEPTIONS = [
+          IOError, Errno::ECONNREFUSED, Errno::ECONNRESET, SocketError,
+        ].freeze
+
+        TIMEOUT_EXCEPTIONS = [
+          Net::OpenTimeout, Net::ReadTimeout, Errno::ETIMEDOUT,
+        ].freeze
+
+        # @override
+        #: (Sofia::Request request) -> Sofia::Response
+        def call(request)
+          uri = URI.parse(request.url)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme == 'https'
+
+          klass = Net::HTTP.const_get(request.http_method.capitalize)
+
+          raise Sofia::Error::ArgumentError, 'only HTTP(S) URLs are supported' unless uri.is_a?(URI::HTTP)
+
+          net_req = klass.new(uri.request_uri)
+
+          request.headers.each { |k, v| net_req[k] = v }
+          body_hash = request.body.to_h
+          net_req.body = JSON.dump(body_hash) unless body_hash.empty? || request.http_method == :get
+
+
+          response = perform_request(http, net_req)
+
+          adapt_response(response, request)
+        end
+
+        private
+
+        #: (Net::HTTPResponse response, Sofia::Request request) -> Sofia::Response
+        def adapt_response(response, request)
+          Sofia::Response.new(
+            status:   response.code.to_i,
+            headers:  response.each_header.to_h,
+            raw_body: response.body,
+            request:  request,
+          )
+        end
+
+        #: (Net::HTTP http, Net::HTTPRequest net_req) -> Net::HTTPResponse
+        def perform_request(http, net_req)
+          http.request(net_req)
+        rescue OpenSSL::SSL::SSLError => e
+          raise Sofia::Error::SSLError, e
+        rescue *NET_HTTP_EXCEPTIONS => e
+          raise Sofia::Error::ConnectionFailed, e
+        rescue *TIMEOUT_EXCEPTIONS => e
+          raise Sofia::Error::TimeoutError, e
+        end
+
+      end
+    end
+  end
+end

data/lib/sofia/adapter.rb

@@ -0,0 +1,20 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Adapter
+    # @abstract
+    class Base
+      class << self
+        extend T::Sig
+        extend T::Helpers
+        abstract!
+
+        sig { abstract.params(request: Sofia::Request).returns(Sofia::Response) }
+        def call(request); end
+      end
+    end
+  end
+end
+
+require_relative 'adapter/net_http'

data/lib/sofia/client.rb

@@ -0,0 +1,55 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  class Client
+    HTTP_METHODS = %w[get post put patch delete].freeze
+
+    #: (base_url: untyped, adapter: untyped) -> void
+    def initialize(base_url:, adapter:)
+      @base_url = Sofia::Types::BaseUrl.new(base_url) #: Sofia::Types::BaseUrl
+      @adapter = Sofia::Types::Adapter.new(adapter) #: Sofia::Types::Adapter
+    end
+
+    #: -> String
+    def base_url
+      @base_url.to_s
+    end
+
+    #: -> Symbol
+    def adapter
+      @adapter.to_sym
+    end
+
+    #: ?{ (Request req) -> untyped } -> Response
+    def get(&) = request(:get, &)
+
+    #: ?{ (Request req) -> untyped } -> Response
+    def post(&) = request(:post, &)
+
+    #: ?{ (Request req) -> untyped } -> Response
+    def put(&) = request(:put, &)
+
+    #: ?{ (Request req) -> untyped } -> Response
+    def patch(&) = request(:patch, &)
+
+    #: ?{ (Request req) -> untyped } -> Response
+    def delete(&) = request(:delete, &)
+
+    private
+
+    #: (Symbol http_method) ?{ ( Request req ) -> untyped } -> Response
+    def request(http_method, &block)
+      raise Sofia::Error::ArgumentError, 'configuration of the request must be provided via block' unless block
+
+      req = Request.new(
+        http_method: http_method,
+        base_url:    @base_url,
+      )
+
+      block.call(req)
+
+      @adapter.klass.call(req)
+    end
+  end
+end

data/lib/sofia/error/argument_error.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class ArgumentError < Base; end
+  end
+end

data/lib/sofia/error/connection_failed.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class ConnectionFailed < Base; end
+  end
+end

data/lib/sofia/error/invalid_json.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class InvalidJSON < Base; end
+  end
+end

data/lib/sofia/error/ssl_error.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class SSLError < Base; end
+  end
+end

data/lib/sofia/error/timeout_error.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class TimeoutError < Base; end
+  end
+end

data/lib/sofia/error.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Error
+    class Base < StandardError; end
+  end
+end
+
+require_relative 'error/connection_failed'
+require_relative 'error/ssl_error'
+require_relative 'error/timeout_error'
+require_relative 'error/invalid_json'
+require_relative 'error/argument_error'

data/lib/sofia/helper.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  module Helper
+  end
+end
+
+require_relative 'helper/params'

data/lib/sofia/request.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sofia
+  class Request
+
+    #: Symbol
+    attr_reader :http_method
+
+    #: Sofia::Types::Headers
+    attr_reader :headers
+
+    #: Sofia::Types::Params
+    attr_reader :params
+
+    #: Sofia::Types::Body
+    attr_reader :body
+
+    #: (http_method: Symbol, base_url: Sofia::Types::BaseUrl) -> void
+    def initialize(http_method:, base_url:)
+      @http_method = http_method
+      @base_url = base_url
+      @path     = Sofia::Types::Path.new #: Sofia::Types::Path
+      @params   = Sofia::Types::Params.new #: Sofia::Types::Params
+      @headers  = Sofia::Types::Headers.new #: Sofia::Types::Headers
+      @body     = Sofia::Types::Body.new #: Sofia::Types::Body
+    end
+
+    #: (untyped path) -> void
+    def path=(path)
+      @path = Sofia::Types::Path.new(path)
+    end
+
+    #: (untyped params) -> void
+    def params=(params)
+      @params = Sofia::Types::Params.new(params)
+    end
+
+    #: (untyped headers) -> void
+    def headers=(headers)
+      @headers = Sofia::Types::Headers.new(headers)
+    end
+
+    #: (untyped? body) -> void
+    def body=(body)
+      @body = Sofia::Types::Body.new(body)
+    end
+
+    #: -> String
+    def url
+      qs = @params.to_s
+      base = @base_url.to_s + @path.to_s
+      qs.empty? ? base : "#{base}?#{qs}"
+    end
+  end
+end