intercom 1.0.0 → 2.0.0

data/lib/intercom/requires_parameters.rb

@@ -1,10 +0,0 @@
-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/social_profile.rb

@@ -1,24 +0,0 @@
-require 'intercom/user_resource'
-
-module Intercom
-  # object representing a social profile for the User (see )http://docs.intercom.io/#SocialProfiles).
-  # Read only part of the {User} object
-  class SocialProfile
-    # @return  [String] type e.g. twitter, facebook etc.
-    attr_reader :type
-    # @return  [String] id
-    attr_reader :id
-    # @return  [String] url
-    attr_reader :url
-    # @return [String] username
-    attr_reader :username
-
-    # @private
-    def initialize(params)
-      @type = params["type"]
-      @id = params["id"]
-      @url = params["url"]
-      @username = params["username"]
-    end
-  end
-end

data/lib/intercom/unix_timestamp_unwrapper.rb

@@ -1,12 +0,0 @@
-module Intercom
-  # Our api returns date as unix time stamps. This module helps marshall to and from {Time} objects.
-  module UnixTimestampUnwrapper
-    def time_at(attribute_name)
-      Time.at(@attributes[attribute_name]) if @attributes[attribute_name]
-    end
-
-    def set_time_at(attribute_name, time)
-      @attributes[attribute_name.to_s] = (time.nil?) ? nil : time.to_i
-    end
-  end
-end

data/lib/intercom/user_collection_proxy.rb

@@ -1,52 +0,0 @@
-require 'intercom/user_resource'
-require 'intercom/flat_store'
-require 'intercom/social_profile'
-
-module Intercom
-  # A collection of your Users from Intercom
-  # Uses the paginated users api under the covers (http://docs.intercom.io/api#getting_all_users)
-  #
-  # == Examples:
-  #
-  # Iterating over each user
-  #    Intercom::User.all.each do |user|
-  #      puts user.inspect
-  #    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", query.merge({:page => page}))
-        current_page["users"].each do |user|
-          block.call User.from_api(user)
-        end
-        page = page + 1
-        fetch_another_page = !current_page["next_page"].nil?
-      end
-    end
-
-    include Enumerable
-
-    # This method exists as an optimisation of Enumerable#count,
-    # which would potentially fetch multiple pages of users.
-    def count(item=nil) #:nodoc:
-      return super unless item.nil?
-      return super if block_given?
-
-      Intercom::User.count
-    end
-  end
-end

data/lib/intercom/user_resource.rb

@@ -1,82 +0,0 @@
-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={})
-      self.attributes = attributes
-    end
-
-    # @return [Hash] hash of all the attributes in the structure they will be sent to the api
-    def to_hash
-      UserResource.for_wire(@attributes)
-    end
-
-    # @return [String] email address
-    def email
-      @attributes["email"]
-    end
-
-    # @param [String] email
-    # @return [String]
-    def email=(email)
-      @attributes["email"] = email
-    end
-
-    # @return [String] user_id
-    def user_id
-      @attributes["user_id"]
-    end
-
-    # @param [String] user_id
-    # @return [String]
-    def user_id=(user_id)
-      @attributes["user_id"] = user_id
-    end
-
-    # updates the internal state of this {UserResource} based on the response from the API
-    # @return [UserResource] self
-    def update_from_api_response(api_response)
-      api_response.each do |key, value|
-        setter_method = "#{key.to_s}="
-        if self.respond_to?(setter_method, true)
-          self.send(setter_method, value)
-        else
-          @attributes[key.to_s] = value
-        end
-      end
-      self
-    end
-
-    private
-
-    def attributes=(attributes={})
-      @attributes = {}
-      (attributes || {}).each do |key, value|
-        self.send("#{key.to_s}=", value)
-      end
-    end
-
-    def self.for_wire(object)
-      return object.for_wire if object.respond_to?(:for_wire)
-      return object.map { |item| for_wire(item) } if object.is_a?(Array)
-      return object.inject({}) { |result, (k, value)| result[k] = for_wire(value); result } if object.is_a?(Hash)
-      return object.to_i if object.is_a?(Time)
-      object
-    end
-
-    def self.from_api(api_response)
-      obj = self.new
-      obj.update_from_api_response(api_response)
-    end
-
-    def method_missing(method, *args, &block)
-      return @attributes[method.to_s] if @attributes.has_key?(method.to_s)
-      super
-    end
-  end
-end

data/spec/integration/fixtures/v1-user.json

@@ -1,45 +0,0 @@
-{
-  "intercom_id": "528f291df8d4a41d8c000088",
-  "email": "somebody@example.com",
-  "user_id": "123",
-  "name": "Somebody",
-  "created_at": 1270000000,
-  "last_impression_at": 1300000000,
-  "custom_data": {
-    "app_name": "Genesis",
-    "monthly_spend": 155.5,
-    "team_mates": 7
-  },
-  "social_profiles": [
-    {
-      "type": "twitter",
-      "url": "http://twitter.com/abc",
-      "username": "abc"
-    },
-    {
-      "type": "facebook",
-      "url": "http://facebook.com/vanity",
-      "username": "vanity",
-      "id": "13241141441141413"
-    }
-  ],
-  "location_data": {
-    "city_name": "Santiago",
-    "continent_code": "SA",
-    "country_name": "Chile",
-    "latitude": -33.44999999999999,
-    "longitude": -70.6667,
-    "postal_code": "",
-    "region_name": "12",
-    "timezone": "Chile/Continental",
-    "country_code": "CHL"
-  },
-  "session_count": 0,
-  "last_seen_ip": "127.0.0.1",
-  "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
-  "unsubscribed_from_emails": false,
-  "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
-  "company_ids": [
-
-  ]
-}

data/spec/integration/fixtures/v1-users-impression.json

@@ -1,3 +0,0 @@
-{
-  "unread_messages": 1
-}

data/spec/integration/fixtures/v1-users-message_thread.json

@@ -1,44 +0,0 @@
-{
-  "created_at": 1385114541,
-  "updated_at": 1385028141,
-  "read": true,
-  "created_by_user": true,
-  "thread_id": 5591,
-  "message_id": 5591,
-  "message_type": "conversation",
-  "interrupt": true,
-  "messages": [
-    {
-      "created_at": 1385114541,
-      "url": null,
-      "html": "<p>Hey Intercom, What is up?</p>\n\n<p></p>",
-      "subject": "",
-      "from": {
-        "email": "bob@example.com",
-        "user_id": "456",
-        "name": "Bob",
-        "is_admin": false,
-        "avatar": {
-        }
-      }
-    },
-    {
-      "created_at": 1384941741,
-      "url": null,
-      "html": "<p>Not much, you?\n</p>"
-    },
-    {
-      "created_at": 1385028141,
-      "url": null,
-      "html": "<p>Not much either :(</p>\n\n<p></p>",
-      "from": {
-        "email": "bob@example.com",
-        "user_id": "123",
-        "name": "Bob",
-        "is_admin": false,
-        "avatar": {
-        }
-      }
-    }
-  ]
-}

data/spec/integration/fixtures/v1-users-message_threads.json

@@ -1,46 +0,0 @@
-[
-  {
-    "created_at": 1385114400,
-    "updated_at": 1385028000,
-    "read": true,
-    "created_by_user": true,
-    "thread_id": 5591,
-    "message_id": 5591,
-    "message_type": "conversation",
-    "interrupt": true,
-    "messages": [
-      {
-        "created_at": 1385114400,
-        "url": null,
-        "html": "<p>Hey Intercom, What is up?</p>\n\n<p></p>",
-        "subject": "",
-        "from": {
-          "email": "somebody@example.com",
-          "user_id": "123",
-          "name": "Somebody",
-          "is_admin": false,
-          "avatar": {
-          }
-        }
-      },
-      {
-        "created_at": 1384941600,
-        "url": null,
-        "html": "<p>Not much, you?\n</p>"
-      },
-      {
-        "created_at": 1385028000,
-        "url": null,
-        "html": "<p>Not much either :(</p>\n\n<p></p>",
-        "from": {
-          "email": "somebody@example.com",
-          "user_id": "123",
-          "name": "Somebody",
-          "is_admin": false,
-          "avatar": {
-          }
-        }
-      }
-    ]
-  }
-]

data/spec/integration/fixtures/v1-users-note.json

@@ -1,49 +0,0 @@
-{
-  "html": "<p>This is a note</p>",
-  "created_at": null,
-  "user": {
-    "intercom_id": "528f2cbb1b393a6e470000e6",
-    "email": "somebody@example.com",
-    "user_id": "123",
-    "name": "Somebody",
-    "created_at": 1270000000,
-    "last_impression_at": 1300000000,
-    "custom_data": {
-      "app_name": "Genesis",
-      "monthly_spend": 155.5,
-      "team_mates": 7
-    },
-    "social_profiles": [
-      {
-        "type": "twitter",
-        "url": "http://twitter.com/abc",
-        "username": "abc"
-      },
-      {
-        "type": "facebook",
-        "url": "http://facebook.com/vanity",
-        "username": "vanity",
-        "id": "13241141441141413"
-      }
-    ],
-    "location_data": {
-      "city_name": "Santiago",
-      "continent_code": "SA",
-      "country_name": "Chile",
-      "latitude": -33.44999999999999,
-      "longitude": -70.6667,
-      "postal_code": "",
-      "region_name": "12",
-      "timezone": "Chile/Continental",
-      "country_code": "CHL"
-    },
-    "session_count": 0,
-    "last_seen_ip": "127.0.0.1",
-    "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
-    "unsubscribed_from_emails": false,
-    "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
-    "company_ids": [
-
-    ]
-  }
-}

data/spec/integration/fixtures/v1-users.json

@@ -1,144 +0,0 @@
-{
-  "users": [
-    {
-      "intercom_id": "528f27c330972d783600006d",
-      "email": "first.user@example.com",
-      "user_id": "123",
-      "name": "First User",
-      "created_at": 1270000000,
-      "last_impression_at": 1300000000,
-      "custom_data": {
-        "app_name": "Genesis",
-        "monthly_spend": 155.5,
-        "team_mates": 7
-      },
-      "social_profiles": [
-        {
-          "type": "twitter",
-          "url": "http://twitter.com/abc",
-          "username": "abc"
-        },
-        {
-          "type": "facebook",
-          "url": "http://facebook.com/vanity",
-          "username": "vanity",
-          "id": "13241141441141413"
-        }
-      ],
-      "location_data": {
-        "city_name": "Santiago",
-        "continent_code": "SA",
-        "country_name": "Chile",
-        "latitude": -33.44999999999999,
-        "longitude": -70.6667,
-        "postal_code": "",
-        "region_name": "12",
-        "timezone": "Chile/Continental",
-        "country_code": "CHL"
-      },
-      "session_count": 0,
-      "last_seen_ip": "127.0.0.1",
-      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
-      "unsubscribed_from_emails": false,
-      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
-      "company_ids": [
-
-      ]
-    },
-    {
-      "intercom_id": "528f27c330972d7836000070",
-      "email": "second.user@example.com",
-      "user_id": "123",
-      "name": "Second User",
-      "created_at": 1270000000,
-      "last_impression_at": 1300000000,
-      "custom_data": {
-        "app_name": "Genesis",
-        "monthly_spend": 155.5,
-        "team_mates": 7
-      },
-      "social_profiles": [
-        {
-          "type": "twitter",
-          "url": "http://twitter.com/abc",
-          "username": "abc"
-        },
-        {
-          "type": "facebook",
-          "url": "http://facebook.com/vanity",
-          "username": "vanity",
-          "id": "13241141441141413"
-        }
-      ],
-      "location_data": {
-        "city_name": "Santiago",
-        "continent_code": "SA",
-        "country_name": "Chile",
-        "latitude": -33.44999999999999,
-        "longitude": -70.6667,
-        "postal_code": "",
-        "region_name": "12",
-        "timezone": "Chile/Continental",
-        "country_code": "CHL"
-      },
-      "session_count": 0,
-      "last_seen_ip": "127.0.0.1",
-      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
-      "unsubscribed_from_emails": false,
-      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
-      "company_ids": [
-
-      ]
-    },
-    {
-      "intercom_id": "528f27c330972d7836000073",
-      "email": "third.user@example.com",
-      "user_id": "123",
-      "name": "Third User",
-      "created_at": 1270000000,
-      "last_impression_at": 1300000000,
-      "custom_data": {
-        "app_name": "Genesis",
-        "monthly_spend": 155.5,
-        "team_mates": 7
-      },
-      "social_profiles": [
-        {
-          "type": "twitter",
-          "url": "http://twitter.com/abc",
-          "username": "abc"
-        },
-        {
-          "type": "facebook",
-          "url": "http://facebook.com/vanity",
-          "username": "vanity",
-          "id": "13241141441141413"
-        }
-      ],
-      "location_data": {
-        "city_name": "Santiago",
-        "continent_code": "SA",
-        "country_name": "Chile",
-        "latitude": -33.44999999999999,
-        "longitude": -70.6667,
-        "postal_code": "",
-        "region_name": "12",
-        "timezone": "Chile/Continental",
-        "country_code": "CHL"
-      },
-      "session_count": 0,
-      "last_seen_ip": "127.0.0.1",
-      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
-      "unsubscribed_from_emails": false,
-      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
-      "company_ids": [
-
-      ]
-    }
-  ],
-  "total_count": 3,
-  "page": 1,
-  "next_page": null,
-  "previous_page": null,
-  "total_pages": 1
-}