curlify 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a48b30cfd32c1b91c5a582817d8f14f4591a163d849e4bee0571e9a30b51e616
-  data.tar.gz: ae6700a423572016a5c60ad5130921249d5f63cd8064761408fbce0022e88945
+  metadata.gz: 61f726c478086bdbcaddeb6b7854c5436e712d489de412a94d9fc4d11ab64ae8
+  data.tar.gz: a61aa42711acf30bfb6ed41e00dc8b9f4731a1a7f296e4dfccd287f70196f4e6
 SHA512:
-  metadata.gz: 856229b5b419e3affd619dcb8844607eb89fe08335f6192171e624c57f304d4b0b4c870d3bc5d9e304ebe9598998c3ccc30198292267029818ff97588d4c1160
-  data.tar.gz: fcc0f724a986b7d7d761dcfa2669c90d0ec5a75c4b627e6e1e8e4a6fa12c5d845a1248c6c5df861ae6750ee4462911eed4f7e28d230b9845534141db85df5546
+  metadata.gz: 998ad7457a2f3d50d99dc0481bb58af0e97a25d74ea0edf0d90255971dfee299a6b308a0c39a4b82ada657628fc8510d12a25eb4740f6392ff8b493ce06f05da
+  data.tar.gz: 28d7484b3fdeaaffa253885646577db7986735e2938dbb25c7c5f7224af002505548bbb923cdd390387336d22293220a9f3aded5fbb3c2031e0070afedc9a654

data/README.md

@@ -1,4 +1,11 @@
-The gem convert ruby requests(net/http) into curl command.
+The gem converts ruby requests to curl
+
+## Features
+
+- **Multi-Framework Support**: Works with Faraday and Net::HTTP requests
+- **Clipboard Integration**: Copy generated curl commands directly to clipboard (macOS, Windows, Linux)
+- **Configuration Management**: YAML-based settings for customizing Curlify behavior
+- **Simple API**: Easy-to-use interface with minimal configuration required
 
 ## Installation
 
@@ -46,6 +53,131 @@ request.body = { title: 'Ruby is great :)' }.to_json
 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.
+
+Supported platforms:
+- macOS: uses `pbcopy`
+- Windows: uses `clip`
+- Linux: uses `xclip` (must be installed and available in `PATH`)
+
+If `xclip` is not available on Linux, Curlify will print a warning: `Curlify Warning: 'xclip' is required for clipboard support on Linux.`
+
+## Configuration
+
+Curlify supports configuration management through a YAML settings file. You can customize the default behavior by creating a `settings.yml` configuration file in your `config` directory.
+
+### Creating Your Configuration File
+
+#### Step 1: Create the config directory (if it doesn't exist)
+
+```bash
+mkdir -p config
+```
+
+#### Step 2: Create the settings.yml file
+
+Create a file named `settings.yml` in the `config` directory:
+
+```bash
+touch config/settings.yml
+```
+
+#### Step 3: Configure your settings
+
+Open `config/settings.yml` and add your Curlify configuration options:
+
+```yaml
+# config/settings.yml
+clipboard: false
+verify: true
+compressed: false
+```
+
+### Available Configuration Options
+
+- **clipboard** (boolean, default: `false`): Automatically copy generated curl commands to the clipboard
+  - `true`: Copy curl command to clipboard
+  - `false`: Only return the curl string
+
+- **verify** (boolean, default: `true`): Verify SSL certificates when making requests
+  - `true`: Verify SSL certificates
+  - `false`: Skip SSL verification (use with caution)
+
+- **compressed** (boolean, default: `false`): Add compression support to curl commands
+  - `true`: Add `--compressed` flag to curl command
+  - `false`: No compression flag
+
+### Usage Examples
+
+#### Example 1: Basic Configuration
+
+```yaml
+# config/settings.yml
+clipboard: false
+verify: true
+compressed: false
+```
+
+Then use Curlify normally:
+
+```ruby
+require 'faraday'
+require 'curlify'
+
+request = Faraday.new.build_request(:post) do |req|
+  req.url 'http://127.0.0.1'
+end
+
+# Uses settings from config/settings.yml
+Curlify.new(request).to_curl
+```
+
+#### Example 2: Enable Clipboard Support
+
+```yaml
+# config/settings.yml
+clipboard: true
+verify: true
+compressed: false
+```
+
+Now every curl command will be automatically copied to your clipboard:
+
+```ruby
+require 'faraday'
+require 'curlify'
+
+request = Faraday.new.build_request(:get) do |req|
+  req.url 'https://api.example.com/data'
+end
+
+curl_command = Curlify.new(request).to_curl
+# curl_command is now in your clipboard!
+puts curl_command
+```
+
+#### Example 3: Production Configuration
+
+```yaml
+# config/settings.yml
+clipboard: false
+verify: true
+compressed: true
+```
+
+This configuration is suitable for production environments where you want:
+- No automatic clipboard operations
+- SSL verification enabled for security
+- Compressed curl commands
+
+### Troubleshooting
+
+- **Configuration file not found**: Make sure the `config/settings.yml` file exists in your project root directory
+- **Settings not loading**: Verify the YAML syntax is correct (indentation matters in YAML)
+- **Clipboard not working on Linux**: Ensure `xclip` is installed: `sudo apt-get install xclip`
+
 Performing this curl command, we can see the following result:
 
 ```bash

data/lib/curlify.rb

@@ -2,26 +2,38 @@
 
 require 'faraday'
 
+require_relative 'settings'
+
 class Curlify
-  attr_reader :request, :verify, :compressed
+  attr_reader :request
 
-  def initialize(request, compressed: false, verify: true)
+  def initialize(request)
     @request = request
-    @compressed = compressed
-    @verify = verify
+
+    Settings.call.each do |key, value|
+      instance_variable_set("@#{key}", value)
+      define_singleton_method(key) { instance_variable_get("@#{key}") }
+    end
   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 #{http_method.upcase} #{headers} #{body} #{url}"
+    "curl -X #{http_method.upcase} #{headers} #{body} #{url}".strip
   end
 
   def headers
@@ -47,4 +59,24 @@ class Curlify
   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

data/lib/settings.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+class Settings
+  def self.call
+    new.send(:params)
+  end
+
+  private
+
+  def params
+    YAML.safe_load(
+      read_file,
+      permitted_classes: [],
+      permitted_symbols: [],
+      aliases: true
+    )
+  end
+
+  def read_file
+    File.read(
+      File.join('config', 'settings.yml')
+    )
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: curlify
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcus Almeida
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,17 +23,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description: The gem convert python requests object in curl command.
+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
 - lib/curlify.rb
+- lib/settings.rb
 homepage: https://rubygems.org/gems/curlify
 licenses:
 - MIT
@@ -43,7 +44,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:
@@ -59,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Hola!
+summary: Convert Ruby HTTP request objects into curl commands
 test_files: []