helpscout-mailbox-paths 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f115cdd3dc90b119a8d4e439411f6c09f06ca799965a964e9b32b7e5827dae2
+  data.tar.gz: 0e6d8541b9c8f85dac4c280afdccb7400773208b87e6279cdc0449f8401ff6ce
+SHA512:
+  metadata.gz: cff58d579cc9450ef348cc092681f0aee025d94f14160ce5bb070c321f96bc2bd65a428cad6918e55e309021920519f9246a8ab7c14a8f14843c7ea8121523ac
+  data.tar.gz: 4992916597b9404e17e9312a00092e31ff934b7afbfbd929cb5de04f0dda4b7b1358c3bc05040aaaadf7ffb1bc4056bb3b50d2d5591d0e2b5c4b89b87ddd9ded

data/.buildkite/pipeline.yml

@@ -0,0 +1,6 @@
+steps:
+  - name: ":rspec:"
+    command: "bundle exec rspec"
+    plugins:
+      docker-compose#v3.2.0:
+        run: app

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

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 TODO: Write your email address. 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/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.7
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY . /app
+
+RUN bundle install -j 8

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in helpscout-mailbox-paths.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    helpscout-mailbox-paths (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  helpscout-mailbox-paths!
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jason Jacob
+
+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,183 @@
+# Helpscout::Mailbox::Paths
+
+[![Build status](https://badge.buildkite.com/f19b143ad6bbb2fce71a361da78e974be4737e14d578d21b5d.svg)](https://buildkite.com/jayco/helpscout-mailbox-paths)
+
+Simple Gem for generating helpscout paths with params
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'helpscout-mailbox-paths'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install helpscout-mailbox-paths
+
+## Usage
+
+## Helpscout::Mailbox::Paths.generate_path()
+
+```ruby
+require 'helpscout/mailbox/paths'
+
+mailbox = Helpscout::Mailbox::Paths.generate_path(:v2_conversation, {conversation_id: 1089909636})
+# => {:method=>"GET", :path=>"/v2/conversations/1089909636"}
+```
+
+## API Mapping
+
+```ruby
+PATH_MAP = {
+    v2_conversations_create: ['POST', '/v2/conversations'],
+    v2_conversations: ['GET', '/v2/conversations'],
+    v2_conversations_delete: ['DELETE', '/v2/conversations/%{conversation_id}'],
+    v2_conversation: ['GET', '/v2/conversations/%{conversation_id}'],
+    v2_conversations_update: ['PATCH', '/v2/conversations/%{conversation_id}'],
+
+    v2_conversations_attachment_delete: ['DELETE', '/v2/conversations/%{conversation_id}/attachments/%{attachment_id}'],
+    v2_conversations_attachment: ['GET', '/v2/conversations/%{conversation_id}/attachments/%{attachment_id}/data'],
+    v2_conversations_attachment_create: ['POST', '/v2/conversations/%{conversation_id}/threads/%{thread_id}/attachments'],
+
+    v2_conversations_fields_update: ['PUT', '/v2/conversations/%{conversation_id}/fields'],
+    v2_conversations_tags_update: ['PUT', '/v2/conversations/%{conversation_id}/tags'],
+
+    v2_conversations_chat_create: ['POST', '/v2/conversations/%{conversation_id}/chats'],
+    v2_conversations_note_create: ['POST', '/v2/conversations/%{conversation_id}/notes'],
+    v2_conversations_phone_create: ['POST', '/v2/conversations/%{conversation_id}/phones'],
+    v2_conversations_reply_create: ['POST', '/v2/conversations/%{conversation_id}/reply'],
+
+    v2_conversations_original_source: ['GET', '/v2/conversations/%{conversation_id}/threads/%{thread_id}/original-source'],
+
+    v2_conversations_thread_create: ['POST', '/v2/conversations/%{conversation_id}/customer'],
+    v2_conversations_thread_list: ['GET', '/v2/conversations/%{conversation_id}/threads'],
+    v2_conversations_thread_update: ['PATCH', '/v2/conversations/%{conversation_id}/threads/%{thread_id}'],
+
+    v2_conversations_customer_properties: ['GET', '/v2/customer-properties'],
+
+    v2_customers: ['GET', '/v2/customers'],
+    v2_customers_create: ['POST', '/v2/customers'],
+    v2_customer: ['GET', '/v2/customers/%{customer_id}'],
+    v2_customers_overwrite: ['PUT', '/v2/customers/%{customer_id}'],
+    v2_customers_update: ['PATCH', '/v2/customers/%{customer_id}'],
+
+    v2_customers_address_create: ['POST', '/v2/customers/%{customer_id}/address'],
+    v2_customers_address_delete: ['DELETE', '/v2/customers/%{customer_id}/address'],
+    v2_customers_address: ['GET', '/v2/customers/%{customer_id}/address'],
+    v2_customers_address_update: ['PATCH', '/v2/customers/%{customer_id}/address'],
+
+    v2_customers_chats: ['GET', '/v2/customers/%{customer_id}/chats'],
+    v2_customers_chats_create: ['POST', '/v2/customers/%{customer_id}/chats/%{chat_id}'],
+    v2_customers_chats_update: ['PUT', '/v2/customers/%{customer_id}/chats/%{chat_id}'],
+
+    v2_customers_emails_create: ['POST', '/v2/customers/%{customer_id}/emails'],
+    v2_customers_emails: ['GET', '/v2/customers/%{customer_id}/emails'],
+    v2_customers_emails_update: ['PUT', '/v2/customers/%{customer_id}/emails/%{email_id}'],
+    v2_customers_emails_delete: ['DELETE', '/v2/customers/%{customer_id}/emails/%{email_id}'],
+
+    v2_customers_phones_create: ['POST', '/v2/customers/%{customer_id}/phones'],
+    v2_customers_phones: ['GET', '/v2/customers/%{customer_id}/phones'],
+    v2_customers_phones_update: ['PUT', '/v2/customers/%{customer_id}/phones/%{phone_id}'],
+    v2_customers_phones_delete: ['DELETE', '/v2/customers/%{customer_id}/phones/%{phone_id}'],
+
+    v2_customers_social_create: ['POST', '/v2/customers/%{customer_id}/social-profiles'],
+    v2_customers_social: ['GET', '/v2/customers/%{customer_id}/social-profiles'],
+    v2_customers_social_update: ['PUT', '/v2/customers/%{customer_id}/social-profiles/%{profile_id}'],
+    v2_customers_social_delete: ['DELETE', '/v2/customers/%{customer_id}/social-profiles/%{profile_id}'],
+
+    v2_customers_website_create: ['POST', '/v2/customers/%{customer_id}/websites'],
+    v2_customers_website: ['GET', '/v2/customers/%{customer_id}/websites'],
+    v2_customers_website_update: ['PUT', '/v2/customers/%{customer_id}/websites/%{website_id}'],
+    v2_customers_website_delete: ['DELETE', '/v2/customers/%{customer_id}/websites/%{website_id}'],
+
+    v2_customers_properties_update: ['PATCH', '/v2/customers/%{customer_id}/properties'],
+
+    v2_mailboxes: ['GET', '/v2/mailboxes'],
+    v2_mailbox: ['GET', '/v2/mailboxes/%{mailbox_id}'],
+    v2_mailbox_fields: ['GET', '/v2/mailboxes/%{mailbox_id}/fields'],
+    v2_mailbox_folders: ['GET', '/v2/mailboxes/%{mailbox_id}/folders'],
+
+    v2_ratings: ['GET', '/v2/ratings/%{rating_id}'],
+
+    v2_reports_company: ['GET', '/v2/reports/company'],
+    v2_reports_company_customers_helped: ['GET', '/v2/reports/company/customers-helped'],
+    v2_reports_company_drilldown: ['GET', '/v2/reports/company/drilldown'],
+
+    v2_reports_conversations: ['GET', '/v2/reports/conversations'],
+    v2_reports_conversations_new: ['GET', '/v2/reports/conversations/new'],
+    v2_reports_conversations_channel_volume: ['GET', '/v2/reports/conversations/volume-by-channel'],
+    v2_reports_conversations_busy_times: ['GET', '/v2/reports/conversations/busy-times'],
+    v2_reports_conversations_drilldown: ['GET', '/v2/reports/conversations/drilldown'],
+    v2_reports_conversations_new_drilldown: ['GET', '/v2/reports/conversations/new-drilldown'],
+    v2_reports_conversations_fields_drilldown: ['GET', '/v2/reports/conversations/fields-drilldown'],
+    v2_reports_conversations_messages_received: ['GET', '/v2/reports/conversations/received-messages'],
+
+    v2_reports_docs: ['GET', '/v2/reports/docs'],
+
+    v2_reports_happiness: ['GET', '/v2/reports/happiness'],
+    v2_reports_happiness_ratings: ['GET', '/v2/reports/happiness/ratings'],
+
+    v2_reports_productivity: ['GET', '/v2/reports/productivity'],
+    v2_reports_productivity_first_response_times: ['GET', '/v2/reports/productivity/first-response-time'],
+    v2_reports_productivity_replies: ['GET', '/v2/reports/productivity/replies-sent'],
+    v2_reports_productivity_resolutions_times: ['GET', '/v2/reports/productivity/resolution-time'],
+    v2_reports_productivity_resolved: ['GET', '/v2/reports/productivity/resolved'],
+    v2_reports_productivity_response_times: ['GET', '/v2/reports/productivity/response-time'],
+
+    v2_reports_user: ['GET', '/v2/reports/user'],
+    v2_reports_user_conversation_history: ['GET', '/v2/reports/user/conversation-history'],
+    v2_reports_user_customers_helped: ['GET', '/v2/reports/user/customers-helped'],
+    v2_reports_user_happiness: ['GET', '/v2/reports/user/happiness'],
+    v2_reports_user_ratings: ['GET', '/v2/reports/user/ratings'],
+    v2_reports_user_replies: ['GET', '/v2/reports/user/replies'],
+    v2_reports_user_resolutions: ['GET', '/v2/reports/user/resolutions'],
+    v2_reports_user_drilldown: ['GET', '/v2/reports/user/drilldown'],
+
+    v2_reports_chat: ['GET', '/v2/reports/chat'],
+    v2_reports_email: ['GET', '/v2/reports/email'],
+    v2_reports_phone: ['GET', '/v2/reports/phone'],
+
+    v2_tags: ['GET', '/v2/tags'],
+
+    v2_teams: ['GET', '/v2/teams'],
+    v2_teams_members: ['GET', '/v2/teams/%{team_id}/members'],
+
+    v2_users: ['GET', '/v2/users'],
+    v2_me: ['GET', '/v2/users/me'],
+    v2_user: ['GET', '/v2/users/%{user_id}'],
+
+    v2_webhooks_create: ['POST', '/v2/webhooks'],
+    v2_webhooks: ['GET', '/v2/webhooks'],
+    v2_webhook: ['GET', '/v2/webhooks/%{webhook_id}'],
+    v2_webhooks_update: ['PUT', '/v2/webhooks/%{webhook_id}'],
+    v2_webhooks_delete: ['DELETE', '/v2/webhooks/%{webhook_id}'],
+
+    v2_workflows: ['GET', '/v2/workflows'],
+    v2_workflows_run: ['POST', '/v2/workflows/%{workflow_id}/run'],
+    v2_workflows_update: ['PATCH', '/v2/workflows/%{workflow_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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jayco/helpscout-mailbox-paths. 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 Helpscout::Mailbox::Paths project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/helpscout-mailbox-paths/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "helpscout/mailbox/paths"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/docker-compose.yml

@@ -0,0 +1,5 @@
+version: "3"
+
+services:
+  app:
+    build: .

data/helpscout-mailbox-paths.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'helpscout/mailbox/paths/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'helpscout-mailbox-paths'
+  spec.version       = Helpscout::Mailbox::Paths::VERSION
+  spec.authors       = ['Jason Jacob']
+  spec.email         = ['hipcog@gmail.com']
+
+  spec.summary       = 'Generates HelpScout V2 mailbox paths'
+  spec.homepage      = 'https://github.com/jayco/helpscout-mailbox-paths.git'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jayco/helpscout-mailbox-paths.git'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/helpscout/mailbox/paths.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'helpscout/mailbox/paths/version'
+
+module Helpscout
+  module Mailbox
+    module Paths
+      class Error < StandardError; end
+      PATH_MAP = {
+        v2_conversations_create: ['POST', '/v2/conversations'].freeze,
+        v2_conversations: ['GET', '/v2/conversations'].freeze,
+        v2_conversations_delete: ['DELETE', '/v2/conversations/%{conversation_id}'].freeze,
+        v2_conversation: ['GET', '/v2/conversations/%{conversation_id}'].freeze,
+        v2_conversations_update: ['PATCH', '/v2/conversations/%{conversation_id}'].freeze,
+
+        v2_conversations_attachment_delete: ['DELETE', '/v2/conversations/%{conversation_id}/attachments/%{attachment_id}'].freeze,
+        v2_conversations_attachment: ['GET', '/v2/conversations/%{conversation_id}/attachments/%{attachment_id}/data'].freeze,
+        v2_conversations_attachment_create: ['POST', '/v2/conversations/%{conversation_id}/threads/%{thread_id}/attachments'].freeze,
+
+        v2_conversations_fields_update: ['PUT', '/v2/conversations/%{conversation_id}/fields'].freeze,
+        v2_conversations_tags_update: ['PUT', '/v2/conversations/%{conversation_id}/tags'].freeze,
+
+        v2_conversations_chat_create: ['POST', '/v2/conversations/%{conversation_id}/chats'].freeze,
+        v2_conversations_note_create: ['POST', '/v2/conversations/%{conversation_id}/notes'].freeze,
+        v2_conversations_phone_create: ['POST', '/v2/conversations/%{conversation_id}/phones'].freeze,
+        v2_conversations_reply_create: ['POST', '/v2/conversations/%{conversation_id}/reply'].freeze,
+
+        v2_conversations_original_source: ['GET', '/v2/conversations/%{conversation_id}/threads/%{thread_id}/original-source'].freeze,
+
+        v2_conversations_thread_create: ['POST', '/v2/conversations/%{conversation_id}/customer'].freeze,
+        v2_conversations_thread_list: ['GET', '/v2/conversations/%{conversation_id}/threads'].freeze,
+        v2_conversations_thread_update: ['PATCH', '/v2/conversations/%{conversation_id}/threads/%{thread_id}'].freeze,
+
+        v2_conversations_customer_properties: ['GET', '/v2/customer-properties'].freeze,
+
+        v2_customers: ['GET', '/v2/customers'].freeze,
+        v2_customers_create: ['POST', '/v2/customers'].freeze,
+        v2_customer: ['GET', '/v2/customers/%{customer_id}'].freeze,
+        v2_customers_overwrite: ['PUT', '/v2/customers/%{customer_id}'].freeze,
+        v2_customers_update: ['PATCH', '/v2/customers/%{customer_id}'].freeze,
+
+        v2_customers_address_create: ['POST', '/v2/customers/%{customer_id}/address'].freeze,
+        v2_customers_address_delete: ['DELETE', '/v2/customers/%{customer_id}/address'].freeze,
+        v2_customers_address: ['GET', '/v2/customers/%{customer_id}/address'].freeze,
+        v2_customers_address_update: ['PATCH', '/v2/customers/%{customer_id}/address'].freeze,
+
+        v2_customers_chats: ['GET', '/v2/customers/%{customer_id}/chats'].freeze,
+        v2_customers_chats_create: ['POST', '/v2/customers/%{customer_id}/chats/%{chat_id}'].freeze,
+        v2_customers_chats_update: ['PUT', '/v2/customers/%{customer_id}/chats/%{chat_id}'].freeze,
+
+        v2_customers_emails_create: ['POST', '/v2/customers/%{customer_id}/emails'].freeze,
+        v2_customers_emails: ['GET', '/v2/customers/%{customer_id}/emails'].freeze,
+        v2_customers_emails_update: ['PUT', '/v2/customers/%{customer_id}/emails/%{email_id}'].freeze,
+        v2_customers_emails_delete: ['DELETE', '/v2/customers/%{customer_id}/emails/%{email_id}'].freeze,
+
+        v2_customers_phones_create: ['POST', '/v2/customers/%{customer_id}/phones'].freeze,
+        v2_customers_phones: ['GET', '/v2/customers/%{customer_id}/phones'].freeze,
+        v2_customers_phones_update: ['PUT', '/v2/customers/%{customer_id}/phones/%{phone_id}'].freeze,
+        v2_customers_phones_delete: ['DELETE', '/v2/customers/%{customer_id}/phones/%{phone_id}'].freeze,
+
+        v2_customers_social_create: ['POST', '/v2/customers/%{customer_id}/social-profiles'].freeze,
+        v2_customers_social: ['GET', '/v2/customers/%{customer_id}/social-profiles'].freeze,
+        v2_customers_social_update: ['PUT', '/v2/customers/%{customer_id}/social-profiles/%{profile_id}'].freeze,
+        v2_customers_social_delete: ['DELETE', '/v2/customers/%{customer_id}/social-profiles/%{profile_id}'].freeze,
+
+        v2_customers_website_create: ['POST', '/v2/customers/%{customer_id}/websites'].freeze,
+        v2_customers_website: ['GET', '/v2/customers/%{customer_id}/websites'].freeze,
+        v2_customers_website_update: ['PUT', '/v2/customers/%{customer_id}/websites/%{website_id}'].freeze,
+        v2_customers_website_delete: ['DELETE', '/v2/customers/%{customer_id}/websites/%{website_id}'].freeze,
+
+        v2_customers_properties_update: ['PATCH', '/v2/customers/%{customer_id}/properties'].freeze,
+
+        v2_mailboxes: ['GET', '/v2/mailboxes'].freeze,
+        v2_mailbox: ['GET', '/v2/mailboxes/%{mailbox_id}'].freeze,
+        v2_mailbox_fields: ['GET', '/v2/mailboxes/%{mailbox_id}/fields'].freeze,
+        v2_mailbox_folders: ['GET', '/v2/mailboxes/%{mailbox_id}/folders'].freeze,
+
+        v2_ratings: ['GET', '/v2/ratings/%{rating_id}'].freeze,
+
+        v2_reports_company: ['GET', '/v2/reports/company'].freeze,
+        v2_reports_company_customers_helped: ['GET', '/v2/reports/company/customers-helped'].freeze,
+        v2_reports_company_drilldown: ['GET', '/v2/reports/company/drilldown'].freeze,
+
+        v2_reports_conversations: ['GET', '/v2/reports/conversations'].freeze,
+        v2_reports_conversations_new: ['GET', '/v2/reports/conversations/new'].freeze,
+        v2_reports_conversations_channel_volume: ['GET', '/v2/reports/conversations/volume-by-channel'].freeze,
+        v2_reports_conversations_busy_times: ['GET', '/v2/reports/conversations/busy-times'].freeze,
+        v2_reports_conversations_drilldown: ['GET', '/v2/reports/conversations/drilldown'].freeze,
+        v2_reports_conversations_new_drilldown: ['GET', '/v2/reports/conversations/new-drilldown'].freeze,
+        v2_reports_conversations_fields_drilldown: ['GET', '/v2/reports/conversations/fields-drilldown'].freeze,
+        v2_reports_conversations_messages_received: ['GET', '/v2/reports/conversations/received-messages'].freeze,
+
+        v2_reports_docs: ['GET', '/v2/reports/docs'].freeze,
+
+        v2_reports_happiness: ['GET', '/v2/reports/happiness'].freeze,
+        v2_reports_happiness_ratings: ['GET', '/v2/reports/happiness/ratings'].freeze,
+
+        v2_reports_productivity: ['GET', '/v2/reports/productivity'].freeze,
+        v2_reports_productivity_first_response_times: ['GET', '/v2/reports/productivity/first-response-time'].freeze,
+        v2_reports_productivity_replies: ['GET', '/v2/reports/productivity/replies-sent'].freeze,
+        v2_reports_productivity_resolutions_times: ['GET', '/v2/reports/productivity/resolution-time'].freeze,
+        v2_reports_productivity_resolved: ['GET', '/v2/reports/productivity/resolved'].freeze,
+        v2_reports_productivity_response_times: ['GET', '/v2/reports/productivity/response-time'].freeze,
+
+        v2_reports_user: ['GET', '/v2/reports/user'].freeze,
+        v2_reports_user_conversation_history: ['GET', '/v2/reports/user/conversation-history'].freeze,
+        v2_reports_user_customers_helped: ['GET', '/v2/reports/user/customers-helped'].freeze,
+        v2_reports_user_happiness: ['GET', '/v2/reports/user/happiness'].freeze,
+        v2_reports_user_ratings: ['GET', '/v2/reports/user/ratings'].freeze,
+        v2_reports_user_replies: ['GET', '/v2/reports/user/replies'].freeze,
+        v2_reports_user_resolutions: ['GET', '/v2/reports/user/resolutions'].freeze,
+        v2_reports_user_drilldown: ['GET', '/v2/reports/user/drilldown'].freeze,
+
+        v2_reports_chat: ['GET', '/v2/reports/chat'].freeze,
+        v2_reports_email: ['GET', '/v2/reports/email'].freeze,
+        v2_reports_phone: ['GET', '/v2/reports/phone'].freeze,
+
+        v2_tags: ['GET', '/v2/tags'].freeze,
+
+        v2_teams: ['GET', '/v2/teams'].freeze,
+        v2_teams_members: ['GET', '/v2/teams/%{team_id}/members'].freeze,
+
+        v2_users: ['GET', '/v2/users'].freeze,
+        v2_me: ['GET', '/v2/users/me'].freeze,
+        v2_user: ['GET', '/v2/users/%{user_id}'].freeze,
+
+        v2_webhooks_create: ['POST', '/v2/webhooks'].freeze,
+        v2_webhooks: ['GET', '/v2/webhooks'].freeze,
+        v2_webhook: ['GET', '/v2/webhooks/%{webhook_id}'].freeze,
+        v2_webhooks_update: ['PUT', '/v2/webhooks/%{webhook_id}'].freeze,
+        v2_webhooks_delete: ['DELETE', '/v2/webhooks/%{webhook_id}'].freeze,
+
+        v2_workflows: ['GET', '/v2/workflows'].freeze,
+        v2_workflows_run: ['POST', '/v2/workflows/%{workflow_id}/run'].freeze,
+        v2_workflows_update: ['PATCH', '/v2/workflows/%{workflow_id}'].freeze
+      }.freeze
+
+      def self.generate_path(path, values)
+        template = PATH_MAP[path]
+        raise "path '#{path}' not found" if template.nil?
+
+        { method: template.first, path: template.last % values }
+      end
+    end
+  end
+end

data/lib/helpscout/mailbox/paths/version.rb

@@ -0,0 +1,7 @@
+module Helpscout
+  module Mailbox
+    module Paths
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: helpscout-mailbox-paths
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Jacob
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- hipcog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".buildkite/pipeline.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- helpscout-mailbox-paths.gemspec
+- lib/helpscout/mailbox/paths.rb
+- lib/helpscout/mailbox/paths/version.rb
+homepage: https://github.com/jayco/helpscout-mailbox-paths.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jayco/helpscout-mailbox-paths.git
+  source_code_uri: https://github.com/jayco/helpscout-mailbox-paths.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generates HelpScout V2 mailbox paths
+test_files: []