desk 0.3.1 → 0.3.2

data/HISTORY.mkd

@@ -1,3 +1,9 @@
+0.3.2 February 25, 2013
+------------------
+Support for groups (Thanks to @tstachl)
+Support for max_requests (Thanks to @tstachl)
+New multi_json and multi_xml version
+
 0.3.0 July 15, 2012
 ------------------
 Renamed from Assistly to Desk

data/desk.gemspec

@@ -11,14 +11,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency('simplecov', '~> 0.4')
   s.add_development_dependency('webmock', '~> 1.6')
   s.add_development_dependency('yard', '~> 0.6')
-  s.add_development_dependency('ZenTest', '~> 4.5')
   s.add_runtime_dependency('json', '~> 1.7')  if RUBY_VERSION < '1.9'
   s.add_runtime_dependency('hashie', '~> 1.2.0')
   s.add_runtime_dependency('faraday', '~> 0.8.0')
   s.add_runtime_dependency('faraday_middleware', '~> 0.8.0')
   s.add_runtime_dependency('jruby-openssl', '~> 0.7.2') if RUBY_PLATFORM == 'java'
-  s.add_runtime_dependency('multi_json', '~> 1.3')
-  s.add_runtime_dependency('multi_xml', '~> 0.4.0')
+  s.add_runtime_dependency('multi_json', '~> 1.6')
+  s.add_runtime_dependency('multi_xml', '~> 0.5')
   s.add_runtime_dependency('rash', '~> 0.3.1')
   s.add_runtime_dependency('simple_oauth', '~> 0.1.4')
   s.add_runtime_dependency('pony', '~> 1.1')

data/lib/desk.rb

@@ -6,21 +6,27 @@ require 'pony'
 
 module Desk
   extend Configuration
+  @counter = 0
+  @minute = Time.now.min
 
-  # Alias for Desk::Client.new
-  #
-  # @return [Desk::Client]
-  def self.client(options={})
-    Desk::Client.new(options)
-  end
+  class << self
+    attr_accessor :counter, :minute
+    
+    # Alias for Desk::Client.new
+    #
+    # @return [Desk::Client]
+    def client(options={})
+      Desk::Client.new(options)
+    end
 
-  # Delegate to Desk::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
-  end
+    # Delegate to Desk::Client
+    def method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
 
-  def self.respond_to?(method)
-    client.respond_to?(method) || super
+    def respond_to?(method)
+      client.respond_to?(method) || super
+    end
   end
 end

data/lib/desk/client.rb

@@ -8,6 +8,7 @@ module Desk
     # order to avoid a superclass mismatch error, allowing those modules to be
     # Client-namespaced.
     require 'desk/client/user'
+    require 'desk/client/group'
     require 'desk/client/interaction'
     require 'desk/client/case'
     require 'desk/client/customer'
@@ -18,6 +19,7 @@ module Desk
     alias :api_endpoint :endpoint
 
     include Desk::Client::User
+    include Desk::Client::Group
     include Desk::Client::Interaction
     include Desk::Client::Case
     include Desk::Client::Customer

data/lib/desk/client/group.rb

@@ -0,0 +1,37 @@
+module Desk
+  class Client
+    # Defines methods related to groups
+    module Group
+      # Returns extended information of groups
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Desk.groups
+      #     Desk.groups(:count => 5)
+      #     Desk.groups(:count => 5, :page => 3)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.desk.com/docs/api/groups
+      def groups(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("groups",options)
+        response
+      end
+
+      # Returns extended information on a single group
+      #
+      #   @param id [Integer] a group ID
+      #   @option options [Hash]
+      #   @example Return extended information for 12345
+      #     Desk.group(12345)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.desk.com/docs/api/groups/show
+      def group(id)
+        response = get("groups/#{id}")
+        response.group
+      end
+
+    end
+  end
+end

data/lib/desk/configuration.rb

@@ -10,11 +10,13 @@ module Desk
       :consumer_key,
       :consumer_secret,
       :format,
+      :max_requests,
       :oauth_token,
       :oauth_token_secret,
       :proxy,
       :subdomain,
       :support_email,
+      :use_max_requests,
       :user_agent,
       :version].freeze
 
@@ -39,6 +41,12 @@ module Desk
     #
     # @note JSON is preferred over XML because it is more concise and faster to parse.
     DEFAULT_FORMAT = :json
+    
+    # By default, set the max requests to 60 per minute
+    DEFAULT_MAX_REQUESTS = 60
+
+    # By default, don't use the max request feature
+    DEFAULT_USE_MAX_REQUESTS = false
 
     # By default, don't set a user oauth token
     DEFAULT_OAUTH_TOKEN = nil
@@ -85,11 +93,13 @@ module Desk
       self.consumer_key       = DEFAULT_CONSUMER_KEY
       self.consumer_secret    = DEFAULT_CONSUMER_SECRET
       self.format             = DEFAULT_FORMAT
+      self.max_requests       = DEFAULT_MAX_REQUESTS
       self.oauth_token        = DEFAULT_OAUTH_TOKEN
       self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
       self.proxy              = DEFAULT_PROXY
       self.subdomain          = DEFAULT_SUBDOMAIN
       self.support_email      = DEFAULT_SUPPORT_EMAIL
+      self.use_max_requests   = DEFAULT_USE_MAX_REQUESTS
       self.user_agent         = DEFAULT_USER_AGENT
       self.version            = DEFAULT_VERSION
       self

data/lib/desk/error.rb

@@ -50,6 +50,9 @@ module Desk
       @http_headers.values_at('retry-after', 'Retry-After').detect {|value| value }.to_i
     end
   end
+  
+  # Raised when Desk max_requests is reached and use_max_requests is set to true
+  class TooManyRequests < StandardError; end
 
   # Raised when Desk returns the HTTP status code 500
   class InternalServerError < Error; end

data/lib/desk/request.rb

@@ -22,9 +22,24 @@ module Desk
     end
 
     private
+    
+    def before_request
+      if Desk.minute != Time.now.min
+        Desk.minute = Time.now.min
+        Desk.counter = 0
+      end
+      
+      Desk.counter += 1
+      if Desk.use_max_requests
+        if Desk.counter > Desk.max_requests
+          raise Desk::TooManyRequests
+        end
+      end
+    end
 
     # Perform an HTTP request
     def request(method, path, options, raw=false)
+      before_request
       response = connection(raw).send(method) do |request|
         case method
         when :get, :delete

data/lib/desk/version.rb

@@ -1,4 +1,4 @@
 module Desk
   # The version of the gem
-  VERSION = '0.3.1'.freeze unless defined?(::Desk::VERSION)
+  VERSION = '0.3.2'.freeze unless defined?(::Desk::VERSION)
 end

data/spec/desk/api_spec.rb

@@ -36,9 +36,11 @@ describe Desk::API do
           :oauth_token_secret => 'OS',
           :adapter => :typhoeus,
           :format => :xml,
+          :max_requests => 50,
           :proxy => 'http://erik:sekret@proxy.example.com:8080',
           :subdomain => 'zencoder',
           :support_email => 'help@zencoder.com',
+          :use_max_requests => true,
           :user_agent => 'Custom User Agent',
           :version => "amazing"
         }

data/spec/desk/client/group_spec.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+describe Desk::Client do
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".groups" do
+        context "lookup" do
+          before do
+            stub_get("groups.#{format}").
+              to_return(:body => fixture("groups.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.groups
+            a_get("groups.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 groups worth of extended information" do
+            groups = @client.groups
+            groups.results.should be_a Array
+            groups.results.last.group.id.should == 2
+            groups.results.last.group.name.should == "Administrators"
+          end
+        end
+      end
+
+      describe ".group" do
+        context "lookup" do
+          before do
+            stub_get("groups/1.#{format}").
+              to_return(:body => fixture("group.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.group(1)
+            a_get("groups/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            group = @client.group(1)
+            group.id.should == 1
+            group.name.should == "Sales"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/desk_spec.rb

@@ -98,6 +98,32 @@ describe Desk do
       Desk.format.should == 'xml'
     end
   end
+  
+  describe ".max_requests" do
+    it "should return the default max requests" do
+      Desk.max_requests.should == Desk::Configuration::DEFAULT_MAX_REQUESTS
+    end
+  end
+
+  describe ".max_requests=" do
+    it "should set the max_requests" do
+      Desk.max_requests = 50
+      Desk.max_requests.should == 50
+    end
+  end
+
+  describe ".use_max_requests" do
+    it "should return the default max requests flag" do
+      Desk.use_max_requests.should == Desk::Configuration::DEFAULT_USE_MAX_REQUESTS
+    end
+  end
+
+  describe ".use_max_requests=" do
+    it "should set the use_max_requests flag" do
+      Desk.max_requests = true
+      Desk.max_requests.should == true
+    end
+  end
 
   describe ".user_agent" do
     it "should return the default user agent" do
@@ -124,4 +150,70 @@ describe Desk do
       end
     end
   end
+  
+  describe ".counter" do
+    before do
+      Desk.counter = 0
+      stub_get("cases.json").
+        to_return(:body => fixture("cases.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+    
+    it "should be 0 in the beginning" do
+      Desk.counter.should == 0
+    end
+    
+    it "should count the requests" do
+      5.times {
+        Desk.cases
+      }
+      Desk.counter.should == 5
+    end
+    
+    context "max requests enabled" do
+      before do
+        Desk.use_max_requests = true
+      end
+      
+      it "should only allow 60 requests" do
+        expect {
+          70.times {
+            Desk.cases
+          }
+        }.to raise_error
+      end
+      
+      it "should only allow defined requests" do
+        Desk.max_requests = 50
+        expect {
+          55.times {
+            Desk.cases
+          }
+        }.to raise_error
+      end
+      
+      def make_request
+        Desk.cases
+      rescue Desk::TooManyRequests
+        sleep(5)
+        make_request
+      end
+      
+      xit "should allow more requests after minute has passed" do
+        70.times {
+          make_request
+        }
+        Desk.counter.should == 10
+      end
+    end
+  end
+  
+  describe ".minute" do
+    before do
+      Desk.minute = Time.now.min
+    end
+    
+    it "should be the current minute" do
+      Desk.minute.should == Time.now.min
+    end
+  end
 end

data/spec/fixtures/group.json

@@ -0,0 +1,8 @@
+{
+    "group": {
+        "id": 1,
+        "name": "Sales",
+        "created_at": "2013-01-21T09:47:23Z",
+        "updated_at": "2013-01-21T09:47:23Z"
+    }
+}

data/spec/fixtures/groups.json

@@ -0,0 +1,23 @@
+{
+    "results": [
+        {
+            "group": {
+                "id": 1,
+                "name": "Sales",
+                "created_at": "2013-01-21T09:47:23Z",
+                "updated_at": "2013-01-21T09:47:23Z"
+            }
+        },
+        {
+            "group": {
+                "id": 2,
+                "name": "Administrators",
+                "created_at": "2013-01-21T09:47:23Z",
+                "updated_at": "2013-01-21T09:47:23Z"
+            }
+        }
+    ],
+    "page": 1,
+    "count": 20,
+    "total": 2
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: desk
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Chris Warren
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-22 00:00:00 Z
+date: 2013-02-25 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -138,25 +139,10 @@ dependencies:
         version: "0.6"
   type: :development
   version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 4
-        - 5
-        version: "4.5"
-  type: :development
-  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -167,11 +153,11 @@ dependencies:
         - 7
         version: "1.7"
   type: :runtime
-  version_requirements: *id010
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: hashie
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -183,11 +169,11 @@ dependencies:
         - 0
         version: 1.2.0
   type: :runtime
-  version_requirements: *id011
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: faraday
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -199,11 +185,11 @@ dependencies:
         - 0
         version: 0.8.0
   type: :runtime
-  version_requirements: *id012
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: faraday_middleware
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -215,42 +201,41 @@ dependencies:
         - 0
         version: 0.8.0
   type: :runtime
-  version_requirements: *id013
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: multi_json
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 3
         segments: 
         - 1
-        - 3
-        version: "1.3"
+        - 6
+        version: "1.6"
   type: :runtime
-  version_requirements: *id014
+  version_requirements: *id013
 - !ruby/object:Gem::Dependency 
   name: multi_xml
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 1
         segments: 
         - 0
-        - 4
-        - 0
-        version: 0.4.0
+        - 5
+        version: "0.5"
   type: :runtime
-  version_requirements: *id015
+  version_requirements: *id014
 - !ruby/object:Gem::Dependency 
   name: rash
   prerelease: false
-  requirement: &id016 !ruby/object:Gem::Requirement 
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -262,11 +247,11 @@ dependencies:
         - 1
         version: 0.3.1
   type: :runtime
-  version_requirements: *id016
+  version_requirements: *id015
 - !ruby/object:Gem::Dependency 
   name: simple_oauth
   prerelease: false
-  requirement: &id017 !ruby/object:Gem::Requirement 
+  requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -278,11 +263,11 @@ dependencies:
         - 4
         version: 0.1.4
   type: :runtime
-  version_requirements: *id017
+  version_requirements: *id016
 - !ruby/object:Gem::Dependency 
   name: pony
   prerelease: false
-  requirement: &id018 !ruby/object:Gem::Requirement 
+  requirement: &id017 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -293,7 +278,7 @@ dependencies:
         - 1
         version: "1.1"
   type: :runtime
-  version_requirements: *id018
+  version_requirements: *id017
 description: A Ruby wrapper for the Desk.com REST API
 email: 
 - chris@zencoder.com
@@ -321,6 +306,7 @@ files:
 - lib/desk/client/article.rb
 - lib/desk/client/case.rb
 - lib/desk/client/customer.rb
+- lib/desk/client/group.rb
 - lib/desk/client/interaction.rb
 - lib/desk/client/macro.rb
 - lib/desk/client/topic.rb
@@ -338,6 +324,7 @@ files:
 - spec/desk/client/article_spec.rb
 - spec/desk/client/case_spec.rb
 - spec/desk/client/customer_spec.rb
+- spec/desk/client/group_spec.rb
 - spec/desk/client/interaction_spec.rb
 - spec/desk/client/macro_spec.rb
 - spec/desk/client/topic_spec.rb
@@ -359,6 +346,8 @@ files:
 - spec/fixtures/customer_update.json
 - spec/fixtures/customer_update_email.json
 - spec/fixtures/customers.json
+- spec/fixtures/group.json
+- spec/fixtures/groups.json
 - spec/fixtures/interaction_create.json
 - spec/fixtures/interactions.json
 - spec/fixtures/macro.json
@@ -377,6 +366,7 @@ files:
 - spec/fixtures/user.json
 - spec/fixtures/users.json
 - spec/helper.rb
+has_rdoc: true
 homepage: https://github.com/zencoder/desk
 licenses: []
 
@@ -408,7 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: desk
-rubygems_version: 1.8.24
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Desk.com API
@@ -417,6 +407,7 @@ test_files:
 - spec/desk/client/article_spec.rb
 - spec/desk/client/case_spec.rb
 - spec/desk/client/customer_spec.rb
+- spec/desk/client/group_spec.rb
 - spec/desk/client/interaction_spec.rb
 - spec/desk/client/macro_spec.rb
 - spec/desk/client/topic_spec.rb
@@ -438,6 +429,8 @@ test_files:
 - spec/fixtures/customer_update.json
 - spec/fixtures/customer_update_email.json
 - spec/fixtures/customers.json
+- spec/fixtures/group.json
+- spec/fixtures/groups.json
 - spec/fixtures/interaction_create.json
 - spec/fixtures/interactions.json
 - spec/fixtures/macro.json
@@ -456,4 +449,3 @@ test_files:
 - spec/fixtures/user.json
 - spec/fixtures/users.json
 - spec/helper.rb
-has_rdoc: