zendesk_api 1.37.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5a2ced45e0201f6f9a45e5b8f7cf6951ca92c15ce893283c2289d0b260dc77
-  data.tar.gz: 31fa7566865e7191f49dadf6a5e01573264f4fc62ddfd4f635f8f7edd4be9ab2
+  metadata.gz: 918e2310ea7213d2531370e89e3ebb6e6e2765e06decc874bd16390157f08c49
+  data.tar.gz: 25d7593ddc8d0c949a73752d509b9ba02c9d21411f0ea86187ee88e3183816d9
 SHA512:
-  metadata.gz: a1b355c67c8126f69f32ff6cd24d03b81b75eec27a0a72044383d0e06a871ba5bd18778119523a013725162048393d7a6bf58f075013e852303255b78bccb73f
-  data.tar.gz: 78ecdd8fd4d2fd889df06aea1ac98df7c68e6f89378f1358594b30853b23b3179f304ee4d87a781bda0047bc1970b8c28dfd147907d74223e28ffceb1676d1b1
+  metadata.gz: fb7ebca0a99f0a952e276d2502f1983b006ff8b72148c73a7cc3867eab3b027d5f326c214f7eedb5c0877393ad7851bf62f282f213f9a262175df8f7f74c08a7
+  data.tar.gz: 921f38c3d0372fc2c1693cb9a72ca22ad137deb298e3338d12ae9e6a08d7f24fb437b58a5ab3b597e7506e9a71268845f8ff592242a7941225fbce310997989a

data/lib/zendesk_api/client.rb

@@ -1,5 +1,3 @@
-require 'faraday'
-
 require 'zendesk_api/version'
 require 'zendesk_api/sideloading'
 require 'zendesk_api/configuration'
@@ -100,9 +98,7 @@ module ZendeskAPI
       config.retry = !!config.retry # nil -> false
 
       set_raise_error_when_rated_limited
-
       set_token_auth
-
       set_default_logger
       add_warning_callback
     end
@@ -112,7 +108,6 @@ module ZendeskAPI
     # @return [Faraday::Connection] Faraday connection for the client
     def connection
       @connection ||= build_connection
-      return @connection
     end
 
     # Pushes a callback onto the stack. Callbacks are executed on responses, last in the Faraday middleware stack.
@@ -155,7 +150,6 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Response::ParseIsoDates
         builder.use ZendeskAPI::Middleware::Response::ParseJson
         builder.use ZendeskAPI::Middleware::Response::SanitizeResponse
-
         adapter = config.adapter || Faraday.default_adapter
 
         unless GZIP_EXCEPTIONS.include?(adapter)
@@ -163,14 +157,7 @@ module ZendeskAPI
           builder.use ZendeskAPI::Middleware::Response::Deflate
         end
 
-        # request
-        if config.access_token && !config.url_based_access_token
-          builder.request(:authorization, "Bearer", config.access_token)
-        elsif config.access_token
-          builder.use ZendeskAPI::Middleware::Request::UrlBasedAccessToken, config.access_token
-        else
-          builder.use Faraday::Request::BasicAuthentication, config.username, config.password
-        end
+        set_authentication(builder, config)
 
         if config.cache
           builder.use ZendeskAPI::Middleware::Request::EtagCache, :cache => config.cache
@@ -181,12 +168,17 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Request::EncodeJson
 
         # Should always be first in the stack
-        builder.use ZendeskAPI::Middleware::Request::Retry, :logger => config.logger, :retry_codes => config.retry_codes, :retry_on_exception => config.retry_on_exception if config.retry
+        if config.retry
+          builder.use ZendeskAPI::Middleware::Request::Retry,
+                      :logger => config.logger,
+                      :retry_codes => config.retry_codes,
+                      :retry_on_exception => config.retry_on_exception
+        end
         if config.raise_error_when_rate_limited
           builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
         end
 
-        builder.adapter(*adapter)
+        builder.adapter(*adapter, &config.adapter_proc)
       end
     end
 
@@ -239,5 +231,16 @@ module ZendeskAPI
         end
       end
     end
+
+    # See https://lostisland.github.io/faraday/middleware/authentication
+    def set_authentication(builder, config)
+      if config.access_token && !config.url_based_access_token
+        builder.request :authorization, "Bearer", config.access_token
+      elsif config.access_token
+        builder.use ZendeskAPI::Middleware::Request::UrlBasedAccessToken, config.access_token
+      else
+        builder.request :authorization, :basic, config.username, config.password
+      end
+    end
   end
 end

data/lib/zendesk_api/configuration.rb

@@ -28,6 +28,9 @@ module ZendeskAPI
     # @return [Symbol] Faraday adapter
     attr_accessor :adapter
 
+    # @return [Proc] Faraday adapter proc
+    attr_accessor :adapter_proc
+
     # @return [Boolean] Whether to allow non-HTTPS connections for development purposes.
     attr_accessor :allow_http
 

data/lib/zendesk_api/middleware/request/encode_json.rb

@@ -6,7 +6,6 @@ module ZendeskAPI
       class EncodeJson < Faraday::Middleware
         CONTENT_TYPE = 'Content-Type'.freeze
         MIME_TYPE = 'application/json'.freeze
-        dependency 'json'
 
         def call(env)
           type = env[:request_headers][CONTENT_TYPE].to_s

data/lib/zendesk_api/middleware/response/callback.rb

@@ -4,7 +4,7 @@ module ZendeskAPI
   module Middleware
     module Response
       # @private
-      class Callback < Faraday::Response::Middleware
+      class Callback < Faraday::Middleware
         def initialize(app, client)
           super(app)
           @client = client

data/lib/zendesk_api/middleware/response/deflate.rb

@@ -5,11 +5,12 @@ module ZendeskAPI
     module Response
       # Faraday middleware to handle content-encoding = inflate
       # @private
-      class Deflate < Faraday::Response::Middleware
+      class Deflate < Faraday::Middleware
         def on_complete(env)
-          if !env.body.strip.empty? && env[:response_headers]['content-encoding'] == "deflate"
-            env.body = Zlib::Inflate.inflate(env.body)
-          end
+          return if env[:response_headers]['content-encoding'] != "deflate"
+          return if env.body.strip.empty?
+
+          env.body = Zlib::Inflate.inflate(env.body)
         end
       end
     end

data/lib/zendesk_api/middleware/response/gzip.rb

@@ -7,11 +7,12 @@ module ZendeskAPI
     # @private
     module Response
       # Faraday middleware to handle content-encoding = gzip
-      class Gzip < Faraday::Response::Middleware
+      class Gzip < Faraday::Middleware
         def on_complete(env)
-          if !env[:body].strip.empty? && env[:response_headers]['content-encoding'] == "gzip"
-            env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body])).read
-          end
+          return if env[:response_headers]['content-encoding'] != "gzip"
+          return if env[:body].force_encoding(Encoding::BINARY).strip.empty?
+
+          env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body])).read
         end
       end
     end

data/lib/zendesk_api/middleware/response/parse_iso_dates.rb

@@ -6,7 +6,7 @@ module ZendeskAPI
     module Response
       # Parse ISO dates from response body
       # @private
-      class ParseIsoDates < Faraday::Response::Middleware
+      class ParseIsoDates < Faraday::Middleware
         def call(env)
           @app.call(env).on_complete do |env|
             parse_dates!(env[:body])

data/lib/zendesk_api/middleware/response/parse_json.rb

@@ -3,9 +3,8 @@ module ZendeskAPI
   module Middleware
     # @private
     module Response
-      class ParseJson < Faraday::Response::Middleware
+      class ParseJson < Faraday::Middleware
         CONTENT_TYPE = 'Content-Type'.freeze
-        dependency 'json'
 
         def on_complete(env)
           type = env[:response_headers][CONTENT_TYPE].to_s

data/lib/zendesk_api/middleware/response/sanitize_response.rb

@@ -1,7 +1,7 @@
 module ZendeskAPI
   module Middleware
     module Response
-      class SanitizeResponse < Faraday::Response::Middleware
+      class SanitizeResponse < Faraday::Middleware
         def on_complete(env)
           env[:body].scrub!('')
         end

data/lib/zendesk_api/resources.rb

@@ -228,6 +228,12 @@ module ZendeskAPI
     has_many Vote
     class Translation < Resource; end
     has_many Translation
+    class Label < DataResource
+      include Read
+      include Create
+      include Destroy
+    end
+    has_many Label
   end
 
   class TopicSubscription < Resource

data/lib/zendesk_api/verbs.rb

@@ -44,14 +44,12 @@ module ZendeskAPI
           end
 
           define_method method do |*method_args|
-            begin
-              send("#{method}!", *method_args)
-            rescue ZendeskAPI::Error::RecordInvalid => e
-              @errors = e.errors
-              false
-            rescue ZendeskAPI::Error::ClientError
-              false
-            end
+            send("#{method}!", *method_args)
+          rescue ZendeskAPI::Error::RecordInvalid => e
+            @errors = e.errors
+            false
+          rescue ZendeskAPI::Error::ClientError
+            false
           end
         end
       end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.37.0"
+  VERSION = "2.0.0"
 end

data/lib/zendesk_api.rb

@@ -1,4 +1,7 @@
 module ZendeskAPI; end
 
+require 'faraday'
+require 'faraday/multipart'
+
 require 'zendesk_api/core_ext/inflection'
 require 'zendesk_api/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,28 +9,36 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -144,9 +152,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/zendesk/zendesk_api_client_rb/issues
-  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.37.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.37.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.37.0
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v2.0.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/2.0.0
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v2.0.0
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
 post_install_message:
 rdoc_options: []
@@ -156,14 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Zendesk REST API Client