helpscout 0.0.3.alpha

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.1.3"
+  gem "jeweler", "~> 1.8.4"
+  gem "httparty"
+  gem 'simplecov', :require => false 
+  gem "reek", "~> 1.2.8"
+  gem "rdoc" 
+end
+
+gem "httparty"

data/README.markdown

@@ -0,0 +1,40 @@
+# Helpscout Developers API gem
+
+This gem is in alpha.
+
+## Usage
+
+1. Follow the instructions at [Help Scout's Developers site](http://developer.helpscout.net/) to generate an API key.
+
+2. Initialize your HelpScout client
+
+```ruby
+HelpScout::Base.load!(HELPSCOUT_API_KEY)
+```
+
+#### Fetching Users
+
+```ruby
+users = HelpScout::Base.users
+```
+
+#### Fetching Mailboxes
+
+```ruby
+mailboxes = HelpScout::Base.mailboxes
+```
+
+#### Fetching Customers
+
+```ruby
+customers = HelpScout::Base.customers
+```
+
+#### Fetching Conversations
+
+To fetch active conversations:
+
+```ruby
+conversations = HelpScout::Base.conversations(mailboxId, "active", nil)
+```
+

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'base64'
+require 'simplecov'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "helpscout"
+  gem.homepage = "http://github.com/hramos/helpscout"
+  gem.license = "MIT"
+  gem.summary = %Q{HelpScout API Wrapper}
+  gem.description = %Q{}
+  gem.email = Base64.decode64("aGVjdG9yQGhlY3RvcnJhbW9zLmNvbQ==\n")
+  gem.authors = ["Héctor Ramos"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+SimpleCov.start
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "helpscout #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3.alpha

data/helpscout.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "helpscout"
+  s.version = "0.0.3.alpha"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["H\u{e9}ctor Ramos"]
+  s.date = "2012-08-14"
+  s.description = ""
+  s.email = "hector@hectorramos.com"
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "helpscout.gemspec",
+    "lib/helpscout.rb",
+    "lib/helpscout/base.rb",
+    "lib/helpscout/models.rb"
+  ]
+  s.homepage = "http://github.com/hramos/helpscout"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "HelpScout API Wrapper"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/lib/helpscout.rb

@@ -0,0 +1,6 @@
+require 'helpscout/models.rb'
+require 'helpscout/base.rb'
+
+module HelpScout
+
+end

data/lib/helpscout/base.rb

@@ -0,0 +1,270 @@
+require "date"
+require "httparty"
+require "helpscout/models"
+require "erb"
+
+module HelpScout
+  class Base
+    include HTTParty
+    base_uri 'https://api.helpscout.net/v1'
+
+    def initialize(key=nil)
+      Base.settings
+
+      if key.nil?
+        key = @@settings["api_key"]
+      end
+
+      @auth = { :username => key, :password => "X" }
+      @users = []
+      @mailboxes = []
+    end
+
+    @@settings ||= nil
+
+    def self.load!(api_key)
+      @auth = { :username => api_key, :password => "X" }
+      @users = []
+      @mailboxes = []
+      @@settings = {"api_key" => api_key}
+    end
+
+    def self.settings
+      if @@settings.nil?
+        path = "config/helpscout.yml"
+        @@settings = YAML.load(ERB.new(File.new(path).read).result)
+        @auth = { :username => @@settings["api_key"], :password => "X" }
+      end
+      @@settings
+    end
+
+    def self.parametrizedUrl(url, params={})
+      return url unless params
+
+      complete_url = url
+
+      parameterString = ""
+
+      params.each do |k,v|
+        if parameterString.length > 0
+          parameterString << "&"
+        else
+          parameterString << "?"
+        end
+        parameterString << "#{k}=#{v}"
+      end
+
+      if parameterString.length > 0
+        complete_url << parameterString
+      end
+      complete_url
+    end
+
+    def self.requestItem(url, params={})
+      item = nil
+      complete_url = Base.parametrizedUrl(url, params)
+
+      response = Base.get(complete_url, {:basic_auth => @auth})
+
+      if 200 <= response.code && response.code < 300
+        envelope = SingleItemEnvelope.new(response)
+        if envelope.item
+          item = envelope.item
+        end
+      elsif 400 <= response.code && response.code < 500
+        if response["message"]
+          envelope = ErrorEnvelope.new(response)
+          raise StandardError, envelope.message
+        else
+          raise StandardError, response["error"]
+        end
+      else
+        raise StandardError, "Server Response: #{response.code}"
+      end
+
+      item
+    end
+
+    def self.requestItems(url, params={})
+      items = []
+      complete_url = Base.parametrizedUrl(url, params)
+
+      response = Base.get(complete_url, {:basic_auth => @auth})
+
+      if 200 <= response.code && response.code < 300
+        envelope = CollectionsEnvelope.new(response)
+        if envelope.items
+          envelope.items.each do |item|
+            items << item
+          end
+        end
+
+        if envelope.page < envelope.pages
+          params[:page] = envelope.page + 1
+          items << Base.requestItems(url, params)
+        end
+      elsif 400 <= response.code && response.code < 500
+        if response["message"]
+          envelope = ErrorEnvelope.new(response)
+          raise StandardError, envelope.message
+        else
+          raise StandardError, response["error"]
+        end
+      else
+        raise StandardError, "Server Response: #{response.code}"
+      end
+
+      items
+    end
+    
+    def self.user(userId)
+      url = "/users/#{userId}.json"
+      item = Base.requestItem(url, nil)
+      user = nil
+      if item
+        user = User.new(item)
+      end
+      user
+    end
+
+    def self.users
+      url = "/users.json"
+      items = Base.requestItems(url, :page => 1)
+      @users = []
+      items.each do |item|
+        @users << User.new(item)
+      end
+      @users
+    end
+
+    def self.usersInMailbox(mailboxId)
+      url ="/mailboxes/#{mailboxId}/users.json"
+      items = Base.requestItems(url, :page => 1)
+      users = []
+      items.each do |item|
+        users << User.new(item)
+      end
+      users
+    end
+
+    def self.mailboxes
+      url = "/mailboxes.json"
+      @mailboxes = []
+      begin
+        items = Base.requestItems(url, {})
+        items.each do |item|
+          @mailboxes << Mailbox.new(item)
+        end
+      rescue StandardError => e
+        print "Request failed: " + e.message
+      end
+      @mailboxes
+    end
+
+    def self.foldersInMailbox(mailboxId)
+      url ="/mailboxes/#{mailboxId}/folders.json"
+      items = Base.requestItems(url, :page => 1)
+      folders = []
+      items.each do |item|
+        folders << Mailbox::Folder.new(item)
+      end
+      folders
+    end
+
+    def self.conversation(conversationId)
+      url = "/conversations/#{conversationId}.json"
+      item = Base.requestItem(url, nil)
+      conversation = nil
+      if item
+        conversation = Conversation.new(item)
+      end
+      conversation
+    end
+
+
+    CONVERSATION_STATUS_ACTIVE = "active"
+    CONVERSATION_STATUS_ALL = "all"
+    CONVERSATION_STATUS_PENDING = "pending"
+
+    def self.conversations(mailboxId, status, modifiedSince)
+      url = "/mailboxes/#{mailboxId}/conversations.json"
+
+      options = {}
+      if status
+        options["status"] = status
+      end
+      if modifiedSince
+        # TODO: Check modifiedSince format. Needs to be Datetime in UTC
+        options["modifiedSince"] = modifiedSince
+      end
+
+      conversations = []
+      begin
+        items = Base.requestItems(url, options)
+        items.each do |item|
+          conversations << Conversation.new(item)
+        end
+      rescue StandardError => e
+        print "Request failed: " + e.message
+      end
+      conversations
+    end
+
+    def self.customer(customerId)
+      url = "/customers/#{customerId}.json"
+      item = Base.requestItem(url, nil)
+      customer = nil
+      if item
+        customer = Customer.new(item)
+      end
+      customer
+    end
+
+    def self.customers
+      url = "/customers.json"
+      items = Base.requestItems(url, :page => 1)
+      customers = []
+      items.each do |item|
+        customers << Customer.new(item)
+      end
+      customers
+    end
+
+    def self.attachmentData(attachmentId)
+      url = "/attachments/#{attachmentId}/data.json"
+      item = Base.requestItem(url, nil)
+      attachmentData = nil
+      if item
+        attachmentData = Conversation::AttachmentData.new(item)
+      end
+      attachmentData
+    end
+  end
+
+  # TODO: check response, if 200, it's one of the first two.
+  # If 403, error
+  class SingleItemEnvelope
+    attr_accessor :item
+    def initialize(object)
+      @item = object["item"]
+    end
+  end
+
+  class CollectionsEnvelope
+    attr_accessor :page, :pages, :count, :items
+    def initialize(object)
+      @page = object["page"]
+      @pages = object["pages"]
+      @count = object["count"]
+      @items = object["items"]
+    end
+  end
+
+  class ErrorEnvelope
+    attr_accessor :status, :message
+    def initialize(object)
+      @status = object["status"]
+      @message = object["message"]
+    end    
+  end
+end

data/lib/helpscout/models.rb

@@ -0,0 +1,397 @@
+require "date"
+require "httparty"
+
+module HelpScout
+  class Mailbox
+    attr_accessor :id, :name, :slug, :email, :createdAt, :modifiedAt
+    def initialize(object)
+      @id = object["id"]
+      @name = object["name"]
+      @slug = object["slug"]
+      @email = object["email"]
+      @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+      @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
+    end
+
+    class Folder
+      attr_accessor :id, :name, :type, :userId, :totalCount, :activeCount, :modifiedAt
+  
+      FOLDER_TYPE_UNASSIGNED = "unassigned"
+      FOLDER_TYPE_MY_TICKETS = "mytickets"
+      FOLDER_TYPE_DRAFTS = "drafts"
+      FOLDER_TYPE_ASSIGNED = "assigned"
+      FOLDER_TYPE_CLOSED = "closed"
+      FOLDER_TYPE_SPAM = "spam"
+
+      def initialize(object)
+        @id = object["id"]
+        @name = object["name"]
+        @type = object["type"]
+        @userId = object["userId"] # 0, unless type == FOLDER_TYPE_MY_TICKETS
+        @totalCount = object["totalCount"]
+        @activeCount = object["activeCount"]
+        @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
+      end
+    end
+  end
+
+  class Conversation
+    attr_accessor :id, :folderId, :isDraft, :number, :owner, :mailbox, :customer, :threadCount, :status, :subject, :preview, :createdBy, :createdAt, :modifiedAt, :closedAt, :closedBy, :source, :cc, :bcc, :tags, :threads
+
+    CONVERSATION_STATUS_ACTIVE = "active"
+    CONVERSATION_STATUS_PENDING = "pending"
+    CONVERSATION_STATUS_CLOSED = "closed"
+    CONVERSATION_STATUS_SPAM = "spam"
+
+    def initialize(object)
+      @id = object["id"]
+      @folderId = object["folderId"]
+      @isDraft = object["isDraft"]
+      @number = object["number"]
+      @owner = User.new(object["owner"]) if object["owner"]
+      @mailbox = Mailbox.new(object["mailbox"]) if object["mailbox"]
+      @customer = Customer.new(object["customer"]) if object["customer"]
+      @threadCount = object["threadCount"]
+      @status = object["status"]
+      @subject = object["subject"]
+      @preview = object["preview"]
+      @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+      @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
+      @closedAt = DateTime.iso8601(object["closedAt"]) if object["closedAt"]
+      @closedBy = User.new(object["closedBy"]) if object["closedBy"]
+
+      @source = nil
+      if object["source"]
+        @source = Source.new(object["source"])
+
+        if object["createdBy"]
+          if @source.type == Source::SOURCE_VIA_CUSTOMER
+            @createdBy = Customer.new(object["createdBy"])
+          elsif @source.type == Source::SOURCE_VIA_USER
+            @createdBy = User.new(object["createdBy"])
+          end
+        end
+      end
+
+      @cc = object["cc"]
+      @bcc = object["bcc"]
+      @tags = object["tags"]
+
+      @threads = []
+      if object["threads"]
+        object["threads"].each do |thread|
+          @threads << Thread.new(thread)
+        end
+      end
+    end
+
+    def to_s
+      "Last Modified: #{@modifiedAt}\nAssigned to: #{@owner}\nSubject: #{@subject}\n#{@preview}"
+    end
+
+    class Attachment
+      attr_accessor :id, :mimeType, :filename, :size, :width, :height, :url
+
+      def initialize(object)
+        @id = object["id"]
+        @mimeType = object["mimeType"]
+        @filename = object["filename"]
+        @size = object["size"]
+        @width = object["width"]
+        @height = object["height"]
+        @url = object["url"]
+      end
+    end
+
+    class AttachmentData
+      attr_accessor :id, :data
+
+      def initialize(object)
+        @id = object["id"]
+        @data = object["data"]
+      end
+    end
+
+    class Source
+      attr_accessor :type, :via
+
+      SOURCE_TYPE_EMAIL = "email"
+      SOURCE_TYPE_WEB = "web"
+      SOURCE_TYPE_NOTIFICATION = "notification"
+      SOURCE_TYPE_EMAIL_FWD = "emailfwd"
+
+      SOURCE_VIA_USER = "user"
+      SOURCE_VIA_CUSTOMER = "customer"
+
+      def initialize(object)
+        @type = object["type"]
+        @via = object["via"]
+      end
+    end
+
+    class Thread
+      attr_accessor :id, :assignedTo, :status, :createdAt, :createdBy, :source, :fromMailbox, :type, :state, :customer, :body, :to, :cc, :bcc, :attachments
+
+      THREAD_STATE_PUBLISHED = "published"
+      THREAD_STATE_DRAFT = "draft"
+      THREAD_STATE_UNDER_REVIEW = "underreview"
+
+      THREAD_STATUS_ACTIVE = "active"
+      THREAD_STATUS_NO_CHANGE = "nochange"
+      THREAD_STATUS_PENDING = "pending"
+      THREAD_STATUS_CLOSED = "closed"
+      THREAD_STATUS_SPAM = "spam"
+
+      THREAD_TYPE_NOTE = "note"
+      THREAD_TYPE_MESSAGE = "message"
+      THREAD_TYPE_CUSTOMER = "customer"
+
+      # A lineitem represents a change of state on the conversation. This could include, but not limited to, the conversation was assigned, the status changed, the conversation was moved from one mailbox to another, etc. A line item won't have a body, to/cc/bcc lists, or attachments.
+      THREAD_TYPE_LINEITEM = "lineitem" 
+
+      # When a conversation is forwarded, a new conversation is created to represent the forwarded conversation.
+      THREAD_TYPE_FWD_PARENT = "forwardparent" # forwardparent is the type set on the thread of the original conversation that initiated the forward event.
+      THREAD_TYPE_FWD_CHILD = "forwardchild" # forwardchild is the type set on the first thread of the new forwarded conversation.
+
+      
+      def initialize(object)
+        @id = object["id"]
+        @assignedTo = User.new(object["assignedTo"]) if object["assignedTo"]
+        @status = object["status"]
+        @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+
+        @source = nil
+        if object["source"]
+          @source = Source.new(object["source"])
+
+          if object["createdBy"]
+            if @source.type == Source::SOURCE_VIA_CUSTOMER
+              @createdBy = Customer.new(object["createdBy"])
+            elsif @source.type == Source::SOURCE_VIA_USER
+              @createdBy = User.new(object["createdBy"])
+            end
+          end
+        end
+
+        @fromMailbox = Mailbox.new(object["fromMailbox"]) if object["fromMailbox"]
+        @type = object["type"]
+        @state = object["state"]
+        @customer = Customer.new(object["customer"]) if object["customer"]
+        @body = object["body"]
+        @to = object["to"]
+        @cc = object["cc"]
+        @bcc = object["bcc"]
+
+        @attachments = []
+        if object["attachments"]
+          object["attachments"].each do |item|
+            @attachments << Attachment.new(item)
+          end
+        end
+      end
+
+      def to_s
+        "#{@customer}: #{@body}"
+      end
+    end
+
+  end
+
+  class User
+    attr_accessor :id, :firstName, :lastName, :email, :role, :timezone, :photoUrl, :createdAt, :createdBy
+
+    USER_ROLE_OWNER = "owner"
+    USER_ROLE_ADMIN = "admin"
+    USER_ROLE_USER = "user"
+
+    def initialize(object)
+      @id = object["id"]
+      @firstName = object["firstName"]
+      @lastName = object["lastName"]
+      @email = object["email"]
+      @role = object["role"]
+      @timezone = object["timezone"]
+      @photoUrl = object["photoUrl"]
+      @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+      @createdBy = object["createdBy"]
+    end
+
+    def to_s
+      "#{@firstName} #{@lastName}"
+    end
+  end
+
+  class Customer
+    attr_accessor :id, :firstName, :lastName, :photoUrl, :photoType, :gender, :age, :organization, :jobTitle, :location, :createdAt, :modifiedAt, :background, :address, :socialProfiles, :emails, :phones, :chats, :websites
+
+    CUSTOMER_PHOTO_TYPE_UNKNOWN = "unknown"
+    CUSTOMER_PHOTO_TYPE_GRAVATAR = "gravatar"
+    CUSTOMER_PHOTO_TYPE_TWITTER = "twitter"
+    CUSTOMER_PHOTO_TYPE_FACEBOOK = "facebook"
+    CUSTOMER_PHOTO_TYPE_GOOGLE_PROFILE = "googleprofile"
+    CUSTOMER_PHOTO_TYPE_GOOGLE_PLUS = "googleplus"
+    CUSTOMER_PHOTO_TYPE_LINKEDIN = "linkedin"
+
+    CUSTOMER_GENDER_MALE = "male"
+    CUSTOMER_GENDER_FEMALE = "female"
+    CUSTOMER_GENDER_UNKNOWN = "unknown"
+
+    def initialize(object)
+      @id = object["id"]
+      @firstName = object["firstName"]
+      @lastName = object["lastName"]
+      @photoUrl = object["photoUrl"]
+      @photoType = object["photoType"]
+      @gender = object["gender"]
+      @age = object["age"]
+      @organization = object["organization"]
+      @jobTitle = object["jobTitle"]
+      @location = object["location"]
+      @background = object["background"]
+
+      @address = nil
+      if object["address"]
+        @address = Address.new(object["address"])
+      end
+
+      @socialProfiles = []
+      if object["socialProfiles"]
+        object["socialProfiles"].each do |item|
+          @socialProfiles << SocialProfile.new(item)
+        end
+      end
+
+      @emails = []
+      if object["emails"]
+        object["emails"].each do |item|
+          @emails << Email.new(item)
+        end
+      end
+
+      @phones = []
+      if object["phones"]
+        object["phones"].each do |item|
+          @phones << Phone.new(item)
+        end
+      end
+
+      @chats = []
+      if object["chats"]
+        object["chats"].each do |item|
+          @chats << Chat.new(item)
+        end
+      end
+
+      @websites = []
+      if object["websites"]
+        object["websites"].each do |item|
+          @websites << Website.new(item)
+        end
+      end
+
+      @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+      @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
+    end
+
+    def to_s
+      "#{@firstName} #{@lastName}"
+    end
+
+    class Address
+      attr_accessor :id, :lines, :city, :state, :postalCode, :country, :createdAt, :modifiedAt
+      def initialize(object)
+        @id = object["id"]
+        @lines = object["lines"]
+        @city = object["city"]
+        @state = object["state"]
+        @postalCode = object["postalCode"]
+        @country = object["country"]
+        @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+        @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
+      end
+    end
+
+    class Chat
+      attr_accessor :id, :value, :type
+
+      CHAT_TYPE_AIM = "aim"
+      CHAT_TYPE_GTALK = "gtalk"
+      CHAT_TYPE_ICQ = "icq"
+      CHAT_TYPE_XMPP = "xmpp"
+      CHAT_TYPE_MSN = "msn"
+      CHAT_TYPE_SKYPE = "skype"
+      CHAT_TYPE_YAHOO = "yahoo"
+      CHAT_TYPE_QQ = "qq"
+      CHAT_TYPE_OTHER = "other"
+
+      def initialize(object)
+        @id = object["id"]
+        @value = object["value"]
+        @type = object["type"]
+      end
+    end
+
+    class Email
+      attr_accessor :id, :value, :location
+
+      EMAIL_LOCATION_WORK = "work"
+      EMAIL_LOCATION_HOME = "home"
+      EMAIL_LOCATION_OTHER = "other"
+
+      def initialize(object)
+        @id = object["id"]
+        @value = object["value"]
+        @location = object["location"]
+      end
+    end
+
+    class Phone
+      attr_accessor :id, :value, :location
+
+      PHONE_LOCATION_HOME = "home"
+      PHONE_LOCATION_WORK = "work"
+      PHONE_LOCATION_MOBILE = "mobile"
+      PHONE_LOCATION_FAX = "fax"
+      PHONE_LOCATION_PAGER = "pager"
+      PHONE_LOCATION_OTHER = "other"
+
+      def initialize(object)
+        @id = object["id"]
+        @value = object["value"]
+        @location = object["location"]
+      end
+    end
+
+    class SocialProfile
+      attr_accessor :id, :value, :type
+
+      SOCIAL_PROFILE_TYPE_TWITTER = "twitter"
+      SOCIAL_PROFILE_TYPE_FACEBOOK = "facebook"
+      SOCIAL_PROFILE_TYPE_LINKEDIN = "linkedin"
+      SOCIAL_PROFILE_TYPE_ABOUTME = "aboutme"
+      SOCIAL_PROFILE_TYPE_GOOGLE = "google"
+      SOCIAL_PROFILE_TYPE_GOOGLE_PLUS = "googleplus"
+      SOCIAL_PROFILE_TYPE_TUNGLEME = "tungleme"
+      SOCIAL_PROFILE_TYPE_QUORA = "quora"
+      SOCIAL_PROFILE_TYPE_FOURSQUARE = "foursquare"
+      SOCIAL_PROFILE_TYPE_YOUTUBE = "youtube"
+      SOCIAL_PROFILE_TYPE_FLICKR = "flickr"
+      SOCIAL_PROFILE_TYPE_OTHER = "other"
+
+      def initialize(object)
+        @id = object["id"]
+        @value = object["value"]
+        @type = object["type"] # twitter, facebook, linkedin, aboutme, google, googleplus, tungleme, quora, foursquare, youtube, flickr, other
+      end
+    end
+
+    class Website
+      attr_accessor :id, :value
+      def initialize(object)
+        @id = object["id"]
+        @value = object["value"]
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: helpscout
+version: !ruby/object:Gem::Version
+  version: 0.0.3.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Héctor Ramos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: hector@hectorramos.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- Gemfile
+- README.markdown
+- Rakefile
+- VERSION
+- helpscout.gemspec
+- lib/helpscout.rb
+- lib/helpscout/base.rb
+- lib/helpscout/models.rb
+homepage: http://github.com/hramos/helpscout
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HelpScout API Wrapper
+test_files: []