delighted 1.0.0 → 1.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbd30413c6cbb1ddf012ba06c1e4360d14f4713e
-  data.tar.gz: c936317dfc07e80425b559384aeef161c98ea364
+  metadata.gz: 6a734458d846278f7d93ca179a4e6adda072a68b
+  data.tar.gz: bbd3579c8ee5de44970a7d95e68fcd9f6e529ee4
 SHA512:
-  metadata.gz: d2318fd1929ee0e18781c50a98758af693fffa390b39511aa7a6522cb50df751de823d418c541ecd06f09c1a648a1c3aae714aa155a91c028db4bf0289f264ad
-  data.tar.gz: 7980888bf830ed0777ff63d6bc56a7a304caa7a9c2028792ba1c2b2c9edbf06792f7540b99893975d7673f08e901d97058fb298758e58c5f298ba96544a4a89d
+  metadata.gz: 03576120d48a582bfaf41a3bbbdfa188a619a5985fc03b9fcb86209d43ea5cc36badd39167b3f501a6fb042b76bc241215535be683cd81b895238862fab6eb65
+  data.tar.gz: 161a69baca6102cb630acd1bc45524a47cf35ac41b800ee6a608455d2e3e9cba5f2b3792a29d05edbec081486ca4ffb19d0b7046ef247fb85931fd836da9f4ea

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.1.0.rc1 (2014-01-12)
+
+Features:
+
+- Add support for cancelling pending survey requests
+
+## 1.0.0 (2013-12-13)

data/USAGE.md

@@ -30,7 +30,7 @@ person2 = Delighted::Person.create(:email => "foo+testing2@delightedapp.com", :d
 person3 = Delighted::Person.create(:email => "foo+testing3@delightedapp.com", :send => false)
 
 # Add a new person with full set of attributes, including a custom question product name,
-# and schedule a survey 30 seconds
+# and schedule a survey with a 30 second delay
 person4 = Delighted::Person.create(:email => "foo+testing4@delightedapp.com", :name => "Joe Bloggs",
   :properties => { :customer_id => 123, :country => "USA", :question_product_name => "Apple Genius Bar" },
   :delay => 30)
@@ -40,6 +40,13 @@ updated_person1 = Delighted::Person.create(:email => "foo+testing1@delightedapp.
   :name => "James Scott", :send => false)
 ```
 
+### Deleting pending survey requests
+
+```ruby
+# Delete all pending (scheduled but unsent) survey requests for a person, by email.
+Delighted::SurveyRequest.delete_pending(:email => "foo+testing1@delightedapp.com")
+```
+
 ### Adding survey responses
 
 ```ruby
@@ -93,7 +100,7 @@ client = Delighted::Client.new(:api_key => 'API_KEY',
 metrics_from_custom_client = Delighted::Metrics.retrieve({}, client)
 
 # Or, you can set Delighted.shared_client yourself
-Delighed.shared_client = Delighted::Client.new(:api_key => 'API_KEY',
+Delighted.shared_client = Delighted::Client.new(:api_key => 'API_KEY',
   :api_base_url => 'https://api.delightedapp.com/v1', :http_adapter => Delighted::HTTPAdapter.new)
 metrics_from_custom_shared_client = Delighted::Metrics.retrieve
 ```

data/lib/delighted.rb

@@ -17,7 +17,8 @@ require 'delighted/operations/retrieve'
 
 require 'delighted/resources/metrics'
 require 'delighted/resources/person'
-require 'delighted/resources/survey_responses'
+require 'delighted/resources/survey_request'
+require 'delighted/resources/survey_response'
 
 require 'delighted/errors'
 require 'delighted/http_response'

data/lib/delighted/client.rb

@@ -29,6 +29,16 @@ module Delighted
       handle_json_response(response)
     end
 
+    def delete_json(path, params = {})
+      headers = default_headers.dup.merge('Accept' => 'application/json', 'Content-Type' => 'application/json')
+
+      uri = URI.parse(File.join(@api_base_url, path))
+      data = JSON.dump(params) unless params.empty?
+
+      response = @http_adapter.request(:delete, uri, headers, data)
+      handle_json_response(response)
+    end
+
     private
 
     def handle_json_response(response)

data/lib/delighted/http_adapter.rb

@@ -3,6 +3,7 @@ module Delighted
     REQUEST_CLASSES = {
       :get => Net::HTTP::Get,
       :post => Net::HTTP::Post,
+      :delete => Net::HTTP::Delete
     }
 
     def request(method, uri, headers = {}, data = nil)

data/lib/delighted/resources/survey_request.rb

@@ -0,0 +1,13 @@
+module Delighted
+  class SurveyRequest < Resource
+    self.path = "/people/{PERSON_EMAIL}/survey_requests"
+
+    def self.delete_pending(attributes = {}, client = Delighted.shared_client)
+      raise ArgumentError, "You must pass :person_email" unless attributes[:person_email]
+      interpolated_path = path.sub("{PERSON_EMAIL}", CGI.escape(attributes[:person_email]))
+      interpolated_path << "/pending"
+      json = client.delete_json(interpolated_path)
+      json
+    end
+  end
+end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.0.0"
+  VERSION = "1.1.0.rc1"
 end

data/test/delighted_test.rb

@@ -36,6 +36,17 @@ class Delighted::PeopleTest < Delighted::TestCase
     assert_equal 'foo@bar.com', person.email
     assert_equal '123', person.id
   end
+
+  def test_deleting_pending_survey_requests_for_a_person
+    uri = URI.parse("https://api.delightedapp.com/v1/people/foo%40bar.com/survey_requests/pending")
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :ok => true }))
+    mock_http_adapter.expects(:request).with(:delete, uri, headers, nil).once.returns(response)
+
+    result = Delighted::SurveyRequest.delete_pending(:person_email => "foo@bar.com")
+    assert_kind_of Hash, result
+    assert_equal({ :ok => true }, result)
+  end
 end
 
 class Delighted::SurveyResponseTest < Delighted::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -94,7 +95,8 @@ files:
 - lib/delighted/resource.rb
 - lib/delighted/resources/metrics.rb
 - lib/delighted/resources/person.rb
-- lib/delighted/resources/survey_responses.rb
+- lib/delighted/resources/survey_request.rb
+- lib/delighted/resources/survey_response.rb
 - lib/delighted/utils.rb
 - lib/delighted/version.rb
 - test/delighted_test.rb
@@ -114,12 +116,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Delighted is the easiest and most beautiful way to measure customer happiness.