zendesk_api 0.3.14 → 0.4.0.rc1

data/lib/zendesk_api/server/public/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.4.1
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
@@ -73,10 +73,6 @@
   
   
     
-      <dt class="r1">Extended by:</dt>
-      <dd class="r1"><span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">ZendeskAPI::Console</a></span>, <span class='object_link'><a href="ZendeskAPI/Console/Eval.html" title="ZendeskAPI::Console::Eval (module)">ZendeskAPI::Console::Eval</a></span></dd>
-      
-    
   
     
   
@@ -98,46 +94,18 @@
 
 
 
-  <h2>Constant Summary</h2>
-  
-  <h3 class="inherited">Constants included
-     from <span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">ZendeskAPI::Console</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="ZendeskAPI/Console.html#ZD_DIRUP-constant" title="ZendeskAPI::Console::ZD_DIRUP (constant)">ZendeskAPI::Console::ZD_DIRUP</a></span></p>
-
-
-
 
 
 
-  
-  
-  
-  
-  
-  
-  <h2>Method Summary</h2>
-  
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="ZendeskAPI/Console/Eval.html" title="ZendeskAPI::Console::Eval (module)">ZendeskAPI::Console::Eval</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="ZendeskAPI/Console/Eval.html#loop_eval-instance_method" title="ZendeskAPI::Console::Eval#loop_eval (method)">loop_eval</a></span></p>
 
-  
-  
-  
-  
-  
-  
-  
-  
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">ZendeskAPI::Console</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="ZendeskAPI/Console.html#basic_auth-instance_method" title="ZendeskAPI::Console#basic_auth (method)">basic_auth</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#cd-instance_method" title="ZendeskAPI::Console#cd (method)">cd</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#client-instance_method" title="ZendeskAPI::Console#client (method)">client</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#config-instance_method" title="ZendeskAPI::Console#config (method)">config</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#cwd-instance_method" title="ZendeskAPI::Console#cwd (method)">cwd</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#help-instance_method" title="ZendeskAPI::Console#help (method)">help</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#ls-instance_method" title="ZendeskAPI::Console#ls (method)">ls</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#method_missing-instance_method" title="ZendeskAPI::Console#method_missing (method)">method_missing</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#password-instance_method" title="ZendeskAPI::Console#password (method)">password</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#url-instance_method" title="ZendeskAPI::Console#url (method)">url</a></span>, <span class='object_link'><a href="ZendeskAPI/Console.html#username-instance_method" title="ZendeskAPI::Console#username (method)">username</a></span></p>
 
 
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 11 17:45:36 2013 by
+  Generated on Wed May 15 18:59:28 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.4.1 (ruby-1.9.3).
+  0.8.5.2 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/zendesk_api/verbs.rb

@@ -1,8 +1,6 @@
 module ZendeskAPI
   # Creates put, post, delete class methods for custom resource methods.
   module Verbs
-    include Rescue
-
     class << self
       private
 
@@ -30,8 +28,6 @@ module ZendeskAPI
 
             true
           end
-
-          rescue_client_error method, :with => false
         end
       end
     end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.3.14"
+  VERSION = "0.4.0.rc1"
 end

data/spec/core/client_spec.rb

@@ -39,15 +39,55 @@ describe ZendeskAPI::Client do
       end
     end
 
+    context "basic_auth" do
+      subject do
+        ZendeskAPI::Client.new do |config|
+          config.url = "https://example.zendesk.com"
+          config.username = "hello"
+          config.password = "token"
+        end
+      end
+
+      it "should build basic auth middleware" do
+        subject.connection.builder.handlers.index(Faraday::Request::BasicAuthentication).should_not be_nil
+      end
+
+      it "should not build token middleware" do
+        subject.connection.headers["Authorization"].should be_nil
+      end
+    end
+
+    context "access token" do
+      subject do
+        ZendeskAPI::Client.new do |config|
+          config.url = "https://example.zendesk.com"
+          config.access_token = "hello"
+        end
+      end
+
+      it "should not build basic auth middleware" do
+        subject.connection.builder.handlers.index(Faraday::Request::BasicAuthentication).should be_nil
+      end
+
+      it "should build token middleware" do
+        subject.connection.headers["Authorization"].should match(/Bearer/)
+      end
+    end
+
     context "#token" do
-      context "with a username with /token" do
-        subject do
-          ZendeskAPI::Client.new do |config|
-            config.url = "https://example.zendesk.com"
-            config.username = "hello/token"
-            config.token = "token"
-          end.config
+      let(:client) do
+        ZendeskAPI::Client.new do |config|
+          config.url = "https://example.zendesk.com"
+          config.username = username
+          config.token = "token"
         end
+      end
+
+      subject { client.config }
+      let(:username) { "hello" }
+
+      context "with a username with /token" do
+        let(:username) { "hello/token" }
 
         it "should not add /token to the username" do
           subject.username.should == "hello/token"
@@ -55,12 +95,12 @@ describe ZendeskAPI::Client do
       end
 
       context "with no password" do
-        subject do
-          ZendeskAPI::Client.new do |config|
-            config.url = "https://example.zendesk.com"
-            config.username = "hello"
-            config.token = "token"
-          end.config
+        it "should build basic auth middleware" do
+          client.connection.builder.handlers.index(Faraday::Request::BasicAuthentication).should_not be_nil
+        end
+
+        it "should not build token middleware" do
+          client.connection.builder.handlers.index(Faraday::Request::TokenAuthentication).should be_nil
         end
 
         it "should copy token to password" do

data/spec/core/collection_spec.rb

@@ -44,6 +44,20 @@ describe ZendeskAPI::Collection do
       subject.update(:id => 1)
     end
 
+    context "when class doesn't have method" do
+      subject do
+        ZendeskAPI::Collection.new(client, ZendeskAPI::NilDataResource)
+      end
+
+      it "should raise NoMethodError" do
+        expect { subject.create }.to raise_error(NoMethodError)
+      end
+
+      it "should raise NoMethodError" do
+        expect { subject.create! }.to raise_error(NoMethodError)
+      end
+    end
+
     context "with a class with a parent" do
       let(:association) do
         ZendeskAPI::Association.new(:class => ZendeskAPI::TestResource::TestChild,
@@ -165,7 +179,7 @@ describe ZendeskAPI::Collection do
     end
   end
 
-  context "each_page" do
+  context "all" do
     context "Faraday errors" do
       before(:each) do
         stub_json_request(:get, %r{test_resources$}, json(
@@ -190,7 +204,7 @@ describe ZendeskAPI::Collection do
           end
 
           begin
-            silence_logger { subject.each_page(&b) }
+            silence_logger { subject.all(&b) }
           rescue SearchError
             retry
           end
@@ -199,6 +213,20 @@ describe ZendeskAPI::Collection do
           [ZendeskAPI::TestResource.new(client, :id => 2), 2]
         )
       end
+
+      it "should retry from the same page!" do
+        expect do |b|
+          begin
+            subject.all!(&b)
+          rescue ZendeskAPI::Error::NetworkError
+            retry
+          rescue ZendeskAPI::Error::ClientError
+          end
+        end.to yield_successive_args(
+          [ZendeskAPI::TestResource.new(client, :id => 1), 1],
+          [ZendeskAPI::TestResource.new(client, :id => 2), 2]
+        )
+      end
     end
 
     context "successful requests" do
@@ -231,7 +259,7 @@ describe ZendeskAPI::Collection do
             end
           end
 
-          silence_logger { subject.each_page(&block) }
+          silence_logger { subject.all(&block) }
         end.to yield_successive_args(
           ZendeskAPI::TestResource.new(client, :id => 1),
           ZendeskAPI::TestResource.new(client, :id => 2)
@@ -240,7 +268,7 @@ describe ZendeskAPI::Collection do
 
       it "should yield resource and page" do
         expect do |b|
-          silence_logger { subject.each_page(&b) }
+          silence_logger { subject.all(&b) }
         end.to yield_successive_args(
           [ZendeskAPI::TestResource.new(client, :id => 1), 1],
           [ZendeskAPI::TestResource.new(client, :id => 2), 2]

data/spec/core/create_resource_spec.rb

@@ -28,7 +28,7 @@ describe ZendeskAPI::CreateResource do
     subject { ZendeskAPI::TestResource }
 
     before(:each) do
-      subject.should_receive(:create).and_return(nil)
+      stub_request(:post, %r{test_resources}).to_return(:status => 500)
     end
 
     it "should raise if save fails" do

data/spec/core/data_resource_spec.rb

@@ -20,7 +20,7 @@ describe ZendeskAPI::DataResource do
       ZendeskAPI::TestResource.has :nil, options.merge(:class => ZendeskAPI::NilDataResource)
     end
 
-    it "should try and find non-existant object" do
+    it "should try and find non-existent object" do
       stub_json_request(:get, %r{test_resources/1/nil}, json(:nil_data_resource => {}))
 
       subject.nil.should be_instance_of(ZendeskAPI::NilDataResource)
@@ -29,7 +29,7 @@ describe ZendeskAPI::DataResource do
     context "inline => true" do
       let(:options) {{ :inline => true }}
 
-      it "should not try and find non-existant object" do
+      it "should not try and find non-existent object" do
         subject.nil
       end
     end

data/spec/core/middleware/request/etag_cache_spec.rb

@@ -5,17 +5,16 @@ describe ZendeskAPI::Middleware::Request::EtagCache do
     client.config.cache.size = 1
 
     stub_json_request(:get, %r{blergh}, '{"x":1}', :headers => {"Etag" => "x"})
-    first_response = client.connection.get("blergh")
-    first_response.status.should == 200
-    first_response.body.should == {"x"=>1}
+    response = client.connection.get("blergh")
+    response.status.should == 200
+    response.body.should == {"x"=>1}
+
+    headers = response.headers
 
     stub_request(:get, %r{blergh}).to_return(:status => 304, :headers => {"Etag" => "x"})
     response = client.connection.get("blergh")
     response.status.should == 304
     response.body.should == {"x"=>1}
-
-    %w{content_encoding content_type content_length etag}.each do |header|
-      response.headers[header].should == first_response.headers[header]
-    end
+    response.headers.should == headers
   end
 end

data/spec/core/middleware/request/upload_spec.rb

@@ -10,7 +10,7 @@ describe ZendeskAPI::Middleware::Request::Upload do
   end
 
   it "should handle body with no file" do
-    subject.call(:body => {})[:body].should == {}
+    subject.call(:body => {})[:body].should == {} 
   end
 
   it "should handle invalid types" do
@@ -58,7 +58,7 @@ describe ZendeskAPI::Middleware::Request::Upload do
 
     context "with an ActionDispatch::Http::UploadedFile" do
       before(:each) do
-        @upload = ActionDispatch::Http::UploadedFile.new(:filename => "hello.jpg", :tempfile => Tempfile.new(File.basename(filename)))
+        @upload = ActionDispatch::Http::UploadedFile.new(:filename => "hello", :tempfile => Tempfile.new(File.basename(filename)))
         @env = subject.call(:body => { :file => @upload })
       end
 
@@ -73,14 +73,6 @@ describe ZendeskAPI::Middleware::Request::Upload do
       it "should add filename if none exist" do
         @env[:body][:filename].should == "hello"
       end
-
-      context "when path does not resolve a mime_type" do
-        it "should use the content_type of ActionDispatch::Http::UploadedFile " do
-          @upload.tempfile.path = "XXX"
-          @env = subject.call(:body => { :file => @upload })
-          @env[:body][:uploaded_data][:content_type].should == "image/jpeg"
-        end
-      end
     end
   end
 

data/spec/core/middleware/response/callback_spec.rb

@@ -8,7 +8,7 @@ describe ZendeskAPI::Middleware::Response::Callback do
       env[:body] = response
     end
 
-    stub_request(:get, %r{test_endpoint}).to_return(:body => JSON.dump({ "ABC" => "DEF" }))
+    stub_request(:get, %r{test_endpoint}).to_return(:body => MultiJson.dump({ "ABC" => "DEF" }))
   end
 
   it "should call callbacks " do

data/spec/core/middleware/response/raise_error_spec.rb

@@ -0,0 +1,40 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::Middleware::Response::RaiseError do
+  before(:each) do
+    stub_request(:any, /.*/).to_return(:status => status)
+  end
+
+  context "with status = 404" do
+    let(:status) { 404 }
+
+    it "should raise RecordNotFound when status is 404" do
+      expect { client.connection.get "/non_existent" }.to raise_error(ZendeskAPI::Error::RecordNotFound)
+    end
+  end
+
+  context "with status in 400...600" do
+    let(:status) { 500 }
+
+    it "should raise NetworkError" do
+      expect { client.connection.get "/non_existent" }.to raise_error(ZendeskAPI::Error::NetworkError)
+    end
+  end
+
+  context "with status = 422" do
+    let(:status) { 422 }
+
+    it "should raise RecordInvalid" do
+      expect { client.connection.get "/non_existent" }.to raise_error(ZendeskAPI::Error::RecordInvalid)
+    end
+  end
+
+  context "with status = 200" do
+    let(:status) { 200 }
+
+    it "should not raise" do
+      client.connection.get "/abcdef"
+    end
+  end
+end
+

data/spec/core/read_resource_spec.rb

@@ -40,13 +40,11 @@ describe ZendeskAPI::ReadResource do
     context "with client error" do
       it "should handle 500 properly" do
         stub_request(:get, %r{test_resources/#{id}}).to_return(:status => 500)
-        client.config.logger.should_receive(:warn).at_least(:once)
         subject.find(client, :id => id).should == nil
       end
 
       it "should handle 404 properly" do
         stub_request(:get, %r{test_resources/#{id}}).to_return(:status => 404)
-        client.config.logger.should_receive(:warn).at_least(:once)
         subject.find(client, :id => id).should == nil
       end
     end

data/spec/core/resource_spec.rb

@@ -99,7 +99,7 @@ describe ZendeskAPI::Resource do
     subject { ZendeskAPI::TestResource.new(client, :id => 1) }
 
     before(:each) do
-      subject.should_receive(:save).and_return(false)
+      stub_request(:put, %r{test_resources/1}).to_return(:status => 422)
     end
 
     it "should raise if save fails" do
@@ -341,8 +341,8 @@ describe ZendeskAPI::Resource do
             stub_request(verb.to_sym, %r{test_resources/1/#{method}}).to_return(:status => 500)
           end
 
-          it "should return false" do
-            expect { silence_logger{ subject.send(method).should be_false } }.to_not raise_error
+          it "should raise" do
+            expect { silence_logger{ subject.send(method) } }.to raise_error(ZendeskAPI::Error::ClientError)
           end
         end
       end
@@ -382,8 +382,16 @@ describe ZendeskAPI::Resource do
       ZendeskAPI::TestResource.new(client, :id => 2).should_not == ZendeskAPI::TestResource.new(client, :id => 1)
     end
 
-    it "is different when class is different" do
-      ZendeskAPI::TestResource.new(client, :id => 2).should_not == ZendeskAPI::TestResource::TestChild.new(client, :id => 2)
+    it "is same when class is Data" do
+      ZendeskAPI::TestResource.new(client, :id => 2).should == ZendeskAPI::TestResource::TestChild.new(client, :id => 2)
+    end
+
+    it "is same when class is Integer" do
+      ZendeskAPI::TestResource.new(client, :id => 2).should == 2
+    end
+
+    it "is different when class is Integer" do
+      ZendeskAPI::TestResource.new(client, :id => 2).should_not == 3
     end
 
     it "is different when other is no resource" do

data/spec/core/search_spec.rb

@@ -8,7 +8,7 @@ describe ZendeskAPI::Search do
       end
     end
 
-    context "when given a nonexistant class" do
+    context "when given a nonexistent class" do
       it "should return an object of the type Search::Result" do
         ZendeskAPI::Search.new(nil, { "result_type" => "blah" }).should be_instance_of(ZendeskAPI::Search::Result)
       end