zendesk2 1.4.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a75f9d7681dd7fc05b70ffaac7cd40f4d7b0e0d2
-  data.tar.gz: da867a0ca54e8645a7ba70f301810474509dc640
+  metadata.gz: c144b75c399e6341efe72d69133be4abe3dff438
+  data.tar.gz: 71f62dd8b8c08825f44486be2f1bdcd035571fd0
 SHA512:
-  metadata.gz: 66a38be00688b1ee608f8898ac88cb96137f056a5eb116039f30ab143994dede0dbba3442c6bcae7503dc94d2d2f45b89a366624787fd2437c6129cc5cb3d354
-  data.tar.gz: 222bf38cead5cbbae73790862d893fbf7bccb1758d075980e03a7da722b7ce2b724d5c05fc8d364ab479a02a30efd9be892d30953349f8ed44be99c6fab1608c
+  metadata.gz: 27f2a692f0471b39fe9b33c7edee0f4d84639d325412f64cb3587f2687943ff93833c9c87e1e9559817a88b2181bf4934aa027af6472cdb79499f911ae44b793
+  data.tar.gz: 29214d0384eedab7f1399ec05b872ac82d528b684fe2313551dc77e2b696a0fd54d80fcd8cb99393ab0270424d1ec9b43d8b0d9546124685ccb1dde6d1381481

data/README.md

@@ -56,7 +56,7 @@ Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate
 
 #### Collections
 
-Currently support resources
+Currently support resources:
 
 * Audit Events
 * Categories
@@ -73,6 +73,12 @@ Currently support resources
 * User Fields
 * Users
 
+Help Center resources:
+
+* Sections
+* Articles
+* Categories
+
 All collection are accessed like so:
 
 ```ruby

data/lib/zendesk2/attributes.rb

@@ -4,7 +4,7 @@ module Zendesk2::Attributes
     collection = options[:collection] || "#{name}s"
     define_method(name) do
       if assoc_id = self.send(assoc_key)
-        self.connection.send(collection).get(assoc_id)
+        self.service.send(collection).get(assoc_id)
       else self.instance_variable_get("@#{name}")
       end
     end

data/lib/zendesk2/{collection.rb → client/collection.rb}

@@ -1,15 +1,24 @@
-# @abstract Subclass and set #{collection_method}, #{collection_root}, #{model_method}, #{model_root} and #{model}
-# adds {#create!} method to {Cistern::Collection}.
-class Zendesk2::Collection < Cistern::Collection
-  def self.inherited(klass)
-    klass.send(:attribute, :count)
-    klass.send(:extend, ClassMethods)
+class Zendesk2::Client::Collection
+
+  class << self
+    attr_accessor :collection_method, :collection_root, :model_method, :model_root
+
+    attr_writer :namespace
+
+    def namespace
+      @namespace || self.model_root
+    end
+
+    def scopes
+      @scopes ||= []
+    end
   end
 
   def collection_method; self.class.collection_method; end
   def collection_root; self.class.collection_root; end
   def model_method; self.class.model_method; end
   def model_root; self.class.model_root; end
+  def namespace; self.class.namespace; end
 
   # Attempt creation of resource and explode if unsuccessful
   # @raise [Zendesk2::Error] if creation was unsuccessful
@@ -30,7 +39,7 @@ class Zendesk2::Collection < Cistern::Collection
   # Fetch a collection of resources
   def all(params={})
     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])
     self.merge_attributes(Cistern::Hash.slice(body, "count"))
@@ -53,12 +62,16 @@ class Zendesk2::Collection < Cistern::Collection
   # @return [Zendesk2::Model] fetched resource corresponding to value of {Zendesk2::Collection#model}
   def get!(identity_or_hash)
     scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}
+
     if identity_or_hash.is_a?(Hash)
       scoped_attributes.merge!(identity_or_hash)
-    else scoped_attributes.merge!("id" => identity_or_hash)
+    else
+      scoped_attributes.merge!("id" => identity_or_hash)
     end
 
-    if data = self.connection.send(model_method, scoped_attributes).body[self.model_root]
+    scoped_attributes = { namespace => scoped_attributes }
+
+    if data = self.service.send(model_method, scoped_attributes).body[self.model_root]
       new(data)
     end
   end
@@ -72,12 +85,4 @@ class Zendesk2::Collection < Cistern::Collection
   rescue Zendesk2::Error
     nil
   end
-
-  module ClassMethods
-    attr_accessor :collection_method, :collection_root, :model_method, :model_root
-
-    def scopes
-      @scopes ||= []
-    end
-  end
 end

data/lib/zendesk2/client/collections/categories.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Categories < Zendesk2::PagedCollection
+class Zendesk2::Client::Categories < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Category

data/lib/zendesk2/client/collections/forums.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Forums < Zendesk2::PagedCollection
+class Zendesk2::Client::Forums < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Forum

data/lib/zendesk2/client/collections/groups.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Groups < Zendesk2::PagedCollection
+class Zendesk2::Client::Groups < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Group
@@ -10,8 +11,8 @@ class Zendesk2::Client::Groups < Zendesk2::PagedCollection
   self.search_type       = "group"
 
   def assignable
-    data = self.connection.get_assignable_groups.body
-    collection = self.connection.groups.load(data["groups"])
+    data = self.service.get_assignable_groups.body
+    collection = self.service.groups.load(data["groups"])
     collection.merge_attributes(Cistern::Hash.slice(data, "next_page", "previous_page", "count"))
   end
 end

data/lib/zendesk2/client/collections/help_center/articles.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::HelpCenter::Articles < Zendesk2::PagedCollection
+class Zendesk2::Client::HelpCenter::Articles < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::HelpCenter::Article

data/lib/zendesk2/client/collections/help_center/categories.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::HelpCenter::Categories < Zendesk2::PagedCollection
+class Zendesk2::Client::HelpCenter::Categories < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::HelpCenter::Category

data/lib/zendesk2/client/collections/help_center/sections.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::HelpCenter::Sections < Zendesk2::PagedCollection
+class Zendesk2::Client::HelpCenter::Sections < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::HelpCenter::Section

data/lib/zendesk2/client/collections/memberships.rb

@@ -1,28 +1,30 @@
-class Zendesk2::Client::Memberships < Zendesk2::Collection
+class Zendesk2::Client::Memberships < Zendesk2::Client::Collection
   extend Zendesk2::Attributes
 
   model Zendesk2::Client::Membership
 
   attribute :user_id, type: :integer
   attribute :organization_id, type: :integer
+  attribute :count, type: :integer
 
   assoc_accessor :organization
   assoc_accessor :user
 
-  self.collection_root   = "organization_memberships"
-  self.model_method      = :get_membership
-  self.model_root        = "organization_membership"
+  self.collection_root = "organization_memberships"
+  self.model_method    = :get_membership
+  self.model_root      = "organization_membership"
 
   def all(params={})
     requires_one :user_id, :organization_id
 
     body = if self.user_id && self.organization_id
-             { "organization_memberships" => [ connection.get_membership("user_id" => self.user_id, "organization_id" => self.organization_id).body["organization_membership"] ]
+             {
+               "organization_memberships" => [ service.get_membership("user_id" => self.user_id, "organization_id" => self.organization_id).body["organization_membership"] ]
              }
            elsif self.user_id
-             connection.get_user_memberships("user_id" => self.user_id).body
+             service.get_user_memberships("membership" => { "user_id" => self.user_id }).body
            else
-             connection.get_organization_memberships("organization_id" => self.organization_id).body
+             service.get_organization_memberships("membership" => { "organization_id" => self.organization_id }).body
            end
 
     self.load(body[collection_root])

data/lib/zendesk2/client/collections/organizations.rb

@@ -1,10 +1,11 @@
-class Zendesk2::Client::Organizations < Zendesk2::PagedCollection
+class Zendesk2::Client::Organizations < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Organization
 
   def find_by_external_id(external_id)
-    body = connection.get_organization_by_external_id(external_id).body
+    body = service.get_organization_by_external_id("external_id" => external_id).body
     if data = body.delete("organizations")
       collection = self.clone.load(data)
       collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))

data/lib/zendesk2/client/collections/ticket_audits.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::TicketAudits < Zendesk2::PagedCollection
+class Zendesk2::Client::TicketAudits < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
 
   model Zendesk2::Client::TicketAudit
 
@@ -10,13 +11,13 @@ class Zendesk2::Client::TicketAudits < Zendesk2::PagedCollection
   self.model_root        = "audit"
 
   def ticket
-    self.connection.tickets.get(self.ticket_id)
+    self.service.tickets.get(self.ticket_id)
   end
 
   def all(params={})
     requires :ticket_id
 
-    body = connection.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+    body = service.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
 
     collection = self.clone.load(body[collection_root])
     collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
@@ -26,7 +27,7 @@ class Zendesk2::Client::TicketAudits < Zendesk2::PagedCollection
   def get(id)
     requires :ticket_id
 
-    if data = self.connection.send(model_method, {"ticket_id" => self.ticket_id, "id" => id}).body[self.model_root]
+    if data = self.service.send(model_method, {"ticket_id" => self.ticket_id, "id" => id}).body[self.model_root]
       new(data)
     end
   rescue Zendesk2::Error

data/lib/zendesk2/client/collections/ticket_comments.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::TicketComments < Zendesk2::PagedCollection
+class Zendesk2::Client::TicketComments < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
 
   model Zendesk2::Client::TicketComment
 
@@ -8,13 +9,13 @@ class Zendesk2::Client::TicketComments < Zendesk2::PagedCollection
   self.collection_root   = "comments"
 
   def ticket
-    self.connection.tickets.get(self.ticket_id)
+    self.service.tickets.get(self.ticket_id)
   end
 
   def all(params={})
     requires :ticket_id
 
-    body = connection.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+    body = service.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
 
     collection = self.clone.load(body[collection_root])
     collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))

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

@@ -1,8 +1,10 @@
-class Zendesk2::Client::TicketFields < Zendesk2::Collection
+class Zendesk2::Client::TicketFields < Zendesk2::Client::Collection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::TicketField
 
+  attribute :count, type: :integer
+
   self.collection_method = :get_ticket_fields
   self.collection_root   = "ticket_fields"
   self.model_method      = :get_ticket_field

data/lib/zendesk2/client/collections/tickets.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Tickets < Zendesk2::PagedCollection
+class Zendesk2::Client::Tickets < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Ticket

data/lib/zendesk2/client/collections/topic_comments.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::TopicComments < Zendesk2::PagedCollection
+class Zendesk2::Client::TopicComments < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::TopicComment

data/lib/zendesk2/client/collections/topics.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Topics < Zendesk2::PagedCollection
+class Zendesk2::Client::Topics < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Topic

data/lib/zendesk2/client/collections/user_fields.rb

@@ -1,8 +1,10 @@
-class Zendesk2::Client::UserFields < Zendesk2::Collection
+class Zendesk2::Client::UserFields < Zendesk2::Client::Collection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::UserField
 
+  attribute :count
+
   self.collection_method = :get_user_fields
   self.collection_root   = "user_fields"
   self.model_method      = :get_user_field

data/lib/zendesk2/client/collections/user_identities.rb

@@ -1,12 +1,14 @@
-class Zendesk2::Client::UserIdentities < Zendesk2::Collection
+class Zendesk2::Client::UserIdentities < Zendesk2::Client::Collection
   model Zendesk2::Client::UserIdentity
 
   attribute :user_id, type: :integer
+  attribute :count, type: :integer
 
   self.collection_method = :get_user_identities
   self.collection_root   = "identities"
   self.model_method      = :get_user_identity
   self.model_root        = "identity"
+  self.namespace         = "user_identity"
 
   scopes << :user_id
 end

data/lib/zendesk2/client/collections/users.rb

@@ -1,4 +1,5 @@
-class Zendesk2::Client::Users < Zendesk2::PagedCollection
+class Zendesk2::Client::Users < Zendesk2::Client::Collection
+  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::User
@@ -11,6 +12,6 @@ class Zendesk2::Client::Users < Zendesk2::PagedCollection
   self.search_request    = :search_user
 
   def current
-    new(connection.get_current_user.body["user"])
+    new(service.get_current_user.body["user"])
   end
 end

data/lib/zendesk2/client/help_center.rb

@@ -1 +1,4 @@
 module Zendesk2::Client::HelpCenter; end
+
+Dir[File.expand_path("../requests/*_help_center_*.rb",           __FILE__)].each { |f| require(f) }
+Dir[File.expand_path("../{models,collections}/help_center/*.rb", __FILE__)].each { |f| require(f) }

data/lib/zendesk2/client/mock.rb

@@ -1,8 +1,8 @@
 class Zendesk2::Client < Cistern::Service
   class Mock
-    include Shared
 
     attr_reader :username, :url, :token, :jwt_token
+    attr_accessor :last_request
 
     def self.data
       @data ||= {
@@ -27,28 +27,24 @@ class Zendesk2::Client < Cistern::Service
       }
     end
 
-    def self.new_id
+    def self.serial_id
       @current_id ||= 0
       @current_id += 1
-      @current_id.to_s
+      @current_id
     end
 
-    def data
-      self.class.data
-    end
-
-    def self.reset!
-      @data = nil
+    def serial_id
+      self.class.serial_id
     end
 
     def initialize(options={})
       @url                 = options[:url]
-      @path                = Addressable::URI.parse(url).path
+      @path                = URI.parse(url).path
       @username, @password = options[:username], options[:password]
       @token               = options[:token]
       @jwt_token           = options[:jwt_token]
 
-      @current_user ||= self.create_user("email" => @username, "name" => "Mock Agent").body["user"]
+      @current_user ||= self.create_user("user" => {"email" => @username, "name" => "Mock Agent"}).body["user"]
       @current_user_identity ||= self.data[:identities].values.first
     end
 
@@ -60,124 +56,5 @@ class Zendesk2::Client < Cistern::Service
 
       @current_user
     end
-
-    def html_url_for(path)
-      File.join(@url, path.to_s)
-    end
-
-    def url_for(path, options={})
-      Addressable::URI.parse(
-        File.join(@url, "/api/v2", path.to_s)
-      ).tap do |uri|
-        uri.query_values = options.fetch(:query, {})
-      end.to_s
-    end
-
-    def resources(collection, path, collection_root, options={})
-      filter    = options[:filter]
-      resources = self.data[collection].values
-      resources = filter.call(resources) if filter
-      count     = resources.size
-
-      response(
-        :body => {
-          collection_root => resources,
-          "count"         => count,
-        },
-        :path => path
-      )
-    end
-
-    def page(params, collection, path, collection_root, options={})
-      page_params = Zendesk2.paging_parameters(params)
-      page_size   = (page_params["per_page"] || 100).to_i
-      page_index  = (page_params["page"] || 1).to_i
-      offset      = (page_index - 1) * page_size
-      filter      = options[:filter]
-      resources   = options[:resources] || self.data[collection].values
-      resources   = filter.call(resources) if filter
-      count       = resources.size
-      total_pages = (count / page_size) + 1
-
-      query = options.fetch(:query, {})
-
-      next_page = if page_index < total_pages
-                    url_for(path, query: {page: page_index + 1, per_page: page_size}.merge(query))
-                  end
-      previous_page = if page_index > 1
-                        url_for(path, query: {page: page_index - 1, per_page: page_size}.merge(query))
-                      end
-
-      resource_page = resources.slice(offset, page_size)
-
-      body = {
-        collection_root => resource_page,
-        "count"         => count,
-        "next_page"     => next_page,
-        "previous_page" => previous_page,
-      }
-
-      response(
-        :body => body,
-        :path => path
-      )
-    end
-
-    def pluralize(word)
-      pluralized = word.dup
-      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| pluralized.gsub!(regex, replace) if pluralized.match(regex)}
-      pluralized
-    end
-
-    def self.error_map
-      @@error_map ||= {
-        :invalid => [422, {
-          "error"       => "RecordInvalid",
-          "description" => "Record validation errors",
-        }],
-        :not_found => [404, {
-          "error"       => "RecordNotFound",
-          "description" => "Not found",
-        }],
-      }
-    end
-
-    def find!(collection, identity, options={})
-      if resource = self.data[collection][identity.to_s]
-        resource
-      else
-        error!(options[:error] || :not_found)
-      end
-    end
-
-    def delete!(collection, identity, options={})
-      self.data[collection].delete(identity.to_s) ||
-        error!(options[:error] || :not_found)
-    end
-
-    def error!(type, options={})
-      status, body = self.class.error_map[type]
-      body.merge!("details" => options[:details]) if options[:details]
-
-      response(
-        :status => status,
-        :body   => body,
-      )
-    end
-
-    def response(options={})
-      method = options[:method] || :get
-      status = options[:status] || 200
-      path   = options[:path]
-      body   = options[:body]
-
-      url = options[:url] || url_for(path)
-
-      env = Faraday::Env.new(method, body, url, nil, {}, nil, nil, {}, nil, {"Content-Type"  => "application/json; charset=utf-8"}, status)
-
-      Faraday::Response::RaiseError.new.on_complete(env) || Faraday::Response.new(env)
-    rescue Faraday::Error::ClientError => e
-      raise Zendesk2::Error.new(e)
-    end
   end
 end