twingly-http 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c96f42ded2e94d947bd2a15cc7de75669e3f2dc06a17ff7d648eb3c0cf862c5e
-  data.tar.gz: 5203e3833efe611708b1b185708735b2c6a027d20d8edd0e79c80dcca696d73a
+  metadata.gz: cc5e134cf7d77a56bda5f8d4c40ef90f6c80c0230aea262cada8c943b4defa77
+  data.tar.gz: ad54778da0dddff2b0bb14e4205333758a43272cfd9d6458566fbb4fc48c9816
 SHA512:
-  metadata.gz: 6869f39208327e4b834f999e96a1a0d7253768022aca54f259c1f0cf57bf60331e4aabc966919ad0a7bef08e3091ff7090c9e576986f7d4f5336894ac47b250b
-  data.tar.gz: 4cf992e7c60229b8fcbfd3ab62b0584e8531b229fd8a863d8ab1a47b248c5c2697eb225beecb6ec26377bce50009bf6ba295e1fee45622951be2809ffb5b4640
+  metadata.gz: 83b57d12d30e4a3f38c5e4b71d06d1ed894ab7ecca32495d9607bb2cf434e0f5bc1b1ffea0d4855b06e3e7791987c60ffe2d0e0c69be739bf0f5eabcb0ff4ed1
+  data.tar.gz: 138b97d64ed9b979c942eecd48728fd1427b26054b6c614ee19799e3046695dc7f1523c113f4f9efdb289fdfac092315f15e084e6ab3b2ad8fa723d091100ff1

data/README.md

@@ -1,7 +1,44 @@
 # Twingly::HTTP
 
-Robust HTTP client
+[![GitHub Build Status](https://github.com/twingly/twingly-http/workflows/CI/badge.svg?branch=master)](https://github.com/twingly/twingly-http/actions)
 
+Robust HTTP client, tailored by Twingly.
+
+## Getting Started
+
+Install the gem:
+
+    gem install twingly-http
+
+Example "one-liner" usage:
+
+```
+ruby -rlogger -rtwingly/http -e '\
+    logger = Logger.new(STDOUT); logger.level = :INFO; \
+    puts Twingly::HTTP::Client.new(logger: logger, \
+    base_user_agent: "").get("http://example.org").status'
+```
+
+Example `irb` usage:
+
+```
+irb -rlogger -rtwingly/http
+```
+```ruby
+logger = Logger.new(STDOUT); logger.level = :INFO
+client = Twingly::HTTP::Client.new(logger: logger, base_user_agent: "")
+client.get("http://example.org").status
+```
+
+## Tests
+
+The tests require [Toxiproxy](https://github.com/Shopify/toxiproxy)
+
+    docker-compose up
+
+Run tests with
+
+    bundle exec rake
 
 ## Release workflow
 
@@ -18,6 +55,3 @@ Robust HTTP client
         github_changelog_generator
 
 [twingly-rubygems]: https://rubygems.org/profiles/twingly
-[ruby-prof]: http://ruby-prof.rubyforge.org/
-[memory_profiler]: https://github.com/SamSaffron/memory_profiler
-[examples]: examples/url.rb

data/lib/twingly/http.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "logger"
 require "net/http"
 require "faraday"
+require "faraday_middleware"
 
 require_relative "../faraday/logfmt_logger"
 require_relative "../faraday/url_size_limit"
@@ -12,6 +14,7 @@ module Twingly
   module HTTP
     class ConnectionError < StandardError; end
     class UrlSizeLimitExceededError < StandardError; end
+    class RedirectLimitReachedError < StandardError; end
     class Client # rubocop:disable Metrics/ClassLength
       DEFAULT_RETRYABLE_EXCEPTIONS = [
         Faraday::ConnectionFailed,
@@ -28,6 +31,7 @@ module Twingly
       DEFAULT_NUMBER_OF_RETRIES = 0
       DEFAULT_RETRY_INTERVAL = 1
       DEFAULT_MAX_URL_SIZE_BYTES = Float::INFINITY
+      DEFAULT_FOLLOW_REDIRECTS_LIMIT = 3
 
       attr_writer :http_timeout
       attr_writer :http_open_timeout
@@ -36,27 +40,21 @@ module Twingly
       attr_writer :on_retry_callback
       attr_writer :max_url_size_bytes
       attr_writer :request_id
+      attr_writer :follow_redirects
 
+      attr_accessor :follow_redirects_limit
+      attr_accessor :logger
       attr_accessor :retryable_exceptions
 
-      def initialize(logger:, base_user_agent:)
-        @logger          = logger
+      def initialize(base_user_agent:, logger: default_logger)
         @base_user_agent = base_user_agent
-        @request_id      = nil
-
-        @http_timeout      = DEFAULT_HTTP_TIMEOUT
-        @http_open_timeout = DEFAULT_HTTP_OPEN_TIMEOUT
-
-        @retryable_exceptions = DEFAULT_RETRYABLE_EXCEPTIONS
-        @number_of_retries    = DEFAULT_NUMBER_OF_RETRIES
-        @retry_interval       = DEFAULT_RETRY_INTERVAL
-        @on_retry_callback    = nil
+        @logger          = logger
 
-        @max_url_size_bytes = DEFAULT_MAX_URL_SIZE_BYTES
+        initialize_defaults
       end
 
-      def get(url, params: {})
-        http_response_for(:get, url: url, params: params)
+      def get(url, params: {}, headers: {})
+        http_response_for(:get, url: url, params: params, headers: headers)
       end
 
       def post(url, body:, headers: {})
@@ -65,13 +63,30 @@ module Twingly
 
       private
 
+      def default_logger
+        Logger.new(File::NULL)
+      end
+
+      def initialize_defaults
+        @request_id             = nil
+        @http_timeout           = DEFAULT_HTTP_TIMEOUT
+        @http_open_timeout      = DEFAULT_HTTP_OPEN_TIMEOUT
+        @retryable_exceptions   = DEFAULT_RETRYABLE_EXCEPTIONS
+        @number_of_retries      = DEFAULT_NUMBER_OF_RETRIES
+        @retry_interval         = DEFAULT_RETRY_INTERVAL
+        @on_retry_callback      = nil
+        @follow_redirects       = false
+        @follow_redirects_limit = DEFAULT_FOLLOW_REDIRECTS_LIMIT
+        @max_url_size_bytes     = DEFAULT_MAX_URL_SIZE_BYTES
+      end
+
       # rubocop:disable Metrics/MethodLength
-      def http_response_for(method, *args)
+      def http_response_for(method, **args)
         response = case method
                    when :get
-                     http_get_response(*args)
+                     http_get_response(**args)
                    when :post
-                     http_post_response(*args)
+                     http_post_response(**args)
                    end
 
         Response.new(headers: response.headers.to_h,
@@ -81,14 +96,16 @@ module Twingly
         raise ConnectionError
       rescue Faraday::UrlSizeLimit::LimitExceededError => error
         raise UrlSizeLimitExceededError, error.message
+      rescue FaradayMiddleware::RedirectLimitReached => error
+        raise RedirectLimitReachedError, error.message
       end
       # rubocop:enable all
 
-      def http_get_response(url:, params: {})
+      def http_get_response(url:, params:, headers:)
         binary_url = url.dup.force_encoding(Encoding::BINARY)
         http_client = create_http_client
 
-        headers = default_headers
+        headers = default_headers.merge(headers)
 
         http_client.get do |request|
           request.url(binary_url)
@@ -128,6 +145,10 @@ module Twingly
                            headers: true,
                            bodies: true,
                            request_id: @request_id
+          if @follow_redirects
+            faraday.use FaradayMiddleware::FollowRedirects,
+                        limit: @follow_redirects_limit
+          end
           faraday.adapter Faraday.default_adapter
           faraday.headers[:user_agent] = user_agent
         end

data/lib/twingly/version.rb

@@ -2,6 +2,6 @@
 
 module Twingly
   module HTTP
-    VERSION = "0.1.0"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-http
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Twingly AB
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -158,13 +178,13 @@ homepage: http://github.com/twingly/twingly-http
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -173,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Robust HTTP client
 test_files: []