discourse_zendesk_api 1.0.0

data/lib/zendesk_api/sideloading.rb

@@ -0,0 +1,58 @@
+module ZendeskAPI
+  # @private
+  module Sideloading
+    def self.included(klass)
+      klass.send(:attr_reader, :included)
+    end
+
+    def set_includes(resource_or_resources, includes, body)
+      @included = {}
+
+      includes.each do |side_load|
+        unless body.key?(side_load.to_s)
+          @client.config.logger.warn "Missing #{side_load} key in response -- cannot side load"
+        end
+      end
+
+      resources = to_array(resource_or_resources)
+      resource_class = resources.first.class
+
+      return if resources.empty?
+
+      body.keys.each do |name|
+        @included[name] = body[name]
+        _side_load(name, resource_class, resources)
+      end
+    end
+
+    private
+
+    # Traverses the resource looking for associations
+    # then descends into those associations and checks for applicable
+    # resources to side load
+    def _side_load(name, klass, resources)
+      associations = klass.associated_with(name)
+
+      associations.each do |association|
+        association.side_load(resources, @included[name])
+      end
+
+      resources.each do |resource|
+        loaded_associations = resource.loaded_associations
+        loaded_associations.each do |association|
+          loaded = resource.send(association[:name])
+          next unless loaded
+          _side_load(name, association[:class], to_array(loaded))
+        end
+      end
+    end
+
+    def to_array(item)
+      if item.is_a?(Collection)
+        item
+      else
+        [item].flatten.compact
+      end
+    end
+  end
+end

data/lib/zendesk_api/silent_mash.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+
+module ZendeskAPI
+  # @private
+  class SilentMash < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/zendesk_api/track_changes.rb

@@ -0,0 +1,85 @@
+module ZendeskAPI
+  # Shamelessly stolen and modified from https://github.com/archan937/dirty_hashy
+  # @private
+  module TrackChanges
+    def self.included(base)
+      base.method_defined?(:regular_writer).tap do |defined|
+        base.send :include, InstanceMethods
+        unless defined
+          base.send :alias_method, :_store, :store
+          base.send :alias_method, :store, :regular_writer
+          base.send :alias_method, :[]=, :store
+          base.send :define_method, :update do |other|
+            other.each { |key, value| store key, value }
+          end
+          base.send :alias_method, :merge!, :update
+        end
+      end
+    end
+
+    # @private
+    module InstanceMethods
+      def clear_changes
+        each do |k, v|
+          if v.respond_to?(:clear_changes)
+            v.clear_changes
+          elsif v.is_a?(Array)
+            v.each do |val|
+              if val.respond_to?(:clear_changes)
+                val.clear_changes
+              end
+            end
+          end
+        end
+
+        changes.clear
+      end
+
+      def replace(other)
+        clear
+        merge! other
+      end
+
+      def clear
+        keys.each { |key| delete key }
+      end
+
+      def regular_writer(key, value)
+        if has_key?(key) && self[key] == value
+          value
+        else
+          changes[key] = value
+          defined?(_store) ? _store(key, value) : super(key, value)
+        end
+      end
+
+      def delete(key)
+        super.tap do |value|
+          changes[key] = nil
+        end
+      end
+
+      def changes
+        (@changes ||= self.class.superclass.new).tap do |changes|
+          each do |k, v|
+            if v.respond_to?(:changed?) && v.changed?
+              changes[k] = v.changes
+            elsif v.is_a?(Array) && v.any? { |val| val.respond_to?(:changed?) && val.changed? }
+              changes[k] = v
+            end
+          end
+        end
+      end
+
+      def changed?(key = nil)
+        if key.nil?
+          !changes.empty? || any? { |_, v| v.respond_to?(:changed?) && v.changed? }
+        else
+          changes.key?(key)
+        end
+      end
+
+      alias :dirty? :changed?
+    end
+  end
+end

data/lib/zendesk_api/trackie.rb

@@ -0,0 +1,13 @@
+require 'zendesk_api/track_changes'
+require 'zendesk_api/silent_mash'
+
+module ZendeskAPI
+  # @private
+  class Trackie < SilentMash
+    include ZendeskAPI::TrackChanges
+
+    def size
+      self['size']
+    end
+  end
+end

data/lib/zendesk_api/verbs.rb

@@ -0,0 +1,65 @@
+module ZendeskAPI
+  # Creates put, post, delete class methods for custom resource methods.
+  module Verbs
+    class << self
+      private
+
+      # @macro [attach] container.create_verb
+      #   @method $1(method)
+      #   Executes a $1 using the passed in method as a path.
+      #   Reloads the resource's attributes if any are in the response body.
+      #
+      #   Created method takes an optional options hash. Valid options to be passed in to the created method: reload (for caching, default: false)
+      def create_verb(method_verb)
+        define_method method_verb do |method|
+          define_method "#{method}!" do |*method_args|
+            opts = method_args.last.is_a?(Hash) ? method_args.pop : {}
+
+            if method_verb == :any
+              verb = opts.delete(:verb)
+              raise(ArgumentError, ":verb required for method defined as :any") unless verb
+            else
+              verb = method_verb
+            end
+
+            @response = @client.connection.send(verb, "#{path}/#{method}") do |req|
+              req.body = opts
+            end
+
+            return false unless @response.success?
+            return false unless @response.body
+
+            resource = nil
+
+            if @response.body.is_a?(Hash)
+              resource = @response.body[self.class.singular_resource_name]
+              resource ||= @response.body.fetch(self.class.resource_name, []).detect { |res| res["id"] == id }
+            end
+
+            @attributes.replace @attributes.deep_merge(resource || {})
+            @attributes.clear_changes
+            clear_associations
+
+            true
+          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
+          end
+        end
+      end
+    end
+
+    create_verb :put
+    create_verb :post
+    create_verb :delete
+    create_verb :any
+  end
+end

data/lib/zendesk_api/version.rb

@@ -0,0 +1,3 @@
+module ZendeskAPI
+  VERSION = "1.0.0"
+end

data/lib/zendesk_api.rb

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

data/util/resource_handler.rb

@@ -0,0 +1,74 @@
+require 'zendesk_api'
+
+class ResourceHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:has), method_call(:has_many)
+
+  def process
+    many = statement.jump(:ident).source == "has_many"
+
+    klass = get_klass(statement)
+
+    if klass
+      begin
+        klass = klass.split("::").inject(ZendeskAPI) do |p, k|
+          p.const_get(k)
+        end
+      rescue NameError
+        parent = walk_namespace(namespace)
+        klass = parent.const_get(klass)
+      end
+
+      name = statement.parameters.first.jump(:ident).source
+    else
+      klass = statement.parameters.first.source
+
+      begin
+        klass = ZendeskAPI.const_get(klass)
+      rescue NameError
+        parent = walk_namespace(namespace)
+        klass = parent.const_get(klass)
+      end
+
+      name = many ? klass.resource_name : klass.singular_resource_name
+    end
+
+    reader = YARD::CodeObjects::MethodObject.new(namespace, name)
+    register(reader)
+    reader.dynamic = true
+    reader.docstring.add_tag(YARD::Tags::Tag.new(:return, "The associated object", klass.name))
+
+    if many
+      reader.signature = "def #{name}=(options = {})"
+      reader.parameters = [['options', {}]]
+      reader.docstring.add_tag(YARD::Tags::Tag.new(:param, "Options to pass to the collection object", "Hash", "options"))
+    end
+
+    writer = YARD::CodeObjects::MethodObject.new(namespace, "#{name}=")
+    register(writer)
+    writer.signature = "def #{name}=(value)"
+    writer.parameters = [['value', nil]]
+    writer.dynamic = true
+    writer.docstring.add_tag(YARD::Tags::Tag.new(:return, "The associated object", klass.name))
+    writer.docstring.add_tag(YARD::Tags::Tag.new(:param, "The associated object or its attributes", "Hash or #{klass.name}", "value"))
+  end
+
+  def walk_namespace(namespace)
+    namespace.to_s.split('::').inject(ZendeskAPI) do |klass, namespace|
+      klass.const_get(namespace)
+    end
+  end
+
+  def get_klass(statement)
+    statement.traverse do |node|
+      if node.type == :assoc && node.jump(:kw).source == "class"
+        node.traverse do |value|
+          if value.type == :const_path_ref || value.type == :var_ref
+            return value.source
+          end
+        end
+      end
+    end
+
+    nil
+  end
+end

data/util/verb_handler.rb

@@ -0,0 +1,16 @@
+class VerbHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:put), method_call(:post), method_call(:get)
+
+  def process
+    name = statement.parameters.first.jump(:ident).source
+
+    verb = YARD::CodeObjects::MethodObject.new(namespace, name)
+    register(verb)
+    verb.dynamic = true
+    verb.docstring.add_tag(YARD::Tags::Tag.new(:return, "Success of this call", "Boolean"))
+
+    verb.signature = "def #{name}=(options = {})"
+    verb.parameters = [['options', {}]]
+    verb.docstring.add_tag(YARD::Tags::Tag.new(:param, "Options to pass to the request", "Hash", "options"))
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: discourse_zendesk_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Discourse
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-30 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: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: inflection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  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: mini_mime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the REST API at https://www.zendesk.com. Documentation
+  at https://developer.zendesk.com.
+email:
+- isaac.janzen@discourse.org
+- sam.saffron@discourse.org
+- robin.ward@discourse.org
+- team@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/zendesk_api.rb
+- lib/zendesk_api/actions.rb
+- lib/zendesk_api/association.rb
+- lib/zendesk_api/associations.rb
+- lib/zendesk_api/client.rb
+- lib/zendesk_api/collection.rb
+- lib/zendesk_api/configuration.rb
+- lib/zendesk_api/core_ext/inflection.rb
+- lib/zendesk_api/delegator.rb
+- lib/zendesk_api/error.rb
+- lib/zendesk_api/helpers.rb
+- lib/zendesk_api/lru_cache.rb
+- lib/zendesk_api/middleware/request/encode_json.rb
+- lib/zendesk_api/middleware/request/etag_cache.rb
+- lib/zendesk_api/middleware/request/raise_rate_limited.rb
+- lib/zendesk_api/middleware/request/retry.rb
+- lib/zendesk_api/middleware/request/upload.rb
+- lib/zendesk_api/middleware/request/url_based_access_token.rb
+- lib/zendesk_api/middleware/response/callback.rb
+- lib/zendesk_api/middleware/response/deflate.rb
+- lib/zendesk_api/middleware/response/gzip.rb
+- lib/zendesk_api/middleware/response/logger.rb
+- lib/zendesk_api/middleware/response/parse_iso_dates.rb
+- lib/zendesk_api/middleware/response/parse_json.rb
+- lib/zendesk_api/middleware/response/raise_error.rb
+- lib/zendesk_api/middleware/response/sanitize_response.rb
+- lib/zendesk_api/resource.rb
+- lib/zendesk_api/resources.rb
+- lib/zendesk_api/sideloading.rb
+- lib/zendesk_api/silent_mash.rb
+- lib/zendesk_api/track_changes.rb
+- lib/zendesk_api/trackie.rb
+- lib/zendesk_api/verbs.rb
+- lib/zendesk_api/version.rb
+- util/resource_handler.rb
+- util/verb_handler.rb
+homepage: https://developer.zendesk.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Discourse Zendesk REST API Client
+test_files: []