ruby-redtail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2QzZDlhMWI3MjI1N2E5YjRiMWQ0ZmJhMjljMzI4NWI4NTNjN2FlOQ==
+    YjlmM2JlNWRiZmNhYjFlYTk0MThkYTQ1YTdlY2MxNDcyN2ExYTNkOQ==
   data.tar.gz: !binary |-
-    ZTAzYjM4MTY0ZDYzZWE2N2UzNzRmOTcxOTEyMDZlYWExZWNjNGMzMg==
+    MDZhMDlkYWEyMTQ4NDc3ZWZiNjFjYTliM2ExMGUzYTNjOGI2YjMyNw==
 SHA512:
   metadata.gz: !binary |-
-    MDZlZjRlOTE1NDg0ZGNhMmJkYjc3MTQyOGQxZWY1OTBmZjgzZTYzNWU4NmMx
-    NWI1YzFjMzQ4NjIyYWI2NWRhMGU0N2E3ZWM3MTM1NGQyOThlOThlZTAyZWIy
-    ODk2NzA2NzUyNTViOTJlYjY2Y2FlN2FmMTE0OGE1ZWNjYTcxYTE=
+    MjI2Zjk1M2U3NTAzZDE2YTU1MTkxMzcxZDdkYjQ5NDlkY2YwOTZlNGQ2MGJl
+    NjM2OTg0ODZiZjUyYTgxMzVkOTQ3MTNhOWJkYTlmMTQzNzkwNDc0NDFmMWZm
+    MTg1MDc4MmQ3OTJmMDBlZTYzNTZiNTc1ZDEyNmE4N2E2MGQ3OGU=
   data.tar.gz: !binary |-
-    ZDdkOTEzYWUzMTljOTZmYjEwY2Q3ZDY1MDc2ZjRjOWViYTUxODcxYWFlZjdm
-    Y2RiZDQxNDkzNDhlMzc0ZTgzMDAwY2Q1OWYwMzg1ZTkxOGE2ZjkyMjAwMDI4
-    MTA1ZTk3MjUwNzhmZDNiZjAxYTdiNDQzOTdmZjg0NzgwNWI5OGI=
+    MTQ1Y2MxNzIyM2FkZTY1ZGRhNmMzYmRhNTI3ZGJhOGM3ZDQxMTExOWZhNTM0
+    OTZhOTRlNDU1NjZiNGZmYjNhZDNkZjRlZDZjMzRhZGUyYmViMmY1ZDJhZTM5
+    YTAwOThkMjU2NjZjNGIxNGExNjE5ZjgwZmY0MmIxMjA3Y2NiOGQ=

data/README.rdoc

@@ -1,6 +1,8 @@
-= ruby-redtail
+= RubyRedtail
 
-Description goes here.
+http://static.brandnewbox.com/misc/ruby-redtail.png
+
+The gem provides access to methods to use the Redtail CRM API.
 
 == Installation
 
@@ -18,15 +20,51 @@ Or install it yourself as:
 
 == Basic Setup
 
-Create a file in `config/initializers/ruby-redtail.rb` and add your API Key, User Name, Password And API URI:
+To setup the client, you'll need the following configuration. In Rails land, you could create a file in `config/initializers/ruby-redtail.rb` (and if you're still storing top secret keys in your code repository, take the opportunity now to stop and start using ENV vars or something):
 
     RubyRedtail.configure do |config|
       config.api_key = ENV['REDTAIL_API_KEY']
       config.secret_key = ENV['REDTAIL_SECRET_KEY']
       config.api_uri = ENV['REDTAIL_API_URI']
     end
+    
+== Basic Usage
+
+=== Authentication Options
+
+Block-tastic!
+
+    RubyRedtail::User.authenticate_via_basic('frank', 'secret') do |redtail_user|
+      # Something Cool
+    end
+    RubyRedtail::User.authenticate_via_user_key('key') do |redtail_user|
+      # Something Cool
+    end
+    RubyRedtail::User.authenticate_via_user_token('token') do |redtail_user|
+      # Something Cool
+    end
+    
+This works too:
+
+    redtail_user = RubyRedtail::User.new('Basic','frank', 'secret')
+    redtail_user = RubyRedtail::User.new('UserKey','key')
+    redtail_user = RubyRedtail::User.new('UserToken','token')
+
+=== Fetching UserKey
+
+
+    redtail_user.user_key
+    
+
+=== Fetching Settings
+
+    redtail_user.settings.taggroups
+    
+=== Fetching Contacts
+
+    redtail_user.contacts.search_by_name('Investor')
 
-== Contributing to ruby-redtail
+== Contributing to RubyRedtail
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/core_extensions/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

data/lib/ruby-redtail.rb

@@ -5,6 +5,8 @@ require 'ruby-redtail/user'
 require 'ruby-redtail/exceptions'
 require 'ruby-redtail/query'
 
+require 'core_extensions/string'
+
 module RubyRedtail
   class << self
     attr_accessor :config

data/lib/ruby-redtail/authentication.rb

@@ -0,0 +1,12 @@
+module RubyRedtail
+  class Authentication
+    def initialize(authentication = {})
+      raise ArgumentError if authentication.class != Hash
+      authentication.each do |key, value|
+        key = key.underscore
+        self.class.send :attr_accessor, key
+        instance_variable_set "@#{key}", value
+      end
+    end
+  end
+end

data/lib/ruby-redtail/client.rb

@@ -0,0 +1,19 @@
+module RubyRedtail
+  class Client < RubyRedtail::Contact
+    # http://help.redtailtechnology.com/entries/21654562-authentication-methods
+    def initialize(client = {}, api_hash)
+      @api_hash = api_hash
+      
+      raise ArgumentError unless client['ClientID']
+      @id = client['ClientID']
+      
+      raise ArgumentError if client.class != Hash
+      client.each do |key, value|
+        key = key.underscore
+        self.class.send :attr_accessor, key
+        instance_variable_set "@#{key}", value
+      end
+    end
+
+  end
+end

data/lib/ruby-redtail/contact.rb

@@ -0,0 +1,134 @@
+module RubyRedtail
+  class Contact
+    attr_accessor :api_hash, :id
+
+    # http://help.redtailtechnology.com/entries/21654562-authentication-methods
+    def initialize(contact = {}, api_hash)
+      @api_hash = api_hash
+      
+      raise ArgumentError unless contact['ContactID']
+      @id = contact['ContactID']
+      
+      raise ArgumentError if contact.class != Hash
+      contact.each do |key, value|
+        key = key.underscore
+        self.class.send :attr_accessor, key
+        instance_variable_set "@#{key}", value
+      end
+    end
+    
+    
+    def addresses
+      RubyRedtail::Contact::Addresses.new self.api_hash
+    end
+    
+    def notes
+      RubyRedtail::Contact::Notes.new self.api_hash
+    end
+    
+    def accounts
+      RubyRedtail::Contact::Accounts.new self.api_hash
+    end
+    
+    def activities
+      RubyRedtail::Contact::Activities.new self.api_hash
+    end
+    
+    def tag_groups
+      RubyRedtail::Contact::TagGroups.new self.api_hash
+    end
+    
+    # Fetch Contact By Contact Id
+    # Optional parameter: ?recent={recent}*
+    # * {0} does nothing
+    # * {1} updates recently viewed
+    def fetch (recent = false, basic = false)
+      RubyRedtail::Query.run("contacts/#{self.id}?recent=#{recent ? 1 : 0}", @api_hash, "GET")
+    end
+    
+    # Fetch Basic Contact By Contact Id
+    # Optional parameter: ?recent={recent}*
+    # * {0} does nothing
+    # * {1} updates recently viewed
+    def fetch_basic (recent = false, basic = false)
+      RubyRedtail::Query.run("contacts/#{self.id}/basic?recent=#{recent ? 1 : 0}", @api_hash, "GET")
+    end
+
+    # Master Fetch Contact
+    # http://help.redtailtechnology.com/entries/22846682-master-fetch-contacts-contactid-master
+    def fetch_master
+      RubyRedtail::Query.run("contacts/#{self.id}/master", @api_hash, 'GET')
+    end
+
+    # Update Contact
+    def update (params)
+      RubyRedtail::Query.run("contacts/#{self.id}", @api_hash, 'PUT', params)
+    end
+  
+    # Delete Contact
+    def delete
+      RubyRedtail::Query.run("contacts/#{self.id}", @api_hash, 'DELETE')['Status'] == 0
+    end
+
+    # Fetch Contact Details
+    def details
+      RubyRedtail::Query.run("contacts/#{self.id}/details", @api_hash, "GET")
+    end
+
+    # Update Contact Details
+    # Is this required? (Deprecated on API website). Ask Client?
+    def update_details (params)
+      RubyRedtail::Query.run("contacts/#{self.id}/details", @api_hash, 'PUT', params)
+    end
+
+    # Fetch Contact Family
+    def family
+      RubyRedtail::Query.run("contacts/#{self.id}/family", @api_hash, "GET")
+    end
+
+    # Fetch Contact Memberships
+    def memberships
+      RubyRedtail::Query.run("contacts/#{self.id}/memberships", @api_hash, "GET")
+    end
+
+    # Fetch Contact Personal Profile
+    def personal_profile
+      RubyRedtail::Query.run("contacts/#{self.id}/personalprofile", @api_hash, "GET")
+    end
+
+    # Update Contact Personal Profile
+    def update_personal_profile (personal_profile_id, params)
+      RubyRedtail::Query.run("contacts/#{self.id}/personalprofile/#{personal_profile_id}", @api_hash, 'PUT', params)
+    end
+
+    # Fetch Contact Important Information
+    def inportant_information
+      RubyRedtail::Query.run("contacts/#{self.id}/importantinfo", @api_hash, "GET")
+    end
+
+    # Update Contact Important Information
+    def update_important_information (params)
+      RubyRedtail::Query.run("contacts/#{self.id}/importantinfo", @api_hash, 'PUT', params)
+    end
+
+    # Fetch Contact Departments
+    def departments
+      RubyRedtail::Query.run("contacts/#{self.id}/importantinfo", @api_hash, "GET")
+    end
+
+    # Fetch User Defined Fields for Contact
+    def user_defined_fields
+      RubyRedtail::Query.run("contacts/#{self.id}/udf", @api_hash, "GET")
+    end
+
+    # Update User Defined Field for Contact
+    def update_user_defined_field (udf_id, params)
+      RubyRedtail::Query.run("contacts/#{self.id}/udf/#{udf_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create User Defined Field for Contact
+    def create_user_defined_field (params)
+      update_user_defined_field(self.id, 0, params)
+    end
+  end
+end

data/lib/ruby-redtail/contact/accounts.rb

@@ -0,0 +1,26 @@
+module RubyRedtail
+  class Contact
+    class Accounts
+      def initialize(contact_id, api_hash)
+        @api_hash = api_hash
+        @contact_id = contact_id
+      end
+
+      def fetch
+        RubyRedtail::Query.run("contacts/#{@contact_id}/accounts", @api_hash, "GET")
+      end
+
+      def create (params)
+        update(@contact_id, 0, params)
+      end
+
+      def update (account_id, params)
+        RubyRedtail::Query.run("contacts/#{contact_id}/accounts/#{account_id}", @api_hash, 'PUT', params)
+      end
+
+      def assets (account_id)
+        RubyRedtail::Query.run("contacts/#{contact_id}/#{account_id}/assets", @api_hash, "GET")
+      end
+    end
+  end
+end

data/lib/ruby-redtail/query.rb

@@ -3,7 +3,7 @@ module RubyRedtail
     # TODO: Refactor (Lots of repetition)
     def self.run (uri, auth_hash, method, request_body = nil)
       base_uri = RubyRedtail.config.api_uri
-      if method == "GET" || method == "POST"
+      if method == "GET"
         @response = HTTParty.get(base_uri + uri, :headers => {"Authorization" => auth_hash, 'Content-Type' => 'text/json'}).parsed_response
       elsif method == "POST"
         @response = HTTParty.post(base_uri + uri, :headers => {"Authorization" => auth_hash, 'Content-Type' => 'text/json'}, :body => request_body.to_json).parsed_response

data/lib/ruby-redtail/setting.rb

@@ -0,0 +1,14 @@
+module RubyRedtail
+  class Setting
+    def initialize(setting = {},api_hash)
+      @api_hash = api_hash
+      
+      raise ArgumentError if setting.class != Hash
+      setting.each do |key, value|
+        key = key.underscore
+        self.class.send :attr_accessor, key
+        instance_variable_set "@#{key}", value
+      end
+    end
+  end
+end

data/lib/ruby-redtail/sso.rb

@@ -0,0 +1,12 @@
+module RubyRedtail
+  class Sso
+    def initialize(sso = {})
+      raise ArgumentError if sso.class != Hash
+      sso.each do |key, value|
+        key = key.underscore
+        self.class.send :attr_accessor, key
+        instance_variable_set "@#{key}", value
+      end
+    end
+  end
+end

data/lib/ruby-redtail/user.rb

@@ -1,15 +1,13 @@
-require 'ruby-redtail/contacts'
-require 'ruby-redtail/addresses'
-require 'ruby-redtail/notes'
-require 'ruby-redtail/accounts'
-require 'ruby-redtail/activities'
-require 'ruby-redtail/tag_groups'
-require 'ruby-redtail/settings'
+require 'ruby-redtail/user/contacts'
+require 'ruby-redtail/user/settings'
+require 'ruby-redtail/authentication'
+require 'ruby-redtail/sso'
 
 module RubyRedtail
   class User
     attr_accessor :api_hash
 
+    # http://help.redtailtechnology.com/entries/21654562-authentication-methods
     def initialize type, *args
       if type == "Basic"
         self.api_hash = "Basic " + Base64.strict_encode64("#{RubyRedtail.config.api_key}:#{args[0]}:#{args[1]}")
@@ -34,51 +32,33 @@ module RubyRedtail
       yield self.new('UserToken',token)
     end
     
-    # def self.method_missing(method_name, *args)
-    #   method_array = method_name.to_s.split('_')
-    #   if method_array.first == 'authenticate'
-    #     type = method_array[2]
-    #     type += ('' if type == 'basic') || ('auth' if type == 'userkey') || 'Auth'
-    #     yield RubyRedtail::User.new type.to_s.capitalize, *args
-    #   else
-    #     super
-    #   end
-    # end
-    
+    # UserKey Retrieval
+    # http://help.redtailtechnology.com/entries/22621068
+    # returns a UserKey in exchange for the Username and Password specified in the Authentication.
+	  def user_key
+	    authentication.user_key
+	  end
     def authentication
-      RubyRedtail::Query.run("authentication", self.api_hash, "GET")
+      RubyRedtail::Authentication.new(RubyRedtail::Query.run("authentication", self.api_hash, "GET"))
     end
 	  
+    # Single Sign-On
+    # http://help.redtailtechnology.com/entries/22602246
+    # returns a URL for Single Sign-On based on the specified endpoint.
+    # TODO: pass endpoint and id parameters
+    def sso_return_url
+      sso.return_url
+    end
 	  def sso
-      Redtail::Query.run("sso", self.api_hash, "GET")
+      RubyRedtail::Sso.new(RubyRedtail::Query.run("sso", self.api_hash, "GET"))
     end
 
     def contacts
-      RubyRedtail::Contacts.new self.api_hash
-    end
-
-    def addresses
-      RubyRedtail::Addresses.new self.api_hash
-    end
-
-    def notes
-      RubyRedtail::Notes.new self.api_hash
-    end
-
-    def accounts
-      RubyRedtail::Accounts.new self.api_hash
-    end
-
-    def activities
-      RubyRedtail::Activities.new self.api_hash
-    end
-
-    def tag_groups
-      RubyRedtail::TagGroups.new self.api_hash
+      RubyRedtail::User::Contacts.new self.api_hash
     end
 
     def settings
-      RubyRedtail::Settings.new self.api_hash
+      RubyRedtail::User::Settings.new self.api_hash
     end
   end
 end

data/lib/ruby-redtail/user/contacts.rb

@@ -0,0 +1,91 @@
+require 'ruby-redtail/contact'
+require 'ruby-redtail/client'
+
+module RubyRedtail
+  class User
+    class Contacts
+
+      CONTACT_SEARCH_FIELDS = ['LastUpdate','Name','RecAdd','PhoneNumber','Tag_Group','FirstName','LastName','FamilyName','FamilyHead','ClientStatus','ContactType','ClientSource','TaxId']
+      CONTACT_SEARCH_OPERANDS = ['=','>','<','!=','Like','BeginsWith','IsEmpty']
+
+      def initialize(api_hash)
+        @api_hash = api_hash
+      end
+
+      # Contact Search by Name Fetch
+      # returns a paged list of limited Contact Information, including the ContactID
+      # *value = searched name
+      # *page = pagination
+      # http://help.redtailtechnology.com/entries/21937828-contacts-search-contacts-search
+      def search_by_name (value, page = 1)
+        build_contacts_array RubyRedtail::Query.run("contacts/search?value=#{value}&page=#{page}", @api_hash, "GET")["Contacts"]
+      end
+      
+      # Contact Search by Letter Fetch
+      # returns a paged list of limited Contact Information, including the ContactID, 
+      # based on a partial name or a single character.
+      # *value = searched beginning letter(s)
+      # *page = pagination
+      # http://help.redtailtechnology.com/entries/21937828-contacts-search-contacts-search
+      def search_by_letter (value, page = 1)
+        build_contacts_array RubyRedtail::Query.run("contacts/search/beginswith?value=#{value}&page=#{page}", @api_hash, "GET")["Contacts"]
+      end
+
+      # TODO: Test this properly
+      # Search Contact by Custom Query
+      # returns a paged list of Basic Contact Information, including the ContactID, 
+      # based on the specified field, operand, and field value. 
+      # http://help.redtailtechnology.com/entries/22550401
+      def search (query, page = 1)
+        body = Array.new(query.length) { {} }
+        query.each_with_index do |expr, i|
+          body[i]["Field"] = CONTACT_SEARCH_FIELDS.index(expr[0]).to_s
+          body[i]["Operand"] = CONTACT_SEARCH_OPERANDS.index(expr[1]).to_s
+          body[i]["Value"] = expr[2]
+        end
+        build_clients_array RubyRedtail::Query.run("contacts/search?page=#{page}", @api_hash, "POST", body)["Contacts"]
+      end
+      
+      # Create New Contact
+      def create (params)
+        update(0, params)
+      end
+      
+      protected
+      
+      def build_contact contact_hash
+        if contact_hash
+          RubyRedtail::Contact.new(contact_hash,@api_hash)
+        else
+          raise RubyRedtail::AuthenticationError
+        end
+      end
+
+      def build_contacts_array contact_hashes
+        if client_hashes
+          contact_hashes.collect { |contact_hash| self.build_contact contact_hash }
+        else
+          raise RubyRedtail::AuthenticationError
+        end
+      end
+      
+      def build_client client_hash
+        if client_hash
+          RubyRedtail::Client.new(client_hash,@api_hash)
+        else
+          raise RubyRedtail::AuthenticationError
+        end
+      end
+
+      def build_clients_array client_hashes
+        if client_hashes
+          client_hashes.collect { |client_hash| self.build_client client_hash }
+        else
+          raise RubyRedtail::AuthenticationError
+        end
+      end
+
+
+    end
+  end
+end

data/lib/ruby-redtail/user/settings.rb

@@ -0,0 +1,97 @@
+require 'ruby-redtail/setting'
+
+module RubyRedtail
+  class User
+    class Settings
+
+      def initialize api_hash
+        @api_hash = api_hash
+      end
+    
+      # Activity Type List Fetch
+      # returns a list of activity types with the corresponding Activity Code
+      def activitytypes
+        build_settings_array RubyRedtail::Query.run("settings/activitytypes", @api_hash, "GET")
+      end
+    
+      # Master Category List Fetch
+      # returns a Master Category List with the corresponding MCL Code.
+      def mcl
+        build_settings_array RubyRedtail::Query.run("settings/mcl", @api_hash, "GET")
+      end
+    
+      # Salutation List Fetch
+      # returns a list of Salutations with the corresponding Salutation Code
+      def salutations
+        build_settings_array RubyRedtail::Query.run("settings/salutations", @api_hash, "GET")
+      end
+    
+      # User-Defined Fields Fetch
+      # returns a list of User-defined fields with the corresponding UDF Code.
+      def udf
+        build_settings_array RubyRedtail::Query.run("settings/udf", @api_hash, "GET")
+      end
+    
+      # Tag Groups Fetch
+      # returns a list of Tag Groups for a user's Database.
+      def taggroups
+        build_settings_array RubyRedtail::Query.run("settings/taggroups", @api_hash, "GET")
+      end
+
+      # Contact Status List Fetch
+      # returns a list of contact statuses with the corresponding Contact Status Code.
+      # optional Parameter: {deleted}*
+      # {0} shows current records, {1} shows deleted records
+      def csl(deleted=false)
+        build_settings_array RubyRedtail::Query.run("settings/csl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
+      end
+
+      # Contact Category List Fetch
+      # returns a list of Contact Categories with the corresponding Contact Category Code
+      # optional Parameter: {deleted}*
+      # {0} shows current records, {1} shows deleted records
+      def mccl(deleted=false)
+        build_settings_array RubyRedtail::Query.run("settings/mccl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
+      end
+
+      # Contact Source List Fetch
+      # returns a list of Contact Sources with the corresponding Contact Source Code
+      # optional Parameter: {deleted}*
+      # {0} shows current records, {1} shows deleted records
+      def mcsl(deleted=false)
+        build_settings_array RubyRedtail::Query.run("settings/mcsl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
+      end
+
+      # Servicing Advisor List Fetch
+      # returns a list of Servicing Advisors with the corresponding Servicing Advisor Code.
+      # optional Parameter: {deleted}*
+      # {0} shows current records, {1} shows deleted records
+      def sal(deleted=false)
+        build_settings_array RubyRedtail::Query.run("settings/sal?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
+      end
+
+      # Writing Advisor List Fetch
+      # returns a list of Writing Advisors with the corresponding Writing Advisor Code.
+      # optional Parameter: {deleted}*
+      # {0} shows current records, {1} shows deleted records
+      def wal(deleted=false)
+        build_settings_array RubyRedtail::Query.run("settings/wal?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
+      end
+      
+      protected
+      
+      def build_setting setting_hash
+        RubyRedtail::Setting.new(setting_hash,@api_hash)
+      end
+
+      def build_settings_array setting_hashes
+        if setting_hashes
+          setting_hashes.collect { |setting_hash| self.build_setting setting_hash }
+        else
+          raise RubyRedtail::AuthenticationError
+        end
+      end
+
+    end
+  end
+end

data/ruby-redtail.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ruby-redtail 0.1.0 ruby lib
+# stub: ruby-redtail 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ruby-redtail"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Colgate"]
-  s.date = "2014-03-07"
+  s.date = "2014-04-28"
   s.description = "The gem offers various methods to access the Redtail CRM API"
   s.email = "nathan@brandnewbox.com"
   s.extra_rdoc_files = [
@@ -26,19 +26,28 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "lib/core_extensions/string.rb",
     "lib/ruby-redtail.rb",
-    "lib/ruby-redtail/accounts.rb",
-    "lib/ruby-redtail/activities.rb",
-    "lib/ruby-redtail/addresses.rb",
-    "lib/ruby-redtail/contacts.rb",
+    "lib/ruby-redtail/authentication.rb",
+    "lib/ruby-redtail/client.rb",
+    "lib/ruby-redtail/contact.rb",
+    "lib/ruby-redtail/contact/accounts.rb",
+    "lib/ruby-redtail/contact/activities.rb",
+    "lib/ruby-redtail/contact/addresses.rb",
+    "lib/ruby-redtail/contact/notes.rb",
+    "lib/ruby-redtail/contact/tag_groups.rb",
     "lib/ruby-redtail/exceptions.rb",
-    "lib/ruby-redtail/notes.rb",
     "lib/ruby-redtail/query.rb",
-    "lib/ruby-redtail/settings.rb",
-    "lib/ruby-redtail/tag_groups.rb",
+    "lib/ruby-redtail/setting.rb",
+    "lib/ruby-redtail/sso.rb",
     "lib/ruby-redtail/user.rb",
+    "lib/ruby-redtail/user/contacts.rb",
+    "lib/ruby-redtail/user/settings.rb",
     "ruby-redtail.gemspec",
+    "test/contact_test.rb",
     "test/helper.rb",
+    "test/user_contacts_test.rb",
+    "test/user_settings_test.rb",
     "test/user_test.rb"
   ]
   s.homepage = "http://github.com/nathancolgate/ruby-redtail"

data/test/contact_test.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class ContactTest < Test::Unit::TestCase
+  def setup
+    setup_redtail
+    @user = RubyRedtail::User.new('UserKey',@redtail_user_key)
+    @contact = RubyRedtail::Contact.new({"ContactID" => @redtail_contact_id},@user.api_hash)
+  end
+  
+  should "be able to fetch client details" do
+    assert_equal(Hash, @contact.fetch.class)
+  end
+  
+  should "be able to fetch basic client details" do
+    assert_equal(Hash, @contact.fetch_basic.class)
+  end
+  
+  should "be able to fetch master client details" do
+    assert_equal(Hash, @contact.fetch_master.class)
+  end
+  
+
+
+  
+end

data/test/helper.rb

@@ -15,13 +15,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'ruby-redtail'
 
 class Test::Unit::TestCase
-  def setup
+  def setup_redtail
     @redtail_api_key = 'E45FC97D-5AB2-4FD7-B05F-80BC64227A80'
     @redtail_secret_key = '31CE58601D694E31B681C209D29936F6'
     @redtail_uri = 'http://dev.api2.redtailtechnology.com/crm/v1/rest'
     @redtail_user_key = 'CF5DAEC8-4F73-404C-9F1A-8C944F2DDC51'
     @redtail_user_name = 'Statementone'
     @redtail_user_password = 'sonedemo'
+    @redtail_contact_id = 1624478 # Mary Investor
     @num = 4
     RubyRedtail.configure do |config|
       config.api_key = @redtail_api_key

data/test/user_contacts_test.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class UserContactsTest < Test::Unit::TestCase
+  def setup
+    setup_redtail
+    @user = RubyRedtail::User.new('UserKey',@redtail_user_key)
+  end
+  
+  should "be able to search contacts by name" do
+    contacts = @user.contacts.search_by_name('Investor')
+    assert_equal(Array, contacts.class)
+    assert_equal(RubyRedtail::Contact, contacts.first.class)
+  end  
+  
+  should "be able to search contacts by letter" do
+    contacts = @user.contacts.search_by_letter('m')
+    assert_equal(Array, contacts.class)
+    assert_equal(RubyRedtail::Contact, contacts.first.class)
+  end
+  
+  should "be able to search with that fancy method" do
+    clients = @user.contacts.search([
+      ['FirstName','=',"Mary"],
+      ['LastName','=',"Investor"]
+    ])
+    assert_equal(Array, clients.class)
+    assert_equal(RubyRedtail::Client, clients.first.class)
+  end
+  
+end

data/test/user_settings_test.rb

@@ -0,0 +1,70 @@
+require 'helper'
+
+class UserSettingsTest < Test::Unit::TestCase
+  def setup
+    setup_redtail
+    @user = RubyRedtail::User.new('UserKey',@redtail_user_key)
+  end
+  
+  should "be able to fetch user activitytypes" do
+    activitytypes = @user.settings.activitytypes
+    assert_equal(Array, activitytypes.class)
+    assert_equal(RubyRedtail::Setting, activitytypes.first.class)
+  end
+  
+  should "be able to fetch user mcl" do
+    mcl = @user.settings.mcl
+    assert_equal(Array, mcl.class)
+    assert_equal(RubyRedtail::Setting, mcl.first.class)
+  end
+  
+  should "be able to fetch user salutations" do
+    salutations = @user.settings.salutations
+    assert_equal(Array, salutations.class)
+    assert_equal(RubyRedtail::Setting, salutations.first.class)
+  end
+  
+  should "be able to fetch user udf" do
+    udf = @user.settings.udf
+    assert_equal(Array, udf.class)
+    assert_equal(RubyRedtail::Setting, udf.first.class)
+  end
+  
+  should "be able to fetch user taggroups" do
+    taggroups = @user.settings.taggroups
+    assert_equal(Array, taggroups.class)
+    assert_equal(RubyRedtail::Setting, taggroups.first.class)
+  end
+  
+  should "be able to fetch user csl" do
+    csl = @user.settings.csl
+    assert_equal(Array, csl.class)
+    assert_equal(RubyRedtail::Setting, csl.first.class)
+  end
+  
+  should "be able to fetch user mccl" do
+    mccl = @user.settings.mccl
+    assert_equal(Array, mccl.class)
+    assert_equal(RubyRedtail::Setting, mccl.first.class)
+  end
+  
+  should "be able to fetch user mcsl" do
+    mcsl = @user.settings.mcsl
+    assert_equal(Array, mcsl.class)
+    assert_equal(RubyRedtail::Setting, mcsl.first.class)
+  end
+  
+  should "be able to fetch user sal" do
+    sal = @user.settings.sal
+    assert_equal(Array, sal.class)
+    assert_equal(RubyRedtail::Setting, sal.first.class)
+  end
+  
+  should "be able to fetch user wal" do
+    wal = @user.settings.wal
+    assert_equal(Array, wal.class)
+    assert_equal(RubyRedtail::Setting, wal.first.class)
+  end
+
+  
+end

data/test/user_test.rb

@@ -1,72 +1,66 @@
 require 'helper'
 
 class UserTest < Test::Unit::TestCase
+  def setup
+    setup_redtail
+  end
   
   should "be able to fetch UserKey via Basic authentication" do
     user = RubyRedtail::User.new('Basic', @redtail_user_name, @redtail_user_password)
     authentication = user.authentication
-    assert_equal("Success", authentication["Message"])
-    assert_equal(41974, authentication["UserID"])
-    assert_equal(@redtail_user_key, authentication["UserKey"])
+    assert_equal("Success", authentication.message)
+    assert_equal(41974, authentication.user_id)
+    assert_equal(@redtail_user_key, authentication.user_key)
   end
   
   should "be able to fetch user data via Basic authentication" do
     user = RubyRedtail::User.new('Basic', @redtail_user_name, @redtail_user_password)
-    tag_groups = user.settings.tag_groups
-    assert_equal(Array, tag_groups.class)
+    assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
   should "be able to fetch user data via UserKey authentication" do
     user = RubyRedtail::User.new('UserKey', @redtail_user_key)
-    tag_groups = user.settings.tag_groups
-    assert_equal(Array, tag_groups.class)
+    assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
   should "be able to fetch user data via UserToken authentication" do
     # TODO: We need a user token
     # user = RubyRedtail::User.new('UserToken',@redtail_user_token)
-    # tag_groups = user.settings.tag_groups
-    # assert_equal(Array,tag_groups.class)
+    # assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
   should "be able to fetch user data via Basic authentication block" do
     RubyRedtail::User.authenticate_via_basic(@redtail_user_name, @redtail_user_password) do |user|
-      tag_groups = user.settings.tag_groups
-      assert_equal(Array, tag_groups.class)
+      assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
     end
   end
   
   should "be able to fetch user data via UserKey authentication block" do
     RubyRedtail::User.authenticate_via_user_key(@redtail_user_key) do |user|
-      tag_groups = user.settings.tag_groups
-      assert_equal(Array, tag_groups.class)
+      assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
     end
   end
   
   should "be able to fetch user data via UserToken authentication block" do
     # TODO: We need a user token
     # RubyRedtail::User.authenticate_via_user_token(@redtail_user_token) do |user|
-    #   tag_groups = user.settings.tag_groups
-    #   assert_equal(Array,tag_groups.class)
+    #   assert_nothing_raised(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
     # end
   end
   
   should "not be able to fetch user data via faulty Basic authentication" do
     user = RubyRedtail::User.new('Basic', @redtail_user_name, 'hacker_hackity_hack')
-    tag_groups = user.settings.tag_groups
-    assert_equal(nil, tag_groups)
+    assert_raise(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
   should "not be able to fetch user data via faulty UserKey authentication" do
     user = RubyRedtail::User.new('UserKey', 'hacker_hackity_hack')
-    tag_groups = user.settings.tag_groups
-    assert_equal(nil, tag_groups)
+    assert_raise(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
   should "not be able to fetch user data via faulty UserToken authentication" do
     user = RubyRedtail::User.new('UserToken', 'hacker_hackity_hack')
-    tag_groups = user.settings.tag_groups
-    assert_equal(nil, tag_groups)
+    assert_raise(RubyRedtail::AuthenticationError) {taggroups = user.settings.taggroups }
   end
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-redtail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Colgate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,16 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          My4xMg==
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          My4xMg==
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,19 +124,28 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/core_extensions/string.rb
 - lib/ruby-redtail.rb
-- lib/ruby-redtail/accounts.rb
-- lib/ruby-redtail/activities.rb
-- lib/ruby-redtail/addresses.rb
-- lib/ruby-redtail/contacts.rb
+- lib/ruby-redtail/authentication.rb
+- lib/ruby-redtail/client.rb
+- lib/ruby-redtail/contact.rb
+- lib/ruby-redtail/contact/accounts.rb
+- lib/ruby-redtail/contact/activities.rb
+- lib/ruby-redtail/contact/addresses.rb
+- lib/ruby-redtail/contact/notes.rb
+- lib/ruby-redtail/contact/tag_groups.rb
 - lib/ruby-redtail/exceptions.rb
-- lib/ruby-redtail/notes.rb
 - lib/ruby-redtail/query.rb
-- lib/ruby-redtail/settings.rb
-- lib/ruby-redtail/tag_groups.rb
+- lib/ruby-redtail/setting.rb
+- lib/ruby-redtail/sso.rb
 - lib/ruby-redtail/user.rb
+- lib/ruby-redtail/user/contacts.rb
+- lib/ruby-redtail/user/settings.rb
 - ruby-redtail.gemspec
+- test/contact_test.rb
 - test/helper.rb
+- test/user_contacts_test.rb
+- test/user_settings_test.rb
 - test/user_test.rb
 homepage: http://github.com/nathancolgate/ruby-redtail
 licenses:

data/lib/ruby-redtail/accounts.rb

@@ -1,23 +0,0 @@
-module RubyRedtail
-  class Accounts
-    def initialize (api_hash)
-      @api_hash = api_hash
-    end
-
-    def fetch (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/accounts", @api_hash, "GET")
-    end
-
-    def update (contact_id, account_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}/accounts/#{account_id}", @api_hash, 'PUT', params)
-    end
-
-    def create (contact_id, params)
-      update(contact_id, 0, params)
-    end
-
-    def assets (contact_id, account_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/#{account_id}/assets", @api_hash, "GET")
-    end
-  end
-end

data/lib/ruby-redtail/contacts.rb

@@ -1,118 +0,0 @@
-module RubyRedtail
-  class Contacts
-
-    CONTACT_SEARCH_FIELDS = ['LastUpdate','Name','RecAdd','PhoneNumber','Tag_Group','FirstName','LastName','FamilyName','FamilyHead','ClientStatus','ContactType','ClientSource','TaxId']
-    CONTACT_SEARCH_OPERANDS = ['=','>','<','!=','Like','BeginsWith','IsEmpty']
-
-    def initialize(api_hash)
-      @api_hash = api_hash
-    end
-
-    # Search Contact By Name or Part of Name
-    def search_by_name (value, page = 1)
-      RubyRedtail::Query.run("contacts/search?value=#{value}&page=#{page}", @api_hash, "GET")["Contacts"]
-    end
-
-    # TODO: Test this properly
-    # Search Contact by Custom Query
-    def search (query, page = 1)
-      body = Array.new(query.length) { {} }
-      query.each_with_index do |expr, i|
-        body[i]["Field"] = CONTACT_SEARCH_FIELDS.index expr[0]
-        body[i]["Operand"] = CONTACT_SEARCH_OPERANDS.index expr[1]
-        body[i]["Value"] = expr[2]
-      end
-      RubyRedtail::Query.run("contacts/search?page=#{page}", @api_hash, "POST", body)
-    end
-
-    # Fetch Contact By Contact Id
-    def fetch (contact_id, recent = false, basic = false)
-      if basic
-        RubyRedtail::Query.run("contacts/#{contact_id}/basic?recent=#{recent ? 1 : 0}", @api_hash, "GET")
-      else
-        RubyRedtail::Query.run("contacts/#{contact_id}?recent=#{recent ? 1 : 0}", @api_hash, "GET")
-      end
-    end
-
-    # Update Contact
-    def update (contact_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}", @api_hash, 'PUT', params)
-    end
-
-    # Create New Contact
-    def create (params)
-      update(0, params)
-    end
-
-    # Delete Contact
-    def delete (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}", @api_hash, 'DELETE')['Status'] == 0
-    end
-
-    # Master Fetch Contact
-    def master_fetch (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/master", @api_hash, 'GET')
-    end
-
-    # Fetch Contact Details
-    def details (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/details", @api_hash, "GET")
-    end
-
-    # Update Contact Details
-    # Is this required? (Deprecated on API website). Ask Client?
-    def update_details (contact_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}/details", @api_hash, 'PUT', params)
-    end
-
-    # Fetch Contact Family
-    def family (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/family", @api_hash, "GET")
-    end
-
-    # Fetch Contact Memberships
-    def memberships (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/memberships", @api_hash, "GET")
-    end
-
-    # Fetch Contact Personal Profile
-    def personal_profile (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/personalprofile", @api_hash, "GET")
-    end
-
-    # Update Contact Personal Profile
-    def update_personal_profile (contact_id, personal_profile_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}/personalprofile/#{personal_profile_id}", @api_hash, 'PUT', params)
-    end
-
-    # Fetch Contact Important Information
-    def inportant_information (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/importantinfo", @api_hash, "GET")
-    end
-
-    # Update Contact Important Information
-    def update_important_information (contact_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}/importantinfo", @api_hash, 'PUT', params)
-    end
-
-    # Fetch Contact Departments
-    def departments (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/importantinfo", @api_hash, "GET")
-    end
-
-    # Fetch User Defined Fields for Contact
-    def user_defined_fields (contact_id)
-      RubyRedtail::Query.run("contacts/#{contact_id}/udf", @api_hash, "GET")
-    end
-
-    # Update User Defined Field for Contact
-    def update_user_defined_field (contact_id, udf_id, params)
-      RubyRedtail::Query.run("contacts/#{contact_id}/udf/#{udf_id}", @api_hash, 'PUT', params)
-    end
-
-    # Create User Defined Field for Contact
-    def create_user_defined_field (contact_id, params)
-      update_user_defined_field(contact_id, 0, params)
-    end
-  end
-end

data/lib/ruby-redtail/settings.rb

@@ -1,31 +0,0 @@
-module RubyRedtail
-  class Settings
-    METHODS = {
-      :activity_types => 'activitytypes', 
-      :master_categories => 'mcl', 
-      :salutations => 'salutations', 
-      :user_defined_fields => 'udf', 
-      :tag_groups => 'taggroups'
-    }
-    METHODS_WITH_DELETE = {
-      :contact_statuses => 'csl', 
-      :contact_categories => 'mccl', 
-      :contact_sources => 'mcsl', 
-      :servicing_advisors => 'sal', 
-      :writing_advisors => 'wal'
-    }
-
-    def initialize api_hash
-      @api_hash = api_hash
-    end
-
-    METHODS.each do |name, uri|
-      define_method(name) { RubyRedtail::Query.run("settings/#{uri}", @api_hash, "GET") }
-    end
-
-    METHODS_WITH_DELETE.each do |name, uri|
-      define_method(name) { |deleted=false| RubyRedtail::Query.run("settings/#{uri}?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")}
-    end
-
-  end
-end