promoter 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95792b0b464ff9072200693024cf2cf5d115ef39
-  data.tar.gz: a5d4acfaaa3381413c4fe093167f35453c4df479
+  metadata.gz: 82b302c42afebc4958d965828131b4bd1ae7e226
+  data.tar.gz: 390dcdb37ac48a67c7c350ba766522333fc83900
 SHA512:
-  metadata.gz: 38f0998be10fee79e559bfa8303a52a155034e1e7a60eadfa8aaa20a08c544f3fd91cb1f972f475b0ac6b3f1bb18e2d9172e2309c60857515f0acc86f0141ed0
-  data.tar.gz: 8cde91e251abc021b76eb4c4e8d387cce2c16fa9bb42198db60e83db2d8a5766ba2c0f3a1fb0a1ddc672ebce7e09df01c4d4356bf87840bb4adc8a0255b2c2b1
+  metadata.gz: 4cb56545fbffca1530de00a8d1bde82d8ffce90093a4a8dcd9ff0b7b4f2c5077c7046ece2a78fa55ddf1a501ac21ebba1b80fe6e4627da37c8ce8e62bceb28c4
+  data.tar.gz: 7eb2ef3606aac16577343b596886a4fc4a264bdac31f68e66dc94b60bd459e2c82c6c73a4b1fdc562c19fccb6f754e8c9749ce30b5095a727421b1c379c15022

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,11 +1,13 @@
 # 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.
+promoter is a wrapper for the promoter.io REST API.
 
-TODO: Delete this and the text above, and describe your gem
+You can find the promoter.io api docs here: https://promoterio.github.io/api/
 
 ## Installation
 
+First off you need to grab your [promoter.io](http://www.promoter.io) api key.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,15 +22,99 @@ Or install it yourself as:
 
     $ gem install promoter
 
-## Usage
+Set your api key with:
+```ruby
+Promoter.api_key = 'YOUR API KEY'
+```
+(Put this into an initializer i.e. ```app/initializers/promoter.rb``` if using Rails.)
+
+## Feedback
+### Get all feedback
+
+```ruby
+Promoter::Feedback.all(score: 8) # => returns all feedback with a score of 8
+```
+
+Possible filters:
+  ```score```                    Filter by the score
+  ```score_type```               Filters by the score type: ```promoter```, ```detractor```, ```passive```
+  ```survey_campaign```          Filter by the campaign id
+  ```survey_campaign_status```   Filter by the campaign status: ```ACTIVE```, ```COMPLETE```
+
+### Get a specific feedback
+
+```ruby
+Promoter::Feedback.find(79) #=> id of the feedback to return
+```
+
+## Contacts
+
+### Get all contacts
+
+```ruby
+Promoter::Contact.all(2) # => this is paginated - returns page 2 of results
+```
+
+### Get a specific contact
+
+```ruby
+Promoter::Contact.find(897)
+```
+
+### Create a contact
+
+```ruby
+Promoter::Contact.create(email: "chris@lexoo.co.uk",    # required
+                         first_name: "Chris",           # optional
+                         last_name: "O'Sullivan",       # optional
+                         contact_list: [599],           # array of contact list ids to add to
+                         campaign: 78,                  # campaign which this belongs to
+                         attributes: { plan: 'silver' } # any extra data you want to add to the contact
+                         send: false )                  # set this to true to send the NPS immediately
+```
+
+## Campaigns
+### Get all campaigns
+
+```ruby
+Promoter::Campaign.all(2) # => this is paginated - returns page 2 of results
+```
 
-TODO: Write usage instructions here
+### Send surveys for a campaign
 
-## Development
+```ruby
+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!)
 
-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.
+## Contact lists
+### Get all contact lists
+
+```ruby
+Promoter::ContactList.all(2)  # => this is paginated - returns page 2 of results
+```
 
-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).
+### Get All Contacts for a Contact List
+
+```ruby
+Promoter::ContactList.contact_ids_for(2)  
+# => returns an array of contact ids for a contact list id
+```
+
+### Remove a contact from a contact list
+
+```ruby
+Promoter::ContactList.remove_contact(contact_list_id: 7899,
+                                     contact_id: 15777)  
+```
+
+## Metrics
+
+```ruby
+Promoter::Metric.all
+# => returns a list of interesting metrics that promoter has for your account
+```
 
 ## Contributing
 

data/lib/promoter/errors.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Promoter
   module Errors
     class BadRequest < StandardError; end

data/lib/promoter/feedback.rb

@@ -43,10 +43,6 @@ module Promoter
     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
 

data/lib/promoter/metric.rb

@@ -12,8 +12,8 @@ module Promoter
       @organization_nps = attrs["organization_nps"].to_f
     end
 
-    def self.all(page=1)
-      response = Request.get("#{API_URL}/?page=#{page}")
+    def self.all
+      response = Request.get("#{API_URL}/")
       response['results'].map {|attrs| new(attrs)}
     end
 

data/lib/promoter/version.rb

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

data/promoter.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "byebug"
 
   spec.add_dependency "httparty"
   spec.add_dependency "json"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !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