help_scout-sdk 1.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d4c58f9f96b57b2d1bbc0cd69ad741ffa6201244861167992e8212901d491d2
-  data.tar.gz: 055c66adf697283a7836ce6fdb91156cea27ea1cddf0fc6f8b2c05c07ed174a8
+  metadata.gz: 4286a555cb8b028bcc762b8152d44d13698b8e4f3fe9edc546ba459ba3b9ef70
+  data.tar.gz: f54e8cce71dccf0ab9e79b2dbe1a3e212c3d58d70db03d10ec4b27e98b1dc410
 SHA512:
-  metadata.gz: 2058da0b726acce0ef9993b40e827bb2be27f2947c78dfcb57216e51acb3fbcd4969b86a658e621e1bd63c1e6410f291a55cb2aaa03fd446374208e2376eeed0
-  data.tar.gz: 10b8bbca725910b62a0b3120247506d50b8c7e3f34ed50a39ae2ddeb340d9081803b66d2649e9a9b410de4d1af2eb346372f3b96bcb6e7543f38e6f7c790f163
+  metadata.gz: 4cd56f581e3c66a2602e2f26071befb87b3f6546f53848415c6a5d357e6373767065e681802936b73a81e092bd712bc6434caa7f976dd422004b1b2cd9c1f618
+  data.tar.gz: 38ada331bd5a25454540ec4a5f436c16c2ba6955a2049b62cf1a53e90040fe4dbf0f2f1ff0d5a510dbbc5697e111574ec63f16c3215d1f03a7ef4d288db0557e

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+### master (unreleased)
+
+## 3.0.0 / 2024-03-14
+
+Breaking Changes:
+
+* Upgrades Faraday dependency to 2.9 which makes it compatible with Ruby 3.x
+  However, Faraday does not support Ruby 2.x on this version.
+    ([#30](https://github.com/taxjar/help_scout-sdk/pull/30))
+
+### 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/help_scout-sdk.gemspec

@@ -31,9 +31,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'faraday', '~> 0.10'
-  spec.add_dependency 'faraday_middleware', '>= 0.10.1', '< 1.0'
-  spec.required_ruby_version = '>= 2.3'
+  spec.add_dependency 'faraday', '2.9.0'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_development_dependency 'awesome_print', '~> 1.8'
   spec.add_development_dependency 'bundler', '~> 2.0'

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/api/client.rb

@@ -13,7 +13,7 @@ module HelpScout
         @_connection ||= build_connection.tap do |conn|
           if authorize?
             HelpScout::API::AccessToken.refresh!
-            conn.authorization(:Bearer, access_token) if access_token
+            conn.request(:authorization, 'Bearer', access_token) if access_token
           end
         end
       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 = '3.0.1'
 end

data/lib/help_scout-sdk.rb

@@ -4,7 +4,6 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'json'
 require 'faraday'
-require 'faraday_middleware'
 
 require 'help_scout/version'
 
@@ -52,7 +51,6 @@ module HelpScout
 
     def configure
       yield(configuration)
-      api.access_token = HelpScout.configuration.access_token
     end
 
     def default_mailbox

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: help_scout-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 3.0.1
 platform: ruby
 authors:
 - TaxJar
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,36 +28,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +203,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -257,7 +238,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/taxjar/help_scout-sdk
   bug_tracker_uri: https://github.com/taxjar/help_scout-sdk/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -265,15 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby Help Scout SDK
 test_files: []