delighted 1.3.1 → 1.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37805cf1e7b0836ab7a522aa3e886cc2c82cb0f4
-  data.tar.gz: bb1dc6a443bc57aa8784f91dfc75d95d07326b7a
+  metadata.gz: d8beec1cb9744f320e1fc4f9616446777b36310f
+  data.tar.gz: 119d1aa1d03033a91984a59408d430a6bf45688b
 SHA512:
-  metadata.gz: 3e5aecf2f1cbb700dc8acb92232e754384809681817450e73a69a6ea2eac219957d112e350e1e0ac6305d0f04ad79fccce921688d1e94d75f4eeb74d03ad48a2
-  data.tar.gz: 265dfdeed0e7d351bf21f44dde3d6416ca725b4917eb43ed1334a10466b7af808c0ab5522318c6eaf755422d3e8d42a7e2c375e39f65d504c7910fd0ad4fd909
+  metadata.gz: 108ff82e7a3c7f4be0ade2b17d6319d197038952c169b2ad779cf729726944d0557cebea63d5a4c2c04d22dcadb9297cafd5cfb173742f1e30d6e4f1396dc2af
+  data.tar.gz: 72efad36ac7309e3f232309badfdc1cb2ce81d66c59b0cfc3dbe51ca11e7cc850f0d3a09c77a9bb048fa598fe00308b5c76d08288830704625f9d3dc7d89d597

data/CHANGELOG.md

@@ -1,8 +1,9 @@
-## 1.3.1 (2015-09-14)
+## 1.4.0 (Unreleased)
 
 Features:
 
-- Fix authentication header on 1.8.7
+- Add support for retrieving a SurveyResponse
+- Add support for updating a SurveyResponse
 
 ## 1.3.0 (2014-06-03)
 

data/USAGE.md

@@ -65,6 +65,30 @@ survey_response2 = Delighted::SurveyResponse.create(:person => person1.id, :scor
   :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

data/lib/delighted.rb

@@ -14,6 +14,7 @@ require 'delighted/resource'
 require 'delighted/operations/all'
 require 'delighted/operations/create'
 require 'delighted/operations/retrieve'
+require 'delighted/operations/update'
 
 require 'delighted/resources/metrics'
 require 'delighted/resources/person'

data/lib/delighted/client.rb

@@ -29,6 +29,16 @@ module Delighted
       handle_json_response(response)
     end
 
+    def put_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(:put, uri, headers, data)
+      handle_json_response(response)
+    end
+
     def delete_json(path, params = {})
       headers = default_headers.dup.merge('Accept' => 'application/json', 'Content-Type' => 'application/json')
 
@@ -60,7 +70,7 @@ module Delighted
 
     def default_headers
       @default_headers ||= {
-        'Authorization' => "Basic #{["#{@api_key}:"].pack('m').chomp}",
+        'Authorization' => "Basic #{["#{@api_key}:"].pack('m0')}",
         'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}"
       }.freeze
     end

data/lib/delighted/operations/update.rb

@@ -0,0 +1,26 @@
+module Delighted
+  module Operations
+    module Update
+      def self.included(klass)
+        unless klass.singleton_resource?
+          klass.extend(Pluralton::ClassMethods)
+        end
+      end
+
+      def save(client = Delighted.shared_client)
+        params = Utils.hash_without_key(attributes, :id)
+        params = Utils.serialize_values(params)
+        json = client.put_json(self.class.path(id), params)
+        self.class.new(json)
+      end
+
+      module Pluralton
+        module ClassMethods
+          def path(id = nil)
+            id ? "#{@path}/#{id}" : @path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delighted/resource.rb

@@ -54,6 +54,10 @@ module Delighted
           define_method(key) do
             attributes[key]
           end
+
+          define_method("#{key}=") do |value|
+            attributes[key] = value
+          end
         end
       end
     end

data/lib/delighted/resources/survey_response.rb

@@ -4,6 +4,8 @@ module Delighted
 
     include Operations::Create
     include Operations::All
+    include Operations::Update
+    include Operations::Retrieve
 
     def to_hash
       if Person === attributes[:person]

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.3.1"
+  VERSION = "1.4.0.rc1"
 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' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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' => @auth_header,
+      'Authorization' => "Basic #{["123abc:"].pack('m0')}",
       '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' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    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)
 
@@ -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' => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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)
@@ -83,9 +83,40 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
     assert_equal '456', survey_response.id
   end
 
+  def test_retrieving_a_survey_response
+    uri = URI.parse("https://api.delightedapp.com/v1/survey_responses/456")
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :id => '456', :person => '123', :score => 10 }))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    survey_response = Delighted::SurveyResponse.retrieve('456')
+    assert_kind_of Delighted::SurveyResponse, survey_response
+    assert_equal({ :person => '123', :score => 10 }, survey_response.to_hash)
+    assert_equal '123', survey_response.person
+    assert_equal 10, survey_response.score
+    assert_equal '456', survey_response.id
+  end
+
+  def test_updating_a_survey_response
+    uri = URI.parse("https://api.delightedapp.com/v1/survey_responses/456")
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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(:put, uri, headers, data).once.returns(response)
+
+    survey_response = Delighted::SurveyResponse.new(:id => '456', :person => '321', :score => 1)
+    survey_response.person = '123'
+    survey_response.score = 10
+    assert_kind_of Delighted::SurveyResponse, survey_response.save
+    assert_equal({ :person => '123', :score => 10 }, survey_response.to_hash)
+    assert_equal '123', survey_response.person
+    assert_equal 10, survey_response.score
+    assert_equal '456', survey_response.id
+  end
+
   def test_listing_all_survey_responses
     uri = URI.parse("https://api.delightedapp.com/v1/survey_responses?order=desc")
-    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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)
 
@@ -103,7 +134,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' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    headers = { 'Authorization' => "Basic #{["123abc:"].pack('m0')}", "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)
 

data/test/test_helper.rb

@@ -8,7 +8,6 @@ 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.3.1
+  version: 1.4.0.rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -92,6 +92,7 @@ files:
 - lib/delighted/operations/all.rb
 - lib/delighted/operations/create.rb
 - lib/delighted/operations/retrieve.rb
+- lib/delighted/operations/update.rb
 - lib/delighted/resource.rb
 - lib/delighted/resources/metrics.rb
 - lib/delighted/resources/person.rb
@@ -117,12 +118,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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Delighted is the easiest and most beautiful way to measure customer happiness.