httparty_curl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6326e21907094579b265b6058d10bbf324a232af78107014094f4f9302a664f
-  data.tar.gz: 6ea21e2db0aadefeef5814acfcb1a70c88022c2917f00679ec97b958bf378314
+  metadata.gz: c4b9276e692736e8a2bdd94e26c802b5a1b41a0d617ace96f467f1d8ca4c3728
+  data.tar.gz: accf966bd2a76362b3f031547e80a5ebb2b46830909b73f92e249465b55fd06d
 SHA512:
-  metadata.gz: fb447d219baa96116854968bdd9b1e7e47733c02548dd4f57a8f1444a403ec12dd559ed9ab0267e1ce722d94a1937c788d94e5c5e64ec4427191165a84c709e5
-  data.tar.gz: 036730dc4ebf953d1aae54c7e7abfa0e1c9e899bdf184e9cd17e5893db0949ce05301b5911d9445bbb35f5e27456da93bdc683bc660e6540f34bc1a1e1c92381
+  metadata.gz: c04728ea33e9a1f020dff1974e8cf5ff17258f0f9cd46c01b7cc025281a09b2e55e414682b4d95f343879f26c619926288d30ebb971b69e8aa036682bb482af0
+  data.tar.gz: 5ceccaa74625648fa4f126e26cce69352211a422268291f0b6f611ebfbbc19f09cf18aa7ce6c7c0192d76fef7cc14dc97db54aafc6a4eed9463d75b20181dd92

data/README.md

@@ -92,6 +92,26 @@ curl -X GET 'https://api.example.com/data' \
   -u 'username:password'
 ```
 
+## Environment-Based Logging
+
+By default, `HTTPartyCurl` enables cURL logging in `development` and `test` environments when used within a Rails application. In other environments, logging is disabled by default.
+
+### Rails Applications
+
+No additional configuration is needed. Logging is automatically enabled in `development` and `test` environments.
+
+### Non-Rails Applications
+
+For non-Rails applications, you can manually set the environment or configure logging:
+
+```ruby
+# Set the environment (e.g., :development, :test, :production)
+HTTPartyCurl.configuration.environment = :development
+
+# Or manually enable logging
+HTTPartyCurl.configuration.curl_logging_enabled = true
+```
+
 ## Customization
 
 ### Supported HTTP Methods

data/lib/httparty_curl/version.rb

@@ -2,5 +2,5 @@
 
 module HTTPartyCurl
   # Gem version number.
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/httparty_curl.rb

@@ -13,17 +13,39 @@ module HTTPartyCurl
 
   # Configuration class to store gem settings.
   class Configuration
-    # @return [Boolean] whether cURL logging is enabled.
-    attr_accessor :curl_logging_enabled
+    attr_accessor :curl_logging_enabled, :logger
+    attr_reader :environment
 
-    # @return [Logger] the logger instance used for logging.
-    attr_accessor :logger
-
-    # Initializes the configuration with default values.
     def initialize
-      @curl_logging_enabled = false
+      @environment = detect_environment
+      @curl_logging_enabled = default_logging_enabled?
       @logger = ::Logger.new($stdout)
     end
+
+    # Sets the environment
+    #
+    # @param env [tring|Symbol] environment
+    def environment=(env)
+      @environment = env&.to_sym
+      @curl_logging_enabled = default_logging_enabled?
+    end
+
+    private
+
+    # Detects the environment or sets it to :production by default
+    def detect_environment
+      if defined?(Rails)
+        Rails.env.to_sym
+      else
+        # Default to :production for non-Rails applications
+        :production
+      end
+    end
+
+    # Determines if logging should be enabled by default
+    def default_logging_enabled?
+      %i[development test].include?(@environment)
+    end
   end
 
   class << self

data/test/lib/httparty_curl_test.rb

@@ -0,0 +1,242 @@
+# test/httparty_curl_test.rb
+
+require 'minitest/autorun'
+require 'httparty_curl'
+require 'stringio'
+
+class HTTPartyCurlTest < Minitest::Test
+  def setup
+    # Reset the configuration before each test
+    HTTPartyCurl.configuration = nil
+    @original_rails = nil
+  end
+
+  def teardown
+    # Reset the configuration after each test
+    HTTPartyCurl.configuration = nil
+    restore_rails_constant
+  end
+
+  # Helper method to simulate a Rails environment
+  def simulate_rails_environment(env)
+    # Save the original Rails constant if it exists
+    @original_rails = Object.const_get(:Rails) if defined?(Rails)
+
+    # Create a mock Rails object with the specified environment
+    rails_mock = Minitest::Mock.new
+    rails_mock.expect(:env, env)
+
+    # Set the Rails constant to the mock
+    Object.const_set(:Rails, rails_mock)
+  end
+
+  # Helper method to remove the Rails constant if it exists
+  def remove_rails_constant
+    if defined?(Rails)
+      @original_rails = Object.const_get(:Rails)
+      Object.send(:remove_const, :Rails)
+    end
+  end
+
+  # Helper method to restore the original Rails constant
+  def restore_rails_constant
+    if @original_rails
+      Object.const_set(:Rails, @original_rails)
+      @original_rails = nil
+    else
+      Object.send(:remove_const, :Rails) if defined?(Rails)
+    end
+  end
+
+  def test_configuration_defaults_in_production_environment
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+    assert_instance_of ::Logger, configuration.logger
+    assert_equal $stdout, configuration.logger.instance_variable_get(:@logdev).dev
+  end
+
+  def test_configuration_defaults_in_development_environment
+    simulate_rails_environment('development')
+
+    configuration = HTTPartyCurl::Configuration.new
+
+    assert_equal :development, configuration.environment
+    assert configuration.curl_logging_enabled
+    assert_instance_of ::Logger, configuration.logger
+  end
+
+  def test_configuration_defaults_in_test_environment
+    simulate_rails_environment('test')
+
+    configuration = HTTPartyCurl::Configuration.new
+
+    assert_equal :test, configuration.environment
+    assert configuration.curl_logging_enabled
+    assert_instance_of ::Logger, configuration.logger
+  end
+
+  def test_configuration_defaults_in_other_rails_environment
+    simulate_rails_environment('staging')
+
+    configuration = HTTPartyCurl::Configuration.new
+
+    assert_equal :staging, configuration.environment
+    refute configuration.curl_logging_enabled
+  end
+
+  def test_configuration_can_set_curl_logging_enabled
+    remove_rails_constant
+
+    HTTPartyCurl.configure do |config|
+      config.curl_logging_enabled = true
+    end
+
+    assert HTTPartyCurl.configuration.curl_logging_enabled
+  end
+
+  def test_configuration_can_set_logger
+    custom_logger = Logger.new(StringIO.new)
+
+    HTTPartyCurl.configure do |config|
+      config.logger = custom_logger
+    end
+
+    assert_equal custom_logger, HTTPartyCurl.configuration.logger
+  end
+
+  def test_configuration_environment_can_be_set_in_non_rails_app
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    configuration.environment = :development
+
+    assert_equal :development, configuration.environment
+    assert configuration.curl_logging_enabled
+  end
+
+  def test_configuration_default_environment_in_non_rails_app
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+  end
+
+  def test_error_class_exists
+    assert_kind_of Class, HTTPartyCurl::Error
+    assert HTTPartyCurl::Error < StandardError
+  end
+
+  def test_configure_block_sets_configuration
+    custom_logger = Logger.new(StringIO.new)
+
+    HTTPartyCurl.configure do |config|
+      config.curl_logging_enabled = true
+      config.logger = custom_logger
+      config.environment = :test
+    end
+
+    assert HTTPartyCurl.configuration.curl_logging_enabled
+    assert_equal custom_logger, HTTPartyCurl.configuration.logger
+    assert_equal :test, HTTPartyCurl.configuration.environment
+  end
+
+  def test_configuration_respects_environment_change
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+
+    configuration.environment = :development
+    assert_equal :development, configuration.environment
+    assert configuration.curl_logging_enabled
+  end
+
+  def test_environment_setter_updates_environment
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+
+    configuration.environment = :development
+    assert_equal :development, configuration.environment
+  end
+
+  def test_environment_setter_updates_curl_logging_enabled
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+
+    configuration.environment = :development
+    assert_equal :development, configuration.environment
+    assert configuration.curl_logging_enabled
+
+    configuration.environment = :test
+    assert_equal :test, configuration.environment
+    assert configuration.curl_logging_enabled
+
+    configuration.environment = :production
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+
+    configuration.environment = :staging
+    assert_equal :staging, configuration.environment
+    refute configuration.curl_logging_enabled
+  end
+
+  def test_environment_setter_with_string_argument
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    configuration.environment = 'development'
+    assert_equal :development, configuration.environment
+    # Assuming default_logging_enabled? handles strings
+    assert configuration.curl_logging_enabled
+  end
+
+  def test_environment_setter_with_invalid_argument
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    configuration.environment = nil
+    assert_nil configuration.environment
+    refute configuration.curl_logging_enabled
+  end
+
+  def test_environment_setter_does_not_affect_logger
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    original_logger = configuration.logger
+
+    configuration.environment = :development
+    assert_equal original_logger, configuration.logger
+  end
+
+  def test_environment_setter_updates_curl_logging_enabled_correctly
+    remove_rails_constant
+
+    configuration = HTTPartyCurl::Configuration.new
+    configuration.curl_logging_enabled = false
+
+    configuration.environment = :development
+    assert_equal :development, configuration.environment
+    # Since environment changed, curl_logging_enabled should be updated
+    assert configuration.curl_logging_enabled
+
+    # Manually disable logging again
+    configuration.curl_logging_enabled = false
+    configuration.environment = :production
+    assert_equal :production, configuration.environment
+    refute configuration.curl_logging_enabled
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty_curl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - TheScubaGeek
@@ -63,7 +63,8 @@ files:
 - lib/httparty_curl.rb
 - lib/httparty_curl/logger.rb
 - lib/httparty_curl/version.rb
-- test/httparty_curl/logger_test.rb
+- test/lib/httparty_curl/logger_test.rb
+- test/lib/httparty_curl_test.rb
 - test/test_helper.rb
 homepage: https://github.com/thescubageek/httparty_curl
 licenses:
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: A gem to log HTTParty requests as cURL commands.