zendesk2 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODU3ZjQzNTA5Y2UzYzM5NmEwZDEyM2QyNjk1NmRmYjFhZDliMTkwNg==
+    ZDJlNjlkMmU1MDlhNWNmMWRhYmY1MzZlNDcwZjU0NmZmNzc0OGJmNA==
   data.tar.gz: !binary |-
-    NTJjNmY4MTVmN2UwYjM5MmY0YmIzODA3YzNiNDI5MWYzNTAxZjdhNw==
+    MmNiOGE1OGZlOTRmNzkyM2NjMTFmNjE1MDIxNjc1MmZlYzAyMTc5Zg==
 SHA512:
   metadata.gz: !binary |-
-    YzA2Y2E0MmI2NzA5MDZmMmRhZjZlNmY3MDQyZDM5YzY4NGU2NWI3NDJjNWNj
-    MTkyYjJhNzllMDgyNjMxZjAzZGYyMDA5ODVlM2QzNThlNmQ3NjdjNTM1ZWI4
-    OTFmODQyODVlOTYwNTkzNTE3ODJmZjA2NzlmMGVjMzY1MDhhMTk=
+    ZDg2OTJlZDNkNDBlZTViODc5MTljMTI1YjJjNGJjZDdiNjNhZDAxNzU0NTQ5
+    OWJiMDNjMzM4MzE2MTgxMGU2MzgzNzY2YTYwNWE5ZWJkNzVmODA1YmNjNmE1
+    NGFmNGY0NmFkMDk3ZDY5NDg1MjQ4NDEzNDBmNzcwNzM3Nzk1YTQ=
   data.tar.gz: !binary |-
-    MGNkMjE0M2M4OGFmOTQ4MjM2YTU2Y2M1NzRmMTg4NDFmMGEzZDE0YWM0NDA4
-    N2I3MjE2YTNmMTAzM2ViOTVkYjgxMDJkOWNkZTUzNTM2ZWQ1ZWJjN2EzOGFl
-    MGZhOTQ2MWY0NDI4OGFhMjM2MGExZDM1ZThlOWU0ZGExZDhjNjA=
+    MWQ2NjJhMTNjZGVlOWU1NDQxOGFiYWMxYjZjYWFmNTc2MTEyOTlkZWNhNzM0
+    YWMyMmNkYjFlZDI0OTU0NTE5MjNjNjRjNTQxNGU2ZTMwNTkxODIzYzE1YmRk
+    NTk2NWU3YzFmMjVlM2I3NGM3YjZmOTdkNTQ5YWUyYWFmNTI2ZTc=

data/Gemfile

@@ -7,11 +7,13 @@ gem 'rake'
 #To avoid warnings from JWT
 gem 'json', '~> 1.7.7'
 
+group :development, :test do
+  gem 'pry-nav'
+end
+
 group :test do
   gem 'awesome_print'
-  gem 'guard-bundler'
-  gem 'guard-rspec'
-  gem 'pry-nav'
-  gem 'rb-fsevent'
+  gem 'guard-bundler', require: false
+  gem 'guard-rspec', require: false
   gem 'rspec'
 end

data/Guardfile

@@ -3,7 +3,7 @@ guard 'bundler' do
   watch(/^.+\.gemspec/)
 end
 
-guard 'rspec', cmd: 'bundle exec rspec' do
+guard 'rspec', cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
   watch('spec/spec_helper.rb')  { "spec" }

data/lib/zendesk2/client/models/ticket.rb

@@ -1,7 +1,7 @@
 class Zendesk2::Client::Ticket < Zendesk2::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[external_id via requester_id submitter_id assignee_id organization_id subject description fields recipient status collaborator_ids tags]
+  PARAMS = %w[external_id via requester_id submitter_id assignee_id organization_id subject description custom_fields recipient status collaborator_ids tags]
 
   # @return [Integer] Automatically assigned when creating tickets
   identity :id, type: :integer

data/lib/zendesk2/client/models/ticket_field.rb

@@ -0,0 +1,75 @@
+class Zendesk2::Client::TicketField < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[type title description position active required collapsed_for_agents regexp_for_validation title_in_portal visible_in_portal editable_in_portal required_in_portal tag custom_field_options]
+
+  # @return [integer] Automatically assigned upon creation
+  identity :id, type: :integer
+
+  # @return [Boolean] Whether this field is available
+  attribute :active, type: :boolean
+  # @return [String] If this field should be shown to agents by default or be hidden alongside infrequently used fields
+  attribute :collapsed_for_agents, type: :string
+  # @return [Date] The time the ticket field was created
+  attribute :created_at, type: :date
+  # @return [Array] Required and presented for a ticket field of type "tagger"
+  attribute :custom_field_options, type: :array
+  # @return [String] The description of the purpose of this ticket field, shown to users
+  attribute :description, type: :string
+  # @return [Boolean] Whether this field is editable by end users
+  attribute :editable_in_portal, type: :boolean
+  # @return [Integer] A relative position for the ticket fields, determines the order of ticket fields on a ticket
+  attribute :position, type: :integer
+  # @return [String] Regular expression field only. The validation pattern for a field value to be deemed valid.
+  attribute :regexp_for_validation, type: :string
+  # @return [Boolean] If this field is not a system basic field that must be present for all tickets on the account
+  attribute :removable, type: :boolean
+  # @return [Boolean] If it's required for this field to have a value when updated by agents
+  attribute :required, type: :boolean
+  # @return [Boolean] If it's required for this field to have a value when updated by end users
+  attribute :required_in_portal, type: :boolean
+  # @return [Array] Presented for a ticket field of type "tickettype", "priority" or "status"
+  attribute :system_field_options, type: :array
+  # @return [String] A tag value to set for checkbox fields when checked
+  attribute :tag, type: :string
+  # @return [String] The title of the ticket field
+  attribute :title, type: :string
+  # @return [String] The title of the ticket field when shown to end users
+  attribute :title_in_portal, type: :string
+  # @return [String] The type of the ticket field
+  attribute :type, type: :string
+  # @return [Date] The time of the last update of the ticket field
+  attribute :updated_at, type: :date
+  # @return [String] The URL for this resource
+  attribute :url, type: :string
+  # @return [Boolean] Whether this field is available to end users
+  attribute :visible_in_portal, type: :boolean
+
+  def save!
+    data = if new_record?
+             requires :type, :title
+
+             self.custom_field_options ||= []
+
+             connection.create_ticket_field(params).body["ticket_field"]
+           else
+             requires :identity
+
+             connection.update_ticket_field(params.merge("id" => self.identity)).body["ticket_field"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy!
+    requires :identity
+
+    connection.destroy_ticket_field("id" => self.identity)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

data/lib/zendesk2/client/models/ticket_fields.rb

@@ -0,0 +1,11 @@
+class Zendesk2::Client::TicketFields < Zendesk2::Collection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::TicketField
+
+  self.collection_method = :get_ticket_fields
+  self.collection_root   = "ticket_fields"
+  self.model_method      = :get_ticket_field
+  self.model_root        = "ticket_field"
+  self.search_type       = "ticket_field"
+end

data/lib/zendesk2/client/requests/create_ticket_field.rb

@@ -0,0 +1,42 @@
+class Zendesk2::Client
+  class Real
+    def create_ticket_field(params={})
+      request(
+        :body   => {"ticket_field" => params},
+        :method => :post,
+        :path   => "/ticket_fields.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_ticket_field(params={})
+      identity = self.class.new_id
+
+      record = {
+        "active"                => true,
+        "collapsed_for_agents"  => false,
+        "created_at"            => Time.now.iso8601,
+        "description"           => params["title"],
+        "editable_in_portal"    => false,
+        "id"                    => identity,
+        "position"              => 9999,
+        "regexp_for_validation" => nil,
+        "required"              => true,
+        "required_in_portal"    => false,
+        "title_in_portal"       => params["title"],
+        "updated_at"            => Time.now.iso8601,
+        "url"                   => url_for("/ticket_fields/#{identity}.json"),
+        "visible_in_portal"     => false,
+      }.merge(params)
+
+      self.data[:ticket_fields][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"ticket_field" => record},
+        :path   => "/ticket_fields.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

data/lib/zendesk2/client/requests/destroy_ticket_field.rb

@@ -0,0 +1,27 @@
+class Zendesk2::Client
+  class Real
+    def destroy_ticket_field(params={})
+      id = params["id"]
+
+      request(
+        :method => :delete,
+        :path   => "/ticket_fields/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_ticket_field(params={})
+      id   = params["id"]
+      body = self.data[:ticket_fields].delete(id)
+
+      response(
+        :method => :delete,
+        :path   => "/ticket_fields/#{id}.json",
+        :body   => {
+          "ticket_field" => body,
+        },
+      )
+    end
+  end
+end

data/lib/zendesk2/client/requests/get_ticket_field.rb

@@ -0,0 +1,34 @@
+class Zendesk2::Client
+  class Real
+    def get_ticket_field(params={})
+      id = params["id"]
+
+      request(
+        :method => :get,
+        :path => "/ticket_fields/#{id}.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_ticket_field(params={})
+      id   = params["id"]
+      path = "/ticket_fields/#{id}.json"
+
+      if body = self.data[:ticket_fields][id]
+        response(
+          :path => path,
+          :body => {
+            "ticket_field" => body
+          },
+        )
+      else
+        response(
+          :path   => path,
+          :status => 404,
+          :body => {"error" => "RecordNotFound", "description" => "Not found"},
+        )
+      end
+    end
+  end # Mock
+end

data/lib/zendesk2/client/requests/get_ticket_fields.rb

@@ -0,0 +1,18 @@
+class Zendesk2::Client
+  class Real
+    def get_ticket_fields(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/ticket_fields.json",
+      )
+    end
+  end
+  class Mock
+    def get_ticket_fields(params={})
+      page(params, :ticket_fields, "/ticket_fields.json", "ticket_fields")
+    end
+  end
+end

data/lib/zendesk2/client/requests/update_ticket_field.rb

@@ -0,0 +1,29 @@
+class Zendesk2::Client
+  class Real
+    def update_ticket_field(params={})
+      id = params.delete("id")
+
+      request(
+        :method => :put,
+        :path   => "/ticket_fields/#{id}.json",
+        :body   => {
+          "ticket_field" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_ticket_field(params={})
+      ticket_field_id = params.delete("id")
+      body            = self.data[:ticket_fields][ticket_field_id].merge!(params)
+
+      response(
+        :method => :put,
+        :path   => "/ticket_fields/#{ticket_field_id}.json",
+        :body   => {
+          "ticket_field" => body
+        },
+      )
+    end
+  end
+end

data/lib/zendesk2/client.rb

@@ -11,6 +11,7 @@ class Zendesk2::Client < Cistern::Service
   collection :groups
   collection :organizations
   collection :ticket_audits
+  collection :ticket_fields
   collection :ticket_metrics
   collection :tickets
   collection :ticket_comments
@@ -29,6 +30,7 @@ class Zendesk2::Client < Cistern::Service
   model :ticket_comment
   model :ticket_comment_privacy_change
   model :ticket_create
+  model :ticket_field
   model :ticket_notification
   model :ticket_voice_comment
   model :topic
@@ -42,6 +44,7 @@ class Zendesk2::Client < Cistern::Service
   request :create_group
   request :create_organization
   request :create_ticket
+  request :create_ticket_field
   request :create_topic
   request :create_topic_comment
   request :create_user
@@ -51,6 +54,7 @@ class Zendesk2::Client < Cistern::Service
   request :destroy_group
   request :destroy_organization
   request :destroy_ticket
+  request :destroy_ticket_field
   request :destroy_topic
   request :destroy_topic_comment
   request :destroy_user
@@ -74,6 +78,8 @@ class Zendesk2::Client < Cistern::Service
   request :get_ticket_audit
   request :get_ticket_audits
   request :get_ticket_comments
+  request :get_ticket_field
+  request :get_ticket_fields
   request :get_ticket_metric
   request :get_ticket_metrics
   request :get_tickets
@@ -94,6 +100,7 @@ class Zendesk2::Client < Cistern::Service
   request :update_organization
   request :update_request
   request :update_ticket
+  request :update_ticket_field
   request :update_topic
   request :update_topic_comment
   request :update_user
@@ -129,7 +136,7 @@ class Zendesk2::Client < Cistern::Service
       @username         += "/token" if @auth_token == @token
       @jwt_token         = options[:jwt_token]
 
-      raise "Missing required options: :username" unless @username 
+      raise "Missing required options: :username" unless @username
       raise "Missing required options: :password or :token" unless password || @token
 
       @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
@@ -171,18 +178,19 @@ class Zendesk2::Client < Cistern::Service
 
     def self.data
       @data ||= {
-        :categories     => {},
-        :forums         => {},
-        :groups         => {},
-        :identities     => {},
-        :organizations  => {},
-        :ticket_audits  => {},
+        :categories      => {},
+        :forums          => {},
+        :groups          => {},
+        :identities      => {},
+        :organizations   => {},
+        :ticket_audits   => {},
         :ticket_comments => {},
-        :ticket_metrics => {},
-        :tickets        => {},
-        :topic_comments => {},
-        :topics         => {},
-        :users          => {},
+        :ticket_fields   => {},
+        :ticket_metrics  => {},
+        :tickets         => {},
+        :topic_comments  => {},
+        :topics          => {},
+        :users           => {},
       }
     end
 

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/ticket_fields_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "ticket_fields" do
+  let(:client) { create_client }
+
+  it_should_behave_like "a resource", :ticket_fields,
+    lambda { { title: Zendesk2.uuid, type: "text" } },
+    lambda { { title: Zendesk2.uuid } }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Josh Lane
@@ -117,6 +117,8 @@ files:
 - lib/zendesk2/client/models/ticket_comment_privacy_change.rb
 - lib/zendesk2/client/models/ticket_comments.rb
 - lib/zendesk2/client/models/ticket_create.rb
+- lib/zendesk2/client/models/ticket_field.rb
+- lib/zendesk2/client/models/ticket_fields.rb
 - lib/zendesk2/client/models/ticket_metric.rb
 - lib/zendesk2/client/models/ticket_metrics.rb
 - lib/zendesk2/client/models/ticket_notification.rb
@@ -135,6 +137,7 @@ files:
 - lib/zendesk2/client/requests/create_group.rb
 - lib/zendesk2/client/requests/create_organization.rb
 - lib/zendesk2/client/requests/create_ticket.rb
+- lib/zendesk2/client/requests/create_ticket_field.rb
 - lib/zendesk2/client/requests/create_topic.rb
 - lib/zendesk2/client/requests/create_topic_comment.rb
 - lib/zendesk2/client/requests/create_user.rb
@@ -144,6 +147,7 @@ files:
 - lib/zendesk2/client/requests/destroy_group.rb
 - lib/zendesk2/client/requests/destroy_organization.rb
 - lib/zendesk2/client/requests/destroy_ticket.rb
+- lib/zendesk2/client/requests/destroy_ticket_field.rb
 - lib/zendesk2/client/requests/destroy_topic.rb
 - lib/zendesk2/client/requests/destroy_topic_comment.rb
 - lib/zendesk2/client/requests/destroy_user.rb
@@ -168,6 +172,8 @@ files:
 - lib/zendesk2/client/requests/get_ticket_audit.rb
 - lib/zendesk2/client/requests/get_ticket_audits.rb
 - lib/zendesk2/client/requests/get_ticket_comments.rb
+- lib/zendesk2/client/requests/get_ticket_field.rb
+- lib/zendesk2/client/requests/get_ticket_fields.rb
 - lib/zendesk2/client/requests/get_ticket_metric.rb
 - lib/zendesk2/client/requests/get_ticket_metrics.rb
 - lib/zendesk2/client/requests/get_tickets.rb
@@ -188,6 +194,7 @@ files:
 - lib/zendesk2/client/requests/update_organization.rb
 - lib/zendesk2/client/requests/update_request.rb
 - lib/zendesk2/client/requests/update_ticket.rb
+- lib/zendesk2/client/requests/update_ticket_field.rb
 - lib/zendesk2/client/requests/update_topic.rb
 - lib/zendesk2/client/requests/update_topic_comment.rb
 - lib/zendesk2/client/requests/update_user.rb
@@ -206,6 +213,7 @@ files:
 - spec/shared/resource.rb
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
+- spec/ticket_fields_spec.rb
 - spec/tickets_spec.rb
 - spec/topic_comments_spec.rb
 - spec/topics_spec.rb
@@ -245,6 +253,7 @@ test_files:
 - spec/shared/resource.rb
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
+- spec/ticket_fields_spec.rb
 - spec/tickets_spec.rb
 - spec/topic_comments_spec.rb
 - spec/topics_spec.rb