help_scout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c0f81a717d1e98ee61c2cfbea80a333f18cab74
+  data.tar.gz: 290d049dec86ebe919ce0cf9affc5906267b8511
+SHA512:
+  metadata.gz: 6818f2cfbed3119f952677ab3de5880006bd3886e13f204e566b39086a7d5bcb19383de73cbf613823ad85fd6f4f864fc0c65eb0e94f8c66db8ac5f2f65b4d5e
+  data.tar.gz: 329b28bb44cad44336c025c7db49370a1ef399b40cfab2d4ae386fd8786fc2ec40968c4a488ae262100adc9c3c53b14469a64795403fd6d238b8e6441071a981

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.12.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mark Mulder
+
+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,38 @@
+# HelpScout
+
+[![Build Status](https://travis-ci.org/Springest/help_scout.svg?branch=master)](https://travis-ci.org/Springest/help_scout)
+
+This is a gem extracted out from our codebase at Springest. That means that it's currently not as general as it can be, we mostly do stuff with conversations and customers. At the moment we also pass in complete hash objects to create these conversations, something we want to improve on, but take note.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'help_scout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install help_scout
+
+## Usage
+
+## 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/springest/help_scout.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "help_scout"
+
+# 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

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.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'help_scout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "help_scout"
+  spec.version       = HelpScout::VERSION
+  spec.authors       = ["Dennis Paagman", "Miriam Tocino", "Mark Mulder"]
+  spec.email         = ["dennispaagman@gmail.com", "miriam.tocino@gmail.com", "markmulder@gmail.com"]
+
+  spec.summary       = "HelpScout is a an api client for Help Scout"
+  spec.homepage      = "https://github.com/Springest/help_scout"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/help_scout.rb

@@ -0,0 +1,137 @@
+require "help_scout/version"
+require "httparty"
+
+class HelpScout
+  attr_accessor :last_response
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  # Public: Create conversation
+  #
+  # data - hash with data
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/conversations/create/
+  #
+  # Returns conversation ID
+  def create_conversation(data)
+    post("conversations", { body: data })
+
+    # Extract ID of created conversation from the Location header
+    conversation_uri = last_response.headers["location"]
+    conversation_uri.match(/(\d+)\.json$/)[1]
+  end
+
+  # Public: Get conversation
+  #
+  # id - conversation ID
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/objects/conversation/
+  #
+  # Returns hash from HS with conversation data
+  def get_conversation(id)
+    get("conversations/#{id}")
+  end
+
+  # Public: Get conversations
+  #
+  # mailbox_id - ID of mailbox (find these with get_mailboxes)
+  # page - integer of page to fetch (default: 1)
+  # modified_since - Only return conversations that have been modified since
+  #                  this UTC datetime (default: nil)
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/conversations/list/
+  #
+  # Returns hash from HS with conversation data
+  def get_conversations(mailbox_id, page = 1, modified_since = nil)
+    options ={
+      page: page,
+      modified_since: modified_since,
+    }
+    get("mailboxes/#{mailbox_id}/conversations", options)
+  end
+
+  # Public: Update conversation
+  #
+  # id - conversation id
+  # data - hash with data
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/conversations/update/
+  def update_conversation(id, data)
+    put("conversations/#{id}", { body: data })
+  end
+
+  # Public: Search for conversations
+  #
+  # query - term to search for
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/search/conversations/
+  def search_conversations(query)
+    search("search/conversations", query)
+  end
+
+  # Public: Get customer
+  #
+  # id - customer id
+  #
+  # More info: http://developer.helpscout.net/help-desk-api/customers/get/
+  def get_customer(id)
+    get("customers/#{id}")
+  end
+
+  def get_mailboxes
+    get("mailboxes")
+  end
+
+  protected
+
+  def post(path, options = {})
+    options[:body] = options[:body].to_json if options[:body]
+
+    request(:post, path, options)
+  end
+
+  def put(path, options = {})
+    options[:body] = options[:body].to_json if options[:body]
+
+    request(:put, path, options)
+  end
+
+  def get(path, options = {})
+    request(:get, path, options)
+  end
+
+  def search(path, query, page_id = 1, items = [])
+    options = { query: { page: page_id, query: "(#{query})" } }
+
+    result = get(path, options)
+    if !result.empty?
+      next_page_id = page_id + 1
+      result["items"] += items
+      if next_page_id > result["pages"]
+        return result["items"]
+      else
+        search(path, query, next_page_id, result["items"])
+      end
+    end
+  end
+
+  def request(method, path, options)
+    uri = URI("https://api.helpscout.net/v1/#{path}.json")
+
+    # The password can be anything, it's not used, see:
+    # http://developer.helpscout.net/help-desk-api/
+    options = {
+      basic_auth: {
+        username: @api_key, password: 'X'
+      },
+      headers: {
+        'Content-Type' => 'application/json'
+      }
+    }.merge(options)
+
+    @last_response = HTTParty.send(method, uri, options)
+    @last_response.parsed_response
+  end
+end

data/lib/help_scout/version.rb

@@ -0,0 +1,3 @@
+class HelpScout
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: help_scout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Paagman
+- Miriam Tocino
+- Mark Mulder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: webmock
+  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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dennispaagman@gmail.com
+- miriam.tocino@gmail.com
+- markmulder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- help_scout.gemspec
+- lib/help_scout.rb
+- lib/help_scout/version.rb
+homepage: https://github.com/Springest/help_scout
+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.5.1
+signing_key: 
+specification_version: 4
+summary: HelpScout is a an api client for Help Scout
+test_files: []