curlify 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f8603bf909c7334127104c8fab5861f012831d6fa81da078babdabbc57c4fd8
-  data.tar.gz: '088456a7f8dacbbd4a9907117fc0d2fa804a4947e29f0de85d18860364be9c29'
+  metadata.gz: 76a3fea5ff081b12d6de36265e700ca9c6d527672b21be0cd1f4877682e6757b
+  data.tar.gz: 6ccab146f35e8649debeb1f04633bae4a32a9e50758247e5fc1926f595f0f9fd
 SHA512:
-  metadata.gz: 11f6723c766d88aae5d04034bab585e699abd729282ab6f0b520bd177f7d8e519cb50eb03f2cd4de70303a3e5663e0b593f702378aac6aa267da82c7eb9dcb5d
-  data.tar.gz: 2ff5487bba2d8491e1295be94f37dcef6fe1dff2a52b977c614d7dda06887774e73856b55ba812003e2f8d2cc6d502454649c5efce5bf0368becb3d6d9879224
+  metadata.gz: ffb9587d3dad61225f2b2c55498da7605f4a497cb12b35360346421ffa761eac3136b392e6e5db62a6bbf589a087c78284636642b2a08c8781aed367bd193cdf
+  data.tar.gz: 3456eb8c4efcd1f5321a7a8656e2fea962f5ed8461cae8ac837093166d91ab6bff0f2388db2bcd40abf63acc05b8ae10bac1e1d2059dc50d37637a5aa8907261

data/README.md

@@ -1,4 +1,4 @@
-The gem convert ruby requests(net/http) into curl command.
+The gem converts ruby requests to curl
 
 ## Installation
 
@@ -14,11 +14,27 @@ or bundle:
 $ bundle add curlify
 ```
 
-## Usage
+## Usage with faraday
 
-Import `curlify`, `uri` and `net/http` gems and execute curlify, see:
+Import `curlify` and `faraday` and perform curlify, see:
 
-```python
+```ruby
+require 'faraday'
+require 'curlify'
+
+request = Faraday.new.build_request(:post) do |req|
+  req.url 'http://127.0.0.1'
+end
+
+Curlify.new(request).to_curl # "curl -X POST -H 'User-Agent: Faraday v2.9.0'  http://127.0.0.1"
+```
+
+## Usage with net/http
+
+Import `curlify`, `uri` and `net/http` and perform curlify, see:
+
+```ruby
+require 'json'
 require 'uri'
 require 'net/http'
 require 'curlify'
@@ -27,14 +43,29 @@ uri = URI('https://httpbin.org/post')
 request = Net::HTTP::Post.new(uri, { 'content-type': 'application/json' })
 request.body = { title: 'Ruby is great :)' }.to_json
 
-curlify = Curlify.new(request)
+Curlify.new(request).to_curl # curl -X POST -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: httpbin.org' -d '{"title":"Ruby is great :)"}' https://httpbin.org/post
+```
+
+## Clipboard support
+
+Curlify can copy the generated curl command directly to the operating system clipboard. To enable this behavior, pass `clipboard: true` when creating the `Curlify` instance. The method still returns the curl string.
 
-puts curlify.to_curl
+Supported platforms:
+- macOS: uses `pbcopy`
+- Windows: uses `clip`
+- Linux: uses `xclip` (must be installed and available in `PATH`)
 
-# curl -X POST -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: httpbin.org' -d '{"title":"Ruby is great :)"}' https://httpbin.org/post
+Example:
+
+```ruby
+# copy to clipboard and return the curl string
+Curlify.new(request, clipboard: true).to_curl
 ```
 
-Running this command generated, we have the following result:
+If `xclip` is not available on Linux, Curlify will print a warning: `Curlify Warning: 'xclip' is required for clipboard support on Linux.`
+
+
+Performing this curl command, we can see the following result:
 
 ```bash
 {

data/lib/curlify.rb

@@ -1,32 +1,79 @@
 # frozen_string_literal: true
 
+require 'faraday'
+require 'byebug'
+
 class Curlify
-  attr_reader :request, :verify, :compressed
+  attr_reader :request, :verify, :compressed, :clipboard
 
-  def initialize(request, compressed: false, verify: true)
+  def initialize(request, compressed: false, verify: true, clipboard: false)
     @request = request
     @compressed = compressed
     @verify = verify
+    @clipboard = clipboard
   end
 
   def to_curl
-    return curl_request << ' --compressed' if compressed
-    return curl_request << ' --insecure' unless verify
-
-    curl_request
+    command = build_curl_command
+    copy_to_clipboard(command)
+    command
   end
 
   private
 
+  def build_curl_command
+    [
+      curl_request,
+      verify ? nil : '--insecure',
+      compressed ? '--compressed' : nil
+    ].compact.join(' ')
+  end
+
   def curl_request
-    "curl -X #{request.method} #{headers} #{body} #{request.uri}"
+    "curl -X #{http_method.upcase} #{headers} #{body} #{url}".strip
   end
 
   def headers
-    request.each_header.map { |key, value| "-H '#{key}: #{value}'" }.join(' ')
+    if request.is_a?(Faraday::Request)
+      context_headers(request.headers)
+    else
+      context_headers(request.each_header)
+    end
+  end
+
+  def http_method
+    request.is_a?(Faraday::Request) ? request.http_method : request.method
+  end
+
+  def url
+    request.is_a?(Faraday::Request) ? request.path : request.uri
   end
 
   def body
     "-d '#{request.body}'" unless request.body.nil?
   end
+
+  def context_headers(headers)
+    headers.map { |k, v| "-H '#{k}: #{v}'" }.join(' ')
+  end
+
+  def copy_to_clipboard(string)
+    return unless clipboard
+
+    command = clipboard_command
+    return warn("Curlify Warning: 'xclip' is required for clipboard support on Linux.") unless command
+
+    IO.popen(command, 'w') { |f| f << string }
+  end
+
+  def clipboard_command
+    case RUBY_PLATFORM
+    when /darwin/
+      'pbcopy'
+    when /mswin|mingw|cygwin/
+      'clip'
+    when /linux/
+      'xclip -selection clipboard' if system('which xclip > /dev/null 2>&1')
+    end
+  end
 end

metadata

@@ -1,22 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: curlify
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Marcus Almeida
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
-dependencies: []
-description: The gem convert python requests object in curl command.
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Convert Ruby HTTP request and client objects into their equivalent curl
+  command. Useful for debugging and sharing HTTP requests.
 email: mpereirassa@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
@@ -29,7 +43,6 @@ metadata:
   bug_tracker_uri: https://github.com/marcuxyz/curlify/issues
   changelog_uri: https://github.com/marcuxyz/curlify/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -38,15 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 2.7.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Hola!
+summary: Convert Ruby HTTP request objects into curl commands
 test_files: []