desk_api 0.1.0

data/spec/desk_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Desk do
+  describe '.method_missing' do
+    it 'delegates to Desk::Client' do
+      Desk.method_missing(:endpoint).should be_a(String)
+    end
+  end
+
+  describe '.respond_to_missing?' do
+    it 'delegates to Desk::Client' do
+      Desk.respond_to_missing?(:endpoint).should be_true
+    end
+
+    it 'takes an optional argument' do
+      Desk.respond_to_missing?(:endpoint, true).should be_true
+    end
+  end
+
+  describe '.client' do
+    it 'should return a client' do
+      Desk.client.should be_an_instance_of(Desk::Client)
+    end
+
+    context 'when the options do not change' do
+      it 'caches the client' do
+        Desk.client.should equal(Desk.client)
+      end
+    end
+
+    context 'when the options change' do
+      it 'busts the cache' do
+        client1 = Desk.client
+        client1.configure do |config|
+          config.username = 'test@example.com'
+          config.password = 'password'
+        end
+        client2 = Desk.client
+        client1.should_not equal(client2)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter 'config.rb'
+end
+
+require 'rspec'
+require 'vcr'
+require 'desk'
+
+begin
+  require_relative '../config'
+rescue LoadError
+  module Desk
+    CONFIG = {
+      username: 'devel@example.com',
+      password: '1234password',
+      subdomain: 'devel'
+    }
+  end
+end
+
+VCR.configure do |config|
+  config.hook_into :typhoeus, :faraday
+  config.cassette_library_dir = 'spec/cassettes'
+  config.configure_rspec_metadata!
+  config.before_record { |i| i.request.headers.delete('Authorization') }
+  config.ignore_request { |request| URI(request.uri).host == 'localhost' }
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,347 @@
+--- !ruby/object:Gem::Specification
+name: desk_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Stachl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a lightweight, flexible ruby gem to interact with the desk.com
+  REST API. It allows to create, read and delete resources available through the API
+  endpoints. It can be used either with OAuth or HTTP Basic Authentication.
+email: tom@desk.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .coveralls.yml
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config.rb
+- desk_api.gemspec
+- lib/desk.rb
+- lib/desk/action/create.rb
+- lib/desk/action/delete.rb
+- lib/desk/action/embedded.rb
+- lib/desk/action/field.rb
+- lib/desk/action/link.rb
+- lib/desk/action/resource.rb
+- lib/desk/action/search.rb
+- lib/desk/action/update.rb
+- lib/desk/client.rb
+- lib/desk/configuration.rb
+- lib/desk/default.rb
+- lib/desk/error.rb
+- lib/desk/error/bad_gateway.rb
+- lib/desk/error/bad_request.rb
+- lib/desk/error/client_error.rb
+- lib/desk/error/configuration_error.rb
+- lib/desk/error/conflict.rb
+- lib/desk/error/forbidden.rb
+- lib/desk/error/gateway_timeout.rb
+- lib/desk/error/internal_server_error.rb
+- lib/desk/error/method_not_allowed.rb
+- lib/desk/error/method_not_supported.rb
+- lib/desk/error/not_acceptable.rb
+- lib/desk/error/not_found.rb
+- lib/desk/error/parse_error.rb
+- lib/desk/error/parser_error.rb
+- lib/desk/error/server_error.rb
+- lib/desk/error/service_unavailable.rb
+- lib/desk/error/too_many_requests.rb
+- lib/desk/error/unauthorized.rb
+- lib/desk/error/unprocessable_entity.rb
+- lib/desk/error/unsupported_media_type.rb
+- lib/desk/rate_limit.rb
+- lib/desk/request/retry.rb
+- lib/desk/resource.rb
+- lib/desk/resource/article.rb
+- lib/desk/resource/article_translation.rb
+- lib/desk/resource/attachment.rb
+- lib/desk/resource/case.rb
+- lib/desk/resource/company.rb
+- lib/desk/resource/customer.rb
+- lib/desk/resource/integration_url.rb
+- lib/desk/resource/job.rb
+- lib/desk/resource/label.rb
+- lib/desk/resource/macro.rb
+- lib/desk/resource/macro_action.rb
+- lib/desk/resource/note.rb
+- lib/desk/resource/page.rb
+- lib/desk/resource/reply.rb
+- lib/desk/resource/topic.rb
+- lib/desk/resource/topic_translation.rb
+- lib/desk/resource/user_preference.rb
+- lib/desk/resources.json
+- lib/desk/response/raise_error.rb
+- lib/desk/version.rb
+- spec/cassettes/Desk_Client/_delete/deletes_a_resource.yml
+- spec/cassettes/Desk_Client/_get/fetches_resources.yml
+- spec/cassettes/Desk_Client/_patch/updates_a_resource.yml
+- spec/cassettes/Desk_Client/_post/creates_a_resource.yml
+- spec/cassettes/Desk_Error/_from_response/can_be_created_from_a_faraday_response.yml
+- spec/cassettes/Desk_Error/_from_response/uses_the_body_message_if_present.yml
+- spec/cassettes/Desk_Resource/_by_url/finds_resources_by_url.yml
+- spec/cassettes/Desk_Resource/_create/creates_a_new_topic.yml
+- spec/cassettes/Desk_Resource/_delete/deletes_a_resource.yml
+- spec/cassettes/Desk_Resource/_delete/throws_an_error_deleting_a_non_deletalbe_resource.yml
+- spec/cassettes/Desk_Resource/_exec_/can_be_forced_to_reload.yml
+- spec/cassettes/Desk_Resource/_exec_/loads_the_current_resource.yml
+- spec/cassettes/Desk_Resource/_method_missing/loads_the_resource_to_find_a_suitable_method.yml
+- spec/cassettes/Desk_Resource/_method_missing/raises_an_error_if_method_does_not_exist.yml
+- spec/cassettes/Desk_Resource/_search/allows_searching_on_search_enabled_resources.yml
+- spec/cassettes/Desk_Resource/_update/throws_an_error_updating_a_user.yml
+- spec/cassettes/Desk_Resource/_update/updates_a_topic.yml
+- spec/cassettes/Desk_Resource_Page/_by_id/loads_the_requested_resource.yml
+- spec/cassettes/Desk_Resource_Page/_page/keeps_the_resource_as_loaded.yml
+- spec/cassettes/Desk_Resource_Page/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
+- spec/cassettes/Desk_Resource_Page/_page/sets_the_resource_to_not_loaded.yml
+- spec/desk/client_spec.rb
+- spec/desk/configuration_spec.rb
+- spec/desk/default_spec.rb
+- spec/desk/error_spec.rb
+- spec/desk/rate_limit_spec.rb
+- spec/desk/request/retry_spec.rb
+- spec/desk/resource_spec.rb
+- spec/desk/resources/page_spec.rb
+- spec/desk_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tstachl/desk.rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline--source
+- --title
+- desk.rb
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A lightweight, flexible wrapper for the desk.com REST API.
+test_files:
+- spec/cassettes/Desk_Client/_delete/deletes_a_resource.yml
+- spec/cassettes/Desk_Client/_get/fetches_resources.yml
+- spec/cassettes/Desk_Client/_patch/updates_a_resource.yml
+- spec/cassettes/Desk_Client/_post/creates_a_resource.yml
+- spec/cassettes/Desk_Error/_from_response/can_be_created_from_a_faraday_response.yml
+- spec/cassettes/Desk_Error/_from_response/uses_the_body_message_if_present.yml
+- spec/cassettes/Desk_Resource/_by_url/finds_resources_by_url.yml
+- spec/cassettes/Desk_Resource/_create/creates_a_new_topic.yml
+- spec/cassettes/Desk_Resource/_delete/deletes_a_resource.yml
+- spec/cassettes/Desk_Resource/_delete/throws_an_error_deleting_a_non_deletalbe_resource.yml
+- spec/cassettes/Desk_Resource/_exec_/can_be_forced_to_reload.yml
+- spec/cassettes/Desk_Resource/_exec_/loads_the_current_resource.yml
+- spec/cassettes/Desk_Resource/_method_missing/loads_the_resource_to_find_a_suitable_method.yml
+- spec/cassettes/Desk_Resource/_method_missing/raises_an_error_if_method_does_not_exist.yml
+- spec/cassettes/Desk_Resource/_search/allows_searching_on_search_enabled_resources.yml
+- spec/cassettes/Desk_Resource/_update/throws_an_error_updating_a_user.yml
+- spec/cassettes/Desk_Resource/_update/updates_a_topic.yml
+- spec/cassettes/Desk_Resource_Page/_by_id/loads_the_requested_resource.yml
+- spec/cassettes/Desk_Resource_Page/_page/keeps_the_resource_as_loaded.yml
+- spec/cassettes/Desk_Resource_Page/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
+- spec/cassettes/Desk_Resource_Page/_page/sets_the_resource_to_not_loaded.yml
+- spec/desk/client_spec.rb
+- spec/desk/configuration_spec.rb
+- spec/desk/default_spec.rb
+- spec/desk/error_spec.rb
+- spec/desk/rate_limit_spec.rb
+- spec/desk/request/retry_spec.rb
+- spec/desk/resource_spec.rb
+- spec/desk/resources/page_spec.rb
+- spec/desk_spec.rb
+- spec/spec_helper.rb
+has_rdoc: