delighted 1.2.0 → 1.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a8edfb2d7af0d3cd4ebfbb48ad1871934e57a80
-  data.tar.gz: a6a42c011ee59d7b2058bba2d639b23b39a11cf2
+  metadata.gz: 4d0398185f79509fb4bd2b35e4e25ba8b4b9653d
+  data.tar.gz: 25ecde8c4fc548fc4571a8c25244c0930c833e14
 SHA512:
-  metadata.gz: a070f88c21c96ebcdd9205f515b893e89220c78040eea67e686a2762e187bc31d20cb6b7392f6923d0d44ed0370c7fb273dc6448d0a3503d452ca483a3c5fd24
-  data.tar.gz: ea4e20e9d3532b26cd8c0eb5e60722da2a9dae05b70fa3c9862a2871c95aa64a7fd229c8c79e64ae256b8894868e573801b04a2ea8d523e4efcc8b7ead216866
+  metadata.gz: 5e8e06cd8ce9df39d61a0257bcd7ba4fa6db2b340917b883921b30bee40a051fd757cdd94fbb70166d27a8afa93daec5da570c2995aa7eaadfe1dfefffbf6681
+  data.tar.gz: 913d32f3d9e4fa207c2e40fd314bb85196060302e4c1a457c6b185d99a79a383382e3d3e8147480d04a65ee52d140491601e2dc1aea7a53427151da16c0746cb

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 *.gem
+.bundle

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.3.0.rc1 (2014-03-14)
+
+Features:
+
+- Add support expanding person on SurveyResponses
+
 ## 1.2.0 (2014-02-28)
 
 Features:

data/USAGE.md

@@ -61,13 +61,20 @@ survey_response2 = Delighted::SurveyResponse.create(:person => person1.id, :scor
 ### Listing survey responses
 
 ```ruby
-# List all survey responses, 20 per page
+# 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)
 
+```ruby
+# 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')
-survey_responses_page_2_desc = Delighted::SurveyResponse.all(:order => 'desc', :page => 2)
 
 # List all survey responses, 100 per page, page 5, with a time range
 filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5, :per_page => 100,
@@ -80,6 +87,9 @@ filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5, :per_page
 # 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))

data/lib/delighted/resource.rb

@@ -25,8 +25,7 @@ module Delighted
     def initialize(attributes = {})
       @id = attributes[:id]
       define_id_reader if @id
-      @attributes = Utils.hash_without_key(attributes, :id)
-      define_attribute_accessors(@attributes.keys)
+      build_from_attributes(attributes)
     end
 
     def to_hash
@@ -34,6 +33,13 @@ module Delighted
     end
     alias_method :to_h, :to_hash
 
+    protected
+
+    def build_from_attributes(attributes)
+      @attributes = Utils.hash_without_key(attributes, :id)
+      define_attribute_accessors(@attributes.keys)
+    end
+
     private
 
     def define_id_reader

data/lib/delighted/resources/survey_response.rb

@@ -4,5 +4,25 @@ module Delighted
 
     include Operations::Create
     include Operations::All
+
+    def to_hash
+      if Person === attributes[:person]
+        Utils.hash_without_key(attributes, :person)
+      else
+        attributes
+      end
+    end
+
+    protected
+
+    def build_from_attributes(attributes)
+      attributes_dup = attributes.dup
+
+      if Hash === attributes_dup[:person]
+        attributes_dup[:person] = Person.new(attributes_dup.delete(:person))
+      end
+
+      super(attributes_dup)
+    end
   end
 end

data/lib/delighted/utils.rb

@@ -12,7 +12,7 @@ module Delighted
       hash_or_array.map { |object|
         k, v = case hash_or_array
         when Hash then object
-        when Array then [nil, object[0]]
+        when Array then [nil, object]
         else raise ArgumentError, "must pass Hash or Array"
         end
 

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "1.2.0"
+  VERSION = "1.3.0.rc1"
 end

data/test/delighted_test.rb

@@ -82,4 +82,26 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
     assert_equal 'Two', survey_responses[1].comment
     assert_equal '456', survey_responses[1].id
   end
+
+  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}" }
+    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)
+
+    survey_responses = Delighted::SurveyResponse.all(:expand => ['person'])
+    assert_kind_of Delighted::EnumerableResourceCollection, survey_responses
+    assert_kind_of Delighted::SurveyResponse, survey_responses[0]
+    assert_equal({ :comment => 'One' }, survey_responses[0].to_hash)
+    assert_equal 'One', survey_responses[0].comment
+    assert_equal '123', survey_responses[0].id
+    assert_kind_of Delighted::Person, survey_responses[0].person
+    assert_equal({ :email => 'foo@bar.com' }, survey_responses[0].person.to_hash)
+    assert_kind_of Delighted::SurveyResponse, survey_responses[1]
+    assert_equal({ :comment => 'Two' }, survey_responses[1].to_hash)
+    assert_equal 'Two', survey_responses[1].comment
+    assert_equal '456', survey_responses[1].id
+    assert_kind_of Delighted::Person, survey_responses[1].person
+    assert_equal({ :email => 'foo@bar.com' }, survey_responses[1].person.to_hash)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -116,9 +116,9 @@ 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.2.2