zendesk_api 0.3.14 → 0.4.0.rc1

data/lib/zendesk_api/association.rb

@@ -41,7 +41,7 @@ module ZendeskAPI
         namespace[1..1] = parent_namespace if parent_namespace
         namespace[0] = parent_class.resource_name
       else
-        namespace[0] = @options.path || @options[:class].resource_name
+        namespace[0] = @options.path || @options[:class].resource_path
       end
 
       if id = extract_id(instance, options, original_options)

data/lib/zendesk_api/associations.rb

@@ -30,8 +30,6 @@ module ZendeskAPI
 
     # @private
     module ClassMethods
-      include Rescue
-
       def self.extended(klass)
         klass.extend Has
         klass.extend HasMany
@@ -112,10 +110,8 @@ module ZendeskAPI
             elsif found = method_missing(association[:name].to_sym)
               wrap_resource(found, association, :include_key => association[:include_key])
             elsif klass.superclass == DataResource && !association[:inline]
-              rescue_client_error do
-                response = @client.connection.get(instance_association.generate_path(:with_parent => true))
-                klass.new(@client, response.body[klass.singular_resource_name].merge(:association => instance_association))
-              end
+              response = @client.connection.get(instance_association.generate_path(:with_parent => true))
+              klass.new(@client, response.body[klass.singular_resource_name].merge(:association => instance_association))
             end
 
             send("#{association[:id_column]}=", resource.id) if resource && has_key?(association[:id_column])

data/lib/zendesk_api/client.rb

@@ -2,7 +2,6 @@ require 'faraday'
 require 'faraday_middleware'
 
 require 'zendesk_api/version'
-require 'zendesk_api/rescue'
 require 'zendesk_api/sideloading'
 require 'zendesk_api/configuration'
 require 'zendesk_api/collection'
@@ -14,14 +13,13 @@ require 'zendesk_api/middleware/response/callback'
 require 'zendesk_api/middleware/response/deflate'
 require 'zendesk_api/middleware/response/gzip'
 require 'zendesk_api/middleware/response/parse_iso_dates'
+require 'zendesk_api/middleware/response/raise_error'
 require 'zendesk_api/middleware/response/logger'
 
 module ZendeskAPI
   # The top-level class that handles configuration and connection to the Zendesk API.
   # Can also be used as an accessor to resource collections.
   class Client
-    include Rescue
-
     # @return [Configuration] Config instance
     attr_reader :config
     # @return [Array] Custom response callbacks
@@ -57,8 +55,6 @@ module ZendeskAPI
       @current_account = Hashie::Mash.new(connection.get('account/resolve').body)
     end
 
-    rescue_client_error :current_account
-
     # Returns the current locale
     # @return [ZendeskAPI::Locale] Current locale or nil
     def current_locale(reload = false)
@@ -86,6 +82,7 @@ module ZendeskAPI
       config.retry = !!config.retry # nil -> false
 
       set_token_auth
+
       set_default_logger
       add_warning_callback
     end
@@ -125,8 +122,7 @@ module ZendeskAPI
     def build_connection
       Faraday.new(config.options) do |builder|
         # response
-        builder.use Faraday::Request::BasicAuthentication, config.username, config.password
-        builder.use Faraday::Response::RaiseError
+        builder.use ZendeskAPI::Middleware::Response::RaiseError
         builder.use ZendeskAPI::Middleware::Response::Callback, self
         builder.use ZendeskAPI::Middleware::Response::Logger, config.logger if config.logger
         builder.use ZendeskAPI::Middleware::Response::ParseIsoDates
@@ -140,10 +136,13 @@ module ZendeskAPI
         end
 
         # request
-        if config.cache
-          builder.use ZendeskAPI::Middleware::Request::EtagCache, :cache => config.cache
+        if config.access_token
+          builder.authorization("Bearer", config.access_token)
+        else
+          builder.use Faraday::Request::BasicAuthentication, config.username, config.password
         end
 
+        builder.use ZendeskAPI::Middleware::Request::EtagCache, :cache => config.cache
         builder.use ZendeskAPI::Middleware::Request::Upload
         builder.request :multipart
         builder.request :json

data/lib/zendesk_api/collection.rb

@@ -10,8 +10,6 @@ module ZendeskAPI
     # Options passed in that are automatically converted from an array to a comma-separated list.
     SPECIALLY_JOINED_PARAMS = [:ids, :only]
 
-    include Rescue
-
     # @return [ZendeskAPI::Association] The class association
     attr_reader :association
 
@@ -45,29 +43,21 @@ module ZendeskAPI
       end
     end
 
-    # Passes arguments and the proper path to the resource class method.
-    # @param [Hash] attributes Attributes to pass to Create#create
-    def create(attributes = {})
-      attributes.merge!(:association => @association)
-      @resource_class.create(@client, @options.merge(attributes))
-    end
+    methods = %w{create find update destroy}
+    methods += methods.map {|method| method + "!"}
+    methods.each do |deferrable|
+      # Passes arguments and the proper path to the resource class method.
+      # @param [Hash] options Options or attributes to pass
+      define_method deferrable do |*args|
+        unless @resource_class.respond_to?(deferrable)
+          raise NoMethodError.new("undefined method \"#{deferrable}\" for #{@resource_class}", deferrable, args)
+        end
 
-    # (see #create)
-    def find(opts = {})
-      opts.merge!(:association => @association)
-      @resource_class.find(@client, @options.merge(opts))
-    end
+        opts = args.last.is_a?(Hash) ? args.pop : {}
+        opts.merge!(:association => @association)
 
-    # (see #create)
-    def update(opts = {})
-      opts.merge!(:association => @association)
-      @resource_class.update(@client, @options.merge(opts))
-    end
-
-    # (see #create)
-    def destroy(opts = {})
-      opts.merge!(:association => association)
-      @resource_class.destroy(@client, @options.merge(opts))
+        @resource_class.send(deferrable, @client, @options.merge(opts))
+      end
     end
 
     # @return [Number] The total number of resources server-side (disregarding pagination).
@@ -76,6 +66,12 @@ module ZendeskAPI
       @count || -1
     end
 
+    # @return [Number] The total number of resources server-side (disregarding pagination).
+    def count!
+      fetch!
+      @count || -1
+    end
+
     # Changes the per_page option. Returns self, so it can be chained. No execution.
     # @return [Collection] self
     def per_page(count)
@@ -103,17 +99,13 @@ module ZendeskAPI
     # Saves all newly created resources stored in this collection.
     # @return [Collection] self
     def save
-      if @resources
-        @resources.map! do |item|
-          unless !item.respond_to?(:save) || item.changes.empty?
-            item.save
-          end
-
-          item
-        end
-      end
+      _save
+    end
 
-      self
+    # Saves all newly created resources stored in this collection.
+    # @return [Collection] self
+    def save!
+      _save(:save!)
     end
 
     # Adds an item (or items) to the list of side-loaded resources to request
@@ -146,7 +138,7 @@ module ZendeskAPI
 
     # Executes actual GET from API and loads resources into proper class.
     # @param [Boolean] reload Whether to disregard cache
-    def fetch(reload = false)
+    def fetch!(reload = false)
       if @resources && (!@fetchable || !reload)
         return @resources
       elsif association && association.options.parent && association.options.parent.new_record?
@@ -160,32 +152,42 @@ module ZendeskAPI
       @resources
     end
 
-    rescue_client_error :fetch, :with => lambda { Array.new }
+    def fetch(*args)
+      fetch!(*args)
+    rescue Faraday::Error::ClientError => e
+      []
+    end
 
     # Alias for fetch(false)
     def to_a
       fetch
     end
 
+    # Alias for fetch!(false)
+    def to_a!
+      fetch!
+    end
+
     # Calls #each on every page with the passed in block
     # @param [Block] block Passed to #each
-    def each_page(start_page = @options["page"], &block)
-      page(start_page)
-      clear_cache
-
-      while !empty?
-        each do |resource|
-          arguments = [resource, @options["page"] || 1]
+    def all!(start_page = @options["page"], &block)
+      _all(start_page, :bang, &block)
+    end
 
-          if block.arity >= 0
-            arguments = arguments.take(block.arity)
-          end
+    # Calls #each on every page with the passed in block
+    # @param [Block] block Passed to #each
+    def all(start_page = @options["page"], &block)
+      _all(start_page, &block)
+    end
 
-          block.call(*arguments)
-        end
+    def each_page!(*args, &block)
+      warn "ZendeskAPI::Collection#each_page! is deprecated, please use ZendeskAPI::Collection#all!"
+      all!(*args, &block)
+    end
 
-        self.next
-      end
+    def each_page(*args, &block)
+      warn "ZendeskAPI::Collection#each_page is deprecated, please use ZendeskAPI::Collection#all"
+      all(*args, &block)
     end
 
     # Replaces the current (loaded or not) resources with the passed in collection
@@ -234,7 +236,6 @@ module ZendeskAPI
       @count = nil
       @next_page = nil
       @prev_page = nil
-      @query = nil
     end
 
     # @private
@@ -278,6 +279,39 @@ module ZendeskAPI
       end
     end
 
+    def _all(start_page = @options["page"], bang = false, &block)
+      page(start_page)
+      clear_cache
+
+      while (bang ? fetch! : fetch) && !empty?
+        each do |resource|
+          arguments = [resource, @options["page"] || 1]
+
+          if block.arity >= 0
+            arguments = arguments.take(block.arity)
+          end
+
+          block.call(*arguments)
+        end
+
+        self.next
+      end
+    end
+
+    def _save(method = :save)
+      if @resources
+        @resources.map! do |item|
+          if item.respond_to?(method) && !item.changes.empty?
+            item.send(method)
+          end
+
+          item
+        end
+      end
+
+      self
+    end
+
     ## Initialize
 
     def join_special_params

data/lib/zendesk_api/configuration.rb

@@ -28,6 +28,9 @@ module ZendeskAPI
     # @return [Boolean] Whether to allow non-HTTPS connections for development purposes.
     attr_accessor :allow_http
 
+    # @return [String] OAuth2 access_token
+    attr_accessor :access_token
+
     # Use this cache instead of default ZendeskAPI::LRUCache.new
     # - must respond to read/write/fetch e.g. ActiveSupport::Cache::MemoryStore.new)
     # - pass false to disable caching
@@ -36,6 +39,7 @@ module ZendeskAPI
 
     def initialize
       @client_options = {}
+
       self.cache = ZendeskAPI::LRUCache.new(1000)
     end
 

data/lib/zendesk_api/error.rb

@@ -0,0 +1,22 @@
+module ZendeskAPI
+  module Error
+    class ClientError < Faraday::Error::ClientError; end
+
+    class RecordInvalid < ClientError
+      attr_accessor :response, :errors
+
+      def initialize(response)
+        @response = response
+
+        if response[:body].is_a?(Hash) && response[:body].key?("details")
+          @errors = response[:body]["details"]
+        else
+          @errors = {}
+        end
+      end
+    end
+
+    class NetworkError < ClientError; end
+    class RecordNotFound < ClientError; end
+  end
+end

data/lib/zendesk_api/middleware/request/etag_cache.rb

@@ -30,13 +30,7 @@ module ZendeskAPI
 
           @app.call(env).on_complete do
             if cached && env[:status] == 304 # not modified
-              env[:body] = cached[:body]
-              env[:response_headers].merge!(
-                :etag => cached[:response_headers][:etag],
-                :content_type => cached[:response_headers][:content_type],
-                :content_length => cached[:response_headers][:content_length],
-                :content_encoding => cached[:response_headers][:content_encoding]
-              )
+              env.merge!(:body => cached[:body], :response_headers => cached[:response_headers])
             elsif env[:status] == 200 && env[:response_headers]["Etag"] # modified and cacheable
               @cache.write(cache_key(env), env)
             end

data/lib/zendesk_api/middleware/request/upload.rb

@@ -38,7 +38,6 @@ module ZendeskAPI
           else
             if defined?(ActionDispatch) && file.is_a?(ActionDispatch::Http::UploadedFile)
               path = file.tempfile.path
-              mime_type = file.content_type
             else
               warn "WARNING: Passed invalid filename #{file} of type #{file.class} to upload"
             end
@@ -50,7 +49,7 @@ module ZendeskAPI
               hash = hash[key]
             end
 
-            mime_type ||= MIME::Types.type_for(path).first || "application/octet-stream"
+            mime_type = MIME::Types.type_for(path).first || "application/octet-stream"
 
             hash[:filename] ||= if file.respond_to?(:original_filename)
               file.original_filename

data/lib/zendesk_api/middleware/response/raise_error.rb

@@ -0,0 +1,20 @@
+require 'zendesk_api/error'
+
+module ZendeskAPI
+  module Middleware
+    module Response
+      class RaiseError < Faraday::Response::RaiseError
+        def on_complete(env)
+          case env[:status]
+          when 404
+            raise Error::RecordNotFound.new(env)
+          when 422
+            raise Error::RecordInvalid.new(env)
+          when 400...600
+            raise Error::NetworkError.new(env)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/resource.rb

@@ -9,7 +9,6 @@ module ZendeskAPI
   # Represents a resource that only holds data.
   class Data
     include Associations
-    include Rescue
 
     class << self
       def inherited(klass)
@@ -30,6 +29,10 @@ module ZendeskAPI
         @resource_name ||= Inflection.plural(singular_resource_name)
       end
 
+      def resource_path
+        [@namespace, resource_name].compact.join("/")
+      end
+
       alias :model_key :resource_name
 
       # @private
@@ -41,13 +44,18 @@ module ZendeskAPI
       def unnested_params
         @unnested_params ||= false
       end
+
+      def namespace(namespace)
+        @namespace = namespace
+      end
     end
 
     # @return [Hash] The resource's attributes
     attr_reader :attributes
     # @return [ZendeskAPI::Association] The association
     attr_accessor :association
-
+    # @return [Array] The last received errors
+    attr_accessor :errors
     # Place to dump the last response
     attr_accessor :response
 
@@ -111,11 +119,21 @@ module ZendeskAPI
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
-      warn "Trying to compare #{other.class} to a Resource from #{caller.first}" if other && !other.is_a?(Data)
-      other.is_a?(self.class) && ((other.id && other.id == id) || (other.object_id == self.object_id))
+      return true if other.object_id == self.object_id
+
+      if other && !(other.is_a?(Data) || other.is_a?(Integer))
+        warn "Trying to compare #{other.class} to a Resource from #{caller.first}"
+      end
+
+      if other.is_a?(Data)
+        other.id && other.id == id
+      elsif other.is_a?(Integer)
+        id == other
+      else
+        false
+      end
     end
     alias :eql :==
-    alias :hash :id
 
     # @private
     def inspect
@@ -123,6 +141,16 @@ module ZendeskAPI
     end
 
     alias :to_param :attributes
+
+    private
+
+    def attributes_for_save
+      if self.class.unnested_params
+        attributes.changes
+      else
+        { self.class.singular_resource_name.to_sym => attributes.changes }
+      end
+    end
   end
 
   # Indexable resource