fetch-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8968e4c64a4d0b5370aef72a78f1b4ac04096057deb92d1bc1a6dd14353b3cd
-  data.tar.gz: 2b7cdf82b75cf2c2d51abd5693f1ad278242e4e93645779b0909bfa7fd62de7a
+  metadata.gz: ae66c4ee1f7d2b11e55480e6456be9eb78f5b1f6a2da0a22fb0cef1b4388328b
+  data.tar.gz: 2995e13999494f718966a8dc3f293342593a17f88a0c003b702243ae710492e2
 SHA512:
-  metadata.gz: 39bfda51fed25d97acb41128134615980b4eb35357a790d76c79feb1bf57c06e7f2047e2908c530d346e1b051f79b1846cf01c912209d1be6cebb7d1eeaf88c1
-  data.tar.gz: 42cd5a712cfe067f16e70482c6013162d2a29d76666d709d5032badc79a4202a9c474d1ba38dd19598657ae1b2b0d51f5de32ef49ce7395d6221ba1f7d752526
+  metadata.gz: 81683853c7d4e62b19dd0e4472b343958d656c361251239e160c44504b5671ba3b32078626433fd63f0be5a5a6290564cdc232f1db0a2c8dbbf462320b2102d8
+  data.tar.gz: ca6a9131aa1a4a3c504e74521b3c8244e89a66cc4f5e2e9bb27a7974352c910a7a869cd1ab96b531ccf694f3565e5ba93ae8de21d374006ac533ddb0f289241e

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.
 
@@ -30,9 +30,11 @@ require 'fetch-api'
 res = Fetch::API.fetch('https://example.com')
 
 # res is a Rack::Response object
-puts res.body
+puts res.body.first
 ```
 
+or
+
 ``` ruby
 require 'fetch-api'
 
@@ -41,6 +43,13 @@ include Fetch::API
 res = fetch('https://example.com')
 ```
 
+Supported options are as follows:
+
+- `method`: HTTP method (default: `'GET'`)
+- `headers`: Request headers (default: `{}`)
+- `body`: Request body (default: `nil`)
+- `redirect`: Follow redirects (one of `follow`, `error`, `manual`, default: `follow`)
+
 ### Post JSON
 
 ``` ruby
@@ -57,23 +66,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,7 +1,9 @@
 require_relative '../fetch'
+require_relative 'form_data'
+require_relative 'url_search_params'
 
+require 'marcel'
 require 'net/http'
-require 'net/https'
 require 'rack/response'
 require 'singleton'
 require 'uri'
@@ -18,7 +20,25 @@ module Fetch
         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,9 +49,9 @@ module Fetch
       when Net::HTTPRedirection
         case redirect
         when 'follow'
-          fetch(res['location'], method:, headers:, body:, redirect:)
+          fetch(res['Location'], method:, headers:, body:, redirect:)
         when 'error'
-          raise RedirectError, "redirected to #{res['location']}"
+          raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
           to_rack_response(res)
         else

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/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.2.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.2.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,8 @@ files:
 - lib/fetch.rb
 - lib/fetch/api.rb
 - lib/fetch/client.rb
+- lib/fetch/form_data.rb
+- lib/fetch/url_search_params.rb
 - lib/fetch/version.rb
 - sig/fetch.rbs
 homepage: https://github.com/ursm/fetch-api