zendesk2 1.4.2 → 1.5.3

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

@@ -1,4 +1,4 @@
-class Zendesk2::Client::TicketAudit < Cistern::Model
+class Zendesk2::Client::TicketAudit < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
   # @return [Integer] Automatically assigned when creating audits
@@ -19,10 +19,10 @@ class Zendesk2::Client::TicketAudit < Cistern::Model
   def ticket
     requires :ticket_id
 
-    self.connection.tickets.get(self.ticket_id)
+    self.service.tickets.get(self.ticket_id)
   end
 
   def events
-    (self.attributes[:events] || []).map{|ae| Zendesk2::Client::AuditEvent.for(ae.merge(ticket_audit: self, connection: self.connection))}
+    (self.attributes[:events] || []).map{|ae| Zendesk2::Client::AuditEvent.for(ae.merge(ticket_audit: self, service: self.service))}
   end
 end

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

@@ -20,7 +20,7 @@ class Zendesk2::Client
     def author
       requires :author_id
 
-      self.connection.users.get(self.author_id)
+      self.service.users.get(self.author_id)
     end
   end
 end

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

@@ -13,7 +13,7 @@ class Zendesk2::Client
     def comment
       requires :comment_id
 
-      self.connection.ticket_comments.get(self.comment_id)
+      self.service.ticket_comments.get(self.comment_id)
     end
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::TicketField < Zendesk2::Model
+class Zendesk2::Client::TicketField < Zendesk2::Client::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
 
@@ -49,12 +47,12 @@ class Zendesk2::Client::TicketField < Zendesk2::Model
     data = if new_record?
              requires :type, :title
 
-             connection.create_ticket_field(params).body["ticket_field"]
+             service.create_ticket_field("ticket_field" => self.attributes)
            else
              requires :identity
 
-             connection.update_ticket_field(params.merge("id" => self.identity)).body["ticket_field"]
-           end
+             service.update_ticket_field("ticket_field" => self.attributes)
+           end.body["ticket_field"]
 
     merge_attributes(data)
   end
@@ -62,12 +60,6 @@ class Zendesk2::Client::TicketField < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_ticket_field("id" => self.identity)
-  end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    service.destroy_ticket_field("ticket_field" => { "id" => self.identity })
   end
 end

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

@@ -48,7 +48,7 @@ class Zendesk2::Client::TicketMetric < Cistern::Model
   def ticket
     requires :ticket_id
 
-    self.connection.tickets.get(self.ticket_id)
+    self.service.tickets.get(self.ticket_id)
   end
 
 end

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

@@ -28,7 +28,7 @@ class Zendesk2::Client
     def author
       requires :author_id
 
-      self.connection.users.get(self.author_id)
+      self.service.users.get(self.author_id)
     end
   end
 end

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

@@ -1,9 +1,8 @@
-class Zendesk2::Client::Topic < Zendesk2::Model
+class Zendesk2::Client::Topic < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[id title body submitter_id updater_id forum_id locked pinned highlighted position tags]
+  identity :id, type: :integer # ro[yes] mandatory[no]   Automatically assigned upon creation
 
-  identity  :id,           type: :integer # ro[yes] mandatory[no]   Automatically assigned upon creation
   attribute :url,          type: :string  # ro[yes] mandatory[no]   The API url of this topic
   attribute :title,        type: :string  # ro[no] mandatory[yes]   The title of the topic
   attribute :body,         type: :string  # ro[no] mandatory[yes] The unescaped body of the topic
@@ -23,31 +22,27 @@ class Zendesk2::Client::Topic < Zendesk2::Model
   assoc_accessor :updater, collection: :users
   assoc_accessor :forum
 
-
   def destroy!
     requires :identity
 
-    connection.destroy_topic("id" => self.identity)
+    service.destroy_topic("topic" => {"id" => self.identity})
   end
 
   def save!
     data = if new_record?
              requires :title, :body
-             connection.create_topic(params).body["topic"]
+
+             service.create_topic("topic" => self.attributes)
            else
              requires :identity
-             connection.update_topic(params).body["topic"]
-           end
+
+             service.update_topic("topic" => self.attributes)
+           end.body["topic"]
+
     merge_attributes(data)
   end
 
   def comments
     self.topic_comments(topic_id: topic_id)
   end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-  end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::TopicComment < Zendesk2::Model
+class Zendesk2::Client::TopicComment < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[id topic_id user_id body informative]
-
   # @return [Integer] Automatically assigned upon creation
   identity :id, type: :integer
 
@@ -29,33 +27,30 @@ class Zendesk2::Client::TopicComment < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_topic_comment("id" => self.identity, "topic_id" => self.topic_id)
+    service.destroy_topic_comment("topic_comment" => { "id" => self.identity, "topic_id" => self.topic_id })
   end
 
   def save!
-    data = if new_record?
-             requires :topic_id, :user_id, :body
-             connection.create_topic_comment(params).body["topic_comment"]
-           else
-             requires :identity
-             connection.update_topic_comment(params).body["topic_comment"]
-           end
-    merge_attributes(data)
+    response = if new_record?
+                 requires :topic_id, :user_id, :body
+
+                 service.create_topic_comment("topic_comment" => self.attributes)
+               else
+                 requires :identity
+
+                 service.update_topic_comment("topic_comment" => self.attributes)
+               end
+
+    merge_attributes(response.body["topic_comment"])
   end
 
   def reload
     requires :identity
 
-    if data = self.connection.topic_comments("topic_id" => topic_id).get(identity)
+    if data = self.service.topic_comments("topic_id" => topic_id).get(identity)
       new_attributes = data.attributes
       merge_attributes(new_attributes)
       self
     end
   end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-  end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::User < Zendesk2::Model
+class Zendesk2::Client::User < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[name email organization_id external_id alias verified locate_id time_zone phone signature details notes role custom_role_id moderator ticket_restriction only_private_comments]
-
   # @return [Integer] Automatically assigned when creating users
   identity :id, type: :integer
 
@@ -68,22 +66,23 @@ class Zendesk2::Client::User < Zendesk2::Model
     data = if new_record?
              requires :name, :email
 
-             connection.create_user(params).body["user"]
+             service.create_user("user" => self.attributes)
            else
              requires :identity
 
-             connection.update_user(params.merge("id" => self.identity)).body["user"]
-           end
+             service.update_user("user" => self.attributes)
+           end.body["user"]
 
     merge_attributes(data)
   end
 
   def destroy!
     requires :identity
-    raise "don't nuke yourself" if self.email == connection.username
+    raise "don't nuke yourself" if self.email == service.username
 
-    data = connection.destroy_user("id" => self.identity).body["user"]
-    merge_attributes(data)
+    merge_attributes(
+      service.destroy_user("user" => {"id" => self.identity}).body["user"]
+    )
   end
 
   def destroyed?
@@ -99,9 +98,9 @@ class Zendesk2::Client::User < Zendesk2::Model
     requires :name, :email
 
     return_to = options[:return_to]
-    token     = self.connection.token || options[:token]
+    token     = self.service.token || options[:token]
 
-    uri      = Addressable::URI.parse(self.connection.url)
+    uri      = URI.parse(self.service.url)
     uri.path = "/access/remote"
 
     raise "timestamp cannot be nil" unless timestamp
@@ -113,10 +112,12 @@ class Zendesk2::Client::User < Zendesk2::Model
       'timestamp' => timestamp,
       'hash'      => Digest::MD5.hexdigest(hash_str)
     }
+
     unless Zendesk2.blank?(return_to)
       query_values['return_to'] = return_to
     end
-    uri.query_values = query_values
+
+    uri.query = Faraday::NestedParamsEncoder.encode(query_values)
 
     uri.to_s
   end
@@ -129,9 +130,9 @@ class Zendesk2::Client::User < Zendesk2::Model
     requires :name, :email
 
     return_to = options[:return_to]
-    jwt_token = self.connection.jwt_token || options[:jwt_token]
+    jwt_token = self.service.jwt_token || options[:jwt_token]
 
-    uri       = Addressable::URI.parse(self.connection.url)
+    uri       = URI.parse(self.service.url)
     uri.path  = "/access/jwt"
 
     iat = Time.now.to_i
@@ -149,7 +150,8 @@ class Zendesk2::Client::User < Zendesk2::Model
     unless Zendesk2.blank?(return_to)
       query_values['return_to'] = return_to
     end
-    uri.query_values = query_values
+
+    uri.query = Faraday::NestedParamsEncoder.encode(query_values)
 
     uri.to_s
   end
@@ -158,9 +160,9 @@ class Zendesk2::Client::User < Zendesk2::Model
   def tickets
     requires :identity
 
-    data = connection.get_requested_tickets("id" => self.identity).body["tickets"]
-
-    connection.tickets.load(data)
+    service.tickets.load(
+      service.get_requested_tickets("user_id" => self.identity).body["tickets"]
+    )
   end
   alias requested_tickets tickets
 
@@ -168,27 +170,18 @@ class Zendesk2::Client::User < Zendesk2::Model
   def ccd_tickets
     requires :identity
 
-    data = connection.get_ccd_tickets("id" => self.identity).body["tickets"]
-
-    connection.tickets.load(data)
+    service.tickets.load(
+      service.get_ccd_tickets("user_id" => self.identity).body["tickets"]
+    )
   end
 
   # @return [Zendesk2::Client::UserIdentities] the identities of this user
   def identities
-    self.connection.user_identities("user_id" => self.identity)
+    self.service.user_identities("user_id" => self.identity)
   end
 
   # @return [Zendesk2::Client::Memberships] the organization memberships of this user
   def memberships
-    self.connection.memberships(user: self)
-  end
-
-  private
-
-  def params
-    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-    writable_attributes.delete("organization_id") if writable_attributes["organization_id"] == 0
-    writable_attributes.delete("custom_role_id") if writable_attributes["custom_role_id"] == 0
-    writable_attributes
+    self.service.memberships(user: self)
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::UserField < Zendesk2::Model
+class Zendesk2::Client::UserField < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[key type title description position active, regexp_for_validation tag custom_field_options]
-
   # @return [Integer] Automatically assigned upon creation
   identity :id, type: :integer
 
@@ -32,28 +30,22 @@ class Zendesk2::Client::UserField < Zendesk2::Model
   attribute :url, type: :string
 
   def save!
-    data = if new_record?
-             requires :type, :title, :key
+    response = if new_record?
+                 requires :type, :title, :key
 
-             connection.create_user_field(params).body["user_field"]
-           else
-             requires :identity
+                 service.create_user_field("user_field" => self.attributes)
+               else
+                 requires :identity
 
-             connection.update_user_field(params.merge("id" => self.identity)).body["user_field"]
-           end
+                 service.update_user_field("user_field" => self.attributes)
+               end
 
-    merge_attributes(data)
+    merge_attributes(response.body["user_field"])
   end
 
   def destroy!
     requires :identity
 
-    connection.destroy_user_field("id" => self.identity)
-  end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    service.destroy_user_field("user_field" => { "id" => self.identity })
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::UserIdentity < Zendesk2::Model
+class Zendesk2::Client::UserIdentity < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[primary verified type value user_id]
-
   # @return [Integer] Automatically assigned upon creation
   identity :id, type: :integer
 
@@ -27,40 +25,33 @@ class Zendesk2::Client::UserIdentity < Zendesk2::Model
     data = if new_record?
              requires :type, :value, :user_id
 
-             connection.create_user_identity(params).body["identity"]
+             service.create_user_identity("user_identity" => self.attributes)
            else
              requires :identity
 
-             update_params = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "verified", "id", "user_id")
-             connection.update_user_identity(update_params).body["identity"]
-           end
+             service.update_user_identity("user_identity" => self.attributes)
+           end.body["identity"]
+
     merge_attributes(data)
   end
 
   def destroy!
     requires :identity
 
-    connection.destroy_user_identity("user_id" => self.user_id, "id" => self.identity)
+    service.destroy_user_identity("user_identity" => { "user_id" => self.user_id, "id" => self.identity })
   end
 
   def reload
     requires :identity
 
-    if data = self.connection.user_identities("user_id" => user_id).get(identity)
-      new_attributes = data.attributes
-      merge_attributes(new_attributes)
+    if model = self.service.user_identities("user_id" => user_id).get(identity)
+      merge_attributes(model.attributes)
       self
     end
   end
 
   def primary!
-    self.connection.mark_user_identity_primary("user_id" => self.user_id, "id" => self.identity)
+    self.service.mark_user_identity_primary("user_identity" => { "user_id" => self.user_id, "id" => self.identity })
     self.primary = true
   end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-  end
 end

data/lib/zendesk2/client/real.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client < Cistern::Service
   class Real
-    include Zendesk2::Client::Shared
 
-    attr_accessor :username, :url, :token, :logger, :jwt_token
+    attr_accessor :username, :url, :token, :logger, :jwt_token, :last_request
 
     def initialize(options={})
       @url = if url = options[:url] || Zendesk2.defaults[:url]
-               Addressable::URI.parse(url).to_s
+               URI.parse(url).to_s
              end
 
       @logger   = options[:logger]   || Logger.new(nil)
@@ -15,7 +14,7 @@ class Zendesk2::Client < Cistern::Service
       @token    = options[:token]    || Zendesk2.defaults[:token]
       password  = options[:password] || Zendesk2.defaults[:password]
 
-      connection_options = options[:connection_options] || {}
+      service_options = options[:service_options] || {}
 
       @auth_token  = password || @token
       @username   += "/token" if @auth_token == @token
@@ -25,7 +24,7 @@ class Zendesk2::Client < Cistern::Service
       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|
+      @service = Faraday.new({url: @url}.merge(service_options)) do |builder|
         # response
         builder.use Faraday::Request::BasicAuthentication, @username, @auth_token
         builder.use Faraday::Response::RaiseError
@@ -47,11 +46,11 @@ class Zendesk2::Client < Cistern::Service
       body    = options[:body]
       headers = {"User-Agent" => USER_AGENT}.merge(options[:headers] || {})
 
-      @connection.send(method) do |req|
-        req.url url
+      @service.send(method) do |req|
+        req.url(url)
         req.headers.merge!(headers)
         req.params.merge!(params)
-        req.body = body
+        req.body = @last_request = body
       end
     rescue Faraday::Error::ClientError => e
       raise Zendesk2::Error.new(e)