desk_api 0.1.0

data/spec/desk/client_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Desk::Client do
+  subject do
+    @client ||= Desk::Client.new Desk::CONFIG
+  end
+
+  before do
+    @topic_create_data = { name: 'Test Topic' }
+    @topic_update_data = { name: 'Test Updated Topic' }
+  end
+
+  context '#initialize' do
+    before do
+      @configuration = {
+        consumer_key: 'CK',
+        consumer_secret: 'CS',
+        token: 'TOK',
+        token_secret: 'TOKS',
+        username: 'UN',
+        password: 'PW',
+        subdomain: 'devel',
+        endpoint: 'https://devel.desk.com',
+        connection_options: {
+          request: { timeout: 10 }
+        }
+      }
+    end
+
+    after do
+      Desk.reset!
+    end
+
+    context 'with module configuration' do
+      before do
+        Desk.configure do |config|
+          Desk::Configuration.keys.each do |key|
+            config.send("#{key}=", @configuration[key])
+          end
+        end
+      end
+
+      it 'inherits the module configuration' do
+        client = Desk::Client.new
+        Desk::Configuration.keys.each do |key|
+          client.instance_variable_get(:"@#{key}").should eq(@configuration[key])
+        end
+      end
+    end
+
+    context 'with class configuration' do
+      context "during initialization" do
+        it "overrides the module configuration" do
+          client = Desk::Client.new(@configuration)
+          Desk::Configuration.keys.each do |key|
+            client.instance_variable_get(:"@#{key}").should eq(@configuration[key])
+          end
+        end
+      end
+
+      context "after initialization" do
+        it "overrides the module configuration after initialization" do
+          client = Desk::Client.new
+          client.configure do |config|
+            @configuration.each do |key, value|
+              config.send("#{key}=", value)
+            end
+          end
+          
+          Desk::Configuration.keys.each do |key|
+            client.instance_variable_get(:"@#{key}").should eq(@configuration[key])
+          end
+        end
+      end
+    end
+
+    it 'sets up default resources on client' do
+      subject.methods include(:articles, :cases, :companies, :custom_fields, :customers)
+      subject.methods include(:filters, :groups, :inbound_mailboxes, :integration_urls)
+      subject.methods include(:jobs, :labels, :macros, :rules, :site_settings)
+      subject.methods include(:system_message, :topics, :twitter_accounts, :users)
+    end
+  end
+
+  describe '#get', :vcr do
+    it 'fetches resources' do
+      response = subject.get('/api/v2/cases/3014')
+      response.body.subject.should eq('Testing Quick Case')
+    end
+  end
+
+  describe '#post', :vcr do
+    it 'creates a resource' do
+      response = subject.post('/api/v2/topics', @topic_create_data)
+      response.body.name.should eq(@topic_create_data[:name])
+    end
+  end
+
+  describe '#patch', :vcr do
+    it 'updates a resource' do
+      subject.patch('/api/v2/topics/556402', @topic_update_data).body.name.should eq(@topic_update_data[:name])
+    end
+  end
+
+  describe '#delete', :vcr do
+    it 'deletes a resource' do
+      subject.delete('/api/v2/topics/556401').status.should eq(204)
+    end
+  end
+
+  describe '#connection' do
+    it 'looks like Faraday connection' do
+      subject.send(:connection).should be_an_instance_of(Faraday::Connection)
+    end
+
+    it 'memoizes the connection' do
+      c1, c2 = subject.send(:connection), subject.send(:connection)
+      c1.should equal(c2)
+    end
+  end
+
+  describe '#request' do
+    it 'catches Faraday errors' do
+      allow(subject).to receive(:connection).and_raise(Faraday::Error::ClientError.new('Oops'))
+      lambda { subject.send(:request, :get, '/path') }.should raise_error(Desk::Error::ClientError)
+    end
+
+    it 'catches JSON::ParserError errors' do
+      allow(subject).to receive(:connection).and_raise(JSON::ParserError.new('unexpected token'))
+      lambda { subject.send(:request, :get, '/path') }.should raise_error(Desk::Error::ParserError)
+    end
+  end
+end

data/spec/desk/configuration_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe Desk::Configuration do
+  context '#keys' do
+    it 'returns an array of configuration keys' do
+      Desk::Configuration.keys.should eq([
+        :consumer_key,
+        :consumer_secret,
+        :token,
+        :token_secret,
+        :username,
+        :password,
+        :subdomain,
+        :endpoint,
+        :connection_options
+      ])
+    end
+  end
+
+  context '#endpoint' do
+    after(:each) do
+      Desk.reset!
+    end
+
+    it 'returns the endpoint if set' do
+      Desk.endpoint = 'https://devel.desk.com'
+      Desk.endpoint.should eq('https://devel.desk.com')
+    end
+
+    it 'returns the subdomain endpoint if subdomain is set' do
+      Desk.subdomain = 'devel'
+      Desk.endpoint.should eq('https://devel.desk.com')
+    end
+
+    it 'gives presidence to the endpoint' do
+      Desk.subdomain = 'subdomain'
+      Desk.endpoint = 'https://endpoint.desk.com'
+      Desk.endpoint.should eq('https://endpoint.desk.com')
+    end
+  end
+
+  context '#configure' do
+    before do
+      @configuration = {
+        consumer_key: 'CK',
+        consumer_secret: 'CS',
+        token: 'TOK',
+        token_secret: 'TOKS',
+        username: 'UN',
+        password: 'PW',
+        subdomain: 'devel',
+        endpoint: 'https://devel.desk.com',
+        connection_options: {
+          request: { timeout: 10 }
+        }
+      }
+    end
+
+    it 'overrides the module configuration' do
+      client = Desk::Client.new
+      client.configure do |config|
+        @configuration.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+
+      Desk::Configuration.keys.each do |key|
+        client.instance_variable_get(:"@#{key}").should eq(@configuration[key])
+      end
+    end
+
+    it 'throws an exception if credentials are not set' do
+      client = Desk::Client.new
+      lambda {
+        client.configure do |config|
+          @configuration.each do |key, value|
+            config.send("#{key}=", value)
+          end
+          config.username = nil
+          config.consumer_key = nil
+        end
+      }.should raise_error(Desk::Error::ConfigurationError)
+    end
+
+    it 'throws an exception if basic auth credentials are invalid' do
+      client = Desk::Client.new
+      lambda {
+        client.configure do |config|
+          @configuration.each do |key, value|
+            config.send("#{key}=", value)
+          end
+          config.username = 1
+          config.consumer_key = nil
+        end
+      }.should raise_error(Desk::Error::ConfigurationError)
+    end
+
+    it 'throws an exception if oauth credentials are invalid' do
+      client = Desk::Client.new
+      lambda {
+        client.configure do |config|
+          @configuration.each do |key, value|
+            config.send("#{key}=", value)
+          end
+          config.username = nil
+          config.consumer_key = 1
+        end
+      }.should raise_error(Desk::Error::ConfigurationError)
+    end
+
+    it 'throws an exception if endpoint is not a valid url' do
+      client = Desk::Client.new
+      lambda {
+        client.configure do |config|
+          @configuration.each do |key, value|
+            config.send("#{key}=", value)
+          end
+          config.endpoint = 'some_funky_endpoint'
+        end
+      }.should raise_error(Desk::Error::ConfigurationError)
+    end
+  end
+
+  context '#reset!' do
+    before do
+      @configuration = {
+        consumer_key: 'CK',
+        consumer_secret: 'CS',
+        token: 'TOK',
+        token_secret: 'TOKS',
+        username: 'UN',
+        password: 'PW',
+        subdomain: 'devel',
+        endpoint: 'https://devel.desk.com',
+        connection_options: {
+          request: { timeout: 10 }
+        }
+      }
+    end
+
+    it 'resets the configuration to module defaults' do
+      client = Desk::Client.new
+      client.configure do |config|
+        @configuration.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+      client.reset!
+
+      Desk::Configuration.keys.each do |key|
+        client.instance_variable_get(:"@#{key}").should_not eq(@configuration[key])
+      end
+    end
+  end
+
+  context '#credentials?' do
+    before do
+      @client = Desk::Client.new
+    end
+
+    after do
+      @client.reset!
+    end
+
+    it 'returns false if no authentication credentials are set' do
+      @client.credentials?.should be_false
+    end
+
+    it 'returns true if basic auth credentials are set' do
+      @client.username = 'UN'
+      @client.password = 'PW'
+      @client.credentials?.should be_true
+    end
+
+    it 'returns true if oauth credentials are set' do
+      @client.consumer_key = 'CK'
+      @client.consumer_secret = 'CS'
+      @client.token = 'TOK'
+      @client.token_secret = 'TOKS'
+      @client.credentials?.should be_true
+    end
+  end
+end

data/spec/desk/default_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Desk::Default do
+  context '#options' do
+    it 'returns a hash with mostly nil values' do
+      Desk::Default.options.should eq({
+        consumer_key: nil,
+        consumer_secret: nil,
+        token: nil,
+        token_secret: nil,
+        username: nil,
+        password: nil,
+        subdomain: nil,
+        endpoint: nil,
+        connection_options: {
+          headers: {
+            accept: 'application/json',
+            user_agent: "desk.com Ruby Gem v#{Desk::VERSION}"
+          },
+          request: {
+            open_timeout: 5,
+            timeout: 10
+          }
+        }
+      })
+    end
+
+    it 'returns a hash with environmental variables' do
+      ENV['DESK_CONSUMER_KEY'] = 'CK'
+      ENV['DESK_CONSUMER_SECRET'] = 'CS'
+      ENV['DESK_TOKEN'] = 'TOK'
+      ENV['DESK_TOKEN_SECRET'] = 'TOKS'
+      ENV['DESK_USERNAME'] = 'UN'
+      ENV['DESK_PASSWORD'] = 'PW'
+      ENV['DESK_SUBDOMAIN'] = 'SD'
+      ENV['DESK_ENDPOINT'] = 'EP'
+
+      Desk::Default.options.should eq({
+        consumer_key: 'CK',
+        consumer_secret: 'CS',
+        token: 'TOK',
+        token_secret: 'TOKS',
+        username: 'UN',
+        password: 'PW',
+        subdomain: 'SD',
+        endpoint: 'EP',
+        connection_options: {
+          headers: {
+            accept: 'application/json',
+            user_agent: "desk.com Ruby Gem v#{Desk::VERSION}"
+          },
+          request: {
+            open_timeout: 5,
+            timeout: 10
+          }
+        }
+      })
+
+      ENV['DESK_CONSUMER_KEY'] = nil
+      ENV['DESK_CONSUMER_SECRET'] = nil
+      ENV['DESK_TOKEN'] = nil
+      ENV['DESK_TOKEN_SECRET'] = nil
+      ENV['DESK_USERNAME'] = nil
+      ENV['DESK_PASSWORD'] = nil
+      ENV['DESK_SUBDOMAIN'] = nil
+      ENV['DESK_ENDPOINT'] = nil
+    end
+  end
+end

data/spec/desk/error_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Desk::Error do
+  subject do
+    @client ||= Desk::Client.new Desk::CONFIG
+  end
+
+  context '.from_response' do
+    it 'can be created from a faraday response', :vcr do
+      lambda {
+        subject.articles.create({ subject: 'Testing', body: 'Testing' }) 
+      }.should raise_error(Desk::Error::UnprocessableEntity)
+    end
+
+    it 'uses the body message if present', :vcr do
+      begin
+        subject.articles.create({ subject: 'Testing', body: 'Testing' })
+      rescue Desk::Error::UnprocessableEntity => e
+        e.message.should eq('Validation Failed')
+      end
+    end
+  end
+end

data/spec/desk/rate_limit_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Desk::RateLimit do
+  context "#limit" do
+    it "returns an Integer when x-rate-limit-limit header is set" do
+      rate_limit = Desk::RateLimit.new("x-rate-limit-limit" => "150")
+      expect(rate_limit.limit).to be_an Integer
+      expect(rate_limit.limit).to eq 150
+    end
+
+    it "returns nil when x-rate-limit-limit header is not set" do
+      rate_limit = Desk::RateLimit.new
+      expect(rate_limit.limit).to be_nil
+    end
+  end
+
+  context "#remaining" do
+    it "returns an Integer when x-rate-limit-remaining header is set" do
+      rate_limit = Desk::RateLimit.new("x-rate-limit-remaining" => "149")
+      expect(rate_limit.remaining).to be_an Integer
+      expect(rate_limit.remaining).to eq 149
+    end
+
+    it "returns nil when x-rate-limit-remaining header is not set" do
+      rate_limit = Desk::RateLimit.new
+      expect(rate_limit.remaining).to be_nil
+    end
+  end
+
+  context "#reset_in" do
+    it "returns an Integer when x-rate-limit-reset header is set" do
+      rate_limit = Desk::RateLimit.new("x-rate-limit-reset" => "36")
+      expect(rate_limit.reset_in).to be_an Integer
+      expect(rate_limit.reset_in).to eq 36
+    end
+
+    it "returns nil when x-rate-limit-reset header is not set" do
+      rate_limit = Desk::RateLimit.new
+      expect(rate_limit.reset_in).to be_nil
+    end
+  end
+end

data/spec/desk/request/retry_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'desk/request/retry'
+
+describe Desk::Request::Retry do
+  before do
+    @stubs = Faraday::Adapter::Test::Stubs.new
+    @conn = Faraday.new do |builder|
+      builder.request :retry, { interval: 0 }
+      builder.adapter :test, @stubs
+    end
+  end
+
+  it 'retries three times', vcr: { record: :none } do
+    times_called = 0
+
+    @stubs.post('/echo') do
+      times_called += 1
+      raise Faraday::Error::TimeoutError, 'Timeout'
+    end
+
+    @conn.post('http://localhost/echo') rescue nil
+    times_called.should eq(3)
+  end
+
+  it 'retries once if we have too many requests', vcr: { record: :none } do
+    times_called = 0
+
+    @stubs.post('/echo') do
+      times_called += 1
+      raise Desk::Error::TooManyRequests.from_response({
+        body: '{"message":"Too Many Requests"}',
+        status: 429,
+        response_headers: {
+          'status' => 429,
+          'x-rate-limit-limit' => '60',
+          'x-rate-limit-remaining' => '0',
+          'x-rate-limit-reset' => '1',
+          'content-length' => '31'
+        }
+      })
+    end
+
+    @conn.post('http://localhost/echo') rescue nil
+    times_called.should eq(2)
+  end
+end

data/spec/desk/resource_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Desk::Resource do
+  subject do
+    @client ||= Desk::Client.new Desk::CONFIG
+  end
+
+  context '#initialize' do
+    it 'stores the client' do
+      subject.articles.instance_variable_get(:@client).should eq(subject)
+    end
+
+    it 'is not loaded initially' do
+      subject.articles.instance_variable_get(:@loaded).should be_false
+    end
+
+    it 'sets up the link to self' do
+      subject.articles.instance_variable_get(:@_links).self.href.should_not be_nil
+    end
+  end
+
+  context '#exec!', :vcr do
+    it 'loads the current resource' do
+      subject.articles.send(:exec!).instance_variable_get(:@loaded).should be_true
+    end
+
+    it 'can be forced to reload' do
+      subject.articles.instance_variable_set(:@loaded, true)
+      subject.should_receive(:get).and_call_original
+      subject.articles.send(:exec!, true)
+    end
+  end
+
+  context '#method_missing', :vcr do
+    it 'loads the resource to find a suitable method' do
+      subject.articles.instance_variable_set(:@loaded, false)
+      subject.articles.should_receive(:exec!).and_call_original
+      subject.articles.first_page
+    end
+
+    it 'raises an error if method does not exist' do
+      lambda { subject.articles.some_other_method }.should raise_error(Desk::Error::MethodNotSupported)
+    end
+  end
+
+  context '#by_url', :vcr do
+    it 'finds resources by url' do
+      subject.articles.by_url('/api/v2/articles/1213277').should be_an_instance_of(Desk::Resource::Article)
+    end
+  end
+
+  context '#resource', :vcr do
+    it 'requires the specified resource' do
+      subject.send(:resource, 'article').should equal(Desk::Resource::Article)
+    end
+
+    it 'returns the generic resource on error' do
+      subject.send(:resource, 'something_crazy').should equal(Desk::Resource)
+    end
+  end
+
+  context '#search' do
+    it 'allows searching on search enabled resources', :vcr do
+      subject.articles.search(text: 'Lorem Ipsum').total_entries.should eq(0)
+    end
+
+    it 'throws an error if search is not enabled' do
+      lambda { subject.users.search(test: 'something') }.should raise_error(Desk::Error::MethodNotSupported)
+    end
+  end
+
+  context '#create' do
+    it 'creates a new topic', :vcr do
+      topic = subject.topics.create({
+        name: 'My new topic'
+      }).name.should eq('My new topic')
+    end
+
+    it 'throws an error creating a user' do
+      lambda { subject.users.create(name: 'Some User') }.should raise_error(Desk::Error::MethodNotSupported)
+    end
+  end
+
+  context '#update' do
+    it 'updates a topic', :vcr do
+      topic = subject.topics.first
+
+      topic.description = 'Some new description'
+      topic.update({
+        name: 'Updated topic name'
+      })
+
+      topic.name.should eq('Updated topic name')
+      topic.description.should eq('Some new description')
+    end
+
+    it 'throws an error updating a user', :vcr do
+      user = subject.users.first
+      lambda { user.update(name: 'Some User') }.should raise_error(Desk::Error::MethodNotSupported)
+    end
+  end
+
+  context '#delete' do
+    it 'deletes a resource', :vcr do
+      subject.articles.create({
+        subject: 'My subject',
+        body: 'Some text for this new article',
+        _links: {
+          topic: subject.topics.first.get_self
+        }
+      }).delete.should be_true
+    end
+
+    it 'throws an error deleting a non deletalbe resource', :vcr do
+      user = subject.users.first
+      lambda { user.delete }.should raise_error(Desk::Error::MethodNotSupported)
+    end
+  end
+end

data/spec/desk/resources/page_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'desk/resource/page'
+
+describe Desk::Resource::Page do
+  subject do
+    @client ||= Desk::Client.new Desk::CONFIG
+  end
+
+  context '#query_params' do
+    before do
+      @page = Desk::Resource::Page.new(subject, Hashie::Mash.new({
+        _links: { self: { href: '/api/v2/cases?page=2&per_page=50' } }
+      }), true)
+    end
+
+    it 'allows to get query params from the current resource' do
+      @page.send(:query_params, 'page').should eq('2')
+      @page.send(:query_params, 'per_page').should eq('50')
+    end
+
+    it 'returns nil if param not found' do
+      @page.send(:query_params, 'blup').should be_nil
+    end
+  end
+
+  context '#query_params=' do
+    before do
+      @page = Desk::Resource::Page.new(subject, Hashie::Mash.new({
+        _links: { self: { href: '/api/v2/cases' } }
+      }), true)
+    end
+
+    it 'sets query params on the current url' do
+      @page.send(:query_params=, { page: 5, per_page: 50 })
+      @page.instance_variable_get(:@_links).self.href.should eq('/api/v2/cases?page=5&per_page=50')
+    end
+  end
+
+  context '#page' do
+    it 'returns the current page and loads if page not defined', :vcr do
+      subject.articles.page.should eq(1)
+    end
+
+    it 'sets the page' do
+      subject.cases.page(5).page.should eq(5)
+    end
+
+    it 'sets the resource to not loaded', :vcr do
+      cases = subject.cases.send(:exec!)
+      cases.page(5).instance_variable_get(:@loaded).should be_false
+    end
+
+    it 'keeps the resource as loaded', :vcr do
+      cases = subject.cases.send(:exec!)
+      cases.page(1).instance_variable_get(:@loaded).should be_true
+    end
+  end
+
+  context '#by_id' do
+    it 'loads the requested resource', :vcr do
+      subject.cases.by_id(3065).subject.should eq('Testing the Tank again')
+    end
+  end
+end