desk 0.3.3 → 1.0.0

data/lib/desk/version.rb

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

data/lib/faraday/request/oauth.rb

@@ -6,11 +6,14 @@ module Faraday
 
     def call(env)
       params = env[:body] || {}
-
+break
       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)
-
+      #header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+      # Runscope Support
+      realURL = env[:url].sub(/-desk-com-(\w)+.runscope.net/, ".desk.com")
+      header = SimpleOAuth::Header.new(env[:method], realURL, signature_params, @options)
+      env[:request_headers]['theURL'] = realURL
       env[:request_headers]['Authorization'] = header.to_s
 
       @app.call(env)

data/lib/faraday/response/deashify.rb

@@ -0,0 +1,23 @@
+require 'faraday_middleware/response/mashify'
+
+module FaradayMiddleware
+  # Public: Converts parsed response bodies to a Hashie::Rash if they were of
+  # Hash or Array type.
+  class Deashify < Mashify
+    dependency do
+      require 'desk/deash'
+      self.mash_class = ::Hashie::Deash
+    end
+
+    def parse(body)
+      case body
+      when Hash
+        raw = mash_class.new({:raw => body})
+      when Array
+        raw = body.map { |item| parse(item) }
+      else
+        raw = body
+      end
+    end
+  end
+end

data/spec/desk/client/article_spec.rb

@@ -1,132 +1,77 @@
 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
+  context "Article" do
+
+    let(:endpoint) { "article" }
+    let(:id) { 1 }
+    let(:check_key) { "subject" }
+    let(:check_value) { "Awesome Subject" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+    it_behaves_like "a create endpoint", {
+      :subject => "Awesome Subject",
+      :body => "Simply post here",
+      :_links => {
+        :topic => {
+          :href => "/api/v2/topics/1",
+          :class => "topic"
+        }
+      }
+    }
+
+    it_behaves_like "an update endpoint", {
+      :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"
+        }
+      }
+    } do
+      let(:check_value) { "How to make your customers happy" }
+    end
 
-      describe ".update_article" do
+    it_behaves_like "a delete endpoint"
 
-        context "update" do
+    it_behaves_like "a search endpoint", {
+      :text => "happy",
+      :topic_ids => "1,2,4"
+    }
 
-          before do
-            stub_put("articles/1.#{format}").
-              to_return(:body => fixture("article_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    context "Translation" do
 
-          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
+      let(:sub_endpoint) { "translation" }
+      let(:sub_id) { "en" }
+      let(:check_key) { "subject" }
+      let(:check_value) { "Awesome Subject" }
 
-          it "should return the new topic" do
-            topic = @client.update_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+      it_behaves_like "a sub list endpoint"
 
-            topic.subject.should == "API Tips"
-            topic.main_content.should == "Tips on using our API"
-          end
+      it_behaves_like "a sub show endpoint"
 
-        end
+      it_behaves_like "a sub create endpoint", {
+        :locale => "es",
+        :subject => "Spanish Translation",
+        :body => "Traducción español aquí"
+      } do
+        let(:sub_id) { "es" }
+        let(:check_value) { "Spanish Translation" }
       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
+      it_behaves_like "a sub update endpoint", {
+        :subject => "Updated Spanish Translation"
+      } do
+        let(:sub_id) { "es" }
+        let(:check_value) { "Updated Spanish Translation" }
       end
 
     end

data/spec/desk/client/brand_spec.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+describe Desk::Client do
+  context "Brand" do
+
+    let(:endpoint) { "brand" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "Desk.com" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+  end
+end

data/spec/desk/client/case_spec.rb

@@ -1,99 +1,215 @@
 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
+  context "Case" do
+
+    let(:endpoint) { "case" }
+    let(:id) { 1 }
+    let(:check_key) { "subject" }
+    let(:check_value) { "Welcome" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a search endpoint", {
+      :subject => "please help",
+      :name => "jimmy"
+    }
+
+    it_behaves_like "a show endpoint"
+
+    it_behaves_like "a create endpoint", {
+      :type => "email",
+      :subject => "Creating a case via the API",
+      :priority => 4,
+      :status => "open",
+      :labels => [ "Spam", "Ignore" ],
+      :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 => "out",
+        :status => "pending",
+        :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"
+      }
+    } do
+      let(:check_value) { "Creating a case via the API" }
+    end
 
-      describe ".cases" do
+    it_behaves_like "an update endpoint", {
+      :subject => "Updated",
+      :status => "pending",
+      :labels => [ "Spam", "Test" ],
+      :label_action => "replace",
+      :custom_fields => { :level => "super" },
+      :_links => {
+        :assigned_group => {
+          :href => "/api/v2/groups/1",
+          :rel => "group"
+        }
+      }
+    } do
+      let(:check_value) { "Updated" }
+    end
 
-        context "lookup" do
+    context "Message" do
 
-          before do
-            stub_get("cases.#{format}").
-              to_return(:body => fixture("cases.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+      let(:sub_endpoint) { "message" }
+      let(:check_value) { "Please help" }
 
-          it "should get the correct resource" do
-            @client.cases
-            a_get("cases.#{format}").
-              should have_been_made
-          end
+      include_context "plural endpoint"
 
-          it "should return up to 100 cases worth of extended information" do
-            cases = @client.cases
+      subject { client.send("show_#{endpoint}_#{sub_endpoint}", id) }
 
-            cases.results.should be_a Array
-            cases.results.first.case.id.should == 1
-            cases.results.first.case.user.name.should == "Jeremy Suriel"
-          end
+      before do
+        stub_get("#{endpoints}/#{id}/#{sub_endpoint}").
+          to_return(:body => fixture("#{endpoint}_#{sub_endpoint}"))
+      end
 
-        end
+      it "gets the correct resource" do
+        subject
+        expect(a_get("#{endpoints}/#{id}/#{sub_endpoint}")).
+          to have_been_made
       end
 
-      describe ".case" do
+      it { expect(subject).to be_a Hashie::Deash }
+
+      it "has a valid entry" do
+        expect(subject.parent_id).to eq(id)
+        expect(subject.send(check_key)).to eq(check_value)
+      end
 
-        context "lookup" do
+      it "allows raw access" do
+        expect(subject.raw).to be_a Hashie::Deash
+      end
 
-          before do
-            stub_get("cases/1.#{format}").
-              to_return(:body => fixture("case.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    end
 
-          it "should get the correct resource" do
-            @client.case(1)
-            a_get("cases/1.#{format}").
-              should have_been_made
-          end
+    context "Reply" do
 
-          it "should return up to 100 cases worth of extended information" do
-            a_case = @client.case(1)
+      let(:sub_endpoint) { "reply" }
+      let(:sub_id) { 1 }
+      let(:check_key) { "subject" }
+      let(:check_value) { "Re: Please help" }
 
-            a_case.id.should == 1
-            a_case.external_id.should == "123"
-            a_case.subject.should == "Welcome to Desk.com"
-          end
+      it_behaves_like "a sub list endpoint" do
+        let(:check_value) { "Please help" }
+      end
 
-        end
+      it_behaves_like "a sub show endpoint" do
+        let(:sub_id) { 2 }
       end
 
-      describe ".update_case" do
+      it_behaves_like "a sub create endpoint", {
+        :body => "My Reply",
+        :direction => "out"
+      }
+
+      it_behaves_like "a sub update endpoint", {
+        :body => "Updated reply body",
+        :cc => "new.email@example.com"
+      }
 
-        context "update" do
+    end
 
-          before do
-            stub_put("cases/1.#{format}").
-              to_return(:body => fixture("case_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    context "Note" do
 
-          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
+      let(:sub_endpoint) { "note" }
+      let(:sub_id) { 1 }
+      let(:check_key) { "body" }
+      let(:check_value) { "Please assist me with this case" }
 
-          it "should return up to 100 cases worth of extended information" do
-            a_case = @client.update_case(1, :subject => "Welcome to Desk.com")
+      it_behaves_like "a sub list endpoint"
 
-            a_case.id.should == 1
-            a_case.subject.should == "Welcome to Desk.com"
-          end
+      it_behaves_like "a sub show endpoint"
 
-        end
+      it_behaves_like "a sub create endpoint", {
+        :body => "Help me with my issue!"
+      } do
+        let(:check_value) { "Help me with my issue!" }
       end
 
-      describe ".case_url" do
-
-        context "generating a case url" do
+    end
 
-          it "should make a correct url for the case" do
-            @client.case_url(123).should == "https://example.desk.com/agent/case/123"
-          end
+    context "Attachment" do
+
+      let(:sub_endpoint) { "attachment" }
+      let(:sub_id) { 1 }
+      let(:check_key) { "file_name" }
+      let(:check_value) { "awesome_pic.png" }
+
+      it_behaves_like "a sub list endpoint"
+
+      it_behaves_like "a sub show endpoint"
+
+      it_behaves_like "a sub create endpoint", {
+        :file_name => "awesome_pic.png",
+        :content_type => "image/png",
+        :content => "iVBORw0KGgoAAAANSUhEUgAAABsAAAAXCAIAAAB1dKN5AAAAGXRFWHRTb2Z0
+          d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9i
+          ZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2Vo
+          aUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6
+          bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2
+          LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpS
+          REYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJk
+          Zi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIg
+          eG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxu
+          czp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1s
+          bnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9S
+          ZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9w
+          IENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo0
+          NkEyOEM5RUE2REUxMUUyODc1NUM1OUZGMTlFMjEwNyIgeG1wTU06RG9jdW1l
+          bnRJRD0ieG1wLmRpZDo0NkEyOEM5RkE2REUxMUUyODc1NUM1OUZGMTlFMjEw
+          NyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAu
+          aWlkOjg5ODY1RDg5QTZENzExRTI4NzU1QzU5RkYxOUUyMTA3IiBzdFJlZjpk
+          b2N1bWVudElEPSJ4bXAuZGlkOjg5ODY1RDhBQTZENzExRTI4NzU1QzU5RkYx
+          OUUyMTA3Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4
+          bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+I+v80gAAAwJJREFUeNqklUtr
+          U0EUx2fuvb1pmvSVmvpA2021tMXWoiLiY6MoFHQhgvYTFBTpZ+jChXHjwo3g
+          Uhe6EAuCoC1uRKVRulBbUFNSWvrC2rTN475mjmdmkkuSpg/t5SaczNzzu//z
+          PzMTAwDI/14MCAficrAYyTHIepBlRNsVjhCPEw/E7XLiyu9/IELhZjITWTmb
+          x98l3jwdtxk4HFxJN3YCUhcWCFIXBgiNj/x89ehTOpVrO3moh4HFiS1kgrET
+          HOcCxGTABA5QS+LbAuJU+TkmcEqmsVWN0nglylMgUSyIqmXhvqG5Ag7HjLLS
+          FEWNqOokDqT3IkeaBaobvhsWEyOUkN5G3YANHimWVCdEKWmO9KhAVM0BXyPO
+          Npq0q14L6tRAa0B5BPmK8tIIMC7GJU5ALZf/WVh3HFYdCRkh09doauR4RI+Y
+          VP00vAJLvdwtgjIJxcHV5Wz82fjU+4SbczFH02hL1z5S2Bp1VdTHCaLLQNns
+          5G0SjqiqUSAS5yYXR2Mj9rrl53AOya/zm7XUwH2DFEcSHSaaiMaxgptrS+nR
+          2Ft73d75RkAioEwb3ZVondKATlecPPTLk7iPO3el4/zVzpqw+X1sZvhxPLPJ
+          awzc3o7soFgcQDrrtWiAIiuD2z7tvPg8rZ67dLPn2sApFSO3tT1679ZLziuc
+          MlpGHBvE4oCLfk9A4HAUP2GDppLLzBPrmFJ6ub+nOA2JHScOVtaoFifW2Byg
+          KLB4LpdxVBAIGqG66rLMyN5wHmHqJRptJpbB4bDW3aDT0pzahqAKrKz7e36t
+          jDibWFZBYzRUQmyr1c5GjdZQhWOtpT0aDJkqfv7wI2fcn8K2JCeXVHzk2IHi
+          LP3B3aFybf7bNJpOWVMTixgvzqxOxGex/Uuzqx9e//BwfQBZmE5FmsM3Bs/g
+          k34W3fpfwco6sdvDc8mVyq/UtcH7fe29JRq3OcOra8w7sT7sbKWpqoGhi2W4
+          7TXmtx3jWOnY6C/shmt7Tftru0+3Xrh+tL6pZuPDdDf/hRWvvwIMAJE9J8AO
+          RSMOAAAAAElFTkSuQmCC"
+      }
+
+      it_behaves_like "a sub delete endpoint"
 
-        end
-      end
     end
   end
 end