outreach-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1e810766e362fa6195a059c7b0199c55a1511f6caeec5416883e97897a9abaa
+  data.tar.gz: 2c37d788ff83ce7ae03e407fe24632429d033ab6475789b8dbb7e64f3d558b62
+SHA512:
+  metadata.gz: 5e76826b3e2c190af5d7e28b26320bbc2a089bdd286b9aab0d59b2f9bc1659c410bdb836cf5a3bc40cd0dfaa38e779973231d1718fb014770ea45fde5fc51993
+  data.tar.gz: 5b290333d55ee85d8b4ed7187dcb8c5fe97bf6d08c0a3ffb2a228b74d2de0f09d05e5726d16a68aec8e10c25bc56aeed045dd6aa17cb5e0594e375442da157fb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/bin
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/.idea

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.5.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,2 @@
+# outreach-ruby
+Outreach API wrapper

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/outreach-ruby.rb

@@ -0,0 +1,23 @@
+require 'outreach-ruby/version'
+require 'outreach-ruby/errors'
+require 'outreach-ruby/request'
+require 'outreach-ruby/authorization'
+require 'outreach-ruby/client'
+require 'outreach-ruby/prospect'
+require 'outreach-ruby/user'
+require 'outreach-ruby/sequence'
+require 'outreach-ruby/sequence_state'
+require 'outreach-ruby/service/prospect'
+require 'outreach-ruby/service/user'
+require 'outreach-ruby/service/sequence'
+require 'outreach-ruby/service/sequence_state'
+
+module Outreach
+  class << self
+    attr_accessor :application_identifier
+    attr_accessor :application_secret
+    attr_accessor :scopes
+    attr_accessor :redirect_uri
+    attr_accessor :debug
+  end
+end

data/lib/outreach-ruby/authorization.rb

@@ -0,0 +1,50 @@
+require 'uri'
+
+module Outreach
+  class Authorization
+    API_URL = 'https://api.outreach.io/oauth/token'.freeze
+
+    attr_reader :token, :refresh_token, :expires_in
+
+    def initialize(attrs)
+      @token = attrs['access_token']
+      @refresh_token = attrs['refresh_token']
+      @expires_in = attrs['expires_in']
+    end
+
+    def self.authorization_url
+      url = 'https://api.outreach.io/oauth/authorize'
+      params = {
+        client_id: Outreach.application_identifier,
+        redirect_uri: Outreach.redirect_uri,
+        response_type: 'code',
+        scope: Outreach.scopes
+      }
+      url + '?' + URI.encode_www_form(params)
+    end
+
+    def self.create(authorization_code)
+      params = {
+        client_id: Outreach.application_identifier,
+        client_secret: Outreach.application_secret,
+        redirect_uri: Outreach.redirect_uri,
+        grant_type: 'authorization_code',
+        code: authorization_code
+      }
+      response = Outreach::Request.new.post(API_URL, params)
+      new(response)
+    end
+
+    def self.refresh(refresh_token)
+      params = {
+        client_id: Outreach.application_identifier,
+        client_secret: Outreach.application_secret,
+        redirect_uri: Outreach.redirect_uri,
+        grant_type: 'refresh_token',
+        refresh_token: refresh_token
+      }
+      response = Request.new.post(API_URL, params)
+      new(response)
+    end
+  end
+end

data/lib/outreach-ruby/client.rb

@@ -0,0 +1,27 @@
+module Outreach
+  class Client
+    def initialize(api_token)
+      @api_token = api_token
+    end
+
+    def prospects
+      Outreach::Service::Prospect.new(self)
+    end
+
+    def users
+      Outreach::Service::User.new(self)
+    end
+
+    def sequences
+      Outreach::Service::Sequence.new(self)
+    end
+
+    def sequence_states
+      Outreach::Service::SequenceState.new(self)
+    end
+
+    def request
+      Request.new(@api_token)
+    end
+  end
+end

data/lib/outreach-ruby/errors.rb

@@ -0,0 +1,33 @@
+module Outreach
+  module Errors
+    UNAUTHORIZED_ID = 'unauthenticatedRequest'.freeze
+    class Unauthorized < StandardError; end
+
+    def check_for_error(_status_code, response_body)
+      response_hash = JSON.parse(response_body)
+      errors = []
+      if !response_hash['errors'].nil? && response_hash['errors'].any?
+        errors = response_hash['errors'].map { |error| create_error_hash(error) }
+      end
+
+      errors.map do |error|
+        case error[:id]
+        when UNAUTHORIZED_ID
+          raise Unauthorized, error[:detail]
+        else
+          raise StandardError, error[:title] + ': ' + error[:detail]
+        end
+      end
+    end
+
+    private
+
+    def create_error_hash(error)
+      {
+        id: error['id'],
+        title: error['title'],
+        detail: error['detail']
+      }
+    end
+  end
+end

data/lib/outreach-ruby/model.rb

@@ -0,0 +1,17 @@
+module Outreach
+  module Model
+    private
+
+    def to_ostruct(hash)
+      o = OpenStruct.new(hash)
+      hash.each.with_object(o) do |(k, v), o|
+        o.send(:"#{k}=", to_ostruct(v)) if v.is_a? Hash
+      end
+      o
+    end
+
+    def nested_hash_value(attrs, keys)
+      keys.reduce(attrs) { |m, k| m && m[k] }
+    end
+  end
+end

data/lib/outreach-ruby/prospect.rb

@@ -0,0 +1,41 @@
+require 'outreach-ruby/model'
+
+module Outreach
+  class Prospect
+    extend Outreach::Model
+
+    attr_accessor :id, :first_name, :last_name, :emails, :owner_id, :response
+
+    def initialize(attrs)
+      @id = attrs['id']
+      @first_name = attrs['first_name']
+      @last_name = attrs['last_name']
+      @emails = attrs['emails']
+      @owner_id = attrs['owner_id']
+      @response = attrs['response']
+    end
+
+    def self.build_from_attributes_hash(data)
+      result = {}
+      result['first_name'] = nested_hash_value(
+        data,
+        %w[attributes firstName]
+      )
+      result['last_name'] = nested_hash_value(
+        data,
+        %w[attributes lastName]
+      )
+      result['emails'] = nested_hash_value(
+        data,
+        %w[attributes emails]
+      )
+      result['id'] = data['id']
+      result['owner_id'] = nested_hash_value(
+        data,
+        %w[relationships owner data id]
+      )
+      result['response'] = data
+      new(result)
+    end
+  end
+end

data/lib/outreach-ruby/request.rb

@@ -0,0 +1,77 @@
+require 'httparty'
+require 'json'
+
+module Outreach
+  class Request
+    include HTTParty
+    include Errors
+
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    def get(url, query = {})
+      attrs = {
+        query: query, headers: auth_header
+      }
+      attrs[:debug_output] = $stdout if Outreach.debug
+      response = HTTParty.get(url, attrs)
+      parse_response(response)
+    end
+
+    def post(url, params)
+      response_format = params.delete(:response_format) || :json
+      attrs = {
+        body: params.to_json, headers: auth_header
+      }
+      attrs[:debug_output] = $stdout if Outreach.debug
+      response = HTTParty.post(url, attrs)
+      parse_response(response, response_format)
+    end
+
+    def patch(url, params)
+      response_format = params.delete(:response_format) || :json
+      attrs = {
+        body: params.to_json, headers: auth_header
+      }
+      attrs[:debug_output] = $stdout if Outreach.debug
+      response = HTTParty.patch(url, attrs)
+      parse_response(response, response_format)
+    end
+
+    def delete(url)
+      attrs = {
+        headers: auth_header
+      }
+      attrs[:debug_output] = $stdout if Outreach.debug
+      response = HTTParty.delete(url, attrs)
+      parse_response(response)
+    end
+
+    private
+
+    def parse_response(response, response_format = :json)
+      check_for_error(response.response.code, response.body)
+      display_debug(response.body)
+      if response_format == :json
+        JSON.parse(response.body.to_s)
+      else
+        response.body.to_s
+      end
+    end
+
+    def display_debug(response)
+      if Outreach.debug
+        puts '-' * 20 + ' DEBUG ' + '-' * 20
+        puts response
+        puts '-' * 18 + ' END DEBUG ' + '-' * 18
+      end
+    end
+
+    def auth_header
+      headers = { 'Content-Type' => 'application/json' }
+      headers['Authorization'] = "Bearer #{@access_token}" if @access_token
+      headers
+    end
+  end
+end

data/lib/outreach-ruby/sequence.rb

@@ -0,0 +1,26 @@
+require 'outreach-ruby/model'
+
+module Outreach
+  class Sequence
+    extend Outreach::Model
+
+    attr_accessor :id, :name, :response
+
+    def initialize(attrs)
+      @id = attrs['id']
+      @name = attrs['name']
+      @response = attrs['response']
+    end
+
+    def self.build_from_attributes_hash(data)
+      result = {}
+      result['id'] = data['id']
+      result['name'] = nested_hash_value(
+        data,
+        %w[attributes name]
+      )
+      result['response'] = data
+      new(result)
+    end
+  end
+end

data/lib/outreach-ruby/sequence_state.rb

@@ -0,0 +1,26 @@
+require 'outreach-ruby/model'
+
+module Outreach
+  class SequenceState
+    extend Outreach::Model
+
+    attr_accessor :id, :sequence_id, :response
+
+    def initialize(attrs)
+      @id = attrs['id']
+      @sequence_id = attrs['sequence_id']
+      @response = attrs['response']
+    end
+
+    def self.build_from_attributes_hash(data)
+      result = {}
+      result['id'] = data['id']
+      result['sequence_id'] = nested_hash_value(
+        data,
+        %w[relationships sequence data id]
+      )
+      result['response'] = data
+      new(result)
+    end
+  end
+end

data/lib/outreach-ruby/service/prospect.rb

@@ -0,0 +1,70 @@
+module Outreach
+  module Service
+    class Prospect
+      def initialize(client)
+        @request = client.request
+      end
+
+      def find(id)
+        response = @request.get("#{api_url}/#{id}")
+        collection_class.build_from_attributes_hash(response['data'])
+      end
+
+      def find_all(attrs = {})
+        response = @request.get(api_url, filter_attribute_mapping(attrs))
+        response['data'].map do |attrs|
+          collection_class.build_from_attributes_hash(attrs)
+        end
+      end
+
+      def update(id, attrs)
+        mapped_attrs = update_attribute_mapping(attrs)
+        @request.patch(api_url + '/' + id.to_s, mapped_attrs)
+      end
+
+      protected
+
+      def api_url
+        'https://api.outreach.io/api/v2/prospects?include=account,stage,sequenceStates&'
+      end
+
+      def collection_class
+        Outreach::Prospect
+      end
+
+      def filter_attribute_mapping(attrs)
+        if attrs[:first_name]
+          attrs['filter[lastName]'] = attrs.delete(:first_name)
+        end
+        if attrs[:last_name]
+          attrs['filter[firstName]'] = attrs.delete(:last_name)
+        end
+        attrs['filter[emails]'] = attrs.delete(:email) if attrs[:email]
+        attrs['filter[id]'] = attrs.delete(:id) if attrs[:id]
+        attrs
+      end
+
+      def update_attribute_mapping(attrs)
+        result = {
+          'data' => {
+            'attributes' => {
+              'personal' => {},
+              'contact' => {}
+            }
+          }
+        }
+
+        if attrs['first_name']
+          result['data']['attributes']['personal']['name']['first'] = attrs['first_name']
+        end
+        if attrs['last_name']
+          result['data']['attributes']['personal']['name']['last'] = attrs['last_name']
+        end
+        if attrs['email']
+          result['data']['attributes']['contact']['email'] = attrs['email']
+        end
+        result
+      end
+    end
+  end
+end

data/lib/outreach-ruby/service/sequence.rb

@@ -0,0 +1,24 @@
+module Outreach
+  module Service
+    class Sequence
+      def initialize(client)
+        @request = client.request
+      end
+
+      def find(id)
+        response = @request.get("#{api_url}/#{id}")
+        collection_class.build_from_attributes_hash(response['data'])
+      end
+
+      private
+
+      def api_url
+        'https://api.outreach.io/api/v2/sequences'
+      end
+
+      def collection_class
+        Outreach::Sequence
+      end
+    end
+  end
+end

data/lib/outreach-ruby/service/sequence_state.rb

@@ -0,0 +1,38 @@
+module Outreach
+  module Service
+    class SequenceState
+      def initialize(client)
+        @request = client.request
+      end
+
+      def find(id)
+        response = @request.get("#{api_url}/#{id}")
+        collection_class.build_from_attributes_hash(response['data'])
+      end
+
+      def find_all(attrs = {})
+        response = @request.get(api_url, filter_attribute_mapping(attrs))
+        response['data'].map do |attrs|
+          collection_class.build_from_attributes_hash(attrs)
+        end
+      end
+
+      private
+
+      def filter_attribute_mapping(attrs)
+        if attrs[:prospect_id]
+          attrs['filter[prospect][id]'] = attrs.delete(:prospect_id)
+        end
+        attrs
+      end
+
+      def api_url
+        'https://api.outreach.io/api/v2/sequenceStates'
+      end
+
+      def collection_class
+        Outreach::SequenceState
+      end
+    end
+  end
+end

data/lib/outreach-ruby/service/user.rb

@@ -0,0 +1,24 @@
+module Outreach
+  module Service
+    class User
+      def initialize(client)
+        @request = client.request
+      end
+
+      def find(id)
+        response = @request.get("#{api_url}/#{id}")
+        collection_class.build_from_attributes_hash(response['data'])
+      end
+
+      private
+
+      def api_url
+        'https://api.outreach.io/api/v2/users'
+      end
+
+      def collection_class
+        Outreach::User
+      end
+    end
+  end
+end

data/lib/outreach-ruby/user.rb

@@ -0,0 +1,36 @@
+require 'outreach-ruby/model'
+
+module Outreach
+  class User
+    extend Outreach::Model
+
+    attr_accessor :id, :first_name, :last_name, :email, :response
+
+    def initialize(attrs)
+      @id = attrs['id']
+      @first_name = attrs['first_name']
+      @last_name = attrs['last_name']
+      @email = attrs['email']
+      @response = attrs['response']
+    end
+
+    def self.build_from_attributes_hash(data)
+      result = {}
+      result['id'] = data['id']
+      result['first_name'] = nested_hash_value(
+        data,
+        %w[attributes firstName]
+      )
+      result['last_name'] = nested_hash_value(
+        data,
+        %w[attributes lastName]
+      )
+      result['email'] = nested_hash_value(
+        data,
+        %w[attributes email]
+      )
+      result['response'] = data
+      new(result)
+    end
+  end
+end

data/lib/outreach-ruby/version.rb

@@ -0,0 +1,3 @@
+module Outreach
+  VERSION = '0.0.2'.freeze
+end

data/outreach-ruby.gemspec

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outreach-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'outreach-ruby'
+  spec.version       = Outreach::VERSION
+  spec.authors       = ['Macgill Davis']
+  spec.email         = ['macgill@humbledot.com']
+
+  spec.summary       = 'outreach-ruby is a wrapper for the outreachruby.io REST API. This was modified off of https://github.com/thechrisoshow/outreach'
+  spec.license       = 'MIT'
+  spec.homepage      = 'http://github.com/humbledot/outreach-ruby'
+
+  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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+
+  spec.add_dependency 'httparty', '~> 0.16'
+  spec.add_dependency 'json', '>= 1.8', '< 3'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: outreach-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Macgill Davis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 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: '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: byebug
+  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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- macgill@humbledot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/outreach-ruby.rb
+- lib/outreach-ruby/authorization.rb
+- lib/outreach-ruby/client.rb
+- lib/outreach-ruby/errors.rb
+- lib/outreach-ruby/model.rb
+- lib/outreach-ruby/prospect.rb
+- lib/outreach-ruby/request.rb
+- lib/outreach-ruby/sequence.rb
+- lib/outreach-ruby/sequence_state.rb
+- lib/outreach-ruby/service/prospect.rb
+- lib/outreach-ruby/service/sequence.rb
+- lib/outreach-ruby/service/sequence_state.rb
+- lib/outreach-ruby/service/user.rb
+- lib/outreach-ruby/user.rb
+- lib/outreach-ruby/version.rb
+- outreach-ruby.gemspec
+homepage: http://github.com/humbledot/outreach-ruby
+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.8
+signing_key: 
+specification_version: 4
+summary: outreach-ruby is a wrapper for the outreachruby.io REST API. This was modified
+  off of https://github.com/thechrisoshow/outreach
+test_files: []