desk_api 0.1.3 → 0.5.0

data/spec/spec_helper.rb

@@ -35,7 +35,7 @@ rescue LoadError
 end
 
 VCR.configure do |config|
-  config.hook_into :typhoeus, :faraday
+  config.hook_into :faraday
   config.cassette_library_dir = 'spec/cassettes'
   config.configure_rspec_metadata!
   config.before_record { |i| i.request.headers.delete('Authorization') }

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: desk_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Thomas Stachl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-07 00:00:00.000000000 Z
+date: 2013-12-12 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
@@ -66,20 +52,6 @@ dependencies:
     - - '>='
       - !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
@@ -94,20 +66,6 @@ dependencies:
     - - '>='
       - !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
@@ -195,7 +153,7 @@ dependencies:
 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
+email: thomas@desk.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -214,14 +172,6 @@ files:
 - desk_api.gemspec
 - lib/desk.rb
 - lib/desk_api.rb
-- lib/desk_api/action/create.rb
-- lib/desk_api/action/delete.rb
-- lib/desk_api/action/embeddable.rb
-- lib/desk_api/action/field.rb
-- lib/desk_api/action/link.rb
-- lib/desk_api/action/resource.rb
-- lib/desk_api/action/search.rb
-- lib/desk_api/action/update.rb
 - lib/desk_api/client.rb
 - lib/desk_api/configuration.rb
 - lib/desk_api/default.rb
@@ -235,12 +185,8 @@ files:
 - lib/desk_api/error/gateway_timeout.rb
 - lib/desk_api/error/internal_server_error.rb
 - lib/desk_api/error/method_not_allowed.rb
-- lib/desk_api/error/method_not_supported.rb
 - lib/desk_api/error/not_acceptable.rb
-- lib/desk_api/error/not_embeddable.rb
 - lib/desk_api/error/not_found.rb
-- lib/desk_api/error/not_updateable.rb
-- lib/desk_api/error/parse_error.rb
 - lib/desk_api/error/parser_error.rb
 - lib/desk_api/error/server_error.rb
 - lib/desk_api/error/service_unavailable.rb
@@ -251,32 +197,8 @@ files:
 - lib/desk_api/rate_limit.rb
 - lib/desk_api/request/retry.rb
 - lib/desk_api/resource.rb
-- lib/desk_api/resource/article.rb
-- lib/desk_api/resource/article_translation.rb
-- lib/desk_api/resource/attachment.rb
-- lib/desk_api/resource/case.rb
-- lib/desk_api/resource/company.rb
-- lib/desk_api/resource/customer.rb
-- lib/desk_api/resource/filter.rb
-- lib/desk_api/resource/inbound_mailbox.rb
-- lib/desk_api/resource/integration_url.rb
-- lib/desk_api/resource/job.rb
-- lib/desk_api/resource/label.rb
-- lib/desk_api/resource/macro.rb
-- lib/desk_api/resource/macro_action.rb
-- lib/desk_api/resource/note.rb
-- lib/desk_api/resource/page.rb
-- lib/desk_api/resource/reply.rb
-- lib/desk_api/resource/topic.rb
-- lib/desk_api/resource/topic_translation.rb
-- lib/desk_api/resource/user_preference.rb
-- lib/desk_api/resources.json
 - lib/desk_api/response/raise_error.rb
 - lib/desk_api/version.rb
-- spec/cassettes/DeskApi_Client/_delete/deletes_a_resource.yml
-- spec/cassettes/DeskApi_Client/_get/fetches_resources.yml
-- spec/cassettes/DeskApi_Client/_patch/updates_a_resource.yml
-- spec/cassettes/DeskApi_Client/_post/creates_a_resource.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_delete/deletes_a_resource.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_get/fetches_resources.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_patch/updates_a_resource.yml
@@ -290,30 +212,32 @@ files:
 - spec/cassettes/DeskApi_Error/on_validation_error/allows_access_to_error_hash.yml
 - spec/cassettes/DeskApi_Resource/_by_url/finds_resources_by_url.yml
 - spec/cassettes/DeskApi_Resource/_create/creates_a_new_topic.yml
+- spec/cassettes/DeskApi_Resource/_create/throws_an_error_creating_a_user.yml
 - spec/cassettes/DeskApi_Resource/_delete/deletes_a_resource.yml
 - spec/cassettes/DeskApi_Resource/_delete/throws_an_error_deleting_a_non_deletalbe_resource.yml
 - spec/cassettes/DeskApi_Resource/_exec_/can_be_forced_to_reload.yml
 - spec/cassettes/DeskApi_Resource/_exec_/loads_the_current_resource.yml
+- spec/cassettes/DeskApi_Resource/_find/has_an_alias_by_id.yml
+- spec/cassettes/DeskApi_Resource/_find/loads_the_requested_resource.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/returns_linked_resources.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/returns_nil_if_link_is_nil.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/saves_the_linked_resource_instead_of_the_url.yml
 - spec/cassettes/DeskApi_Resource/_method_missing/loads_the_resource_to_find_a_suitable_method.yml
 - spec/cassettes/DeskApi_Resource/_method_missing/raises_an_error_if_method_does_not_exist.yml
+- spec/cassettes/DeskApi_Resource/_page/keeps_the_resource_as_loaded.yml
+- spec/cassettes/DeskApi_Resource/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
+- spec/cassettes/DeskApi_Resource/_page/sets_the_resource_to_not_loaded.yml
 - spec/cassettes/DeskApi_Resource/_search/allows_searching_on_search_enabled_resources.yml
+- spec/cassettes/DeskApi_Resource/_search/throws_an_error_if_search_is_not_enabled.yml
 - spec/cassettes/DeskApi_Resource/_update/can_update_without_a_hash.yml
 - spec/cassettes/DeskApi_Resource/_update/throws_an_error_updating_a_user.yml
 - spec/cassettes/DeskApi_Resource/_update/updates_a_topic.yml
-- spec/cassettes/DeskApi_Resource_Case/once_closed/can_not_be_updated.yml
-- spec/cassettes/DeskApi_Resource_Page/_find/has_an_alias_by_id.yml
-- spec/cassettes/DeskApi_Resource_Page/_find/loads_the_requested_resource.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/keeps_the_resource_as_loaded.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/sets_the_resource_to_not_loaded.yml
 - spec/desk_api/client_spec.rb
 - spec/desk_api/configuration_spec.rb
 - spec/desk_api/default_spec.rb
 - spec/desk_api/error_spec.rb
 - spec/desk_api/rate_limit_spec.rb
 - spec/desk_api/request/retry_spec.rb
-- spec/desk_api/resource/case_spec.rb
-- spec/desk_api/resource/page_spec.rb
 - spec/desk_api/resource_spec.rb
 - spec/desk_api_spec.rb
 - spec/spec_helper.rb
@@ -342,15 +266,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: A lightweight, flexible wrapper for the desk.com REST API.
 test_files:
-- spec/cassettes/DeskApi_Client/_delete/deletes_a_resource.yml
-- spec/cassettes/DeskApi_Client/_get/fetches_resources.yml
-- spec/cassettes/DeskApi_Client/_patch/updates_a_resource.yml
-- spec/cassettes/DeskApi_Client/_post/creates_a_resource.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_delete/deletes_a_resource.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_get/fetches_resources.yml
 - spec/cassettes/DeskApi_Client/using_Basic_Authentication/_patch/updates_a_resource.yml
@@ -364,30 +284,32 @@ test_files:
 - spec/cassettes/DeskApi_Error/on_validation_error/allows_access_to_error_hash.yml
 - spec/cassettes/DeskApi_Resource/_by_url/finds_resources_by_url.yml
 - spec/cassettes/DeskApi_Resource/_create/creates_a_new_topic.yml
+- spec/cassettes/DeskApi_Resource/_create/throws_an_error_creating_a_user.yml
 - spec/cassettes/DeskApi_Resource/_delete/deletes_a_resource.yml
 - spec/cassettes/DeskApi_Resource/_delete/throws_an_error_deleting_a_non_deletalbe_resource.yml
 - spec/cassettes/DeskApi_Resource/_exec_/can_be_forced_to_reload.yml
 - spec/cassettes/DeskApi_Resource/_exec_/loads_the_current_resource.yml
+- spec/cassettes/DeskApi_Resource/_find/has_an_alias_by_id.yml
+- spec/cassettes/DeskApi_Resource/_find/loads_the_requested_resource.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/returns_linked_resources.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/returns_nil_if_link_is_nil.yml
+- spec/cassettes/DeskApi_Resource/_get_linked_resource/saves_the_linked_resource_instead_of_the_url.yml
 - spec/cassettes/DeskApi_Resource/_method_missing/loads_the_resource_to_find_a_suitable_method.yml
 - spec/cassettes/DeskApi_Resource/_method_missing/raises_an_error_if_method_does_not_exist.yml
+- spec/cassettes/DeskApi_Resource/_page/keeps_the_resource_as_loaded.yml
+- spec/cassettes/DeskApi_Resource/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
+- spec/cassettes/DeskApi_Resource/_page/sets_the_resource_to_not_loaded.yml
 - spec/cassettes/DeskApi_Resource/_search/allows_searching_on_search_enabled_resources.yml
+- spec/cassettes/DeskApi_Resource/_search/throws_an_error_if_search_is_not_enabled.yml
 - spec/cassettes/DeskApi_Resource/_update/can_update_without_a_hash.yml
 - spec/cassettes/DeskApi_Resource/_update/throws_an_error_updating_a_user.yml
 - spec/cassettes/DeskApi_Resource/_update/updates_a_topic.yml
-- spec/cassettes/DeskApi_Resource_Case/once_closed/can_not_be_updated.yml
-- spec/cassettes/DeskApi_Resource_Page/_find/has_an_alias_by_id.yml
-- spec/cassettes/DeskApi_Resource_Page/_find/loads_the_requested_resource.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/keeps_the_resource_as_loaded.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/returns_the_current_page_and_loads_if_page_not_defined.yml
-- spec/cassettes/DeskApi_Resource_Page/_page/sets_the_resource_to_not_loaded.yml
 - spec/desk_api/client_spec.rb
 - spec/desk_api/configuration_spec.rb
 - spec/desk_api/default_spec.rb
 - spec/desk_api/error_spec.rb
 - spec/desk_api/rate_limit_spec.rb
 - spec/desk_api/request/retry_spec.rb
-- spec/desk_api/resource/case_spec.rb
-- spec/desk_api/resource/page_spec.rb
 - spec/desk_api/resource_spec.rb
 - spec/desk_api_spec.rb
 - spec/spec_helper.rb

data/lib/desk_api/action/create.rb

@@ -1,15 +0,0 @@
-module DeskApi
-  module Action
-    module Create
-      module ClassMethods
-        def create(client, path, params)
-          self.new(client, client.post(path, params).body)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end

data/lib/desk_api/action/delete.rb

@@ -1,9 +0,0 @@
-module DeskApi
-  module Action
-    module Delete
-      def delete
-        client.delete(@_links.self.href).status === 204
-      end
-    end
-  end
-end

data/lib/desk_api/action/embeddable.rb

@@ -1,47 +0,0 @@
-require 'desk_api/error/not_embeddable'
-
-module DeskApi
-  module Action
-    module Embeddable
-      attr_reader :embedded
-
-      def embed(*embedds)
-        # make sure we don't try to embed anything that's not defined
-        # add it to the query
-        self.query_params = { embed: embedds.each{ |embed|
-          unless self.base_class.embeddable?(embed)
-            raise DeskApi::Error::NotEmbeddable.new("`#{embed.to_s}' can not be embedded.")
-          end
-        }.join(',') }
-        # return self
-        self
-      end
-
-      def setup_embedded(embedds)
-        if embedds.entries?
-          @records = embedds['entries'].map do |record|
-            resource(record._links.self['class']).new(client, record, true)
-          end 
-        else
-          embedds.each_pair do |key, definition|
-            @_links[key]['resource'] = resource(definition['class']).new @client, definition, true
-          end
-        end
-      end
-
-      module ClassMethods
-        def embeddable(*embeddables)
-          @embeddables = embeddables
-        end
-
-        def embeddable?(key)
-          (@embeddables || []).include?(key.to_sym)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end

data/lib/desk_api/action/field.rb

@@ -1,33 +0,0 @@
-module DeskApi
-  module Action
-    module Field
-    private
-      # Handles the _links part of the HAL response and sets up the associations.
-      # It is used by the client to setup the initial resources like `users`, `cases` and
-      # so on, as well as by the resource object itself for sub resources (`cases.replies`).
-      #
-      # @api private
-      def setup_fields(definition)
-        definition.each_pair do |key, value|
-          next if key[0] == '_'
-          # set the instance variable
-          instance_variable_set(:"@#{key}", value)
-          # create getter
-          (class << self; self; end).send(:define_method, "#{key}") do
-            return @_changed[key] if kind_of?(DeskApi::Action::Update) and @_changed[key]
-            instance_variable_get(:"@#{key}")
-          end
-          # create setter
-          if kind_of?(DeskApi::Action::Update)
-            (class << self; self; end).send(:define_method, "#{key}=") do |value|
-              if instance_variable_get(:"@#{key}") != value
-                @_changed[key] = value
-              end
-              self
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/desk_api/action/link.rb

@@ -1,29 +0,0 @@
-module DeskApi
-  module Action
-    module Link
-    private
-      attr_accessor :_links
-      # Handles the _links part of the HAL response and sets up the associations.
-      # It is used by the client to setup the initial resources like `users`, `cases` and
-      # so on, as well as by the resource object itself for sub resources (`cases.replies`).
-      #
-      # @api private
-      def setup_links(links)
-        @_links = links
-        @_links.each_pair do |method, definition|
-          (class << self; self; end).send(:define_method, ['first', 'last', 'next', 'previous'].include?(method) ? "#{method}_page" : method) do
-            return nil unless definition
-            # return the stored resource if we already loaded it
-            return @_links[method]['resource'] if @_links[method].key?('resource')
-            # this is a really ugly hack but necessary for sub resources which aren't declared consistently
-            definition['class'] = 'page' if method.pluralize == method
-            # get the client
-            client = self.instance_of?(DeskApi::Client) ? self : @client
-            # create the new resource
-            @_links[method]['resource'] = resource(definition['class']).new client, Hashie::Mash.new({ _links: { self: definition } })
-          end
-        end
-      end
-    end
-  end
-end

data/lib/desk_api/action/resource.rb

@@ -1,14 +0,0 @@
-module DeskApi
-  module Action
-    module Resource
-    private
-      def resource(name)
-        require "desk_api/resource/#{name}"
-        "DeskApi::Resource::#{name.classify}".constantize
-      rescue NameError
-      rescue LoadError
-        DeskApi::Resource
-      end
-    end
-  end
-end

data/lib/desk_api/action/search.rb

@@ -1,15 +0,0 @@
-module DeskApi
-  module Action
-    module Search
-      module ClassMethods
-        def search(client, path)
-          client.send(:resource, 'page').new(client, Hashie::Mash.new({ _links: { self: { href: path }}}))
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end

data/lib/desk_api/action/update.rb

@@ -1,17 +0,0 @@
-module DeskApi
-  module Action
-    module Update
-      def update(params = {})
-        if kind_of?(resource('case')) and status == 'closed'
-          raise DeskApi::Error::NotUpdateable
-        end
-
-        params.each_pair do |key, value|
-          send("#{key}=", value) if respond_to?("#{key}=")
-        end
-        
-        setup(client.patch(@_links.self.href, @_changed).body)
-      end
-    end
-  end
-end

data/lib/desk_api/error/method_not_supported.rb

@@ -1,9 +0,0 @@
-require 'desk_api/error'
-
-module DeskApi
-  class Error
-    # Raised when trying to search a resource that doesn't support search
-    class MethodNotSupported < DeskApi::Error
-    end
-  end
-end