zendesk_api 0.4.0.rc2 → 0.4.0.rc3

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (0.4.0.rc2)
+    zendesk_api (0.4.0.rc3)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie (>= 1.2)

data/Readme.md

@@ -86,7 +86,7 @@ One way to use the client is to pass it in as an argument to individual classes.
 ZendeskAPI::Ticket.new(client, :id => 1, :priority => "urgent") # doesn't actually send a request, must explicitly call #save
 ZendeskAPI::Ticket.create(client, :subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent")
 ZendeskAPI::Ticket.find(client, :id => 1)
-ZendeskAPI::Ticket.delete(client, :id => 1)
+ZendeskAPI::Ticket.destroy(client, :id => 1)
 ```
 
 Another way is to use the instance methods under client.
@@ -95,7 +95,7 @@ Another way is to use the instance methods under client.
 client.tickets.first
 client.tickets.find(:id => 1)
 client.tickets.create(:subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent")
-client.tickets.delete(:id => 1)
+client.tickets.destroy(:id => 1)
 ```
 
 The methods under ZendeskAPI::Client (such as .tickets) return an instance of ZendeskAPI::Collection a lazy-loaded list of that resource.

data/lib/zendesk_api/actions.rb

@@ -21,6 +21,8 @@ module ZendeskAPI
 
       @response = @client.connection.send(method, req_path) do |req|
         req.body = attributes_for_save.merge(@global_params)
+
+        yield req if block_given?
       end
 
       if @response.body && @response.body[self.class.singular_resource_name]
@@ -33,8 +35,8 @@ module ZendeskAPI
     end
 
     # Saves, returning false if it fails and attaching the errors
-    def save(options={})
-      save!(options)
+    def save(options = {}, &block)
+      save!(options, &block)
     rescue ZendeskAPI::Error::RecordInvalid => e
       @errors = e.errors
       false
@@ -58,7 +60,7 @@ module ZendeskAPI
         next unless send("#{association_name}_used?") && association = send(association_name)
 
         inline_creation = association_data[:inline] == :create && new_record?
-        changed = association.is_a?(Collection) || !association.changes.empty?
+        changed = association.is_a?(Collection) || association.changed?
 
         if association.respond_to?(:save) && changed && !inline_creation && association.save
           self.send("#{association_name}=", association) # set id/ids columns
@@ -91,6 +93,8 @@ module ZendeskAPI
 
       response = client.connection.get(association.generate_path(options)) do |req|
         req.params = options
+
+        yield req if block_given?
       end
 
       new(client, response.body[singular_resource_name]).tap do |resource|
@@ -100,8 +104,8 @@ module ZendeskAPI
     end
 
     # Finds, returning nil if it fails
-    def find(client, options = {})
-      find!(client, options)
+    def find(client, options = {}, &block)
+      find!(client, options, &block)
     rescue ZendeskAPI::Error::ClientError => e
       nil
     end
@@ -118,13 +122,16 @@ module ZendeskAPI
       # 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 = {})
+      def create!(client, attributes = {}, &block)
         ZendeskAPI::Client.check_deprecated_namespace_usage attributes, singular_resource_name
-        new(client, attributes).tap(&:save!)
+
+        new(client, attributes).tap do |resource|
+          resource.save!(&block)
+        end
       end
 
-      def create(client, attributes = {})
-        create!(client, attributes)
+      def create(client, attributes = {}, &block)
+        create!(client, attributes, &block)
       rescue ZendeskAPI::Error::ClientError
         nil
       end
@@ -145,12 +152,16 @@ module ZendeskAPI
     # @return [Boolean] Successful?
     def destroy!
       return false if destroyed? || new_record?
-      @client.connection.delete(url || path)
+
+      @client.connection.delete(url || path) do |req|
+        yield req if block_given?
+      end
+
       @destroyed = true
     end
 
-    def destroy
-      destroy!
+    def destroy(&block)
+      destroy!(&block)
     rescue ZendeskAPI::Error::ClientError
       false
     end
@@ -159,19 +170,14 @@ module ZendeskAPI
       # 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 = {})
-        @client = client # so we can use client.logger in rescue
-        association = opts.delete(:association) || Association.new(:class => self)
-
-        client.connection.delete(association.generate_path(opts)) do |req|
-          req.params = opts
-        end
+      def destroy!(client, opts = {}, &block)
+        new(client, opts).destroy!(&block)
 
         true
       end
 
-      def destroy(client, attributes = {})
-        destroy!(client, attributes)
+      def destroy(client, attributes = {}, &block)
+        destroy!(client, attributes, &block)
       rescue ZendeskAPI::Error::ClientError
         false
       end
@@ -189,17 +195,17 @@ module ZendeskAPI
       # 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 = {})
-        update!(client, attributes)
+      def update(client, attributes = {}, &block)
+        update!(client, attributes, &block)
       rescue ZendeskAPI::Error::ClientError
         false
       end
 
-      def update!(client, attributes = {})
+      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) })
+        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))
+        resource.save!(:force_update => resource.is_a?(SingularResource), &block)
         resource
       end
     end

data/lib/zendesk_api/associations.rb

@@ -59,7 +59,8 @@ module ZendeskAPI
           :path => options.delete(:path),
           :include => (options.delete(:include) || klass.resource_name).to_s,
           :include_key => (options.delete(:include_key) || :id).to_s,
-          :singular => options.delete(:singular)
+          :singular => options.delete(:singular),
+          :extensions => Array(options.delete(:extend))
         }
       end
 
@@ -171,15 +172,23 @@ module ZendeskAPI
                 klass.find(@client, :id => id, :association => instance_association)
               end.compact
             elsif (resources = method_missing(association[:name].to_sym)) && resources.any?
-              resources.map do |res|
-                klass.new(@client, res.merge(:association => instance_association))
-              end
+              resources.map {|res| wrap_resource(res, association)}
             else
-              ZendeskAPI::Collection.new(@client, klass, instance_opts.merge(:association => instance_association))
+              []
             end
 
-            send("#{association[:id_column]}=", resources.map(&:id)) if resource && has_key?(association[:id_column])
-            instance_variable_set("@#{association[:name]}", resources)
+            collection = ZendeskAPI::Collection.new(@client, klass, instance_opts.merge(:association => instance_association))
+
+            if association[:extensions].any?
+              collection.extend(*association[:extensions])
+            end
+
+            if resources.any?
+              collection.replace(resources)
+            end
+
+            send("#{association[:id_column]}=", resources.map(&:id)) if has_key?(association[:id_column])
+            instance_variable_set("@#{association[:name]}", collection)
           end
         end
 

data/lib/zendesk_api/collection.rb

@@ -126,8 +126,7 @@ module ZendeskAPI
           raise "this collection is for #{@resource_class}"
         end
       else
-        item.merge!(:association => @association) if item.is_a?(Hash)
-        @resources << @resource_class.new(@client, item)
+        @resources << wrap_resource(item)
       end
     end
 
@@ -142,7 +141,7 @@ module ZendeskAPI
       if @resources && (!@fetchable || !reload)
         return @resources
       elsif association && association.options.parent && association.options.parent.new_record?
-        return @resources = []
+        return (@resources = [])
       end
 
       @response = get_response(@query || self.path)
@@ -299,17 +298,19 @@ module ZendeskAPI
     end
 
     def _save(method = :save)
-      if @resources
-        @resources.map! do |item|
-          if item.respond_to?(method) && !item.changes.empty?
-            item.send(method)
-          end
+      return self unless @resources
+
+      result = true
 
-          item
+      @resources.map! do |item|
+        if item.respond_to?(method) && item.changed?
+          result &&= item.send(method)
         end
+
+        item
       end
 
-      self
+      result
     end
 
     ## Initialize
@@ -351,12 +352,27 @@ module ZendeskAPI
 
     def handle_response(body)
       results = body.delete(@resource_class.model_key) || body.delete("results")
-      @resources = results.map {|res| @resource_class.new(@client, res)}
+
+      @resources = results.map do |res|
+        wrap_resource(res)
+      end
 
       set_page_and_count(body)
       set_includes(@resources, @includes, body)
     end
 
+    # Simplified Associations#wrap_resource
+    def wrap_resource(res)
+      case res
+      when Array
+        wrap_resource(Hash[*res])
+      when Hash
+        @resource_class.new(@client, res.merge(:association => association))
+      else
+        @resource_class.new(@client, :id => res, :association => association)
+      end
+    end
+
     ## Method missing
 
     def array_method(name, *args, &block)

data/lib/zendesk_api/resources.rb

@@ -20,13 +20,55 @@ module ZendeskAPI
   class SharingAgreement < ReadResource; end
   class JobStatus < ReadResource; end
 
+  class Tag < DataResource
+    include Update
+    include Destroy
+
+    alias :name :id
+
+    def path(opts = {})
+      raise "tags must have parent resource" unless association.options.parent
+      super(opts.merge(:with_parent => true, :with_id => false))
+    end
+
+    def changed?
+      true
+    end
+
+    def destroy!
+      super do |req|
+        req.body = attributes_for_save
+      end
+    end
+
+    module Update
+      def _save(method = :save)
+        return self unless @resources
+
+        client.connection.post(path) do |req|
+          req.body = { :tags => @resources.map(&:id) }
+        end
+
+        true
+      rescue Faraday::Error::ClientError => e
+        if method == :save
+          false
+        else
+          raise e
+        end
+      end
+    end
+
+    def attributes_for_save
+      { self.class.resource_name => [id] }
+    end
+  end
+
   class Attachment < Data
     def initialize(client, attributes)
-      if attributes.is_a?(Hash)
-        super
-      else
-        super(client, :file => attributes)
-      end
+      attributes[:file] ||= attributes.delete(:id)
+
+      super
     end
 
     def save
@@ -65,6 +107,7 @@ module ZendeskAPI
 
     has_many Ticket
     has_many User
+    has_many Tag, :extend => Tag::Update
   end
 
   class ForumSubscription < Resource
@@ -120,6 +163,7 @@ module ZendeskAPI
     has_many :comments, :class => TopicComment
     has_many :subscriptions, :class => TopicSubscription
     has :vote, :class => TopicVote
+    has_many Tag, :extend => Tag::Update
 
     def votes(opts = {})
       return @votes if @votes && !opts[:reload]
@@ -138,8 +182,13 @@ module ZendeskAPI
     attr_reader :on
 
     def initialize(client, attributes = {})
-      @on = attributes.first
-      super(client, attributes[1])
+      # Try and find the root key
+      @on = (attributes.keys.map(&:to_s) - %w{association options}).first
+
+      # Make what's inside that key the root attributes
+      attributes.merge!(attributes.delete(@on))
+
+      super
     end
   end
 
@@ -212,8 +261,6 @@ module ZendeskAPI
       has :author, :class => User
     end
 
-    class Tag < Resource; end
-
     class Comment < Data
       include Save
 
@@ -242,6 +289,8 @@ module ZendeskAPI
     has :last_comment, :class => Comment, :inline => true
     has_many :last_comments, :class => Comment, :inline => true
 
+    has_many Tag, :extend => Tag::Update
+
     # Gets a incremental export of tickets from the start_time until now.
     # @param [Client] client The {Client} object to be used
     # @param [Integer] start_time The start_time parameter
@@ -399,12 +448,20 @@ module ZendeskAPI
   class UserField < Resource; end
   class OrganizationField < Resource; end
 
-  class OAuthClient < Resource
+  class OauthClient < Resource
     namespace "oauth"
+
+    def self.singular_resource_name
+      "client"
+    end
   end
 
-  class OAuthToken < ReadResource
+  class OauthToken < ReadResource
     include Destroy
     namespace "oauth"
+
+    def self.singular_resource_name
+      "token"
+    end
   end
 end

data/lib/zendesk_api/sideloading.rb

@@ -14,7 +14,7 @@ module ZendeskAPI
         end
       end
 
-      resources = [resource_or_resources].flatten.compact
+      resources = to_array(resource_or_resources)
       resource_class = resources.first.class
 
       return if resources.empty?
@@ -43,9 +43,17 @@ module ZendeskAPI
         loaded_associations.each do |association|
           loaded = resource.send(association[:name])
           next unless loaded
-          _side_load(name, association[:class], [loaded].flatten)
+          _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/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.4.0.rc2"
+  VERSION = "0.4.0.rc3"
 end

data/spec/core/association_spec.rb

@@ -73,27 +73,32 @@ describe ZendeskAPI::Association do
       it "should cache a set object" do
         instance.children = [child]
         instance.children.map(&:id).should == [1]
+        instance.children.should be_instance_of(ZendeskAPI::Collection)
       end
 
       it "should set ids" do
         instance.children_ids = []
         instance.children = [child]
         instance.children_ids.should == [child.id]
+        instance.children.should be_instance_of(ZendeskAPI::Collection)
       end
 
       it "should build and cache objects set via hash" do
         instance.children = [{:id => 2}]
         instance.children.map(&:id).should == [2]
+        instance.children.should be_instance_of(ZendeskAPI::Collection)
       end
 
       it "should build a object set via id" do
         instance.children = [2]
         instance.children.map(&:id).should == [2]
+        instance.children.should be_instance_of(ZendeskAPI::Collection)
       end
 
       it "should fetch unknown objects" do
         stub_json_request(:get, %r{test_resources/1/children}, json(:test_children => [{:id => 2}, {:id => 3}]))
         instance.children.map(&:id).should == [2,3]
+        instance.children.should be_instance_of(ZendeskAPI::Collection)
       end
 
       it "is not used when not used" do

data/spec/core/collection_spec.rb

@@ -357,7 +357,7 @@ describe ZendeskAPI::Collection do
     end
 
     context "with a hash" do
-      let(:object) { mock('ZendeskAPI::TestResource', :changes => [:xxx]) }
+      let(:object) { mock('ZendeskAPI::TestResource', :changes => [:xxx], :changed? => true) }
 
       it "should call create with those options" do
         ZendeskAPI::TestResource.should_receive(:new).
@@ -391,8 +391,11 @@ describe ZendeskAPI::Collection do
 
     context "with everything else" do
       it "should pass to new, since this is how attachment handles it" do
-        attachment = mock(:changes => [:xxx])
-        ZendeskAPI::TestResource.should_receive(:new).with(client, "img.jpg").and_return attachment
+        attachment = mock(:changes => [:xxx], :changed? => true)
+        ZendeskAPI::TestResource.should_receive(:new).
+          with(client, :id => "img.jpg", :association => instance_of(ZendeskAPI::Association)).
+          and_return attachment
+
         subject << "img.jpg"
 
         attachment.should_receive :save

data/spec/core/spec_helper.rb

@@ -44,7 +44,7 @@ def client
       config.retry = true
     end
 
-    client.config.logger.level = (ENV["LOG"] ? Logger::INFO : Logger::WARN)
+    client.config.logger.level = (ENV["LOG"] ? Logger::DEBUG : Logger::WARN)
     client.config.cache.size = 0
 
     client

data/spec/live/tag_spec.rb

@@ -0,0 +1,53 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::Tag, :vcr, :not_findable do
+  it_should_be_readable :tags
+
+  [organization, topic, ticket].each do |object|
+    under object do
+      before(:each) do
+        parent.tags = %w{tag2 tag3}
+        parent.tags.save!
+      end
+
+      it "can be set" do
+        tags.should == %w{tag2 tag3}
+      end
+
+      it "should be removable" do
+        parent.tags.destroy!(:id => "tag2")
+
+        tags.should == %w{tag3}
+      end
+
+      it "should be updatable" do
+        parent.tags.update!(:id => "tag4")
+
+        tags.should == %w{tag2 tag3 tag4}
+      end
+
+      it "should be savable" do
+        parent.tags << "tag4"
+        parent.tags.save!
+
+        tags.should == %w{tag2 tag3 tag4}
+      end
+
+      it "should be modifiable" do
+        parent.tags.delete(ZendeskAPI::Tag.new(nil, :id => "tag2"))
+        parent.tags.save!
+
+        tags.should == %w{tag3}
+
+        parent.tags.delete_if {|tag| tag.id == "tag3"}
+        parent.tags.save!
+
+        tags.should be_empty
+      end
+    end
+  end
+
+  def tags
+    parent.tags.fetch!(:reload).map(&:id).sort
+  end
+end

data/spec/macros/resource_macros.rb

@@ -5,6 +5,8 @@ module ResourceMacros
 
   def under(object, &blk)
     context "under a #{object.class.singular_resource_name}" do
+      let(:parent) { object }
+
       define_method(:default_options) do
         { "#{object.class.singular_resource_name}_id" => object.id }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc2
+  version: 0.4.0.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -490,6 +490,7 @@ files:
 - spec/live/satisfaction_rating_spec.rb
 - spec/live/setting_spec.rb
 - spec/live/suspended_ticket_spec.rb
+- spec/live/tag_spec.rb
 - spec/live/ticket_field_spec.rb
 - spec/live/ticket_metrics_spec.rb
 - spec/live/ticket_spec.rb
@@ -585,6 +586,7 @@ test_files:
 - spec/live/satisfaction_rating_spec.rb
 - spec/live/setting_spec.rb
 - spec/live/suspended_ticket_spec.rb
+- spec/live/tag_spec.rb
 - spec/live/ticket_field_spec.rb
 - spec/live/ticket_metrics_spec.rb
 - spec/live/ticket_spec.rb