zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/update_user_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateUserField
   include Zendesk2::Request
 
@@ -5,14 +6,14 @@ class Zendesk2::UpdateUserField
   request_path { |r| "/user_fields/#{r.user_field_id}.json" }
 
   def user_field_id
-    params.fetch("user_field").fetch("id")
+    params.fetch('user_field').fetch('id')
   end
 
   def user_field_params
-    Cistern::Hash.slice(params.fetch("user_field"), *Zendesk2::CreateUserField.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user_field'), *Zendesk2::CreateUserField.accepted_attributes)
   end
 
   def mock
-    mock_response("user_field" => find!(:user_fields, user_field_id).merge!(user_field_params))
+    mock_response('user_field' => find!(:user_fields, user_field_id).merge!(user_field_params))
   end
 end

data/lib/zendesk2/update_user_identity.rb

@@ -1,27 +1,28 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateUserIdentity
   include Zendesk2::Request
 
   request_path { |r| "/users/#{r.user_id}/identities/#{r.user_identity_id}.json" }
   request_method :put
-  request_body { |r| { "identity" => r.user_identity_params } }
+  request_body { |r| { 'identity' => r.user_identity_params } }
 
   def self.accepted_attributes
-    %w[verified]
+    %w(verified)
   end
 
   def user_id
-    params.fetch("user_identity").fetch("user_id")
+    params.fetch('user_identity').fetch('user_id')
   end
 
   def user_identity_id
-    params.fetch("user_identity").fetch("id")
+    params.fetch('user_identity').fetch('id')
   end
 
   def user_identity_params
-    Cistern::Hash.slice(params.fetch("user_identity"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user_identity'), *self.class.accepted_attributes)
   end
 
   def mock
-    mock_response("identity" => self.find!(:identities, user_identity_id).merge!(user_identity_params))
+    mock_response('identity' => find!(:identities, user_identity_id).merge!(user_identity_params))
   end
 end

data/lib/zendesk2/update_view.rb

@@ -1,64 +1,68 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateView
   include Zendesk2::Request
 
   request_method :put
-  request_path { |r| "/views/#{r.view_id}.json"  }
-  request_body { |r| { "view" => r.view_params } }
+  request_path { |r| "/views/#{r.view_id}.json" }
+  request_body { |r| { 'view' => r.view_params } }
 
   def self.accepted_attributes
-    Zendesk2::Createview.accepted_attributes
+    Zendesk2::CreateView.accepted_attributes
   end
 
   def view_params
-    @_view_params ||= Cistern::Hash.slice(params.fetch("view"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('view'), *self.class.accepted_attributes)
   end
 
   def view_id
-    params.fetch("view").fetch("id")
+    params.fetch('view').fetch('id')
   end
 
   def mock
-    body = self.find!(:views, view_id)
+    body = find!(:views, view_id)
 
-    update_params = view_params.dup
+    update_params = view_params
 
-    output = params.delete("output") || {}
-    columns = (output["columns"] || []).inject([]) { |r,c| r << {"id" => c, "name" => Zendesk2::CreateView.view_columns.fetch(c)} }
+    output = update_params.delete('output') || {}
+    columns = (output['columns'] || []).inject([]) do |a, e|
+      a + [{ 'id' => e, 'name' => Zendesk2::CreateView.view_columns.fetch(c) }]
+    end
 
-    body.merge!("updated_at" => Time.now.iso8601)
+    body['updated_at'] = Time.now.iso8601
 
     if columns.any?
-      body.merge!(
-        "execution"        => {
-          "columns"       => columns,
-          "fields"        => columns,
-          "custom_fields" => [],
-        }
-      )
+      body['execution'] = {
+        'columns' => columns,
+        'fields'        => columns,
+        'custom_fields' => [],
+      }
     end
 
-    body["execution"]["conditions"].merge!(Cistern::Hash.slice(body, "any", "all"))
-
-    group_params = Cistern::Hash.slice(body, "group_by", "group_order").merge(Cistern::Hash.slice(update_params, "group_by", "group_order"))
+    body['execution']['conditions'] = Cistern::Hash.slice(body, 'any', 'all')
 
-    body.merge!(group_params).merge!(
-      "group" => {
-        "id"    => group_params["group_by"],
-        "order" => group_params["group_order"],
-        "title" => (group_params["group_by"] && group_params["group_by"].to_s.upcase),
-      },
+    group_params = Cistern::Hash.slice(body, 'group_by', 'group_order').merge(
+      Cistern::Hash.slice(update_params, 'group_by', 'group_order')
     )
 
-    sort_params = Cistern::Hash.slice(body, "sort_by", "sort_order").merge(Cistern::Hash.slice(update_params, "sort_by", "sort_order"))
+    body.merge!(group_params)['group'] = {
+      'id'    => group_params['group_by'],
+      'order' => group_params['group_order'],
+      'title' => (group_params['group_by'] && group_params['group_by'].to_s.upcase),
+    }
 
-    body.merge!(sort_params).merge!(
-      "sort" => {
-        "id"    => sort_params["sort_by"],
-        "order" => sort_params["sort_order"],
-        "title" => (sort_params["sort_by"] && sort_params["sort_by"].to_s.upcase),
-      },
+    sort_params = Cistern::Hash.slice(body, 'sort_by', 'sort_order').merge(
+      Cistern::Hash.slice(update_params, 'sort_by', 'sort_order')
     )
 
-    mock_response("view" => body)
+    body.merge!(sort_params)['sort'] = {
+      'id'    => sort_params['sort_by'],
+      'order' => sort_params['sort_order'],
+      'title' => (sort_params['sort_by'] && sort_params['sort_by'].to_s.upcase),
+    }
+
+    body.merge!(Cistern::Hash.slice(update_params, 'title', 'active'))
+    cistern.data[:views][view_id] = body
+
+    mock_response('view' => body)
   end
 end

data/lib/zendesk2/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::User
   include Zendesk2::Model
 
@@ -46,11 +47,13 @@ class Zendesk2::User
   attribute :shared, type: :boolean
   # @return [String] The signature of this user. Only agents and admins can have signatures
   attribute :signature, type: :string
-  # @return [Boolean] Tickets from suspended users are also suspended, and these users cannot log in to the end-user portal
+  # @return [Boolean] Tickets from suspended users are also suspended, and these users cannot log in to the end-user
+  #   portal
   attribute :suspended, type: :boolean
   # @return [Array] The tags of the user. Only present if your account has user tagging enabled
   attribute :tags, type: :array
-  # @return [String] Specified which tickets this user has access to. Possible values are: "organization", "groups", "assigned", "requested", null
+  # @return [String] Specified which tickets this user has access to.
+  #   Possible values are: "organization", "groups", "assigned", "requested", null
   attribute :ticket_restriction, type: :string
   # @return [String] The time-zone of this user
   attribute :time_zone, type: :string
@@ -70,12 +73,12 @@ class Zendesk2::User
     data = if new_record?
              requires :name, :email
 
-             cistern.create_user("user" => self.attributes)
+             cistern.create_user('user' => attributes)
            else
              requires :identity
 
-             cistern.update_user("user" => self.attributes)
-           end.body["user"]
+             cistern.update_user('user' => attributes)
+           end.body['user']
 
     merge_attributes(data)
   end
@@ -83,17 +86,15 @@ class Zendesk2::User
   def destroy!
     requires :identity
 
-    if self.email == cistern.username
-      raise "don't nuke yourself"
-    end
+    raise "don't nuke yourself" if email == cistern.username
 
     merge_attributes(
-      cistern.destroy_user("user" => {"id" => self.identity}).body["user"]
+      cistern.destroy_user('user' => { 'id' => identity }).body['user']
     )
   end
 
   def destroyed?
-    !reload || !self.active
+    !reload || !active
   end
 
   # @param [Time] timestamp time sent with intial handshake
@@ -101,28 +102,26 @@ class Zendesk2::User
   # @return [String] remote authentication login url
   # Using this method requires you to implement the additional (user-defined) /handshake endpoint
   # @see http://www.zendesk.com/support/api/remote-authentication
-  def login_url(timestamp, options={})
+  def login_url(timestamp, options = {})
     requires :name, :email
 
     return_to = options[:return_to]
-    token     = self.cistern.token || options[:token]
+    token     = cistern.token || options[:token]
 
-    uri      = URI.parse(self.cistern.url)
-    uri.path = "/access/remote"
+    uri      = URI.parse(cistern.url)
+    uri.path = '/access/remote'
 
-    raise "timestamp cannot be nil" unless timestamp
+    raise 'timestamp cannot be nil' unless timestamp
 
-    hash_str = "#{self.name}#{self.email}#{token}#{timestamp}"
+    hash_str = "#{name}#{email}#{token}#{timestamp}"
     query_values = {
       'name'      => name,
       'email'     => email,
       'timestamp' => timestamp,
-      'hash'      => Digest::MD5.hexdigest(hash_str)
+      'hash'      => Digest::MD5.hexdigest(hash_str),
     }
 
-    unless Zendesk2.blank?(return_to)
-      query_values['return_to'] = return_to
-    end
+    query_values['return_to'] = return_to unless Zendesk2.blank?(return_to)
 
     uri.query = Faraday::NestedParamsEncoder.encode(query_values)
 
@@ -137,26 +136,24 @@ class Zendesk2::User
     requires :name, :email
 
     return_to = options[:return_to]
-    jwt_token = self.cistern.jwt_token || options[:jwt_token]
+    jwt_token = cistern.jwt_token || options[:jwt_token]
 
-    uri       = URI.parse(self.cistern.url)
-    uri.path  = "/access/jwt"
+    uri       = URI.parse(cistern.url)
+    uri.path  = '/access/jwt'
 
     iat = Time.now.to_i
     jti = "#{iat}/#{rand(36**64).to_s(36)}"
     payload = JWT.encode({
-      :iat    => iat, # Seconds since epoch, determine when this token is stale
-      :jti    => jti, # Unique token id, helps prevent replay attacks
-      :name   => self.name,
-      :email  => self.email,
-    }, jwt_token)
+                           iat: iat, # Seconds since epoch, determine when this token is stale
+                           jti: jti, # Unique token id, helps prevent replay attacks
+                           name: name,
+                           email: email,
+                         }, jwt_token)
 
     query_values = {
-      'jwt' => payload
+      'jwt' => payload,
     }
-    unless Zendesk2.blank?(return_to)
-      query_values['return_to'] = return_to
-    end
+    query_values['return_to'] = return_to unless Zendesk2.blank?(return_to)
 
     uri.query = Faraday::NestedParamsEncoder.encode(query_values)
 
@@ -167,7 +164,7 @@ class Zendesk2::User
   def tickets
     requires :identity
 
-    cistern.tickets(requester_id: self.identity)
+    cistern.tickets(requester_id: identity)
   end
   alias requested_tickets tickets
 
@@ -175,21 +172,28 @@ class Zendesk2::User
   def ccd_tickets
     requires :identity
 
-    cistern.tickets(collaborator_id: self.identity)
+    cistern.tickets(collaborator_id: identity)
   end
 
   # @return [Zendesk2::UserIdentities] the identities of this user
   def identities
-    self.cistern.user_identities("user_id" => self.identity)
+    cistern.user_identities('user_id' => identity)
   end
 
   # @return [Zendesk2::Memberships] the organization memberships of this user
   def memberships
-    self.cistern.memberships(user: self)
+    cistern.memberships(user: self)
   end
 
   # @return [Zendesk2::Organizations] the organizations of this user through memberships
   def organizations
-    self.cistern.organizations(user: self)
+    cistern.organizations(user: self)
+  end
+
+  # @return [Zendesk2::HelpCenter::Post] authored posts
+  def posts
+    requires :identity
+
+    cistern.help_center_posts(user_id: identity)
   end
 end

data/lib/zendesk2/user_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::UserField
   include Zendesk2::Model
 
@@ -14,7 +15,8 @@ class Zendesk2::UserField
   attribute :custom_field_options, type: :array
   # @return [String] User-defined description of this field's purpose
   attribute :description, type: :string
-  # @return [String] create A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders.
+  # @return [String] create a unique key that identifies this custom field.
+  # This is used for updating the field and referencing in placeholders.
   attribute :key, type: :string
   # @return [Integer] Ordering of the field relative to other fields
   attribute :position, type: :integer
@@ -24,7 +26,8 @@ class Zendesk2::UserField
   attribute :tag, type: :string
   # @return [String] The title of the custom field
   attribute :title, type: :string
-  # @return [String] Supported types: "text", "textarea", "checkbox", "date", "integer", "decimal", "regexp", "tagger" (custom dropdown)
+  # @return [String] Supported types: "text", "textarea", "checkbox", "date", "integer", "decimal", "regexp", "tagger"
+  # (custom dropdown)
   attribute :type, type: :string
   # @return [Time] The time of the last update of the ticket field
   attribute :updated_at, type: :time
@@ -35,19 +38,19 @@ class Zendesk2::UserField
     response = if new_record?
                  requires :type, :title, :key
 
-                 cistern.create_user_field("user_field" => self.attributes)
+                 cistern.create_user_field('user_field' => attributes)
                else
                  requires :identity
 
-                 cistern.update_user_field("user_field" => self.attributes)
+                 cistern.update_user_field('user_field' => attributes)
                end
 
-    merge_attributes(response.body["user_field"])
+    merge_attributes(response.body['user_field'])
   end
 
   def destroy!
     requires :identity
 
-    cistern.destroy_user_field("user_field" => { "id" => self.identity })
+    cistern.destroy_user_field('user_field' => { 'id' => identity })
   end
 end

data/lib/zendesk2/user_fields.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::UserFields
   include Zendesk2::Collection
 
@@ -8,8 +9,8 @@ class Zendesk2::UserFields
   attribute :count
 
   self.collection_method = :get_user_fields
-  self.collection_root   = "user_fields"
+  self.collection_root   = 'user_fields'
   self.model_method      = :get_user_field
-  self.model_root        = "user_field"
-  self.search_type       = "user_field"
+  self.model_root        = 'user_field'
+  self.search_type       = 'user_field'
 end

data/lib/zendesk2/user_identities.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::UserIdentities
   include Zendesk2::Collection
 
@@ -7,10 +8,10 @@ class Zendesk2::UserIdentities
   attribute :count, type: :integer
 
   self.collection_method = :get_user_identities
-  self.collection_root   = "identities"
+  self.collection_root   = 'identities'
   self.model_method      = :get_user_identity
-  self.model_root        = "identity"
-  self.namespace         = "user_identity"
+  self.model_root        = 'identity'
+  self.namespace         = 'user_identity'
 
   scopes << :user_id
 end

data/lib/zendesk2/user_identity.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::UserIdentity
   include Zendesk2::Model
 
@@ -27,12 +28,12 @@ class Zendesk2::UserIdentity
     data = if new_record?
              requires :type, :value, :user_id
 
-             cistern.create_user_identity("user_identity" => self.attributes)
+             cistern.create_user_identity('user_identity' => attributes)
            else
              requires :identity
 
-             cistern.update_user_identity("user_identity" => self.attributes)
-           end.body["identity"]
+             cistern.update_user_identity('user_identity' => attributes)
+           end.body['identity']
 
     merge_attributes(data)
   end
@@ -40,20 +41,22 @@ class Zendesk2::UserIdentity
   def destroy!
     requires :identity
 
-    cistern.destroy_user_identity("user_identity" => { "user_id" => self.user_id, "id" => self.identity })
+    cistern.destroy_user_identity('user_identity' => { 'user_id' => user_id, 'id' => identity })
   end
 
   def reload
     requires :identity
 
-    if model = self.cistern.user_identities("user_id" => user_id).get(identity)
-      merge_attributes(model.attributes)
-      self
-    end
+    model = cistern.user_identities('user_id' => user_id).get(identity)
+
+    return false unless model
+
+    merge_attributes(model.attributes)
+    self
   end
 
   def primary!
-    self.cistern.mark_user_identity_primary("user_identity" => { "user_id" => self.user_id, "id" => self.identity })
+    cistern.mark_user_identity_primary('user_identity' => { 'user_id' => user_id, 'id' => identity })
     self.primary = true
   end
 end