zendesk_api 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a8136e8dbb6d7205f9e621716c932ab3cc126fd
-  data.tar.gz: e3172fe0c372455575eacbff2fb1cb561fdfaa6e
+  metadata.gz: f7ceae5c77434c64d5c127b60223bf116aea9886
+  data.tar.gz: fda68db40b3a1433387b9d5493f2a82afef0c56e
 SHA512:
-  metadata.gz: 3ffb325cdc67e9f8023cf13d106508372ca51a970dc29b32a986e47f947cf048944dca5ee6efcc5f8261da53d574b85a03f2d248e93c887e18ffbe7e89d40333
-  data.tar.gz: e3b4ba19b901378f884a1af3352fd28d4103af5f46d75c859ec687a3e22b9ecc5fea92996dddd46a8b7b9d975735a01c40f08d3d9f04576dfeadb3304045f2c1
+  metadata.gz: 13e01aca05908e6046cfe6da59ef99f9f5bb83db4287de96596ccbf6365ba8055b6cec8df5f5ad1b55a425afcb7291fdd37920ffe52408b3b163f42e58c7433b
+  data.tar.gz: 272d233f0a6e56cd4985ad3fee74d93d1c5557a7b479e31286dc78cf78a67fe3890724b725a21ba5329c54018ff6845391f7a4134b133a0f7162e00beb9908ec

data/lib/zendesk_api/actions.rb

@@ -83,42 +83,52 @@ module ZendeskAPI
   end
 
   module Read
-    def self.extended(klass)
-      klass.send(:include, ZendeskAPI::Sideloading)
-      klass.send(:include, ResponseHandler)
+    include ResponseHandler
+    include ZendeskAPI::Sideloading
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def reload!
+      response = client.connection.get(path) do |req|
+        yield req if block_given?
+      end
+
+      handle_response(response)
+      attributes.clear_changes
+      self
     end
 
-    # 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
+    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)
+        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?
+        includes = Array(options[:include])
+        options[:include] = includes.join(",") if includes.any?
 
-      response = client.connection.get(association.generate_path(options)) do |req|
-        req.params = options
+        response = client.connection.get(association.generate_path(options)) do |req|
+          req.params = options
 
-        yield req if block_given?
-      end
+          yield req if block_given?
+        end
 
-      new(client).tap do |resource|
-        resource.handle_response(response)
-        resource.set_includes(resource, includes, response.body)
-        resource.attributes.clear_changes
+        new_from_response(client, response, includes)
       end
-    end
 
-    # Finds, returning nil if it fails
-    def find(client, options = {}, &block)
-      find!(client, options, &block)
-    rescue ZendeskAPI::Error::ClientError => e
-      nil
+      # Finds, returning nil if it fails
+      def find(client, options = {}, &block)
+        find!(client, options, &block)
+      rescue ZendeskAPI::Error::ClientError => e
+        nil
+      end
     end
   end
 
@@ -149,6 +159,18 @@ module ZendeskAPI
     end
   end
 
+  module CreateMany
+    def create_many!(client, attributes_array)
+      response = client.connection.post("#{resource_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 Destroy
     def self.included(klass)
       klass.extend(ClassMethod)
@@ -195,6 +217,18 @@ module ZendeskAPI
     end
   end
 
+  module DestroyMany
+    def destroy_many!(client, ids)
+      response = client.connection.delete("#{resource_path}/destroy_many") do |req|
+        req.params = { :ids => ids }
+
+        yield req if block_given?
+      end
+
+      JobStatus.new_from_response(client, response)
+    end
+  end
+
   module Update
     include Save
 

data/lib/zendesk_api/resource.rb

@@ -66,6 +66,14 @@ module ZendeskAPI
       @attributes.clear_changes unless new_record?
     end
 
+    def self.new_from_response(client, response, includes = nil)
+      new(client).tap do |resource|
+        resource.handle_response(response)
+        resource.set_includes(resource, includes, response.body) if includes
+        resource.attributes.clear_changes
+      end
+    end
+
     # Passes the method onto the attributes hash.
     # If the attributes are nested (e.g. { :tickets => { :id => 1 } }), passes the method onto the nested hash.
     def method_missing(*args, &block)
@@ -147,7 +155,7 @@ module ZendeskAPI
 
   # Represents a resource that can only GET
   class ReadResource < DataResource
-    extend Read
+    include Read
   end
 
   # Represents a resource that can only POST
@@ -167,7 +175,7 @@ module ZendeskAPI
 
   # Represents a resource that can CRUD (create, read, update, delete).
   class Resource < DataResource
-    extend Read
+    include Read
     include Create
 
     include Update

data/lib/zendesk_api/resources.rb

@@ -605,6 +605,9 @@ module ZendeskAPI
   end
 
   class GroupMembership < Resource
+    extend CreateMany
+    extend DestroyMany
+
     has User
     has Group
   end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

data/spec/core/bulk_actions_spec.rb

@@ -0,0 +1,45 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::DestroyMany do
+  subject { ZendeskAPI::BulkTestResource }
+
+  context "destroy_many!" do
+    before(:each) do
+      stub_json_request(:delete, %r{bulk_test_resources/destroy_many}, json(:job_status => {:id => 'abc'}))
+      @response = subject.destroy_many!(client, [1,2,3])
+    end
+
+    it 'calls the destroy_many endpoint' do
+      assert_requested(:delete, %r{bulk_test_resources/destroy_many\?ids%5B%5D=1&ids%5B%5D=2&ids%5B%5D=3})
+    end
+
+    it 'returns a JobStatus' do
+      expect(@response).to be_instance_of(ZendeskAPI::JobStatus)
+      expect(@response.id).to eq('abc')
+    end
+  end
+end
+
+describe ZendeskAPI::CreateMany do
+  subject { ZendeskAPI::BulkTestResource }
+
+  context "create_many!" do
+    let(:attributes) { [{:name => 'A'}, {:name => 'B'}] }
+
+    before(:each) do
+      stub_json_request(:post, %r{bulk_test_resources/create_many}, json(:job_status => {:id => 'def'}))
+      @response = subject.create_many!(client, attributes)
+    end
+
+    it 'calls the create_many endpoint' do
+      assert_requested(:post, %r{bulk_test_resources/create_many},
+        :body => json(:bulk_test_resources => attributes)
+      )
+    end
+
+    it 'returns a JobStatus' do
+      expect(@response).to be_instance_of(ZendeskAPI::JobStatus)
+      expect(@response.id).to eq('def')
+    end
+  end
+end

data/spec/core/read_resource_spec.rb

@@ -73,5 +73,25 @@ describe ZendeskAPI::ReadResource do
       end
     end
   end
+
+  context "#reload!" do
+    let(:id) { 2 }
+
+    subject { ZendeskAPI::TestResource.new(client, :id => id, :name => 'Old Name') }
+
+    before(:each) do
+      stub_json_request(:get, %r{test_resources/#{id}}, json("test_resource" => {:id => id, :name => "New Name" }))
+    end
+
+    it "reloads the data" do
+      expect(subject.name).to eq('Old Name')
+      assert_not_requested(:get, %r{test_resources/#{id}})
+
+      subject.reload!
+
+      assert_requested(:get, %r{test_resources/#{id}})
+      expect(subject.name).to eq('New Name')
+    end
+  end
 end
 

data/spec/fixtures/test_resources.rb

@@ -7,6 +7,11 @@ class ZendeskAPI::TestResource < ZendeskAPI::Resource
   end
 end
 
+class ZendeskAPI::BulkTestResource < ZendeskAPI::DataResource
+  extend ZendeskAPI::CreateMany
+  extend ZendeskAPI::DestroyMany
+end
+
 class ZendeskAPI::NilResource < ZendeskAPI::Data; end
 class ZendeskAPI::NilDataResource < ZendeskAPI::DataResource; end
 class ZendeskAPI::SingularTestResource < ZendeskAPI::SingularResource; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -239,6 +239,7 @@ files:
 - lib/zendesk_api/verbs.rb
 - lib/zendesk_api/version.rb
 - spec/core/association_spec.rb
+- spec/core/bulk_actions_spec.rb
 - spec/core/client_spec.rb
 - spec/core/collection_spec.rb
 - spec/core/configuration_spec.rb
@@ -351,12 +352,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Zendesk REST API Client
 test_files:
 - spec/core/association_spec.rb
+- spec/core/bulk_actions_spec.rb
 - spec/core/client_spec.rb
 - spec/core/collection_spec.rb
 - spec/core/configuration_spec.rb