curlify 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a3fea5ff081b12d6de36265e700ca9c6d527672b21be0cd1f4877682e6757b
-  data.tar.gz: 6ccab146f35e8649debeb1f04633bae4a32a9e50758247e5fc1926f595f0f9fd
+  metadata.gz: 61f726c478086bdbcaddeb6b7854c5436e712d489de412a94d9fc4d11ab64ae8
+  data.tar.gz: a61aa42711acf30bfb6ed41e00dc8b9f4731a1a7f296e4dfccd287f70196f4e6
 SHA512:
-  metadata.gz: ffb9587d3dad61225f2b2c55498da7605f4a497cb12b35360346421ffa761eac3136b392e6e5db62a6bbf589a087c78284636642b2a08c8781aed367bd193cdf
-  data.tar.gz: 3456eb8c4efcd1f5321a7a8656e2fea962f5ed8461cae8ac837093166d91ab6bff0f2388db2bcd40abf63acc05b8ae10bac1e1d2059dc50d37637a5aa8907261
+  metadata.gz: 998ad7457a2f3d50d99dc0481bb58af0e97a25d74ea0edf0d90255971dfee299a6b308a0c39a4b82ada657628fc8510d12a25eb4740f6392ff8b493ce06f05da
+  data.tar.gz: 28d7484b3fdeaaffa253885646577db7986735e2938dbb25c7c5f7224af002505548bbb923cdd390387336d22293220a9f3aded5fbb3c2031e0070afedc9a654

data/README.md

@@ -1,5 +1,12 @@
 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
 
 To install the gem use `bundle` or `gem`, see:
@@ -55,15 +62,121 @@ Supported platforms:
 - Windows: uses `clip`
 - Linux: uses `xclip` (must be installed and available in `PATH`)
 
-Example:
+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
-# copy to clipboard and return the curl string
-Curlify.new(request, clipboard: true).to_curl
+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
 ```
 
-If `xclip` is not available on Linux, Curlify will print a warning: `Curlify Warning: 'xclip' is required for clipboard support on Linux.`
+#### 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:
 

data/lib/curlify.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'byebug'
+
+require_relative 'settings'
 
 class Curlify
-  attr_reader :request, :verify, :compressed, :clipboard
+  attr_reader :request
 
-  def initialize(request, compressed: false, verify: true, clipboard: false)
+  def initialize(request)
     @request = request
-    @compressed = compressed
-    @verify = verify
-    @clipboard = clipboard
+
+    Settings.call.each do |key, value|
+      instance_variable_set("@#{key}", value)
+      define_singleton_method(key) { instance_variable_get("@#{key}") }
+    end
   end
 
   def to_curl

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curlify
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcus Almeida
@@ -35,6 +35,7 @@ files:
 - LICENSE
 - README.md
 - lib/curlify.rb
+- lib/settings.rb
 homepage: https://rubygems.org/gems/curlify
 licenses:
 - MIT