promoter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95792b0b464ff9072200693024cf2cf5d115ef39
+  data.tar.gz: a5d4acfaaa3381413c4fe093167f35453c4df479
+SHA512:
+  metadata.gz: 38f0998be10fee79e559bfa8303a52a155034e1e7a60eadfa8aaa20a08c544f3fd91cb1f972f475b0ac6b3f1bb18e2d9172e2309c60857515f0acc86f0141ed0
+  data.tar.gz: 8cde91e251abc021b76eb4c4e8d387cce2c16fa9bb42198db60e83db2d8a5766ba2c0f3a1fb0a1ddc672ebce7e09df01c4d4356bf87840bb4adc8a0255b2c2b1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in promoter.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,39 @@
+# Promoter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/promoter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'promoter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install promoter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/promoter/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/promoter.rb

@@ -0,0 +1,15 @@
+require "promoter/version"
+require "promoter/errors"
+require "promoter/request"
+require "promoter/campaign"
+require "promoter/contact"
+require "promoter/contact_list"
+require "promoter/feedback"
+require "promoter/metric"
+
+module Promoter
+  class << self
+    attr_accessor :api_key
+    attr_accessor :debug
+  end
+end

data/lib/promoter/campaign.rb

@@ -0,0 +1,39 @@
+module Promoter
+
+  class Campaign
+
+    API_URL =  "https://app.promoter.io/api/campaigns"
+
+    attr_reader :id, :name, :drip_duration, :contact_count, :eligible_count,
+                :last_surveyed_date, :launch_date
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @name = attrs["name"]
+      @drip_duration = attrs["drip_duration"]
+      @contact_count = attrs["all_count"]
+      @eligible_count = attrs["eligible_count"]
+      @last_surveyed_date = Time.parse(attrs["last_surveyed_date"]) if attrs["last_surveyed_date"]
+      @launch_date = Time.parse(attrs["launch_date"]) if attrs["launch_date"]
+    end
+
+    def self.all(page=1)
+      response = Request.get("#{API_URL}/?page=#{page}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+    # Parameter     Optional?  Description
+    # all_contacts	yes	       Can be set to true,false
+    #                          If set to true, the call will send surveys to all
+    #                          contacts in your specified contact list.
+    #                          If set to false, the call will send surveys to
+    #                          contacts who have been added or updated since you
+    #                          last sent surveys. The default behavior is when
+    #                          all_contacts is set to false.
+    def self.send_surveys(campaign_id, all_contacts=false)
+      response = Request.post("#{API_URL}/#{campaign_id}/send-surveys/",
+                              { all_contacts: all_contacts, response_format: :plain })
+      response.match /Success\, surveys sent\./
+    end
+  end
+end

data/lib/promoter/contact.rb

@@ -0,0 +1,53 @@
+module Promoter
+
+  class Contact
+
+    attr_reader :id, :email, :first_name, :last_name, :created_date, :attributes
+
+    API_URL =  "https://app.promoter.io/api/contacts"
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @email = attrs["email"]
+      @first_name = attrs["first_name"]
+      @last_name = attrs["last_name"]
+      @created_date = Time.parse(attrs["created_date"]) if attrs["created_date"]
+      @attributes = attrs["attributes"]
+    end
+
+    def self.all(page=1)
+      response = Request.get("#{API_URL}/?page=#{page}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+    def self.find(id)
+      response = Request.get("#{API_URL}/#{id}")
+      new(response)
+    end
+
+    # Contact Params
+    # Parameter     Optional?  Description
+    # email         no	       The email of the contact to add to the organization.
+    # first_name	  yes	       The first name of the contact to add to the organization.
+    # last_name	    yes	       The last name of the contact to add to the organization.
+    # contact_list	yes	       A list of Contact List Id’s to associate a contact to.
+    #                          If one is not provided the contact will be
+    #                          associated to a default generated contact list.
+    # attributes	  yes	       A dictionary of key value pairs of custom
+    #                          attributes that will be associated with the
+    #                          contact and contact list.
+    # send	        yes	       A boolean value set to true in order to express
+    #                          intent to survey this contact for a given campaign.
+    # campaign	    yes	       The campaign id you would like to associate the
+    #                          contact to. Note: Campaign must have a contact
+    #                          list associated to it in order for the contact to
+    #                          be added correctly. Otherwise, the contact will
+    #                          be associated to a default generated contact list
+    #                          for your given organization.
+    def self.create(attributes)
+      response = Request.post(API_URL + "/", attributes)
+      new(response)
+    end
+
+  end
+end

data/lib/promoter/contact_list.rb

@@ -0,0 +1,31 @@
+module Promoter
+
+  class ContactList
+
+    attr_reader :id, :name
+
+    API_URL =  "https://app.promoter.io/api/lists"
+
+    def initialize(attrs)
+      @id = attrs['id']
+      @name = attrs['name']
+    end
+
+    def self.all(page=1)
+      response = Request.get("#{API_URL}/?page=#{page}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+    def self.contact_ids_for(contact_list_id)
+      response = Request.get("#{API_URL}/#{contact_list_id}/contacts")
+      response['results'].map {|attrs| attrs["id"]}
+    end
+
+    def self.remove_contact(params={})
+      contact_list_id = params[:contact_list_id]
+      contact_id = params[:contact_id]
+      Request.delete("#{API_URL}/#{contact_list_id}/contacts/#{contact_id}")
+    end
+
+  end
+end

data/lib/promoter/errors.rb

@@ -0,0 +1,50 @@
+module Promoter
+  module Errors
+    class BadRequest < StandardError; end
+    class Unauthorized < StandardError; end
+    class Forbidden < StandardError; end
+    class NotFound < StandardError; end
+    class MethodNotAllowed < StandardError; end
+    class NotAcceptable < StandardError; end
+    class Gone < StandardError; end
+    class TooManyRequests < StandardError; end
+    class InternalServerError < StandardError; end
+    class ServiceUnavailable < StandardError; end
+
+    # Error Code	Meaning
+    # 400	Bad Request – Something is wrong with your request
+    # 401	Unauthorized – Your API key is incorrect or invalid
+    # 403	Forbidden – The resource requested is hidden for administrators only
+    # 404	Not Found – The specified resource could not be found
+    # 405	Method Not Allowed – You tried to access a resource with an invalid method
+    # 406	Not Acceptable – You requested a format that isn’t json
+    # 410	Gone – The resource requested has been removed from our servers
+    # 429	Too Many Requests – You’re requesting too much! Slown down!
+    # 500	Internal Server Error – We had a problem with our server. Try again later.
+    # 503	Service Unavailable – We’re temporarially offline for maintanance. Please try again later.
+    def check_for_error(status_code)
+      case status_code.to_i
+      when 400
+        raise BadRequest.new("Something is wrong with your request")
+      when 401
+        raise Unauthorized.new("Your API key is incorrect or invalid")
+      when 403
+        raise Forbidden.new("The resource requested is hidden for administrators only")
+      when 404
+        raise NotFound.new("The specified resource could not be found")
+      when 405
+        raise MethodNotAllowed.new("You tried to access a resource with an invalid method")
+      when 406
+        raise NotAcceptable.new("You requested a format that isn’t json")
+      when 410
+        raise Gone.new("The resource requested has been removed from our servers")
+      when 429
+        raise TooManyRequests.new("You’re requesting too much! Slown down!")
+      when 500
+        raise InternalServerError.new("We had a problem with our server. Try again later.")
+      when 503
+        raise ServiceUnavailable.new("We’re temporarially offline for maintanance. Please try again later.")
+      end
+    end
+  end
+end

data/lib/promoter/feedback.rb

@@ -0,0 +1,54 @@
+module Promoter
+
+  class Feedback
+
+    attr_reader :id, :contact, :score, :score_type, :posted_date, :comment, :follow_up_url, :url
+
+    API_URL =  "https://app.promoter.io/api/feedback"
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @contact = Contact.new(attrs["contact"])
+      @score = attrs["score"]
+      @score_type = attrs["score_type"]
+      @posted_date = Time.parse(attrs["posted_date"])
+      @comment = attrs["comment"]
+      @follow_up_url = attrs["followup_href"]
+      @follow_up_href = attrs["href"]
+    end
+
+    # Parameter                 Required Description
+    # score	                    false    Filtering by score can be achieved with
+    #                                    a range 0-10
+    # score_type	              false	   Filtering by score type can be achieved
+    #                                    with a list of values promoter,
+    #                                    detractor, passive
+    # survey__campaign	        false	   Filtering by campaign can be achieved
+    #                                    by the given id of your campaign id
+    # survey__campaign__status	false	   Filtering by campaign status can be
+    #                                    achieved by providing one of the
+    #                                    campaign status values: ACTIVE, COMPLETE.
+    # NOTE: This url parameter does not require quotes around the value.
+    # e.g. (<api-url>?survey__campaign__status=ACTIVE)
+    def self.all(attrs={})
+      response = Request.get("#{API_URL}/?#{query_string(attrs)}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+    def self.find(id)
+      response = Request.get("#{API_URL}/#{id}")
+      new(response)
+    end
+
+    private
+
+    def self.query_string(attrs)
+      # campaign_id is preferable to survey_campaign (which is what promoter expects)
+      if attrs.has_key?(:campaign_id)
+        attrs[:survey_campaign] = attrs.delete(:campaign_id)
+      end
+      URI.encode_www_form(attrs)
+    end
+
+  end
+end

data/lib/promoter/metric.rb

@@ -0,0 +1,21 @@
+module Promoter
+
+  class Metric
+
+    attr_accessor :campaign_name, :nps, :organization_nps
+
+    API_URL = "https://app.promoter.io/api/metrics"
+
+    def initialize(attrs)
+      @campaign_name = attrs["campaign"]
+      @nps = attrs["nps"].to_f
+      @organization_nps = attrs["organization_nps"].to_f
+    end
+
+    def self.all(page=1)
+      response = Request.get("#{API_URL}/?page=#{page}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+  end
+end

data/lib/promoter/request.rb

@@ -0,0 +1,57 @@
+require 'httparty'
+require 'json'
+
+module Promoter
+
+  class Request
+
+    include HTTParty
+    extend Errors
+
+    def self.get(url)
+      response = HTTParty.get(url, headers: auth_header)
+      parse_response(response)
+    end
+
+    def self.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 self.delete(url)
+      response = HTTParty.delete(url, headers: auth_header)
+      parse_response(response)
+    end
+
+    private
+
+    def self.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 self.display_debug(response)
+      if Promoter.debug
+        puts "-" * 20 + " DEBUG " + "-" * 20
+        puts response
+        puts "-" * 18 + " END DEBUG " + "-" * 18
+      end
+    end
+
+    def self.auth_header
+      if Promoter.api_key.empty?
+        raise Unauthorized.new("You need to set your promoter api key. You can register for a Promoter API key with a Promoter.io Account.")
+      end
+      { "Authorization" => "Token #{Promoter.api_key}",
+        'Content-Type' => 'application/json' }
+    end
+
+  end
+
+end

data/lib/promoter/version.rb

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

data/promoter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'promoter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "promoter"
+  spec.version       = Promoter::VERSION
+  spec.authors       = ["Chris O'Sullivan"]
+  spec.email         = ["thechrisoshow@gmail.com"]
+
+  spec.summary       = %q{promoter is a wrapper for the promoter.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"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: promoter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris O'Sullivan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-30 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: 
+email:
+- thechrisoshow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/promoter.rb
+- lib/promoter/campaign.rb
+- lib/promoter/contact.rb
+- lib/promoter/contact_list.rb
+- lib/promoter/errors.rb
+- lib/promoter/feedback.rb
+- lib/promoter/metric.rb
+- lib/promoter/request.rb
+- lib/promoter/version.rb
+- promoter.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.4.8
+signing_key: 
+specification_version: 4
+summary: promoter is a wrapper for the promoter.io REST API
+test_files: []