help_scout-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db597946131f89598f48083d3352273b5adde0f23dfe608a9f42f4a0d836be83
+  data.tar.gz: d7e837bf6257fda9b10f21e74948068df19f50033885e70b30120004e98b6717
+SHA512:
+  metadata.gz: d9b1bec06d8ab4ee6715054ad7a96b3013532c2e62fd76eb5a68e0b6425b8a0f62f7b395dc3c60ab607a76926b3ae1ebeb928fbd9757977064b9c20a643ddc7c
+  data.tar.gz: ea66c98c374e78172b7cfa5daa7b236357bd4a74f624a86803725bddfb2b6503d4da95b88f1220d4d5aef1a48dfb7e481c63897e35fff7bba26d71df387a0ca3

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+.env*
+.byebug_history
+.rspec_status
+.ruby-gemset
+.ruby-version
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout:
+  DotPosition:
+    EnforcedStyle: trailing
+  MultilineMethodCallIndentation:
+    EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*_spec.rb'
+
+Metrics/ClassLength:
+  Max: 125
+
+Metrics/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Exclude:
+    - 'lib/help_scout-sdk.rb'
+    - 'spec/**/*_spec.rb'
+
+Style/Documentation:
+  Enabled: False

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+ - 2.3
+ - 2.4
+ - 2.5
+ - 2.6
+
+before_install:
+  - gem update --system
+  - gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andre@taxjar.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in helpscout.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andre LeBlanc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Help Scout API Wrapper
+
+[![Build Status](https://travis-ci.org/taxjar/help_scout-sdk.svg?branch=master)](https://travis-ci.org/taxjar/help_scout-sdk)
+
+🚨 WORK IN PROGRESS 🚨
+
+This gem is a wrapper around the Help Scout API. The current version is targeting the [Mailbox 2.0 API](https://developer.helpscout.com/mailbox-api/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "help_scout-sdk"
+```
+
+And then execute:
+
+    $ bundle
+
+## Progress
+
+| Models                     | List | Get  | Create  | Update | Delete  |
+| :------------------------- | :--: | :--: | :-----: | :----: | :-----: |
+| Attachment                 |   ❌  |  ❌  |    ✅   |    ❌   |    ❌   |
+| Conversations              |   ✅  |  ✅  |    ✅   |    ✅   |    ❌   |
+| Conversation::Threads      |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Conversation::ThreadSource |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Customers                  |   ✅  |  ✅  |    ❌   |    ❌   |    ❌   |
+| Notes                      |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Mailboxes                  |   ✅  |  ✅  |    ➖   |    ➖   |    ➖   |
+| Mailbox::Folders           |   ✅  |  ➖  |    ➖   |    ➖   |    ➖   |
+| Mailbox::Workflows         |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Tags                       |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Teams                      |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Team::Members              |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+| Users                      |   ✅  |  ✅  |    ❌   |    ❌   |    ❌   |
+| Workflows                  |   ❌  |  ❌  |    ❌   |    ❌   |    ❌   |
+
+| Endpoint | Supported |
+| -------- | :-------: |
+| Reports  |     ❌     |
+| Search   |     ❌     |
+| Webhooks |     ❌     |
+
+## Usage
+
+### Configuration
+
+```ruby
+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
+```
+
+### Conversations
+
+[Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/)
+
+```ruby
+HelpScout::Conversation.list
+location = HelpScout::Conversation.create(...)
+conversation = HelpScout::Conversation.get(location.split("/").last)
+conversation.update("replace", "/subject", "New Subject")
+```
+
+### Customers
+
+[Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/customers/list/)
+
+```ruby
+HelpScout::Customer.list
+HelpScout::Customer.get(id)
+```
+
+### Mailboxes
+
+[Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/list/)
+
+```ruby
+HelpScout::Mailbox.list
+mailbox = HelpScout::Mailbox.get(id)
+mailbox.fields
+mailbox.folders
+```
+
+### Users
+
+[Documentation Link](https://developer.helpscout.com/mailbox-api/endpoints/users/list/)
+
+```ruby
+HelpScout::User.list
+user = HelpScout::User.get(id)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taxjar/help_scout-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the H2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/taxjar/help_scout-sdk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler/audit/task'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::Audit::Task.new
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+desc 'Run CI'
+task :ci do
+  Rake::Task['bundle:audit'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec'].invoke
+end
+
+task default: :ci

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'awesome_print'
+require 'byebug'
+require 'help_scout-sdk'
+
+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
+  require 'pry'
+  Pry.start
+rescue LoadError
+  require 'irb'
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/help_scout-sdk.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'help_scout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'help_scout-sdk'
+  spec.version       = HelpScout::VERSION
+  spec.authors       = ['TaxJar']
+  spec.email         = ['support@taxjar.com']
+
+  spec.summary       = 'Ruby Help Scout SDK'
+  spec.description   = 'Ruby Help Scout SDK.'
+  spec.homepage      = 'https://github.com/taxjar/help_scout-sdk'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['source_code_uri'] = 'https://github.com/taxjar/help_scout-sdk'
+    spec.metadata['bug_tracker_uri'] = 'https://github.com/taxjar/help_scout-sdk/issues'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_development_dependency 'awesome_print', '~> 1.8'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'dotenv', '~> 2.2'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+  spec.add_development_dependency 'vcr', '~> 5.0'
+  spec.add_development_dependency 'webmock', '~> 3.3'
+end

data/lib/help_scout/api/access_token.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class API
+    class AccessToken
+      class << self
+        def create
+          connection = HelpScout::API::Client.new.unauthorized_connection
+          response = connection.post('oauth2/token', token_request_params)
+
+          case response.status
+          when 429 then raise ThrottleLimitReached, response.body&.dig('error')
+          when 500, 501, 503 then raise InternalError, response.body&.dig('error')
+          end
+
+          new HelpScout::Response.new(response).body
+        end
+
+        def refresh!
+          HelpScout.api.access_token = create
+        end
+
+        private
+
+        def token_request_params
+          @token_request_params ||= {
+            grant_type: 'client_credentials',
+            client_id: HelpScout.app_id,
+            client_secret: HelpScout.app_secret
+          }
+        end
+      end
+
+      attr_reader :expires_at, :expires_in, :value
+
+      def initialize(params)
+        @value = params[:access_token]
+        expires_in = params[:expires_in]
+
+        return unless expires_in
+
+        @expires_in = expires_in
+        @expires_at = Time.now.utc + expires_in
+      end
+
+      def expired?
+        Time.now.utc > expires_at
+      end
+    end
+  end
+end

data/lib/help_scout/api/client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class API
+    class Client
+      def authorized_connection
+        @authorized_connection ||= begin
+          HelpScout::API::AccessToken.refresh! if HelpScout.access_token.nil?
+          build_connection
+        end
+      end
+
+      def unauthorized_connection
+        @unauthorized_connection ||= begin
+          build_connection(authorize: false)
+        end
+      end
+
+      private
+
+      def build_connection(authorize: true)
+        Faraday.new(url: BASE_URL) do |conn|
+          conn.request :json
+          conn.authorization(:Bearer, HelpScout.access_token.value) if authorize && HelpScout.access_token&.value
+          conn.response(:json, content_type: /\bjson$/)
+          conn.adapter(Faraday.default_adapter)
+        end
+      end
+    end
+  end
+end

data/lib/help_scout/api.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class API
+    class BadRequest < StandardError; end
+    class NotAuthorized < StandardError; end
+    class NotFound < StandardError; end
+    class InternalError < StandardError; end
+    class ThrottleLimitReached < StandardError; end
+
+    BASE_URL = 'https://api.helpscout.net/v2/'
+
+    attr_accessor :access_token
+
+    def get(path, params = {})
+      send_request(:get, path, params)
+    end
+
+    def patch(path, params)
+      send_request(:patch, path, params)
+    end
+
+    def post(path, params)
+      send_request(:post, path, params)
+    end
+
+    def put(path, params)
+      send_request(:put, path, params)
+    end
+
+    private
+
+    def handle_response(result) # rubocop:disable AbcSize
+      case result.status
+      when 400 then raise BadRequest, result.body&.dig('validationErrors')
+      when 401 then raise NotAuthorized, result.body&.dig('error_description')
+      when 404 then raise NotFound, 'Resource Not Found'
+      when 429 then raise ThrottleLimitReached, result.body&.dig('error')
+      when 500, 501, 503 then raise InternalError, result.body&.dig('error')
+      end
+
+      HelpScout::Response.new(result)
+    end
+
+    def new_connection
+      HelpScout::API::Client.new.authorized_connection
+    end
+
+    def send_request(action, path, params)
+      connection = new_connection
+      response = connection.send(action, path, params.compact)
+
+      if response.status == 401
+        HelpScout::API::AccessToken.refresh!
+        response = connection.send(action, path, params.compact)
+      end
+
+      handle_response(response)
+    end
+  end
+end

data/lib/help_scout/attachment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Attachment < HelpScout::Base
+    class << self
+      def create(conversation_id, thread_id, params)
+        HelpScout.api.post(
+          create_path(conversation_id, thread_id),
+          HelpScout::Util.camelize_keys(params)
+        )
+        true
+      end
+
+      private
+
+      def base_path
+        'conversations/%<CONVERSATION_ID>/threads/%<THREAD_ID>/attachments'
+      end
+
+      def create_path(conversation_id, thread_id)
+        replacements = {
+          '%<CONVERSATION_ID>' => conversation_id,
+          '%<THREAD_ID>' => thread_id
+        }
+
+        HelpScout::Util.parse_path(base_path, replacements)
+      end
+    end
+  end
+end

data/lib/help_scout/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Base
+    class << self
+      private
+
+      def base_path
+        name.split('::').last.downcase.pluralize
+      end
+    end
+
+    def to_h(method = :to_h) # rubocop:disable Metrics/MethodLength
+      {}.tap do |result|
+        instance_variables.each do |var|
+          attribute = {
+            name: var,
+            value: HelpScout::Util.serialized_value(instance_variable_get(var), method)
+          }
+          if block_given?
+            yield(result, attribute)
+          else
+            result[keyify(attribute[:name])] = attribute[:value]
+          end
+        end
+      end
+    end
+
+    def as_json
+      to_h(:as_json) do |result, attribute|
+        result[HelpScout::Util.jsonify(attribute[:name])] = attribute[:value]
+      end
+    end
+
+    def to_json(*_args)
+      as_json.to_json
+    end
+  end
+end

data/lib/help_scout/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module HelpScout
+  class Configuration
+    attr_accessor :app_id, :app_secret, :default_mailbox
+    attr_reader :access_token
+
+    def access_token=(token_value)
+      @access_token = HelpScout::API::AccessToken.new(access_token: token_value)
+    end
+  end
+end