zendesk_api 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49f877ef488efff63166e65c6bbc635393efa488
-  data.tar.gz: d71df887f074652902d22226c6bf150b98d835e6
+  metadata.gz: 73febfb24dc4a39b5b386d4476aa71718ca59a13
+  data.tar.gz: ba8cfa1f3bccf225f73c5ab33088bba61d9d7167
 SHA512:
-  metadata.gz: 7c528d250017f13ed20916f9b8f32ca5570b3533d75e41f9152104c31ec7ae0c7e888cd21a91d261fc8e0adada5cc5c54c1b4dbce3fedf4a5b1c06c33884b23c
-  data.tar.gz: da0747da376fbabe82d4b46ce86e3a454bbc18fec7c0cb9f1537a8a6e64b21f6b7ede256bc5d4713c5bdbff1747782bab7ab48c6a1e5e565941d22a74a00ddc0
+  metadata.gz: fa55aa31b991933dc87c9956d0dc280c84bc32325f43d65ac95f4abea42b98ca366c169bbfad2274a62901016ea5aa9f2c31c59f3533ea8e576d19bd6be77aba
+  data.tar.gz: dbfe25ff93a95353da721dca9771e8c6561e65f323e2cc6440fb583c1e4f0281f9b27444c2c65839ad65a95080cfaf98d55ac0d06e2c165aca309841bdbf81ab

data/.gitignore

@@ -1,6 +1,6 @@
 pkg
-./doc/*
-./doc/**/*
+doc/*
+doc/**/*
 *swp
 spec/fixtures/cassettes
 spec/fixtures/credentials.yml

data/README.md

@@ -6,7 +6,7 @@ This client **only** supports Zendesk's v2 API.  Please see our [API documentati
 
 ## Documentation
 
-Please check out the [wiki](https://github.com/zendesk/zendesk_api_client_rb/wiki), [class documentation](https://zendesk-api.herokuapp.com/doc/index.html), and [issues](https://github.com/zendesk/zendesk_api_client_rb/issues) before reporting a bug or asking for help.
+Please check out the [wiki](https://github.com/zendesk/zendesk_api_client_rb/wiki), [class documentation](http://zendesk.github.io/zendesk_api_client_rb), and [issues](https://github.com/zendesk/zendesk_api_client_rb/issues) before reporting a bug or asking for help.
 
 ## Important Notices
 
@@ -306,6 +306,7 @@ client.apps.create!(:name => "test", :upload => "app.zip")
 ```
 
 *Note: job statuses are currently not supported, so you must manually poll the job status API for app creation.*
+
 ```ruby
 body = {}
 until %w{failed completed}.include?(body["status"])

data/lib/zendesk_api/actions.rb

@@ -90,6 +90,7 @@ module ZendeskAPI
       base.extend(ClassMethods)
     end
 
+    # Reloads a resource.
     def reload!
       response = @client.connection.get(path) do |req|
         yield req if block_given?
@@ -124,6 +125,8 @@ module ZendeskAPI
       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 => e
@@ -151,6 +154,9 @@ module ZendeskAPI
         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
@@ -160,6 +166,10 @@ module ZendeskAPI
   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 }
@@ -193,6 +203,7 @@ module ZendeskAPI
       @destroyed = true
     end
 
+    # Destroys, returning false on error.
     def destroy(&block)
       destroy!(&block)
     rescue ZendeskAPI::Error::ClientError
@@ -209,6 +220,7 @@ module ZendeskAPI
         true
       end
 
+      # Destroys, returning false on error.
       def destroy(client, attributes = {}, &block)
         destroy!(client, attributes, &block)
       rescue ZendeskAPI::Error::ClientError
@@ -218,6 +230,10 @@ module ZendeskAPI
   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(',') }
@@ -237,15 +253,16 @@ module ZendeskAPI
     end
 
     module ClassMethod
-      # 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 {}
+      # 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))
@@ -257,6 +274,11 @@ module ZendeskAPI
   end
 
   module UpdateMany
+    # Updates multiple resources using the update_many endpoint.
+    # @param [Client] client The {Client} object to be used
+    # @param [Array] ids An array of 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, attributes)
       association = attributes.delete(:association) || Association.new(:class => self)
 

data/lib/zendesk_api/collection.rb

@@ -82,7 +82,7 @@ module ZendeskAPI
 
     # Convenience method to build a new resource and
     # add it to the collection. Fetches the collection as well.
-    # @param [Hash] options Options or attributes to pass
+    # @param [Hash] opts Options or attributes to pass
     def build(opts = {})
       wrap_resource(opts, true).tap do |res|
         self << res
@@ -91,7 +91,7 @@ module ZendeskAPI
 
     # Convenience method to build a new resource and
     # add it to the collection. Fetches the collection as well.
-    # @param [Hash] options Options or attributes to pass
+    # @param [Hash] opts Options or attributes to pass
     def build!(opts = {})
       wrap_resource(opts, true).tap do |res|
         fetch!

data/lib/zendesk_api/resources.rb

@@ -637,6 +637,10 @@ module ZendeskAPI
   end
 
   class User < Resource
+    extend CreateMany
+    extend UpdateMany
+    extend DestroyMany
+
     class TopicComment < TopicComment
       include Read
     end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.12.0"
+  VERSION = "1.12.1"
 end

data/util/resource_handler.rb

@@ -14,7 +14,7 @@ class ResourceHandler < YARD::Handlers::Ruby::Base
           p.const_get(k)
         end
       rescue NameError
-        parent = ZendeskAPI.const_get(namespace.to_s.split('::').last)
+        parent = walk_namespace(namespace)
         klass = parent.const_get(klass)
       end
 
@@ -25,7 +25,7 @@ class ResourceHandler < YARD::Handlers::Ruby::Base
       begin
         klass = ZendeskAPI.const_get(klass)
       rescue NameError
-        parent = ZendeskAPI.const_get(namespace.to_s.split('::').last)
+        parent = walk_namespace(namespace)
         klass = parent.const_get(klass)
       end
 
@@ -52,6 +52,12 @@ class ResourceHandler < YARD::Handlers::Ruby::Base
     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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump