zendesk_api 1.35.0 → 1.38.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb0a6ce03a083efc37a6f742e90e58955a411ce76c3bfffb78ad5fc61f336b6
-  data.tar.gz: 10d25156b4961da61e2c1b7276ef5a8e4a17664c93d4a24e8f466ec9dc2e85b1
+  metadata.gz: 5d882067cdc76fd3a3d9b637081938d7aac2c2f9e0638b5f9532e1263209ded4
+  data.tar.gz: dbe86053eb280e432cc50d83c412a1e30114ac9448aac6fb818f2ef36f19da75
 SHA512:
-  metadata.gz: da965fc1a9d28cb7edafdb82a56a1e73b64930f7706ac32bc9980ee3da415e540362f036c8dd6101b7615ce3781e4cc9e5645780bd83c504c714c60879450dcc
-  data.tar.gz: edbee03ff02ea28e78f88c9e1766d0cccbd0d59b068ae103f80d9c83f10cf734707e96a3341710131f93ffc346066f04a0e3d0200cc9def631cb984285086679
+  metadata.gz: 906d14b5d6922ae062d0056b3ad186975afc284cb9fe0a1a654d10c73174101c92c8dd72fab287cb87a0c3a7c74fda99764557b7020aeed358280109508de434
+  data.tar.gz: 1712eb0890655f184273f6713cda84e4373faa5e660b0ea37323fe6d49d2c8556d6c54d4cca8f639e3f0cf28e59dcf8ae5e1e6145fbf5d61898a54a171f17586

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.
@@ -148,6 +143,8 @@ module ZendeskAPI
     # Retry middleware if retry is true
     def build_connection
       Faraday.new(config.options) do |builder|
+        builder.request :multipart
+
         # response
         builder.use ZendeskAPI::Middleware::Response::RaiseError
         builder.use ZendeskAPI::Middleware::Response::Callback, self
@@ -155,7 +152,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 +159,7 @@ module ZendeskAPI
           builder.use ZendeskAPI::Middleware::Response::Deflate
         end
 
-        # request
-        if config.access_token && !config.url_based_access_token
-          builder.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
@@ -186,7 +175,7 @@ module ZendeskAPI
           builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
         end
 
-        builder.adapter(*adapter)
+        builder.adapter(*adapter, &config.adapter_proc)
       end
     end
 
@@ -239,5 +228,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/collection.rb

@@ -420,8 +420,6 @@ module ZendeskAPI
       @collection_path ||= [@resource]
     end
 
-    ## Fetch
-
     def get_response(path)
       @error = nil
       @response = @client.connection.send(@verb || "get", path) do |req|

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/resource.rb

@@ -5,6 +5,7 @@ require 'zendesk_api/association'
 require 'zendesk_api/associations'
 require 'zendesk_api/verbs'
 
+# See docs: https://developer.zendesk.com/api-reference/
 module ZendeskAPI
   # Represents an abstract resource that only holds data.
   class Data
@@ -145,10 +146,16 @@ module ZendeskAPI
 
     alias :to_param :attributes
 
+    def attributes_for_save
+      { self.class.singular_resource_name.to_sym => attribute_changes }
+    end
+
     private
 
-    def attributes_for_save
-      { self.class.singular_resource_name.to_sym => attributes.changes }
+    # Send only the changes, for example, if the "status" attriubte
+    # goes from "new" to "new", we don't need to send anything
+    def attribute_changes
+      attributes.changes
     end
   end
 
@@ -189,7 +196,7 @@ module ZendeskAPI
 
   class SingularResource < Resource
     def attributes_for_save
-      { self.class.resource_name.to_sym => attributes.changes }
+      { self.class.resource_name.to_sym => attribute_changes }
     end
   end
 

data/lib/zendesk_api/resources.rb

@@ -6,6 +6,7 @@ module ZendeskAPI
   class UserRelated < DataResource; end
   class Category < Resource; end
   class OrganizationSubscription < ReadResource; end
+  class CustomStatus < Resource; end
 
   # @internal Begin actual Resource definitions
 
@@ -190,8 +191,10 @@ module ZendeskAPI
 
     class Section < Resource
     end
+    class Translation < Resource; end
 
     has_many Section
+    has_many Translation
   end
 
   class Section < ReadResource
@@ -203,9 +206,14 @@ module ZendeskAPI
 
     has Category
 
+    class Vote < Resource; end
+    class Translation < Resource; end
     class Article < Resource
+      has_many Vote
+      has_many Translation
     end
 
+    has_many Translation
     has_many Article
   end
 
@@ -215,6 +223,11 @@ module ZendeskAPI
         "help_center/articles"
       end
     end
+
+    class Vote < Resource; end
+    has_many Vote
+    class Translation < Resource; end
+    has_many Translation
   end
 
   class TopicSubscription < Resource
@@ -277,6 +290,18 @@ module ZendeskAPI
     has Group
   end
 
+  class Interval < Resource; end
+
+  class Schedule < Resource
+    has_many Interval
+
+    class << self
+      def resource_path
+        "business_hours/schedules"
+      end
+    end
+  end
+
   class Request < Resource
     class Comment < DataResource
       include Save
@@ -341,6 +366,13 @@ module ZendeskAPI
     extend UpdateMany
     extend DestroyMany
 
+    # Unlike other attributes, "comment" is not a property of the ticket,
+    # but is used as a "comment on save", so it should be kept unchanged,
+    # See https://github.com/zendesk/zendesk_api_client_rb/issues/321
+    def attribute_changes
+      attributes.changes.merge("comment" => attributes["comment"])
+    end
+
     class Audit < DataResource
       class Event < Data
         has :author, :class => User

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.35.0"
+  VERSION = "1.38.0.rc1"
 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,36 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.35.0
+  version: 1.38.0.rc1
 platform: ruby
 authors:
 - Steven Davidovitz
 - Michael Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-09-07 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,11 +152,11 @@ 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.35.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.35.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.35.0
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.38.0.rc1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.38.0.rc1
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.38.0.rc1
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -164,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Zendesk REST API Client
 test_files: []