colrapi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d0b45d7d61f0ef91fda1d02f2f90eef26296a0f9dde8621637a03d3616469e
-  data.tar.gz: ba27842e25d7727443e69481e03b75af7649dd53d917136cbd1b6883a4b8cd4f
+  metadata.gz: 6d185adfc2ce8f6fb4fbcfe4147e3eba4534e94a2934af0a068480bb681a1364
+  data.tar.gz: d05ecc9a9c656f13b64ea4993809208da7b623a8702d37571090066d16625477
 SHA512:
-  metadata.gz: 24197d4e95bb99ed80189ce7263781ec212c04b733cb98f188b496a78f1ec42ca3cdf14e3cd73e64acdd520e89047c9502785beaf5f53582b2cbed7740af0747
-  data.tar.gz: c80b544c93a171ba2f768468a262175dcae973df961e88e0d28639596d876c3237e714af3e1b8b530c009a3932b7c8f5698991009ecb2dde93e794cae29acbab
+  metadata.gz: 1ead5baa09b3af575ac5608621e8c409620de0fc1e8c780823824517fba02bbb95ccf6d82cfdcac4796fc69c4fc2f9809823b811d1db38bb60a008ca3472ae74
+  data.tar.gz: a654921132c8e78be7db02c29fd69df842178e286098eafb9a6128ae26b7030eabcdd47a294b752f904b326802f3c91ab03583cb3a5135cb8b8005dd6d0fedcf

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.1.1] - 2023-04-17
+- Updated Faraday version
+
 ## [0.1.0] - 2022-01-20
 
 - Initial release

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    colrapi (0.1.0)
-      faraday (~> 1.0)
-      faraday_middleware (~> 1.2)
+    colrapi (0.1.1)
+      faraday (~> 2.2)
+      faraday-follow_redirects (>= 0.1, < 0.4)
       multi_json (~> 1.15)
 
 GEM
@@ -14,35 +14,15 @@ GEM
     byebug (11.1.3)
     crack (0.4.5)
       rexml
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     minitest (5.15.0)
     multi_json (1.15.0)
-    multipart-post (2.1.1)
     power_assert (2.0.1)
     public_suffix (5.0.1)
     rake (13.0.6)

data/colrapi.gemspec

@@ -42,8 +42,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "vcr", "~> 6.0"
   s.add_development_dependency "webmock", "~> 3.18"
 
-  s.add_runtime_dependency "faraday", "~> 1.0"
-  s.add_runtime_dependency "faraday_middleware", "~> 1.2" # requires 1.0
+  s.add_runtime_dependency "faraday", "~> 2.2"
+  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.4"
   s.add_runtime_dependency "multi_json", "~> 1.15"
 
   # TODO: comment out

data/lib/colrapi/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Colrapi
+  # Custom error class for rescuing from all Colrapi errors
+  class Error < StandardError; end
+
+  # Raised when ChecklistBank returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when ChecklistBank returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when ChecklistBank returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when ChecklistBank returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when ChecklistBank returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when ChecklistBank returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/colrapi/faraday.rb

@@ -1,73 +1,72 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday_middleware"
 require "multi_json"
 
 # @private
-module FaradayMiddleware
-  # @private
-  class RaiseHttpException < Faraday::Middleware
-    def call(env)
-      @app.call(env).on_complete do |response|
-        case response[:status].to_i
-        when 400
-          raise Colrapi::BadRequest, error_message_400(response)
-        when 404
-          raise Colrapi::NotFound, error_message_400(response)
-        when 500
-          raise Colrapi::InternalServerError, error_message_500(response, "Something is technically wrong.")
-        when 502
-          raise Colrapi::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
-        when 503
-          raise Colrapi::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
-        when 504
-          raise Colrapi::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+module Faraday
+  module ColrapiErrors
+    # @private
+    class Middleware < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise Colrapi::BadRequest, error_message_400(response)
+          when 404
+            raise Colrapi::NotFound, error_message_400(response)
+          when 500
+            raise Colrapi::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 502
+            raise Colrapi::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          when 503
+            raise Colrapi::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+          when 504
+            raise Colrapi::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          end
         end
       end
-    end
 
-    def initialize(app)
-      super app
-      @parser = nil
-    end
+      def initialize(app)
+        super app
+        @parser = nil
+      end
 
-    private
+      private
 
-    def error_message_400(response)
-      "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
-    end
+      def error_message_400(response)
+        "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      end
 
-    def error_body(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        if json?(body)
-          body = ::MultiJson.load(body)
-          if body["message"].nil?
-            body = nil
-            elseif body["message"].length == 1
-            body = body["message"]
-          else
-            body = body["message"].collect { |x| x["message"] }.join("; ")
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          if json?(body)
+            body = ::MultiJson.load(body)
+            if body["message"].nil?
+              body = nil
+            else
+              body = body["message"]
+            end
           end
         end
-      end
 
-      if body.nil?
-        nil
-      else
-        ": #{body}"
+        if body.nil?
+          nil
+        else
+          ": #{body}"
+        end
       end
-    end
 
-    def error_message_500(response, body = nil)
-      "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
-    end
+      def error_message_500(response, body = nil)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
+      end
 
-    def json?(string)
-      MultiJson.load(string)
-      true
-    rescue MultiJson::ParseError
-      false
+      def json?(string)
+        MultiJson.load(string)
+        true
+      rescue MultiJson::ParseError
+        false
+      end
     end
   end
 end

data/lib/colrapi/request.rb

@@ -1,6 +1,7 @@
 require_relative "faraday" # !! Potential ruby 3.0 difference in module loading? relative differs from Serrano
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require_relative "utils"
+require "colrapi/error"
 
 module Colrapi
   class Request
@@ -137,7 +138,7 @@ module Colrapi
                    f.request(:basic_auth, @user, @password)
                  end
                  f.response :logger
-                 f.use FaradayMiddleware::RaiseHttpException
+                 f.use Faraday::ColrapiErrors::Middleware
                  f.adapter Faraday.default_adapter
                end
              else
@@ -145,7 +146,7 @@ module Colrapi
                  if !@user.nil? and !@password.nil?
                    f.request(:basic_auth, @user, @password)
                  end
-                 f.use FaradayMiddleware::RaiseHttpException
+                 f.use Faraday::ColrapiErrors::Middleware
                  f.adapter Faraday.default_adapter
                end
              end

data/lib/colrapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Colrapi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/colrapi.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "erb"
+require_relative "colrapi/error"
 require_relative "colrapi/version"
 require_relative "colrapi/request"
 require "colrapi/helpers/configuration"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colrapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Yoder, Geoff Ower
@@ -104,28 +104,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +181,7 @@ files:
 - bin/setup
 - colrapi.gemspec
 - lib/colrapi.rb
+- lib/colrapi/error.rb
 - lib/colrapi/faraday.rb
 - lib/colrapi/helpers/configuration.rb
 - lib/colrapi/request.rb
@@ -186,7 +193,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/SpeciesFileGroup/colrapi
   source_code_uri: https://github.com/SpeciesFileGroup/colrapi
-  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.0
+  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -202,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Catalog of Life Client