zendesk_api 1.1.2 → 1.1.3

data/Gemfile.lock

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

data/lib/zendesk_api/resources.rb

@@ -273,6 +273,8 @@ module ZendeskAPI
     extend Read
   end
 
+  class TicketRelated < DataResource; end
+
   class Ticket < Resource
     class Audit < DataResource
       class Event < Data
@@ -299,6 +301,8 @@ module ZendeskAPI
       alias :save! :save
     end
 
+    put :mark_as_spam
+
     has :requester, :class => User, :inline => :create
     has :submitter, :class => User
     has :assignee, :class => User
@@ -308,6 +312,7 @@ module ZendeskAPI
     has Group
     has :forum_topic, :class => Topic
     has Organization
+    has :related, :class => TicketRelated
 
     has :comment, :class => Comment, :inline => true
     has :last_comment, :class => Comment, :inline => true
@@ -449,6 +454,28 @@ module ZendeskAPI
       self.role_id = role.name if key?(:role)
     end
 
+    any :password
+
+    # Set a user's password
+    def set_password(opts = {})
+      password(opts.merge(:verb => :post))
+    end
+
+    # Change a user's password
+    def change_password(opts = {})
+      password(opts.merge(:verb => :put))
+    end
+
+    # Set a user's password
+    def set_password!(opts = {})
+      password!(opts.merge(:verb => :post))
+    end
+
+    # Change a user's password
+    def change_password!(opts = {})
+      password!(opts.merge(:verb => :put))
+    end
+
     has Organization
 
     has CustomRole, :inline => true, :include => :roles

data/lib/zendesk_api/verbs.rb

@@ -10,24 +10,46 @@ module ZendeskAPI
       #   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(verb)
-        define_method verb do |method|
-          define_method method do |*method_args|
+      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 : {}
-            return instance_variable_get("@_#{verb}_#{method}") if instance_variable_defined?("@_#{verb}_#{method}") && !opts[:reload]
 
-            response = @client.connection.send(verb, "#{path}/#{method}") do |req|
-              req.body = opts
+            if method_verb == :any
+              verb = opts.delete(:verb)
+              raise(ArgumentError, ":verb required for method defined as :any") unless verb
+            else
+              verb = method_verb
             end
 
-            if (resources = response.body[self.class.resource_name]) &&
-              (res = resources.find {|res| res["id"] == id})
-              @attributes = ZendeskAPI::Trackie.new(res)
-              @attributes.clear_changes
+            @response = @client.connection.send(verb, "#{path}/#{method}") do |req|
+              req.body = opts
             end
 
+            return false unless @response.success?
+            return false unless @response.body
+
+            resource = @response.body[self.class.singular_resource_name] ||
+              @response.body.fetch(self.class.resource_name, []).detect {|res| res["id"] == id} ||
+              {}
+
+            @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
@@ -35,5 +57,6 @@ module ZendeskAPI
     create_verb :put
     create_verb :post
     create_verb :delete
+    create_verb :any
   end
 end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/core/resource_spec.rb

@@ -305,6 +305,74 @@ describe ZendeskAPI::Resource do
     end
   end
 
+  context "on any" do
+    let(:method) { "test_any_method" }
+
+    before(:each) do
+      ZendeskAPI::TestResource.any method
+    end
+
+    context "class method" do
+      subject { ZendeskAPI::TestResource }
+
+      it "should create a method of the same name" do
+        subject.instance_methods.map(&:to_s).should include(method)
+      end
+    end
+
+    context "instance method" do
+      subject { ZendeskAPI::TestResource.new(client, :id => 1) }
+
+      it "throws an argumenterror without a :verb" do
+        expect { subject.send(method) }.to raise_error(ArgumentError)
+      end
+
+      context "with an array response" do
+        before(:each) do
+          stub_json_request(:put, %r{test_resources/1/#{method}}, json(:test_resources => [{ :id => 1, :method => method }]))
+        end
+
+        it "should return true" do
+          subject.send(method, :verb => :put).should be_true
+        end
+
+        it "should update the attributes if they exist" do
+          subject.send(method, :verb => :put)
+          subject[:method].should == method
+        end
+      end
+
+      context "with a resource response" do
+        before(:each) do
+          stub_json_request(:put, %r{test_resources/1/#{method}}, json(:test_resource => { :id => 1, :method => method }))
+        end
+
+        it "should return true" do
+          subject.send(method, :verb => :put).should be_true
+        end
+
+        it "should update the attributes if they exist" do
+          subject.send(method, :verb => :put)
+          subject[:method].should == method
+        end
+      end
+
+      context "with client error" do
+        before(:each) do
+          stub_request(:put, %r{test_resources/1/#{method}}).to_return(:status => 500)
+        end
+
+        it "doesn't raise without bang" do
+          silence_logger { subject.send("#{method}", :verb => :put).should be_false }
+        end
+
+        it "raises with bang" do
+          expect { silence_logger{ subject.send("#{method}!", :verb => :put) } }.to raise_error(ZendeskAPI::Error::ClientError)
+        end
+      end
+    end
+  end
+
   %w{put post delete}.each do |verb|
     context "on #{verb}" do
       let(:method) { "test_#{verb}_method" }
@@ -323,17 +391,34 @@ describe ZendeskAPI::Resource do
       context "instance method" do
         subject { ZendeskAPI::TestResource.new(client, :id => 1) }
 
-        before(:each) do
-          stub_json_request(verb.to_sym, %r{test_resources/1/#{method}}, json(:test_resources => [{ :id => 1, :method => method }]))
-        end
+        context "with an array response" do
+          before(:each) do
+            stub_json_request(verb.to_sym, %r{test_resources/1/#{method}}, json(:test_resources => [{ :id => 1, :method => method }]))
+          end
 
-        it "should return true" do
-          subject.send(method).should be_true
+          it "should return true" do
+            subject.send(method).should be_true
+          end
+
+          it "should update the attributes if they exist" do
+            subject.send(method)
+            subject[:method].should == method
+          end
         end
 
-        it "should update the attributes if they exist" do
-          subject.send(method)
-          subject[:method].should == method
+        context "with a resource response" do
+          before(:each) do
+            stub_json_request(verb.to_sym, %r{test_resources/1/#{method}}, json(:test_resource => { :id => 1, :method => method }))
+          end
+
+          it "should return true" do
+            subject.send(method).should be_true
+          end
+
+          it "should update the attributes if they exist" do
+            subject.send(method)
+            subject[:method].should == method
+          end
         end
 
         context "with client error" do
@@ -341,8 +426,12 @@ describe ZendeskAPI::Resource do
             stub_request(verb.to_sym, %r{test_resources/1/#{method}}).to_return(:status => 500)
           end
 
-          it "should raise" do
-            expect { silence_logger{ subject.send(method) } }.to raise_error(ZendeskAPI::Error::ClientError)
+          it "doesn't raise without bang" do
+            silence_logger { subject.send("#{method}").should be_false }
+          end
+
+          it "raises with bang" do
+            expect { silence_logger{ subject.send("#{method}!") } }.to raise_error(ZendeskAPI::Error::ClientError)
           end
         end
       end

data/spec/live/user_spec.rb

@@ -17,6 +17,16 @@ describe ZendeskAPI::User, :delete_after do
     end
   end
 
+  context "passwords", :vcr do
+    it "sets the password" do
+      agent.set_password!(:password => client.config.password)
+    end
+
+    it "changes the password" do
+      current_user.change_password!(:previous_password => client.config.password, :password => client.config.password)
+    end
+  end
+
   context "side-loading" do
     context "no permission set" do
       subject do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump