intercom 2.2.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa96a0842530f56baae6d4a78782fc99dbdfb5d
-  data.tar.gz: aab9881adb19557ed2e03d2edf4e8007aa5e7c18
+  metadata.gz: 513076550f366c50ddd55f25cf420c9e28ed4a67
+  data.tar.gz: fe6b1eb608e712aa9094035dc14b73e3c7005315
 SHA512:
-  metadata.gz: 46ff0d47d1be82494ab2b76b2ed90a73798f7e9465634e19e305495b7b27fd9c8887364906a0ecca0bc63267b2fb8ac2b7c4610ab0e302fd4b3a90b2729ea263
-  data.tar.gz: 4e47ecae6dea2a440d4580b7597ce91ec471d01f51f2f426ba043267a95a236964f0723735884b9b5c96b7c1517f5e932c464dad4de565941285f693020eaceb
+  metadata.gz: 0a3d1a25d2f82c0e88b51c84172b966eeb35d3866a3ba66e5f197522c6e79710baf155166813514f17df91a14fda47e34f479d4632b94191d01b083684343a70
+  data.tar.gz: d90da12671da821d98af3c53009a64adb3425af83a407a428983bb926610c85b64f25171c620682b37271666d81e23562d234db518dcaa29c4bd8608db0705a2

data/README.md

@@ -19,7 +19,7 @@ Additionally, the new version uses Ruby 2.
 
 Using bundler:
 
-    gem 'intercom', "~> 2.2.4"
+    gem 'intercom', "~> 2.3.0"
 
 ## Basic Usage
 
@@ -328,7 +328,7 @@ user = payload.model
 Note that models generated from webhook notifications might differ slightly from models directly acquired via the API. If this presents a problem, calling `payload.load` will load the model from the API using the `id` field.
 
 ### Errors
-You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of Intercom:Error will be raised. If desired, you can get at the http_code of an Intercom::Error via it's `http_code` method.
+You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of Intercom:Error will be raised. If desired, you can get at the http_code of an Intercom::Error via its `http_code` method.
 
 The list of different error subclasses are listed below. As they all inherit off Intercom::Error you can choose to rescue Intercom::Error or
 else rescue the more specific error subclass.
@@ -343,6 +343,7 @@ Intercom::BadRequestError
 Intercom::RateLimitExceeded
 Intercom::AttributeNotSetError # Raised when you try to call a getter that does not exist on an object
 Intercom::MultipleMatchingUsersError
+Intercom::HttpError # Raised when response object is unexpectedly nil
 ```
 
 ### Rate Limiting

data/changes.txt

@@ -1,3 +1,8 @@
+2.3.0
+ - Add Intercom::HttpError to be raised when empty response entity received unexpectedly
+ - Raise Intercom errors more gracefully when HTML returned
+ - Fixed README typo (thanks to @marckohlbrugge)
+
 2.2.4
  - Add Intercom::MultipleMatchingUsersError
 

data/lib/intercom/api_operations/find.rb

@@ -10,6 +10,7 @@ module Intercom
           else
             response = Intercom.get("/#{collection_name}", params)
           end
+          raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
           from_api(response)
         end
       end

data/lib/intercom/api_operations/load.rb

@@ -8,6 +8,7 @@ module Intercom
         else
           raise "Cannot load #{self.class} as it does not have a valid id."
         end
+        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
         from_response(response)
       end
     end

data/lib/intercom/collection_proxy.rb

@@ -21,6 +21,7 @@ module Intercom
         else
           response_hash = Intercom.get(@finder_url, @finder_params)
         end
+        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
         deserialize_response_hash(response_hash, block)
         next_page = extract_next_link(response_hash)
         break if next_page.nil?

data/lib/intercom/errors.rb

@@ -43,6 +43,9 @@ module Intercom
 
   # Raised when you try to call a non-setter method that does not exist on an object
   class Intercom::AttributeNotSetError < IntercomError ; end
+  
+  # Raised when unexpected nil returned from server
+  class Intercom::HttpError < IntercomError ; end
 
   #
   # Non-public errors (internal to the gem)

data/lib/intercom/request.rb

@@ -62,11 +62,8 @@ module Intercom
           begin
             response = http.request(net_http_method)
             set_rate_limit_details(response)
-            decoded = decode(response['content-encoding'], response.body)
-            unless decoded.strip.empty?
-              parsed_body = JSON.parse(decoded)
-              raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
-            end
+            decoded_body = decode_body(response)
+            parsed_body = parse_body(decoded_body, response)
             raise_errors_on_failure(response)
             parsed_body
           rescue Timeout::Error
@@ -77,6 +74,23 @@ module Intercom
         raise Intercom::ServiceConnectionError.new('Failed to connect to service [connection attempt timed out]')
       end
     end
+    
+    def decode_body(response)
+      decode(response['content-encoding'], response.body)
+    end
+
+    def parse_body(decoded_body, response)
+      parsed_body = nil
+      unless decoded_body.strip.empty?
+        begin
+          parsed_body = JSON.parse(decoded_body)
+        rescue JSON::ParserError => e
+          raise_errors_on_failure(response)
+        end
+        raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
+      end
+      parsed_body
+    end
 
     def set_rate_limit_details(response)
       rate_limit_details = {}

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "2.2.4"
+  VERSION = "2.3.0"
 end

data/spec/unit/intercom/company_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Intercom::Company do
+  
+  describe 'when no response raises error' do
+    it 'on find' do
+      Intercom.expects(:get).with("/companies", {:company_id => '4'}).returns(nil)
+      proc {company = Intercom::Company.find(:company_id => '4')}.must_raise Intercom::HttpError
+    end
+    
+    it 'on find_all' do
+      Intercom.expects(:get).with("/companies", {}).returns(nil)
+      proc {Intercom::Company.all.each {|company| }}.must_raise Intercom::HttpError
+    end
+    
+    it 'on load' do
+      Intercom.expects(:get).with("/companies", {:company_id => '4'}).returns({'type' =>'user', 'id' =>'aaaaaaaaaaaaaaaaaaaaaaaa', 'company_id' => '4', 'name' => 'MyCo'})
+      company = Intercom::Company.find(:company_id => '4')
+      Intercom.expects(:get).with('/companies/aaaaaaaaaaaaaaaaaaaaaaaa', {}).returns(nil)
+      proc {company.load}.must_raise Intercom::HttpError
+    end
+  end
+end

data/spec/unit/intercom/request_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe 'Intercom::Request' do
+  it 'raises an error when a html error page rendered' do
+    response = OpenStruct.new(:code => 500)
+    req = Intercom::Request.new('path/', 'GET')
+    proc {req.parse_body('<html>somethjing</html>', response)}.must_raise(Intercom::ServerError)
+  end
+end

data/spec/unit/intercom/user_spec.rb

@@ -219,32 +219,5 @@ describe "Intercom::User" do
   it "returns the total number of users" do
     Intercom::Count.expects(:user_count).returns('count_info')
     Intercom::User.count
-  end
-
- ##TODO: Investigate
-  #it "converts company created_at values to unix timestamps" do
-  #  time = Time.now
-
-  #  user = Intercom::User.new("companies" => [
-  #    { "created_at" => time },
-  #    { "created_at" => time.to_i }
-  #  ])
-
-  #  as_hash = user.to_hash
-  #  require 'ruby-debug' ; debugger
-  #  first_company_as_hash = as_hash["companies"][0]
-  #  second_company_as_hash = as_hash["companies"][1]
-
-  #  first_company_as_hash["created_at"].must_equal time.to_i
-  #  second_company_as_hash["created_at"].must_equal time.to_i
-  #end
-  
-#  it "tracks events" do
-#    user = Intercom::User.new("email" => "jim@example.com", :user_id => "12345", :created_at => Time.now, :name => "Jim Bob")
-#    Intercom::Event.expects(:create).with(:event_name => 'registration', :user => user)
-#    event = user.track_event('registration')
-    
-#    Intercom::Event.expects(:create).with(:event_name => 'another', :user => user, :created_at => 1391691571)
-#    event = user.track_event("another", {:created_at => 1391691571})
-#  end
+  end  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -156,11 +156,13 @@ files:
 - spec/spec_helper.rb
 - spec/unit/intercom/admin_spec.rb
 - spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/notification_spec.rb
+- spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
@@ -194,11 +196,13 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/intercom/admin_spec.rb
 - spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/notification_spec.rb
+- spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb