desk_api 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa23de82e1ce07590d68a76f0119c95cb9e73a4b
-  data.tar.gz: 666410ec133cd3443c5acc6d40ce4b29f5c53d21
+  metadata.gz: 713992be5f19dc8df200df92c6fe9f5ad5b70d78
+  data.tar.gz: 3ac32cfaaf38ca81753bf778817e2f01b314d3e6
 SHA512:
-  metadata.gz: 0bf1e2029ddb61613d7db4505759177b84e3ce64026a8f0510fbd62223cfe24caa879d50599a10c55e9acb5422dcba2616a64efa3c13308657c7c0f0051fe052
-  data.tar.gz: 9264c470bc23b8a33cd852ceeb49c1c2b8d210316f13d0a9010fca549a4d869c54f77328923b0b0c6cc52dce622bbf7383874c8f202aaf1afa842a85886d66be
+  metadata.gz: 1bc6a19bfe95983cd026f0fdbb6345f47168fd89fc7e1d30918fd810a4f9f456839d58cd9546a1d219befb01d8334be637d7644117a9d60212c8650c31115722
+  data.tar.gz: 95d2944ebeeb92768fa99a617102487f467b9d55cd94e969105461e5adb98f355af7e996c3a3f5adfa9a85151158e484ab7d20a8af97c04a887d9f6b95a5af59

data/README.md

@@ -87,6 +87,30 @@ last_page = previous_page.last
 first_page = last_page.first
 ```
 
+### List params
+
+Some lists allow for additional params like [cases](http://dev.desk.com/API/cases/#list). This allows you to filter the cases endpoint by using a `company_id`, `customer_id` or `filter_id` list param.
+
+```ruby
+# fetch cases for the company with id 1
+companys_cases = DeskApi.cases(company_id: 1)
+
+# fetch cases for the customer with id 1
+customers_cases = DeskApi.cases(customer_id: 1)
+
+# fetch cases for the filter with id 1
+filters_cases = DeskApi.cases(filter_id: 1)
+```
+
+### Sorting
+
+A recent update on APIv2 now imposes a maximum page limit. This is why sorting got very important and now you can even sort the list endpoints like [cases](http://dev.desk.com/API/cases/#list).
+
+```ruby
+# fetch cases sorted by updated_at direction desc
+sorted_cases = DeskApi.cases(sort_field: :updated_at, sort_direction: :desc)
+```
+
 ### Links
 
 Pagination is pretty obvious but the cool part about pagination or rather resources is the auto-linking. As soon as the resource has a link defined, it'll be navigatable:
@@ -96,11 +120,11 @@ Pagination is pretty obvious but the cool part about pagination or rather resour
 customer = DeskApi.cases.entries.first.customer
 
 # who sent the first outbound reply of the first email
-user_name = DeskApi.cases.entries.select{ |my_case| 
-              my_case.type == 'email'
-            }.first.replies.entries.select{ |reply|
-              reply.direction == 'out'
-            }.first.sent_by.name
+user_name = DeskApi.cases.entries.select do |my_case| 
+  my_case.type == 'email'
+end.first.replies.entries.select do |reply|
+  reply.direction == 'out'
+end.first.sent_by.name
 ```
 
 ### Lazy loading

data/desk_api.gemspec

@@ -20,15 +20,13 @@ Gem::Specification.new do |gem|
   gem.extra_rdoc_files  = ['README.md']
   gem.rdoc_options      = ['--line-numbers', '--inline--source', '--title', 'desk.rb']
 
-  gem.add_runtime_dependency('faraday')
-  gem.add_runtime_dependency('faraday_middleware')
-  gem.add_runtime_dependency('simple_oauth')
-  gem.add_runtime_dependency('addressable')
-  gem.add_runtime_dependency('hashie')
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.8.0')
+  gem.add_runtime_dependency('simple_oauth', '~> 0.1')
+  gem.add_runtime_dependency('addressable', '~> 2.3')
 
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('vcr')
-  gem.add_development_dependency('simplecov')
-  gem.add_development_dependency('coveralls')
+  gem.add_development_dependency('rake', '~> 0.9')
+  gem.add_development_dependency('rspec', '~> 2.6')
+  gem.add_development_dependency('vcr', '~> 2.0')
+  gem.add_development_dependency('simplecov', '~> 0.7')
+  gem.add_development_dependency('coveralls', '~> 0.6')
 end

data/lib/desk_api/client.rb

@@ -36,8 +36,10 @@ class DeskApi::Client
 
 private
   # If the method is missing create a resource
-  def method_missing(method, *args, &block)
-    DeskApi::Resource.new(self, DeskApi::Resource.build_self_link("/api/v2/#{method}"))
+  def method_missing(method, params = {}, &block)
+    DeskApi::Resource.new(self, DeskApi::Resource.build_self_link("/api/v2/#{method}")).tap do |res|
+      res.query_params = params
+    end
   end
 
   def request(method, path, params = {})

data/lib/desk_api/configuration.rb

@@ -1,5 +1,6 @@
-require 'faraday'
 require 'faraday_middleware'
+require 'faraday_middleware/version'
+require 'faraday_middleware/response/parse_dates'
 
 require 'desk_api/default'
 require 'desk_api/request/retry'
@@ -37,16 +38,28 @@ module DeskApi::Configuration
 
   def middleware
     @middleware ||= Proc.new do |builder|
-      builder.request :json
-      builder.request :basic_auth, @username, @password if basic_auth.values.all?
-      builder.request :oauth, oauth if oauth.values.all?
-      builder.request :retry
-
-      builder.response :dates
-      builder.response :raise_desk_error, DeskApi::Error::ClientError
-      builder.response :raise_desk_error, DeskApi::Error::ServerError
-      builder.response :json, content_type: /application\/json/
-
+      if Gem::Version.new(FaradayMiddleware::VERSION) >= Gem::Version.new('0.9.0')
+        builder.request :json
+        builder.request :basic_authentication, @username, @password if basic_auth.values.all?
+        builder.request :oauth, oauth if oauth.values.all?
+        builder.request :retry
+
+        builder.response :dates
+        builder.response :raise_desk_error, DeskApi::Error::ClientError
+        builder.response :raise_desk_error, DeskApi::Error::ServerError
+        builder.response :json, content_type: /application\/json/
+      else
+        builder.use FaradayMiddleware::EncodeJson
+        builder.use Faraday::Request::BasicAuthentication, @username, @password if basic_auth.values.all?
+        builder.use FaradayMiddleware::OAuth, oauth if oauth.values.all?
+        builder.use DeskApi::Request::Retry
+
+        builder.use FaradayMiddleware::ParseDates
+        builder.use DeskApi::Response::RaiseError, DeskApi::Error::ClientError
+        builder.use DeskApi::Response::RaiseError, DeskApi::Error::ServerError
+        builder.use FaradayMiddleware::ParseJson, content_type: /application\/json/
+      end
+      
       builder.adapter Faraday.default_adapter
     end
   end

data/lib/desk_api/resource.rb

@@ -1,6 +1,6 @@
 class DeskApi::Resource
   class << self
-    def build_self_link(link)
+    def build_self_link(link, params = {})
       link = {'href'=>link} if link.kind_of?(String)
       {'_links'=>{'self'=>link}}
     end
@@ -76,18 +76,6 @@ class DeskApi::Resource
     end
   end
 
-protected
-
-  def clean_base_url
-    Addressable::URI.parse(href).path.gsub(/\/(search|\d+)$/, '') 
-  end
-
-  def exec!(reload = false)
-    return self if @_loaded and !reload
-    @_definition, @_loaded = @_client.get(href).body, true
-    self
-  end
-
   def query_params
     Addressable::URI.parse(href).query_values || {}
   end
@@ -99,6 +87,8 @@ protected
   def query_params=(params = {})
     return href if params.empty?
 
+    params.keys.each{ |key| params[key] = params[key].join(',') if params[key].is_a?(Array) }
+
     uri = Addressable::URI.parse(href)
     params = (uri.query_values || {}).merge(params)
 
@@ -108,6 +98,18 @@ protected
     self.href = uri.to_s
   end
 
+protected
+
+  def clean_base_url
+    Addressable::URI.parse(href).path.gsub(/\/(search|\d+)$/, '') 
+  end
+
+  def exec!(reload = false)
+    return self if @_loaded and !reload
+    @_definition, @_loaded = @_client.get(href).body, true
+    self
+  end
+
 private
   attr_accessor :_client, :_loaded, :_changed, :_definition
 

data/lib/desk_api/version.rb

@@ -1,3 +1,3 @@
 module DeskApi
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

data/spec/desk_api/resource_spec.rb

@@ -17,6 +17,28 @@ describe DeskApi::Resource do
     it 'sets up the link to self' do
       subject.articles.href.should_not be_nil
     end
+
+    context 'additional options' do
+      it 'allows for sorting options' do
+        cases = subject.cases(sort_field: :updated_at, sort_direction: :asc)
+        cases.href.should eq('/api/v2/cases?sort_direction=asc&sort_field=updated_at')
+      end
+
+      it 'allows to specify arbitrary params' do
+        subject.cases(company_id: 1).href.should eq('/api/v2/cases?company_id=1')
+        subject.cases(customer_id: 1).href.should eq('/api/v2/cases?customer_id=1')
+        subject.cases(filter_id: 1).href.should eq('/api/v2/cases?filter_id=1')
+      end
+
+      it 'allows to specify embeddables' do
+        subject.cases(embed: :customer).href.should eq('/api/v2/cases?embed=customer')
+        subject.cases(embed: [:customer, :assigned_user]).href.should eq('/api/v2/cases?embed=customer%2Cassigned_user')
+      end
+
+      it 'does not automatically load the resource' do
+        subject.cases(company_id: 1).instance_variable_get(:@_loaded).should be_false
+      end
+    end
   end
 
   context '#exec!', :vcr do
@@ -160,9 +182,13 @@ describe DeskApi::Resource do
         @stubs  ||= Faraday::Adapter::Test::Stubs.new
         @client ||= DeskApi::Client.new(DeskApi::CONFIG).tap do |client|
           client.middleware = Proc.new do |builder|
-            builder.response :mashify
-            builder.response :dates
-            builder.response :json, content_type: /application\/json/
+            if Gem::Version.new(FaradayMiddleware::VERSION) >= Gem::Version.new('0.9.0')
+              builder.response :dates
+              builder.response :json, content_type: /application\/json/
+            else
+              builder.use FaradayMiddleware::ParseDates
+              builder.use FaradayMiddleware::ParseJson, content_type: /application\/json/
+            end
             builder.adapter :test, @stubs
           end
         end

metadata

@@ -1,155 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: desk_api
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Thomas Stachl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
-- !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'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !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: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 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.