desk_api_v2 0.0.1

data/lib/desk/client.rb

@@ -0,0 +1,39 @@
+require 'desk/connection'
+require 'desk/api/cases'
+require 'desk/api/articles'
+require 'desk/api/translations'
+require 'desk/api/customers'
+require 'desk/api/topics'
+require 'desk/api/groups'
+
+module Desk
+  class Client
+
+    def initialize(opts={})
+      @opts = opts
+    end
+
+    def articles
+      Desk::Api::Articles.new(connection)
+    end
+
+    def cases
+      Desk::Api::Cases.new(connection)
+    end
+
+    def customers
+      Desk::Api::Customers.new(connection)
+    end
+
+    def topics
+      Desk::Api::Topics.new(connection)
+    end
+
+    private
+
+    def connection
+      @connection ||= Desk::Connection.new(@opts)
+    end
+
+  end
+end

data/lib/desk/collection.rb

@@ -0,0 +1,17 @@
+module Desk
+  class Collection < Array
+
+    def initialize(response, klass)
+      @response = response
+      super response["_embedded"]["entries"]
+      coerce_into klass
+    end
+
+    private
+
+    def coerce_into(klass)
+      self.map! { |obj| klass.new(obj) }
+    end
+
+  end
+end

data/lib/desk/connection.rb

@@ -0,0 +1,71 @@
+require 'faraday_middleware'
+require 'desk/response/error_handling'
+
+module Desk
+  class Connection
+
+    def initialize(opts={})
+      @site = opts[:site]
+      connection
+      use_basic_auth(opts) if opts[:email] && opts[:password]
+      use_oauth(opts) if opts[:consumer_key] &&
+                         opts[:consumer_secret] &&
+                         opts[:token] &&
+                         opts[:token_secret]
+    end
+
+    def get(*opts)
+      @connection.get(*stringify_arrays(*opts)).body
+    end
+
+    def post(*opts)
+      @connection.post(*opts).body
+    end
+
+    def patch(*opts)
+      @connection.patch(*opts).body
+    end
+
+    def delete(*opts)
+      result = @connection.delete(*opts)
+
+      result.status == 204
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(base_url, ssl: { verify: true } ) do |conn|
+        conn.use Desk::Response::ErrorHandling
+        conn.use FaradayMiddleware::ParseJson
+        conn.headers = {'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+        conn.request :json
+        conn.use Faraday::Adapter::NetHttp
+      end
+      @connection
+    end
+
+    def use_basic_auth(opts)
+      @connection.builder.insert(1, Faraday::Request::BasicAuthentication, opts[:email], opts[:password])
+    end
+
+    def use_oauth(opts)
+      @connection.builder.insert(1, FaradayMiddleware::OAuth, {
+                          :consumer_key => opts[:consumer_key],
+                          :consumer_secret => opts[:consumer_secret],
+                          :token => opts[:token],
+                          :token_secret => opts[:token_secret]
+                        } )
+    end
+
+    def base_url
+      "https://#{@site}.desk.com/api/v2/"
+    end
+
+    def stringify_arrays(*opts)
+      opts.collect do |opt|
+        opt.is_a?(Hash) ? opt.each {|k,v| opt[k] = v.is_a?(Array) ? v.join(",") : v} : opt
+      end
+    end
+  end
+end

data/lib/desk/customer.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Customer < Entity
+
+  end
+end

data/lib/desk/entity.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+module Desk
+  class Entity < OpenStruct
+
+  end
+end

data/lib/desk/error.rb

@@ -0,0 +1,17 @@
+module Desk
+  class Error < StandardError
+
+  end
+
+  BadRequest = Class.new(Desk::Error)
+  Unauthorized = Class.new(Desk::Error)
+  NotFound = Class.new(Desk::Error)
+  Forbidden = Class.new(Desk::Error)
+  MethodNotAllowed = Class.new(Desk::Error)
+  NotAcceptable = Class.new(Desk::Error)
+  Conflict = Class.new(Desk::Error)
+  UnsupportedMediaType = Class.new(Desk::Error)
+  UnprocessableEntity = Class.new(Desk::Error)
+  TooManyRequests = Class.new(Desk::Error)
+  NotImplemented = Class.new(Desk::Error)
+end

data/lib/desk/filter.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Filter < Entity
+
+  end
+end

data/lib/desk/group.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Group < Entity
+
+  end
+end

data/lib/desk/message.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Message < Entity
+
+  end
+end

data/lib/desk/response/error_handling.rb

@@ -0,0 +1,30 @@
+require 'desk/error'
+
+module Desk
+  module Response
+    class ErrorHandling < Faraday::Response::Middleware
+
+      ERROR_TYPE = {
+        400 => BadRequest,
+        401 => Unauthorized,
+        404 => NotFound,
+        403 => Forbidden,
+        405 => MethodNotAllowed,
+        406 => NotAcceptable,
+        409 => Conflict,
+        415 => UnsupportedMediaType,
+        422 => UnprocessableEntity,
+        429 => TooManyRequests,
+        501 => NotImplemented
+      }
+
+      def call(env)
+        @app.call(env).on_complete do |finished_env|
+          if finished_env[:status] >= 400
+            raise ERROR_TYPE[finished_env[:status]], finished_env[:body]["message"] if ERROR_TYPE[finished_env[:status]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/desk/topic.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Topic < Entity
+
+  end
+end

data/lib/desk/translation.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Translation < Entity
+
+  end
+end

data/lib/desk/user.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class User < Entity
+
+  end
+end

data/spec/desk/api/articles_spec.rb

@@ -0,0 +1,135 @@
+require 'json'
+require_relative '../../spec_helper'
+
+describe Desk::Api::Articles do
+
+  before { @connection = Minitest::Mock.new }
+
+  subject { Desk::Api::Articles.new(@connection) }
+
+  describe "#all" do
+
+    before { @connection.expect(:get, articles_fixture, ["articles"]) }
+
+    it "will connect to the articles endpoint" do
+      subject.all
+    end
+
+    it "will return an array of articles" do
+      result = subject.all
+
+      assert result.is_a? Array
+      assert result.first.is_a? Desk::Article
+    end
+  end
+
+  describe "#show" do
+
+    before { @connection.expect(:get, article_fixture, ["articles/1234"]) }
+
+    it "will connect to the article show endpoint" do
+      subject.show(1234)
+
+      @connection.verify
+    end
+
+    it "will return a single article object" do
+      result = subject.show(1234)
+
+      assert result.is_a? Desk::Article
+    end
+  end
+
+  describe "#create" do
+
+    before do
+      @data = {
+                subject: "How to make your customers happy",
+                body: "<strong>Use Desk.com</strong>",
+                body_email: "Custom email body for article",
+                body_email_auto: false,
+                _links: { topic: { href: "/api/v2/topics/1", class: "topic" } }
+             }
+
+      @connection.expect(:post, article_fixture, ["articles", @data])
+    end
+
+    it "will connect to the article creation endpoint" do
+      subject.create(@data)
+
+      @connection.verify
+    end
+  end
+
+  describe "#update" do
+    before do
+      @data = {
+                subject: "How to make your customers happy",
+                body: "<strong>Use Desk.com</strong>",
+                body_email: "Email just doesn't cut it",
+                body_email_auto: false,
+                body_twitter: "Use Desk.com in 140 chars or less",
+                body_twitter_auto: false,
+                _links: {
+                  topic: {
+                    href: "/api/v2/topics/2"
+                  }
+                }
+              }
+
+      @connection.expect(:patch, article_fixture, ["articles/1234", @data])
+    end
+
+    it "will connect to the article update endpoint" do
+      subject.update(1234, @data)
+
+      @connection.verify
+    end
+  end
+
+  describe "#delete" do
+
+    before { @connection.expect(:delete, true, ["articles/1234"]) }
+
+    it "will connect to the article delete endpoint" do
+      subject.delete(1234)
+
+      @connection.verify
+    end
+  end
+
+  describe "#search" do
+
+    it "will connect to the article search endpoint" do
+      @connection.expect(:get, articles_fixture, ["articles/search", {text: "foo"}])
+
+      subject.search(text: "foo")
+
+      @connection.verify
+    end
+
+    it "will pass topic IDs into the search query" do
+      @connection.expect(:get, articles_fixture, ["articles/search", {text: "foo", topic_ids: [1,2,3]}])
+
+      subject.search(text: "foo", topic_ids: [1,2,3])
+
+      @connection.verify
+    end
+
+    it "will whitelist hash arguments" do
+      @connection.expect(:get, articles_fixture, ["articles/search", {text: "foo", topic_ids: [1,2,3]}])
+
+      subject.search(text: "foo", topic_ids: [1,2,3], bar: "baz")
+
+      @connection.verify
+    end
+  end
+
+  def articles_fixture
+    JSON.load(fixture("articles.json"))
+  end
+
+  def article_fixture
+    JSON.load(fixture("article.json"))
+  end
+end

data/spec/desk/api/cases_spec.rb

@@ -0,0 +1,181 @@
+require 'json'
+require_relative '../../spec_helper'
+
+class CasesSpec
+  describe Desk::Api::Cases do
+
+    before { @connection = Minitest::Mock.new }
+
+    subject { Desk::Api::Cases.new(@connection) }
+
+    describe "#all" do
+
+      before { @connection.expect(:get, cases_fixture, ["cases"]) }
+
+      it "will connect to the cases endpoint" do
+        subject.all
+
+        @connection.verify
+      end
+
+      it "will return an array of cases" do
+        result = subject.all
+
+        assert result.is_a? Array
+        assert result.first.is_a? Desk::Case
+      end
+    end
+
+    describe "#show" do
+
+      before { @connection.expect(:get, case_fixture, ["cases/1234"]) }
+
+      it "will connect to the case show endpoint" do
+        subject.show(1234)
+
+        @connection.verify
+      end
+
+      it "will return a single case object" do
+        result = subject.show(1234)
+
+        assert result.is_a? Desk::Case
+      end
+    end
+
+    describe "#create" do
+
+      before do
+        @data = {
+                  type: "email",
+                  subject: "Creating a case via the API",
+                  priority: 4,
+                  status: "open",
+                  labels: [
+                    "Spam",
+                    "Ignore"
+                  ],
+                  language: "fr",
+                  created_at: "2012-05-01T21:38:48Z",
+                  _links: {
+                    customer: {
+                      href: "/api/v2/customers/1",
+                      class: "customer"
+                    },
+                    assigned_user: {
+                      href: "/api/v2/users/1",
+                      class: "user"
+                    },
+                    assigned_group: {
+                      href: "/api/v2/groups/1",
+                      class: "group"
+                    },
+                    locked_by: {
+                      href: "/api/v2/users/1",
+                      class: "user"
+                    }
+                  },
+                  message: {
+                    direction: "in",
+                    status: "received",
+                    to: "someone@desk.com",
+                    from: "someone-else@desk.com",
+                    cc: "alpha@desk.com",
+                    bcc: "beta@desk.com",
+                    subject: "Creating a case via the API",
+                    body: "Please assist me with this case",
+                    created_at: "2012-05-02T21:38:48Z"
+                  }
+                }
+
+        @connection.expect(:post, case_fixture, ["cases", @data])
+      end
+
+      it "will connect to the case creation endpoint" do
+        subject.create(@data)
+
+        @connection.verify
+      end
+    end
+
+    describe "#update" do
+      before do
+        @data = {
+                  subject: "Updated",
+                  status: "pending",
+                  labels: [
+                    "Spam",
+                    "Test"
+                  ],
+                  custom_fields: {
+                    level: "super"
+                  },
+                  _links: {
+                    assigned_group: {
+                      href: "/api/v2/groups/1",
+                      rel: "group"
+                    }
+                  }
+                }
+
+        @connection.expect(:patch, case_fixture, ["cases/1234", @data])
+      end
+
+      it "will connect to the case update endpoint" do
+        subject.update(1234, @data)
+
+        @connection.verify
+      end
+    end
+
+    describe "#search" do
+
+      Desk::Api::Cases::VALID_SEARCH_PARAMS.each do |param|
+        it "will pass whitelisted params into the search query" do
+          @connection.expect(:get, cases_fixture, ["cases/search", {param => "foo"}])
+
+          subject.search(param => "foo")
+
+          @connection.verify
+        end
+      end
+
+      it "will whitelist hash arguments" do
+        @connection.expect(:get, cases_fixture, ["cases/search", {name: "foo"}])
+
+        subject.search(name: "foo", bar: "baz")
+
+        @connection.verify
+      end
+    end
+
+    describe "#message" do
+
+      before { @connection.expect(:get, message_fixture, ["cases/1234/message"]) }
+
+      it "will connect to the case message endpoint" do
+        subject.message(1234)
+
+        @connection.verify
+      end
+
+      it "will return a single message object" do
+        result = subject.message(1234)
+
+        assert result.is_a? Desk::Message
+      end
+    end
+
+    def cases_fixture
+      JSON.load(fixture("cases.json"))
+    end
+
+    def case_fixture
+      JSON.load(fixture("case.json"))
+    end
+
+    def message_fixture
+      JSON.load(fixture("message.json"))
+    end
+  end
+end