desk 0.3.0

data/spec/desk/client/topic_spec.rb

@@ -0,0 +1,135 @@
+require 'helper'
+
+describe Desk::Client do
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".topics" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics.#{format}").
+              to_return(:body => fixture("topics.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.topics
+            a_get("topics.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 topics worth of extended information" do
+            topics = @client.topics
+
+            topics.results.should be_a Array
+            topics.results.first.topic.id.should == 1
+          end
+
+        end
+      end
+
+      describe ".topic" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics/1.#{format}").
+              to_return(:body => fixture("topic.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.topic(1)
+            a_get("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            topic = @client.topic(1)
+
+            topic.id.should == 1
+            topic.name.should == "General"
+          end
+
+        end
+      end
+
+      describe ".create_topic" do
+
+        context "create" do
+
+          before do
+            stub_post("topics.#{format}").
+              to_return(:body => fixture("topic_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_topic("General", :description => "Everything belongs here")
+            a_post("topics.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.create_topic("General", :description => "Everything belongs here")
+
+            topic.id.should == 9
+            topic.name.should == "General"
+            topic.description.should == "Everything belongs here"
+          end
+
+        end
+      end
+
+      describe ".update_topic" do
+
+        context "update" do
+
+          before do
+            stub_put("topics/1.#{format}").
+              to_return(:body => fixture("topic_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_topic(1, :name => "Updated", :description => "Updated Description")
+            a_put("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.update_topic(1, :name => "Updated", :description => "Updated Description")
+
+            topic.name.should == "Updated"
+            topic.description.should == "Updated Description"
+          end
+
+        end
+      end
+
+      describe ".delete_topic" do
+
+        context "delete" do
+
+          before do
+            stub_delete("topics/1.#{format}").
+              to_return(:body => fixture("topic_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_topic(1)
+            a_delete("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            topic = @client.delete_topic(1)
+            topic.success.should == true
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/desk/client/user_spec.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe Desk::Client do
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".user" do
+
+        context "with id passed" do
+
+            before do
+              stub_get("users/1.#{format}").
+                to_return(:body => fixture("user.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+            end
+
+            it "should get the correct resource" do
+              @client.user(1)
+              a_get("users/1.#{format}").
+                should have_been_made
+            end
+
+            it "should return extended information of a given user" do
+              user = @client.user(1)
+              user.name.should == "Chris Warren"
+            end
+
+        end
+      end
+
+      describe ".users" do
+
+        context "lookup" do
+
+          before do
+            stub_get("users.#{format}").
+              to_return(:body => fixture("users.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.users
+            a_get("users.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 users worth of extended information" do
+            users = @client.users
+            users.results.should be_a Array
+            users.results.first.user.name.should == "Test User"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/desk/client_spec.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+describe Desk::Client do
+  it "should connect using the endpoint configuration" do
+    client = Desk::Client.new
+    endpoint = URI.parse(client.api_endpoint)
+    connection = client.send(:connection).build_url("./").to_s.strip
+    connection.should == endpoint.to_s
+  end
+end

data/spec/desk_spec.rb

@@ -0,0 +1,127 @@
+require 'helper'
+
+describe Desk do
+  after do
+    Desk.reset
+  end
+
+  # context "when delegating to a client" do
+  #
+  #   before do
+  #     stub_get("statuses/user_timeline.json").
+  #       with(:query => {:screen_name => "sferik"}).
+  #       to_return(:body => fixture("statuses.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+  #   end
+  #
+  #   it "should get the correct resource" do
+  #     Twitter.user_timeline('sferik')
+  #     a_get("statuses/user_timeline.json").
+  #       with(:query => {:screen_name => "sferik"}).
+  #       should have_been_made
+  #   end
+  #
+  #   it "should return the same results as a client" do
+  #     Desk.user_timeline('sferik').should == Twitter::Client.new.user_timeline('sferik')
+  #   end
+  #
+  # end
+
+  describe ".client" do
+    it "should be an Desk::Client" do
+      Desk.client.should be_a Desk::Client
+    end
+  end
+
+  describe ".adapter" do
+    it "should return the default adapter" do
+      Desk.adapter.should == Desk::Configuration::DEFAULT_ADAPTER
+    end
+  end
+
+  describe ".adapter=" do
+    it "should set the adapter" do
+      Desk.adapter = :typhoeus
+      Desk.adapter.should == :typhoeus
+    end
+  end
+
+  describe ".subdomain=" do
+    before do
+      Desk.subdomain = "zencoder"
+    end
+
+    it "should set the subdomain" do
+      Desk.subdomain.should == "zencoder"
+    end
+
+    it "should change the endpoint" do
+      Desk.endpoint.should == "https://zencoder.desk.com/api/#{Desk::Configuration::DEFAULT_VERSION}/"
+    end
+  end
+
+  describe ".support_email" do
+    it "should return the default support_email" do
+      Desk.support_email.should == Desk::Configuration::DEFAULT_SUPPORT_EMAIL
+    end
+  end
+
+  describe ".support_email=" do
+    it "should set the support_email" do
+      Desk.support_email = "help@example.com"
+      Desk.support_email.should == "help@example.com"
+    end
+  end
+
+  describe ".version=" do
+    before do
+      Desk.version = "v4"
+    end
+
+    it "should set the subdomain" do
+      Desk.version.should == "v4"
+    end
+
+    it "should change the endpoint" do
+      Desk.endpoint.should == "https://#{Desk::Configuration::DEFAULT_SUBDOMAIN}.desk.com/api/v4/"
+    end
+  end
+
+  describe ".format" do
+    it "should return the default format" do
+      Desk.format.should == Desk::Configuration::DEFAULT_FORMAT
+    end
+  end
+
+  describe ".format=" do
+    it "should set the format" do
+      Desk.format = 'xml'
+      Desk.format.should == 'xml'
+    end
+  end
+
+  describe ".user_agent" do
+    it "should return the default user agent" do
+      Desk.user_agent.should == Desk::Configuration::DEFAULT_USER_AGENT
+    end
+  end
+
+  describe ".user_agent=" do
+    it "should set the user_agent" do
+      Desk.user_agent = 'Custom User Agent'
+      Desk.user_agent.should == 'Custom User Agent'
+    end
+  end
+
+  describe ".configure" do
+
+    Desk::Configuration::VALID_OPTIONS_KEYS.each do |key|
+
+      it "should set the #{key}" do
+        Desk.configure do |config|
+          config.send("#{key}=", key)
+          Desk.send(key).should == key
+        end
+      end
+    end
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+describe Faraday::Response do
+  before do
+    @client = Desk::Client.new
+  end
+
+  {
+    400 => Desk::BadRequest,
+    401 => Desk::Unauthorized,
+    403 => Desk::Forbidden,
+    404 => Desk::NotFound,
+    406 => Desk::NotAcceptable,
+    420 => Desk::EnhanceYourCalm,
+    500 => Desk::InternalServerError,
+    502 => Desk::BadGateway,
+    503 => Desk::ServiceUnavailable,
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+
+      before do
+        stub_get('users/1.json').
+          with(:headers => {'Accept'=>'application/json', 'User-Agent'=>Desk::Configuration::DEFAULT_USER_AGENT}).
+          to_return(:status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        lambda do
+          @client.user(1)
+        end.should raise_error(exception)
+      end
+    end
+  end
+end

data/spec/fixtures/article.json

@@ -0,0 +1,50 @@
+{
+        "article":
+        {
+                "id":13,
+                "subject":"API Tips",
+                "show_in_portal":true,
+                "main_content":"Tips on using our API",
+                "agent_content":null,
+                "email":"Tips on using our API",
+                "chat":"Tips on using our API",
+                "twitter":"Tips on using our API",
+                "question_answer":"Tips on using our API",
+                "phone":"Tips on using our API",
+                "quickcode":null,
+                "created_by":
+                {
+                        "user":
+                        {
+                                "id":1,
+                                "name":"API User",
+                                "name_public":"API User",
+                                "email":"apiuser@yoursite.com",
+                                "created_at":"2011-01-13T22:41:42Z",
+                                "updated_at":"2011-01-19T22:04:33Z",
+                                "user_level":"admin",
+                                "login_count":9,
+                                "time_zone":"Pacific Time (US & Canada)",
+                                "last_login_at":"2011-01-19T18:21:52Z",
+                                "current_login_at":"2011-01-19T22:04:33Z"
+                        }
+                },
+                "updated_by":
+                {
+                        "user":
+                        {
+                                "id":1,
+                                "name":"API User",
+                                "name_public":"API User",
+                                "email":"apiuser@yoursite.com",
+                                "created_at":"2011-01-13T22:41:42Z",
+                                "updated_at":"2011-01-19T22:04:33Z",
+                                "user_level":"admin",
+                                "login_count":9,
+                                "time_zone":"Pacific Time (US & Canada)",
+                                "last_login_at":"2011-01-19T18:21:52Z",
+                                "current_login_at":"2011-01-19T22:04:33Z"
+                        }
+                }
+        }
+}

data/spec/fixtures/article_create.json

@@ -0,0 +1,54 @@
+{
+        "success":true,
+        "results":
+        {
+                "article":
+                {
+                        "id":13,
+                        "subject":"API Tips",
+                        "show_in_portal":true,
+                        "main_content":"Tips on using our API",
+                        "agent_content":null,
+                        "email":"Tips on using our API",
+                        "chat":"Tips on using our API",
+                        "twitter":"Tips on using our API",
+                        "question_answer":"Tips on using our API",
+                        "phone":"Tips on using our API",
+                        "quickcode":null,
+                        "created_by":
+                        {
+                                "user":
+                                {
+                                        "id":1,
+                                        "name":"API User",
+                                        "name_public":"API User",
+                                        "email":"apiuser@yoursite.com",
+                                        "created_at":"2011-01-13T22:41:42Z",
+                                        "updated_at":"2011-01-19T22:04:33Z",
+                                        "user_level":"admin",
+                                        "login_count":9,
+                                        "time_zone":"Pacific Time (US & Canada)",
+                                        "last_login_at":"2011-01-19T18:21:52Z",
+                                        "current_login_at":"2011-01-19T22:04:33Z"
+                                }
+                        },
+                        "updated_by":
+                        {
+                                "user":
+                                {
+                                        "id":1,
+                                        "name":"API User",
+                                        "name_public":"API User",
+                                        "email":"apiuser@yoursite.com",
+                                        "created_at":"2011-01-13T22:41:42Z",
+                                        "updated_at":"2011-01-19T22:04:33Z",
+                                        "user_level":"admin",
+                                        "login_count":9,
+                                        "time_zone":"Pacific Time (US & Canada)",
+                                        "last_login_at":"2011-01-19T18:21:52Z",
+                                        "current_login_at":"2011-01-19T22:04:33Z"
+                                }
+                        }
+                }
+        }
+}