zendesk_api 1.0.7 → 1.1.0

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (1.0.7)
+    zendesk_api (1.1.0)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie (>= 1.2)

data/{Readme.md → README.md}

@@ -269,6 +269,111 @@ ticket.comment.uploads << File.new("img.jpg")
 ticket.save
 ```
 
+### Apps API
+
+v1.1.0 introduces support for the Zendesk [Apps API](http://developer.zendesk.com/documentation/apps/reference/api.html)
+
+#### Creating Apps
+
+```ruby
+upload = client.apps.uploads.create!(:file => "path/to/app.zip")
+client.apps.create!(:name => "test", :short_description => "My test app", :upload_id => upload.id)
+
+# Or
+
+app = ZendeskAPI::App.new(client, :name => "test", :short_description => "My test app")
+app.upload = "path/to/app.zip"
+app.save!
+
+# Or
+
+upload = ZendeskAPI::App::Upload.new(client, :file => "path/to/app.zip")
+upload.save!
+
+app = ZendeskAPI::App.new(client, :name => "test")
+app.short_description = "My test app"
+app.upload_id = upload.id
+app.save!
+
+# Not supported!
+client.apps.create!(:name => "test", :short_description => "My test app", :upload => "app.zip")
+```
+
+*Note: job statuses are currently not supported, so you must manually poll the job status API for app creation.*
+```ruby
+body = {}
+until %w{failed completed}.include?(body["status"])
+  response = client.connection.get(app.response.headers["Location"])
+  body = response.body
+
+  sleep(body["retry_in"])
+end
+```
+
+#### Updating Apps
+
+```ruby
+client.apps.update!(:id => 123, :short_description => "New Description")
+
+app = ZendeskAPI::App.new(client, :id => 123, :short_description => "New Description")
+app.save!
+
+ZendeskAPI::App.update!(client, :id => 123, :short_description => "New Description")
+```
+
+#### Deleting Apps
+
+```ruby
+client.apps.destroy!(:id => 123)
+
+app = ZendeskAPI::App.new(client, :id => 123)
+app.destroy!
+
+ZendeskAPI::App.destroy!(client, :id => 123)
+```
+
+#### Installing an App
+
+```ruby
+install = ZendeskAPI::App::Installation.new(client, :app_id => 123)
+install.save!
+
+client.apps.installations.create!(:app_id => 123)
+
+ZendeskAPI::App::Installation.create!(client, :app_id => 123)
+```
+
+#### List Installations
+
+```ruby
+apps = client.app.installations
+apps.fetch!
+```
+
+#### Update Installation
+
+```ruby
+client.app.installations.update!(:id => 123, :settings => { :title => "My New Name" })
+
+install = ZendeskAPI::App::Installation.new(client, :id => 123)
+install.settings = { :title => "My New Name" }
+install.save!
+
+ZendeskAPI::App::Installation.update!(client, :id => 123, :settings => { :title => "My New Name" })
+```
+
+#### Delete Installation
+
+```ruby
+client.app.installations.destroy!(:id => 123)
+
+install = ZendeskAPI::App::Installation.new(client, :id => 123)
+install.destroy!
+
+ZendeskAPI::App::Installation.destroy!(client, :id => 123)
+```
+
+
 ## Note on Patches/Pull Requests
 1. Fork the project.
 2. Make your feature addition or bug fix.

data/lib/zendesk_api/actions.rb

@@ -25,9 +25,7 @@ module ZendeskAPI
         yield req if block_given?
       end
 
-      if @response.body && @response.body[self.class.singular_resource_name]
-        @attributes.replace @attributes.deep_merge(@response.body[self.class.singular_resource_name] || {})
-      end
+      handle_response
 
       @attributes.clear_changes
       clear_associations
@@ -71,6 +69,12 @@ module ZendeskAPI
         end
       end
     end
+
+    def handle_response
+      if @response.body && @response.body[self.class.singular_resource_name]
+        @attributes.replace @attributes.deep_merge(@response.body[self.class.singular_resource_name] || {})
+      end
+    end
   end
 
   module Read

data/lib/zendesk_api/association.rb

@@ -32,6 +32,8 @@ module ZendeskAPI
       instance = args.first
 
       namespace = @options[:class].to_s.split("::")
+      namespace[-1] = @options[:class].resource_path
+
       %w(ZendeskAPI Voice).each { |ns| namespace.delete(ns) }
       has_parent = namespace.size > 1 || (options[:with_parent] && @options.parent)
 
@@ -118,7 +120,7 @@ module ZendeskAPI
       return unless association_on_parent = parent_class.associations.detect {|a| a[:class] == @options[:class] }
       [
         extract_parent_id(parent_class, instance, options, original_options),
-        @options.path || association_on_parent[:name].to_s
+        @options.path || association_on_parent[:path] || association_on_parent[:name].to_s
       ]
     end
 

data/lib/zendesk_api/resources.rb

@@ -263,8 +263,14 @@ module ZendeskAPI
 
   class Ticket < Resource
     class Audit < DataResource
+      class Event < Data
+        has :author, :class => User
+      end
+
       # need this to support SideLoading
       has :author, :class => User
+
+      has_many Event
     end
 
     class Comment < Data
@@ -451,6 +457,8 @@ module ZendeskAPI
     has_many TopicSubscription
     has_many :topic_comments, :class => TopicComment
     has_many :topic_votes, :class => Topic::TopicVote
+
+    has_many Setting
   end
 
   class UserField < Resource; end
@@ -485,4 +493,79 @@ module ZendeskAPI
     # TODO
     # post :clone
   end
+
+  class App < DataResource
+    include Create
+    include Update
+    include Destroy
+
+    def initialize(client, attributes = {})
+      attributes[:upload_id] ||= nil
+
+      super
+    end
+
+    class Upload < Data
+      class << self
+        def resource_path
+          "uploads"
+        end
+      end
+
+      include Create
+
+      def initialize(client, attributes)
+        attributes[:file] ||= attributes.delete(:id)
+
+        super
+      end
+
+      # Not nested under :upload, just returns :id
+      def save!(*)
+        super.tap do
+          attributes.id = @response.body["id"]
+        end
+      end
+
+      # Always save
+      def changed?
+        true
+      end
+
+      # Don't nest attributes
+      def attributes_for_save
+        attributes
+      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)
+    end
+
+    has Upload, :path => "uploads"
+
+    # Don't nest attributes
+    def attributes_for_save
+      attributes.changes
+    end
+
+    def handle_response
+      @attributes.replace(@response.body) if @response.body
+    end
+  end
 end

data/lib/zendesk_api/track_changes.rb

@@ -44,10 +44,6 @@ module ZendeskAPI
         keys.each{|key| delete key}
       end
 
-      def [](key)
-        super(key)
-      end
-
       def regular_writer(key, value)
         if self.has_key?(key) && self[key] == value
           value
@@ -58,8 +54,9 @@ module ZendeskAPI
       end
 
       def delete(key)
-        self[key] = nil
-        super
+        super.tap do |value|
+          changes[key] = nil
+        end
       end
 
       def changes

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.0.7"
+  VERSION = "1.1.0"
 end

data/spec/core/association_spec.rb

@@ -180,6 +180,27 @@ describe ZendeskAPI::Association do
         subject.generate_path.should == "test_resources/1/blergh"
       end
     end
+
+    context "with a path on the association" do
+      before(:each) do
+        association = ZendeskAPI::TestResource.associations.detect {|a| a[:name] == :children}
+        association[:path] = "blergh"
+      end
+
+      it "should generate nested resource path" do
+        subject.generate_path.should == "test_resources/1/blergh"
+      end
+    end
+
+    context "with no association" do
+      before(:each) do
+        ZendeskAPI::TestResource.associations.clear
+      end
+
+      it "should generate nested resource path" do
+        subject.generate_path.should == "test_resources/test_children"
+      end
+    end
   end
 
   context "class with a parent id" do

data/spec/core/trackie_spec.rb

@@ -21,6 +21,24 @@ describe ZendeskAPI::Trackie do
     end
   end
 
+  context "deleting keys" do
+    before(:each) do
+      subject[:key] = true
+    end
+
+    it "returns key on deletion" do
+      subject.delete(:key).should be_true
+    end
+
+    context "after deletion" do
+      before(:each) { subject.delete(:key) }
+
+      it "keeps the changes" do
+        subject.changed?(:key).should be_true
+      end
+    end
+  end
+
   context "adding identical keys" do
     before(:each) do
       subject[:key] = "foo"

data/spec/live/app_spec.rb

@@ -0,0 +1,40 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::App do
+  it "should work "do
+    upload = VCR.use_cassette("app_upload_create") do
+      ZendeskAPI::App::Upload.new(client, :id => "spec/fixtures/sample_app.zip").tap(&:save!)
+    end
+
+    attributes = { :upload_id => upload.id, :name => "My App", :short_description => "Testing" }
+
+    app = ZendeskAPI::App.new(client, attributes)
+
+    VCR.use_cassette("app_create") { app.save! }
+
+    body = {}
+
+    VCR.use_cassette("app_create_job_status") do
+      until %w{failed completed}.include?(body["status"])
+        response = client.connection.get(app.response.headers["Location"])
+        body = response.body
+
+        sleep(3)
+      end
+    end
+
+    if body["status"] == "failed"
+      fail "Could not create app: #{body.inspect}"
+    end
+
+    app.id = body["app_id"]
+    app.short_description = "My Test App"
+
+    VCR.use_cassette("app_save") { app.save! }
+
+    app.short_description.should == "My Test App"
+    app.author_name.should == "Skip Moore"
+
+    VCR.use_cassette("app_destroy") { app.destroy! }
+  end
+end

data/spec/live/audit_spec.rb

@@ -2,4 +2,14 @@ require 'core/spec_helper'
 
 describe ZendeskAPI::Ticket::Audit do
   it_should_be_readable ticket, :audits
+
+  describe ZendeskAPI::Ticket::Audit::Event, :vcr do
+    it "should side-load events" do
+      audit = ticket.audits(include: :users).first
+      event = audit.events.first
+
+      event.should be_instance_of(ZendeskAPI::Ticket::Audit::Event)
+      event.author.should be_instance_of(ZendeskAPI::User)
+    end
+  end
 end

data/spec/live/installation_spec.rb

@@ -0,0 +1,57 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::App::Installation 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!)
+    end
+
+    attributes = { :upload_id => upload.id, :name => "My App", :short_description => "Testing" }
+
+    app = ZendeskAPI::App.new(client, attributes)
+
+    VCR.use_cassette("app_installations_create") { app.save! }
+
+    body = {}
+
+    VCR.use_cassette("app_installations_create_job_status") do
+      until %w{failed completed}.include?(body["status"])
+        response = client.connection.get(app.response.headers["Location"])
+        body = response.body
+
+        sleep(3)
+      end
+    end
+
+    if body["status"] == "failed"
+      fail "Could not create app: #{body.inspect}"
+    end
+
+    app.id = body["app_id"]
+
+    attributes = { :app_id => app.id, :settings => {
+        :name => "My App",
+        "Custom_Field_ID" => "123",
+        "Custom_Field_Default" => "Default"
+      }
+    }
+
+    install = ZendeskAPI::App::Installation.new(client, attributes)
+
+    VCR.use_cassette("app_install_create") { install.save! }
+
+    installations = client.app.installations
+    VCR.use_cassette("app_install_fetch") { installations.fetch! }
+
+    installations.should include(install)
+
+    install.settings.name = "My New Name"
+    VCR.use_cassette("app_install_update") { install.save! }
+
+    install.settings.title.should == "My New Name"
+
+    VCR.use_cassette("app_install_destroy") { install.destroy! }
+
+    VCR.use_cassette("app_installations_destroy") { app.destroy! }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -236,8 +236,8 @@ files:
 - Gemfile.lock
 - LICENSE
 - Procfile
+- README.md
 - Rakefile
-- Readme.md
 - bin/zendesk
 - config.ru
 - config/mongoid.yml
@@ -477,10 +477,12 @@ files:
 - spec/fixtures/cassettes/ZendeskAPI_Voice_PhoneNumber_update_create.json
 - spec/fixtures/cassettes/ZendeskAPI_Voice_PhoneNumber_update_delete.json
 - spec/fixtures/credentials.yml.example
+- spec/fixtures/sample_app.zip
 - spec/fixtures/test_resources.rb
 - spec/fixtures/zendesk.rb
 - spec/live/Readme.md
 - spec/live/activity_spec.rb
+- spec/live/app_spec.rb
 - spec/live/audit_spec.rb
 - spec/live/automation_spec.rb
 - spec/live/bookmark_spec.rb
@@ -492,6 +494,7 @@ 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
@@ -586,10 +589,12 @@ test_files:
 - spec/fixtures/cassettes/ZendeskAPI_Voice_PhoneNumber_update_create.json
 - spec/fixtures/cassettes/ZendeskAPI_Voice_PhoneNumber_update_delete.json
 - spec/fixtures/credentials.yml.example
+- spec/fixtures/sample_app.zip
 - spec/fixtures/test_resources.rb
 - spec/fixtures/zendesk.rb
 - spec/live/Readme.md
 - spec/live/activity_spec.rb
+- spec/live/app_spec.rb
 - spec/live/audit_spec.rb
 - spec/live/automation_spec.rb
 - spec/live/bookmark_spec.rb
@@ -601,6 +606,7 @@ 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