desk 0.3.0

data/lib/desk/request.rb

@@ -0,0 +1,44 @@
+module Desk
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false)
+      request(:post, path, options, raw)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false)
+      request(:put, path, options, raw)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false)
+      request(:delete, path, options, raw)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false)
+      response = connection(raw).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(formatted_path(path), options)
+        when :post, :put
+          request.path = formatted_path(path)
+          request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/desk/version.rb

@@ -0,0 +1,4 @@
+module Desk
+  # The version of the gem
+  VERSION = '0.3.0'.freeze unless defined?(::Desk::VERSION)
+end

data/lib/faraday/request/multipart_with_file.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::MultipartWithFile < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+        when /\.jpe?g/i then 'image/jpeg'
+        when /\.gif$/i then 'image/gif'
+        when /\.png$/i then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/request/oauth.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module Faraday
+  class Request::OAuth < Faraday::Middleware
+    dependency 'simple_oauth'
+
+    def call(env)
+      params = env[:body] || {}
+
+      signature_params = params.reject{ |k,v| v.respond_to?(:content_type) || (env[:method] == :put) }
+
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Desk::BadRequest.new(error_message(env), env[:response_headers])
+      when 401
+        raise Desk::Unauthorized.new(error_message(env), env[:response_headers])
+      when 403
+        raise Desk::Forbidden.new(error_message(env), env[:response_headers])
+      when 404
+        raise Desk::NotFound.new(error_message(env), env[:response_headers])
+      when 406
+        raise Desk::NotAcceptable.new(error_message(env), env[:response_headers])
+      when 420
+        raise Desk::EnhanceYourCalm.new(error_message(env), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = body['errors'].to_a.first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise Desk::InternalServerError.new(error_message(env, "Something is technically wrong."), env[:response_headers])
+      when 502
+        raise Desk::BadGateway.new(error_message(env, "Desk.com is down or being upgraded."), env[:response_headers])
+      when 503
+        raise Desk::ServiceUnavailable.new(error_message(env, "(__-){ Desk.com is over capacity."), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')} Check http://desk.com/ for updates on the status of the Desk.com service."
+    end
+  end
+end

data/spec/desk/api_spec.rb

@@ -0,0 +1,70 @@
+require 'helper'
+
+describe Desk::API do
+  before do
+    @keys = Desk::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+
+    before do
+      Desk.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Desk.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Desk::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :consumer_key => 'CK',
+          :consumer_secret => 'CS',
+          :oauth_token => 'OT',
+          :oauth_token_secret => 'OS',
+          :adapter => :typhoeus,
+          :format => :xml,
+          :proxy => 'http://erik:sekret@proxy.example.com:8080',
+          :subdomain => 'zencoder',
+          :support_email => 'help@zencoder.com',
+          :user_agent => 'Custom User Agent',
+          :version => "amazing"
+        }
+      end
+
+      context "during initialization"
+
+        it "should override module configuration" do
+          api = Desk::API.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = Desk::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/desk/client/article_spec.rb

@@ -0,0 +1,134 @@
+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 ".articles" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics/1/articles.#{format}").
+              to_return(:body => fixture("articles.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.articles(1)
+            a_get("topics/1/articles.#{format}").
+              should have_been_made
+          end
+
+          it "should return the articles" do
+            articles = @client.articles(1)
+
+            articles.results.should be_a Array
+            articles.results.first.article.id.should == 13
+          end
+
+        end
+      end
+
+      describe ".article" do
+
+        context "lookup" do
+
+          before do
+            stub_get("articles/13.#{format}").
+              to_return(:body => fixture("article.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.article(13)
+            a_get("articles/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            article = @client.article(13)
+
+            article.id.should == 13
+            article.subject.should == "API Tips"
+          end
+
+        end
+      end
+
+      describe ".create_article" do
+
+        context "create" do
+
+          before do
+            stub_post("topics/1/articles.#{format}").
+              to_return(:body => fixture("article_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+            a_post("topics/1/articles.#{format}").
+              should have_been_made
+          end
+
+          it "should return the articles" do
+            article = @client.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+
+            article.id.should == 13
+          end
+
+        end
+      end
+
+      describe ".update_article" do
+
+        context "update" do
+
+          before do
+            stub_put("articles/1.#{format}").
+              to_return(:body => fixture("article_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+            a_put("articles/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.update_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+
+            topic.subject.should == "API Tips"
+            topic.main_content.should == "Tips on using our API"
+          end
+
+        end
+      end
+
+      describe ".delete_article" do
+
+        context "delete" do
+
+          before do
+            stub_delete("articles/1.#{format}").
+              to_return(:body => fixture("article_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_article(1)
+            a_delete("articles/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            topic = @client.delete_article(1)
+            topic.success.should == true
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/spec/desk/client/case_spec.rb

@@ -0,0 +1,99 @@
+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 ".cases" do
+
+        context "lookup" do
+
+          before do
+            stub_get("cases.#{format}").
+              to_return(:body => fixture("cases.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.cases
+            a_get("cases.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            cases = @client.cases
+
+            cases.results.should be_a Array
+            cases.results.first.case.id.should == 1
+            cases.results.first.case.user.name.should == "Jeremy Suriel"
+          end
+
+        end
+      end
+
+      describe ".case" do
+
+        context "lookup" do
+
+          before do
+            stub_get("cases/1.#{format}").
+              to_return(:body => fixture("case.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.case(1)
+            a_get("cases/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            a_case = @client.case(1)
+
+            a_case.id.should == 1
+            a_case.external_id.should == "123"
+            a_case.subject.should == "Welcome to Desk.com"
+          end
+
+        end
+      end
+
+      describe ".update_case" do
+
+        context "update" do
+
+          before do
+            stub_put("cases/1.#{format}").
+              to_return(:body => fixture("case_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_case(1, :subject => "Welcome to Desk")
+            a_put("cases/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            a_case = @client.update_case(1, :subject => "Welcome to Desk.com")
+
+            a_case.id.should == 1
+            a_case.subject.should == "Welcome to Desk.com"
+          end
+
+        end
+      end
+
+      describe ".case_url" do
+
+        context "generating a case url" do
+
+          it "should make a correct url for the case" do
+            @client.case_url(123).should == "https://example.desk.com/agent/case/123"
+          end
+
+        end
+      end
+    end
+  end
+end