discourse_zendesk_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b93af5c412815bf61b05f472ef44d6eed4950bed97b91ed3dffa3863b245717
+  data.tar.gz: f41010a89c776b543dd20b7a24a87b2a743d854876829a6379d781f4b9a4629c
+SHA512:
+  metadata.gz: 2046f5546c29378a80bff6341cd9526551475e3051e70246d29c76031fc81ee74742723194c8bc62af3b232cf06360e487c814b860df4f7c81abc0f2bf2e8a15
+  data.tar.gz: 93c60d666ef7862e2b7c5ed8fed5e6c5ebe7ceb0090567eb7a6e0c51a8ee89212097fc014d7f5f72de391b7a91d7fccd4ab9d7e496b525312c111ee6b4683ab1

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/lib/zendesk_api/actions.rb

@@ -0,0 +1,334 @@
+module ZendeskAPI
+  module ResponseHandler
+    def handle_response(response)
+      if response.body.is_a?(Hash) && response.body[self.class.singular_resource_name]
+        @attributes.replace(@attributes.deep_merge(response.body[self.class.singular_resource_name]))
+      end
+    end
+  end
+
+  module Save
+    include ResponseHandler
+
+    # If this resource hasn't been deleted, then create or save it.
+    # Executes a POST if it is a {Data#new_record?}, otherwise a PUT.
+    # Merges returned attributes on success.
+    # @return [Boolean] Success?
+    def save!(options = {})
+      return false if respond_to?(:destroyed?) && destroyed?
+
+      if new_record? && !options[:force_update]
+        method = :post
+        req_path = path
+      else
+        method = :put
+        req_path = url || path
+      end
+
+      req_path = options[:path] if options[:path]
+
+      save_associations
+
+      @response = @client.connection.send(method, req_path) do |req|
+        req.body = attributes_for_save.merge(@global_params)
+
+        yield req if block_given?
+      end
+
+      handle_response(@response)
+
+      @attributes.clear_changes
+      clear_associations
+      true
+    end
+
+    # Saves, returning false if it fails and attaching the errors
+    def save(options = {}, &block)
+      save!(options, &block)
+    rescue ZendeskAPI::Error::RecordInvalid => e
+      @errors = e.errors
+      false
+    rescue ZendeskAPI::Error::ClientError
+      false
+    end
+
+    # Removes all cached associations
+    def clear_associations
+      self.class.associations.each do |association_data|
+        name = association_data[:name]
+        instance_variable_set("@#{name}", nil) if instance_variable_defined?("@#{name}")
+      end
+    end
+
+    # Saves associations
+    # Takes into account inlining, collections, and id setting on the parent resource.
+    def save_associations
+      self.class.associations.each do |association_data|
+        association_name = association_data[:name]
+
+        next unless send("#{association_name}_used?") && association = send(association_name)
+
+        inline_creation = association_data[:inline] == :create && new_record?
+        changed = association.is_a?(Collection) || association.changed?
+
+        if association.respond_to?(:save) && changed && !inline_creation && association.save
+          send("#{association_name}=", association) # set id/ids columns
+        end
+
+        if (association_data[:inline] == true || inline_creation) && changed
+          attributes[association_name] = association.to_param
+        end
+      end
+    end
+  end
+
+  module Read
+    include ResponseHandler
+    include ZendeskAPI::Sideloading
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Reloads a resource.
+    def reload!
+      response = @client.connection.get(path) do |req|
+        yield req if block_given?
+      end
+
+      handle_response(response)
+      attributes.clear_changes
+      self
+    end
+
+    module ClassMethods
+      # Finds a resource by an id and any options passed in.
+      # A custom path to search at can be passed into opts. It defaults to the {Data.resource_name} of the class.
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] options Any additional GET parameters to be added
+      def find!(client, options = {})
+        @client = client # so we can use client.logger in rescue
+
+        raise ArgumentError, "No :id given" unless options[:id] || options["id"] || ancestors.include?(SingularResource)
+        association = options.delete(:association) || Association.new(:class => self)
+
+        includes = Array(options[:include])
+        options[:include] = includes.join(",") if includes.any?
+
+        response = client.connection.get(association.generate_path(options)) do |req|
+          req.params = options
+
+          yield req if block_given?
+        end
+
+        new_from_response(client, response, includes)
+      end
+
+      # Finds, returning nil if it fails
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] options Any additional GET parameters to be added
+      def find(client, options = {}, &block)
+        find!(client, options, &block)
+      rescue ZendeskAPI::Error::ClientError
+        nil
+      end
+    end
+  end
+
+  module Create
+    include Save
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Create a resource given the attributes passed in.
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] attributes The attributes to create.
+      def create!(client, attributes = {}, &block)
+        ZendeskAPI::Client.check_deprecated_namespace_usage attributes, singular_resource_name
+
+        new(client, attributes).tap do |resource|
+          resource.save!(&block)
+        end
+      end
+
+      # Creates, returning nil if it fails
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] options Any additional GET parameters to be added
+      def create(client, attributes = {}, &block)
+        create!(client, attributes, &block)
+      rescue ZendeskAPI::Error::ClientError
+        nil
+      end
+    end
+  end
+
+  module CreateMany
+    # Creates multiple resources using the create_many endpoint.
+    # @param [Client] client The {Client} object to be used
+    # @param [Array] attributes_array An array of resources to be created.
+    # @return [JobStatus] the {JobStatus} instance for this create job
+    def create_many!(client, attributes_array, association = Association.new(:class => self))
+      response = client.connection.post("#{association.generate_path}/create_many") do |req|
+        req.body = { resource_name => attributes_array }
+
+        yield req if block_given?
+      end
+
+      JobStatus.new_from_response(client, response)
+    end
+  end
+
+  module CreateOrUpdate
+    # Creates or updates resource using the create_or_update endpoint.
+    # @param [Client] client The {Client} object to be used
+    # @param [Hash] attributes The attributes to create.
+    def create_or_update!(client, attributes, association = Association.new(:class => self))
+      response = client.connection.post("#{association.generate_path}/create_or_update") do |req|
+        req.body = { singular_resource_name => attributes }
+
+        yield req if block_given?
+      end
+
+      new_from_response(client, response, Array(association.options[:include]))
+    end
+  end
+
+  module CreateOrUpdateMany
+    # Creates or updates multiple resources using the create_or_update_many endpoint.
+    #
+    # @param [Client] client The {Client} object to be used
+    # @param [Array<Hash>] attributes The attributes to update resources with
+    #
+    # @return [JobStatus] the {JobStatus} instance for this destroy job
+    def create_or_update_many!(client, attributes)
+      association = Association.new(:class => self)
+
+      response = client.connection.post("#{association.generate_path}/create_or_update_many") do |req|
+        req.body = { resource_name => attributes }
+
+        yield req if block_given?
+      end
+
+      JobStatus.new_from_response(client, response)
+    end
+  end
+
+  module Destroy
+    def self.included(klass)
+      klass.extend(ClassMethod)
+    end
+
+    # Has this object been deleted?
+    def destroyed?
+      @destroyed ||= false
+    end
+
+    # If this resource hasn't already been deleted, then do so.
+    # @return [Boolean] Successful?
+    def destroy!
+      return false if destroyed? || new_record?
+
+      @client.connection.delete(url || path) do |req|
+        yield req if block_given?
+      end
+
+      @destroyed = true
+    end
+
+    # Destroys, returning false on error.
+    def destroy(&block)
+      destroy!(&block)
+    rescue ZendeskAPI::Error::ClientError
+      false
+    end
+
+    module ClassMethod
+      # Deletes a resource given the id passed in.
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] opts The optional parameters to pass. Defaults to {}
+      def destroy!(client, opts = {}, &block)
+        new(client, opts).destroy!(&block)
+
+        true
+      end
+
+      # Destroys, returning false on error.
+      def destroy(client, attributes = {}, &block)
+        destroy!(client, attributes, &block)
+      rescue ZendeskAPI::Error::ClientError
+        false
+      end
+    end
+  end
+
+  module DestroyMany
+    # Destroys multiple resources using the destroy_many endpoint.
+    # @param [Client] client The {Client} object to be used
+    # @param [Array] ids An array of ids to destroy
+    # @return [JobStatus] the {JobStatus} instance for this destroy job
+    def destroy_many!(client, ids, association = Association.new(:class => self))
+      response = client.connection.delete("#{association.generate_path}/destroy_many") do |req|
+        req.params = { :ids => ids.join(',') }
+
+        yield req if block_given?
+      end
+
+      JobStatus.new_from_response(client, response)
+    end
+  end
+
+  module Update
+    include Save
+
+    def self.included(klass)
+      klass.extend(ClassMethod)
+    end
+
+    module ClassMethod
+      # Updates, returning false on error.
+      def update(client, attributes = {}, &block)
+        update!(client, attributes, &block)
+      rescue ZendeskAPI::Error::ClientError
+        false
+      end
+
+      # Updates a resource given the id passed in.
+      # @param [Client] client The {Client} object to be used
+      # @param [Hash] attributes The attributes to update. Default to {
+      def update!(client, attributes = {}, &block)
+        ZendeskAPI::Client.check_deprecated_namespace_usage attributes, singular_resource_name
+        resource = new(client, :id => attributes.delete(:id), :global => attributes.delete(:global), :association => attributes.delete(:association))
+        resource.attributes.merge!(attributes)
+        resource.save!(:force_update => resource.is_a?(SingularResource), &block)
+        resource
+      end
+    end
+  end
+
+  module UpdateMany
+    # Updates multiple resources using the update_many endpoint.
+    # @param [Client] client The {Client} object to be used
+    # @param [Array] ids_or_attributes An array of ids or arributes including ids to update
+    # @param [Hash] attributes The attributes to update resources with
+    # @return [JobStatus] the {JobStatus} instance for this destroy job
+    def update_many!(client, ids_or_attributes, attributes = {})
+      association = attributes.delete(:association) || Association.new(:class => self)
+
+      response = client.connection.put("#{association.generate_path}/update_many") do |req|
+        if attributes == {}
+          req.body = { resource_name => ids_or_attributes }
+        else
+          req.params = { :ids => ids_or_attributes.join(',') }
+          req.body = { singular_resource_name => attributes }
+        end
+
+        yield req if block_given?
+      end
+
+      JobStatus.new_from_response(client, response)
+    end
+  end
+end