fetch-api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8968e4c64a4d0b5370aef72a78f1b4ac04096057deb92d1bc1a6dd14353b3cd
-  data.tar.gz: 2b7cdf82b75cf2c2d51abd5693f1ad278242e4e93645779b0909bfa7fd62de7a
+  metadata.gz: dc8cbe5804a5286df86b5840189dbbe3c1cfc77e68bfd33b0ba3244be99af5c2
+  data.tar.gz: f72c409553a6b531803d084d8e862c77329ef785579e9a11b5a461fadd481ca3
 SHA512:
-  metadata.gz: 39bfda51fed25d97acb41128134615980b4eb35357a790d76c79feb1bf57c06e7f2047e2908c530d346e1b051f79b1846cf01c912209d1be6cebb7d1eeaf88c1
-  data.tar.gz: 42cd5a712cfe067f16e70482c6013162d2a29d76666d709d5032badc79a4202a9c474d1ba38dd19598657ae1b2b0d51f5de32ef49ce7395d6221ba1f7d752526
+  metadata.gz: 6051e1551078686b6624604b23966804684f7a764ffb76c467e79cf5bfd09e0025c8dd315803b0e7c8b1fe83874e349984c1a3fa325306fb4c09d1f855524e0c
+  data.tar.gz: 6340aa6ca403e46a023753fd08144081009512a3b97c12a3b035ac58aa951e49e1218e7d543a52151d9600022ed40773f00c655926eaa5d59b7fc9c3f9fc8ca3

data/README.md

@@ -1,4 +1,4 @@
-# Fetch API
+# Fetch API for Ruby
 
 Ruby's Net::HTTP is very powerful, but has a complicated API. OpenURI is easy to use, but has limited functionality. Third-party HTTP clients each have different APIs, and it can sometimes be difficult to learn how to use them.
 
@@ -29,10 +29,12 @@ require 'fetch-api'
 
 res = Fetch::API.fetch('https://example.com')
 
-# res is a Rack::Response object
+# res is a Fetch::Response object
 puts res.body
 ```
 
+or
+
 ``` ruby
 require 'fetch-api'
 
@@ -41,6 +43,24 @@ include Fetch::API
 res = fetch('https://example.com')
 ```
 
+Options for `fetch` method:
+
+- `method`: HTTP method (default: `'GET'`)
+- `headers`: Request headers (default: `{}`)
+- `body`: Request body (default: `nil`)
+- `redirect`: Follow redirects (one of `follow`, `error`, `manual`, default: `follow`)
+
+Methods of `Fetch::Response` object:
+
+- `body`: Response body (String)
+- `headers`: Response headers
+- `ok`: Whether the response was successful or not (status code is in the range 200-299)
+- `redirected`: Whether the response is the result of a redirect
+- `status`: Status code (e.g. `200`, `404`)
+- `status_text`: Status text (e.g. `'OK'`, `'Not Found'`)
+- `url`: Response URL
+- `json(**args)`: An object that parses the response body as JSON. The arguments are passed to `JSON.parse`
+
 ### Post JSON
 
 ``` ruby
@@ -57,23 +77,30 @@ res = fetch('http://example.com', **{
 })
 ```
 
-### Post Form
+### Post application/x-www-form-urlencoded
 
 ``` ruby
 res = fetch('http://example.com', **{
   method: 'POST',
 
-  headers: {
-    'Content-Type' => 'multipart/form-data'
-  },
-
-  body: Rack::Multipart.build_multipart(
-    file: Rack::Multipart::UploadedFile.new(io: StringIO.new('foo'), filename: 'foo.txt')
+  body: Fetch::URLSearchParams.new(
+    name: 'Alice'
   )
 })
 ```
 
-Note: `Rack::Multipart.build_multipart` returns nil if the parameter does not include UploadedFile.
+### Post multipart/form-data
+
+``` ruby
+res = fetch('http://example.com', **{
+  method: 'POST',
+
+  body: Fetch::FormData.build(
+    name: 'Alice',
+    file: File.open('path/to/file.txt')
+  )
+})
+```
 
 ## Development
 

data/lib/fetch/client.rb

@@ -1,8 +1,11 @@
 require_relative '../fetch'
+require_relative 'form_data'
+require_relative 'headers'
+require_relative 'response'
+require_relative 'url_search_params'
 
+require 'marcel'
 require 'net/http'
-require 'net/https'
-require 'rack/response'
 require 'singleton'
 require 'uri'
 
@@ -10,15 +13,35 @@ module Fetch
   class Client
     include Singleton
 
-    def fetch(resource, method: 'GET', headers: {}, body: nil, redirect: 'follow')
+    def fetch(resource, method: 'GET', headers: [], body: nil, redirect: 'follow', _redirected: false)
       uri = URI.parse(resource)
       req = Net::HTTP.const_get(method.capitalize).new(uri)
 
+      headers = Headers.new(headers) unless headers.is_a?(Headers)
+
       headers.each do |k, v|
         req[k] = v
       end
 
-      req.body = body
+      case body
+      when FormData
+        req.set_form body.entries.map {|k, v|
+          if v.is_a?(File)
+            [k, v, {
+              filename:     File.basename(v.path),
+              content_type: Marcel::MimeType.for(v) || 'application/octet-stream'
+            }]
+          else
+            [k, v]
+          end
+        }, 'multipart/form-data'
+      when URLSearchParams
+        req['Content-Type'] ||= 'application/x-www-form-urlencoded'
+
+        req.body = body.to_s
+      else
+        req.body = body
+      end
 
       http = Net::HTTP.new(uri.hostname, uri.port)
       http.use_ssl = uri.scheme == 'https'
@@ -29,23 +52,37 @@ module Fetch
       when Net::HTTPRedirection
         case redirect
         when 'follow'
-          fetch(res['location'], method:, headers:, body:, redirect:)
+          fetch(res['Location'], method:, headers:, body:, redirect:, _redirected: true)
         when 'error'
-          raise RedirectError, "redirected to #{res['location']}"
+          raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
-          to_rack_response(res)
+          to_response(resource, res, _redirected)
         else
           raise ArgumentError, "invalid redirect option: #{redirect}"
         end
       else
-        to_rack_response(res)
+        to_response(resource, res, _redirected)
       end
     end
 
     private
 
-    def to_rack_response(res)
-      Rack::Response.new(res.body, res.code, res.to_hash)
+    def to_response(url, res, redirected)
+      headers = Headers.new
+
+      res.each do |k, vs|
+        vs.split(', ').each do |v|
+          headers.append k, v
+        end
+      end
+
+      Response.new(
+        url:        ,
+        status:     res.code.to_i,
+        headers:    ,
+        body:       res.body,
+        redirected:
+      )
     end
   end
 end

data/lib/fetch/form_data.rb

@@ -0,0 +1,60 @@
+module Fetch
+  class FormData
+    include Enumerable
+
+    def self.build(enumerable)
+      data = FormData.new
+
+      enumerable.each do |k, v|
+        data.append k, v
+      end
+
+      data
+    end
+
+    def initialize
+      @entries = []
+    end
+
+    attr_reader :entries
+
+    def append(key, value)
+      @entries.push [key.to_s, value]
+    end
+
+    def delete(key)
+      @entries.reject! {|k,| k == key.to_s }
+    end
+
+    def get(key)
+      @entries.assoc(key.to_s)&.last
+    end
+
+    def get_all(key)
+      @entries.select {|k,| k == key.to_s }.map(&:last)
+    end
+
+    def has(key)
+      @entries.any? {|k,| k == key.to_s }
+    end
+
+    def keys
+      @entries.map(&:first)
+    end
+
+    def set(key, value)
+      delete key
+      append key, value
+    end
+
+    def values
+      @entries.map(&:last)
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      @entries.each(&block)
+    end
+  end
+end

data/lib/fetch/headers.rb

@@ -0,0 +1,50 @@
+module Fetch
+  class Headers
+    include Enumerable
+
+    def initialize(init = [])
+      @entries = []
+
+      init.each do |k, v|
+        append k, v
+      end
+    end
+
+    attr_reader :entries
+
+    def append(key, value)
+      @entries << [key.to_s.downcase, value]
+    end
+
+    def delete(key)
+      @entries.delete_if {|k,| k == key.to_s.downcase }
+    end
+
+    def get(key)
+      @entries.select {|k,| k == key.to_s.downcase }.map(&:last).join(', ')
+    end
+
+    def has(key)
+      @entries.any? {|k,| k == key.to_s.downcase }
+    end
+
+    def keys
+      @entries.map(&:first)
+    end
+
+    def set(key, value)
+      delete key
+      append key, value
+    end
+
+    def values
+      @entries.map(&:last)
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      @entries.each(&block)
+    end
+  end
+end

data/lib/fetch/response.rb

@@ -0,0 +1,18 @@
+require 'json'
+require 'rack/utils'
+
+module Fetch
+  Response = Data.define(:url, :status, :headers, :body, :redirected) {
+    def ok
+      status.between?(200, 299)
+    end
+
+    def status_text
+      Rack::Utils::HTTP_STATUS_CODES[status]
+    end
+
+    def json(**opts)
+      JSON.parse(body, **opts)
+    end
+  }
+end

data/lib/fetch/url_search_params.rb

@@ -0,0 +1,71 @@
+require 'uri'
+
+module Fetch
+  class URLSearchParams
+    include Enumerable
+
+    def initialize(options = [])
+      @entries = []
+
+      case options
+      when String
+        initialize(URI.decode_www_form(options.delete_prefix('?')))
+      when Enumerable
+        options.each do |k, v|
+          append k, v
+        end
+      else
+        raise ArgumentError
+      end
+    end
+
+    attr_reader :entries
+
+    def append(key, value)
+      @entries.push [key.to_s, value]
+    end
+
+    def delete(key)
+      @entries.reject! {|k,| k == key.to_s }
+    end
+
+    def get(key)
+      @entries.assoc(key.to_s)&.last
+    end
+
+    def get_all(key)
+      @entries.select {|k,| k == key.to_s }.map(&:last)
+    end
+
+    def has(key)
+      @entries.any? {|k,| k == key.to_s }
+    end
+
+    def keys
+      @entries.map(&:first)
+    end
+
+    def set(key, value)
+      delete key
+      append key, value
+    end
+
+    def sort
+      @entries.sort_by!(&:first)
+    end
+
+    def to_s
+      URI.encode_www_form(@entries)
+    end
+
+    def values
+      @entries.map(&:last)
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      @entries.each(&block)
+    end
+  end
+end

data/lib/fetch/version.rb

@@ -1,3 +1,3 @@
 module Fetch
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/fetch.rb

@@ -1,5 +1,4 @@
 require_relative 'fetch/version'
-require_relative 'fetch/api'
 
 module Fetch
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keita Urashima
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +93,10 @@ files:
 - lib/fetch.rb
 - lib/fetch/api.rb
 - lib/fetch/client.rb
+- lib/fetch/form_data.rb
+- lib/fetch/headers.rb
+- lib/fetch/response.rb
+- lib/fetch/url_search_params.rb
 - lib/fetch/version.rb
 - sig/fetch.rbs
 homepage: https://github.com/ursm/fetch-api
@@ -95,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="