ruby-redtail 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2QzZDlhMWI3MjI1N2E5YjRiMWQ0ZmJhMjljMzI4NWI4NTNjN2FlOQ==
+  data.tar.gz: !binary |-
+    ZTAzYjM4MTY0ZDYzZWE2N2UzNzRmOTcxOTEyMDZlYWExZWNjNGMzMg==
+SHA512:
+  metadata.gz: !binary |-
+    MDZlZjRlOTE1NDg0ZGNhMmJkYjc3MTQyOGQxZWY1OTBmZjgzZTYzNWU4NmMx
+    NWI1YzFjMzQ4NjIyYWI2NWRhMGU0N2E3ZWM3MTM1NGQyOThlOThlZTAyZWIy
+    ODk2NzA2NzUyNTViOTJlYjY2Y2FlN2FmMTE0OGE1ZWNjYTcxYTE=
+  data.tar.gz: !binary |-
+    ZDdkOTEzYWUzMTljOTZmYjEwY2Q3ZDY1MDc2ZjRjOWViYTUxODcxYWFlZjdm
+    Y2RiZDQxNDkzNDhlMzc0ZTgzMDAwY2Q1OWYwMzg1ZTkxOGE2ZjkyMjAwMDI4
+    MTA1ZTk3MjUwNzhmZDNiZjAxYTdiNDQzOTdmZjg0NzgwNWI5OGI=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'httparty'
+
+# group :test do
+#   gem 'turn', :require => false
+# end
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem 'guard'
+  gem 'guard-test'
+end

data/Gemfile.lock

@@ -0,0 +1,116 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.15)
+    builder (3.2.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    descendants_tracker (0.0.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    guard (2.5.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.6)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-test (2.0.4)
+      guard (~> 2.0)
+      test-unit (~> 2.2)
+    hashie (2.0.5)
+    highline (1.6.21)
+    httparty (0.13.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    listen (2.7.0)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.9.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nio4r (1.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.7)
+    test-unit (2.5.5)
+    thor (0.18.1)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    timers (1.1.0)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  guard
+  guard-test
+  httparty
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+notification :ruby_gntp
+guard :test do
+  watch(%r{^test/.+_test\.rb$})
+  # watch('test/test_helper.rb')  { 'test' }
+
+  # Non-rails
+  watch(%r{^lib/ruby-redtail/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Nathan Colgate
+
+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.rdoc

@@ -0,0 +1,47 @@
+= ruby-redtail
+
+Description goes here.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-redtail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-redtail
+
+== Basic Setup
+
+Create a file in `config/initializers/ruby-redtail.rb` and add your API Key, User Name, Password And API URI:
+
+    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
+
+== Contributing to ruby-redtail
+ 
+* 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.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Kudos
+
+To @sampritipanda for his help in the creation of this gem.
+
+== Copyright
+
+Copyright (c) 2014 Nathan Colgate. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "ruby-redtail"
+  gem.homepage = "http://github.com/nathancolgate/ruby-redtail"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem to access the Redtail CRM API}
+  gem.description = %Q{The gem offers various methods to access the Redtail CRM API}
+  gem.email = "nathan@brandnewbox.com"
+  gem.authors = ["Nathan Colgate"]
+  # 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.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-redtail #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ruby-redtail.rb

@@ -0,0 +1,26 @@
+require "base64"
+require 'httparty'
+
+require 'ruby-redtail/user'
+require 'ruby-redtail/exceptions'
+require 'ruby-redtail/query'
+
+module RubyRedtail
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield config
+    raise RubyRedtail::InvalidURIError if (config.api_uri =~ URI::regexp).nil?
+    raise RubyRedtail::AccessKeyError if (config.api_key.empty? || config.secret_key.empty?)
+    config.api_uri << '/' unless config.api_uri[-1, 1] == '/'
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_uri
+    attr_accessor :secret_key
+  end
+end

data/lib/ruby-redtail/accounts.rb

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

@@ -0,0 +1,44 @@
+module RubyRedtail
+  class Activities
+
+    def initialize api_hash
+      @api_hash = api_hash
+    end
+
+    # Fetch Activity By User Id, Start Date and End Date
+    def fetch_by_user (user_id, start_date, end_date, basic = true, page = 1)
+      RubyRedtail::Query.run("calendar/#{user_id}#{"/basic" if basic}?startdate=#{start_date}&enddate=#{end_date}&page=#{page}", @api_hash, "GET")
+    end
+
+    # Fetch Activity By Activity Id
+    def fetch (activity_id)
+      RubyRedtail::Query.run("calendar/activities/#{activity_id}", @api_hash, "GET")
+    end
+
+    # Update Activity
+    def update(activity_id, params)
+      RubyRedtail::Query.run("calendar/activities/#{activity_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create new Activity
+    def create(params)
+      update(0, params)
+    end
+
+    # Mark Activity as Complete
+    def mark_complete(activity_id)
+      RubyRedtail::Query.run("calendar/activities/#{activity_id}/complete", @api_hash, "PUT")
+    end
+
+    # Fetch List of Recent Activities
+    def recent(start_date, page = 1)
+      RubyRedtail::Query.run("calendar/activities/recent?startdate=#{start_date}&page=#{page}", @api_hash, "GET")
+    end
+
+    # Fetch Activities By Contact Id
+    def fetch_by_contact (contact_id, start_date, end_date, basic = true, page = 1)
+      RubyRedtail::Query.run("contacts/#{contact_id}/activities#{"/basic" if basic}?startdate=#{start_date}&enddate=#{end_date}&page=#{page}", @api_hash, "GET")
+    end
+
+  end
+end

data/lib/ruby-redtail/addresses.rb

@@ -0,0 +1,74 @@
+module RubyRedtail
+  class Addresses
+
+    def initialize(api_hash)
+      @api_hash = api_hash
+    end
+
+    # Fetch Address By Contact Id
+    def fetch (contact_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/addresses", @api_hash, "GET")
+    end
+
+    # Update Address
+    def update (contact_id, address_id, params)
+      RubyRedtail::Query.run("contacts/#{contact_id}/addresses/#{address_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create New Address
+    def create (contact_id, params)
+      update(contact_id, 0, params)
+    end
+
+    # Delete Address
+    def delete (contact_id, address_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/addresses/#{address_id}", @api_hash, 'DELETE')
+    end
+
+    # Fetch Phones By Contact Id
+    def phones (contact_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/phones", @api_hash, "GET")
+    end
+
+    # Update Phone
+    def update_phone (contact_id, phone_id, params)
+      RubyRedtail::Query.run("contacts/#{contact_id}/phones/#{phone_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create New Phone
+    def create_phone (contact_id, params)
+      update(contact_id, 0, params)
+    end
+
+    # Delete Phone
+    def delete_phone (contact_id, phone_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/phones/#{phone_id}", @api_hash, 'DELETE')
+    end
+
+    # Fetch Internet Addresses By Contact Id
+    def internet_addresses (contact_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/internets", @api_hash, "GET")
+    end
+
+    # Update Internet Address
+    def update_internet_address (contact_id, internet_id, params)
+      RubyRedtail::Query.run("contacts/#{contact_id}/phones/#{internet_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create New Internet Address
+    def create_internet_address (contact_id, params)
+      update_internet_address(contact_id, 0, params)
+    end
+
+    # Delete Internet Address
+    def delete_internet_address (contact_id, internet_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/phones/#{internet_id}", @api_hash, 'DELETE')
+    end
+
+    # Fetch Assets and Liabilities
+    def assets_and_liabilities (contact_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/assets-liabilities", @api_hash, "GET")
+    end
+
+  end
+end

data/lib/ruby-redtail/contacts.rb

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

@@ -0,0 +1,6 @@
+module RubyRedtail
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class InvalidURIError < Error; end
+  class AccessKeyError < Error; end
+end

data/lib/ruby-redtail/notes.rb

@@ -0,0 +1,27 @@
+module RubyRedtail
+  class Notes
+    def initialize (api_hash)
+      @api_hash = api_hash
+    end
+
+    # Fetch Notes By Contact Id
+    def fetch (contact_id, page = 1)
+      RubyRedtail::Query.run("contacts/#{contact_id}/notes?page=#{page}", @api_hash, "GET")
+    end
+
+    # Update Note
+    def update (contact_id, note_id, params)
+      RubyRedtail::Query.run("contacts/#{contact_id}/notes/#{note_id}", @api_hash, 'PUT', params)
+    end
+
+    # Create New Note
+    def create (contact_id, params)
+      update(contact_id, 0, params)
+    end
+
+    # Fetch Recently Added Notes
+    def recent
+      RubyRedtail::Query.run("contacts/notes/recent", @api_hash, 'GET')
+    end
+  end
+end

data/lib/ruby-redtail/query.rb

@@ -0,0 +1,20 @@
+module RubyRedtail
+  class Query
+    # 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"
+        @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
+      elsif method == "PUT"
+        @response = HTTParty.put(base_uri + uri, :headers => {"Authorization" => auth_hash, 'Content-Type' => 'text/json'}, :body => request_body.to_json).parsed_response
+      elsif method == "DELETE"
+        @response = HTTParty.post(base_uri + uri, :headers => {"Authorization" => auth_hash, 'Content-Type' => 'text/json'}, :body => "").parsed_response
+      end
+
+      return @response
+    end
+  end
+end
+

data/lib/ruby-redtail/settings.rb

@@ -0,0 +1,31 @@
+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

data/lib/ruby-redtail/tag_groups.rb

@@ -0,0 +1,19 @@
+module RubyRedtail
+  class TagGroups
+    def initialize api_hash
+      @api_hash = api_hash
+    end
+
+    def fetch(tag_id)
+      RubyRedtail::Query.run("taggroups/#{tag_id}", @api_hash, "GET")
+    end
+
+    def fetch_contacts(tag_id)
+      RubyRedtail::Query.run("taggroups/#{tag_id}/contacts", @api_hash, "GET")
+    end
+
+    def fetch_by_contact(contact_id)
+      RubyRedtail::Query.run("contacts/#{contact_id}/taggroups", @api_hash, "GET")
+    end
+  end
+end

data/lib/ruby-redtail/user.rb

@@ -0,0 +1,84 @@
+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'
+
+module RubyRedtail
+  class User
+    attr_accessor :api_hash
+
+    def initialize type, *args
+      if type == "Basic"
+        self.api_hash = "Basic " + Base64.strict_encode64("#{RubyRedtail.config.api_key}:#{args[0]}:#{args[1]}")
+      elsif type == "UserKey"
+        self.api_hash = "Userkeyauth " + Base64.strict_encode64("#{RubyRedtail.config.api_key}:#{args[0]}")
+      elsif type == "UserToken"
+        self.api_hash = "UsertokenAuth " + Base64.strict_encode64("#{RubyRedtail.config.api_key}:#{args[0]}")
+      else
+        raise ArgumentError
+      end
+    end
+    
+    def self.authenticate_via_basic(username, password)
+      yield self.new('Basic',username,password)
+    end
+    
+    def self.authenticate_via_user_key(key)
+      yield self.new('UserKey',key)
+    end
+    
+    def self.authenticate_via_user_token(token)
+      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
+    
+    def authentication
+      RubyRedtail::Query.run("authentication", self.api_hash, "GET")
+    end
+	  
+	  def sso
+      Redtail::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
+    end
+
+    def settings
+      RubyRedtail::Settings.new self.api_hash
+    end
+  end
+end

data/ruby-redtail.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "ruby-redtail"
+  s.version = "0.1.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.description = "The gem offers various methods to access the Redtail CRM API"
+  s.email = "nathan@brandnewbox.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "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/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/user.rb",
+    "ruby-redtail.gemspec",
+    "test/helper.rb",
+    "test/user_test.rb"
+  ]
+  s.homepage = "http://github.com/nathancolgate/ruby-redtail"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
+  s.summary = "A gem to access the Redtail CRM API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    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<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-test>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-test>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-test>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby-redtail'
+
+class Test::Unit::TestCase
+  def setup
+    @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'
+    @num = 4
+    RubyRedtail.configure do |config|
+      config.api_key = @redtail_api_key
+      config.secret_key = @redtail_secret_key
+      config.api_uri = @redtail_uri
+    end
+  end
+end

data/test/user_test.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+class UserTest < Test::Unit::TestCase
+  
+  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"])
+  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)
+  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)
+  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)
+  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)
+    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)
+    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)
+    # 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)
+  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)
+  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)
+  end
+  
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: ruby-redtail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Colgate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4xMg==
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4xMg==
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gem offers various methods to access the Redtail CRM API
+email: nathan@brandnewbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- 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/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/user.rb
+- ruby-redtail.gemspec
+- test/helper.rb
+- test/user_test.rb
+homepage: http://github.com/nathancolgate/ruby-redtail
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A gem to access the Redtail CRM API
+test_files: []