zendesk2 1.4.2 → 1.5.3

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

@@ -1,29 +1,17 @@
-class Zendesk2::Client
-  class Real
-    def update_ticket_field(params={})
-      id = params.delete("id")
+class Zendesk2::Client::UpdateTicketField < Zendesk2::Client::Request
+  request_method :put
+  request_path { |r| "/ticket_fields/#{r.ticket_field_id}.json" }
+  request_body { |r| { "ticket_field" => r.ticket_field_params } }
 
-      request(
-        :method => :put,
-        :path   => "/ticket_fields/#{id}.json",
-        :body   => {
-          "ticket_field" => params
-        },
-      )
-    end
+  def ticket_field_id
+    params.fetch("ticket_field").fetch("id")
   end
-  class Mock
-    def update_ticket_field(params={})
-      id   = params.delete("id")
-      body = self.find!(:ticket_fields, id).merge!(params)
 
-      response(
-        :method => :put,
-        :path   => "/ticket_fields/#{id}.json",
-        :body   => {
-          "ticket_field" => body
-        },
-      )
-    end
+  def ticket_field_params
+    Cistern::Hash.slice(params.fetch("ticket_field"), *Zendesk2::Client::CreateTicketField.accepted_attributes)
+  end
+
+  def mock
+    mock_response("ticket_field" => self.find!(:ticket_fields, ticket_field_id).merge!(ticket_field_params))
   end
 end

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

@@ -1,31 +1,17 @@
-class Zendesk2::Client
-  class Real
-    def update_topic(params={})
-      id = params.delete("id")
+class Zendesk2::Client::UpdateTopic < Zendesk2::Client::Request
+  request_method :put
+  request_path { |r| "/topics/#{r.topic_id}.json" }
+  request_body { |r| { "topic" => r.topic_params } }
 
-      request(
-        :method => :put,
-        :path   => "/topics/#{id}.json",
-        :body   => {
-          "topic" => params
-        },
-      )
-    end
+  def topic_id
+    params.fetch("topic").fetch("id").to_i
   end
-  class Mock
-    def update_topic(params={})
-      id   = params.delete("id")
-      path = "/topics/#{id}.json"
 
-      body = self.find!(:topics, id).merge!(params)
+  def topic_params
+    Cistern::Hash.slice(params.fetch("topic"), *Zendesk2::Client::CreateTopic.accepted_attributes)
+  end
 
-      response(
-        :method => :put,
-        :path   => path,
-        :body   => {
-          "topic" => body
-        },
-      )
-    end
+  def mock
+    mock_response("topic" => self.find!(:topics, topic_id).merge!(topic_params))
   end
 end

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

@@ -1,73 +1,58 @@
-class Zendesk2::Client
-  class Real
-    def update_user(_params={})
-      params = Cistern::Hash.stringify_keys(_params)
-      id     = params.delete("id")
+class Zendesk2::Client::UpdateUser < Zendesk2::Client::Request
+  request_method :put
+  request_path { |r| "/users/#{r.user_id}.json" }
+  request_body { |r| {"user" => r.user_params } }
 
-      request(
-        :method => :put,
-        :path   => "/users/#{id}.json",
-        :body   => {
-          "user" => params
-        },
-      )
-    end
+  def user_params
+    @_user_params ||= Cistern::Hash.slice(params.fetch("user"), *Zendesk2::Client::CreateUser.accepted_attributes)
   end
-  class Mock
-    def update_user(_params={})
-      params  = Cistern::Hash.stringify_keys(_params)
-      user_id = params.delete("id").to_s
-      path    = "/users/#{user_id}.json"
-
-      email = params["email"]
-
-      other_users = self.data[:users].dup
-      other_users.delete(user_id)
-
-      if params["external_id"] && other_users.values.find { |o| o["external_id"] == params["external_id"] }
-        error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
-      end
 
-      existing_identity = self.data[:identities].values.find { |i| i["type"] == "email" && i["value"] == email }
-
-      if !email
-        # nvm
-      elsif existing_identity && existing_identity["user_id"] != user_id
-        # email not allowed to conflict across users
-        error!(:invalid, details: { "email" => [ {
-          "description" => "Email #{params["email"]} is already being used by another user",
-        } ] })
-      elsif existing_identity && existing_identity["user_id"] == user_id
-        # no-op email already used
-      else
-        # add a new identity
-        user_identity_id = self.class.new_id
+  def user_id
+    @_user_id ||= params.fetch("user").fetch("id").to_i
+  end
 
-        user_identity = {
-          "id"         => user_identity_id,
-          "url"        => url_for("/users/#{user_id}/identities/#{user_identity_id}.json"),
-          "created_at" => Time.now.iso8601,
-          "updated_at" => Time.now.iso8601,
-          "type"       => "email",
-          "value"      => email,
-          "verified"   => false,
-          "primary"    => false,
-          "user_id"    => user_id,
-        }
+  def mock
+    email = user_params["email"]
 
-        self.data[:identities][user_identity_id] = user_identity
-      end
+    other_users = service.data[:users].dup
+    other_users.delete(user_id)
 
-      body = self.find!(:users, user_id).merge!(params)
+    external_id = user_params["external_id"]
 
-      response(
-        :method => :put,
-        :path   => path,
-        :body   => {
-          "user" => body
-        },
-      )
+    if external_id && other_users.values.find { |o| o["external_id"].to_s == external_id.to_s }
+      error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
+    end
 
+    existing_identity = service.data[:identities].values.find { |i| i["type"] == "email" && i["value"] == email }
+
+    if !email
+      # nvm
+    elsif existing_identity && existing_identity["user_id"] != user_id
+      # email not allowed to conflict across users
+      error!(:invalid, details: { "email" => [ {
+        "description" => "Email #{params["email"]} is already being used by another user",
+      } ] })
+    elsif existing_identity && existing_identity["user_id"] == user_id
+      # no-op email already used
+    else
+      # add a new identity
+      user_identity_id = service.serial_id
+
+      user_identity = {
+        "id"         => user_identity_id,
+        "url"        => url_for("/users/#{user_id}/identities/#{user_identity_id}.json"),
+        "created_at" => Time.now.iso8601,
+        "updated_at" => Time.now.iso8601,
+        "type"       => "email",
+        "value"      => email,
+        "verified"   => false,
+        "primary"    => false,
+        "user_id"    => user_id,
+      }
+
+      service.data[:identities][user_identity_id] = user_identity
     end
+
+    mock_response("user" => self.find!(:users, user_id).merge!(user_params))
   end
 end

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

@@ -1,28 +1,16 @@
-class Zendesk2::Client
-  class Real
-    def update_user_field(params={})
-      id = params.delete("id")
+class Zendesk2::Client::UpdateUserField < Zendesk2::Client::Request
+  request_method :put
+  request_path { |r| "/user_fields/#{r.user_field_id}.json" }
 
-      request(
-        :method => :put,
-        :path   => "/user_fields/#{id}.json",
-        :body   => {
-          "user_field" => params
-        },
-      )
-    end
+  def user_field_id
+    params.fetch("user_field").fetch("id")
   end
-  class Mock
-    def update_user_field(params={})
-      user_field_id = params.delete("id")
 
-      response(
-        :method => :put,
-        :path   => "/user_fields/#{user_field_id}.json",
-        :body   => {
-          "user_field" => find!(:user_fields, user_field_id).merge!(params),
-        },
-      )
-    end
+  def user_field_params
+    Cistern::Hash.slice(params.fetch("user_field"), *Zendesk2::Client::CreateUserField.accepted_attributes)
+  end
+
+  def mock
+    mock_response("user_field" => find!(:user_fields, user_field_id).merge!(user_field_params))
   end
 end

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

@@ -1,33 +1,25 @@
-class Zendesk2::Client
-  class Real
-    def update_user_identity(params={})
-      id      = params.delete("id")
-      user_id = params.delete("user_id")
-      path    = "/users/#{user_id}/identities/#{id}.json"
+class Zendesk2::Client::UpdateUserIdentity < Zendesk2::Client::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(
-        :method => :put,
-        :path   => path,
-        :body   => {
-          "identity" => params
-        },
-      )
-    end
+  def self.accepted_attributes
+    %w[verified]
   end
-  class Mock
-    def update_user_identity(params={})
-      id      = params.delete("id").to_s
-      user_id = params.delete("user_id").to_s
-      path    = "/users/#{user_id}/identities/#{id}.json"
 
-      body = self.find!(:identities, id).merge!(Cistern::Hash.slice(params, "verified"))
-      response(
-        :method => :put,
-        :path   => path,
-        :body   => {
-          "identity" => body
-        },
-      )
-    end
+  def user_id
+    params.fetch("user_identity").fetch("user_id")
+  end
+
+  def user_identity_id
+    params.fetch("user_identity").fetch("id")
+  end
+
+  def user_identity_params
+    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))
   end
 end

data/lib/zendesk2/client.rb

@@ -1,38 +1,62 @@
 class Zendesk2::Client < Cistern::Service
   USER_AGENT = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) Zendesk2/#{Zendesk2::VERSION} Faraday/#{Faraday::VERSION}".freeze
 
-  collection_path "zendesk2/client/collections"
-  model_path      "zendesk2/client/models"
-  request_path    "zendesk2/client/requests"
-
-  # @fixme might be nice if cistern took care of this
-  [
-    [:collection, collection_path],
-    [:model,      model_path],
-    [:request,    request_path],
-  ].each do |type, path|
-    Dir[File.expand_path(File.join("../..", path, "**/*.rb"), __FILE__)].sort.each do |file|
-      send(type, file.gsub(/.*#{path}\/(.*)\.rb/, "\\1"), require: file)
-    end
-  end
-
   recognizes :url, :logger, :adapter, :username, :password, :token, :jwt_token
+end
+
+def require_resource(resource, options={})
+  plural = options[:plural] || "#{resource}s"
+  except = Array(options[:except])
+  other  = Array(options[:and])
+
+  require "zendesk2/client/models/#{resource}"
+  require "zendesk2/client/collections/#{plural}"
+
+  require "zendesk2/client/requests/create_#{resource}"  unless except.include?(:create)
+  require "zendesk2/client/requests/destroy_#{resource}" unless except.include?(:destroy)
+  require "zendesk2/client/requests/get_#{plural}"       unless except.include?(:index)
+  require "zendesk2/client/requests/get_#{resource}"     unless except.include?(:show)
+  require "zendesk2/client/requests/update_#{resource}"  unless except.include?(:update)
 
-  module Shared
-    def require_parameters(_params, *requirements)
-      params = Cistern::Hash.stringify_keys(_params)
-      params.reject! { |_,v| Zendesk2.blank?(v) }
-
-      if (missing = requirements - params.keys).any?
-        raise ArgumentError, "missing parameters: #{missing.join(", ")}"
-      else
-        values = params.values_at(*requirements)
-        requirements.size == 1 ? values.first : values
-      end
-    end
-  end
+  other.each { |file| require "zendesk2/client/requests/#{file}" }
 end
 
 require 'zendesk2/client/real'
 require 'zendesk2/client/mock'
+require 'zendesk2/client/request'
+require 'zendesk2/client/model'
+require 'zendesk2/client/collection'
 require 'zendesk2/client/help_center'
+
+require 'zendesk2/client/requests/search'
+require 'zendesk2/client/models/audit_event'
+
+require_resource("category", plural: "categories")
+require_resource("forum")
+require_resource("group", and: ["get_assignable_groups"])
+require_resource("user", and: ["search_user", "get_current_user", "mark_user_identity_primary"])
+
+require_resource("ticket", and: ["get_requested_tickets", "get_ccd_tickets"])
+require_resource("ticket_audit", except: [:create, :destroy, :update])
+require_resource("ticket_field")
+require_resource("topic")
+require_resource("topic_comment", except: [:update])
+require_resource("ticket_comment", except: [:create, :destroy, :update, :show])
+require_resource("organization", and: [
+  "get_organization_users",
+  "get_organization_tickets",
+  "get_organization_by_external_id",
+  "get_organization_memberships",
+  "search_organization",
+  "get_user_memberships",
+])
+require_resource("user_field")
+require_resource("user_identity", plural: "user_identities")
+
+require "zendesk2/client/models/membership"
+require "zendesk2/client/collections/memberships"
+
+require "zendesk2/client/requests/create_membership"
+require "zendesk2/client/requests/destroy_membership"
+require "zendesk2/client/requests/get_membership"
+require "zendesk2/client/requests/mark_membership_default"

data/lib/zendesk2/paged_collection.rb

@@ -1,7 +1,6 @@
-# @abstract Subclass and set #{collection_method}, #{collection_root}, #{model_method}, #{model_root} and #{model}
 # adds {#create!} method to {Cistern::Collection}.
-class Zendesk2::PagedCollection < Zendesk2::Collection
-  def self.inherited(klass)
+module Zendesk2::PagedCollection
+  def self.included(klass)
     klass.send(:attribute, :count)
     klass.send(:attribute, :next_page_link, {:aliases => "next_page"})
     klass.send(:attribute, :previous_page_link, {:aliases => "previous_page"})
@@ -14,7 +13,7 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
   def model_root; self.class.model_root; end
 
   def new_page
-    page = self.class.new(connection: self.connection)
+    page = self.class.new(service: self.service)
     page.merge_attributes(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))})
     page
   end
@@ -32,7 +31,7 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
     return to_enum(:each_entry) unless block_given?
     page = self
     while page
-      page.records.each { |r| yield r }
+      page.to_a.each { |r| yield r }
       page = page.next_page
     end
   end
@@ -64,12 +63,11 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
   # Fetch a collection of resources
   def all(params={})
     if params["filtered"] && (url = params["url"])
-      uri = Addressable::URI.parse(url)
-      query = uri.query_values
+      query = Faraday::NestedParamsEncoder.decode(URI.parse(url).query)
       search(query.delete("query"), query)
     else
       scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}.merge(params)
-      body = connection.send(collection_method, scoped_attributes).body
+      body = service.send(collection_method, scoped_attributes).body
 
       self.load(body[collection_root]) # 'results' is the key for paged seraches
       self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
@@ -98,7 +96,9 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
     else scoped_attributes.merge!("id" => identity_or_hash)
     end
 
-    if data = self.connection.send(model_method, scoped_attributes).body[self.model_root]
+    scoped_attributes = {model_root => scoped_attributes}
+
+    if data = self.service.send(model_method, scoped_attributes).body[self.model_root]
       new(data)
     end
   end

data/lib/zendesk2/searchable.rb

@@ -36,7 +36,7 @@ module Zendesk2::Searchable
               end
             end
 
-    body = connection.send(self.class.search_request, query, params).body
+    body = service.send(self.class.search_request, query, params).body
 
     if data = body.delete("results")
       self.load(data)