ruby-http-session 1.0.1

data/lib/http/session/version.rb

@@ -0,0 +1,5 @@
+module HTTP
+  class Session
+    VERSION = "1.0.1"
+  end
+end

data/lib/http/session.rb

@@ -0,0 +1,97 @@
+require "http"
+require "monitor"
+
+require_relative "session/cache/cache_control"
+require_relative "session/cache/entry"
+require_relative "session/cache/status"
+require_relative "session/cache"
+require_relative "session/client/perform"
+require_relative "session/client"
+require_relative "session/configurable"
+require_relative "session/features/auto_inflate"
+require_relative "session/options/cache_option"
+require_relative "session/options/cookies_option"
+require_relative "session/options"
+require_relative "session/request"
+require_relative "session/requestable"
+require_relative "session/response/string_body"
+require_relative "session/response"
+require_relative "session/version"
+
+# Use session to manage cookies and cache across requests.
+class HTTP::Session
+  include MonitorMixin
+  include HTTP::Session::Configurable
+  include HTTP::Session::Requestable
+
+  # @!attribute [r] default_options
+  #   @return [Options]
+  attr_reader :default_options
+
+  # @!attribute [r] cache
+  #   @return [Cache]
+  attr_reader :cache
+
+  # @!attribute [r] jar
+  #   @return [HTTP::CookieJar]
+  attr_reader :jar
+
+  # @param [Hash] default_options
+  # @option default_options [Boolean, Hash] :cookies session cookies option
+  # @option default_options [Boolean, Hash] :cache session cache option
+  # @option default_options [Hash] :http http client options
+  def initialize(default_options = {})
+    super()
+
+    @default_options = HTTP::Session::Options.new(default_options)
+    @cache = HTTP::Session::Cache.new(@default_options.cache)
+    @jar = HTTP::CookieJar.new
+  end
+
+  # @param verb
+  # @param uri
+  # @param [Hash] opts
+  # @return [Response]
+  def request(verb, uri, opts = {})
+    c = HTTP::Session::Client.new(@default_options.http, self)
+    c.request(verb, uri, opts).tap do |res|
+      handle_http_response(res)
+    end
+  end
+
+  # @!visibility private
+  def make_http_request_data
+    synchronize do
+      {
+        cookies: extract_cookie_from_jar
+      }
+    end
+  end
+
+  private
+
+  def handle_http_response(res)
+    synchronize do
+      extract_cookie_to_jar(res)
+    end
+  end
+
+  def extract_cookie_from_jar
+    return unless @default_options.cookies.enabled?
+
+    return if @jar.empty?
+    @jar.cookies.each_with_object({}) { |c, h| h[c.name] = c.value }
+  end
+
+  def extract_cookie_to_jar(res)
+    return unless @default_options.cookies.enabled?
+
+    all = ([] << res.history << res).flatten
+    all.each do |r|
+      req = r.request
+      r.headers.get(HTTP::Headers::SET_COOKIE).each do |header|
+        @jar.parse(header, req.uri)
+      end
+    end
+  end
+end

data/lib/http-session/webmock.rb

@@ -0,0 +1,30 @@
+require "webmock"
+
+class HTTP::Session
+  class WebMockPerform < HTTP::WebMockPerform
+    def replay
+      webmock_response = response_for_request request_signature
+      return unless webmock_response
+
+      raise_timeout_error if webmock_response.should_timeout
+      webmock_response.raise_error_if_any
+
+      invoke_callbacks(webmock_response, real_request: false)
+      response = HTTP::Response.from_webmock @request, webmock_response, request_signature
+      HTTP::Session::Response.new(response)
+    end
+  end
+
+  class Client
+    alias_method :__perform__, :httprb_perform
+
+    def httprb_perform(request, options)
+      return __perform__(request, options) unless webmock_enabled?
+      HTTP::Session::WebMockPerform.new(request, options) { __perform__(request, options) }.exec
+    end
+
+    def webmock_enabled?
+      WebMock::HttpLibAdapters::HttpRbAdapter.enabled?
+    end
+  end
+end

data/lib/http-session.rb

@@ -0,0 +1,14 @@
+require_relative "http/session"
+
+module HTTP
+  class << self
+    # @param [Hash] default_options
+    # @option default_options [Boolean, Hash] :cookies session cookies option
+    # @option default_options [Boolean, Hash] :cache session cache option
+    # @option default_options [Hash] :http http client options
+    # @return [Session] a new instance of Session.
+    def session(default_options = {})
+      HTTP::Session.new(default_options)
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ruby-http-session
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- John Doe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: HTTP::Session - a session abstraction for http.rb in order to support
+  cookies and caching.
+email:
+- johndoe@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- http-session.gemspec
+- lib/http-session.rb
+- lib/http-session/webmock.rb
+- lib/http/session.rb
+- lib/http/session/cache.rb
+- lib/http/session/cache/cache_control.rb
+- lib/http/session/cache/entry.rb
+- lib/http/session/cache/status.rb
+- lib/http/session/client.rb
+- lib/http/session/client/perform.rb
+- lib/http/session/configurable.rb
+- lib/http/session/features/auto_inflate.rb
+- lib/http/session/options.rb
+- lib/http/session/options/cache_option.rb
+- lib/http/session/options/cookies_option.rb
+- lib/http/session/request.rb
+- lib/http/session/requestable.rb
+- lib/http/session/response.rb
+- lib/http/session/response/string_body.rb
+- lib/http/session/version.rb
+homepage: https://github.com/souk4711/http-session
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/souk4711/http-session
+  source_code_uri: https://github.com/souk4711/http-session
+  changelog_uri: https://github.com/souk4711/http-session
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: HTTP::Session - a session abstraction for http.rb in order to support cookies
+  and caching.
+test_files: []