outreach 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72f658d033d57bbdbf06abb68f300d63f660260a
+  data.tar.gz: 698a2d0171428bb54be9e047761540ef44544b20
+SHA512:
+  metadata.gz: 2b3be014ee575b6e5f3f682171c8fd14f41ab74ddb7bd9e364fe29bbedb18b9c73ed4dc7c32e1a462df012cdcc4e6c7a0fcd8b933ad172d5dd54282dc49e0a61
+  data.tar.gz: 43918793ef5f573a5bae628231880f7db7a817644c743b4abe84f3085b48c3219c45411c54b28e91255af2343750a1c67014a6d8303cfaaee4ef77a1791b9fd5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris O'Sullivan
+
+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,116 @@
+# Outreach
+
+outreach is a wrapper for the outreach.io REST API.
+
+You can find the outreach.io api docs here: https://github.com/getoutreach/outreach-platform-sdk
+
+## Installation
+
+First off you need to grab your [outreach.io](https://www.outreach.io) api oauth keys. You can sign up for access [here](http://goo.gl/forms/RWk35DeZAK)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'outreach'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outrach
+
+Set your api access with:
+```ruby
+Outreach.application_identifier = 'YOUR APPLICATION IDENTIFIER'
+Outreach.application_secret = 'YOUR APPLICATION SECRET'
+Outreach.scopes = 'SCOPES FOR API ACCESS'
+Outreach.redirect_uri = 'YOUR REDIRECT URI UPON OAUTH'
+```
+(Put this into an initializer i.e. ```app/initializers/outreach.rb``` if using Rails.)
+
+## Authorization
+First off you need to grab the authorization key for your user. You do this by getting them to follow the authorization URL:
+```ruby
+  Outreach::Authorization.authorization_url
+```
+
+For example, if using Rails this could be in a view
+```
+  <%= link_to("Connect to Outreach", Outreach::Authorization.authorization_url)
+```
+
+This will take the user through the oauth process - afterwards they will be redirected back to your site to whatever the url you have setup in Outreach.redirect_uri.  This will also provide the authorization key so you can get access for that user using the Outreach::Authorization.create method.
+
+Here's a Rails example:
+
+```ruby
+class OutreachController < ApplicationController
+
+  def callback
+    user = current_user
+    user.auth_code = params[:code]
+
+    codes = Outreach::Authorization.create(params[:code])
+    user.access_code = codes.token
+    user.refresh_code = codes.refresh_token
+    user.save
+
+    flash[:notice] = "Outreach oauth connected"
+    redirect_to home_path
+  end
+end
+```
+
+The access code can expire, but this can be refreshed using the refresh token
+
+```ruby
+# after authorization exception
+codes = Outreach::Authorization.refresh(user.refresh_code)
+user.access_code = codes.token
+user.refresh_code = codes.refresh_token
+user.save
+```
+
+## API Client
+Once you have the access code for a user you can then create an api client for that user.
+```ruby
+  client = Outreach::Client.new(user.access_code)
+```
+
+## Prospects
+To find all prospects:
+```ruby
+  client.prospects.all
+  # returns an array of prospects
+```
+
+Filtering is possible by using the following conditions:
+```ruby
+  # first_name
+  # last_name
+  # email
+  # company_name
+  # e.g.
+  client.prospects.all({ first_name: "Chris", last_name: "O'Sullivan" })
+```
+
+The results of client.prospects.all is paginated. You can control pagination by passing in which page you want to see:
+```ruby
+  client.prospects.all({ page: 2 })
+```
+
+You can find a specific prospect given the prospect id:
+```ruby
+  clients.prospect.find(2345)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/outreach/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/outreach/authorization.rb

@@ -0,0 +1,50 @@
+require 'uri'
+
+module Outreach
+  class Authorization
+    API_URL =  "https://api.outreach.io/oauth/token"
+
+    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 = 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/client.rb

@@ -0,0 +1,17 @@
+module Outreach
+  class Client
+    def initialize(api_token)
+      @api_token = api_token
+    end
+
+    def prospect
+      Outreach::ProspectFinder.new(request)
+    end
+
+    private
+
+    def request
+      Request.new(@api_token)
+    end
+  end
+end

data/lib/outreach/errors.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Outreach
+  module Errors
+    class Unauthorized < StandardError; end
+
+    def check_for_error(status_code)
+      # raise error if status code isn't 200
+      case status_code.to_i
+      when 401
+        raise Unauthorized.new("Authorization failed")
+      end
+    end
+  end
+end

data/lib/outreach/prospect.rb

@@ -0,0 +1,58 @@
+module Outreach
+  class Prospect
+    attr_accessor :first_name, :last_name, :company, :contact, :tags
+
+    def initialize(attrs)
+      @first_name = attrs['attributes']['personal']['name']['first']
+      @last_name = attrs['attributes']['personal']['name']['last']
+      @company = to_ostruct(attrs['attributes']['company'])
+      @contact = to_ostruct(attrs['attributes']['contact'])
+      @tags = attrs['attributes']['metadata']['tags']
+    end
+
+    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
+  end
+
+  class ProspectFinder
+    API_URL =  "https://api.outreach.io/1.0/prospects"
+
+    def initialize(request)
+      @request = request
+    end
+
+    def find(id)
+      response = @request.get("#{API_URL}/#{id}")
+      Prospect.new(response)
+    end
+
+    def all(attrs={})
+      response = @request.get(API_URL, attribute_mapping(attrs))
+      response['data'].map {|attrs| Prospect.new(attrs)}
+    end
+
+    private
+
+    def attribute_mapping(attrs)
+      if attrs[:first_name]
+        attrs["filter[personal/name/first]"] = attrs.delete(:first_name)
+      end
+      if attrs[:last_name]
+        attrs["filter[personal/name/last]"] = attrs.delete(:last_name)
+      end
+      attrs["filter[contact/email]"] = attrs.delete(:email) if attrs[:email]
+      if attrs[:company_name]
+        attrs["filter[company/name]"] = attrs.delete(company_name)
+      end
+      attrs
+    end
+  end
+end
+

data/lib/outreach/request.rb

@@ -0,0 +1,57 @@
+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={})
+      response = HTTParty.get(url, query: query, headers: auth_header)
+      parse_response(response)
+    end
+
+    def post(url, params)
+      response_format = params.delete(:response_format) || :json
+      response = HTTParty.post(url, body: params.to_json, headers: auth_header)
+      parse_response(response, response_format)
+    end
+
+    def delete(url)
+      response = HTTParty.delete(url, headers: auth_header)
+      parse_response(response)
+    end
+
+    private
+
+    def parse_response(response, response_format=:json)
+      check_for_error(response.response.code)
+      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/version.rb

@@ -0,0 +1,3 @@
+module Outreach
+  VERSION = "0.0.1"
+end

data/lib/outreach.rb

@@ -0,0 +1,16 @@
+require "outreach/version"
+require "outreach/errors"
+require "outreach/request"
+require "outreach/authorization"
+require "outreach/client"
+require "outreach/prospect"
+
+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/outreach.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outreach/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "outreach"
+  spec.version       = Outreach::VERSION
+  spec.authors       = ["Chris O'Sullivan"]
+  spec.email         = ["thechrisoshow@gmail.com"]
+
+  spec.summary       = %q{outreach is a wrapper for the outreach.io REST API}
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "webmock", "~> 1.24"
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "json", "~> 1.8"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: outreach
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris O'Sullivan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- thechrisoshow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/outreach.rb
+- lib/outreach/authorization.rb
+- lib/outreach/client.rb
+- lib/outreach/errors.rb
+- lib/outreach/prospect.rb
+- lib/outreach/request.rb
+- lib/outreach/version.rb
+- outreach.gemspec
+homepage: 
+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: outreach is a wrapper for the outreach.io REST API
+test_files: []
+has_rdoc: