helpscout_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f988be1e5e6b85055a1981734b26c4eacd1c53ff39e4193c5701b9a3310c69b
+  data.tar.gz: ed9c81ef958817f9f7c37e7431cec6499511a7bca1f9b035415b7dbca548bf34
+SHA512:
+  metadata.gz: '08ea175cbdbbdebb33db12a305e2c0f1b41590f729f8b2cbb9f230c1aae54438d3c7c0b352d40ba5fbe46680a3af97522c339d173f2166a487b17f196e628eee'
+  data.tar.gz: 032d2a72c7504771135168513fef4964b11791b0ab427f97c24e31e84822c6b04ec8f3ecc405d7358d119691214200e1173bb6b8aa7a9e5a4482ff42b7ff6a48

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.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 hello@garethfuller.me. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in helpscout_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    helpscout_api (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  helpscout_api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 garethfuller
+
+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,64 @@
+# HelpscoutApi
+
+A simple ruby wrapper for the [Helpscout API](https://developer.helpscout.com/help-desk-api/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'helpscout_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install helpscout_api
+
+## Usage
+
+```ruby
+# Authenticate your client
+client = HelpscoutApi::Client.new(api_token: YOUR_API_TOKEN)
+
+# List resources
+client.<resource>.list(<params>)
+# e.g. client.mailboxes.list(<params>)
+
+# Get resources
+client.<resource>.get(<id>, <params>)
+# e.g. client.mailboxes.get(123)
+
+# Create resource
+client.<resource>.create(<params>)
+# e.g. client.conversations.get({ conversation_params })
+
+# CONVERSATIONS
+# List all
+client.conversations.list(mailbox_id: <mailbox_id>, <params>)
+
+# Create
+client.conversations.create(<params>)
+# See https://developer.helpscout.com/help-desk-api/conversations/create/ for required params
+```
+
+## 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/[USERNAME]/helpscout_api. 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 HelpscoutApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/helpscout_api/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_api"
+
+# 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/helpscout_api.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "helpscout_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "helpscout_api"
+  spec.version       = HelpscoutApi::VERSION
+  spec.authors       = ["garethfuller"]
+  spec.email         = ["gareth@bitbond.com"]
+
+  spec.summary       = %q{A simple ruby wrapper for the Helpscout API.}
+  spec.description   = %q{A simple ruby wrapper for the Helpscout API.}
+  spec.homepage      = "https://github.com/bitbond/helpscout_api"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "httparty"
+end

data/lib/helpscout_api/client.rb

@@ -0,0 +1,71 @@
+require 'httparty'
+
+module HelpscoutApi
+
+  HEADERS = { "Content-Type" => "application/json" }
+  API_VERSION = "v1"
+
+  class Client
+
+    include HTTParty
+    format :json
+    attr_accessor :api_token, :auth_params
+    headers HEADERS
+    base_uri "https://api.helpscout.net/#{API_VERSION}/"
+
+    def initialize(api_token:)
+      @api_token = api_token
+      @auth_params = { username: api_token, password: "X" }
+    end
+
+    def list(**params)
+      response = self.class.get "#{resource_path}.json", basic_auth: @auth_params, query: params
+      handle response
+    end
+
+    def get(id, **params)
+      response = self.class.get "#{resource_path}/#{id}.json", basic_auth: @auth_params, query: params
+      handle response
+    end
+
+    def create(**params)
+      response = self.class.post "#{resource_path}.json", basic_auth: @auth_params, body: params.to_json
+      handle response
+    end
+
+    def mailboxes
+      HelpscoutApi::Mailbox.new(self, @auth_params)
+    end
+
+    def conversations
+      HelpscoutApi::Conversation.new(self, @auth_params)
+    end
+
+    def resource_path
+      klass = self.class.name.split('::').last
+      klass[0] = klass[0].chr.downcase
+
+      if klass.end_with?('y')
+        "/#{klass.chop}ies"
+      elsif klass.end_with?('x')
+        "/#{klass}es"
+      else
+        "/#{klass}s"
+      end
+    end
+
+    def handle response
+      case response.code
+      when 200..299
+        response.parsed_response
+      when 403..404
+        raise HTTParty::Error, response.parsed_response['error']
+      when 500..600
+        raise HTTParty::Error, response.parsed_response['error']
+      else
+        raise StandardError, 'Unknown error'
+      end
+    end
+
+  end
+end

data/lib/helpscout_api/conversation.rb

@@ -0,0 +1,17 @@
+module HelpscoutApi
+  class Conversation < Client
+
+    attr_accessor :auth_params
+
+    def initialize(client, auth_params)
+      @client = client
+      @auth_params = auth_params
+    end
+
+    def list(mailbox_id:, **params)
+      response = self.class.get "/mailboxes/#{mailbox_id}#{resource_path}.json", basic_auth: @auth_params, query: params
+      handle response
+    end
+
+  end
+end

data/lib/helpscout_api/mailbox.rb

@@ -0,0 +1,12 @@
+module HelpscoutApi
+  class Mailbox < Client
+
+    attr_accessor :auth_params
+
+    def initialize(client, auth_params)
+      @client = client
+      @auth_params = auth_params
+    end
+    
+  end
+end

data/lib/helpscout_api/version.rb

@@ -0,0 +1,3 @@
+module HelpscoutApi
+  VERSION = "0.1.0"
+end

data/lib/helpscout_api.rb

@@ -0,0 +1,8 @@
+require "helpscout_api/version"
+require 'helpscout_api/client'
+require 'helpscout_api/mailbox'
+require 'helpscout_api/conversation'
+
+module HelpscoutApi
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: helpscout_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- garethfuller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple ruby wrapper for the Helpscout API.
+email:
+- gareth@bitbond.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- helpscout_api.gemspec
+- lib/helpscout_api.rb
+- lib/helpscout_api/client.rb
+- lib/helpscout_api/conversation.rb
+- lib/helpscout_api/mailbox.rb
+- lib/helpscout_api/version.rb
+homepage: https://github.com/bitbond/helpscout_api
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: A simple ruby wrapper for the Helpscout API.
+test_files: []