help_scout-sdk 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d4c58f9f96b57b2d1bbc0cd69ad741ffa6201244861167992e8212901d491d2
-  data.tar.gz: 055c66adf697283a7836ce6fdb91156cea27ea1cddf0fc6f8b2c05c07ed174a8
+  metadata.gz: 7d88954135888a77486265cfd3a3755711a419b1883c0e4af31e3c3671d0e67f
+  data.tar.gz: beeb0ecb380ab39348823a61f1d6533617f093e9142c3f78dc0bcb1efff20064
 SHA512:
-  metadata.gz: 2058da0b726acce0ef9993b40e827bb2be27f2947c78dfcb57216e51acb3fbcd4969b86a658e621e1bd63c1e6410f291a55cb2aaa03fd446374208e2376eeed0
-  data.tar.gz: 10b8bbca725910b62a0b3120247506d50b8c7e3f34ed50a39ae2ddeb340d9081803b66d2649e9a9b410de4d1af2eb346372f3b96bcb6e7543f38e6f7c790f163
+  metadata.gz: dd1bd18e9d42821f7df2f1e397fd322af8d765ce522cddffd90b93d24d7390fec98f8a9d381bcf92e64896797c9726d62f8ea687bc6e4044c15592592c1b0b68
+  data.tar.gz: 278dd433006623d04f155b6b30521b6645eb13659c811282efe30cb5d00c4c755877158640a6411cac50dfd968770491b94c78d1588f511ab7cc4402532efd96

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+### master (unreleased)
+
+### 2.0.0 / 2019-07-19
+
+Breaking Changes:
+
+* Removes HelpScout::Configuration#access_token and writer to avoid multiple sources
+  of truth for access token values ([#14](https://github.com/taxjar/help_scout-sdk/pull/14))
+
+Enhancements:
+
+* Adds support for `HelpScout::Thread.create`, `HelpScout::Thread.get`, and
+  `HelpScout::Thread#update` (Justin White, [#13](https://github.com/taxjar/help_scout-sdk/pull/13))
+
+### 1.1.0 / 2019-06-20
+
+### 1.0.2 / 2019-06-07
+
+### 1.0.1 / 2019-06-07
+
+### 1.0.0 / 2019-06-05
+
+Breaking Changes:
+
+* Drops support for the Mailbox 1.0 API ([#2](https://github.com/taxjar/help_scout-sdk/pull/2))
+
+Enhancements:
+
+* Updated to support the Mailbox 2.0 API ([#2](https://github.com/taxjar/help_scout-sdk/pull/2))

data/README.md

@@ -23,8 +23,7 @@ And then execute:
 | :------------------------- | :--: | :--: | :-----: | :----: | :-----: |
 | Attachment                 |   ❌  |  ❌  |    ✅   |    ❌   |    ❌   |
 | Conversations              |   ✅  |  ✅  |    ✅   |    ✅   |    ❌   |
-| Conversation::Threads      |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
-| Conversation::ThreadSource |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Conversation::Threads      |   ✅  |  ➖  |    ✅   |    ✅   |    ➖   |
 | Customers                  |   ✅  |  ✅  |    ❌   |    ❌   |    ❌   |
 | Notes                      |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
 | Mailboxes                  |   ✅  |  ✅  |    ➖   |    ➖   |    ➖   |
@@ -50,8 +49,6 @@ And then execute:
 HelpScout.configure do |config|
   config.app_id = ENV["HELP_SCOUT_APP_ID"]
   config.app_secret = ENV["HELP_SCOUT_APP_SECRET"]
-
-  config.access_token = HelpScout::API::AccessToken.create
 end
 ```
 
@@ -86,6 +83,19 @@ mailbox.fields
 mailbox.folders
 ```
 
+### Threads
+
+[Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/list/)
+
+```ruby
+conversation = HelpScout::Conversation.list.first
+new_thread = HelpScout::Thread.create(conversation.id, "notes", { text: 'Hello, world!' })
+threads = HelpScout::Thread.list(conversation.id)
+latest_thread = threads.first
+latest_thread.update("replace", "/text", "Updating a threads text.")
+modified_thread = HelpScout::Thread.get(conversation.id, latest_thread.id)
+```
+
 ### Users
 
 [Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/users/list/)

data/bin/console

@@ -11,7 +11,6 @@ HelpScout.configure do |config|
   config.app_id = ENV.fetch('HELP_SCOUT_APP_ID')
   config.app_secret = ENV.fetch('HELP_SCOUT_APP_SECRET')
   config.default_mailbox = ENV.fetch('HELP_SCOUT_DEFAULT_MAILBOX')
-  config.access_token = ENV.fetch('HELP_SCOUT_ACCESS_TOKEN', nil)
 end
 
 begin

data/lib/help_scout-sdk.rb

@@ -52,7 +52,6 @@ module HelpScout
 
     def configure
       yield(configuration)
-      api.access_token = HelpScout.configuration.access_token
     end
 
     def default_mailbox

data/lib/help_scout/api/access_token.rb

@@ -16,7 +16,7 @@ module HelpScout
         end
 
         def refresh!
-          return HelpScout.api.access_token unless HelpScout.access_token.nil? || HelpScout.access_token.stale?
+          return HelpScout.access_token unless HelpScout.access_token.nil? || HelpScout.access_token.stale?
 
           HelpScout.api.access_token = create
         end

data/lib/help_scout/configuration.rb

@@ -3,17 +3,10 @@
 module HelpScout
   class Configuration
     attr_accessor :app_id, :app_secret, :default_mailbox, :token_cache
-    attr_reader :access_token
     attr_writer :token_cache_key
 
     DEFAULT_CACHE_KEY = 'help_scout_token_cache'
 
-    def access_token=(token_value)
-      return unless token_value
-
-      @access_token = HelpScout::API::AccessToken.new(access_token: token_value)
-    end
-
     def token_cache_key
       return @token_cache_key if defined?(@token_cache_key)
 

data/lib/help_scout/thread.rb

@@ -3,12 +3,33 @@
 module HelpScout
   class Thread < HelpScout::Base
     class << self
+      def create(conversation_id, thread_type, params)
+        HelpScout.api.post(
+          create_path(conversation_id, thread_type),
+          HelpScout::Util.camelize_keys(params)
+        )
+        true
+      end
+
       def list(conversation_id, page: nil)
-        HelpScout.api.get(list_path(conversation_id), page: page).embedded_list.map { |details| new details }
+        HelpScout.api.get(
+          list_path(conversation_id), page: page
+        ).embedded_list.map { |details| new details.merge(conversation_id: conversation_id) }
+      end
+
+      def get(conversation_id, thread_id)
+        threads = list(conversation_id)
+        thread_id = thread_id.to_i
+
+        threads.find { |thread| thread.id == thread_id }
       end
 
       private
 
+      def create_path(conversation_id, thread_type)
+        "conversations/#{conversation_id}/#{thread_type}"
+      end
+
       def list_path(conversation_id)
         "conversations/#{conversation_id}/threads"
       end
@@ -32,6 +53,7 @@ module HelpScout
       created_at
       opened_at
       attachments
+      conversation_id
     ].freeze
 
     attr_accessor(*BASIC_ATTRIBUTES)
@@ -46,5 +68,15 @@ module HelpScout
 
       @hrefs = HelpScout::Util.map_links(params.fetch(:_links, []))
     end
+
+    def conversation
+      @_conversation ||= HelpScout::Conversation.get(conversation_id)
+    end
+
+    def update(operation, path, value = nil)
+      update_path = "conversations/#{conversation_id}/threads/#{id}"
+      HelpScout.api.patch(update_path, op: operation, path: path, value: value)
+      true
+    end
   end
 end

data/lib/help_scout/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: help_scout-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -223,6 +223,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt