desk_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b7e54656d496540b4dca275b4288ee34341b3c6
-  data.tar.gz: fadb4549ca2e30c77e92fa0f74aece67f9176ce6
+  metadata.gz: 707504b6574f986733536a110fcb6e62d9e21fdc
+  data.tar.gz: 83018510d73d59c23fc2e867729a9317939d1ab0
 SHA512:
-  metadata.gz: a14e59d2749dab344223176662a5d20b262d12e010247a76dd04e1a4964dd311fb58e419b1d358eeb5386dd0e11a163df1c5874f84b97591c0a6e2f9fe65ff42
-  data.tar.gz: 2be5d5583bfc5735e010444a06e4b1d220dc12da470c498240a29c0ac9ed8ffeeec64cc249f06227787d53e9fdaff8ad02a01193569d54f0414ca707ecc3030b
+  metadata.gz: cc4d3a9536f1e49d1d0ff7d9d860e8e9a897bc718f663682bd103fd1dc3db06ed52a1637ada19431af765160fa40c03cdf19bcf68184cb37aee8348a1a20a3bd
+  data.tar.gz: de81f51bc700975c8ed46394fa47b13a69e420a1f2c86e6665fa48d201fa1e139ee94f93f6ec9c76b643efbdd2dbf0230924b1b4cf20964ef8edf46a5b3bb24a

data/README.md

@@ -1,12 +1,27 @@
-# desk.com APIv2 [![Build Status](https://secure.travis-ci.org/tstachl/desk.png)](http://travis-ci.org/tstachl/desk) [![Coverage Status](https://coveralls.io/repos/tstachl/desk/badge.png)](https://coveralls.io/r/tstachl/desk) [![Dependency Status](https://gemnasium.com/tstachl/desk.png)](https://gemnasium.com/tstachl/desk)
+# desk.com APIv2 [![Build Status](https://secure.travis-ci.org/tstachl/desk.png)](http://travis-ci.org/tstachl/desk) [![Coverage Status](https://coveralls.io/repos/tstachl/desk/badge.png?branch=develop)](https://coveralls.io/r/tstachl/desk?branch=develop) [![Dependency Status](https://gemnasium.com/tstachl/desk.png)](https://gemnasium.com/tstachl/desk)
 
 desk.com has released v2 of their REST API a few months ago and provides a lot more functionality. You should read up on the current progress of the [API](http://dev.desk.com/API/changelog). This library wraps all of it into an easy to use ruby module. We'll try to keep up with the changes of the API but things might still break unexpectedly.
 
+## Installation
+
+```ruby
+gem install desk_api
+```
+
 ## Example
 This example shows you how to create a new client and establish a connection to the API. It shows the four request methods supported by the desk.com API (`GET`, `POST`, `PATCH` and `DELETE`).
 
 ```ruby
-client = Desk::Client.new username: 'thomas@example.com', password: 'somepassword', subdomain: 'devel'
+# Basic Auth
+client = DeskApi::Client.new username: 'thomas@example.com', password: 'somepassword', subdomain: 'devel'
+# OAuth
+client = DeskApi::Client.new({
+  token: 'TOKEN',
+  token_secret: 'TOKEN_SECRET',
+  consumer_key: 'CONSUMER_KEY',
+  consumer_secret: 'CONSUMER_SECRET',
+  subdomain: 'devel'
+})
 
 response = client.get '/api/v2/topics'
 response = client.post '/api/v2/topics', name: 'My new Topic', allow_questions: true
@@ -17,16 +32,16 @@ response = client.delete '/api/v2/topics/1'
 For ease of use and if you only create one connection to the desk.com API you can use `Desk` directly:
 
 ```ruby
-Desk.configure do |config|
+DeskApi.configure do |config|
   config.username = 'thomas@example.com'
   config.password = 'somepassword'
   config.subdomain = 'devel'
 end
 
-Desk.get '/api/v2/topics'
-Desk.post '/api/v2/topics', name: 'My new Topic', allow_questions: true
-Desk.patch '/api/v2/topics/1', name: 'Changed the Topic Name'
-Desk.delete '/api/v2/topics/1'
+DeskApi.get '/api/v2/topics'
+DeskApi.post '/api/v2/topics', name: 'My new Topic', allow_questions: true
+DeskApi.patch '/api/v2/topics/1', name: 'Changed the Topic Name'
+DeskApi.delete '/api/v2/topics/1'
 ```
 
 ## Working with Resources and Collections
@@ -36,10 +51,10 @@ The API supports RESTful resources and so does this wrapper. Those resources are
 ### Finders
 ```ruby
 # get the first user and find a case by url.
-found_case = Desk.users.first.by_url '/api/v2/cases/1'
+found_case = DeskApi.users.first.by_url '/api/v2/cases/1'
 
 # find a case by case number
-found_case = Desk.cases.by_id 1
+found_case = DeskApi.cases.by_id 1
 ```
 
 ### Pagination
@@ -47,7 +62,7 @@ found_case = Desk.cases.by_id 1
 As mentioned above you can also navigate between resources and mainly pages of collections.
 
 ```ruby
-cases = Desk.cases
+cases = DeskApi.cases
 cases.each do |my_case|
   # do something with the case
 end
@@ -70,9 +85,9 @@ Pagination is pretty obvious but the cool part about pagination or rather resour
 
 ```ruby
 # get the customer of the first case of the first page
-customer = Desk.cases.first.customer
+customer = DeskApi.cases.first.customer
 # who sent the first outbound reply of the first email
-user_name = Desk.cases.select{ |my_case| 
+user_name = DeskApi.cases.select{ |my_case| 
               my_case.type == 'email'
             }.first.replies.select{ |reply|
               reply.direction == 'out'
@@ -81,29 +96,29 @@ user_name = Desk.cases.select{ |my_case|
 
 ### Lazy loading
 
-Collections and resources in general are lazily loaded, meaning if you request the cases `Desk.cases` no actual request will be set off until you actually request data. This makes sure only necessary requests are fired and which keeps the overall requests low and spares the [desk.com rate limit](http://dev.desk.com/API/using-the-api/#rate-limits).
+Collections and resources in general are lazily loaded, meaning if you request the cases `DeskApi.cases` no actual request will be set off until you actually request data. This makes sure only necessary requests are fired and which keeps the overall requests low and spares the [desk.com rate limit](http://dev.desk.com/API/using-the-api/#rate-limits).
 
 ```ruby
-Desk.cases.page(10).per_page(50).each do |my_case|
+DeskApi.cases.page(10).per_page(50).each do |my_case|
   # in this method chain `.each' is the first method that acutally sends a request
 end
 
 # however if you request the current page numer and the resource is not loaded
 # it'll send a request
-Desk.cases.page == 1
+DeskApi.cases.page == 1
 ```
 
 ### Create, Update and Delete
 
-Of course we support creating, updating and deleting resources but not all resources can be deleted or updated or created, if that's the case for the resource you're trying to update, it'll throw a `Desk::Error::MethodNotSupported` error. The specific method won't be defined on the resource either `Desk.cases.first.respond_to?(:delete) == false`.
+Of course we support creating, updating and deleting resources but not all resources can be deleted or updated or created, if that's the case for the resource you're trying to update, it'll throw a `DeskApi::Error::MethodNotSupported` error. The specific method won't be defined on the resource either `DeskApi.cases.first.respond_to?(:delete) == false`.
 
 ```ruby
 # let's create an article
-new_article = Desk.articles.create({
+new_article = DeskApi.articles.create({
                 subject: 'Some Subject',
                 body: 'Some Body',
                 _links: {
-                  topic: Desk.topics.first.get_self
+                  topic: DeskApi.topics.first.get_self
                 }
               })
 
@@ -120,8 +135,8 @@ end
 
 # ATTENTION: Cases can not be deleted!
 begin
-  Desk.cases.first.delete
-rescue Desk::Error::MethodNotSupported => e
+  DeskApi.cases.first.delete
+rescue DeskApi::Error::MethodNotSupported => e
   # too bad
 end
 ```
@@ -131,7 +146,7 @@ end
 As you have seen in prior examples for each field on the resource we create a getter and setter. Be careful if a resource is not updatable it won't have a setter specified.
 
 ```ruby
-customer = Desk.customers.by_id(1)
+customer = DeskApi.customers.by_id(1)
 
 puts customer.first_name
 puts customer.last_name
@@ -146,28 +161,28 @@ updated_customer = customer.update title: 'Master of the Universe'
 
 # users are not updatable
 begin
-  user = Desk.users.first
+  user = DeskApi.users.first
   user.name = 'Not updateable'
-rescue Desk::Error::MethodNotSupported
+rescue DeskApi::Error::MethodNotSupported
   # too bad
 end
 ```
 
 ### API Errors
 
-Sometimes the API is going to return errors, eg. Validation Error. In these cases we wrap the API error into a `Desk::Error`. Here are the common errors:
+Sometimes the API is going to return errors, eg. Validation Error. In these cases we wrap the API error into a `DeskApi::Error`. Here are the common errors:
 
 ```ruby
-Desk::Error::BadRequest             #=> 400 Status
-Desk::Error::Unauthorized           #=> 401 Status
-Desk::Error::Forbidden              #=> 403 Status
-Desk::Error::NotFound               #=> 404 Status
-Desk::Error::MethodNotAllowed       #=> 405 Status
-Desk::Error::NotAcceptable          #=> 406 Status
-Desk::Error::Conflict               #=> 409 Status
-Desk::Error::UnsupportedMediaType   #=> 415 Status
-Desk::Error::UnprocessableEntity    #=> 422 Status
-Desk::Error::TooManyRequests        #=> 429 Status
+DeskApi::Error::BadRequest             #=> 400 Status
+DeskApi::Error::Unauthorized           #=> 401 Status
+DeskApi::Error::Forbidden              #=> 403 Status
+DeskApi::Error::NotFound               #=> 404 Status
+DeskApi::Error::MethodNotAllowed       #=> 405 Status
+DeskApi::Error::NotAcceptable          #=> 406 Status
+DeskApi::Error::Conflict               #=> 409 Status
+DeskApi::Error::UnsupportedMediaType   #=> 415 Status
+DeskApi::Error::UnprocessableEntity    #=> 422 Status
+DeskApi::Error::TooManyRequests        #=> 429 Status
 ```
 
 Please also have a look at all [desk.com API errors](http://dev.desk.com/API/using-the-api/#status-codes) and their respective meanings.

data/config.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   CONFIG = {
     username: 'tstachl@salesforce.com',
     password: '253e6745',

data/desk_api.gemspec

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'desk/version'
+require 'desk_api/version'
 
 Gem::Specification.new do |gem|
   gem.name              = 'desk_api'
   gem.summary           = 'A lightweight, flexible wrapper for the desk.com REST API.'
   gem.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.'
-  gem.homepage          = 'http://github.com/tstachl/desk.rb'
-  gem.version           = Desk::VERSION
+  gem.homepage          = 'http://github.com/tstachl/desk'
+  gem.version           = DeskApi::VERSION
 
   gem.authors           = ['Thomas Stachl']
   gem.email             = 'tom@desk.com'

data/lib/desk.rb

@@ -1,35 +1 @@
-require 'uri'
-require 'json'
-require 'forwardable'
-require 'addressable/uri'
-
-require 'hashie/mash'
-require 'active_support/inflector'
-
-require 'desk/configuration'
-require 'desk/client'
-require 'desk/version'
-
-module Desk
-  class << self
-    include Desk::Configuration
-
-    # Delegate to a Desk::Client
-    #
-    # @return [Desk::Client]
-    def client
-      return @client if instance_variable_defined?(:@client) && @client.hash == options.hash
-      @client = Desk::Client.new(options)
-    end
-
-    def method_missing(method_name, *args, &block)
-      return super unless respond_to_missing?(method_name)
-      client.send(method_name, *args, &block)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      client.respond_to?(method_name, include_private)
-    end
-  end
-  setup
-end
+require File.dirname(__FILE__) + '/desk_api'

data/lib/desk_api.rb

@@ -0,0 +1,35 @@
+require 'uri'
+require 'json'
+require 'forwardable'
+require 'addressable/uri'
+
+require 'hashie/mash'
+require 'active_support/inflector'
+
+require 'desk_api/configuration'
+require 'desk_api/client'
+require 'desk_api/version'
+
+module DeskApi
+  class << self
+    include DeskApi::Configuration
+
+    # Delegate to a DeskApi::Client
+    #
+    # @return [DeskApi::Client]
+    def client
+      return @client if instance_variable_defined?(:@client) && @client.hash == options.hash
+      @client = DeskApi::Client.new(options)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless respond_to_missing?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+  end
+  setup
+end

data/lib/{desk → desk_api}/action/create.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Create
       module ClassMethods

data/lib/{desk → desk_api}/action/delete.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Delete
       def delete

data/lib/{desk → desk_api}/action/embedded.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Embedded
     protected

data/lib/{desk → desk_api}/action/field.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Field
     protected
@@ -14,11 +14,11 @@ module Desk
           instance_variable_set(:"@#{key}", value)
           # create getter
           (class << self; self; end).send(:define_method, "#{key}") do
-            return @_changed[key] if kind_of?(Desk::Action::Update) and @_changed[key]
+            return @_changed[key] if kind_of?(DeskApi::Action::Update) and @_changed[key]
             instance_variable_get(:"@#{key}")
           end
           # create setter
-          if kind_of?(Desk::Action::Update)
+          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

data/lib/{desk → desk_api}/action/link.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Link
     protected
@@ -18,7 +18,7 @@ module Desk
             # 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?(Desk::Client) ? self : self.client
+            client = self.instance_of?(DeskApi::Client) ? self : self.client
             # create the new resource
             @_links[method]['resource'] = resource(definition['class']).new client, Hashie::Mash.new({ _links: { self: definition } })
           end

data/lib/desk_api/action/resource.rb

@@ -0,0 +1,14 @@
+module DeskApi
+  module Action
+    module Resource
+    protected
+      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 → desk_api}/action/search.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Action
     module Search
       module ClassMethods

data/lib/{desk → desk_api}/action/update.rb

@@ -1,7 +1,7 @@
-module Desk
+module DeskApi
   module Action
     module Update
-      def update(params)
+      def update(params = {})
         params.each_pair do |key, value|
           send("#{key}=", value) if respond_to?("#{key}=")
         end

data/lib/{desk → desk_api}/client.rb

@@ -1,26 +1,26 @@
 require 'faraday'
 
-require 'desk/configuration'
-require 'desk/action/link'
-require 'desk/action/resource'
-require 'desk/error/client_error'
-require 'desk/error/parse_error'
+require 'desk_api/configuration'
+require 'desk_api/action/link'
+require 'desk_api/action/resource'
+require 'desk_api/error/client_error'
+require 'desk_api/error/parse_error'
 
-require 'desk/resource'
+require 'desk_api/resource'
 
-module Desk
+module DeskApi
   class Client
-    include Desk::Configuration
-    include Desk::Action::Link
-    include Desk::Action::Resource
+    include DeskApi::Configuration
+    include DeskApi::Action::Link
+    include DeskApi::Action::Resource
 
     # Initializes a new Client object
     #
     # @param options [Hash]
-    # @return [Desk::Client]
+    # @return [DeskApi::Client]
     def initialize(options = {})
-      Desk::Configuration.keys.each do |key|
-        instance_variable_set(:"@#{key}", options[key] || Desk.instance_variable_get(:"@#{key}"))
+      DeskApi::Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || DeskApi.instance_variable_get(:"@#{key}"))
       end
 
       # load the initial resources (should actually be a call to /api/v2 but not yet)
@@ -55,9 +55,9 @@ module Desk
     def request(method, path, params = {})
       connection.send(method, path, params)
     rescue Faraday::Error::ClientError
-      raise Desk::Error::ClientError
+      raise DeskApi::Error::ClientError
     rescue JSON::ParserError
-      raise Desk::Error::ParserError
+      raise DeskApi::Error::ParserError
     end
 
     def connection

data/lib/{desk → desk_api}/configuration.rb

@@ -4,14 +4,14 @@ require 'faraday_middleware'
 require 'typhoeus'
 require 'typhoeus/adapters/faraday'
 
-require 'desk/default'
-require 'desk/request/retry'
-require 'desk/response/raise_error'
-require 'desk/error/configuration_error'
-require 'desk/error/client_error'
-require 'desk/error/server_error'
-
-module Desk
+require 'desk_api/default'
+require 'desk_api/request/retry'
+require 'desk_api/response/raise_error'
+require 'desk_api/error/configuration_error'
+require 'desk_api/error/client_error'
+require 'desk_api/error/server_error'
+
+module DeskApi
   module Configuration
     extend Forwardable
     attr_writer :consumer_secret, :token, :token_secret, :password
@@ -48,8 +48,8 @@ module Desk
 
         builder.response :mashify
         builder.response :dates
-        builder.response :raise_error, Desk::Error::ClientError
-        builder.response :raise_error, Desk::Error::ServerError
+        builder.response :raise_error, DeskApi::Error::ClientError
+        builder.response :raise_error, DeskApi::Error::ServerError
         builder.response :json, content_type: /application\/json/
 
         builder.adapter :typhoeus
@@ -64,8 +64,8 @@ module Desk
     end
 
     def reset!
-      Desk::Configuration.keys.each do |key|
-        send("#{key}=", Desk::Default.options[key])
+      DeskApi::Configuration.keys.each do |key|
+        send("#{key}=", DeskApi::Default.options[key])
       end
       self
     end
@@ -78,7 +78,7 @@ module Desk
   private
     # @return [Hash]
     def options
-      Hash[Desk::Configuration.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+      Hash[DeskApi::Configuration.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
     end
 
     def oauth