zendesk2 1.4.2 → 1.5.3

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

@@ -1,47 +1,35 @@
-class Zendesk2::Client
-  class Real
-    def create_help_center_category(params={})
-      params = Cistern::Hash.stringify_keys(params)
-
-      require_parameters(params, "name")
-
-      request(
-        :body   => {"category" => params},
-        :method => :post,
-        :path   => "/help_center/categories.json",
-      )
-    end
-  end # Real
-
-  class Mock
-    def create_help_center_category(params={})
-      params = Cistern::Hash.stringify_keys(params)
-
-      require_parameters(params, "name")
-
-      identity = self.class.new_id
-
-      locale = params["locale"] ||= "en-us"
-      position = self.data[:help_center_categories].size
-
-      record = {
-        "id"          => identity,
-        "url"         => url_for("/help_center/#{locale}/categories/#{identity}.json"),
-        "html_url"    => html_url_for("/hc/#{locale}/categories/#{identity}.json"),
-        "author_id"   => current_user["id"],
-        "position"    => position,
-        "created_at"  => Time.now.iso8601,
-        "updated_at"  => Time.now.iso8601,
-        "description" => "",
-      }.merge(params)
-
-      self.data[:help_center_categories][identity] = record
-
-      response(
-        :method => :post,
-        :body   => {"category" => record},
-        :path   => "/categories.json"
-      )
-    end
-  end # Mock
-end # Zendesk2::Client
+class Zendesk2::Client::CreateHelpCenterCategory < Zendesk2::Client::Request
+  request_method :post
+  request_path { |_| "/help_center/categories.json" }
+  request_body { |r| {"category" => r.category_params} }
+
+  def self.accepted_attributes
+    %w[category_id description locale name position sorting]
+  end
+
+  def category_params
+    Cistern::Hash.slice(params.fetch("category"), *self.class.accepted_attributes)
+  end
+
+  def mock
+    identity = service.serial_id
+
+    locale = params["locale"] ||= "en-us"
+    position = self.data[:help_center_categories].size
+
+    record = {
+      "id"          => identity,
+      "url"         => url_for("/help_center/#{locale}/categories/#{identity}.json"),
+      "html_url"    => html_url_for("/hc/#{locale}/categories/#{identity}.json"),
+      "author_id"   => service.current_user["id"],
+      "position"    => position,
+      "created_at"  => Time.now.iso8601,
+      "updated_at"  => Time.now.iso8601,
+      "description" => "",
+    }.merge(category_params)
+
+    self.data[:help_center_categories][identity] = record
+
+    mock_response("category" => record)
+  end
+end

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

@@ -1,55 +1,49 @@
-class Zendesk2::Client
-  class Real
-    def create_help_center_section(params={})
-      category_id = require_parameters(params, "category_id")
-
-      request(
-        :body   => {"section" => params},
-        :method => :post,
-        :path   => "/help_center/categories/#{category_id}/sections.json",
-      )
-    end
-  end # Real
-
-  class Mock
-    def create_help_center_section(params={})
-      params = Cistern::Hash.stringify_keys(params)
-
-      identity = self.class.new_id
-
-      category_id = require_parameters(params, "category_id")
-
-      locale = params["locale"] ||= "en-us"
-      position = self.data[:help_center_sections].values.select { |a| a["category_id"] == category_id }.size
-
-      record = {
-        "id"                => identity,
-        "url"               => url_for("/help_center/#{locale}/sections/#{identity}.json"),
-        "html_url"          => html_url_for("/hc/#{locale}/sections/#{identity}.json"),
-        "author_id"         => current_user["id"],
-        "comments_disabled" => false,
-        "label_names"       => [],
-        "draft"             => false,
-        "promoted"          => false,
-        "position"          => position,
-        "vote_sum"          => 0,
-        "vote_count"        => 0,
-        "category_id"       => category_id,
-        "created_at"        => Time.now.iso8601,
-        "updated_at"        => Time.now.iso8601,
-        "name"              => "",
-        "body"              => "",
-        "source_locale"     => locale,
-        "outdated"          => false,
-      }.merge(params)
-
-      self.data[:help_center_sections][identity] = record
-
-      response(
-        :method => :post,
-        :body   => {"section" => record},
-        :path   => "/sections/#{category_id}.json"
-      )
-    end
-  end # Mock
-end # Zendesk2::Client
+class Zendesk2::Client::CreateHelpCenterSection < Zendesk2::Client::Request
+  request_method :post
+  request_path { |r| "/help_center/categories/#{r.category_id}/sections.json" }
+  request_body { |r| { "section" => r.section_params } }
+
+  def self.accepted_attributes
+    %w[category_id description locale name position sorting]
+  end
+
+  def section_params
+    Cistern::Hash.slice(params.fetch("section"), *self.class.accepted_attributes)
+  end
+
+  def category_id
+    params.fetch("section").fetch("category_id")
+  end
+
+  def mock
+    identity = service.serial_id
+
+    locale = params["locale"] ||= "en-us"
+    position = self.data[:help_center_sections].values.select { |a| a["category_id"] == category_id }.size
+
+    record = {
+      "id"                => identity,
+      "url"               => url_for("/help_center/#{locale}/sections/#{identity}.json"),
+      "html_url"          => html_url_for("/hc/#{locale}/sections/#{identity}.json"),
+      "author_id"         => service.current_user["id"],
+      "comments_disabled" => false,
+      "label_names"       => [],
+      "draft"             => false,
+      "promoted"          => false,
+      "position"          => position,
+      "vote_sum"          => 0,
+      "vote_count"        => 0,
+      "category_id"       => category_id,
+      "created_at"        => Time.now.iso8601,
+      "updated_at"        => Time.now.iso8601,
+      "name"              => "",
+      "body"              => "",
+      "source_locale"     => locale,
+      "outdated"          => false,
+    }.merge(section_params)
+
+    service.data[:help_center_sections][identity] = record
+
+    mock_response("section" => record)
+  end
+end

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

@@ -1,49 +1,49 @@
-class Zendesk2::Client
-  class Real
-    def create_membership(params={})
-      require_parameters(params, "user_id", "organization_id")
-
-      user_id = params["user_id"]
-
-      request(
-        :body   => {"organization_membership" => params },
-        :method => :post,
-        :path   => "/users/#{user_id}/organization_memberships.json",
-      )
+class Zendesk2::Client::CreateMembership < Zendesk2::Client::Request
+  request_method :post
+  request_path { |r|  "/users/#{r.user_id}/organization_memberships.json" }
+  request_body { |r| { "organization_membership" => r.membership_params } }
+
+  def self.accepted_params
+    %w[user_id organization_id default]
+  end
+
+  def membership_params
+    @_membership_params ||= Cistern::Hash.slice(params.fetch("membership"), *self.class.accepted_params)
+  end
+
+  def user_id
+    params.fetch("membership").fetch("user_id").to_i
+  end
+
+  def organization_id
+    params.fetch("membership").fetch("organization_id").to_i
+  end
+
+  def mock
+    find!(:users, user_id)
+    find!(:organizations, organization_id,
+          :error   => :invalid,
+          :details => {
+            "organization" => [ { "description" => "Organization cannot be blank" } ],
+          })
+
+    if self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["organization_id"] == organization_id }
+      error!(:invalid, description: { "user_id" => [ { "description" => "User has already been taken" } ] })
     end
-  end # Real
 
-  class Mock
-    def create_membership(params={})
-      require_parameters(params, "user_id", "organization_id")
+    resource_id = service.serial_id
 
-      user_id         = params["user_id"]
-      organization_id = params["organization_id"]
+    default_membership = false # !self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["default"] }
 
-      find!(:users, user_id)
-      find!(:organizations, organization_id, error: :invalid, details: { "organization" => [ { "description" => "Organization cannot be blank" } ] })
-      if self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["organization_id"] == organization_id }
-        error!(:invalid, description: { "user_id" => [ { "description" => "User has already been taken" } ] })
-      end
+    resource = {
+      "id"              => resource_id,
+      "user_id"         => user_id,
+      "organization_id" => organization_id,
+      "default"         => default_membership,
+    }
 
-      resource_id = self.class.new_id
+    self.data[:memberships][resource_id] = resource
 
-      default_membership = false # !self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["default"] }
-
-      resource = {
-        "id"              => resource_id,
-        "user_id"         => user_id,
-        "organization_id" => organization_id,
-        "default"         => default_membership,
-      }
-
-      self.data[:memberships][resource_id] = resource
-
-      response(
-        :method => :post,
-        :body   => { "organization_membership" => resource },
-        :path   => "/users/#{user_id}/organization_memberships.json",
-      )
-    end
-  end # Mock
+    mock_response("organization_membership" => resource)
+  end
 end

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

@@ -1,46 +1,36 @@
-class Zendesk2::Client
-  class Real
-    def create_organization(params={})
-      request(
-        :body   => {"organization" => params},
-        :method => :post,
-        :path   => "/organizations.json",
-      )
+class Zendesk2::Client::CreateOrganization < Zendesk2::Client::Request
+  request_method :post
+  request_path { |_| "/organizations.json" }
+  request_body { |r|  { "organization" => Cistern::Hash.except(r.params["organization"], "id") } }
+
+  def self.accepted_attributes
+    %w[details domain_names external_id group_id organization_fields shared_comments shared_tickets tags name notes]
+  end
+
+  def mock
+    identity = service.serial_id
+
+    record = {
+      "id"         => identity,
+      "url"        => url_for("/organizations/#{identity}.json"),
+      "created_at" => Time.now.iso8601,
+      "updated_at" => Time.now.iso8601,
+    }.merge(Cistern::Hash.slice(params.fetch("organization"), *self.class.accepted_attributes))
+
+    unless record["name"]
+      error!(:invalid, details: { "name" => [ { "description" => "Name cannot be blank" } ]})
     end
-  end # Real
 
-  class Mock
-    def create_organization(_params={})
-      params = Cistern::Hash.stringify_keys(_params)
-      identity = self.class.new_id
-
-      record = {
-        "id"         => identity,
-        "url"        => url_for("/organizations/#{identity}.json"),
-        "created_at" => Time.now.iso8601,
-        "updated_at" => Time.now.iso8601,
-      }.merge(params)
-
-
-      unless record["name"]
-        error!(:invalid, details: { "name" => [ { "description" => "Name cannot be blank" } ]})
-      end
-
-      if self.data[:organizations].values.find { |o| o["name"] == record["name"]}
-        error!(:invalid, details: {"name" => [ { "description" => "Name: has already been taken" } ]})
-      end
+    if self.data[:organizations].values.find { |o| o["name"].downcase == record["name"].downcase }
+      error!(:invalid, details: {"name" => [ { "description" => "Name: has already been taken" } ]})
+    end
 
-      if record["external_id"] && self.data[:organizations].values.find { |o| o["external_id"] == record["external_id"] }
-        error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
-      end
+    if record["external_id"] && self.data[:organizations].values.find { |o| o["external_id"] == record["external_id"] }
+      error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
+    end
 
-      self.data[:organizations][identity] = record
+    self.data[:organizations][identity] = record
 
-      response(
-        :method => :post,
-        :body   => {"organization" => record},
-        :path   => "/organizations.json"
-      )
-    end
-  end # Mock
+    mock_response({"organization" => record}, {status: 201})
+  end
 end

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

@@ -1,96 +1,87 @@
-class Zendesk2::Client
-  class Real
-    def create_ticket(params={})
-      request(
-        :body   => {"ticket" => params},
-        :method => :post,
-        :path   => "/tickets.json",
-      )
-    end
-  end # Real
+class Zendesk2::Client::CreateTicket < Zendesk2::Client::Request
+  request_method :post
+  request_path { |_| "/tickets.json" }
+  request_body { |r| {"ticket" => r.ticket_params} }
 
-  class Mock
-    def create_ticket(params={})
-      params = Cistern::Hash.stringify_keys(params)
+  def self.accepted_attributes
+    %w[external_id via priority requester requester_id submitter_id assignee_id organization_id subject description custom_fields recipient status collaborator_ids tags]
+  end
 
-      identity = self.class.new_id
+  def ticket_params
+    @_ticket_params ||= Cistern::Hash.slice(params.fetch("ticket"), *self.class.accepted_attributes)
+  end
 
-      if params["description"].nil? || params["description"] == ""
-        error!(:invalid, :details => {"base" => [{"description" => "Description: cannot be blank"}]})
-      end
+  def mock
+    create_params = ticket_params.dup
+
+    if create_params["description"].nil? || create_params["description"] == ""
+      error!(:invalid, :details => {"base" => [{"description" => "Description: cannot be blank"}]})
+    end
 
-      requester_id = params.delete('requester_id')
-
-      if requester = params.delete('requester')
-        if !requester['name'] || requester['name'].size < 1
-          response(
-            :path   => "/tickets.json",
-            :method => :post,
-            :status => 422,
-            :body   => {
-              "error"       => "RecordInvalid",
-              "description" => "Record validation errors",
-              "details"     => {
-                "requester" => [
-                  {
-                    "description" => "Requester Name:  is too short (minimum is 1 characters)"
-                  }
-                ]}})
-        end
-
-        user_id = if known_user = self.users.search(email: requester['email']).first
-                    known_user.identity
-                  else
-                    # name is not required in this case
-                    create_user(requester).body["user"]["id"]
-                  end.to_s
-
-        params['requester_id'] = user_id
+    requester_id = create_params.delete('requester_id')
+
+    if requester = create_params.delete('requester')
+      if !requester['name'] || requester['name'].size < 1
+        error!(:invalid,
+          :details => {
+            "requester" => [
+              {
+                "description" => "Requester Name:  is too short (minimum is 1 characters)"
+              }
+            ]})
       end
 
-      requested_custom_fields = (params.delete("custom_fields") || [])
+      user_id = if known_user = service.users.search(email: requester['email']).first
+                  known_user.identity
+                else
+                  # name is not required in this case
+                  service.create_user("user" => requester).body["user"]["id"]
+                end
+
+      create_params['requester_id'] = user_id.to_i
+    end
+
+    requested_custom_fields = (create_params.delete("custom_fields") || [])
 
-      custom_fields = requested_custom_fields.map do |cf|
-        field_id = cf["id"].to_i
-        if self.data[:ticket_fields][field_id.to_s]
-          {"id" => field_id, "value" => cf["value"] }
-        else
-          # @fixme error ?!
-        end
-      end.compact
+    custom_fields = requested_custom_fields.map do |cf|
+      field_id = cf["id"].to_i
 
-      self.data[:ticket_fields].each do |field_id, field|
-        requested_custom_fields.find { |cf| cf["id"].to_i == field_id.to_i } ||
-          custom_fields << {"id" => field_id.to_i, "value" => nil }
+      if service.data[:ticket_fields][field_id]
+        {"id" => field_id, "value" => cf["value"] }
+      else
+        # @fixme error ?!
       end
+    end.compact
 
-      record = {
-        "id"               => identity,
-        "url"              => url_for("/tickets/#{identity}.json"),
-        "created_at"       => Time.now.iso8601,
-        "updated_at"       => Time.now.iso8601,
-        "priority"         => nil,
-        "collaborator_ids" => [],
-        "custom_fields"    => custom_fields,
-      }.merge(params)
-
-      record["requester_id"] ||= (requester_id && requester_id.to_s) || current_user["id"].to_s
-      record["submitter_id"] = current_user["id"].to_s
-
-      # @note invalid requester id does NOT cause a 404 or 422
-      record["organization_id"] = if requester = self.data[:users][record["requester_id"]]
-                                    requester["organization_id"]
-                                  else
-                                    nil
-                                  end
-
-      self.data[:tickets][identity] = record
-
-      response(
-        :method => :post,
-        :body   => {"ticket" => record},
-        :path   => "/tickets.json"
-      )
+    service.data[:ticket_fields].each do |field_id, field|
+      requested_custom_fields.find { |cf| cf["id"] == field_id } ||
+        custom_fields << {"id" => field_id, "value" => nil }
     end
-  end # Mock
-end # Zendesk2::Client
+
+    identity = service.serial_id
+
+    record = {
+      "id"               => identity,
+      "url"              => url_for("/tickets/#{identity}.json"),
+      "created_at"       => Time.now.iso8601,
+      "updated_at"       => Time.now.iso8601,
+      "priority"         => nil,
+      "collaborator_ids" => [],
+      "custom_fields"    => custom_fields,
+    }.merge(create_params)
+
+    record["requester_id"] ||= (requester_id && requester_id.to_i) || service.current_user["id"]
+    record["submitter_id"] = service.current_user["id"].to_s
+
+    # @note invalid requester id does NOT cause a 404 or 422
+    record["organization_id"] = if requester = service.data[:users][record["requester_id"].to_i]
+                                  requester["organization_id"]
+                                else
+                                  nil
+                                end
+
+    service.data[:tickets][identity] = record
+
+    mock_response("ticket" => record)
+  end
+end