delighted 1.4.0.rc1 → 1.4.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8beec1cb9744f320e1fc4f9616446777b36310f
-  data.tar.gz: 119d1aa1d03033a91984a59408d430a6bf45688b
+  metadata.gz: 0fa8281430a51548a8010a39f65cdafcdb70019e
+  data.tar.gz: c6c74bef892f5e83bfdb3019fe561480d51363d5
 SHA512:
-  metadata.gz: 108ff82e7a3c7f4be0ade2b17d6319d197038952c169b2ad779cf729726944d0557cebea63d5a4c2c04d22dcadb9297cafd5cfb173742f1e30d6e4f1396dc2af
-  data.tar.gz: 72efad36ac7309e3f232309badfdc1cb2ce81d66c59b0cfc3dbe51ca11e7cc850f0d3a09c77a9bb048fa598fe00308b5c76d08288830704625f9d3dc7d89d597
+  metadata.gz: b3650ee32960f335aa669eec0187dd96d800fba8a95e598cc96bac63247b9892c49a4de59823e592e172589b62d2d8a7d67ab44d2adfa1eaefcba3f9469b3e03
+  data.tar.gz: 0d78aa7a4f04ffd4ac9a7b23d79150466999e6b056027de9ba24cb9794ca8fc9fc51ffdc5f0b7363c27fbd41485ccbc37cd1cd72928f3c6bef302ddf0c2c05fb

data/USAGE.md

@@ -96,7 +96,6 @@ survey_response4.save #=> #<Delighted::SurveyResponse:...>
 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:...>

data/lib/delighted/http_adapter.rb

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

data/lib/delighted/operations/retrieve.rb

@@ -11,8 +11,9 @@ module Delighted
 
       module Pluralton
         module ClassMethods
-          def retrieve(id, client = Delighted.shared_client)
-            json = client.get_json(path(id))
+          def retrieve(id, opts = {}, client = Delighted.shared_client)
+            opts = Utils.serialize_values(opts)
+            json = client.get_json(path(id), opts)
             new(json)
           end
 

data/lib/delighted/operations/update.rb

@@ -8,7 +8,8 @@ module Delighted
       end
 
       def save(client = Delighted.shared_client)
-        params = Utils.hash_without_key(attributes, :id)
+        params = Utils.hash_without_key(to_hash, :id)
+        params = params.merge(:expand => expanded_attribute_names) unless expanded_attribute_names.empty?
         params = Utils.serialize_values(params)
         json = client.put_json(self.class.path(id), params)
         self.class.new(json)

data/lib/delighted/resource.rb

@@ -1,16 +1,11 @@
 module Delighted
   class Resource
     class << self
-      def path=(path)
-        @path = path
-      end
-
-      def path
-        @path
-      end
+      attr_accessor :path
+      attr_writer :singleton_resource, :expandable_attributes
 
-      def singleton_resource=(singleton_resource)
-        @singleton_resource = singleton_resource
+      def expandable_attributes
+        @expandable_attributes ||= {}
       end
 
       def singleton_resource?
@@ -28,20 +23,46 @@ module Delighted
       build_from_attributes(attributes)
     end
 
+    # Attributes used for serialization
     def to_hash
-      attributes
+      serialized_attributes = attributes.dup
+
+      self.class.expandable_attributes.each_pair.select do |attribute_name, expanded_class|
+        if expanded_class === attributes[attribute_name]
+          serialized_attributes[attribute_name] = serialized_attributes[attribute_name].id
+        end
+      end
+
+      serialized_attributes
     end
     alias_method :to_h, :to_hash
 
-    protected
+    private
+
+    def expanded_attribute_names
+      names = Set.new
+
+      self.class.expandable_attributes.each_pair.select do |attribute_name, expanded_class|
+        if expanded_class === attributes[attribute_name]
+          names << attribute_name
+        end
+      end
+
+      names
+    end
 
     def build_from_attributes(attributes)
       @attributes = Utils.hash_without_key(attributes, :id)
+
+      self.class.expandable_attributes.each_pair do |attribute_name, expanded_class|
+        if Hash === @attributes[attribute_name]
+          @attributes[attribute_name] = expanded_class.new(@attributes.delete(attribute_name))
+        end
+      end
+
       define_attribute_accessors(@attributes.keys)
     end
 
-    private
-
     def define_id_reader
       Utils.eigenclass(self).instance_eval do
         attr_reader :id

data/lib/delighted/resources/survey_response.rb

@@ -1,30 +1,11 @@
 module Delighted
   class SurveyResponse < Resource
     self.path = "/survey_responses"
+    self.expandable_attributes = { :person => Person }
 
     include Operations::Create
     include Operations::All
     include Operations::Update
     include Operations::Retrieve
-
-    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

@@ -48,7 +48,7 @@ module Delighted
           memo[k] = serialize_values(v)
           memo
         }
-      when Array
+      when Array, Set
         object.map { |v| serialize_values(v) }
       else
         object

data/lib/delighted/version.rb

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

data/test/delighted_test.rb

@@ -97,6 +97,22 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
     assert_equal '456', survey_response.id
   end
 
+  def test_retrieving_a_survey_response_expand_person
+    uri = URI.parse("https://api.delightedapp.com/v1/survey_responses/456?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 => '456', :person => { :id => '123', :email => 'foo@bar.com' }, :score => 10 }))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    survey_response = Delighted::SurveyResponse.retrieve('456', :expand => ['person'])
+    assert_kind_of Delighted::SurveyResponse, survey_response
+    assert_equal({ :person => '123', :score => 10 }, survey_response.to_hash)
+    assert_kind_of Delighted::Person, survey_response.person
+    assert_equal '123', survey_response.person.id
+    assert_equal({ :email => 'foo@bar.com' }, survey_response.person.to_hash)
+    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}" }
@@ -141,13 +157,13 @@ class Delighted::SurveyResponseTest < Delighted::TestCase
     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({ :person => '123', :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({ :person => '123', :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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 1.4.0.rc1
+  version: 1.4.0.rc2
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json