hearth 1.0.0.pre1 → 1.0.0.pre2

data/lib/hearth/http/response.rb

@@ -1,29 +1,58 @@
 # frozen_string_literal: true
 
-require 'stringio'
-
 module Hearth
   module HTTP
     # Represents an HTTP Response.
-    # @api private
-    class Response
+    class Response < Hearth::Response
       # @param [Integer] status
-      # @param [Headers] headers
-      # @param [IO] body
-      def initialize(status: 200, headers: Headers.new, body: StringIO.new)
+      # @param [String, nil] reason
+      # @param [Fields] fields
+      # @param (see Hearth::Response#initialize)
+      def initialize(status: 0, reason: nil, fields: Fields.new, **kwargs)
+        super(**kwargs)
         @status = status
-        @headers = headers
-        @body = body
+        @reason = reason
+        @fields = fields
+        @headers = Fields::Proxy.new(@fields, :header)
+        @trailers = Fields::Proxy.new(@fields, :trailer)
       end
 
       # @return [Integer]
       attr_accessor :status
 
-      # @return [Headers]
-      attr_accessor :headers
+      # @return [String, nil]
+      attr_accessor :reason
+
+      # @return [Fields]
+      attr_reader :fields
+
+      # @return [Fields::Proxy]
+      attr_reader :headers
+
+      # @return [Fields::Proxy]
+      attr_reader :trailers
 
-      # @return [IO]
-      attr_accessor :body
+      # Replace attributes from other response
+      # @param [Response] other
+      # @return [Response]
+      def replace(other)
+        @status = other.status
+        @reason = other.reason
+        @fields = other.fields
+        @headers = Fields::Proxy.new(@fields, :header)
+        @trailers = Fields::Proxy.new(@fields, :trailer)
+
+        super
+      end
+
+      # Resets the HTTP response.
+      # @return [Response]
+      def reset
+        @status = 0
+        @reason = nil
+        @fields.clear
+        super
+      end
     end
   end
 end

data/lib/hearth/http.rb

@@ -3,9 +3,11 @@
 require 'cgi'
 require_relative 'http/api_error'
 require_relative 'http/client'
+require_relative 'http/error_inspector'
 require_relative 'http/error_parser'
-require_relative 'http/headers'
-require_relative 'http/middleware/content_length'
+require_relative 'http/field'
+require_relative 'http/fields'
+require_relative 'http/middleware'
 require_relative 'http/networking_error'
 require_relative 'http/request'
 require_relative 'http/response'
@@ -13,21 +15,28 @@ require_relative 'http/response'
 module Hearth
   # HTTP namespace for HTTP specific functionality. Also includes utility
   # methods for URI escaping.
-  # @api private
   module HTTP
-    # TODO: - do these belong here?
     class << self
       # URI escapes the given value.
       #
-      #   Hearth::_escape("a b/c")
+      #   Hearth.uri_escape("a b/c")
       #   #=> "a%20b%2Fc"
       #
       # @param [String] value
       # @return [String] URI encoded value except for '+' and '~'.
+      # @api private
       def uri_escape(value)
         CGI.escape(value.encode('UTF-8')).gsub('+', '%20').gsub('%7E', '~')
       end
 
+      # URI escapes the given path.
+      #
+      #   Hearth.uri_escape_path("a b/c")
+      #   #=> "a%20b/c"
+      #
+      # @param [String] path
+      # @return [String] URI encoded path except for '+' and '~'.
+      # @api private
       def uri_escape_path(path)
         path.gsub(%r{[^/]+}) { |part| uri_escape(part) }
       end

data/lib/hearth/identities/anonymous.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Identities
+    # Anonymous identity.
+    class Anonymous < Identities::Base; end
+  end
+end

data/lib/hearth/identities/http_api_key.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Identities
+    # Identity class for API Key authentication.
+    class HTTPApiKey < Identities::Base
+      def initialize(key:, **kwargs)
+        super(**kwargs)
+        @key = key
+      end
+
+      # @return [String]
+      attr_reader :key
+    end
+  end
+end

data/lib/hearth/identities/http_bearer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Identities
+    # Identity class for bearer token authentication.
+    class HTTPBearer < Identities::Base
+      def initialize(token:, **kwargs)
+        super(**kwargs)
+        @token = token
+      end
+
+      # @return [String]
+      attr_reader :token
+    end
+  end
+end

data/lib/hearth/identities/http_login.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Identities
+    # Identity class for login authentication.
+    class HTTPLogin < Identities::Base
+      def initialize(username:, password:, **kwargs)
+        super(**kwargs)
+        @username = username
+        @password = password
+      end
+
+      # @return [String]
+      attr_reader :username
+
+      # @return [String]
+      attr_reader :password
+    end
+  end
+end

data/lib/hearth/identities.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hearth
+  # Namespace for all Identity classes.
+  module Identities
+    # Base class for all Identity classes.
+    class Base
+      def initialize(expiration: nil)
+        @expiration = expiration
+      end
+
+      # @return [Time, nil]
+      attr_reader :expiration
+    end
+  end
+end
+
+require_relative 'identities/anonymous'
+require_relative 'identities/http_api_key'
+require_relative 'identities/http_bearer'
+require_relative 'identities/http_login'

data/lib/hearth/identity_resolver.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Hearth
+  # Basic Identity resolver that uses a proc to resolve an Identity.
+  class IdentityResolver
+    # @param [Proc] proc A proc that takes identity properties (Hash)
+    #   and returns a {Hearth::Identities::Base}.
+    def initialize(proc)
+      @proc = proc
+    end
+
+    # @param [Hash] properties
+    def identity(properties = {})
+      @proc.call(properties)
+    end
+  end
+end