promoter 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b302c42afebc4958d965828131b4bd1ae7e226
-  data.tar.gz: 390dcdb37ac48a67c7c350ba766522333fc83900
+  metadata.gz: 6d190bf6c1fe47dcbc6d1935ca875373b0eba137
+  data.tar.gz: b5035d75f42fae29d5b1cab59026716387b583b8
 SHA512:
-  metadata.gz: 4cb56545fbffca1530de00a8d1bde82d8ffce90093a4a8dcd9ff0b7b4f2c5077c7046ece2a78fa55ddf1a501ac21ebba1b80fe6e4627da37c8ce8e62bceb28c4
-  data.tar.gz: 7eb2ef3606aac16577343b596886a4fc4a264bdac31f68e66dc94b60bd459e2c82c6c73a4b1fdc562c19fccb6f754e8c9749ce30b5095a727421b1c379c15022
+  metadata.gz: 7781f1f2faee907bdbe95e4d832de883d1cc7bc8f78984311d65295bab5c4ef66bd1039948dd0b98bfbfef8ae08f1676da30c337c0396a6ad7cfc062c07c7322
+  data.tar.gz: 541a11ab61ef98afcfc155297e098e0cc83e730cc8521851d3baf2226dc1c1db1b423418aef1c11988ad57b2f2deed5b78e17ace16426f56edf84345fd1e23a9

data/README.md

@@ -2,7 +2,7 @@
 
 promoter is a wrapper for the promoter.io REST API.
 
-You can find the promoter.io api docs here: https://promoterio.github.io/api/
+You can find the promoter.io api docs here: http://docs.promoter.apiary.io/
 
 ## Installation
 
@@ -73,7 +73,31 @@ Promoter::Contact.create(email: "chris@lexoo.co.uk",    # required
                          send: false )                  # set this to true to send the NPS immediately
 ```
 
+### Remove a contact
+
+```ruby
+Promoter::Contact.destroy("chris@lexoo.co.uk")
+```
+
+### Survey a contact
+
+```ruby
+Promoter::Contact.survey(email: "chris@lexoo.co.uk",    # required
+                         first_name: "Chris",           # optional
+                         last_name: "O'Sullivan",       # optional
+                         campaign: 78,                  # campaign which this belongs to
+                         attributes: { plan: 'silver' })# any extra data you want to add to the contact
+```
+
 ## Campaigns
+### Create a campaign
+
+```ruby
+Promoter::Campaign.create(name: "Campaign Name",    # required
+                          contact_list: 1,          # required
+                          email: 1)                 # required
+```
+
 ### Get all campaigns
 
 ```ruby
@@ -89,6 +113,12 @@ Promoter::Campaign.send_surveys(33, false)
 This takes two parameters, the campaign id, and a boolean as to send out surveys to ALL of the customers for the campaign. (This is defaulted to false!)
 
 ## Contact lists
+### Create a contact list
+
+```ruby
+Promoter::ContactList.create(name: "List Name")    # required
+```
+
 ### Get all contact lists
 
 ```ruby
@@ -109,6 +139,39 @@ Promoter::ContactList.remove_contact(contact_list_id: 7899,
                                      contact_id: 15777)  
 ```
 
+### Remove a contact from a contact list by email
+
+```ruby
+Promoter::ContactList.remove_contact(email: "me@me.com",
+                                     contact_id: 15777)  
+```
+
+### Remove a contact from all contact lists
+
+```ruby
+Promoter::ContactList.remove_contact(contact_id: 15777)  
+```
+
+## Email Templates
+### Create an email template
+
+```ruby
+Promoter::EmailTemplate.create(name: "Campaign Name", # required
+               subject: "Email Name",                 # required
+               logo: "<base64EncodedImageData>",      # required
+               reply_to_email: "me@me.com",           # required
+               from_name: "Name",                     # required
+               intro_message: "Message",              # required
+               language: "en",                        # required
+               company_brand_product_name: "name")    # required
+```
+
+### Get all email templates
+
+```ruby
+Promoter::EmailTemplate.all # => returns all results
+```
+
 ## Metrics
 
 ```ruby

data/lib/promoter.rb

@@ -2,6 +2,7 @@ require "promoter/version"
 require "promoter/errors"
 require "promoter/request"
 require "promoter/campaign"
+require "promoter/email_template"
 require "promoter/contact"
 require "promoter/contact_list"
 require "promoter/feedback"

data/lib/promoter/campaign.rb

@@ -35,5 +35,15 @@ module Promoter
                               { all_contacts: all_contacts, response_format: :plain })
       response.match /Success\, surveys sent\./
     end
+
+    # Campaign Params
+    # Parameter                   Optional?  Description
+    # name                        no         The name of the campaign
+    # contact_list                no         The id of the contact list to associate to this campaign. The contact list will contain a list of contacts you will survey.
+    # email                       no         The id of the email template you will use to survey your contacts in the contact list.
+    def self.create(attributes)
+      response = Request.post(API_URL + "/", attributes)
+      new(response)
+    end
   end
 end

data/lib/promoter/contact.rb

@@ -15,6 +15,10 @@ module Promoter
       @attributes = attrs["attributes"]
     end
 
+    def destroy
+      Contact.destroy(self.email)
+    end
+
     def self.all(page=1)
       response = Request.get("#{API_URL}/?page=#{page}")
       response['results'].map {|attrs| new(attrs)}
@@ -25,6 +29,14 @@ module Promoter
       new(response)
     end
 
+    def self.destroy(email)
+      attributes = {
+        email: email
+      }
+      response = Request.post("#{API_URL}/remove/", attributes)
+      new(response)
+    end
+
     # Contact Params
     # Parameter     Optional?  Description
     # email         no	       The email of the contact to add to the organization.
@@ -49,5 +61,10 @@ module Promoter
       new(response)
     end
 
+    def self.survey(attributes)
+      response = Request.post(API_URL + "/survey/", attributes)
+      new(response)
+    end
+
   end
 end

data/lib/promoter/contact_list.rb

@@ -24,7 +24,29 @@ module Promoter
     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}")
+      contact_email = params[:email]
+
+      if contact_list_id
+        if contact_id
+          Request.delete("#{API_URL}/#{contact_list_id}/contacts/#{contact_id}")
+        elsif contact_email
+          Request.post("#{API_URL}/#{contact_list_id}/remove/", {email: contact_email})
+        else
+          raise "Not enough information provided to remove a contact"
+        end
+      elsif contact_email
+          Request.post("#{API_URL}/remove/", {email: contact_email})
+      else
+        raise "Not enough information provided to remove a contact"
+      end
+    end
+
+    # Campaign Params
+    # Parameter                   Optional?  Description
+    # name                        no         The name of the campaign
+    def self.create(attributes)
+      response = Request.post(API_URL + "/", attributes)
+      new(response)
     end
 
   end

data/lib/promoter/email_template.rb

@@ -0,0 +1,47 @@
+module Promoter
+
+  class EmailTemplate
+
+    API_URL =  "https://app.promoter.io/api/email"
+
+    attr_reader :id, :name, :logo, :subject, :reply_to_email, :from_name,
+                :intro_message, :language, :company_brand_product_name
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @name = attrs["name"]
+      @logo = attrs["logo"]
+      @subject = attrs["subject"]
+      @reply_to_email = attrs["reply_to_email"]
+      @from_name = attrs["from_name"]
+      @intro_message = attrs["intro_message"]
+      @language = attrs["language"]
+      @company_brand_product_name = attrs["company_brand_product_name"]
+    end
+
+    def self.all(page=1)
+      response = Request.get("#{API_URL}/?page=#{page}")
+      response['results'].map {|attrs| new(attrs)}
+    end
+
+    # Email Template Params
+    # Parameter                   Optional?  Description
+    # name                        no         The name of the email template
+    # subject                     no         The subject line of the email template
+    # logo                        no         Base64 encoded image data (only) representing
+    #                                        the logo with your survey. It is also the logo 
+    #                                        they see when they respond to the survey with a score. 
+    #                                        The logo will be located at the top of the survey
+    # reply_to_email              no         The reply-to email address for the email template
+    # from_name                   no         The name the template is showing to be from
+    # intro_message               no         This is the message that appears just above 
+    #                                        the 0-10 scale and below the logo
+    # language                    no         The language the template is in
+    # company_brand_product_name  no         The name inserted into the main question
+    def self.create(attributes)
+      response = Request.post(API_URL + "/", attributes)
+      new(response)
+    end
+
+  end
+end

data/lib/promoter/version.rb

@@ -1,3 +1,3 @@
 module Promoter
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2016-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - lib/promoter/campaign.rb
 - lib/promoter/contact.rb
 - lib/promoter/contact_list.rb
+- lib/promoter/email_template.rb
 - lib/promoter/errors.rb
 - lib/promoter/feedback.rb
 - lib/promoter/metric.rb
@@ -138,8 +139,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: promoter is a wrapper for the promoter.io REST API
 test_files: []
+has_rdoc: