intercom 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -1,4 +1,13 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in intercom.gemspec
 gemspec
+
+group :development, :test do
+  platforms :jruby do
+    gem 'json-jruby'
+    gem 'jruby-openssl'
+  end
+  platforms :ruby_18 do
+    gem 'json_pure'
+  end
+end

data/{LICENSE → MIT-LICENSE}

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011- Intercom App, Inc. (https://www.intercom.io)
+Copyright (c) 2011- Intercom, Inc. (https://www.intercom.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -2,6 +2,8 @@ Ruby bindings for the Intercom API (https://api.intercom.io). See http://docs.in
 
 Yardoc is available at http://rubydoc.info/github/intercom/intercom-ruby/master/frames
 
+For generating Intercom javascript script tags, please see https://github.com/intercom/intercom-rails
+
 == Installation
     gem install intercom
 
@@ -24,12 +26,20 @@ The API supports:
     POST,PUT,GET https://api.intercom.io/v1/users/messages
     POST https://api.intercom.io/v1/users/impressions
 
-==== Users
+=== Examples:
 
-    user = Intercom::User.find(:email => "bob@example.com")
+==== Users
+    user = Intercom::User.find_by_email("bob@example.com")
+    user.custom_data["average_monthly_spend"] = 1234.56
+    user.save
+    user = Intercom::User.find_by_user_id("bob@example.com")
     user = Intercom::User.create(:email => "bob@example.com", :name => "Bob Smith")
     user = Intercom::User.new(params)
     user.save
+    Intercom::User.all.count
+    Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
+    Intercom::User.all.map {|user| user.email }
+
 
 ==== Messages
 

data/changes.txt

@@ -1,3 +1,6 @@
+0.0.6
+ - drop rest-client, use pure net/http instead
+
 0.0.5
  - added Intercom::User.find_by_email, Intercom::User.find_by_user_id
  - add support for Intercom::User.all.each, Intercom::User.all.map, Intercom::User.all.count

data/intercom.gemspec

@@ -1,25 +1,25 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+
 require "intercom/version"
 
-Gem::Specification.new do |s|
-  s.name        = "intercom"
-  s.version     = Intercom::VERSION
-  s.authors     = ["Ben McRedmond", "Ciaran Lee", "Darragh Curran",]
-  s.email       = ["ben@intercom.io", "ciaran@intercom.io", "darragh@intercom.io"]
-  s.homepage    = "http://www.intercom.io"
-  s.summary     = %q{Ruby bindings for the Intercom API}
-  s.description = %Q{Intercom (https://www.intercom.io) is a customer relationship management and messaging tool for web app owners. This library wraps the api provided by Intercom. See http://docs.intercom.io/api for more details. }
+Gem::Specification.new do |spec|
+  spec.name        = "intercom"
+  spec.version     = Intercom::VERSION
+  spec.authors     = ["Ben McRedmond", "Ciaran Lee", "Darragh Curran",]
+  spec.email       = ["ben@intercom.io", "ciaran@intercom.io", "darragh@intercom.io"]
+  spec.homepage    = "http://www.intercom.io"
+  spec.summary     = %q{Ruby bindings for the Intercom API}
+  spec.description = %Q{Intercom (https://www.intercom.io) is a customer relationship management and messaging tool for web app owners. This library wraps the api provided by Intercom. See http://docs.intercom.io/api for more details. }
 
-  s.rubyforge_project = "intercom"
+  spec.rubyforge_project = "intercom"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  s.add_runtime_dependency "rest-client"
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'mocha'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'mocha'
 end

data/lib/intercom.rb

@@ -3,7 +3,7 @@ require "intercom/user_resource"
 require "intercom/user"
 require "intercom/message_thread"
 require "intercom/impression"
-require "rest_client"
+require "intercom/request"
 require "json"
 
 ##
@@ -42,7 +42,6 @@ module Intercom
     @api_key = api_key
   end
 
-
   private
   def self.url_for_path(path)
     raise ArgumentError, "You must set both Intercom.app_id and Intercom.api_key to use this client. See https://github.com/intercom/intercom for usage examples." if [@app_id, @api_key].any?(&:nil?)
@@ -50,51 +49,23 @@ module Intercom
   end
 
   def self.post(path, payload_hash)
-    execute_request(:post, path, {}, {:content_type => :json, :accept => :json}, payload_hash)
+    Intercom::Request.post(url_for_path(path), payload_hash).execute
   end
 
   def self.put(path, payload_hash)
-    execute_request(:put, path, {}, {:content_type => :json, :accept => :json}, payload_hash)
+    Intercom::Request.put(url_for_path(path), payload_hash).execute
   end
 
   def self.get(path, params)
-    execute_request(:get, path, params)
+    Intercom::Request.get(url_for_path(path), params).execute
   end
 
-  def self.require_email_or_user_id(params)
+  def self.check_required_params(params, path=nil)
+    return if path.eql?("users")
     raise ArgumentError.new("Expected params Hash, got #{params.class}") unless params.is_a?(Hash)
     raise ArgumentError.new("Either email or user_id must be specified") unless params.keys.any? { |key| %W(email user_id).include?(key.to_s) }
   end
 
-  def self.execute_request(method, path, params = {}, headers = {}, payload = nil)
-    method.eql?(:get) ? require_email_or_user_id(params) : require_email_or_user_id(payload) unless path.eql?("users")
-    args =rest_client_args(method, path, params, headers, payload)
-    begin
-      response = RestClient::Request.execute(args)
-      JSON.parse(response.body)
-    rescue RestClient::ResourceNotFound
-      raise ResourceNotFound.new
-    rescue RestClient::Unauthorized
-      raise AuthenticationError.new
-    rescue RestClient::InternalServerError
-      raise ServerError.new
-    end
-  end
-
-  def self.rest_client_args(method, path, params, headers, payload)
-    url = url_for_path(path)
-    {
-        :method => method,
-        :url => url,
-        :headers => {:params => params}.merge(headers).merge(:accept => :json),
-        :open_timeout => 10,
-        :payload => payload.nil? ? nil : payload.to_json,
-        :timeout => 30,
-        :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
-        :ssl_ca_file => File.join(File.dirname(__FILE__), 'data/cacert.pem')
-    }
-  end
-
   def self.protocol #nodoc
     @protocol
   end

data/lib/intercom/message_thread.rb

@@ -54,6 +54,11 @@ module Intercom
       self.update_from_api_response(response)
     end
 
+    # @return [Message]
+    def mark_as_read!
+      Intercom::MessageThread.mark_as_read(:thread_id => thread_id, :email => email)
+    end
+
     # Set the content of the message for new message creation.
     # @param [String] body of the message. Supports markdown syntax
     # @return [String]

data/lib/intercom/request.rb

@@ -0,0 +1,89 @@
+require 'cgi'
+require 'net/https'
+
+module Intercom
+  class Request
+    attr_accessor :uri, :net_http_method
+
+    def initialize(uri, net_http_method)
+      set_common_headers(net_http_method, uri)
+
+      self.uri = uri
+      self.net_http_method = net_http_method
+    end
+
+    def set_common_headers(method, uri)
+      method.basic_auth(CGI.unescape(uri.user), CGI.unescape(uri.password))
+      method.add_field('Accept', 'application/json')
+      method.add_field('AcceptEncoding', 'gzip, deflate')
+    end
+
+    def self.get(url, params)
+      uri = URI.parse(url)
+      new(uri, Net::HTTP::Get.new(append_query_string_to_url(uri.path, params), default_headers))
+    end
+
+    def self.post(url, form_data)
+      uri = URI.parse(url)
+      new(uri, method_with_body(Net::HTTP::Post, uri, form_data))
+    end
+
+    def self.put(url, form_data)
+      uri = URI.parse(url)
+      new(uri, method_with_body(Net::HTTP::Put, uri, form_data))
+    end
+
+    def self.method_with_body(http_method, uri, params)
+      request = http_method.send(:new, uri.request_uri, default_headers)
+      request.body = params.to_json
+      request["Content-Type"] = "application/json"
+      request
+    end
+
+    def self.default_headers
+      {'Accept-Encoding' => 'gzip, deflate', 'Accept' => 'application/json'}
+    end
+
+    def client
+      net = Net::HTTP.new(uri.host, uri.port)
+      if uri.is_a?(URI::HTTPS)
+        net.use_ssl = uri.is_a?(URI::HTTPS)
+        net.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        net.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
+      end
+      net.read_timeout = 30
+      net.open_timeout = 10
+      net
+    end
+
+    def execute
+      client.start do |http|
+        response = http.request(net_http_method)
+        raise_errors_on_failure(response)
+        decoded = decode(response['content-encoding'], response.body)
+        JSON.parse(decoded)
+      end
+    end
+
+    def decode(content_encoding, body)
+      return body if (!body) || body.empty? || content_encoding != 'gzip'
+      Zlib::GzipReader.new(StringIO.new(body)).read
+    end
+
+    def raise_errors_on_failure(res)
+      if res.code.to_i.eql?(404)
+        raise Intercom::ResourceNotFound
+      elsif res.code.to_i.eql?(401)
+        raise Intercom::AuthenticationError
+      elsif res.code.to_i.eql?(500)
+        raise Intercom::ServerError
+      end
+    end
+
+    def self.append_query_string_to_url(url, params)
+      return url if params.empty?
+      query_string = params.map { |k, v| "#{k.to_s}=#{CGI::escape(v.to_s)}" }.join('&')
+      url + "?#{query_string}"
+    end
+  end
+end

data/lib/intercom/user.rb

@@ -20,7 +20,7 @@ module Intercom
   #    user = Intercom::User.find_by_email("bob@example.com")
   #    user.custom_data["number_of_applications"] = 11
   #    user.save
-class User < UserResource
+  class User < UserResource
     ##
     # Fetches an Intercom::User from our API.
     #
@@ -202,12 +202,12 @@ class User < UserResource
     end
 
     protected
-    def social_profiles=(social_profiles) #:nodoc:
-      @social_profiles = social_profiles.map { |account| SocialProfile.new(account) }.freeze
-    end
+      def social_profiles=(social_profiles) #:nodoc:
+        @social_profiles = social_profiles.map { |account| SocialProfile.new(account) }.freeze
+      end
 
-    def location_data=(hash) #:nodoc:
-      @location_data = hash.freeze
-    end
+      def location_data=(hash) #:nodoc:
+        @location_data = hash.freeze
+      end
   end
 end

data/lib/intercom/user_resource.rb

@@ -25,7 +25,6 @@ module Intercom
       @attributes["email"] = email
     end
 
-
     # @return [String] user_id
     def user_id
       @attributes["user_id"]
@@ -81,6 +80,5 @@ module Intercom
       missing = Array(required) - parameters.keys.map(&:to_s)
       raise ArgumentError.new("Missing required parameters (#{missing.join(', ')}).") unless missing.empty?
     end
-
   end
 end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/integration/intercom_api_integration_spec.rb

@@ -5,6 +5,12 @@ describe "api.intercom.io dummy data requests" do
   before :each do
     Intercom.app_id = "dummy-app-id"
     Intercom.api_key = "dummy-secret-key"
+    Intercom.protocol = "http"
+    Intercom.hostname = "intercom.dev"
+  end
+
+  it "should get all user" do
+    Intercom::User.all.count.must_be :>, 0
   end
 
   it "should get a user" do
@@ -27,6 +33,20 @@ describe "api.intercom.io dummy data requests" do
   end
 
   it "should find_all messages for a user" do
-    Intercom::MessageThread.find_all(:email => "somebody@example.com")
+    message_thread = Intercom::MessageThread.find_all(:email => "somebody@example.com").first
+    %w(thread_id read messages created_at updated_at created_by_user).each do |expected|
+      message_thread.send(expected).wont_be_nil
+    end
+  end
+
+  it "should mark message_thread as read" do
+    message_thread = Intercom::MessageThread.find_all(:email => "somebody@example.com").first
+    message_thread.mark_as_read!
+  end
+
+  it "should create some impression" do
+    impression = Intercom::Impression.create(:email => 'somebody@example.com')
+    impression.unread_messages.must_be :>, 0
+    impression.email.must_equal 'somebody@example.com'
   end
 end

data/spec/unit/intercom/user_spec.rb

@@ -52,15 +52,15 @@ describe "Intercom::User" do
     twitter.url.must_equal "http://twitter.com/abc"
     twitter.username.must_equal "abc"
     user.to_hash["social_profiles"].must_equal nil
-    proc { user.social_profiles << "a" }.must_raise RuntimeError, "can't modify frozen array"
-    proc { Intercom::User.new.social_profiles << "a" }.must_raise RuntimeError, "can't modify frozen array"
+    proc { user.social_profiles << "a" }.must_raise error_on_modify_frozen, "can't modify frozen array"
+    proc { Intercom::User.new.social_profiles << "a" }.must_raise error_on_modify_frozen, "can't modify frozen array"
   end
 
   it "has read-only location data" do
     Intercom::User.new.location_data.must_equal({})
     user = Intercom::User.new(:location_data => {"city" => "Dublin"})
     user.location_data.must_equal({"city" => "Dublin"})
-    proc { user.location_data["change"] = "123" }.must_raise RuntimeError, "can't modify frozen hash"
+    proc { user.location_data["change"] = "123" }.must_raise error_on_modify_frozen, "can't modify frozen hash"
     user.to_hash["location_data"].must_equal nil
   end
 

data/spec/unit/intercom_spec.rb

@@ -45,13 +45,13 @@ describe Intercom do
   end
 
   it "checks for email or user id" do
-    proc { Intercom.require_email_or_user_id("else") }.must_raise ArgumentError, "Expected params Hash, got String"
-    proc { Intercom.require_email_or_user_id(:something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
+    proc { Intercom.check_required_params("else") }.must_raise ArgumentError, "Expected params Hash, got String"
+    proc { Intercom.check_required_params(:something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
     proc { Intercom.get("messages", :something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
     proc { Intercom.put("messages", :something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
     proc { Intercom.post("messages", :something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
-    Intercom.require_email_or_user_id(:email => "bob@example.com", :something => "else")
-    Intercom.require_email_or_user_id("email" => "bob@example.com", :something => "else")
-    Intercom.require_email_or_user_id(:user_id => "123")
+    Intercom.check_required_params(:email => "bob@example.com", :something => "else")
+    Intercom.check_required_params("email" => "bob@example.com", :something => "else")
+    Intercom.check_required_params(:user_id => "123")
   end
 end

data/spec/unit/spec_helper.rb

@@ -87,6 +87,10 @@ def page_of_users(page=1, per_page=10)
   }
 end
 
+def error_on_modify_frozen
+  RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
+end
+
 def capture_exception(&block)
   begin
     block.call

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,33 +11,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: &70170925085820 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70170925085820
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &70170925084400 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70170925084400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70170925083440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +39,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170925083440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70170925082380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,7 +55,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170925082380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Intercom (https://www.intercom.io) is a customer relationship management
   and messaging tool for web app owners. This library wraps the api provided by Intercom.
   See http://docs.intercom.io/api for more details. '
@@ -69,8 +73,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
-- LICENSE
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - changes.txt
@@ -79,6 +84,7 @@ files:
 - lib/intercom.rb
 - lib/intercom/impression.rb
 - lib/intercom/message_thread.rb
+- lib/intercom/request.rb
 - lib/intercom/social_profile.rb
 - lib/intercom/unix_timestamp_unwrapper.rb
 - lib/intercom/user.rb
@@ -115,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for the Intercom API
@@ -129,4 +135,3 @@ test_files:
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom_spec.rb
 - spec/unit/spec_helper.rb
-has_rdoc: