zendesk2 1.8.1 → 1.9.0

data/lib/zendesk2/help_center/translations.rb

@@ -0,0 +1,29 @@
+class Zendesk2::HelpCenter::Translations
+  include Zendesk2::Collection
+
+  include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::HelpCenter::Translation
+
+  self.collection_method = :get_help_center_translations
+  self.collection_root   = "translations"
+  self.model_method      = :get_help_center_translation
+  self.model_root        = "translation"
+
+  attribute :source_id, type: :integer
+  attribute :source_type, type: :string
+  attribute :locale, type: :string
+  attribute :locales, type: :array
+  attribute :outdated, type: :boolean
+  attribute :draft, type: :boolean
+
+  scopes << :source_id
+  scopes << :source_type
+
+  scopes << :locale
+  scopes << :locales
+
+  scopes << :outdated
+  scopes << :draft
+end

data/lib/zendesk2/help_center/update_help_center_translation.rb

@@ -0,0 +1,16 @@
+class Zendesk2::UpdateHelpCenterTranslation
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::TranslationSource::Request
+
+  request_method :put
+  request_body { |r| { "translation" => r.translation_params } }
+  request_path { |r| "/help_center/#{r.source_type_url}/#{r.source_id}/translations/#{r.locale}.json" }
+
+  def translation_params
+    @_translation_params ||= Cistern::Hash.slice(params.fetch("translation"), *Zendesk2::CreateHelpCenterTranslation.accepted_attributes)
+  end
+
+  def mock
+    mock_response("translation" => self.find!(:help_center_translations, mock_translation_key).merge!(translation_params))
+  end
+end

data/lib/zendesk2/mark_user_identity_primary.rb

@@ -16,7 +16,7 @@ class Zendesk2::MarkUserIdentityPrimary
     user_identity = self.find!(:identities, user_identity_id)
 
     # only one user can be primary
-    other_user_identities = service.data[:identities].values.select { |i| i["user_id"] == user_id }
+    other_user_identities = cistern.data[:identities].values.select { |i| i["user_id"] == user_id }
     other_user_identities.map { |i| i["primary"] = false }
 
     user_identity.merge!("primary" => true)

data/lib/zendesk2/membership.rb

@@ -26,7 +26,7 @@ class Zendesk2::Membership
     data = if new_record?
              requires :organization_id, :user_id
 
-             service.create_membership("membership" => self.attributes).body["organization_membership"]
+             cistern.create_membership("membership" => self.attributes).body["organization_membership"]
            else
              requires :identity
 
@@ -39,13 +39,13 @@ class Zendesk2::Membership
   def destroy!
     requires :identity
 
-    service.destroy_membership("membership" => { "id" => self.identity })
+    cistern.destroy_membership("membership" => { "id" => self.identity })
   end
 
   def default!
     requires :identity, :user_id
 
-    self.service.mark_membership_default(
+    self.cistern.mark_membership_default(
       "membership" => {
         "user_id" => self.user_id,
         "id"      => self.identity

data/lib/zendesk2/memberships.rb

@@ -22,13 +22,13 @@ class Zendesk2::Memberships
     body = if self.user_id && self.organization_id
              {
                "organization_memberships" => [
-                 service.get_membership("user_id" => self.user_id, "organization_id" => self.organization_id).body["organization_membership"]
+                 cistern.get_membership("user_id" => self.user_id, "organization_id" => self.organization_id).body["organization_membership"]
                ]
              }
            elsif self.user_id
-             service.get_user_memberships({"membership" => { "user_id" => self.user_id }}.merge(params)).body
+             cistern.get_user_memberships({"membership" => { "user_id" => self.user_id }}.merge(params)).body
            else
-             service.get_organization_memberships({"membership" => { "organization_id" => self.organization_id }}.merge(params)).body
+             cistern.get_organization_memberships({"membership" => { "organization_id" => self.organization_id }}.merge(params)).body
            end
 
     self.load(body[collection_root])

data/lib/zendesk2/mock.rb

@@ -7,10 +7,11 @@ class Zendesk2::Mock
       :categories                   => {},
       :forums                       => {},
       :groups                       => {},
+      :help_center_access_policies  => {},
       :help_center_articles         => {},
       :help_center_categories       => {},
       :help_center_sections         => {},
-      :help_center_access_policies  => {},
+      :help_center_translations     => {},
       :identities                   => {},
       :memberships                  => {},
       :organizations                => {},

data/lib/zendesk2/organization.rb

@@ -35,18 +35,18 @@ class Zendesk2::Organization
   def destroy!
     requires :identity
 
-    service.destroy_organization("organization" => {"id" => self.identity})
+    cistern.destroy_organization("organization" => {"id" => self.identity})
   end
 
   def save!
     data = if new_record?
              requires :name
 
-             service.create_organization("organization" => self.attributes)
+             cistern.create_organization("organization" => self.attributes)
            else
              requires :identity
 
-             service.update_organization("organization" => self.attributes)
+             cistern.update_organization("organization" => self.attributes)
            end.body["organization"]
 
     merge_attributes(data)
@@ -56,8 +56,8 @@ class Zendesk2::Organization
   def users
     requires :identity
 
-    service.users.load(
-      service.get_organization_users("organization" => {"id" => self.identity}).body["users"]
+    cistern.users.load(
+      cistern.get_organization_users("organization" => {"id" => self.identity}).body["users"]
     )
   end
 
@@ -65,15 +65,15 @@ class Zendesk2::Organization
   def memberships
     requires :identity
 
-    service.memberships(organization: self)
+    cistern.memberships(organization: self)
   end
 
   # @return [Zendesk2::Tickets] tickets associated with this organization
   def tickets
     requires :identity
 
-    service.tickets.load(
-      service.get_organization_tickets("organization_id" => self.identity).body["tickets"]
+    cistern.tickets.load(
+      cistern.get_organization_tickets("organization_id" => self.identity).body["tickets"]
     )
   end
 end

data/lib/zendesk2/organizations.rb

@@ -12,7 +12,7 @@ class Zendesk2::Organizations
   assoc_accessor :user
 
   def find_by_external_id(external_id)
-    body = service.get_organization_by_external_id("external_id" => external_id).body
+    body = cistern.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"))
@@ -34,7 +34,7 @@ class Zendesk2::Organizations
                           :get_organizations
                         end
 
-    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+    body = cistern.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
 
     self.load(body[collection_root])
     self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))

data/lib/zendesk2/paged_collection.rb

@@ -21,7 +21,7 @@ module Zendesk2::PagedCollection
   def model_root; self.class.model_root; end
 
   def new_page
-    page = self.class.new(service: self.service)
+    page = self.class.new(cistern: self.cistern)
     page.merge_attributes(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))})
     page
   end
@@ -129,7 +129,7 @@ module Zendesk2::PagedCollection
 
     scoped_attributes = { model_root => scoped_attributes }
 
-    if data = self.service.send(model_method, scoped_attributes).body[self.model_root]
+    if data = self.cistern.send(model_method, scoped_attributes).body[self.model_root]
       new(data)
     end
   end
@@ -159,7 +159,7 @@ module Zendesk2::PagedCollection
 
   def collection_page(params)
     scoped_attributes = self.class.scopes.inject({}) { |r, k| r.merge(k.to_s => send(k)) }.merge(params)
-    body = service.send(collection_method, scoped_attributes).body
+    body = cistern.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"))

data/lib/zendesk2/real.rb

@@ -13,19 +13,19 @@ class Zendesk2::Real
     @token    = options.fetch(:token, Zendesk2.defaults[:token])
     password  = options[:password] || Zendesk2.defaults[:password]
 
-    service_options = options[:service_options] || {}
+    cistern_options = options[:cistern_options] || {}
 
     @auth_token  = password || @token
-    @username   += "/token" if @auth_token == @token
+    @auth_id     = "#{@username}/token" if @auth_token == @token
     @jwt_token   = options[:jwt_token]
 
     raise "Missing required options: :url" unless @url
-    raise "Missing required options: :username" unless @username
+    raise "Missing required options: :username" unless @auth_id
     raise "Missing required options: :password or :token" unless password || @token
 
-    @service = Faraday.new({url: @url}.merge(service_options)) do |connection|
+    @cistern = Faraday.new({url: @url}.merge(cistern_options)) do |connection|
       # response
-      connection.use Faraday::Request::BasicAuthentication, @username, @auth_token
+      connection.use Faraday::Request::BasicAuthentication, @auth_id, @auth_token
       connection.use Faraday::Response::RaiseError
       connection.response :json, content_type: /\bjson/
 
@@ -55,7 +55,7 @@ class Zendesk2::Real
     body    = options[:body]
     headers = { "User-Agent" => Zendesk2::USER_AGENT }.merge(options[:headers] || {})
 
-    @service.send(method) do |req|
+    @cistern.send(method) do |req|
       req.url(url)
       req.headers.merge!(headers)
       req.params.merge!(params)

data/lib/zendesk2/request.rb

@@ -114,16 +114,16 @@ module Zendesk2::Request
   end
 
   def data
-    self.service.data
+    self.cistern.data
   end
 
   def html_url_for(path)
-    File.join(service.url, path.to_s)
+    File.join(cistern.url, path.to_s)
   end
 
   def url_for(path, options={})
     URI.parse(
-      File.join(service.url, "/api/v2", path.to_s)
+      File.join(cistern.url, "/api/v2", path.to_s)
     ).tap do |uri|
       if query = options[:query]
         uri.query = Faraday::NestedParamsEncoder.encode(query)
@@ -132,7 +132,7 @@ module Zendesk2::Request
   end
 
   def real(params={})
-    service.request(:method => self.class.request_method,
+    cistern.request(:method => self.class.request_method,
                     :path   => self.request_path,
                     :body   => self.request_body,
                     :url    => params["url"],
@@ -161,7 +161,7 @@ module Zendesk2::Request
   end
 
   def find!(collection, identity, options={})
-    if resource = self.service.data[collection][identity.to_i]
+    if resource = self.cistern.data[collection][identity.to_i]
       resource
     else
       error!(options[:error] || :not_found, options)
@@ -169,7 +169,7 @@ module Zendesk2::Request
   end
 
   def delete!(collection, identity, options={})
-    self.service.data[collection].delete(identity.to_i) ||
+    self.cistern.data[collection].delete(identity.to_i) ||
       error!(options[:error] || :not_found, options)
   end
 
@@ -185,7 +185,7 @@ module Zendesk2::Request
   end
 
   def resources(collection, options={})
-    page = collection.is_a?(Array) ? collection : service.data[collection.to_sym].values
+    page = collection.is_a?(Array) ? collection : cistern.data[collection.to_sym].values
     root = options.fetch(:root) { !collection.is_a?(Array) && collection.to_s }
 
     mock_response(
@@ -205,7 +205,7 @@ module Zendesk2::Request
 
     offset     = (page_index - 1) * page_size
 
-    resources   = collection.is_a?(Array) ? collection : service.data[collection.to_sym].values
+    resources   = collection.is_a?(Array) ? collection : cistern.data[collection.to_sym].values
     count       = resources.size
     total_pages = (count / page_size) + 1
 
@@ -249,7 +249,7 @@ module Zendesk2::Request
     body                 = options[:response_body] || options[:body]
     method               = options[:method]        || :get
     params               = options[:params]
-    service.last_request = options[:request_body]
+    cistern.last_request = options[:request_body]
     status               = options[:status]        || 200
 
     path = options[:path]

data/lib/zendesk2/search.rb

@@ -26,9 +26,9 @@ class Zendesk2::Search
     type  = terms.delete("type")
 
     collection = if type.nil?
-                   service.data.values
+                   cistern.data.values
                  else
-                   service.data[pluralize(type).to_sym]
+                   cistern.data[pluralize(type).to_sym]
                  end
 
     results = collection.values.select { |v| terms.all?{ |term, condition| v[term].to_s == condition.to_s } }

data/lib/zendesk2/searchable.rb

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

data/lib/zendesk2/ticket.rb

@@ -73,11 +73,11 @@ class Zendesk2::Ticket
                create_attributes.merge!("requester" => with_requester)
              end
 
-             service.create_ticket("ticket" => create_attributes).body["ticket"]
+             cistern.create_ticket("ticket" => create_attributes).body["ticket"]
            else
              requires :identity
 
-             service.update_ticket("ticket" => self.attributes).body["ticket"]
+             cistern.update_ticket("ticket" => self.attributes).body["ticket"]
            end
 
     merge_attributes(data)
@@ -86,7 +86,7 @@ class Zendesk2::Ticket
   def destroy!
     requires :identity
 
-    service.destroy_ticket("ticket" => {"id" => self.identity})
+    cistern.destroy_ticket("ticket" => {"id" => self.identity})
   end
 
   # Adds a ticket comment
@@ -103,8 +103,8 @@ class Zendesk2::Ticket
 
     comment = Zendesk2.stringify_keys(options).merge("body" => text)
 
-    service.ticket_comments.new(
-      service.update_ticket(
+    cistern.ticket_comments.new(
+      cistern.update_ticket(
         "ticket" => {
           "id"      => self.identity,
           "comment" => comment,
@@ -115,7 +115,7 @@ class Zendesk2::Ticket
 
   # @return [Array<Zendesk2::User>] All users CCD on this ticket
   def collaborators
-    self.collaborator_ids.map { |cid| self.service.users.get(cid) }
+    self.collaborator_ids.map { |cid| self.cistern.users.get(cid) }
   end
 
   # Update list of users to be CCD on this ticket
@@ -126,16 +126,16 @@ class Zendesk2::Ticket
 
   # @return [Zendesk2::TicketAudits] all audits for this ticket
   def audits
-    self.service.ticket_audits(ticket_id: self.identity).all
+    self.cistern.ticket_audits(ticket_id: self.identity).all
   end
 
   # @return [Zendesk2::TicketMetric] metrics for this ticket
   def metrics
-    Zendesk2::TicketMetric.new(self.service.get_ticket_metric("ticket_id" => self.identity).body["ticket_metric"])
+    Zendesk2::TicketMetric.new(self.cistern.get_ticket_metric("ticket_id" => self.identity).body["ticket_metric"])
   end
 
   # @return [Array<Zendesk2::TicketComment>] all comments for this ticket
   def comments
-    self.service.ticket_comments(ticket_id: self.identity).all
+    self.cistern.ticket_comments(ticket_id: self.identity).all
   end
 end

data/lib/zendesk2/ticket_audit.rb

@@ -21,12 +21,12 @@ class Zendesk2::TicketAudit
   def ticket
     requires :ticket_id
 
-    self.service.tickets.get(self.ticket_id)
+    self.cistern.tickets.get(self.ticket_id)
   end
 
   def events
     (self.attributes[:events] || []).map { |ae|
-      Zendesk2::AuditEvent.for(ae.merge(ticket_audit: self, service: self.service))
+      Zendesk2::AuditEvent.for(ae.merge(ticket_audit: self, cistern: self.cistern))
     }
   end
 end

data/lib/zendesk2/ticket_audits.rb

@@ -13,13 +13,13 @@ class Zendesk2::TicketAudits
   self.model_root        = "audit"
 
   def ticket
-    self.service.tickets.get(self.ticket_id)
+    self.cistern.tickets.get(self.ticket_id)
   end
 
   def all(params={})
     requires :ticket_id
 
-    body = service.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+    body = cistern.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"))
@@ -29,7 +29,7 @@ class Zendesk2::TicketAudits
   def get(id)
     requires :ticket_id
 
-    if data = self.service.send(model_method, {"ticket_id" => self.ticket_id, "id" => id}).body[self.model_root]
+    if data = self.cistern.send(model_method, {"ticket_id" => self.ticket_id, "id" => id}).body[self.model_root]
       new(data)
     end
   rescue Zendesk2::Error