intercom 0.0.2 → 0.0.3

data/.gitignore

@@ -4,5 +4,6 @@
 Gemfile.lock
 pkg/*
 .rakeTasks
+.yardoc
 spike.rb
 html

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011- Intercom App, 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,35 +1,57 @@
 Ruby bindings for the Intercom API (https://api.intercom.io). See http://docs.intercom.io/api for more details
 
+## Install
+```
+gem install intercom
+```
+
 ## Basic Usage
 
 ### Configure your access credentials
 
 ```
-Intercom.app_id = "my_app_id"
-Intercom.secret_key = "my-super-crazy-secret"
+Intercom.app_id = "my_app_iddd"
+Intercom.api_key = "my-super-crazy-api-key"
 ```
 
 ### Resources
 
-All methods in this API operate in the context of a single user. Users are identified by either an '''email''' address or a '''user_id'''.
-One of these is required as input to every operation.
+The API supports:
+
+```
+POST,PUT,GET https://api.intercom.io/v1/users
+POST,PUT,GET https://api.intercom.io/v1/users/messages
+POST https://api.intercom.io/v1/users/impressions
+```
 
 #### Users
 
+```ruby
 user = Intercom::User.find(:email => "bob@example.com")
 user = Intercom::User.create(params)
 user = Intercom::User.new(params)
 user.save
+```
 
 #### Messages
 
+```ruby
 Intercom::Message.create
 Intercom::Message.find
 Intercom::Message.find_all
 Intercom::Message.mark_as_read
+```
 
 #### Impressions
 
+```ruby
 Intercom::Impression.create
+```
 
 ### Errors
+
+```ruby
+Intercom::AuthenticationError
+Intercom::ServerError
+Intercom::ResourceNotFound
+```

data/changed.txt

@@ -0,0 +1,8 @@
+0.0.3
+ - renamed Intercom.secret_key to Intercom.api_key for consistency throughout our app and docs
+
+0.0.2
+ - updates to reflect changes to resources served by the api
+
+0.0.1
+ - experimental version

data/intercom.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   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 is a customer relationship management and messaging tool for web app owners. See https://www.intercom.io for more details.}
+  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. }
 
   s.rubyforge_project = "intercom"
 

data/lib/intercom.rb

@@ -14,7 +14,7 @@ require "json"
 # == Basic Usage
 # === Configure Intercom with your access credentials
 #   Intercom.app_id = "my_app_id"
-#   Intercom.secret_key = "my_secret_key"
+#   Intercom.api_key = "my_api_key"
 # === Make requests to the API
 #   Intercom::User.find(:email => "bob@example.com")
 #
@@ -22,7 +22,7 @@ module Intercom
   @hostname = "api.intercom.io"
   @protocol = "https"
   @app_id = nil
-  @secret_key = nil
+  @api_key = nil
 
   ##
   # Set the id of the application you want to interact with.
@@ -32,17 +32,17 @@ module Intercom
   end
 
   ##
-  # Set the secret key to gain access to your application data.
+  # Set the api key to gain access to your application data.
   # When logged into your intercom console, you can view/create api keys in the settings menu
-  def self.secret_key=(secret_key)
-    @secret_key = secret_key
+  def self.api_key=(api_key)
+    @api_key = api_key
   end
 
 
   private
   def self.url_for_path(path)
-    raise ArgumentError, "You must set both Intercom.app_id and Intercom.secret_key to use this client. See https://github.com/intercom/intercom for usage examples." if [@app_id, @secret_key].any?(&:nil?)
-    "#{protocol}://#{@app_id}:#{@secret_key}@#{hostname}/v1/#{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?)
+    "#{protocol}://#{@app_id}:#{@api_key}@#{hostname}/v1/#{path}"
   end
 
   def self.post(path, payload_hash)
@@ -107,6 +107,9 @@ module Intercom
     @hostname = override
   end
 
+  #
+  # Raised when the credentials you provide don't match a valid account on Intercom.
+  # Check that you have set <b>Intercom.app_id=</b> and <b>Intercom.api_key=</b> correctly.
   class AuthenticationError < StandardError;
   end
 

data/lib/intercom/impression.rb

@@ -4,42 +4,56 @@ module Intercom
 
   ##
   # Represents a users interaction with your app (eg page view, or using a particular feature)
+  #
+  # An impressions contains user_ip, user_agent and location.
+  #
+  #  impression = Intercom::Impression.create(:email => "person@example.com", :location => "/pricing/upgrade",
+  #                                           :user_ip => '1.2.3.4', :user_agent => "my-service-iphone-app-1.2")
+  # The impression response will contain {#unread_messages}
+  #  impression.unread_messages
+  # You can also create an impression and save it like this:
+  #  impression = Intercom::Impression.new
+  #  impression.email = "person@example.com"
+  #  impression.location = "person@example.com"
+  #  ....
+  #  impression.save
   class Impression < UserResource
     ##
-    # Records that a user has interacted with your application, including the 'location' within the app they used
+    # Creates a new Impression using params and saves it
+    # @see #save
     def self.create(params)
       Impression.new(params).save
     end
 
+    ##
+    # Records that a user has interacted with your application, including the 'location' within the app they used
     def save
       response = Intercom.post("users/impressions", to_hash)
       self.update_from_api_response(response)
     end
 
+    ##
+    # Set the ip address of the user for this impression
     def user_ip=(user_ip)
       @attributes["user_ip"] = user_ip
     end
 
-    def user_ip
-      @attributes["user_ip"]
-    end
-
+    ##
+    # Set the location in your application that this impression occurred. E.g. the url in a web app, or perhaps the screen in a desktop  or phone application.
     def location=(location)
       @attributes["location"] = location
     end
 
-    def location
-      @attributes["location"]
-    end
-
+    ##
+    # Set the user agent of the user this impression (E.g. their browser user agent, or the name and version of a desktop or phone application)
     def user_agent=(user_agent)
       @attributes["user_agent"] = user_agent
     end
 
-    def user_agent
-      @attributes["user_agent"]
-    end
-
+    ##
+    # For convenience, after saving, the unread_messages count will be updated with the number of unread messages for the user for their current location.
+    #
+    # Remember, Auto Messages (http://docs.intercom.io/#AutoMessages) can be targeted to only show when a user views a particular page in your application.
     def unread_messages
       @attributes["unread_messages"]
     end

data/lib/intercom/message_thread.rb

@@ -58,7 +58,6 @@ module Intercom
       time_at("updated_at")
     end
 
-
     def thread_id=(thread_id)
       @attributes["thread_id"] = thread_id
     end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/integration/intercom_api_integration_spec.rb

@@ -4,7 +4,7 @@ require 'minitest/autorun'
 describe "api.intercom.io dummy data requests" do
   before :each do
     Intercom.app_id = "dummy-app-id"
-    Intercom.secret_key = "dummy-secret-key"
+    Intercom.api_key = "dummy-secret-key"
   end
 
   it "should get a user" do
@@ -22,7 +22,11 @@ describe "api.intercom.io dummy data requests" do
 
   it "authentication failure with bad api key" do
     Intercom.app_id = "bad-app-id"
-    Intercom.secret_key = "bad-secret-key"
+    Intercom.api_key = "bad-secret-key"
     proc { Intercom::User.find(:email => "not-found@example.com") }.must_raise Intercom::AuthenticationError
   end
+
+  it "should find_all messages for a user" do
+    Intercom::MessageThread.find_all(:email => "somebody@example.com")
+  end
 end

data/spec/unit/intercom_spec.rb

@@ -8,13 +8,13 @@ describe Intercom do
   describe "API" do
     before do
       Intercom.app_id = "abc123"
-      Intercom.secret_key = "super-secret-key"
+      Intercom.api_key = "super-secret-key"
     end
 
-    it "raises ArgumentError if no app_id or secret_key specified" do
+    it "raises ArgumentError if no app_id or api_key specified" do
       Intercom.app_id = nil
-      Intercom.secret_key = nil
-      proc { Intercom.url_for_path("something") }.must_raise ArgumentError, "You must set both Intercom.app_id and Intercom.secret_key to use this client. See https://github.com/intercom/intercom-ruby for usage examples."
+      Intercom.api_key = nil
+      proc { Intercom.url_for_path("something") }.must_raise ArgumentError, "You must set both Intercom.app_id and Intercom.api_key to use this client. See https://github.com/intercom/intercom-ruby for usage examples."
     end
 
     it "defaults to https to api.intercom.io" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000Z
+date: 2012-03-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70093820212260 !ruby/object:Gem::Requirement
+  requirement: &70197574767120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70093820212260
+  version_requirements: *70197574767120
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70093820211560 !ruby/object:Gem::Requirement
+  requirement: &70197574748440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093820211560
+  version_requirements: *70197574748440
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70093820202300 !ruby/object:Gem::Requirement
+  requirement: &70197574686840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093820202300
+  version_requirements: *70197574686840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70093820198940 !ruby/object:Gem::Requirement
+  requirement: &70197570625140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093820198940
+  version_requirements: *70197570625140
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70093820196440 !ruby/object:Gem::Requirement
+  requirement: &70197570614200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,9 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093820196440
-description: Intercom is a customer relationship management and messaging tool for
-  web app owners. See https://www.intercom.io for more details.
+  version_requirements: *70197570614200
+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. '
 email:
 - ben@intercom.io
 - ciaran@intercom.io
@@ -80,9 +81,11 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - README.rdoc
 - Rakefile
+- changed.txt
 - intercom.gemspec
 - lib/data/cacert.pem
 - lib/intercom.rb