help_scout-sdk 1.0.0

data/lib/help_scout/conversation.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Conversation < HelpScout::Base
+    extend Getable
+    extend Listable
+
+    class << self
+      def create(params)
+        response = HelpScout.api.post(create_path, HelpScout::Util.camelize_keys(params))
+        response.location
+      end
+
+      private
+
+      def create_path
+        base_path
+      end
+
+      def list_path(mailbox_id)
+        "#{base_path}?mailbox=#{mailbox_id}"
+      end
+    end
+
+    BASIC_ATTRIBUTES = %i[
+      id
+      number
+      type
+      folder_id
+      status
+      state
+      subject
+      preview
+      mailbox_id
+      assignee
+      created_by
+      created_at
+      closed_by
+      closed_at
+      user_updated_at
+      customer_waiting_since
+      source
+      tags
+      cc
+      bcc
+      primary_customer
+      custom_fields
+    ].freeze
+
+    attr_accessor(*BASIC_ATTRIBUTES)
+    attr_reader :hrefs
+
+    def initialize(params)
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+
+      @hrefs = HelpScout::Util.map_links(params.fetch(:_links, []))
+    end
+
+    def populated_threads
+      @populated_threads ||= HelpScout::Thread.list(id)
+    end
+
+    def update(operation, path, value = nil)
+      update_path = URI.parse(hrefs[:self]).path
+      HelpScout.api.patch(update_path, op: operation, path: path, value: value)
+      true
+    end
+
+    def update_tags(new_tags = nil)
+      new_tags ||= []
+      tags_path = URI.parse(hrefs[:self]).path + '/tags'
+      HelpScout.api.put(tags_path, tags: new_tags)
+      true
+    end
+  end
+end

data/lib/help_scout/customer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Customer < HelpScout::Base
+    extend Getable
+    extend Listable
+
+    BASIC_ATTRIBUTES = %i[
+      first_name
+      last_name
+      photo_url
+      job_title
+      photo_type
+      background
+      location
+      created_at
+      updated_at
+      organization
+      gender
+      age
+      id
+    ].freeze
+    EMBEDDED_ATTRIBUTES = %i[
+      addresses
+      chats
+      emails
+      phones
+      social_profiles
+      websites
+    ].freeze
+    attr_reader(*(BASIC_ATTRIBUTES + EMBEDDED_ATTRIBUTES))
+    attr_reader :hrefs
+
+    def initialize(params = {})
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+
+      embedded_params = params.fetch(:_embedded, {})
+      EMBEDDED_ATTRIBUTES.each do |attribute|
+        next unless embedded_params[attribute]
+
+        instance_variable_set("@#{attribute}", embedded_params[attribute])
+      end
+
+      @hrefs = HelpScout::Util.map_links(params[:_links])
+    end
+  end
+end

data/lib/help_scout/folder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Folder < HelpScout::Base
+    extend Listable
+
+    class << self
+      private
+
+      def base_path
+        'mailboxes/%<MAILBOX_ID>/folders/'
+      end
+
+      def list_path(mailbox_id)
+        replacements = {
+          '%<MAILBOX_ID>' => mailbox_id
+        }
+
+        HelpScout::Util.parse_path(base_path, replacements)
+      end
+    end
+
+    BASIC_ATTRIBUTES = %i[
+      id
+      name
+      type
+      user_id
+      total_count
+      active_count
+      updated_at
+    ].freeze
+    attr_reader(*BASIC_ATTRIBUTES)
+
+    def initialize(params)
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+    end
+  end
+end

data/lib/help_scout/mailbox.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Mailbox < HelpScout::Base
+    extend Getable
+    extend Listable
+
+    BASIC_ATTRIBUTES = %i[
+      id
+      name
+      slug
+      email
+      created_at
+      updated_at
+    ].freeze
+    attr_reader(*BASIC_ATTRIBUTES)
+    attr_reader :hrefs
+
+    def initialize(params)
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+
+      @hrefs = HelpScout::Util.map_links(params[:_links])
+    end
+
+    def fields
+      @fields ||= HelpScout.api.get(fields_path).embedded[:fields]
+    end
+
+    def folders
+      @folders ||= HelpScout::Folder.list(id: id)
+    end
+
+    private
+
+    def fields_path
+      hrefs[:fields]
+    end
+  end
+end

data/lib/help_scout/modules/getable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HelpScout
+  module Getable
+    def get(id)
+      new parse_item(HelpScout.api.get(get_path(id)))
+    end
+
+    private
+
+    def get_path(id)
+      "#{base_path}/#{id}"
+    end
+
+    def parse_item(response)
+      response.body
+    end
+  end
+end

data/lib/help_scout/modules/listable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HelpScout
+  module Listable
+    def list(id: HelpScout.default_mailbox, page: nil)
+      HelpScout.api.get(list_path(id), page: page).embedded_list.map { |e| new e }
+    end
+
+    def list_path(_)
+      base_path
+    end
+  end
+end

data/lib/help_scout/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Response
+    delegate :headers, :status, :success?, to: :response
+
+    attr_reader :response
+    def initialize(response)
+      @response = response
+    end
+
+    def body
+      @body ||= response.body.deep_transform_keys { |key| key.to_s.underscore.to_sym }
+    end
+
+    def embedded
+      body[:_embedded]
+    end
+
+    def embedded_list
+      embedded.values.first
+    end
+
+    def item
+      body[:item]
+    end
+
+    def items
+      body[:items]
+    end
+
+    def location
+      headers['location']
+    end
+  end
+end

data/lib/help_scout/thread.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Thread < HelpScout::Base
+    class << self
+      def list(conversation_id, page: nil)
+        HelpScout.api.get(list_path(conversation_id), page: page).embedded_list.map { |details| new details }
+      end
+
+      private
+
+      def list_path(conversation_id)
+        "conversations/#{conversation_id}/threads"
+      end
+    end
+
+    BASIC_ATTRIBUTES = %i[
+      id
+      assigned_to
+      status
+      state
+      action
+      body
+      source
+      customer
+      created_by
+      saved_reply_id
+      type
+      to
+      cc
+      bcc
+      created_at
+      opened_at
+      attachments
+    ].freeze
+
+    attr_accessor(*BASIC_ATTRIBUTES)
+    attr_reader :hrefs
+
+    def initialize(params)
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+
+      @hrefs = HelpScout::Util.map_links(params.fetch(:_links, []))
+    end
+  end
+end

data/lib/help_scout/user.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class User < HelpScout::Base
+    extend Getable
+    extend Listable
+
+    BASIC_ATTRIBUTES = %i[
+      id
+      first_name
+      last_name
+      email
+      created_at
+      updated_at
+      role
+      timezone
+      type
+      photoUrl
+    ].freeze
+
+    attr_reader(*BASIC_ATTRIBUTES)
+    attr_reader :hrefs
+
+    def initialize(params = {})
+      BASIC_ATTRIBUTES.each do |attribute|
+        next unless params[attribute]
+
+        instance_variable_set("@#{attribute}", params[attribute])
+      end
+
+      @hrefs = HelpScout::Util.map_links(params[:_links])
+    end
+  end
+end

data/lib/help_scout/util.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module HelpScout
+  module Util
+    # TODO: Consider including in Base
+    class << self
+      def camelize(term)
+        term = term.to_s.split('_').collect(&:capitalize).join
+        term[0] = term[0].downcase
+        term
+      end
+
+      def camelize_keys(source)
+        source.each_with_object({}) do |(key, value), results|
+          results[camelize(key)] = if value.is_a? Hash
+                                     camelize_keys(value)
+                                   else
+                                     value
+                                   end
+        end
+      end
+
+      def jsonify(term)
+        camelize(keyify(term))
+      end
+
+      def keyify(term)
+        term.to_s.delete('@')
+      end
+
+      def map_links(links)
+        links.map { |k, v| [k, v[:href]] }.to_h
+      end
+
+      def parse_path(path_template, replacements)
+        placeholders = Regexp.union(replacements.keys)
+        path_template.gsub(placeholders) { |match_text| replacements[match_text] }
+      end
+
+      def serialized_value(value, type)
+        if value.is_a? Array
+          value.map { |v| serialized_value(v, type) }
+        else
+          value.class < HelpScout::Base ? value.send(type) : value
+        end
+      end
+    end
+  end
+end

data/lib/help_scout/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HelpScout
+  VERSION = '1.0.0'
+end

data/lib/help_scout-sdk.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'help_scout/version'
+
+require 'help_scout/base'
+require 'help_scout/modules/getable'
+require 'help_scout/modules/listable'
+
+require 'help_scout/api'
+require 'help_scout/api/access_token'
+require 'help_scout/api/client'
+require 'help_scout/attachment'
+require 'help_scout/configuration'
+require 'help_scout/conversation'
+require 'help_scout/customer'
+require 'help_scout/folder'
+require 'help_scout/mailbox'
+require 'help_scout/response'
+require 'help_scout/thread'
+require 'help_scout/user'
+require 'help_scout/util'
+
+module HelpScout
+  class << self
+    attr_writer :configuration
+
+    def access_token
+      api.access_token
+    end
+
+    def api
+      @api ||= HelpScout::API.new
+    end
+
+    def app_id
+      configuration.app_id
+    end
+
+    def app_secret
+      configuration.app_secret
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+      api.access_token = HelpScout.configuration.access_token
+    end
+
+    def default_mailbox
+      configuration.default_mailbox
+    end
+
+    def refresh!
+      @api = nil
+    end
+  end
+end