office_autopilot_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7d7c8092131eb0c00fdf8b4f6e6d0056d29489f
+  data.tar.gz: 4c13482acbab47bb54ef2df6207742c116516d92
+SHA512:
+  metadata.gz: 88de50b2078e5548909f52f1d1496523c5eeacced13f025f7b2d2500acb27ed1722b8b9c9d67fe91945fa636f2c7ed2aea5131dcaa2ccf592916b7cd4942594a
+  data.tar.gz: d3143011e8bcc35c5b84f76305fc2b725fbb30f45c4e160c937837a4b9736551a85ecb70746660fa5c16b8dde26d2860bda82b73c16466c60d5551ff03400b81

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.rvmrc
+.idea
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in office_autopilot.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Prashant Nadarajan
+
+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.md

@@ -0,0 +1,71 @@
+The OfficeAutopilot Ruby Gem
+============================
+A Ruby wrapper for the OfficeAutopilot API
+
+Installation
+------------
+    gem install office_autopilot_api
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "office_autopilot_api"
+
+    client = OfficeAutopilotApi::Client.new(:api_id => 'xxx', :api_key => 'yyy')
+
+    # Search Contacts
+    puts client.contacts_search(:field => 'E-Mail', :op => 'e', :value => 'prashant@example.com')
+       # results truncated for brevity but ALL fields (including custom fields) are returned
+       => [{"id"=>"7",
+             "Contact Information"=>{"First Name"=>"testing", "Last Name"=>"testing", "E-Mail"=>"prashant@example.com"},
+            "Lead Information"=>{"Contact Owner"=>"XXX", "First Referrer"=>"", "Last Referrer"=>""},
+            "Sequences and Tags"=>{"Sequences"=>"*/*", "Contact Tags"=>""},
+            "Purchase History"=>{}
+          }]
+
+    # Add Contact
+    puts client.contacts_add({ 'Contact Information' => {'First Name' => 'Turtle', 'Last Name' => 'Jones', 'E-Mail' => 'mrturtles@example.com'} })
+       => {"id"=>"24", "Contact Information"=>{"First Name"=>"Turtle", "Last Name"=>"Jones", "E-Mail"=>"mrturtles@example.com"}}
+
+Documentation
+-------------
+
+#### Currently supported API methods:
+
+**Contacts:**
+
+* contacts_search
+
+* contacts_add
+
+* contacts_pull_tag
+
+* contacts_fetch_sequences
+
+* contacts_key
+
+* contacts_fetch
+
+
+[**OfficeAutopilot API Docs**](http://wiki.sendpepper.com/w/page/19528683/API-Documentation)
+
+Todo
+----
+
+* support ALL API calls
+
+Submitting a Pull Request
+-------------------------
+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. Add specs for your feature or bug fix.
+6. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 5.
+7. Commit and push your changes.
+8. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Copyright
+---------
+Copyright (c) 2011 Prashant Nadarajan.
+See [LICENSE](https://github.com/parasquid/office_autopilot/blob/master/MIT_LICENSE) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/office_autopilot_api.rb

@@ -0,0 +1 @@
+require 'office_autopilot_api/client'

data/lib/office_autopilot_api/client.rb

@@ -0,0 +1,51 @@
+require 'builder'
+require 'nokogiri'
+
+require File.expand_path('../error', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../client/contacts', __FILE__)
+
+module OfficeAutopilotApi
+  class Client
+
+    include Contacts
+
+    def initialize(options)
+      @api = {
+        :api_id => options[:api_id],
+        :api_key => options[:api_key]
+      }
+
+      raise ArgumentError, "Missing required parameter: api_id" if @api[:api_id].nil?
+      raise ArgumentError, "Missing required parameter: api_key" if @api[:api_key].nil?
+    end
+
+    def api_id
+      @api[:api_id]
+    end
+
+    def api_key
+      @api[:api_key]
+    end
+
+    def auth
+      { 'Appid' => api_id, 'Key' => api_key }
+    end
+
+    def request(method, path, options)
+      options[:body].merge!(auth)
+      handle_response( OfficeAutopilotApi::Request.send(method, path, options) )
+    end
+
+    def handle_response(response)
+      xml = Nokogiri::XML(response)
+
+      if xml.at_css('result').content =~ /failure/i
+        raise OfficeAutopilotApi::XmlError if xml.at_css('result error').content =~ /Invalid XML/i
+      end
+
+      response
+    end
+
+  end
+end

data/lib/office_autopilot_api/client/contacts.rb

@@ -0,0 +1,160 @@
+module OfficeAutopilotApi
+  class Client
+    module Contacts
+
+      CONTACTS_ENDPOINT = '/cdata.php'
+
+      def contacts_search(options)
+        xml = xml_for_search(options)
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'search', 'data' => xml})
+        parse_contacts_xml(response)
+      end
+
+      def contacts_add(options)
+        xml = xml_for_contact(options)
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'add', 'return_id' => '1', 'data' => xml})
+        parse_contacts_xml(response)[0]
+      end
+      
+      def contacts_update(options)
+        xml = xml_for_contact(options)
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'update', 'return_id' => '1', 'data' => xml})
+        parse_contacts_xml(response)[0]
+      end
+
+      def contacts_pull_tag
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'pull_tag'})
+        parse_xml(response, "tag")
+      end
+
+      def contacts_fetch_sequences
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'fetch_sequences'})
+        parse_xml(response, "sequence")
+      end
+
+      def contacts_key
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'key'})
+        parse_contacts_key_xml(response)
+      end
+
+      def contacts_fetch(ids)
+        xml = xml_for_fetch("contact", ids)
+        response = request(:post, CONTACTS_ENDPOINT, :body => {'reqType' => 'fetch', 'data' => xml})
+        parse_contacts_xml(response)
+      end
+
+      private
+
+      def parse_contacts_xml(response)
+        contacts = []
+        xml = Nokogiri::XML(response)
+        xml.css('result contact').each do |node|
+          contact = {}
+          contact['id'] = node['id']
+
+          node.css('Group_Tag').each do |group_tag|
+            group_tag_name = group_tag['name']
+            contact[group_tag_name] = {}
+
+            group_tag.css('field').each do |field|
+              field_name = field['name']
+              contact[group_tag_name][field_name] = field.content
+            end
+          end
+          contacts << contact
+        end
+        contacts
+      end
+
+      def parse_contacts_key_xml(response)
+        groups = {}
+
+        xml = Nokogiri::XML(response)
+        xml.css('result contact Group_Tag').each do |group_tag|
+          group = { 'fields' => {} }
+          group['editable'] = group_tag['editable'] == '1'
+
+          group_tag.css('field').each do |field_node|
+            field_type = field_node['type']
+            field_info = { 'type' => field_type }
+            field_info['editable'] = field_node['editable'] == '1'
+
+            case field_type
+              when 'tdrop'
+                options = []
+                field_info['options'] = options
+                field_node.css('option').each do |option_node|
+                  options << option_node.content
+                end
+              when 'list'
+                list = {}
+                field_info['list'] = list
+                field_node.css('list').each do |list_node|
+                  list[list_node['id']] = list_node.content
+                end
+            end
+            group['fields'][field_node['name']] = field_info
+          end
+          groups[group_tag['name']] = group
+        end
+        groups
+      end
+
+      def parse_xml(response, element_name)
+        result = {}
+        xml = Nokogiri::XML(response)
+        xml.css("result #{element_name}").each do |node|
+          id = node['id']
+          result[id] = node.content
+        end
+        result
+      end
+
+      def xml_for_contact(options)
+        attrs = {}
+        id = options.delete('id')
+        attrs[:id] = id if id
+        action = options.delete('action')
+        
+        xml = Builder::XmlMarkup.new
+        xml.contact(attrs) do
+          options.each_key do |group_tag|
+            xml.Group_Tag(:name => group_tag) do
+              options[group_tag].each do |field, value|
+                xml_params = {:name => field}
+                xml_params[:action] = action unless action.nil? || action.blank?
+                xml.field(value, xml_params)
+              end
+            end
+          end
+        end
+      end
+
+      def xml_for_fetch(type, ids)
+        xml = ""
+        ids.each do |id|
+          xml << "<#{type}_id>#{id}</#{type}_id>"
+        end
+        xml
+      end
+
+      def xml_for_search(options)
+        if options.is_a?(Hash)
+          options = [options]
+        end
+
+        xml = Builder::XmlMarkup.new
+        xml.search do
+          options.each do |option|
+            xml.equation do
+              xml.field option[:field]
+              xml.op option[:op]
+              xml.value option[:value]
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/office_autopilot_api/error.rb

@@ -0,0 +1,7 @@
+module OfficeAutopilotApi
+  # Custom error class for rescuing from all OfficeAutopilot errors
+  class Error < StandardError; end
+
+  # Raised when OfficeAutopilot returns <result>failure<error>Invalid XML</error></result>
+  class XmlError < Error; end
+end

data/lib/office_autopilot_api/request.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+
+module OfficeAutopilotApi
+  class Request
+
+    include HTTParty
+    base_uri 'http://api.moon-ray.com'
+    format :plain
+
+  end
+end

data/lib/office_autopilot_api/version.rb

@@ -0,0 +1,3 @@
+module OfficeAutopilotApi
+  VERSION = "0.1.0"
+end

data/office_autopilot_api.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "office_autopilot_api/version"
+
+Gem::Specification.new do |s|
+
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('webmock', '~> 1.6')
+
+  s.add_runtime_dependency('httparty', '~> 0.7')
+  s.add_runtime_dependency('builder', '>= 2.1.2')
+  s.add_runtime_dependency('nokogiri', '~> 1.4')
+
+  s.name        = "office_autopilot_api"
+  s.version     = OfficeAutopilotApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Prashant Nadarajan", "parasquid"]
+  s.email       = ["prashant.nadarajan@gmail.com", 'parasquid']
+  s.homepage    = "https://github.com/parasquid/office_autopilot"
+  s.summary     = %q{Ruby wrapper for the OfficeAutopilot API}
+  s.description = %q{A Ruby wrapper for the OfficeAutopilot API}
+
+  s.rubyforge_project = "office_autopilot_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/data/contacts_add_response.xml

@@ -0,0 +1,69 @@
+<result>
+  <contact id='7' date='1299671887' dlm='1299674450' score='0.00' purl='prashant' bulk_mail='1'>
+    <Group_Tag name='Contact Information'>
+      <field name="First Name">prashant</field>
+      <field name="Last Name">nadarajan</field>
+      <field name="E-Mail">prashant@example.com</field>
+      <field name="Home Phone"/>
+      <field name="Title"/>
+      <field name="Office Phone"/>
+      <field name="Cell Phone"/>
+      <field name="Fax"/>
+      <field name="Address"/>
+      <field name="Company"/>
+      <field name="Address 2"/>
+      <field name="City"/>
+      <field name="State"/>
+      <field name="Zip Code"/>
+      <field name="Website "/>
+      <field name="Country"/>
+      <field name="Birthday"/>
+    </Group_Tag>
+    <Group_Tag name='Lead Information'>
+      <field name="Contact Owner">Don Corleone</field>
+      <field name="First Referrer"/>
+      <field name="Last Referrer"/>
+      <field name="Lead Source"/>
+      <field name="Campaign"/>
+      <field name="Ad"/>
+      <field name="Media"/>
+    </Group_Tag>
+    <Group_Tag name='Sequences and Tags'>
+      <field name="Sequences">*/*</field>
+      <field name="Contact Tags"/>
+    </Group_Tag>
+    <Group_Tag name='Purchase History'></Group_Tag>
+    <Group_Tag name='Most Recent Charge'>
+      <field name="Charge Amount">$0.00</field>
+      <field name="Charge Invoice #"/>
+    </Group_Tag>
+    <Group_Tag name='Affiliate Data'>
+      <field name="Affiliate Program"/>
+      <field name="Number of Sales"/>
+      <field name="$ Sales">$0.00</field>
+      <field name="Paypal E-mail"/>
+      <field name="Affiliate Paypal"/>
+    </Group_Tag>
+    <Group_Tag
+        name='Most Recent Invoice'>
+      <field name="Invoice #"/>
+      <field name="Total Invoice Amount">$0.00</field>
+    </Group_Tag>
+    <Group_Tag name='Lead Status'>
+      <field name="Lead Status"/>
+      <field name="Preferencia Contacto"/>
+    </Group_Tag>
+    <Group_Tag name='Credit Card'>
+      <field name="Card Type"/>
+      <field name="Card Expiration Month"/>
+      <field name="Charge Result"/>
+      <field name="Card Expiration Year"/>
+      <field name="Card Number (Last 4)"/>
+      <field name="Payment Center Link"/>
+    </Group_Tag>
+    <Group_Tag name='Invoices'></Group_Tag>
+    <Group_Tag name='Subscriptions and Payment Plans'></Group_Tag>
+    <Group_Tag name='Website Subscribers'></Group_Tag>
+  </contact>
+  <status>Success</status>
+</result>