delighted 1.4.0.rc2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fa8281430a51548a8010a39f65cdafcdb70019e
-  data.tar.gz: c6c74bef892f5e83bfdb3019fe561480d51363d5
+  metadata.gz: a61c272d2e9b5614ae8b289ac046686b89a537dc
+  data.tar.gz: b4511534ddea1075ff4e82892044eae1d39b6f45
 SHA512:
-  metadata.gz: b3650ee32960f335aa669eec0187dd96d800fba8a95e598cc96bac63247b9892c49a4de59823e592e172589b62d2d8a7d67ab44d2adfa1eaefcba3f9469b3e03
-  data.tar.gz: 0d78aa7a4f04ffd4ac9a7b23d79150466999e6b056027de9ba24cb9794ca8fc9fc51ffdc5f0b7363c27fbd41485ccbc37cd1cd72928f3c6bef302ddf0c2c05fb
+  metadata.gz: 2da76b95cfa9f4e3f0afb9516683b7d2d0ecd8036e92a8acab663f09d9cf1f1578e1095840919273b16945a8b9ae6088a019a742039548fcddabafa6517c5462
+  data.tar.gz: eff243c3c5b21dc77fe6985bd4aef5dff12a24f9796343a17ac000e71740b047cb2438c65ca60f5517b6db5bb69ede087d865523ef398aaf5326bfefa34b49ec

data/CHANGELOG.md

@@ -5,6 +5,12 @@ Features:
 - Add support for retrieving a SurveyResponse
 - Add support for updating a SurveyResponse
 
+## 1.3.1 (2015-09-14)
+
+Features:
+
+- Fix authentication header on 1.8.7
+
 ## 1.3.0 (2014-06-03)
 
 Features:

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Delighted Inc.
+Copyright (c) 2013–2015 Delighted Inc.
 
 MIT License
 

data/README.md

@@ -1,12 +1,185 @@
-# Delighted API client for Ruby [![Build Status](https://travis-ci.org/delighted/delighted-ruby.png)](https://travis-ci.org/delighted/delighted-ruby)
+[![Build Status](https://img.shields.io/travis/delighted/delighted-ruby.svg)](https://travis-ci.org/delighted/delighted-ruby)
 
-Official Ruby client for the [Delighted](https://delightedapp.com) API.
+# Delighted API Ruby Client
 
-For basic installation and usage instructions, please [sign in to your Delighted account](https://delightedapp.com/signin) and follow the API documentation under Settings.
+Official Ruby client for the [Delighted API](https://delighted.com/docs/api).
 
-For more detailed examples, please see [USAGE.md](https://github.com/delighted/delighted-ruby/blob/master/USAGE.md).
+## Installation
 
-## Supported Rubies
+Add `gem 'delighted'` to your application's Gemfile, and then run `bundle` to install.
+
+## Configuration
+
+To get started, you need to configure the client with your secret API key. If you're using Rails, you should add the following to new initializer file in `config/initializers/delighted.rb`.
+
+```ruby
+require 'delighted'
+Delighted.api_key = 'YOUR_API_KEY'
+```
+
+For further options, read the [advanced configuration section](#advanced-configuration).
+
+**Note:** Your API key is secret, and you should treat it like a password. You can find your API key in your Delighted account, under *Settings* > *API*.
+
+## Usage
+
+Adding/updating people and scheduling surveys:
+
+```ruby
+# Add a new person, and schedule a survey immediately
+person1 = Delighted::Person.create(:email => "foo+test1@delighted.com")
+
+# Add a new person, and schedule a survey after 1 minute (60 seconds)
+person2 = Delighted::Person.create(:email => "foo+test2@delighted.com",
+  :delay => 60)
+
+# Add a new person, but do not schedule a survey
+person3 = Delighted::Person.create(:email => "foo+test3@delighted.com",
+  :send => false)
+
+# Add a new person with full set of attributes, including a custom question
+# product name, and schedule a survey with a 30 second delay
+person4 = Delighted::Person.create(:email => "foo+test4@delighted.com",
+  :name => "Joe Bloggs", :properties => { :customer_id => 123, :country => "USA",
+  :question_product_name => "The London Trench" }, :delay => 30)
+
+# Update an existing person (identified by email), adding a name, without
+# scheduling a survey
+updated_person1 = Delighted::Person.create(:email => "foo+test1@delighted.com",
+  :name => "James Scott", :send => false)
+```
+
+Unsubscribing people:
+
+```ruby
+# Unsubscribe an existing person
+Delighted::Unsubscribe.create(:person_email => "foo+test1@delighted.com")
+```
+
+Listing people who have unsubscribed:
+
+```ruby
+# List all people who have unsubscribed, 20 per page, first 2 pages
+survey_responses_page1 = Delighted::Unsubscribe.all
+survey_responses_page2 = Delighted::Unsubscribe.all(:page => 2)
+```
+
+Listing people whose emails have bounced:
+
+```ruby
+# List all people whose emails have bounced, 20 per page, first 2 pages
+survey_responses_page1 = Delighted::Bounce.all
+survey_responses_page2 = Delighted::Bounce.all(:page => 2)
+```
+
+Deleting pending survey requests
+
+```ruby
+# Delete all pending (scheduled but unsent) survey requests for a person, by email.
+Delighted::SurveyRequest.delete_pending(:person_email => "foo+test1@delighted.com")
+```
+
+Adding survey responses:
+
+```ruby
+# Add a survey response, score only
+survey_response1 = Delighted::SurveyResponse.create(:person => person1.id,
+  :score => 10)
+
+# Add *another* survey response (for the same person), score and comment
+survey_response2 = Delighted::SurveyResponse.create(:person => person1.id,
+  :score => 5, :comment => "Really nice.")
+```
+
+Retrieving a survey response:
+
+```ruby
+# Retrieve an existing survey response
+survey_response3 = Delighted::SurveyResponse.retrieve('123')
+```
+
+Updating survey responses:
+
+```ruby
+# Update a survey response score
+survey_response4 = Delighted::SurveyResponse.retrieve('234')
+survey_response4.score = 10
+survey_response4.save #=> #<Delighted::SurveyResponse:...>
+
+# Update (or add) survey response properties
+survey_response4.person_properties = { :segment => "Online" }
+survey_response4.save #=> #<Delighted::SurveyResponse:...>
+
+# Update person who recorded the survey response
+survey_response4.person = '321'
+survey_response4.save #=> #<Delighted::SurveyResponse:...>
+```
+
+Listing survey responses:
+
+```ruby
+# List all survey responses, 20 per page, first 2 pages
+survey_responses_page1 = Delighted::SurveyResponse.all
+survey_responses_page2 = Delighted::SurveyResponse.all(:page => 2)
+
+# List all survey responses, 20 per page, expanding person object
+survey_responses_page1_expanded = Delighted::SurveyResponse.all(:expand => ['person'])
+survey_responses_page1_expanded[0].person #=> #<Delighted::Person:...>
+
+# List all survey responses, 20 per page, for a specific trend (ID: 123)
+survey_responses_page1_trend = Delighted::SurveyResponse.all(:trend => "123")
+
+# List all survey responses, 20 per page, in reverse chronological order (newest first)
+survey_responses_page1_desc = Delighted::SurveyResponse.all(:order => 'desc')
+
+# List all survey responses, 100 per page, page 5, with a time range
+filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5,
+  :per_page => 100, :since => Time.utc(2013, 10, 01),
+  :until => Time.utc(2013, 11, 01))
+```
+
+Retrieving metrics:
+
+```ruby
+# Get current metrics, 30-day simple moving average, from most recent response
+metrics = Delighted::Metrics.retrieve
+
+# Get current metrics, 30-day simple moving average, from most recent response,
+# for a specific trend (ID: 123)
+metrics = Delighted::Metrics.retrieve(:trend => "123")
+
+# Get metrics, for given range
+metrics = Delighted::Metrics.retrieve(:since => Time.utc(2013, 10, 01),
+  :until => Time.utc(2013, 11, 01))
+```
+
+## <a name="advanced-configuration"></a> Advanced configuration & testing
+
+The following options are configurable for the client:
+
+```ruby
+Delighted.api_key
+Delighted.api_base_url # default: 'https://api.delighted.com/v1'
+Delighted.http_adapter # default: Delighted::HTTPAdapter.new
+```
+
+By default, a shared instance of `Delighted::Client` is created lazily in `Delighted.shared_client`. If you want to create your own client, perhaps for test or if you have multiple API keys, you can:
+
+```ruby
+# Create an custom client instance, and pass as last argument to resource actions
+client = Delighted::Client.new(:api_key => 'API_KEY',
+  :api_base_url => 'https://api.delighted.com/v1',
+  :http_adapter => Delighted::HTTPAdapter.new)
+metrics_from_custom_client = Delighted::Metrics.retrieve({}, client)
+
+# Or, you can set Delighted.shared_client yourself
+Delighted.shared_client = Delighted::Client.new(:api_key => 'API_KEY',
+  :api_base_url => 'https://api.delighted.com/v1',
+  :http_adapter => Delighted::HTTPAdapter.new)
+metrics_from_custom_shared_client = Delighted::Metrics.retrieve
+```
+
+## Supported runtimes
 
 - Ruby MRI (1.8.7+)
 - JRuby (1.8 + 1.9 modes)
@@ -17,6 +190,7 @@ For more detailed examples, please see [USAGE.md](https://github.com/delighted/d
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Run the tests (`rake test`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/delighted.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.name          = "delighted"
   spec.version       = Delighted::VERSION
   spec.authors       = ["Mark Dodwell"]
-  spec.email         = ["mark@madeofcode.com"]
-  spec.description   = "Delighted API client for Ruby."
-  spec.summary       = "Delighted is the easiest and most beautiful way to measure customer happiness. Are your customers delighted?"
+  spec.email         = ["mark@delighted.com"]
+  spec.description   = "Delighted API Ruby Client."
+  spec.summary       = "Delighted is the fastest and easiest way to gather actionable feedback from your customers."
   spec.homepage      = "https://github.com/delighted/delighted-ruby"
   spec.license       = "MIT"
 

data/lib/delighted.rb

@@ -16,6 +16,7 @@ require 'delighted/operations/create'
 require 'delighted/operations/retrieve'
 require 'delighted/operations/update'
 
+require 'delighted/resources/bounce'
 require 'delighted/resources/metrics'
 require 'delighted/resources/person'
 require 'delighted/resources/survey_request'

data/lib/delighted/client.rb

@@ -70,7 +70,7 @@ module Delighted
 
     def default_headers
       @default_headers ||= {
-        'Authorization' => "Basic #{["#{@api_key}:"].pack('m0')}",
+        'Authorization' => "Basic #{["#{@api_key}:"].pack('m').chomp}",
         'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}"
       }.freeze
     end

data/lib/delighted/resources/bounce.rb

@@ -0,0 +1,7 @@
+module Delighted
+  class Bounce < Resource
+    self.path = '/bounces'
+
+    include Operations::All
+  end
+end

data/lib/delighted/resources/unsubscribe.rb

@@ -2,6 +2,7 @@ module Delighted
   class Unsubscribe < Resource
     self.path = '/unsubscribes'
 
+    include Operations::All
     include Operations::Create
   end
 end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.4.0.rc2"
+  VERSION = "1.5.0"
 end

data/test/delighted_test.rb

@@ -10,7 +10,7 @@ end
 class Delighted::MetricsTest < Delighted::TestCase
   def test_retrieving_metrics
     uri = URI.parse("https://api.delightedapp.com/v1/metrics")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :nps => 10 }))
     mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
 
@@ -25,7 +25,7 @@ end
 class Delighted::PeopleTest < Delighted::TestCase
   def test_creating_or_updating_a_person
     uri = URI.parse("https://api.delightedapp.com/v1/people")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     data = Delighted::JSON.dump({ :email => 'foo@bar.com' })
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '123', :email => 'foo@bar.com' }))
     mock_http_adapter.expects(:request).with(:post, uri, headers, data).once.returns(response)
@@ -41,7 +41,7 @@ class Delighted::PeopleTest < Delighted::TestCase
     person_email = 'person@example.com'
     uri = URI.parse('https://api.delightedapp.com/v1/unsubscribes')
     headers = {
-      'Authorization' => "Basic #{["123abc:"].pack('m0')}",
+      'Authorization' => @auth_header,
       'Accept' => 'application/json',
       'Content-Type' => 'application/json',
       'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}"
@@ -57,7 +57,7 @@ class Delighted::PeopleTest < Delighted::TestCase
 
   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}" }
+    headers = { 'Authorization' => @auth_header, "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)
 
@@ -70,7 +70,7 @@ end
 class Delighted::SurveyResponseTest < Delighted::TestCase
   def test_creating_a_survey_response
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     data = Delighted::JSON.dump({ :person => '123', :score => 10 })
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '456', :person => '123', :score => 10 }))
     mock_http_adapter.expects(:request).with(:post, uri, headers, data).once.returns(response)
@@ -132,7 +132,7 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
 
   def test_listing_all_survey_responses
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses?order=desc")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([{ :id => '123', :comment => 'One' }, { :id => '456', :comment => 'Two' }]))
     mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
 
@@ -150,7 +150,7 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
 
   def test_listing_all_survey_responses_expand_person
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses?expand%5B%5D=person")
-    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
     response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([{ :id => '123', :comment => 'One', :person => { :id => '123', :email => 'foo@bar.com' } }, { :id => '456', :comment => 'Two', :person => { :id => '123', :email => 'foo@bar.com' } }]))
     mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
 
@@ -170,3 +170,39 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
     assert_equal({ :email => 'foo@bar.com' }, survey_responses[1].person.to_hash)
   end
 end
+
+class Delighted::UnsubscribesTest < Delighted::TestCase
+  def test_listing_unsubscribes
+    uri = URI.parse("https://api.delightedapp.com/v1/unsubscribes")
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    example_unsub = {:person_id => '4945', :email => 'foo@example.com', :name => nil, :unsubscribed_at => 1440621400}
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([example_unsub]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    unsubscribes = Delighted::Unsubscribe.all
+    assert_equal 1, unsubscribes.size
+    first_unsub = unsubscribes.first
+    assert_kind_of Delighted::Unsubscribe, first_unsub
+    assert_equal '4945', first_unsub.person_id
+    assert_equal example_unsub, first_unsub.to_hash
+  end
+end
+
+
+class Delighted::BouncesTest < Delighted::TestCase
+  def test_listing_bounces
+    uri = URI.parse("https://api.delightedapp.com/v1/bounces")
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    example_bounce = {:person_id => '4945', :email => 'foo@example.com', :name => nil, :bounced_at => 1440621400}
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([example_bounce]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    bounces = Delighted::Bounce.all
+    assert_equal 1, bounces.size
+    first_bounce = bounces.first
+    assert_kind_of Delighted::Bounce, first_bounce
+    assert_equal '4945', first_bounce.person_id
+    assert_equal example_bounce, first_bounce.to_hash
+  end
+end
+

data/test/test_helper.rb

@@ -8,6 +8,7 @@ class Delighted::TestCase < Minitest::Test
   def setup
     super
     Delighted.shared_client = Delighted::Client.new(:api_key => '123abc', :http_adapter => mock_http_adapter)
+    @auth_header = "Basic #{["123abc:"].pack('m').chomp}"
   end
 
   def mock_http_adapter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.4.0.rc2
+  version: 1.5.0
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-19 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -66,9 +66,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Delighted API client for Ruby.
+description: Delighted API Ruby Client.
 email:
-- mark@madeofcode.com
+- mark@delighted.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -80,7 +80,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- USAGE.md
 - delighted.gemspec
 - lib/delighted.rb
 - lib/delighted/client.rb
@@ -94,6 +93,7 @@ files:
 - lib/delighted/operations/retrieve.rb
 - lib/delighted/operations/update.rb
 - lib/delighted/resource.rb
+- lib/delighted/resources/bounce.rb
 - lib/delighted/resources/metrics.rb
 - lib/delighted/resources/person.rb
 - lib/delighted/resources/survey_request.rb
@@ -118,16 +118,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Delighted is the easiest and most beautiful way to measure customer happiness.
-  Are your customers delighted?
+summary: Delighted is the fastest and easiest way to gather actionable feedback from
+  your customers.
 test_files:
 - test/delighted_test.rb
 - test/test_helper.rb

data/USAGE.md

@@ -1,150 +0,0 @@
-## Installation
-
-Add `gem 'delighted'` to your application's Gemfile, and then run `bundle` to install.
-
-## Configuration
-
-To get started, you need to configure the client with your secret API key. If you're using Rails, you should add the following to new initializer file in `config/initializers/delighted.rb`.
-
-```ruby
-require 'delighted'
-Delighted.api_key = 'YOUR_API_KEY'
-```
-
-For further options, read the [advanced configuration section](#advanced-configuration).
-
-**Note:** Your API key is secret, and you should treat it like a password. You can find your API key in your Delighted account, under *Settings* > *API*.
-
-## Usage
-
-### Adding/updating people and scheduling surveys
-
-```ruby
-# Add a new person, and schedule a survey immediately
-person1 = Delighted::Person.create(:email => "foo+testing1@delightedapp.com")
-
-# Add a new person, and schedule a survey after 1 minute (60 seconds)
-person2 = Delighted::Person.create(:email => "foo+testing2@delightedapp.com", :delay => 60)
-
-# Add a new person, but do not schedule a survey
-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 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)
-
-# Update an existing person (identified by email), adding a name, without scheduling a survey
-updated_person1 = Delighted::Person.create(:email => "foo+testing1@delightedapp.com",
-  :name => "James Scott", :send => false)
-```
-
-### Unsubscribing people
-
-```ruby
-# Unsubscribe an existing person
-Delighted::Unsubscribe.create(:person_email => "foo+testing1@delightedapp.com")
-```
-
-### Deleting pending survey requests
-
-```ruby
-# Delete all pending (scheduled but unsent) survey requests for a person, by email.
-Delighted::SurveyRequest.delete_pending(:person_email => "foo+testing1@delightedapp.com")
-```
-
-### Adding survey responses
-
-```ruby
-# Add a survey response, score only
-survey_response1 = Delighted::SurveyResponse.create(:person => person1.id, :score => 10)
-
-# Add *another* survey response (for the same person), score and comment
-survey_response2 = Delighted::SurveyResponse.create(:person => person1.id, :score => 5,
-  :comment => "Really nice.")
-```
-
-### Retrieving a survey response
-
-```ruby
-# Retrieve an existing survey response
-survey_response3 = Delighted::SurveyResponse.retrieve('123')
-```
-
-### Updating survey responses
-
-```ruby
-# Update a survey response score
-survey_response4 = Delighted::SurveyResponse.retrieve('234')
-survey_response4.score = 10
-survey_response4.save #=> #<Delighted::SurveyResponse:...>
-
-# Update (or add) survey response properties
-survey_response4.person_properties = { :segment => "Online" }
-survey_response4.save #=> #<Delighted::SurveyResponse:...>
-
-# Update person who recorded the survey response
-survey_response4.person = '321'
-survey_response4.save #=> #<Delighted::SurveyResponse:...>
-```
-
-### Listing survey responses
-
-```ruby
-# List all survey responses, 20 per page, first 2 pages
-survey_responses_page_1 = Delighted::SurveyResponse.all
-survey_responses_page_2 = Delighted::SurveyResponse.all(:page => 2)
-
-# List all survey responses, 20 per page, expanding person object
-survey_responses_page_1_expanded = Delighted::SurveyResponse.all(:expand => ['person'])
-survey_responses_page_1_expanded[0].person #=> #<Delighted::Person:...>
-
-# List all survey responses, 20 per page, for a specific trend (ID: 123)
-survey_responses_page_1_trend = Delighted::SurveyResponse.all(:trend => "123")
-
-# List all survey responses, 20 per page, in reverse chronological order (newest first)
-survey_responses_page_1_desc = Delighted::SurveyResponse.all(:order => 'desc')
-
-# List all survey responses, 100 per page, page 5, with a time range
-filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5, :per_page => 100,
-  :since => Time.utc(2013, 10, 01), :until => Time.utc(2013, 11, 01))
-```
-
-### Retrieving metrics
-
-```ruby
-# Get current metrics, 30-day simple moving average, from most recent response
-metrics = Delighted::Metrics.retrieve
-
-# Get current metrics, 30-day simple moving average, from most recent response, for a specific trend (ID: 123)
-metrics = Delighted::Metrics.retrieve(:trend => "123")
-
-# Get metrics, for given range
-metrics = Delighted::Metrics.retrieve(:since => Time.utc(2013, 10, 01),
-  :until => Time.utc(2013, 11, 01))
-```
-
-## <a name="advanced-configuration"></a> Advanced configuration
-
-The following options are configurable for the client:
-
-```ruby
-Delighted.api_key
-Delighted.api_base_url # default: 'https://api.delightedapp.com/v1'
-Delighted.http_adapter # default: Delighted::HTTPAdapter.new
-```
-
-By default, a shared instance of `Delighted::Client` is created lazily in `Delighted.shared_client`. If you want to create your own client, perhaps for testing or if you have multiple API keys, you can:
-
-```ruby
-# Create an custom client instance, and pass as last argument to resource actions
-client = Delighted::Client.new(:api_key => 'API_KEY',
-  :api_base_url => 'https://api.delightedapp.com/v1', :http_adapter => Delighted::HTTPAdapter.new)
-metrics_from_custom_client = Delighted::Metrics.retrieve({}, client)
-
-# Or, you can set Delighted.shared_client yourself
-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
-```