swd 1.3.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b1ef4355a0eb454bc541b4d39740444445316294bb9e23916ca9901437dc73
-  data.tar.gz: 452ca7702a025a61919fe4982d701c810c4b79be4076cad8af1efff39b635aa4
+  metadata.gz: ec5568cf1fe7901b0782a7de8d3f44f6c0efa0382e39f72ec9a6d43ea2c168b4
+  data.tar.gz: b05f2404383e789be4816d7ad002f4fce8e5eac7d64f7a7b16cf35b2fb988f6d
 SHA512:
-  metadata.gz: 603f6c3000796cacaf8ecb852f08cfc29364443bde30073f50b23e40560eb81ee35b7e567df7479f20fefeb0581e9dff09a1ad88e0d47d9a684c5a11482f08cf
-  data.tar.gz: 513dfadd5bb60c22d351f0ce930a42272bfa8f2d2e9d110c461d782874af0d3350a8db48784669f8ccfb750dbceeefe1c8d25b858b8fdfc2e83de50adaddd5d3
+  metadata.gz: c9989ce57ad5c568b69fbb9b8165f07b1946e1cdb6dfe39395455fb3ccf50e45fb618f17cda4ecb788aea568e847b5dc4e1b75722db7d42ecb02b785e43f0c9b
+  data.tar.gz: baa4361f32ee9127fb678fafe5b6b625cf69c63a093b4aad26a9f7d7f9697d4491f09653761cfe028d1c876ae73901c6fc9fd63b1f21654bf9d28e147acd7632

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: nov

data/.github/workflows/spec.yml

@@ -0,0 +1,31 @@
+name: Spec
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  spec:
+    strategy:
+      matrix:
+        os: ['ubuntu-20.04', 'ubuntu-22.04']
+        ruby-version: ['3.1', '3.2', '3.3']
+        include:
+        - os: 'ubuntu-20.04'
+          ruby-version: '3.0'
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run Specs
+      run: bundle exec rake spec

data/.travis.yml

@@ -2,6 +2,7 @@ before_install:
   - gem install bundler
 
 rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
+  - 2.6.10
+  - 2.7.6
+  - 3.0.4
+  - 3.1.2

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## [2.0.2] - 2022-10-09
+
+### Changed
+
+* convert Faraday::Error to SWD::Exception  https://github.com/nov/SWD/commit/a5bacba3c0fe740b1e36be220980b29dc50de095
+
+### Fixed
+
+* SWD::Resource#to_response_object was needed for openid_connect gem https://github.com/nov/SWD/commit/c4d916d3cd8d4fe076bd27a64403d98dea9b00ef
+
+## [2.0.1] - 2022-10-08
+
+### Fixed
+
+* typo https://github.com/nov/SWD/commit/3fd7a4fbe8fdf586824edc5d2b4222c43e7a9655
+
+## [2.0.0] - 2022-10-08
+
+### Added
+
+- start recording CHANGELOG
+
+### Changed
+
+- Switch from httpclient to faraday https://github.com/nov/SWD/pull/4

data/VERSION

@@ -1 +1 @@
-1.3.0
+2.0.3

data/lib/swd/resource.rb

@@ -17,7 +17,7 @@ module SWD
     def discover!(cache_options = {})
       SWD.cache.fetch(cache_key, cache_options) do
         handle_response do
-          SWD.http_client.get_content endpoint.to_s
+          SWD.http_client.get endpoint.to_s
         end
       end
     end
@@ -34,33 +34,32 @@ module SWD
     private
 
     def handle_response
-      res = JSON.parse(yield).with_indifferent_access
-      if redirect = res[:SWD_service_redirect]
+      json = yield.body.with_indifferent_access
+      if redirect = json[:SWD_service_redirect]
         redirect_to redirect[:location], redirect[:expires]
       else
-        to_response_object(res)
+        to_response_object json
       end
-    rescue HTTPClient::BadResponseError => e
-      case e.res.try(:status)
+    rescue Faraday::Error => e
+      case e.response_status
       when nil
-        raise Exception.new(e.message)
+        raise Exception.new e
       when 400
-        raise BadRequest.new('Bad Request', res)
+        raise BadRequest.new('Bad Request', e.response_body)
       when 401
-        raise Unauthorized.new('Unauthorized', res)
+        raise Unauthorized.new('Unauthorized', e.response_body)
       when 403
-        raise Forbidden.new('Forbidden', res)
+        raise Forbidden.new('Forbidden', e.response_body)
       when 404
-        raise NotFound.new('Not Found', res)
+        raise NotFound.new('Not Found', e.response_body)
       else
-        raise HttpError.new(e.res.status, e.res.reason, res)
+        raise HttpError.new(e.response_status, e.response_body, e.response_body)
       end
-    rescue JSON::ParserError, OpenSSL::SSL::SSLError, SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
-      raise Exception.new(e.message)
     end
 
-    def to_response_object(hash)
-      Response.new hash
+    # NOTE: overwritten in openid_connect gem.
+    def to_response_object(json)
+      Response.new json
     end
 
     def redirect_to(location, expires)

data/lib/swd.rb

@@ -3,7 +3,8 @@ require 'logger'
 require 'openssl'
 require 'active_support'
 require 'active_support/core_ext'
-require 'httpclient'
+require 'faraday'
+require 'faraday/follow_redirects'
 require 'attr_required'
 require 'attr_optional'
 
@@ -51,17 +52,14 @@ module SWD
   self.debugging = false
 
   def self.http_client
-    _http_client_ = HTTPClient.new(
-      :agent_name => "SWD (#{VERSION})"
-    )
-
-    # NOTE: httpclient gem seems stopped maintaining root certtificate set, use OS default.
-    _http_client_.ssl_config.clear_cert_store
-    _http_client_.ssl_config.cert_store.set_default_paths
-
-    _http_client_.request_filter << Debugger::RequestFilter.new if debugging?
-    http_config.try(:call, _http_client_)
-    _http_client_
+    Faraday.new(headers: {user_agent: "SWD #{VERSION}"}) do |faraday|
+      faraday.response :raise_error
+      faraday.response :json
+      faraday.response :follow_redirects
+      faraday.response :logger, SWD.logger if debugging?
+      faraday.adapter Faraday.default_adapter
+      http_config.try(:call, faraday)
+    end
   end
   def self.http_config(&block)
     @@http_config ||= block
@@ -79,6 +77,5 @@ require 'swd/cache'
 require 'swd/exception'
 require 'swd/resource'
 require 'swd/response'
-require 'swd/debugger'
 
 SWD.cache = SWD::Cache.new

data/spec/helpers/webmock_helper.rb

@@ -24,6 +24,9 @@ module WebMockHelper
 
   def response_for(response_file, options = {})
     response = {}
+    response[:headers] = {
+      'Content-Type': 'application/json'
+    }
     response[:body] = File.new(File.join(File.dirname(__FILE__), '../mock_json', "#{response_file}.json"))
     if options[:status]
       response[:status] = options[:status]

data/spec/swd/exception_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 describe SWD::HttpError do
   subject do
-    SWD::HttpError.new 400, 'Bad Request', HTTP::Message.new_response('')
+    SWD::HttpError.new 400, 'Bad Request', 'Message'
   end
 
   its(:status)   { should == 400 }
   its(:message)  { should == 'Bad Request' }
-  its(:response) { should be_a HTTP::Message }
+  its(:response) { should == 'Message' }
 end
 
 describe SWD::BadRequest do

data/spec/swd/resource_spec.rb

@@ -97,30 +97,9 @@ describe SWD::Resource do
         end
       end
 
-      context 'when invalid SSL cert' do
+      context 'when Faraday::Error without response' do
         it do
-          expect(SWD.http_client).to receive(:get_content).and_raise(OpenSSL::SSL::SSLError)
-          expect { res = resource.discover! }.to raise_error SWD::Exception
-        end
-      end
-
-      context 'when invalid JSON' do
-        it do
-          expect(SWD.http_client).to receive(:get_content).and_raise(JSON::ParserError)
-          expect { res = resource.discover! }.to raise_error SWD::Exception
-        end
-      end
-
-      context 'when SocketError' do
-        it do
-          expect(SWD.http_client).to receive(:get_content).and_raise(SocketError)
-          expect { res = resource.discover! }.to raise_error SWD::Exception
-        end
-      end
-
-      context 'when BadResponseError without response' do
-        it do
-          expect(SWD.http_client).to receive(:get_content).and_raise(HTTPClient::BadResponseError.new(''))
+          expect(SWD.http_client).to receive(:get).and_raise(Faraday::Error)
           expect { res = resource.discover! }.to raise_error SWD::Exception
         end
       end

data/spec/swd_spec.rb

@@ -108,11 +108,11 @@ describe SWD do
     context 'with http_config' do
       before do
         SWD.http_config do |config|
-          config.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          config.ssl.verify = false
         end
       end
       it 'should configure http_client' do
-        SWD.http_client.ssl_config.verify_mode.should == OpenSSL::SSL::VERIFY_NONE
+        SWD.http_client.ssl.verify.should be_falsy
       end
     end
   end

data/swd.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-  s.add_runtime_dependency 'httpclient', '>= 2.4'
+  s.add_runtime_dependency 'faraday', '~> 2.0'
+  s.add_runtime_dependency 'faraday-follow_redirects'
   s.add_runtime_dependency 'activesupport', '>= 3'
   s.add_runtime_dependency 'attr_required', '>= 0.0.5'
   s.add_development_dependency 'rake'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: swd
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.3
 platform: ruby
 authors:
 - nov matake
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -129,9 +143,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -139,8 +156,6 @@ files:
 - VERSION
 - lib/swd.rb
 - lib/swd/cache.rb
-- lib/swd/debugger.rb
-- lib/swd/debugger/request_filter.rb
 - lib/swd/exception.rb
 - lib/swd/resource.rb
 - lib/swd/response.rb
@@ -151,7 +166,6 @@ files:
 - spec/mock_json/redirect_with_port.json
 - spec/mock_json/success.json
 - spec/spec_helper.rb
-- spec/swd/debugger/request_filter_spec.rb
 - spec/swd/exception_spec.rb
 - spec/swd/resource_spec.rb
 - spec/swd_spec.rb
@@ -159,7 +173,7 @@ files:
 homepage: https://github.com/nov/swd
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,8 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: SWD (Simple Web Discovery) Client Library
 test_files:
@@ -186,7 +200,6 @@ test_files:
 - spec/mock_json/redirect_with_port.json
 - spec/mock_json/success.json
 - spec/spec_helper.rb
-- spec/swd/debugger/request_filter_spec.rb
 - spec/swd/exception_spec.rb
 - spec/swd/resource_spec.rb
 - spec/swd_spec.rb

data/lib/swd/debugger/request_filter.rb

@@ -1,20 +0,0 @@
-module SWD
-  module Debugger
-    class RequestFilter
-      # Callback called in HTTPClient (before sending a request)
-      # request:: HTTP::Message
-      def filter_request(request)
-        started = "======= [SWD] HTTP REQUEST STARTED ======="
-        SWD.logger.info [started, request.dump].join("\n")
-      end
-
-      # Callback called in HTTPClient (after received a response)
-      # request::  HTTP::Message
-      # response:: HTTP::Message
-      def filter_response(request, response)
-        finished = "======= [SWD] HTTP REQUEST FINISHED ======="
-        SWD.logger.info ['-' * 50, response.dump, finished].join("\n")
-      end
-    end
-  end
-end

data/lib/swd/debugger.rb

@@ -1,3 +0,0 @@
-Dir[File.dirname(__FILE__) + '/debugger/*.rb'].each do |file|
-  require file
-end

data/spec/swd/debugger/request_filter_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe SWD::Debugger::RequestFilter do
-  let(:resource_endpoint) { 'https://example.com/resources' }
-  let(:request) { HTTP::Message.new_request(:get, URI.parse(resource_endpoint)) }
-  let(:response) { HTTP::Message.new_response({:hello => 'world'}.to_json) }
-  let(:request_filter) { SWD::Debugger::RequestFilter.new }
-
-  describe '#filter_request' do
-    it 'should log request' do
-      expect(SWD.logger).to receive(:info).with(
-        "======= [SWD] HTTP REQUEST STARTED =======\n" +
-        request.dump
-      )
-      request_filter.filter_request(request)
-    end
-  end
-
-  describe '#filter_response' do
-    it 'should log response' do
-      expect(SWD.logger).to receive(:info).with(
-        "--------------------------------------------------\n" +
-        response.dump +
-        "\n======= [SWD] HTTP REQUEST FINISHED ======="
-      )
-      request_filter.filter_response(request, response)
-    end
-  end
-end