net-hippie 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39c735df32d765a6146802cfed8d0dc6cf6140363b55b84b08d6b691b9613fa
-  data.tar.gz: cc061070fc681973b97833836867d489cabb1db950d29e9561a9bdac8c566a1e
+  metadata.gz: ca969a22c79466a3c517f262f6a7c72137a62304b358b2f1caeec7849e222357
+  data.tar.gz: e9faffeec00a494e39f795d5ab3d32c7f58e9027e3ec79106256ae2b7b70d6f0
 SHA512:
-  metadata.gz: dedf2965ae930705d3e3a4cc5aacd29bb5210d17097c4699660ad2bb3562cbd4d9cba70450a6fd3646741ae0c55a6bc49ce0fa26e799193294bda05ba29d6ccf
-  data.tar.gz: df77476f60696ab864520b689dde126289fc3b9aa9df94bf5e816aa6cb479dff1cdcc33673d3be78a4391685c72d7fa465b261aa712e4b1f84220f1f25b715e9
+  metadata.gz: 035f5e34f31997473705d0556ee16e3e038c004fff44065c7ac86c1ffa2abd659cf0eb7ef1ff44baf51f31c7113e623621d627fd5fbccc478616585a10b59aa0
+  data.tar.gz: f86f16b3fa730239cf81683a1087a275633b88cee991358e7ad282db965b18f9293fc4bf8de6c991dee7ad2921de5413bcbcd6abdb178a42d2f77c2da523fcc1

data/.github/workflows/test.yml

@@ -5,11 +5,13 @@ on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+    - uses: actions/setup-ruby@v1
       with:
-        version: 2.7.x
-    - name: Build and test
+        ruby-version: ${{ matrix.ruby }}
+    - name: cibuild
       run: bin/cibuild

data/.rubocop.yml

@@ -5,7 +5,8 @@ AllCops:
     - 'test/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-Version 0.3.2
+Version 1.0.0
 
 # Changelog
 All notable changes to this project will be documented in this file.
@@ -7,7 +7,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- nil
+
+## [1.0.0] - 2020-07-31
+### Added
+- Add simpler API to remove the need to instantiate a `Client` directly.
+- Default to 3 retries using simple API.
+- Re-use client connection for connections to the same scheme, host, and port.
+
+### Removed
+- Remove support for Ruby 2.4
+- Remove legacy `Api` class.
+
+### Changed
+- Limit mutable options on Client.
+- Change default `read_timeout` to 10 seconds.
+- Change default `open_timeout` to 10 seconds.
+- Log to `STDERR` by default instead of `STDOUT`.
 
 ## [0.3.2] - 2020-01-28
 ### Fixed
@@ -54,7 +69,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - with\_retry.https://www.mokhan.ca/%F0%9F%92%8E/2018/11/10/net-hippie-0-2-0.html
 - authorization header helpers
 
-[Unreleased]: https://github.com/mokhan/net-hippie/compare/v0.3.2...HEAD
+[Unreleased]: https://github.com/mokhan/net-hippie/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/mokhan/net-hippie/compare/v0.3.2...v1.0.0
 [0.3.2]: https://github.com/mokhan/net-hippie/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/mokhan/net-hippie/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/mokhan/net-hippie/compare/v0.2.7...v0.3.0

data/Gemfile

@@ -2,7 +2,5 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in net-hippie.gemspec
 gemspec

data/README.md

@@ -1,10 +1,10 @@
 # Net::Hippie
 
 [![Gem Version](https://badge.fury.io/rb/net-hippie.svg)](https://rubygems.org/gems/net-hippie)
-[![Build Status](https://travis-ci.org/mokhan/net-hippie.svg?branch=master)](https://travis-ci.org/mokhan/net-hippie)
+[![Build Status](https://github.com/mokhan/net-hippie/workflows/Test/badge.svg)](https://github.com/mokhan/net-hippie/actions)
 
-Net::Hippie is a light weight wrapper around `net/http` that defaults to
-sending JSON messages.
+`Net::Hippie` is a light weight wrapper around `net/http` that defaults to
+sending `JSON` messages.
 
 ## Installation
 
@@ -27,23 +27,22 @@ Or install it yourself as:
 ```ruby
 require 'net/hippie'
 
-Net::Hippie.logger = Rails.logger
-
-client = Net::Hippie::Client.new
+Net::Hippie.logger = Logger.new(STDERR)
 
 headers = {
   'Accept' => 'application/vnd.haveibeenpwned.v2+json'
 }
 
-uri = URI.parse('https://haveibeenpwned.com/api/breaches')
-response = client.get(uri, headers: headers)
+uri = 'https://haveibeenpwned.com/api/breaches'
+response = Net::Hippie.get(uri, headers: headers)
 puts JSON.parse(response.body)
 ```
 
 ```ruby
-client = Net::Hippie::Client.new
-body = { user: { name: 'hippie' } }
-response = client.post(URI.parse('https://example.org'), body: body)
+response = Net::Hippie.post(
+  'https://example.org',
+  body: { name: 'hippie' }
+)
 puts JSON.parse(response.body)
 ```
 
@@ -69,24 +68,30 @@ client = Net::Hippie::Client.new(
 ### Basic Auth
 
 ```ruby
-client = Net::Hippie::Client.new
-headers = { 'Authorization' => Net::Hippie.basic_auth('username', 'password') }
-client.get('https://www.example.org', headers: headers)
+Net::Hippie.get(
+  'https://www.example.org',
+  headers: {
+    'Authorization' => Net::Hippie.basic_auth('username', 'password')
+  }
+)
 ```
 
 ### Bearer Auth
 
 ```ruby
-client = Net::Hippie::Client.new
 headers = { 'Authorization' => Net::Hippie.bearer_auth('token') }
-client.get('https://www.example.org', headers: headers)
+Net::Hippie.get('https://www.example.org', headers: headers)
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bin/shipit`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.libs << 'lib'
+  t.verbose = true
   t.test_files = FileList['test/**/*_test.rb']
 end
 RuboCop::RakeTask.new(:rubocop)

data/bin/cibuild

@@ -1,15 +1,10 @@
 #!/bin/sh
 
-# script/cibuild: Setup environment for CI to run tests. This is primarily
-#                 designed to run on the continuous integration server.
-
 set -e
+[ -z "$DEBUG" ] || set -x
 
 cd "$(dirname "$0")/.."
 
-echo [$(date "+%H:%M:%S")] "==> Started at…"
-
-# GC customizations
 export RUBY_GC_MALLOC_LIMIT=79000000
 export RUBY_GC_HEAP_INIT_SLOTS=800000
 export RUBY_HEAP_FREE_MIN=100000
@@ -17,7 +12,11 @@ export RUBY_HEAP_SLOTS_INCREMENT=400000
 export RUBY_HEAP_SLOTS_GROWTH_FACTOR=1
 export CIBUILD=1
 
-ruby -v
-gem install bundler:2.0.1 --conservative
+echo "[$(date "+%H:%M:%S")] ==> Running setup…"
+bin/setup
+
+echo "[$(date "+%H:%M:%S")] ==> Running tests…"
 bin/test
+
+echo "[$(date "+%H:%M:%S")] ==> Running linters…"
 bin/lint

data/bin/lint

@@ -2,7 +2,4 @@
 
 set -e
 
-[ -z "$DEBUG" ] || set -x
-
-echo [$(date "+%H:%M:%S")] "==> Running linters…"
 bundle exec rake lint

data/bin/setup

@@ -1,8 +1,7 @@
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
 
+ruby -v
+gem install bundler -v '~> 2.0'
 bundle install
-
-# Do any other automated setup that you need to do here

data/bin/test

@@ -1,17 +1,7 @@
 #!/bin/sh
 
-# script/test: Run test suite for application. Optionally pass in a path to an
-#              individual test file to run a single test.
-
-
 set -e
 
 cd "$(dirname "$0")/.."
 
-[ -z "$DEBUG" ] || set -x
-
-echo [$(date "+%H:%M:%S")] "==> Running setup…"
-bin/setup
-
-echo [$(date "+%H:%M:%S")] "==> Running tests…"
 bundle exec rake test

data/lib/net/hippie.rb

@@ -6,10 +6,10 @@ require 'logger'
 require 'net/http'
 require 'openssl'
 
-require 'net/hippie/version'
-require 'net/hippie/content_type_mapper'
 require 'net/hippie/client'
-require 'net/hippie/api'
+require 'net/hippie/connection'
+require 'net/hippie/content_type_mapper'
+require 'net/hippie/version'
 
 module Net
   # net/http for hippies.
@@ -31,7 +31,7 @@ module Net
     ].freeze
 
     def self.logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new(STDERR)
     end
 
     def self.logger=(logger)
@@ -53,5 +53,19 @@ module Net
     def self.bearer_auth(token)
       "Bearer #{token}"
     end
+
+    def self.method_missing(symbol, *args)
+      default_client.with_retry(retries: 3) do |client|
+        client.public_send(symbol, *args)
+      end || super
+    end
+
+    def self.respond_to_missing?(name, _include_private = false)
+      Client.public_instance_methods.include?(name.to_sym)
+    end
+
+    def self.default_client
+      @default_client ||= Client.new(follow_redirects: 3, logger: logger)
+    end
   end
 end

data/lib/net/hippie/client.rb

@@ -10,27 +10,25 @@ module Net
         'User-Agent' => "net/hippie #{Net::Hippie::VERSION}"
       }.freeze
 
-      attr_accessor :mapper, :read_timeout, :open_timeout, :logger
-      attr_accessor :follow_redirects
-
-      def initialize(certificate: nil, headers: DEFAULT_HEADERS,
-        key: nil, passphrase: nil, verify_mode: Net::Hippie.verify_mode)
-        @certificate = certificate
-        @default_headers = headers
-        @key = key
-        @mapper = ContentTypeMapper.new
-        @passphrase = passphrase
-        @read_timeout = 30
-        @verify_mode = verify_mode
-        @logger = Net::Hippie.logger
-        @follow_redirects = 0
+      attr_reader :mapper, :logger, :follow_redirects
+
+      def initialize(options = {})
+        @options = options
+        @mapper = options.fetch(:mapper, ContentTypeMapper.new)
+        @logger = options.fetch(:logger, Net::Hippie.logger)
+        @follow_redirects = options.fetch(:follow_redirects, 0)
+        @default_headers = options.fetch(:headers, DEFAULT_HEADERS)
+        @connections = Hash.new do |hash, key|
+          scheme, host, port = key
+          hash[key] = Connection.new(scheme, host, port, options)
+        end
       end
 
       def execute(uri, request, limit: follow_redirects, &block)
-        http = http_for(uri)
-        response = http.request(request)
+        connection = connection_for(uri)
+        response = connection.run(request)
         if limit.positive? && response.is_a?(Net::HTTPRedirection)
-          url = build_url_for(http, response['location'])
+          url = connection.build_url_for(response['location'])
           request = request_for(Net::HTTP::Get, url)
           execute(url, request, limit: limit - 1, &block)
         else
@@ -78,8 +76,7 @@ module Net
 
       private
 
-      attr_reader :default_headers, :verify_mode
-      attr_reader :certificate, :key, :passphrase
+      attr_reader :default_headers
 
       def attempt(attempt, max)
         yield
@@ -91,46 +88,21 @@ module Net
         sleep delay
       end
 
-      def http_for(uri)
-        uri = URI.parse(uri.to_s)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.read_timeout = read_timeout
-        http.open_timeout = open_timeout if open_timeout
-        http.use_ssl = uri.scheme == 'https'
-        http.verify_mode = verify_mode
-        http.set_debug_output(logger)
-        apply_client_tls_to(http)
-        http
-      end
-
       def request_for(type, uri, headers: {}, body: {})
         final_headers = default_headers.merge(headers)
-        uri = URI.parse(uri.to_s)
-        type.new(uri, final_headers).tap do |x|
+        type.new(URI.parse(uri.to_s), final_headers).tap do |x|
           x.body = mapper.map_from(final_headers, body) unless body.empty?
         end
       end
 
-      def private_key(type = OpenSSL::PKey::RSA)
-        passphrase ? type.new(key, passphrase) : type.new(key)
-      end
-
-      def apply_client_tls_to(http)
-        return if certificate.nil? || key.nil?
-
-        http.cert = OpenSSL::X509::Certificate.new(certificate)
-        http.key = private_key
-      end
-
       def run(uri, http_method, headers, body, &block)
         request = request_for(http_method, uri, headers: headers, body: body)
         execute(uri, request, &block)
       end
 
-      def build_url_for(http, path)
-        return path if path.start_with?('http')
-
-        "#{http.use_ssl? ? 'https' : 'http'}://#{http.address}#{path}"
+      def connection_for(uri)
+        uri = URI.parse(uri.to_s)
+        @connections[[uri.scheme, uri.host, uri.port]]
       end
     end
   end

data/lib/net/hippie/connection.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Net
+  module Hippie
+    # A connection to a specific host
+    class Connection
+      def initialize(scheme, host, port, options = {})
+        http = Net::HTTP.new(host, port)
+        http.read_timeout = options.fetch(:read_timeout, 10)
+        http.open_timeout = options.fetch(:open_timeout, 10)
+        http.use_ssl = scheme == 'https'
+        http.verify_mode = options.fetch(:verify_mode, Net::Hippie.verify_mode)
+        http.set_debug_output(options.fetch(:logger, Net::Hippie.logger))
+        apply_client_tls_to(http, options)
+        @http = http
+      end
+
+      def run(request)
+        @http.request(request)
+      end
+
+      def build_url_for(path)
+        return path if path.start_with?('http')
+
+        "#{@http.use_ssl? ? 'https' : 'http'}://#{@http.address}#{path}"
+      end
+
+      private
+
+      def apply_client_tls_to(http, options)
+        return if options[:certificate].nil? || options[:key].nil?
+
+        http.cert = OpenSSL::X509::Certificate.new(options[:certificate])
+        http.key = private_key(options[:key], options[:passphrase])
+      end
+
+      def private_key(key, passphrase, type = OpenSSL::PKey::RSA)
+        passphrase ? type.new(key, passphrase) : type.new(key)
+      end
+    end
+  end
+end

data/lib/net/hippie/content_type_mapper.rb

@@ -5,6 +5,8 @@ module Net
     # Converts a ruby hash into a JSON string
     class ContentTypeMapper
       def map_from(headers, body)
+        return body if body.is_a?(String)
+
         content_type = headers['Content-Type'] || ''
         return JSON.generate(body) if content_type.include?('json')
 

data/lib/net/hippie/version.rb

@@ -2,6 +2,6 @@
 
 module Net
   module Hippie
-    VERSION = '0.3.2'
+    VERSION = '1.0.0'
   end
 end

data/net-hippie.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '~> 2.4'
+  spec.required_ruby_version = '~> 2.5'
 
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.55'
-  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'vcr', '~> 6.0'
   spec.add_development_dependency 'webmock', '~> 3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-hippie
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - mo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,6 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -106,8 +105,8 @@ files:
 - bin/test
 - exe/net-hippie
 - lib/net/hippie.rb
-- lib/net/hippie/api.rb
 - lib/net/hippie/client.rb
+- lib/net/hippie/connection.rb
 - lib/net/hippie/content_type_mapper.rb
 - lib/net/hippie/version.rb
 - net-hippie.gemspec
@@ -123,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: net/http for hippies. ☮️

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-script:
-  - bin/cibuild

data/lib/net/hippie/api.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Net
-  module Hippie
-    # A no nonsense class to perform HTTP requests.
-    class Api
-      attr_reader :uri, :verify_mode
-
-      def initialize(url, verify_none: false)
-        @uri = URI.parse(url)
-        @verify_mode = OpenSSL::SSL::VERIFY_NONE if verify_none
-      end
-
-      def get
-        client.get(uri).body
-      end
-
-      def execute(request)
-        client.execute(uri, request)
-      end
-
-      private
-
-      def client
-        @client ||= Client.new(headers: {}, verify_mode: verify_mode)
-      end
-    end
-  end
-end