infusionsoft 1.1.8 → 1.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5093b99e37a3b833ebe5904cdfa74630f606cfc
+  data.tar.gz: 40a88c2dcc0209bf00d22df7c3f9d608451a0e0d
+SHA512:
+  metadata.gz: 94d51f850e3a136432d7bdb87876ce5ca0c62876b6279e086a882eb7551c29238459f67ce6de0388037dcb92ea7dd3c01613338a4b2e817f27782d4d97ce184d
+  data.tar.gz: acf786d0578fd6d3f446bd6c3db04e11ee7041b39de384ab3e4ec9f002801ac37af4e72800a66b10f3a3969e20c6cf991f492d16b830477b252ae90ff80b88c1

data/.gitignore

@@ -3,3 +3,9 @@ log/*.log
 tmp/**/*
 .DS_Store
 rdoc/
+coverage
+.idea
+.bundle
+.ruby-gemset
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-20mode # JRuby in 2.0 mode
+  - rbx-2.5.2

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'mocha'
+  gem 'simplecov', :require => false
+  gem 'test-unit'
+  gem 'vcr'
+  gem 'webmock'
+end

data/LICENSE.md

@@ -1,7 +1,5 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Nathan Leavitt
-
 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

data/README.md

@@ -1,8 +1,15 @@
+[![Build Status](https://travis-ci.org/nateleavitt/infusionsoft.svg?branch=master)](https://travis-ci.org/nateleavitt/infusionsoft)
+[![Coverage Status](https://coveralls.io/repos/nateleavitt/infusionsoft/badge.svg?branch=master&service=github)](https://coveralls.io/github/nateleavitt/infusionsoft?branch=master)
+
+
 # The Infusionsoft Ruby Gem
 A Ruby wrapper for the Infusionsoft API
 
 **update notes**
-
+* Currently - Going to add Infusionsoft API authentication Oauth flow. Also, I'm thinking of rewriting parts of it to make the calls more user friendly and adding some convenience methods. If you have any suggestions, let me know.
+* 07/21/2015 - Implementation of tests and build/coverage (Thanks! @TheMetalCode)
+* v1.1.8 - Added a default user-agent in the headers. Also, give the
+  ability to set your own user-agent in the config block.
 * v1.1.5 - Added a custom logger option.  This will allow you to track all api calls/results in a separate log file.  Defaults to $stdout if none is specified. To add logger specify `api_logger` in your [config block](#setup--configuration).
 
 ## <a name="installation">Installation</a>
@@ -12,14 +19,14 @@ A Ruby wrapper for the Infusionsoft API
 [http://rubydoc.info/gems/infusionsoft/frames](http://rubydoc.info/gems/infusionsoft/frames)
 
 ## <a name="setup">Setup & Configuration</a>
-1. **Rails 2.3** - add `config.gem 'infusionsoft'` **Rails 3** - add `'infusionsoft'` to your `Gemfile`
+1. **Rails 2.3** - add `config.gem 'infusionsoft'` **Rails >= 3** - add `'infusionsoft'` to your `Gemfile`
 2. Then create an initializer in `config\initializers` called infusionsoft.rb and the following
 
 <b></b>
 
     # Added to your config\initializers file
     Infusionsoft.configure do |config|
-      config.api_url = 'YOUR_INFUSIONSOFT_URL' # example infused.infusionsoft.com
+      config.api_url = 'YOUR_INFUSIONSOFT_URL' # example infused.infusionsoft.com DO NOT INCLUDE https://
       config.api_key = 'YOUR_INFUSIONSOFT_API_KEY'
       config.api_logger = Logger.new("#{Rails.root}/log/infusionsoft_api.log") # optional logger file
     end
@@ -29,6 +36,10 @@ A Ruby wrapper for the Infusionsoft API
     # Get a users first and last name using the DataService
     Infusionsoft.data_load('Contact', contact_id, [:FirstName, :LastName])
 
+    # Get a list of custom fields
+    Infusionsoft.data_find_by_field('DataFormField', 100, 0, 'FormId', -1, ['Name'])
+    # Note, when updating custom fields they are case sensisitve and need to be prefaced with a '_'
+
     # Update a contact with specific field values
     Infusionsoft.contact_update(contact_id, { :FirstName => 'first_name', :Email => 'test@test.com' })
 
@@ -62,27 +73,12 @@ Here are some ways *you* can contribute:
 
 ## <a name="issues">Submitting an Issue</a>
 We use the [GitHub issue tracker](https://github.com/nateleavitt/infusionsoft/issues) to track bugs and
-features. Before submitting a bug report or feature request, check to make sure it hasn't already
-been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
-bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
-details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
-operating system. Ideally, a bug report should include a pull request with failing specs.
-
-## <a name="pulls">Submitting a Pull Request</a>
-1. Fork the project.
-2. Create a topic branch.
-3. Implement your feature or bug fix.
-4. Add documentation for your feature or bug fix.
-5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
-6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
-8. Commit and push your changes.
-9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+features.
 
 ## <a name="rubies">Supported Rubies</a>
 This library aims to support the following Ruby implementations:
 
-* Ruby = 1.8.7
+* Ruby = 1.8.7 (It will work, but tests require Ruby >= 1.9)
 * Ruby >= 1.9
 * [JRuby](http://www.jruby.org/)
 * [Rubinius](http://rubini.us/)
@@ -107,7 +103,7 @@ time of a major release, support for that Ruby version may be dropped.
 * Need to add a history log for additional contributers
 
 ## <a name="copyright">Copyright</a>
-Copyright (c) 2013 Nathan Leavitt
+Copyright (c) 2015 Nathan Leavitt
 
 See [LICENSE](https://github.com/nateleavitt/infusionsoft/blob/master/LICENSE.md) for details.
 

data/Rakefile

@@ -1,3 +1,13 @@
-require 'rake/testtask'
+begin
+  require 'rake/testtask'
 
-Rake::TestTask.new
+  Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  #no test-unit available
+end
+
+task default: [:test]

data/infusionsoft.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |gem|
   gem.summary = %q{Ruby wrapper for the Infusionsoft API}
   gem.description = 'A Ruby wrapper written for the Infusionsoft API'
   gem.authors = ["Nathan Leavitt"]
-  gem.email = ['nate@infusedsystems.com']
-  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.email = ['nateleavitt@gmail.com']
+  # gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   gem.files = `git ls-files`.split("\n")
   gem.homepage = 'https://github.com/nateleavitt/infusionsoft'
   gem.require_paths = ['lib']

data/lib/infusionsoft/client.rb

@@ -15,6 +15,7 @@ module Infusionsoft
     require 'infusionsoft/client/ticket' # Deprecated by Infusionsoft
     require 'infusionsoft/client/search'
     require 'infusionsoft/client/credit_card'
+    require 'infusionsoft/client/funnel'
 
     include Infusionsoft::Client::Contact
     include Infusionsoft::Client::Email
@@ -25,5 +26,6 @@ module Infusionsoft
     include Infusionsoft::Client::Ticket # Deprecated by Infusionsoft
     include Infusionsoft::Client::Search
     include Infusionsoft::Client::CreditCard
+    include Infusionsoft::Client::Funnel
   end
 end

data/lib/infusionsoft/client/contact.rb

@@ -11,9 +11,17 @@ module Infusionsoft
       #   { :Email => 'test@test.com', :FirstName => 'first_name', :LastName => 'last_name' }
       def contact_add(data)
         contact_id = get('ContactService.add', data)
-        if data.has_key?("Email"); email_optin(data["Email"], "requested information"); end
+        if data.has_key?(:Email); email_optin(data[:Email], "requested information"); end
         return contact_id
       end
+      
+      # Merge two contacts together.
+      #
+      # @param [Integer] contact_id
+      # @param [Integer] duplicate_contact_id
+      def contact_merge(contact_id, duplicate_contact_id)
+        response = get('ContactService.merge', contact_id, duplicate_contact_id)
+      end
 
       # Adds or updates a contact record based on matching data
       #
@@ -22,7 +30,9 @@ module Infusionsoft
       #   'EmailAndNameAndCompany'
       # @return [Integer] id of the contact added or updated
       def contact_add_with_dup_check(data, check_type)
-        response = get('ContactService.addWithDupCheck', data, check_type)
+        contact_id = get('ContactService.addWithDupCheck', data, check_type)
+        if data.has_key?(:Email); email_optin(data[:Email], "requested information"); end
+        return contact_id
       end
 
       # Updates a contact in the database.
@@ -33,9 +43,9 @@ module Infusionsoft
       # @example
       #   { :FirstName => 'first_name', :StreetAddress1 => '123 N Street' }
       def contact_update(contact_id, data)
-        bool = get('ContactService.update', contact_id, data)
-        if data.has_key?("Email"); email_optin(data["Email"], "requested information"); end
-        return bool
+        contact_id = get('ContactService.update', contact_id, data)
+        if data.has_key?(:Email); email_optin(data[:Email], "requested information"); end
+        return contact_id
       end
 
       # Loads a contact from the database

data/lib/infusionsoft/client/email.rb

@@ -123,7 +123,7 @@ module Infusionsoft
       # @param [String] The Id of the template to send
       # @return returns true if the email has been sent, an error will be sent back otherwise.      
       def email_send_template(contact_list, template_id)
-        response = get('APIEmailService.sendTemplate', contact_list, template_id)
+        response = get('APIEmailService.sendEmail', contact_list, template_id)
       end
 
 

data/lib/infusionsoft/client/funnel.rb

@@ -0,0 +1,18 @@
+module Infusionsoft
+  class Client
+    # Funnel Service is used to add contacts to your sequences
+    module Funnel
+
+      # Achieves a goal, Returns the result of a goal being achieved.
+      # 
+      # @param integration, string, The integration name of the goal. This defaults to the name of the app.
+      # @param call_name, string, The call name of the goal
+      # @param cid, int, The id of the contact you want to add to a sequence.
+      # 
+      def funnel_achieve_goal(integration, call_name, cid)
+        response = get('FunnelService.achieveGoal', integration, call_name, cid)
+      end
+      
+    end
+  end
+end

data/lib/infusionsoft/client/invoice.rb

@@ -40,7 +40,7 @@ module Infusionsoft
       # @param [Integer] credit_card_id
       # @param [Integer] merchant_account_id
       # @param [Boolean] bypass_commission
-      # @return [Hash] containing the following keys {'Successful => [Boolean],
+      # @return [Hash] containing the following keys {'Successful' => [Boolean],
       #   'Code' => [String], 'RefNum' => [String], 'Message' => [String]}
       def invoice_charge_invoice(invoice_id, notes, credit_card_id, merchant_account_id,
                                  bypass_commissions)

data/lib/infusionsoft/connection.rb

@@ -14,7 +14,7 @@ module Infusionsoft
       })
       client.http_header_extra = {'User-Agent' => user_agent}
       begin
-        api_logger.info "CALL: #{service_call} api_key:#{api_key} at:#{Time.now} args:#{args.inspect}"
+        api_logger.info "CALL: #{service_call} api_url: #{api_url} api_key:#{api_key} at:#{Time.now} args:#{args.inspect}"
         result = client.call("#{service_call}", api_key, *args)
         if result.nil?; ok_to_retry('nil response') end
       rescue Timeout::Error => timeout

data/lib/infusionsoft/request.rb

@@ -1,4 +1,5 @@
 module Infusionsoft
+  # Incase Infusionsoft ever creates a restful API :)
   module Request
     # Perform an GET request
     def get(service_call, *args)

data/lib/infusionsoft/version.rb

@@ -1,4 +1,4 @@
 module Infusionsoft
   # The version of the gem
-  VERSION = '1.1.8'.freeze unless defined?(::Infusionsoft::VERSION)
+  VERSION = '1.1.9'.freeze unless defined?(::Infusionsoft::VERSION)
 end

data/test/client/contact_test.rb

@@ -0,0 +1,79 @@
+require_relative('../test_helper')
+
+class ContactTest < Test::Unit::TestCase
+
+  def test_contact_add
+    data_hash = { Email: 'test@tester.com', FirstName: 'Severus', LastName: 'Snape' }
+    VCR.use_cassette('contact_add') do
+      result = Infusionsoft.contact_add(data_hash)
+      assert_instance_of Fixnum, result
+    end
+  end
+
+  def test_contact_merge
+    VCR.use_cassette('contact_merge') do
+      result = Infusionsoft.contact_merge(3602, 3604)
+      assert_true result
+    end
+  end
+
+  def test_contact_add_dup_check_with_dup
+    data_hash = { Email: 'test@tester.com', FirstName: 'Severus',
+                  LastName: 'Snape', Company: 'Test Company' }
+    VCR.use_cassette('contact_add_dup_check_with_dup') do
+      existing_contact = Infusionsoft.contact_load(3606, [:Id, :FirstName, :LastName, :Email, :Company])
+      result = Infusionsoft.contact_add_with_dup_check(data_hash, 'EmailAndName')
+      assert_equal result, existing_contact['Id']
+      assert_equal Infusionsoft.contact_load(existing_contact['Id'], [:Company])['Company'], data_hash[:Company]
+    end
+  end
+
+  def test_contact_add_dup_check_no_dup
+    data_hash = { Email: 'new@tester.com', FirstName: 'Albus',
+                  LastName: 'Dumbledore', Company: 'Hogwarts' }
+    VCR.use_cassette('contact_add_dup_check_no_dup') do
+      result = Infusionsoft.contact_add_with_dup_check(data_hash, 'EmailAndNameAndCompany')
+      assert_instance_of Fixnum, result
+    end
+  end
+
+  def test_contact_load
+    desired_fields = [:FirstName, :LastName]
+    expected_fields = desired_fields.map { |f| f.to_s }.sort
+    VCR.use_cassette('contact_load') do
+      result = Infusionsoft.contact_load(3606, desired_fields)
+      assert_equal result.keys.sort, expected_fields
+    end
+  end
+
+  def test_contact_update
+    data_hash = { Company: 'Hogwarts' }
+    VCR.use_cassette('contact_update') do
+      result = Infusionsoft.contact_update(3606, data_hash)
+      assert_equal result, 3606
+      assert_equal Infusionsoft.contact_load(3606, [:Company])['Company'], data_hash[:Company]
+    end
+  end
+
+  def test_contact_find_by_email
+    VCR.use_cassette('find_by_email') do
+      result = Infusionsoft.contact_find_by_email('test@tester.com', [:Id])
+      assert_instance_of Array, result
+      assert_instance_of Hash, result.first
+    end
+  end
+
+  def test_contact_add_to_group
+    VCR.use_cassette('add_to_group') do
+      result = Infusionsoft.contact_add_to_group(3794, 382)
+      assert_true result
+    end
+  end
+
+  def test_contact_remove_from_group
+    VCR.use_cassette('remove_from_group') do
+      result = Infusionsoft.contact_remove_from_group(3794, 382)
+      assert_true result
+    end
+  end
+end

data/test/client/data_test.rb

@@ -0,0 +1,102 @@
+require_relative('../test_helper')
+
+class DataTest < Test::Unit::TestCase
+
+  def test_data_add
+    data_hash = { Company: 'Hogwarts of America', Phone1: '123-456-7899',
+                  Website: 'http://hogwarts-usa.com', StreetAddress1: '123 Wizard Ave.',
+                  City: 'Redmond', State: 'WA', PostalCode: '98052',
+                  Country: 'United States' }
+    VCR.use_cassette('data_add') do
+      result = Infusionsoft.data_add('Company', data_hash)
+      assert_instance_of Fixnum, result
+    end
+  end
+
+  def test_data_load
+    desired_fields = [:Company, :StreetAddress1, :City, :State, :PostalCode, :Country]
+    expected_fields = desired_fields.map { |f| f.to_s }.sort
+    VCR.use_cassette('data_load') do
+      result = Infusionsoft.data_load('Company', 3618, desired_fields)
+      assert_equal result.keys.sort, expected_fields
+    end
+  end
+
+  def test_data_update
+    update_hash = { Phone1: '(987) 654-3211' }
+    VCR.use_cassette('data_update') do
+      result = Infusionsoft.data_update('Company', 3618, update_hash)
+      assert_equal result, 3618
+      assert_equal Infusionsoft.data_load('Company', 3618, [:Phone1])['Phone1'], update_hash[:Phone1]
+    end
+  end
+
+  def test_data_delete
+    VCR.use_cassette('data_delete') do
+      result = Infusionsoft.data_delete('Company', 3618)
+      assert_true result
+    end
+  end
+
+  def test_data_find_by_field
+    VCR.use_cassette('data_find_by_field') do
+      result = Infusionsoft.data_find_by_field('Company', 5, 0, :Company, 'Hogwarts of America', [:Id, :Company])
+      assert_instance_of Array, result
+      assert_compare result.size, :>, 0
+    end
+  end
+
+  def test_data_query
+    VCR.use_cassette('data_query') do
+      result = Infusionsoft.data_query('Company', 5, 0, { :Company => 'Hogwarts of America' }, [:Id, :Company])
+      assert_instance_of Array, result
+      assert_compare result.size, :>, 0
+    end
+  end
+
+  def test_data_query_order_by
+    VCR.use_cassette('data_query_order_by') do
+      result = Infusionsoft.data_query_order_by('Company', 5, 0, { :Company => 'Hogwarts of America' }, [:Id, :Company], :Id, false)
+      assert_instance_of Array, result
+      assert_compare result.size, :>, 0
+      assert_compare result.first['Id'].to_i, :>, result.last['Id'].to_i
+    end
+  end
+
+  def test_data_add_custom_field
+    VCR.use_cassette('data_add_custom_field') do
+      result = Infusionsoft.data_add_custom_field('Company', 'Awesomeness Level', 'Text', 4)
+      assert_instance_of Fixnum, result
+    end
+  end
+
+  def test_data_auth_user_success
+    password = Digest::MD5.new.hexdigest 'good_pass'
+    VCR.use_cassette('data_auth_user_success') do
+      result = Infusionsoft.data_authenticate_user('test@test.com', password)
+      assert_instance_of Fixnum, result
+    end
+  end
+
+  def test_data_auth_user_failure
+    VCR.use_cassette('data_auth_user_failure') do
+      assert_raise_kind_of Infusionsoft::FailedLoginAttemptError do
+        Infusionsoft.data_authenticate_user('test@test.com', 'bad_pass')
+      end
+    end
+  end
+
+  def test_data_update_custom_field
+    VCR.use_cassette('data_update_custom_field') do
+      result = Infusionsoft.data_update_custom_field(16, {:Label => 'Stuff'} )
+      assert_true result
+    end
+  end
+
+  def test_data_get_app_setting
+    VCR.use_cassette('data_get_app_setting') do
+      result = Infusionsoft.data_get_app_setting('Contact', 'optiontitles')
+      assert_not_nil result
+    end
+  end
+end