zendesk_api 0.0.9

data/spec/middleware/request/etag_cache_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Request::EtagCache do
+  it "caches" do
+    client.config.cache.size = 1
+
+    stub_json_request(:get, %r{blergh}, '{"x":1}', :headers => {"Etag" => "x"})
+    response = client.connection.get("blergh")
+    response.status.should == 200
+    response.body.should == {"x"=>1}
+
+    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}
+  end
+end

data/spec/middleware/request/retry_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Request::Retry do
+  def runtime
+    start = Time.now.to_f
+    yield
+    Time.now.to_f - start
+  end
+
+  [429, 503].each do |error_code|
+    it "should wait requisite seconds and then retry request on #{error_code}" do
+      stub_request(:get, %r{blergh}).
+        to_return(:status => 429, :headers => { :retry_after => 1 }).
+        to_return(:status => 200)
+
+      runtime do
+        client.connection.get("blergh").status.should == 200
+      end.should be_within(0.2).of(1)
+    end
+  end
+
+  context "with failing request", :prevent_logger_changes do
+    before do
+      stub_request(:get, %r{blergh}).
+        to_return(:status => 503).
+        to_return(:status => 200)
+
+      ZendeskAPI::Middleware::Request::Retry.any_instance.should_receive(:sleep).exactly(10).times.with(1)
+    end
+
+    it "should wait default timeout seconds and then retry request on error" do
+      runtime do
+        client.connection.get("blergh").status.should == 200
+      end.should <= 0.5
+    end
+
+    it "should print to logger" do
+      client.config.logger.should_receive(:warn).at_least(:once)
+      client.connection.get("blergh")
+    end
+
+    it "should not fail without a logger" do
+      client.config.logger = false
+      client.connection.get("blergh")
+    end
+  end
+end

data/spec/middleware/request/upload_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Request::Upload do
+  subject { ZendeskAPI::Middleware::Request::Upload.new(lambda {|env| env}) }
+  let(:filename) { File.join(File.dirname(__FILE__), "test.jpg") }
+
+  it "should handle no body" do
+    subject.call({}).should == {}
+  end
+
+  it "should handle body with no file" do
+    subject.call(:body => {})[:body].should == {} 
+  end
+
+  it "should handle invalid types" do
+    subject.call(:body => { :file => :invalid })[:body].should == {}
+  end
+
+  context "with file string" do
+    before(:each) do
+      @env = subject.call(:body => { :file => filename })
+    end
+
+    it "should convert file string to UploadIO" do
+      @env[:body][:uploaded_data].should be_instance_of(Faraday::UploadIO)
+    end
+
+    it "should remove file string" do
+      @env[:body][:file].should be_nil
+    end
+
+    it "should add filename if none exist" do
+      @env[:body][:filename].should == "test.jpg"
+    end
+
+    context "with filename" do
+      before(:each) do
+        @env = subject.call(:body => { :file => filename, :filename => "test" })
+      end
+
+      it "should not change filename" do
+        @env[:body][:filename].should_not == "test.jpg"
+      end
+    end
+  end
+
+  context "with file instance" do
+    before(:each) do
+      @env = subject.call(:body => { :file => File.new(filename) })
+    end
+
+    it "should convert file string to UploadIO" do
+      @env[:body][:uploaded_data].should be_instance_of(Faraday::UploadIO)
+    end
+
+    it "should remove file string" do
+      @env[:body][:file].should be_nil
+    end
+
+    it "should add filename if none exist" do
+      @env[:body][:filename].should == "test.jpg"
+    end
+
+    context "with filename" do
+      before(:each) do
+        @env = subject.call(:body => { :file => File.new(filename), :filename => "test" })
+      end
+
+      it "should not change filename" do
+        @env[:body][:filename].should_not == "test.jpg"
+      end
+    end
+  end
+end

data/spec/middleware/response/callback_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Response::Callback do
+  let(:response) { "TEST" }
+
+  before(:each) do
+    client.insert_callback do |env|
+      env[:body] = response
+    end
+
+    stub_request(:get, %r{test_endpoint}).to_return(:body => JSON.dump({ "ABC" => "DEF" }))
+  end
+
+  it "should call callbacks " do
+    client.connection.get("test_endpoint").body.should == response
+  end
+end

data/spec/middleware/response/deflate_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Response::Deflate do
+  context "with content-encoding = 'deflate'" do
+    subject { '{ "TESTDATA": true }' }
+
+    before(:each) do
+      stub_request(:get, %r{blergh}).to_return(:headers => { :content_encoding => "deflate" }, :body => Zlib::Deflate.deflate(subject))
+    end
+
+    it "should inflate returned body" do
+      client.connection.get("blergh").body['TESTDATA'].should be_true
+    end
+  end
+end

data/spec/middleware/response/gzip_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Response::Gzip do
+  context "with content-encoding = 'gzip'" do
+    subject { '{ "TESTDATA": true }' }
+    before(:each) do
+      encoded_data = StringIO.new
+      gz = Zlib::GzipWriter.new(encoded_data)
+      gz.write(subject)
+      gz.close
+
+      stub_request(:get, %r{blergh}).to_return(:headers => { :content_encoding => "gzip" }, :body => encoded_data.string)
+    end
+
+    it "should inflate returned body" do
+      client.connection.get("blergh").body['TESTDATA'].should be_true
+    end
+  end
+end

data/spec/middleware/response/parse_iso_dates_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Middleware::Response::ParseIsoDates do
+  def fake_response(data)
+    stub_json_request(:get, %r{blergh}, data)
+    response = client.connection.get("blergh")
+    response.status.should == 200
+    response
+  end
+
+  let(:parsed){
+    if RUBY_VERSION > "1.9"
+      "2012-02-01 13:14:15 UTC"
+    else
+      "Wed Feb 01 13:14:15 UTC 2012"
+    end
+  }
+
+  it "should parse dates" do
+    fake_response('{"x":"2012-02-01T13:14:15Z"}').body["x"].to_s.should == parsed
+  end
+
+  it "should parse nested dates in hash" do
+    fake_response('{"x":{"y":"2012-02-01T13:14:15Z"}}').body["x"]["y"].to_s.should == parsed
+  end
+
+  it "should parse nested dates in arrays" do
+    fake_response('{"x":[{"y":"2012-02-01T13:14:15Z"}]}').body["x"][0]["y"].to_s.should == parsed
+  end
+
+  it "should not blow up on empty body" do
+    fake_response('').body.should == nil
+  end
+
+  it "should leave arrays with ids alone" do
+    fake_response('{"x":[1,2,3]}').body.should == {"x" => [1,2,3]}
+  end
+
+  it "should not parse date-like things" do
+    fake_response('{"x":"2012-02-01T13:14:15Z bla"}').body["x"].to_s.should == "2012-02-01T13:14:15Z bla"
+    fake_response('{"x":"12012-02-01T13:14:15Z"}').body["x"].to_s.should == "12012-02-01T13:14:15Z"
+    fake_response(%Q{{"x":"2012-02-01T13:14:15Z\\nfoo"}}).body["x"].to_s.should == "2012-02-01T13:14:15Z\nfoo"
+  end
+end

data/spec/playlist_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Playlist do
+  subject { ZendeskAPI::Playlist }
+
+  before(:each) do
+    stub_request(:get, %r{views/\d+/play}).to_return(:status => 302, :body => "You are being redirected...")
+  end
+
+  it "should begin playing the playlist on initialization" do
+    subject.new(client, 1)
+  end
+
+  context "#next" do
+    subject { ZendeskAPI::Playlist.new(client, 1) }
+
+    before(:each) do
+      stub_json_request(:get, %r{play/next}, json("ticket" => {}))
+    end
+
+    it "should return ticket" do
+      subject.next.should be_instance_of(ZendeskAPI::Ticket)
+    end
+
+    context "with client error", :silence_logger do
+      before(:each) do
+        stub_request(:get, %r{play/next}).to_return(:status => 500)
+      end
+
+      it "should be properly handled" do
+        expect { subject.next.should be_nil }.to_not raise_error
+      end
+    end
+
+    context "with end of playlist" do
+      before(:each) do
+        stub_request(:get, %r{play/next}).to_return(:status => 204)
+      end
+
+      it "should be properly handled" do
+        subject.next.should be_nil
+        subject.destroyed?.should be_true
+      end
+    end
+  end
+
+  context "#destroy" do
+    subject { ZendeskAPI::Playlist.new(client, 1) }
+
+    before(:each) do
+      stub_request(:delete, %r{play}).to_return(:status => 204)
+    end
+
+    it "should be destroyed" do
+      subject.destroy.should be_true
+      subject.destroyed?.should be_true
+    end
+
+    context "with client error", :silence_logger do
+      before(:each) do
+        stub_request(:delete, %r{play}).to_return(:status => 500)
+      end
+
+      it "should be properly handled" do
+        expect { subject.destroy.should be_false }.to_not raise_error
+      end
+    end
+  end
+
+  context "initialization" do
+    context "with client error", :silence_logger do
+      before(:each) do
+        stub_request(:get, %r{views/\d+/play}).to_return(:status => 500).to_return(:status => 302)
+        stub_request(:get, %r{play/next}).to_return(:body => json)
+      end
+
+      it "should be able to be created" do
+        new_playlist = subject.new(client, 1)
+        new_playlist.should_not be_nil
+      end
+
+      it "should retry initialization on #next" do
+        new_playlist = subject.new(client, 1)
+        new_playlist.should_receive(:init_playlist).and_return(:true)
+        new_playlist.next
+      end
+
+      it "should retry initialization on #each" do
+        new_playlist = subject.new(client, 1)
+        new_playlist.should_receive(:next).and_return(Object.new, nil)
+        new_playlist.each {|arg| :block }
+      end
+    end
+  end
+end

data/spec/read_resource_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe ZendeskAPI::ReadResource do
+  context "find" do
+    let(:id) { 1 }
+    subject { ZendeskAPI::TestResource }
+
+    before(:each) do
+      stub_json_request(:get, %r{test_resources/#{id}}, json("test_resource" => {}))
+    end
+
+    it "should return instance of resource" do
+      subject.find(client, :id => id).should be_instance_of(subject)
+    end
+
+    it "should blow up without an id which would build an invalid url" do
+      expect{
+        ZendeskAPI::User.find(client, :foo => :bar)
+      }.to raise_error("No :id given")
+    end
+
+    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
+  end
+end
+

data/spec/rescue_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Rescue do
+  include ZendeskAPI::Rescue
+
+  class Boom
+    include ZendeskAPI::Rescue
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def puff(error)
+      raise error, "Puff"
+    end
+
+    def boom(error)
+      raise error, "Boom"
+    end
+
+    rescue_client_error :puff
+  end
+
+  it "rescues from client errors", :silence_logger do
+    Boom.new(client).puff(Faraday::Error::ClientError)
+  end
+
+  it "does not protect other actions" do
+    expect{
+      Boom.new(client).boom(RuntimeError)
+    }.to raise_error RuntimeError
+  end
+
+  it "raises everything else" do
+    expect{
+      Boom.new(client).puff(RuntimeError)
+    }.to raise_error RuntimeError
+  end
+
+  it "logs to logger" do
+    out = StringIO.new
+    client = ZendeskAPI::Client.new do |config|
+      config.logger = Logger.new(out)
+      config.url = "https://idontcare.com"
+    end
+    out.should_receive(:write).at_least(:twice)
+    Boom.new(client).puff(Faraday::Error::ClientError)
+  end
+
+  it "does crash without logger" do
+    client = ZendeskAPI::Client.new do |config|
+      config.logger = false
+      config.url = "https://idontcare.com"
+    end
+    Boom.new(client).puff(Faraday::Error::ClientError)
+  end
+
+  context "passing a block" do
+    it "rescues from client errors", :silence_logger do
+      rescue_client_error do
+        raise Faraday::Error::ClientError, "error"
+      end
+    end
+
+    it "raises everything else" do
+      expect{
+        rescue_client_error { raise RuntimeError, "error" }
+      }.to raise_error RuntimeError
+    end
+
+    it "logs to logger" do
+      out = StringIO.new
+      @client = ZendeskAPI::Client.new do |config|
+        config.logger = Logger.new(out)
+        config.url = "https://idontcare.com"
+      end
+      out.should_receive(:write).at_least(:twice)
+      rescue_client_error do
+        raise Faraday::Error::ClientError, "error"
+      end
+    end
+
+    it "does crash without logger" do
+      @client = ZendeskAPI::Client.new do |config|
+        config.logger = false
+        config.url = "https://idontcare.com"
+      end
+      rescue_client_error do
+        raise Faraday::Error::ClientError, "error"
+      end
+    end
+  end
+end