delighted 1.7.0 → 1.8.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 24e928b7535e1d51f72461238850e824b27b3920
-  data.tar.gz: 86001bae9ecc475902d0ce5f2d4ed1cc15d6f686
+SHA256:
+  metadata.gz: 92ff2bf5264a02443144522c7aa937d879d285414b2f27d5da9a149d8523b851
+  data.tar.gz: 0671a5ab613fdf6824dd86527d9fd0592eee37d0f53052a5e1e2b24b55ba3eae
 SHA512:
-  metadata.gz: 1c62db83772abc00c2a6c1524c8a18f998b953ca227d8f521eaf2a3cb10e7457b078eac3d8d8473668e83c646e8f515a32700435fbc7a59edf715585f87e4eb7
-  data.tar.gz: 0cfa475365360aa17f5e7b81c215e07607eed6d10f867ba5269ef840c62aa88ca032944d613d11d7159b224593cbf0e2b67282aa1da5acdcad9621a7a99904fe
+  metadata.gz: 8ec727249f7682b0c3bf66fb0bfd921f456a013e775d4f206d98e61fb35807312c6329e105acb9f5ef8c7276839a47c67829e7e7b2626bd0e9a4e3d91d6d8d6d
+  data.tar.gz: 9914a4c08a10787c4da9a94d6a7208bc5345cf513535a36945442596a6d0967372a2c1a216b0028e88ee888b06e286c72325fa54c162d9ca7ca4389e486bc861

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.8.0rc1 (2018-05-22)
+
+Features:
+
+- Add `Delighted::Person.delete`
+
 ## 1.7.0 (2017-10-18)
 
 Features:

data/README.md

@@ -72,6 +72,17 @@ survey_responses_page1 = Delighted::Bounce.all
 survey_responses_page2 = Delighted::Bounce.all(:page => 2)
 ```
 
+Deleting a person and all of the data associated with them:
+
+```ruby
+# Delete by person id
+Delighted::Person.delete(:id => 42)
+# Delete by email address
+Delighted::Person.delete(:email => "test@example.com")
+# Delete by phone number (must be E.164 format)
+Delighted::Person.delete(:phone_number => "+14155551212")
+```
+
 Deleting pending survey requests
 
 ```ruby

data/lib/delighted.rb

@@ -15,6 +15,7 @@ require 'delighted/operations/all'
 require 'delighted/operations/create'
 require 'delighted/operations/retrieve'
 require 'delighted/operations/update'
+require 'delighted/operations/delete'
 
 require 'delighted/resources/bounce'
 require 'delighted/resources/metrics'

data/lib/delighted/operations/delete.rb

@@ -0,0 +1,20 @@
+module Delighted
+  module Operations
+    module Delete
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def path(id = nil)
+          id ? "#{@path}/#{CGI.escape(id)}" : @path
+        end
+
+        def delete(id_hash, client = Delighted.shared_client)
+          id = identifier_string(id_hash)
+          client.delete_json(path(id))
+        end
+      end
+    end
+  end
+end

data/lib/delighted/resource.rb

@@ -11,6 +11,20 @@ module Delighted
       def singleton_resource?
         !!@singleton_resource
       end
+
+      def identifier_string(identifier_hash)
+        raise ArgumentError, "must pass Hash" unless Hash === identifier_hash
+        raise ArgumentError, "must pass exactly one identifier name and value" unless identifier_hash.size == 1
+
+        identifier_key = identifier_hash.keys.first
+        identifier_value = identifier_hash.values.first
+
+        if identifier_key.to_s == "id"
+          identifier_value.to_s
+        else
+          "#{identifier_key}:#{identifier_value}"
+        end
+      end
     end
 
     undef :id if method_defined?(:id)

data/lib/delighted/resources/person.rb

@@ -3,5 +3,6 @@ module Delighted
     self.path = "/people"
 
     include Operations::Create
+    include Operations::Delete
   end
 end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.7.0"
+  VERSION = "1.8.0rc1"
 end

data/test/delighted_test.rb

@@ -80,6 +80,43 @@ class Delighted::PeopleTest < Delighted::TestCase
     assert_kind_of Hash, result
     assert_equal({ :ok => true }, result)
   end
+
+  def test_deleting_a_person_with_multiple_identifiers
+    assert_raises(ArgumentError) { Delighted::Person.delete(:id => 57, :email => "foo@example.com") }
+  end
+
+  def test_deleting_a_person_by_id
+    uri = URI.parse("https://api.delightedapp.com/v1/people/57")
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(202, {}, Delighted::JSON.dump({ :ok => true }))
+    mock_http_adapter.expects(:request).with(:delete, uri, headers, nil).once.returns(response)
+
+    result = Delighted::Person.delete(:id => 57)
+    assert_kind_of Hash, result
+    assert_equal({ :ok => true }, result)
+  end
+
+  def test_deleting_a_person_by_email
+    uri = URI.parse("https://api.delightedapp.com/v1/people/email%3Afoo%40bar.com")
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(202, {}, Delighted::JSON.dump({ :ok => true }))
+    mock_http_adapter.expects(:request).with(:delete, uri, headers, nil).once.returns(response)
+
+    result = Delighted::Person.delete(:email => "foo@bar.com")
+    assert_kind_of Hash, result
+    assert_equal({ :ok => true }, result)
+  end
+
+  def test_deleting_a_person_by_phone_number
+    uri = URI.parse("https://api.delightedapp.com/v1/people/phone_number%3A%2B14155551212")
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(202, {}, Delighted::JSON.dump({ :ok => true }))
+    mock_http_adapter.expects(:request).with(:delete, uri, headers, nil).once.returns(response)
+
+    result = Delighted::Person.delete(:phone_number => "+14155551212")
+    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.7.0
+  version: 1.8.0rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -90,6 +90,7 @@ files:
 - lib/delighted/json.rb
 - lib/delighted/operations/all.rb
 - lib/delighted/operations/create.rb
+- lib/delighted/operations/delete.rb
 - lib/delighted/operations/retrieve.rb
 - lib/delighted/operations/update.rb
 - lib/delighted/resource.rb
@@ -119,12 +120,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.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Delighted is the fastest and easiest way to gather actionable feedback from