intercom 0.1.1 → 0.1.2

data/{README.rdoc → README.md}

@@ -1,24 +1,29 @@
-Ruby bindings for the Intercom API (https://api.intercom.io). See http://docs.intercom.io/api for more details.
+# intercom-ruby
 
-Yardoc is available at http://rubydoc.info/github/intercom/intercom-ruby/master/frames
+Ruby bindings for the Intercom API (https://api.intercom.io).
 
-For generating Intercom javascript script tags, please see https://github.com/intercom/intercom-rails
+[API Documentation](https://api.intercom.io)
+
+[Gem Documentation](http://rubydoc.info/github/intercom/intercom-ruby/master/frames)
+
+For generating Intercom javascript script tags for Rails, please see https://github.com/intercom/intercom-rails
+
+## Installation
 
-== Installation
     gem install intercom
 
 Using bundler:
 
     gem 'intercom'
 
-== Basic Usage
+## Basic Usage
 
-=== Configure your access credentials
+### Configure your access credentials
 
     Intercom.app_id = "my_app_iddd"
     Intercom.api_key = "my-super-crazy-api-key"
 
-=== Resources
+### Resources
 
 The API supports:
 
@@ -27,9 +32,9 @@ The API supports:
     POST https://api.intercom.io/v1/users/impressions
     POST https://api.intercom.io/v1/users/notes
 
-=== Examples:
+### Examples
 
-==== Users
+#### Users
     user = Intercom::User.find_by_email("bob@example.com")
     user.custom_data["average_monthly_spend"] = 1234.56
     user.save
@@ -41,23 +46,31 @@ The API supports:
     Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
     Intercom::User.all.map {|user| user.email }
 
+#### Companies
+    user = Intercom::User.find_by_email("bob@example.com")
+    user.company = {:id => 6, :name => "Intercom"}
+    user.companies = [{:id => 6, :name => "Intercom"}, {:id => 9, :name => "Test Company"}]
+
+You can also pass custom data within a company:
+
+    user.company = {:id => 6, :name => "Intercom", :referral_source => "Google"}
 
-==== Messages
+#### Messages
 
     Intercom::Message.create(:email => "bob@example.com", :body => "Example message from bob@example.com to your application on Intercom.")
     Intercom::Message.find(:email => "bob@example.com", :thread_id => 123)
     Intercom::Message.find_all(:email => "bob@example.com")
     Intercom::Message.mark_as_read(:email => "bob@example.com", :thread_id => 123)
 
-==== Impressions
+#### Impressions
 
     Intercom::Impression.create(:email => "bob@example.com", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
 
-==== Notes
+#### Notes
 
     Intercom::Note.create(:email => "bob@example.com", :body => "This is the text of the note")
 
-=== Errors
+### Errors
 
     Intercom::AuthenticationError
     Intercom::ServerError

data/lib/intercom/user.rb

@@ -235,7 +235,7 @@ module Intercom
       @attributes["custom_data"] = FlatStore.new(custom_data)
     end
 
-    # Custom attributes stored for this Intercom::User
+    # Company stored for this Intercom::User
     #
     # See http://docs.intercom.io/#Companies for more information
     #
@@ -258,6 +258,29 @@ module Intercom
       @attributes["company"] = FlatStore.new(company)
     end
 
+    # Multiple companies for this Intercom::User
+    #
+    # See http://docs.intercom.io/#Companies for more information
+    #
+    # Example: Setting a company for an existing user
+    #  user = Intercom::User.find(:email => "someone@example.com")
+    #  user.companies = [{:id => 6, :name => "intercom"}, {:id => 9, :name => "Test Company"}]
+    #  user.save
+    #
+    # @return [Array]
+    def companies
+      @attributes["companies"] ||= []
+    end
+
+    # Set an {Array} of {Hash} company attributes to save/update on this user
+    #
+    # @param [Array] companies
+    # @return [Array]
+    def companies=(companies)
+      raise ArgumentError.new("Companies requires an array of hashes of companies") unless companies.is_a?(Array) && companies.all? {|company| company.is_a?(Hash)}
+      @attributes["companies"] = companies.collect {|company| FlatStore.new(company) }
+    end
+
     protected
       def social_profiles=(social_profiles) #:nodoc:
         @social_profiles = social_profiles.map { |account| SocialProfile.new(account) }.freeze

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/unit/intercom/user_spec.rb

@@ -81,6 +81,22 @@ describe "Intercom::User" do
     user.to_hash["company"].must_equal "name" => "Intercom", "id" => 6
   end
 
+  it "allows easy setting of multiple companies" do
+    user = Intercom::User.new()
+    companies = [
+      {"name" => "Intercom", "id" => "6"},
+      {"name" => "Test", "id" => "9"}
+    ]
+    user.companies = companies
+    user.to_hash["companies"].must_equal companies
+  end
+
+  it "rejects setting companies without an array of hashes" do
+    user = Intercom::User.new()
+    proc { user.companies = {"name" => "test"} }.must_raise ArgumentError
+    proc { user.companies = [ ["name", "test"] ]}.must_raise ArgumentError
+  end
+
   it "rejects nested data structures in custom_data" do
     user = Intercom::User.new()
     proc { user.custom_data["thing"] = [1] }.must_raise ArgumentError
@@ -111,6 +127,12 @@ describe "Intercom::User" do
     user.save
   end
 
+  it "saves a user with a companies" do
+    user = Intercom::User.new("email" => "jo@example.com", :user_id => "i-1224242", :companies => [{:id => 6, :name => "Intercom"}])
+    Intercom.expects(:post).with("/v1/users", {"email" => "jo@example.com", "user_id" => "i-1224242", "companies" => [{"id" => 6, "name" => "Intercom"}]}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
+    user.save
+  end
+
   it "deletes a user" do
     Intercom.expects(:delete).with("/v1/users", {"email" => "jo@example.com", "user_id" => "i-1224242"}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
     Intercom::User.delete("email" => "jo@example.com", "user_id" => "i-1224242")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,7 +80,7 @@ files:
 - .travis.yml
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - changes.txt
 - intercom.gemspec
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for the Intercom API