intercom 0.1.7 → 0.1.8

data/changes.txt

@@ -1,3 +1,6 @@
+0.1.8
+ - change tag response to match the new api response. add support to query users that are tagged with a specific tag
+
 0.1.7
  - add support for creating, updating, and fetching tags
 

data/lib/intercom/hashable_object.rb

@@ -0,0 +1,17 @@
+module Intercom
+  module HashableObject
+    def from_hash(hash)
+      hash.each do |key,value|
+        setter_method = "#{key.to_s}="
+        self.send(setter_method, value) if self.respond_to?(setter_method)
+      end
+    end
+
+    def to_hash
+      instance_variables.inject({}) do |hash, var|
+        hash[var.to_s.delete("@").to_sym] = instance_variable_get(var)
+        hash
+      end
+    end
+  end
+end

data/lib/intercom/requires_parameters.rb

@@ -0,0 +1,10 @@
+module Intercom
+  module RequiresParameters
+
+    def requires_parameters(parameters, required)
+      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/tag.rb

@@ -1,11 +1,12 @@
-require 'intercom/user_resource'
+require 'intercom/requires_parameters'
+require 'intercom/hashable_object'
 
 module Intercom
 
   ##
   # Represents a tag
   #
-  # A tag consists of a name, and (optionally) a color and users that you would like to tag.
+  # A tag consists of a name, and (optionally) a color and users that you would like to tag. Returns details about the tag and a count of the number of users currently tagged.
   #
   # == Examples
   #
@@ -27,17 +28,27 @@ module Intercom
   #  tag.tag_or_untag = "untag"
   #  tag.save
 
-  class Tag < UserResource
+  class Tag
+    extend RequiresParameters
+    include HashableObject
+
+    attr_accessor :name, :color, :user_ids, :emails, :tag_or_untag, :segment, :tagged_user_count, :id
 
     def initialize(attributes={})
-      @attributes = attributes
+      from_hash(attributes)
     end
 
     ##
     # Finds a Tag using params
     def self.find(params)
       response = Intercom.get("/v1/tags", params)
-      Tag.from_api(response)
+      from_api(response)
+    end
+
+    def self.from_api(api_response)
+      tag = Tag.new
+      tag.from_hash(api_response)
+      tag
     end
 
     ##
@@ -58,51 +69,8 @@ module Intercom
     # Saves a Tag on your application
     def save
       response = Intercom.post("/v1/tags", to_hash)
-      self.update_from_api_response(response)
+      self.from_hash(response)
+      self
     end
-
-    ##
-    # The name of the tag
-    def name=(name)
-      @attributes["name"] = name
-    end
-
-    ##
-    # The color of the tag
-    def color=(color)
-      @attributes["color"] = color
-    end
-
-    ##
-    # An array of user_ids of the users you'd like to tag or untag
-    def user_ids
-      @attributes["user_ids"] ||= []
-    end
-
-    ##
-    # An array of user_ids of the users you'd like to tag or untag
-    def emails
-      @attributes["emails"] ||= []
-    end
-
-    ##
-    # An array of user_ids of the users you'd like to tag or untag
-    def user_ids=(user_ids)
-      @attributes["user_ids"] = user_ids
-    end
-
-    ##
-    # An array of emails of the users you'd like to tag or untag
-    def emails=(emails)
-      @attributes["emails"] = emails
-    end
-
-    ##
-    # A string to specify whether to tag or untag the specified users, can be left out if only creating a new tag.
-    def tag_or_untag=(tag_or_untag)
-      return unless ["tag", "untag"].include?(tag_or_untag)
-      @attributes["tag_or_untag"] = tag_or_untag
-    end
-
   end
 end

data/lib/intercom/user.rb

@@ -21,6 +21,8 @@ module Intercom
   #    user.custom_data["number_of_applications"] = 11
   #    user.save
   class User < UserResource
+
+
     ##
     # Fetches an Intercom::User from our API.
     #
@@ -80,6 +82,22 @@ module Intercom
       UserCollectionProxy.new
     end
 
+    # Retrieve all the users that match a query
+    # Examples:
+    #   Intercom::User.where(:tag_name => 'Free Trial').each do |user|
+    #     puts user.inspect
+    #   end
+    #     > ["user1@example.com" ,"user2@example.com" ,....]
+    #   Intercom::User.where(:tag_name => 'Free Trial').map(&:email)
+    #     > ["user1@example.com" ,"user2@example.com" ,....]
+    #
+    # Currently only supports tag_name and tag_id querying
+    #
+    # @return [UserCollectionProxy]
+    def self.where(params)
+      UserCollectionProxy.new(params)
+    end
+
     # Fetches a count of all Users tracked on Intercom.
     # Example:
     #   Intercom::User.all.count

data/lib/intercom/user_collection_proxy.rb

@@ -14,13 +14,22 @@ module Intercom
   #    end
   #
   class UserCollectionProxy
+
+    QUERYABLE_ATTRIBUTES = [:tag_id, :tag_name]
+
+    attr_accessor :query
+
+    def initialize(attributes={})
+      self.query = attributes.reject{ |key, value| !QUERYABLE_ATTRIBUTES.include?(key) }
+    end
+
     # yields each {User} to the block provided
     # @return [void]
     def each(&block)
       page = 1
       fetch_another_page = true
       while fetch_another_page
-        current_page = Intercom.get("/v1/users", {:page => page})
+        current_page = Intercom.get("/v1/users", query.merge({:page => page}))
         current_page["users"].each do |user|
           block.call User.from_api(user)
         end

data/lib/intercom/user_resource.rb

@@ -1,8 +1,10 @@
 require 'intercom/unix_timestamp_unwrapper'
+require 'intercom/requires_parameters'
 
 module Intercom
   # Base class for resources tied off a {User}, all of which are scoped by either the users :email or :user_id.
   class UserResource
+    extend RequiresParameters
     include UnixTimestampUnwrapper
 
     def initialize(attributes={})
@@ -76,10 +78,5 @@ module Intercom
       return @attributes[method.to_s] if @attributes.has_key?(method.to_s)
       super
     end
-
-    def self.requires_parameters(parameters, required)
-      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.1.7"
+  VERSION = "0.1.8"
 end

data/spec/spec_helper.rb

@@ -90,12 +90,11 @@ end
 
 def test_tag
   {
+    "id" => "4f73428b5e4dfc000b000112",
     "name" => "Test Tag",
     "color" => "red",
-    "users" => [
-      {"email" => "bob@example.com", "user_id" => "abc123"},
-      {"email" => "tom@example.com", "user_id" => "def456"}
-    ]
+    "segment" => false,
+    "tagged_user_count" => 2
   }
 end
 

data/spec/unit/intercom/tag_spec.rb

@@ -27,6 +27,7 @@ describe "Intercom::Tag" do
     tag = Intercom::Tag.create(:name => "Test Tag", :color => "red", :user_ids => ["abc123", "def456"], :tag_or_untag => "tag")
     tag.name.must_equal "Test Tag"
     tag.color.must_equal "red"
-    tag.users.must_equal [{"email" => "bob@example.com", "user_id" => "abc123"}, {"email" => "tom@example.com", "user_id" => "def456"}]
+    tag.tagged_user_count.must_equal 2
   end
+
 end

data/spec/unit/intercom/user_collection_proxy_spec.rb

@@ -12,6 +12,20 @@ describe Intercom::UserCollectionProxy do
     emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
   end
 
+  it "supports querying for tagged users" do
+    Intercom.expects(:get).with("/v1/users", {:tag_id => "1234", :page => 1}).returns(page_of_users)
+    emails = []
+    Intercom::User.where(:tag_id => '1234').each { |user| emails << user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "should only pass whitelisted attributes to collection query" do
+    Intercom.expects(:get).with("/v1/users", {:tag_name => '1234', :page => 1}).returns(page_of_users)
+    emails = []
+    Intercom::User.where(:danger_zone => 'BOOM', :tag_name => '1234').each { |user| emails << user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
   it "supports map" do
     Intercom.expects(:get).with("/v1/users", {:page => 1}).returns(page_of_users).twice
     Intercom::User.all.map { |user| user.email }.must_equal %W(user1@example.com user2@example.com user3@example.com)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -87,10 +87,12 @@ files:
 - lib/data/cacert.pem
 - lib/intercom.rb
 - lib/intercom/flat_store.rb
+- lib/intercom/hashable_object.rb
 - lib/intercom/impression.rb
 - lib/intercom/message_thread.rb
 - lib/intercom/note.rb
 - lib/intercom/request.rb
+- lib/intercom/requires_parameters.rb
 - lib/intercom/social_profile.rb
 - lib/intercom/tag.rb
 - lib/intercom/unix_timestamp_unwrapper.rb