zendesk_api 0.1.5 → 0.1.6

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (0.1.5)
+    zendesk_api (0.1.6)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie
@@ -39,13 +39,13 @@ GEM
     rspec-core (2.11.1)
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
+    rspec-mocks (2.11.3)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
     vcr (2.2.5)
-    webmock (1.8.10)
+    webmock (1.8.11)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
     yard (0.8.2.1)

data/Readme.md

@@ -178,11 +178,6 @@ ticket.comment.uploads << File.new("img.jpg")
 ticket.save
 ```
 
-## TODO
-
-* Search class detection
-* Live Testing
-
 ## Note on Patches/Pull Requests
 1. Fork the project.
 2. Make your feature addition or bug fix.

data/lib/zendesk_api.rb

@@ -1,6 +1,3 @@
-
-require 'zendesk_api/core_ext/modulize'
-require 'zendesk_api/core_ext/snakecase'
 require 'zendesk_api/core_ext/inflection'
 require 'zendesk_api/client'
 

data/lib/zendesk_api/actions.rb

@@ -56,7 +56,6 @@ module ZendeskAPI
           self.send("#{association_name}=", association) # set id/ids columns
         end
 
-
         if association_data[:inline] == true || inline_creation
           attributes[association_name] = (association.is_a?(Collection) ? association.map(&:to_param) : association.to_param)
         end
@@ -67,6 +66,10 @@ module ZendeskAPI
   module Read
     include Rescue
 
+    def self.extended(klass)
+      klass.send(:include, ZendeskAPI::Sideloading)
+    end
+
     # Finds a resource by an id and any options passed in.
     # A custom path to search at can be passed into opts. It defaults to the {DataResource.resource_name} of the class. 
     # @param [Client] client The {Client} object to be used
@@ -77,11 +80,16 @@ module ZendeskAPI
       raise ArgumentError, "No :id given" unless options[:id] || options["id"] || ancestors.include?(SingularResource)
       association = options.delete(:association) || Association.new(:class => self)
 
+      includes = Array(options[:include])
+      options[:include] = includes.join(",") if includes.any?
+
       response = client.connection.get(association.generate_path(options)) do |req|
         req.params = options
       end
 
-      new(client, response.body[singular_resource_name])
+      new(client, response.body[singular_resource_name]).tap do |resource|
+        resource.set_includes(resource, includes, response.body)
+      end
     end
 
     rescue_client_error :find

data/lib/zendesk_api/association.rb

@@ -1,3 +1,5 @@
+require 'zendesk_api/helpers'
+
 module ZendeskAPI
   # Represents an association between two resources 
   class Association
@@ -48,8 +50,56 @@ module ZendeskAPI
       namespace.join("/")
     end
 
+    def side_load(resources, side_loads)
+      key = "#{options.name}_id"
+      plural_key = "#{Inflection.singular options.name.to_s}_ids"
+
+      resources.each do |resource|
+        if resource.key?(plural_key) # Grab associations from child_ids field on resource
+          ids = resource.send(plural_key)
+
+          resource.send("#{options.name}=", _side_load(resource, side_loads.select {|side_load|
+            ids.include?(side_load[options.include_key])
+          }))
+        elsif resource.key?(key) || options.singular
+        # Either grab association from child_id field on resource or parent_id on child resource
+          if resource.key?(key)
+            id = resource.send(key)
+            key = options.include_key
+          else
+            id = resource.id
+            key = "#{resource.class.singular_resource_name}_id"
+          end
+
+          next unless id
+
+          side_load = side_loads.detect do |side_load|
+            id == side_load[key]
+          end
+
+          resource.send("#{options.name}=", side_load) if side_load
+        else # Grab associations from parent_id field from multiple child resources
+          key = "#{resource.class.singular_resource_name}_id"
+
+          resource.send("#{options.name}=", _side_load(resource, side_loads.select {|side_load|
+            side_load[key] == resource.id
+          }))
+        end
+      end
+    end
+
     private
 
+    def _side_load(resource, side_loads)
+      side_loads.map! do |side_load|
+        resource.send(:wrap_resource, side_load, options[:class], options)
+      end
+
+      ZendeskAPI::Collection.new(resource.client, options[:class]).tap do |collection|
+        collection.replace(side_loads)
+      end
+    end
+
     def build_parent_namespace(parent_class, instance, options, original_options)
       return unless association_on_parent = parent_class.associations.detect {|a| a[:class] == @options[:class] }
       [
@@ -110,7 +160,17 @@ module ZendeskAPI
       include Rescue
 
       def associations
-        @assocations ||= []
+        @associations ||= []
+      end
+
+      def associated_with(name)
+        associations.inject([]) do |associated_with, association|
+          if association[:include] == name.to_s
+            associated_with.push(Association.new(association))
+          end
+
+          associated_with
+        end
       end
 
       # Represents a parent-to-child association between resources. Options to pass in are: class, path.
@@ -118,13 +178,19 @@ module ZendeskAPI
       # @param [Hash] opts The options to pass to the method definition.
       def has(resource_name, class_level_options = {})
         klass = get_class(class_level_options.delete(:class)) || get_class(resource_name)
+
         class_level_association = {
           :class => klass,
           :name => resource_name,
           :inline => class_level_options.delete(:inline),
-          :path => class_level_options.delete(:path)
+          :path => class_level_options.delete(:path),
+          :include => (class_level_options.delete(:include) || klass.resource_name).to_s,
+          :include_key => (class_level_options.delete(:include_key) || :id).to_s,
+          :singular => true
         }
+
         associations << class_level_association
+
         id_column = "#{resource_name}_id"
 
         define_method "#{resource_name}_used?" do
@@ -166,13 +232,18 @@ module ZendeskAPI
       # @param [Symbol] resource The underlying resource name
       # @param [Hash] opts The options to pass to the method definition.
       def has_many(resource_name, class_level_opts = {})
-        klass = get_class(class_level_opts.delete(:class)) || get_class(resource_name.to_s.singular)
+        klass = get_class(class_level_opts.delete(:class)) || get_class(Inflection.singular(resource_name.to_s))
+
         class_level_association = {
           :class => klass,
           :name => resource_name,
           :inline => class_level_opts.delete(:inline),
-          :path => class_level_opts.delete(:path)
+          :path => class_level_opts.delete(:path),
+          :include => (class_level_opts.delete(:include) || klass.resource_name).to_s,
+          :include_key => (class_level_opts.delete(:include_key) || :id).to_s,
+          :singular => false
         }
+
         associations << class_level_association
 
         id_column = "#{resource_name}_ids"
@@ -190,7 +261,7 @@ module ZendeskAPI
 
           # find and cache association
           instance_association = Association.new(class_level_association.merge(:parent => self))
-          singular_resource_name = resource_name.to_s.singular
+          singular_resource_name = Inflection.singular(resource_name.to_s)
 
           resources = if (ids = method_missing("#{singular_resource_name}_ids")) && ids.any?
             ids.map do |id|
@@ -227,7 +298,7 @@ module ZendeskAPI
       # reopened under a different superclass, an error will be thrown
       def get_class(resource)
         return false if resource.nil?
-        res = resource.to_s.modulize
+        res = ZendeskAPI::Helpers.modulize_string(resource.to_s)
 
         begin
           const_get(res)
@@ -249,7 +320,7 @@ module ZendeskAPI
     # reopened under a different superclass, an error will be thrown
     def get_class(resource)
       return false if resource.nil?
-      res = resource.to_s.modulize.split("::")
+      res = ZendeskAPI::Helpers.modulize_string(resource.to_s).split("::")
 
       begin
         res[1..-1].inject(ZendeskAPI.const_get(res[0])) do |iter, k|

data/lib/zendesk_api/client.rb

@@ -3,6 +3,7 @@ require 'faraday_middleware'
 
 require 'zendesk_api/version'
 require 'zendesk_api/rescue'
+require 'zendesk_api/sideloading'
 require 'zendesk_api/configuration'
 require 'zendesk_api/collection'
 require 'zendesk_api/lru_cache'
@@ -13,6 +14,7 @@ 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/logger'
 
 module ZendeskAPI
   class Client
@@ -30,13 +32,7 @@ module ZendeskAPI
       method = method.to_s
       options = args.last.is_a?(Hash) ? args.pop : {}
       return instance_variable_get("@#{method}") if !options.delete(:reload) && instance_variable_defined?("@#{method}")
-      instance_variable_set("@#{method}", ZendeskAPI::Collection.new(self, ZendeskAPI.get_class(method.singular), options))
-    end
-
-    # Plays a view playlist.
-    # @param [String/Number] id View id or 'incoming'
-    def play(id)
-      ZendeskAPI::Playlist.new(self, id)
+      instance_variable_set("@#{method}", ZendeskAPI::Collection.new(self, ZendeskAPI.get_class(Inflection.singular(method)), options))
     end
 
     # Returns the current user (aka me)
@@ -135,7 +131,7 @@ module ZendeskAPI
         builder.use Faraday::Request::BasicAuthentication, config.username, config.password
         builder.use Faraday::Response::RaiseError
         builder.use ZendeskAPI::Middleware::Response::Callback, self
-        builder.use Faraday::Response::Logger, config.logger if config.logger
+        builder.use ZendeskAPI::Middleware::Response::Logger, config.logger if config.logger
         builder.use ZendeskAPI::Middleware::Response::ParseIsoDates
         builder.response :json, :content_type => 'application/json'
         builder.use ZendeskAPI::Middleware::Response::Gzip

data/lib/zendesk_api/collection.rb

@@ -2,19 +2,23 @@ require 'zendesk_api/resource'
 require 'zendesk_api/resources/misc'
 require 'zendesk_api/resources/ticket'
 require 'zendesk_api/resources/user'
-require 'zendesk_api/resources/playlist'
 
 module ZendeskAPI
   # Represents a collection of resources. Lazily loaded, resources aren't
   # actually fetched until explicitly needed (e.g. #each, {#fetch}).
   class Collection
-    SPECIALLY_JOINED_PARAMS = [:include, :ids, :only]
+    include ZendeskAPI::Sideloading
+
+    SPECIALLY_JOINED_PARAMS = [:ids, :only]
 
     include Rescue
 
     # @return [ZendeskAPI::Association] The class association
     attr_reader :association
 
+    # @return [Faraday::Response] The last response
+    attr_reader :response
+
     # Creates a new Collection instance. Does not fetch resources.
     # Additional options are: verb (default: GET), path (default: resource param), page, per_page.
     # @param [Client] client The {Client} to use.
@@ -41,6 +45,7 @@ module ZendeskAPI
       @collection_path ||= [@resource]
       @resource_class = resource
       @fetchable = true
+      @includes = Array(@options.delete(:include))
 
       # Used for Attachments, TicketComment
       if @resource_class.superclass == ZendeskAPI::Data
@@ -112,6 +117,10 @@ module ZendeskAPI
       self
     end
 
+    def include(*sideloads)
+      self.tap { @includes.concat(sideloads.map(&:to_s)) }
+    end
+
     def <<(item)
       fetch
       if item.is_a?(Resource)
@@ -134,6 +143,7 @@ module ZendeskAPI
     # @param [Boolean] reload Whether to disregard cache
     def fetch(reload = false)
       return @resources if @resources && (!@fetchable || !reload)
+
       if association && association.options.parent && association.options.parent.new_record?
         return @resources = []
       end
@@ -145,9 +155,11 @@ module ZendeskAPI
         path = self.path
       end
 
-      response = @client.connection.send(@verb || "get", path) do |req|
+      @response = @client.connection.send(@verb || "get", path) do |req|
         opts = @options.delete_if {|k, v| v.nil?}
 
+        req.params.merge!(:include => @includes.join(",")) if @includes.any?
+
         if %w{put post}.include?(@verb.to_s)
           req.body = opts
         else
@@ -155,21 +167,29 @@ module ZendeskAPI
         end
       end
 
-      results = response.body[@resource_class.model_key] || response.body["results"]
-      @resources = results.map { |res| @resource_class.new(@client, res) }
+      body = @response.body.dup
+
+      results = body.delete(@resource_class.model_key) || body.delete("results")
+      @resources = results.map {|res| @resource_class.new(@client, res)}
 
-      @count = (response.body["count"] || @resources.size).to_i
-      @next_page, @prev_page = response.body["next_page"], response.body["previous_page"]
+      set_page_and_count(body)
+      set_includes(@resources, @includes, body)
+
+      @resources
+    end
+
+    def set_page_and_count(body)
+      @count = (body["count"] || @resources.size).to_i
+      @next_page, @prev_page = body["next_page"], body["previous_page"]
 
       if @next_page =~ /page=(\d+)/
         @options["page"] = $1.to_i - 1
       elsif @prev_page =~ /page=(\d+)/
         @options["page"] = $1.to_i + 1
       end
-
-      @resources
     end
 
+
     rescue_client_error :fetch, :with => lambda { Array.new }
 
     # Alias for fetch(false)

data/lib/zendesk_api/core_ext/inflection.rb

@@ -1,13 +1,3 @@
 require 'inflection'
 
 Inflection.plural_rule 'forum', 'forums'
-
-class String
-  def singular
-    Inflection.singular(self)
-  end
-  
-  def plural
-    Inflection.plural(self)
-  end
-end

data/lib/zendesk_api/helpers.rb

@@ -0,0 +1,23 @@
+module ZendeskAPI
+  module Helpers
+    # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/modulize.rb
+    def self.modulize_string(string)
+      #gsub('__','/').  # why was this ever here?
+      string.gsub(/__(.?)/){ "::#{$1.upcase}" }.
+        gsub(/\/(.?)/){ "::#{$1.upcase}" }.
+        gsub(/(?:_+|-+)([a-z])/){ $1.upcase }.
+        gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+    end
+
+    # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+    def self.snakecase_string(string)
+      #gsub(/::/, '/').
+      string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr('-', '_').
+        gsub(/\s/, '_').
+        gsub(/__+/, '_').
+        downcase
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'faraday_middleware/response_middleware'
+
+module ZendeskAPI
+  module Middleware
+    module Response
+      # Faraday middleware to handle logging
+      class Logger < Faraday::Response::Middleware
+        def initialize(app, logger = nil)
+          super(app)
+          @logger = logger || begin
+            require 'logger'
+            ::Logger.new(STDOUT)
+          end
+        end
+
+        def call(env)
+          @logger.info "#{env[:method]} #{env[:url].to_s}"
+          @logger.debug dump_debug(env, :request_headers)
+          super
+        end
+
+        def on_complete(env)
+          @logger.info("Status #{env[:status].to_s}")
+          @logger.debug dump_debug(env, :response_headers)
+        end
+
+        private
+
+        def dump_debug(env, headers_key)
+          info = env[headers_key].map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
+          unless env[:body].nil?
+            info.concat("\n")
+            info.concat(env[:body].inspect)
+          end
+          info
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/resource.rb

@@ -1,3 +1,4 @@
+require 'zendesk_api/helpers'
 require 'zendesk_api/trackie'
 require 'zendesk_api/actions'
 require 'zendesk_api/association'
@@ -12,12 +13,12 @@ module ZendeskAPI
     class << self
       # The singular resource name taken from the class name (e.g. ZendeskAPI::Ticket -> ticket)
       def singular_resource_name
-        @singular_resource_name ||= to_s.split("::").last.snakecase
+        @singular_resource_name ||= ZendeskAPI::Helpers.snakecase_string(to_s.split("::").last)
       end
 
       # The resource name taken from the class name (e.g. ZendeskAPI::Ticket -> tickets)
       def resource_name
-        @resource_name ||= singular_resource_name.plural
+        @resource_name ||= Inflection.plural(singular_resource_name)
       end
 
       alias :model_key :resource_name
@@ -71,6 +72,13 @@ module ZendeskAPI
       id.nil?
     end
 
+    def loaded_associations
+      self.class.associations.select do |association|
+        loaded = @attributes.method_missing(association[:name])
+        loaded && !(loaded.respond_to?(:empty?) && loaded.empty?)
+      end
+    end
+
     # Returns the path to the resource
     def path(*args)
       @association.generate_path(self, *args)

data/lib/zendesk_api/resources/misc.rb

@@ -54,7 +54,20 @@ module ZendeskAPI
   class Bookmark < Resource; end
   class Macro < DataResource; end
 
-  class Search < DataResource
+  module Search
+    class Result < Data; end
+
+    def self.new(client, attributes)
+      result_type = attributes["result_type"]
+
+      if result_type
+        result_type = ZendeskAPI::Helpers.modulize_string(result_type)
+        klass = ZendeskAPI.const_get(result_type) rescue nil
+      end
+
+      (klass || Result).new(client, attributes)
+    end
+
     def self.resource_name
       "search"
     end

data/lib/zendesk_api/resources/ticket.rb

@@ -14,6 +14,7 @@ module ZendeskAPI
     include Save
 
     has_many :uploads, :class => :attachment, :inline => true
+    has :author, :class => :user
 
     def save
       save_associations
@@ -40,6 +41,7 @@ module ZendeskAPI
     has :organization
 
     has :comment, :class => :ticket_comment, :inline => true
+    has :last_comment, :class => :ticket_comment, :inline => true
 
     # Gets a incremental export of tickets from the start_time until now.
     # @param [Client] client The {Client} object to be used

data/lib/zendesk_api/resources/user.rb

@@ -17,8 +17,19 @@ module ZendeskAPI
       put :request_verification
     end
 
+    def initialize(*)
+      super
+
+      # Needed for side-loading to work
+      self.role_id = role.id if self.key?(:role)
+    end
+
     has :organization
-    has :custom_role
+
+    has :custom_role, :include => :roles
+    has :role, :inline => true, :include_key => :name
+    has :ability, :inline => true
+
     has_many :identities
 
     has_many :requests
@@ -39,7 +50,9 @@ module ZendeskAPI
   end
 
   class Organization < Resource
+    has :ability, :inline => true
     has :group
+
     has_many :tickets
     has_many :users
   end

data/lib/zendesk_api/sideloading.rb

@@ -0,0 +1,50 @@
+module ZendeskAPI
+  module Sideloading
+    def self.included(klass)
+      klass.send(:attr_reader, :included)
+    end
+
+    def set_includes(resource_or_resources, includes, body)
+      @included = {}
+
+      includes.each do |side_load|
+        unless body.key?(side_load.to_s)
+          @client.config.logger.warn "Missing #{side_load} key in response -- cannot side load"
+        end
+      end
+
+      resources = [resource_or_resources].flatten.compact
+      resource_class = resources.first.class
+
+      return if resources.empty?
+
+      body.keys.each do |name|
+        @included[name] = body[name]
+        _side_load(name, resource_class, resources)
+      end
+    end
+
+
+    private
+
+    # Traverses the resource looking for associations
+    # then descends into those associations and checks for applicable
+    # resources to side load
+    def _side_load(name, klass, resources)
+      associations = klass.associated_with(name)
+
+      associations.each do |association|
+        association.side_load(resources, @included[name])
+      end
+
+      resources.each do |resource|
+        loaded_associations = resource.loaded_associations
+        loaded_associations.each do |association|
+          loaded = resource.send(association[:name])
+          next unless loaded
+          _side_load(name, association[:class], [loaded].flatten)
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/live/group_spec.rb

@@ -22,7 +22,6 @@ describe ZendeskAPI::Group, :delete_after do
     after(:each) do
       VCR.use_cassette("read_ZendeskAPI::User_groups_delete") do
         @object.destroy
-        @membership.destroy
       end
     end
 

data/live/ticket_spec.rb

@@ -24,13 +24,13 @@ describe ZendeskAPI::Ticket do
   context "recent tickets" do
     before(:each) do
       VCR.use_cassette("visit_recent_ticket") do
-        client.connection.get("/tickets/#{@object.id}") do |req|
+        client.connection.get("/tickets/1") do |req|
           req.headers[:Accept] = "*/*"
         end
       end
     end
 
-    it_should_be_readable :tickets, :recent, :create => true
+    it_should_be_readable :tickets, :recent
   end
 
   describe ".incremental_export" do

data/spec/client_spec.rb

@@ -87,7 +87,7 @@ describe ZendeskAPI::Client do
         subject { true }
 
         it "should log in faraday" do
-          @client.connection.builder.handlers.should include(Faraday::Response::Logger)
+          @client.connection.builder.handlers.should include(ZendeskAPI::Middleware::Response::Logger)
         end
 
         context "with a request" do
@@ -102,7 +102,7 @@ describe ZendeskAPI::Client do
         subject { false }
 
         it "should not log" do
-          @client.connection.builder.handlers.should_not include(Faraday::Response::Logger)
+          @client.connection.builder.handlers.should_not include(ZendeskAPI::Middleware::Response::Logger)
         end
       end
 
@@ -110,7 +110,7 @@ describe ZendeskAPI::Client do
         subject { nil }
 
         it "should log" do
-          @client.connection.builder.handlers.should include(Faraday::Response::Logger)
+          @client.connection.builder.handlers.should include(ZendeskAPI::Middleware::Response::Logger)
         end
       end
 
@@ -119,7 +119,7 @@ describe ZendeskAPI::Client do
         subject { Logger.new(out) }
         
         it "should log" do
-          @client.connection.builder.handlers.should include(Faraday::Response::Logger)
+          @client.connection.builder.handlers.should include(ZendeskAPI::Middleware::Response::Logger)
         end
 
         context "with a request" do
@@ -159,19 +159,6 @@ describe ZendeskAPI::Client do
     end
   end
 
-  context "#play" do
-    # TODO may be able to be replaced by VCR
-    before(:each) do 
-      stub_request(:get, %r{play}).to_return do
-        { :status => 302 }
-      end
-    end
-
-    it "should return an instance of ZendeskAPI::Playlist" do
-      subject.play(1).should be_instance_of(ZendeskAPI::Playlist)
-    end
-  end
-
   it "can be subclassed" do
     client = SimpleClient.new do |config|
       config.allow_http = true

data/spec/collection_spec.rb

@@ -401,6 +401,149 @@ describe ZendeskAPI::Collection do
     end
   end
 
+  context "side loading" do
+    before(:each) do
+      subject.include(:nil_resources)
+    end
+
+    context "singular id on resource" do
+      before(:each) do
+        ZendeskAPI::TestResource.has :nil_resource
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1, :nil_resource_id => 4 }],
+          :nil_resources => [{ :id => 1, :name => :bye }, { :id => 4, :name => :hi }]
+        ))
+
+        subject.fetch(true)
+
+        @resource = subject.detect {|res| res.id == 1}
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resource.should_not be_nil
+      end
+
+      it "should side load the correct nil_resource" do
+        @resource.nil_resource.name.should == "hi"
+      end
+    end
+
+    context "plural ids on resource" do
+      before(:each) do
+        ZendeskAPI::TestResource.has_many :nil_resources
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1, :nil_resource_ids => [1, 4] }],
+          :nil_resources => [{ :id => 1, :name => :hi }, { :id => 4, :name => :hello }, { :id => 5, :name => :goodbye }]
+        ))
+
+        subject.fetch(true)
+
+        @resource = subject.detect {|res| res.id == 1}
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resources.should_not be_empty
+      end
+
+      it "should side load the correct nil_resources" do
+        @resource.nil_resources.map(&:name).should == %w{hi hello}
+      end
+    end
+
+    context "ids in side load" do
+      before(:each) do
+        ZendeskAPI::TestResource.has_many :nil_resources
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1 }],
+          :nil_resources => [{ :id => 1, :test_resource_id => 2 }, { :id => 2, :test_resource_id => 1 }, { :id => 4, :test_resource_id => 1 }]
+        ))
+
+        subject.fetch(true)
+        @resource = subject.detect {|res| res.id == 1}
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resources.should_not be_empty
+      end
+
+      it "should side load the correct nil_resources" do
+        @resource.nil_resources.map(&:id).should == [2, 4]
+      end
+    end
+
+    context "id in side load" do
+      before(:each) do
+        ZendeskAPI::TestResource.has :nil_resource
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1 }],
+          :nil_resources => [{ :id => 1, :test_resource_id => 2 }, { :id => 2, :test_resource_id => 1 }]
+        ))
+
+        subject.fetch(true)
+        @resource = subject.detect {|res| res.id == 1}
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resource.should_not be_nil
+      end
+
+      it "should side load the correct nil_resources" do
+        @resource.nil_resource.id.should == 2
+      end
+    end
+
+    context "with name as key" do
+      before(:each) do
+        ZendeskAPI::TestResource.has :nil_resource, :include_key => :name
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1, :nil_resource_id => 4 }],
+          :nil_resources => [{ :name => 1 }, { :name => 4 }]
+        ))
+
+        subject.fetch(true)
+
+        @resource = subject.detect {|res| res.id == 1}
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resource.should_not be_nil
+      end
+
+      it "should side load the correct nil_resource" do
+        @resource.nil_resource.name.should == 4
+      end
+    end
+
+    context "sub-loading" do
+      before(:each) do
+        ZendeskAPI::TestResource.has :test_child
+        ZendeskAPI::TestResource::TestChild.has :nil_resource
+
+        stub_json_request(:get, %r{test_resources\?include=nil_resources}, json(
+          :test_resources => [{ :id => 1, :test_child => { :nil_resource_id => 4 } }],
+          :nil_resources => [{ :id => 1 }, { :id => 4 }]
+        ))
+
+        subject.fetch(true)
+
+        @resource = subject.detect {|res| res.id == 1}.test_child
+      end
+
+      it "should side load nil_resources" do
+        @resource.nil_resource.should_not be_nil
+      end
+
+      it "should side load the correct nil_resource" do
+        @resource.nil_resource.id.should == 4
+      end
+    end
+  end
+
   context "method missing" do
     before(:each) { subject.stub(:fetch).and_return([1, 2, nil, 3]) }
 

data/spec/{string_spec.rb → inflection_spec.rb}

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe String do
   specify "the plural of forum if forums" do
-    "forum".plural.should == "forums"
+    Inflection.plural("forum").should == "forums"
   end
 end

data/spec/read_resource_spec.rb

@@ -5,12 +5,14 @@ describe ZendeskAPI::ReadResource do
     let(:id) { 1 }
     subject { ZendeskAPI::TestResource }
 
-    before(:each) do
-      stub_json_request(:get, %r{test_resources/#{id}}, json("test_resource" => {}))
-    end
+    context "normal request" do
+      before(:each) do
+        stub_json_request(:get, %r{test_resources/#{id}}, json("test_resource" => {}))
+      end
 
-    it "should return instance of resource" do
-      subject.find(client, :id => id).should be_instance_of(subject)
+      it "should return instance of resource" do
+        subject.find(client, :id => id).should be_instance_of(subject)
+      end
     end
 
     it "should blow up without an id which would build an invalid url" do
@@ -19,6 +21,22 @@ describe ZendeskAPI::ReadResource do
       }.to raise_error("No :id given")
     end
 
+    context "with side loads" do
+      before(:each) do
+        stub_json_request(:get, %r{test_resources/#{id}\?include=nil_resource}, json(
+          "test_resource" => { :id => 1, :nil_resource_id => 2 },
+          "nil_resources" => [{ :id => 1, :name => :bye }, { :id => 2, :name => :hi }]
+        ))
+
+        subject.has :nil_resource
+        @resource = subject.find(client, :id => id, :include => :nil_resource)
+      end
+
+      it "should side load nil resource" do
+        @resource.nil_resource.name.should == "hi"
+      end
+    end
+
     context "with client error" do
       it "should handle 500 properly" do
         stub_request(:get, %r{test_resources/#{id}}).to_return(:status => 500)

data/spec/search_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Search do
+  context ".new" do
+    context "when given an existing class" do
+      it "should return the correct class" do
+        ZendeskAPI::Search.new(nil, { "result_type" => "user" }).should be_instance_of(ZendeskAPI::User)
+      end
+    end
+
+    context "when given a nonexistant class" do
+      it "should return an object of the type Search::Result" do
+        ZendeskAPI::Search.new(nil, { "result_type" => "blah" }).should be_instance_of(ZendeskAPI::Search::Result)
+      end
+    end
+
+    context "when not given anything" do
+      it "should return an object of the type Search::Result" do
+        ZendeskAPI::Search.new(nil, {}).should be_instance_of(ZendeskAPI::Search::Result)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $:.unshift(File.join(File.dirname(__FILE__), "macros"))
 
 ENV['TZ'] = 'CET' # something that is not local and not utc so we find all the bugs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -228,8 +228,7 @@ files:
 - lib/zendesk_api/collection.rb
 - lib/zendesk_api/configuration.rb
 - lib/zendesk_api/core_ext/inflection.rb
-- lib/zendesk_api/core_ext/modulize.rb
-- lib/zendesk_api/core_ext/snakecase.rb
+- lib/zendesk_api/helpers.rb
 - lib/zendesk_api/lru_cache.rb
 - lib/zendesk_api/middleware/request/etag_cache.rb
 - lib/zendesk_api/middleware/request/retry.rb
@@ -237,14 +236,15 @@ files:
 - lib/zendesk_api/middleware/response/callback.rb
 - lib/zendesk_api/middleware/response/deflate.rb
 - lib/zendesk_api/middleware/response/gzip.rb
+- lib/zendesk_api/middleware/response/logger.rb
 - lib/zendesk_api/middleware/response/parse_iso_dates.rb
 - lib/zendesk_api/rescue.rb
 - lib/zendesk_api/resource.rb
 - lib/zendesk_api/resources/forum.rb
 - lib/zendesk_api/resources/misc.rb
-- lib/zendesk_api/resources/playlist.rb
 - lib/zendesk_api/resources/ticket.rb
 - lib/zendesk_api/resources/user.rb
+- lib/zendesk_api/sideloading.rb
 - lib/zendesk_api/track_changes.rb
 - lib/zendesk_api/trackie.rb
 - lib/zendesk_api/verbs.rb
@@ -291,6 +291,7 @@ files:
 - spec/fixtures/credentials.yml.example
 - spec/fixtures/test_resources.rb
 - spec/fixtures/zendesk.rb
+- spec/inflection_spec.rb
 - spec/lru_cache_spec.rb
 - spec/macros/resource_macros.rb
 - spec/middleware/request/etag_cache_spec.rb
@@ -301,12 +302,11 @@ files:
 - spec/middleware/response/deflate_spec.rb
 - spec/middleware/response/gzip_spec.rb
 - spec/middleware/response/parse_iso_dates_spec.rb
-- spec/playlist_spec.rb
 - spec/read_resource_spec.rb
 - spec/rescue_spec.rb
 - spec/resource_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb
-- spec/string_spec.rb
 - spec/trackie_spec.rb
 - zendesk_api.gemspec
 homepage: http://developer.zendesk.com
@@ -346,6 +346,7 @@ test_files:
 - spec/fixtures/credentials.yml.example
 - spec/fixtures/test_resources.rb
 - spec/fixtures/zendesk.rb
+- spec/inflection_spec.rb
 - spec/lru_cache_spec.rb
 - spec/macros/resource_macros.rb
 - spec/middleware/request/etag_cache_spec.rb
@@ -356,11 +357,10 @@ test_files:
 - spec/middleware/response/deflate_spec.rb
 - spec/middleware/response/gzip_spec.rb
 - spec/middleware/response/parse_iso_dates_spec.rb
-- spec/playlist_spec.rb
 - spec/read_resource_spec.rb
 - spec/rescue_spec.rb
 - spec/resource_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb
-- spec/string_spec.rb
 - spec/trackie_spec.rb
 has_rdoc: 

data/lib/zendesk_api/core_ext/modulize.rb

@@ -1,10 +0,0 @@
-# From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/modulize.rb
-class String
-  def modulize
-    #gsub('__','/').  # why was this ever here?
-    gsub(/__(.?)/){ "::#{$1.upcase}" }.
-    gsub(/\/(.?)/){ "::#{$1.upcase}" }.
-    gsub(/(?:_+|-+)([a-z])/){ $1.upcase }.
-    gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
-  end
-end

data/lib/zendesk_api/core_ext/snakecase.rb

@@ -1,12 +0,0 @@
-# From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
-class String
-  def snakecase
-    #gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr('-', '_').
-    gsub(/\s/, '_').
-    gsub(/__+/, '_').
-    downcase
-  end
-end

data/lib/zendesk_api/resources/playlist.rb

@@ -1,64 +0,0 @@
-module ZendeskAPI
-  class Playlist
-    include Rescue
-
-    attr_reader :ticket
-    attr_accessor :id
-
-    def initialize(client, id)
-      @client, @id = client, id
-      @ticket = nil
-
-      @initialized = false
-      @destroyed = false
-
-      init_playlist
-    end
-
-    def each
-      init_playlist unless initialized?
-
-      while initialized? && !destroyed? && (n = self.next)
-        yield n
-      end
-    end
-
-    def next
-      init_playlist unless initialized?
-      return false if !initialized? || destroyed? 
-
-      response = @client.connection.get("play/next")
-
-      if response.status == 200
-        @ticket = Ticket.new(@client, response.body["ticket"])
-        @ticket
-      else
-        @destroyed = (response.status == 204)
-        nil
-      end
-    end
-
-    def destroy
-      response = @client.connection.delete("play")
-      @destroyed = response.status == 204 
-    end
-
-    def destroyed?
-      @destroyed
-    end
-
-    def initialized?
-      @initialized
-    end
-
-    private
-
-    def init_playlist
-      response = @client.connection.get("views/#{id}/play")
-      @initialized = response.status == 302
-    end
-
-    rescue_client_error :next, :init_playlist
-    rescue_client_error :destroy, :with => false
-  end
-end

data/spec/playlist_spec.rb

@@ -1,95 +0,0 @@
-require 'spec_helper'
-
-describe ZendeskAPI::Playlist do
-  subject { ZendeskAPI::Playlist }
-
-  before(:each) do
-    stub_request(:get, %r{views/\d+/play}).to_return(:status => 302, :body => "You are being redirected...")
-  end
-
-  it "should begin playing the playlist on initialization" do
-    subject.new(client, 1)
-  end
-
-  context "#next" do
-    subject { ZendeskAPI::Playlist.new(client, 1) }
-
-    before(:each) do
-      stub_json_request(:get, %r{play/next}, json("ticket" => {}))
-    end
-
-    it "should return ticket" do
-      subject.next.should be_instance_of(ZendeskAPI::Ticket)
-    end
-
-    context "with client error", :silence_logger do
-      before(:each) do
-        stub_request(:get, %r{play/next}).to_return(:status => 500)
-      end
-
-      it "should be properly handled" do
-        expect { subject.next.should be_nil }.to_not raise_error
-      end
-    end
-
-    context "with end of playlist" do
-      before(:each) do
-        stub_request(:get, %r{play/next}).to_return(:status => 204)
-      end
-
-      it "should be properly handled" do
-        subject.next.should be_nil
-        subject.destroyed?.should be_true
-      end
-    end
-  end
-
-  context "#destroy" do
-    subject { ZendeskAPI::Playlist.new(client, 1) }
-
-    before(:each) do
-      stub_request(:delete, %r{play}).to_return(:status => 204)
-    end
-
-    it "should be destroyed" do
-      subject.destroy.should be_true
-      subject.destroyed?.should be_true
-    end
-
-    context "with client error", :silence_logger do
-      before(:each) do
-        stub_request(:delete, %r{play}).to_return(:status => 500)
-      end
-
-      it "should be properly handled" do
-        expect { subject.destroy.should be_false }.to_not raise_error
-      end
-    end
-  end
-
-  context "initialization" do
-    context "with client error", :silence_logger do
-      before(:each) do
-        stub_request(:get, %r{views/\d+/play}).to_return(:status => 500).to_return(:status => 302)
-        stub_request(:get, %r{play/next}).to_return(:body => json)
-      end
-
-      it "should be able to be created" do
-        new_playlist = subject.new(client, 1)
-        new_playlist.should_not be_nil
-      end
-
-      it "should retry initialization on #next" do
-        new_playlist = subject.new(client, 1)
-        new_playlist.should_receive(:init_playlist).and_return(:true)
-        new_playlist.next
-      end
-
-      it "should retry initialization on #each" do
-        new_playlist = subject.new(client, 1)
-        new_playlist.should_receive(:next).and_return(Object.new, nil)
-        new_playlist.each {|arg| :block }
-      end
-    end
-  end
-end