zendesk_api 1.1.3 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a1a622425d0f711b974ea60999f4beb2a4da61f
+  data.tar.gz: a669017a02d5a001a05793688e3f56c41c50f375
+SHA512:
+  metadata.gz: 78a9c681771ab74a25bbaca94f35e5c8ba527398845f145d09c072bbd1d598cb0cd71c0e1714973d1a9e460bba7534a1e6232436838f88febdad2d3aeddda5ca
+  data.tar.gz: 4e1d57b1489b997f61dd5d932552e1e4f8e82703e155d0f9012defe79cc0b3348733220f4a48a6405d9b207413894276c723a0b906ecf1251c66c59279b181af

data/Gemfile.lock

@@ -7,12 +7,12 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (1.1.3)
+    zendesk_api (1.2.1)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie (>= 1.2)
       inflection
-      mime-types
+      mime-types (~> 1.0)
       multi_json
       multipart-post
 

data/README.md

@@ -110,20 +110,20 @@ as #each.
 ### Caveats
 
 Resource updating is implemented by sending only the `changed?` attributes to the server (see `ZendeskAPI::TrackChanges`).
-Unfortunately, this module only hooks into `Hash` meaning any changes to an `Array`not resulting in a new instance will not be tracked and sent.
+Unfortunately, this module only hooks into `Hash` meaning any changes to an `Array` not resulting in a new instance will not be tracked and sent.
 
 ```
 zendesk_api_client_rb $ bundle console
-> a = ZendeskAPI::Trackie.new(:tags => []).tap(&:clear_changes)
-> a.changed?(:tags)
+> a = ZendeskAPI::Trackie.new(:test => []).tap(&:clear_changes)
+> a.changed?(:test)
  => false
-> a.tags << "my_new_tag"
- => ["my_new_tag"]
-> a.changed?(:tags)
+> a.test << "hello"
+ => ["hello"]
+> a.changed?(:test)
  => false
-> a.tags += %w{my_other_tag}
- => ["my_new_tag", "my_other_tag"]
-> a.changed?(:tags)
+> a.test += %w{hi}
+ => ["hello", "hi"]
+> a.changed?(:test)
  => true
 ```
 

data/lib/zendesk_api/association.rb

@@ -117,10 +117,23 @@ module ZendeskAPI
     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] }
+      path = @options.path
+
+      association_on_parent = parent_class.associations.detect {|a| a[:name] == @options[:name]}
+      association_on_parent ||= parent_class.associations.detect do |a|
+        !a[:inline] && a[:class] == @options[:class]
+      end
+
+      if association_on_parent
+        path ||= association_on_parent[:path]
+        path ||= association_on_parent[:name].to_s
+      end
+
+      path ||= @options[:class].resource_path
+
       [
         extract_parent_id(parent_class, instance, options, original_options),
-        @options.path || association_on_parent[:path] || association_on_parent[:name].to_s
+        path
       ]
     end
 

data/lib/zendesk_api/collection.rb

@@ -167,7 +167,7 @@ module ZendeskAPI
       end
 
       @response = get_response(@query || self.path)
-      handle_response(@response.body.dup)
+      handle_response(@response.body)
 
       @query = nil
       @resources
@@ -375,7 +375,12 @@ module ZendeskAPI
       end
     end
 
-    def handle_response(body)
+    def handle_response(response_body)
+      unless response_body
+        raise ZendeskAPI::Error::NetworkError, @response.env
+      end
+
+      body = response_body.dup
       results = body.delete(@resource_class.model_key) || body.delete("results")
 
       @resources = results.map do |res|
@@ -387,10 +392,10 @@ module ZendeskAPI
     end
 
     # Simplified Associations#wrap_resource
-    def wrap_resource(res, with_association = [Tag, Setting].include?(@resource_class))
+    def wrap_resource(res, with_association = with_association?)
       case res
       when Array
-        wrap_resource(Hash[*res])
+        wrap_resource(Hash[*res], with_association)
       when Hash
         res = res.merge(:association => @association) if with_association
         @resource_class.new(@client, res)
@@ -401,6 +406,12 @@ module ZendeskAPI
       end
     end
 
+    # Two special cases, and all namespaced classes
+    def with_association?
+      [Tag, Setting].include?(@resource_class) ||
+        @resource_class.to_s.split("::").size > 2
+    end
+
     ## Method missing
 
     def array_method(name, *args, &block)

data/lib/zendesk_api/delegator.rb

@@ -1,4 +1,5 @@
+require 'delegate'
+
 module ZendeskAPI
   class Delegator < SimpleDelegator; end
 end
-

data/lib/zendesk_api/error.rb

@@ -1,6 +1,8 @@
 module ZendeskAPI
   module Error
-    class ClientError < Faraday::Error::ClientError; end
+    class ClientError < Faraday::Error::ClientError
+      attr_reader :wrapped_exception
+    end
 
     class RecordInvalid < ClientError
       attr_accessor :response, :errors

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

@@ -8,7 +8,7 @@ module ZendeskAPI
         def call(env)
           super
         rescue Faraday::Error::TimeoutError, Faraday::Error::ConnectionFailed => e
-          raise Error::NetworkError.new(e)
+          raise Error::NetworkError.new(e, env)
         end
 
         def on_complete(env)

data/lib/zendesk_api/resources.rb

@@ -281,13 +281,15 @@ module ZendeskAPI
         has :author, :class => User
       end
 
+      put :trust
+
       # need this to support SideLoading
       has :author, :class => User
 
       has_many Event
     end
 
-    class Comment < Data
+    class Comment < DataResource
       include Save
 
       has_many :uploads, :class => Attachment, :inline => true
@@ -306,7 +308,7 @@ module ZendeskAPI
     has :requester, :class => User, :inline => :create
     has :submitter, :class => User
     has :assignee, :class => User
-    has_many :collaborators, :class => User
+    has_many :collaborators, :class => User, :inline => true
     has_many Audit
     has :metrics, :class => TicketMetric
     has Group
@@ -314,7 +316,9 @@ module ZendeskAPI
     has Organization
     has :related, :class => TicketRelated
 
-    has :comment, :class => Comment, :inline => true
+    has Comment, :inline => true
+    has_many Comment
+
     has :last_comment, :class => Comment, :inline => true
     has_many :last_comments, :class => Comment, :inline => true
 
@@ -533,6 +537,40 @@ module ZendeskAPI
     # post :clone
   end
 
+  class AppInstallation < Resource
+    namespace "apps"
+
+    def self.singular_resource_name
+      "installation"
+    end
+
+    # Don't nest attributes
+    def attributes_for_save
+      attributes.changes
+    end
+
+    def handle_response
+      @attributes.replace(@response.body) if @response.body
+    end
+  end
+
+  class AppNotification < CreateResource
+    class << self
+      def resource_path
+        "apps/notify"
+      end
+    end
+
+    # Don't nest attributes
+    def attributes_for_save
+      attributes.changes
+    end
+
+    def handle_response
+      @attributes.replace(@response.body) if @response.body
+    end
+  end
+
   class App < DataResource
     include Create
     include Update
@@ -577,23 +615,12 @@ module ZendeskAPI
       end
     end
 
-    class Installation < Resource
-      # Don't nest attributes
-      def attributes_for_save
-        attributes.changes
-      end
-
-      def handle_response
-        @attributes.replace(@response.body) if @response.body
-      end
-    end
-
     def self.uploads(client, *args, &block)
       ZendeskAPI::Collection.new(client, Upload, *args, &block)
     end
 
     def self.installations(client, *args, &block)
-      ZendeskAPI::Collection.new(client, Installation, *args, &block)
+      ZendeskAPI::Collection.new(client, AppInstallation, *args, &block)
     end
 
     has Upload, :path => "uploads"

data/lib/zendesk_api/verbs.rb

@@ -29,11 +29,14 @@ module ZendeskAPI
             return false unless @response.success?
             return false unless @response.body
 
-            resource = @response.body[self.class.singular_resource_name] ||
-              @response.body.fetch(self.class.resource_name, []).detect {|res| res["id"] == id} ||
-              {}
+            resource = nil
 
-            @attributes.replace @attributes.deep_merge(resource)
+            if @response.body.is_a?(Hash)
+              resource = @response.body[self.class.singular_resource_name]
+              resource ||= @response.body.fetch(self.class.resource_name, []).detect {|res| res["id"] == id}
+            end
+
+            @attributes.replace @attributes.deep_merge(resource || {})
             @attributes.clear_changes
             clear_associations
 

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.1.3"
+  VERSION = "1.2.1"
 end

data/spec/core/association_spec.rb

@@ -155,7 +155,7 @@ describe ZendeskAPI::Association do
   end
 
   context "class with a specified parent" do
-    subject { described_class.new(:class => ZendeskAPI::TestResource::TestChild, :parent => instance) }
+    subject { described_class.new(:class => ZendeskAPI::TestResource::TestChild, :parent => instance, :name => :children) }
 
     it "should generate nested resource path" do
       subject.generate_path.should == "test_resources/1/children"
@@ -198,13 +198,13 @@ describe ZendeskAPI::Association do
       end
 
       it "should generate nested resource path" do
-        subject.generate_path.should == "test_resources/test_children"
+        subject.generate_path.should == "test_resources/1/test_children"
       end
     end
   end
 
   context "class with a parent id" do
-    subject { described_class.new(:class => ZendeskAPI::TestResource::TestChild) }
+    subject { described_class.new(:class => ZendeskAPI::TestResource::TestChild, :name => :children) }
 
     it "should raise an error if not passed an instance or id" do
       expect { subject.generate_path }.to raise_error(ArgumentError)

data/spec/core/collection_spec.rb

@@ -61,7 +61,7 @@ describe ZendeskAPI::Collection do
     context "with a class with a parent" do
       let(:association) do
         ZendeskAPI::Association.new(:class => ZendeskAPI::TestResource::TestChild,
-          :parent => ZendeskAPI::TestResource.new(client, :id => 1))
+          :parent => ZendeskAPI::TestResource.new(client, :id => 1), :name => :children)
       end
 
       subject do
@@ -363,6 +363,16 @@ describe ZendeskAPI::Collection do
       end
     end
 
+    context "with nil body" do
+      before(:each) do
+        stub_request(:get, %r{test_resources}).to_return(:status => 200)
+      end
+
+      it "should properly be handled" do
+        silence_logger { subject.fetch(true).should be_empty }
+      end
+    end
+
     context "with unfetchable resource" do
       subject { ZendeskAPI::Collection.new(client, ZendeskAPI::NilResource) }
 

data/spec/live/{installation_spec.rb → app_installation_spec.rb}

@@ -1,6 +1,6 @@
 require 'core/spec_helper'
 
-describe ZendeskAPI::App::Installation do
+describe ZendeskAPI::AppInstallation do
   it "should work "do
     upload = VCR.use_cassette("app_installations_upload_create") do
       ZendeskAPI::App::Upload.new(client, :id => "spec/fixtures/sample_app.zip").tap(&:save!)
@@ -36,7 +36,7 @@ describe ZendeskAPI::App::Installation do
       }
     }
 
-    install = ZendeskAPI::App::Installation.new(client, attributes)
+    install = ZendeskAPI::AppInstallation.new(client, attributes)
 
     VCR.use_cassette("app_install_create") { install.save! }
 

data/spec/live/app_spec.rb

@@ -28,12 +28,12 @@ describe ZendeskAPI::App do
     end
 
     app.id = body["app_id"]
-    app.short_description = "My Test App"
+    app.author_name = "Mr. Sprinkles"
+    app.author_email = "sprinkle@example.com"
 
     VCR.use_cassette("app_save") { app.save! }
 
-    app.short_description.should == "My Test App"
-    app.author_name.should == "Skip Moore"
+    app.author_name.should == "Mr. Sprinkles"
 
     VCR.use_cassette("app_destroy") { app.destroy! }
   end

data/zendesk_api.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "hashie", ">= 1.2"
   s.add_runtime_dependency "inflection"
   s.add_runtime_dependency "multi_json"
-  s.add_runtime_dependency "mime-types"
+  s.add_runtime_dependency "mime-types", "~> 1.0"
   s.add_runtime_dependency "multipart-post"
 
   s.files              = `git ls-files -x Gemfile.lock`.split("\n") rescue ''

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.1.3
-  prerelease: 
+  version: 1.2.1
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -10,76 +9,67 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -87,7 +77,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -95,129 +84,113 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: inflection
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby wrapper for the REST API at http://www.zendesk.com. Documentation
@@ -482,6 +455,7 @@ files:
 - spec/fixtures/zendesk.rb
 - spec/live/Readme.md
 - spec/live/activity_spec.rb
+- spec/live/app_installation_spec.rb
 - spec/live/app_spec.rb
 - spec/live/audit_spec.rb
 - spec/live/automation_spec.rb
@@ -494,7 +468,6 @@ files:
 - spec/live/group_membership_spec.rb
 - spec/live/group_spec.rb
 - spec/live/identity_spec.rb
-- spec/live/installation_spec.rb
 - spec/live/locale_spec.rb
 - spec/live/macro_spec.rb
 - spec/live/mobile_device_spec.rb
@@ -531,27 +504,26 @@ files:
 homepage: http://developer.zendesk.com
 licenses:
 - Apache License Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Zendesk REST API Client
 test_files:
 - spec/core/association_spec.rb
@@ -594,6 +566,7 @@ test_files:
 - spec/fixtures/zendesk.rb
 - spec/live/Readme.md
 - spec/live/activity_spec.rb
+- spec/live/app_installation_spec.rb
 - spec/live/app_spec.rb
 - spec/live/audit_spec.rb
 - spec/live/automation_spec.rb
@@ -606,7 +579,6 @@ test_files:
 - spec/live/group_membership_spec.rb
 - spec/live/group_spec.rb
 - spec/live/identity_spec.rb
-- spec/live/installation_spec.rb
 - spec/live/locale_spec.rb
 - spec/live/macro_spec.rb
 - spec/live/mobile_device_spec.rb