promoter 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d190bf6c1fe47dcbc6d1935ca875373b0eba137
-  data.tar.gz: b5035d75f42fae29d5b1cab59026716387b583b8
+  metadata.gz: 3a1c0b45c8ca3ac0de008c7aad0c01e050a386d1
+  data.tar.gz: a1637b87cd2389bfe042549e6525a86950d5417d
 SHA512:
-  metadata.gz: 7781f1f2faee907bdbe95e4d832de883d1cc7bc8f78984311d65295bab5c4ef66bd1039948dd0b98bfbfef8ae08f1676da30c337c0396a6ad7cfc062c07c7322
-  data.tar.gz: 541a11ab61ef98afcfc155297e098e0cc83e730cc8521851d3baf2226dc1c1db1b423418aef1c11988ad57b2f2deed5b78e17ace16426f56edf84345fd1e23a9
+  metadata.gz: b465beeb2d3020128bb14f7ec8e683033e64cd03b3bbfc192691250cf1de37293f0441307f23d57c745f840878f6beac9ad515ccc9fe831a291e35d07ccbd37b
+  data.tar.gz: f536e0537e28f960cf3f5922da8161af472d383ba211da846575d75f7a01eda1a2a3d37ea893367a77e7baf0a6bb1bc79ca9f0763142e0f7275494b235552f2c

data/README.md

@@ -33,6 +33,8 @@ Promoter.api_key = 'YOUR API KEY'
 
 ```ruby
 Promoter::Feedback.all(score: 8) # => returns all feedback with a score of 8
+# this is paginated. Pass page: 2 to get the second page
+# (I know, this is different from the other api calls! This will be fixed in later versions)
 ```
 
 Possible filters:
@@ -52,7 +54,12 @@ Promoter::Feedback.find(79) #=> id of the feedback to return
 ### Get all contacts
 
 ```ruby
-Promoter::Contact.all(2) # => this is paginated - returns page 2 of results
+Promoter::Contact.all(page: 2) # => this is paginated - returns page 2 of results
+```
+
+To find the a contact by an email pass in the ```email``` option:
+```ruby
+Promoter::Contact.all(email: "chris@lexoo.co.uk")
 ```
 
 ### Get a specific contact
@@ -101,7 +108,7 @@ Promoter::Campaign.create(name: "Campaign Name",    # required
 ### Get all campaigns
 
 ```ruby
-Promoter::Campaign.all(2) # => this is paginated - returns page 2 of results
+Promoter::Campaign.all(page: 2) # => this is paginated - returns page 2 of results
 ```
 
 ### Send surveys for a campaign

data/lib/promoter/campaign.rb

@@ -17,8 +17,20 @@ module Promoter
       @launch_date = Time.parse(attrs["launch_date"]) if attrs["launch_date"]
     end
 
-    def self.all(page=1)
-      response = Request.get("#{API_URL}/?page=#{page}")
+    # Parameter     Optional?  Description
+    # page	        yes	       Returns which page of results to return.
+    #                          Defaults to 1
+    def self.all(options={})
+      if !options.is_a?(Hash)
+        puts "-- DEPRECATION WARNING--"
+        puts "Passing in a number as a page is deprecated and will be removed from future versions of this gem.\nInstead pass in a hash of attributes.\n\n e.g. Promoter::Campaign.all(page: 2)"
+        query_string = "page=#{options}"
+      else
+        # default to first page
+        options[:page] ||= 1
+        query_string = URI.encode_www_form(options)
+      end
+      response = Request.get("#{API_URL}/?#{query_string}")
       response['results'].map {|attrs| new(attrs)}
     end
 
@@ -46,4 +58,4 @@ module Promoter
       new(response)
     end
   end
-end
+end

data/lib/promoter/contact.rb

@@ -19,8 +19,21 @@ module Promoter
       Contact.destroy(self.email)
     end
 
-    def self.all(page=1)
-      response = Request.get("#{API_URL}/?page=#{page}")
+    # Parameter     Optional?  Description
+    # page	        yes	       Returns which page of results to return.
+    #                          Defaults to 1
+    # email         yes        Filter the results by email address.
+    def self.all(options={})
+      if !options.is_a?(Hash)
+        puts "-- DEPRECATION WARNING--"
+        puts "Passing in a number as a page is deprecated and will be removed from future versions of this gem.\nInstead pass in a hash of attributes.\n\n e.g. Promoter::Contact.all(page: 2)"
+        query_string = "page=#{options}"
+      else
+        # default to first page
+        options[:page] ||= 1
+        query_string = URI.encode_www_form(options)
+      end
+      response = Request.get("#{API_URL}/?#{query_string}")
       response['results'].map {|attrs| new(attrs)}
     end
 

data/lib/promoter/request.rb

@@ -45,8 +45,8 @@ module Promoter
     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.")
+      if Promoter.api_key.nil?
+        raise Errors::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' }

data/lib/promoter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoter
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler