sunspot4r 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Josh Dennis
+
+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

@@ -0,0 +1,3 @@
+== Sunspot4R
+
+You should document your project here.

data/README.markdown

@@ -0,0 +1,21 @@
+# Daxko_Connect
+
+    Ruby wrapper for [DAXKO Connect](http://www.daxko.com/connect).
+
+    Based on the original Sunspot4R written by Tony Summerville's (tony.summerville@daxko.com).
+
+## Installation
+
+    sudo gem install daxko_connect
+
+## Usage
+
+### Authenticate
+
+### Examples
+
+## TODO
+
+## Copyright
+
+Copyright (c) 2010 [Josh Dennis](http://joshdennis.net). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sunspot4r"
+    gem.summary = %Q{Ruby wrapper for DAXKO Sunspot}
+    gem.description = %Q{Ruby wrapper for DAXKO Sunspot}
+    gem.email = "dennijo@gmail.com"
+    gem.homepage = "http://github.com/dennijo/sunspot4R"
+    gem.authors = ['Tony Summerville', 'Josh Dennis']
+    gem.files   = FileList["[A-Z]*", "{lib,test}/**/*"]
+    gem.add_dependency('savon', '>= 0.7.8')
+    gem.add_dependency('shoulda')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "daxko_connect #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Sunspot4R.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sunspot4r}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tony Summerville", "Josh Dennis"]
+  s.date = %q{2010-08-04}
+  s.description = %q{Ruby wrapper for DAXKO Sunspot}
+  s.email = %q{dennijo@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+     "README",
+     "README.markdown",
+     "Rakefile",
+     "Sunspot4R.gemspec",
+     "VERSION",
+     "lib/ext/savon/request.rb",
+     "lib/sunspot4r.rb",
+     "lib/sunspot4r/base_sunspot_service_client.rb",
+     "lib/sunspot4r/object_service_client.rb",
+     "lib/sunspot4r/security_service_client.rb",
+     "lib/sunspot4r/system_service_client.rb",
+     "test/config.yml",
+     "test/object_service_client_test.rb",
+     "test/security_service_client_test.rb",
+     "test/system_service_client_test.rb",
+     "test/test_helper.rb",
+     "test/test_suite.rb"
+  ]
+  s.homepage = %q{http://github.com/dennijo/sunspot4R}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby wrapper for DAXKO Sunspot}
+  s.test_files = [
+    "test/object_service_client_test.rb",
+     "test/security_service_client_test.rb",
+     "test/system_service_client_test.rb",
+     "test/test_helper.rb",
+     "test/test_suite.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, [">= 0.7.8"])
+      s.add_runtime_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<savon>, [">= 0.7.8"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<savon>, [">= 0.7.8"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/ext/savon/request.rb

@@ -0,0 +1,27 @@
+module Savon
+  class Request
+
+    # FIXME
+    # Must add a double quote (") to the soap action for Sunspot to recognize it properly
+    def soap_headers
+      { "Content-Type" => ContentType[@soap.version], "SOAPAction" => "\"#{@soap.action}\"" }
+    end
+
+    # Returns the Net::HTTP object.
+    #
+    # Changed the verify mode to "VERIFY_NONE" to get rid of "warning: peer certificate
+    # won't be verified in this SSL session" before each request.
+    def http
+      unless @http
+        @http = Net::HTTP::Proxy(@proxy.host, @proxy.port).new @endpoint.host, @endpoint.port
+        @http.read_timeout = 300
+        @http.ssl_client_auth(:verify_mode => OpenSSL::SSL::VERIFY_NONE)
+      end
+      @http
+    end
+
+  end
+end
+
+# Turning off logging improves performance
+Savon::Request.log = false

data/lib/sunspot4r.rb

@@ -0,0 +1,23 @@
+# The main Sunspot4R module, serving as a namespace for all Sunspot services.
+
+module Sunspot4R
+
+  NAME = 'SUNSPOT4R'
+  VERSION = '0.1'
+  USER_AGENT  = "%s %s" % [NAME, VERSION]
+  
+end
+
+# Gem dependencies.
+require 'rubygems'
+require 'savon'
+require 'nokogiri'
+require 'shoulda'
+
+# Extensions & overrides.
+require 'ext/savon/request'
+
+# Core files.
+require 'sunspot4r/system_service_client'
+require 'sunspot4r/security_service_client'
+require 'sunspot4r/object_service_client'

data/lib/sunspot4r/base_sunspot_service_client.rb

@@ -0,0 +1,77 @@
+module Sunspot4R
+
+  # = Sunspot4R::BaseSunspotServiceClient
+  #
+  # Sunspot4R::BaseSunspotServiceClient is service class client that all other
+  # Sunspot services extend.
+  class BaseSunspotServiceClient < Savon::Client
+
+    # Name of the Sunspot service.  Used to build SOAPAction URLs dynamically.
+    def service_name
+      '<add service_name>'
+    end
+
+    attr_accessor :base_uri
+
+    # Optionally pass in the session_guid which will then be placed in the soap
+    # package header for each request.
+    def initialize(base_url, options = {})
+      @session_guid = options.delete(:session_guid)
+      endpoint = "#{base_url}/Partner/#{service_name}"
+      
+      super endpoint, options
+      #super endpoint, :proxy => 'http://127.0.0.1:8888'
+    end
+
+    private
+
+    # Same as +super+ but also conveniently enhances a few things:
+    #   * Capitalizes & adds a base URL to the action
+    #   * Capitalizes the input
+    #   * Adds the +xmlns:wsdl+ namespace
+    #   * Adds SessionIdentifier+ if the +session_guid+ is not nil
+    #   * Adds the +xmlns:imp+ "Import" namespace
+    def setup_objects(action, input, &block)
+      super add_base_url_to_action(action), capitalize_first_letter(input), &block
+      add_namespace
+      add_imports_namespace
+      add_session_identifier
+    end
+
+    # Adds the needed base url to the action & captializes the action name so
+    # Sunspot will recognize it properly.
+    def add_base_url_to_action(action)
+      "http://sunspot.arcsolutionsinc.com/Services/I#{service_name}/#{capitalize_first_letter(action)}"
+    end
+
+    # Capitalizes the first letter of a string but leaves everything else the same,
+    # unlike string.capitalize which lowercases the rest of the letters in a word.
+    # Needed because SOAP actions & inputs CamelCase.
+    def capitalize_first_letter(str)
+      str.gsub(/^[a-z]/) { |a| a.upcase }
+    end
+
+    # Adds the basic namespace to the SOAP request if one has not already been set.
+    def add_namespace
+      unless @soap.namespaces.include?("xmlns:wsdl")
+        @soap.namespace = 'http://sunspot.arcsolutionsinc.com/Services'
+      end
+    end
+
+    # Adds the +xmlns:imp+ to the soap request if the +session_guid+ is not nil.
+    def add_imports_namespace
+      unless @session_guid.nil? || @soap.nil?
+        @soap.namespaces["xmlns:imp"] = "http://sunspot.arcsolutionsinc.com/Services/Imports"
+      end
+    end
+
+    # Adds the +imp:SessionIdentifier+ to the soap request if the +session_guid+
+    # is not nil.
+    def add_session_identifier
+      unless @session_guid.nil? || @soap.nil?
+        @soap.header = "<imp:SessionIdentifier Id=\"#{@session_guid}\" />"
+      end
+    end
+
+  end
+end

data/lib/sunspot4r/object_service_client.rb

@@ -0,0 +1,145 @@
+require 'sunspot4r/base_sunspot_service_client'
+
+module Sunspot4R
+
+  # == Sunspot::ObjectServiceClient
+  #
+  # TODO - Description
+  class ObjectServiceClient < BaseSunspotServiceClient
+
+    # Name of the Sunspot service.  Used to build SOAPAction URLs dynamically.
+    def service_name
+      'ObjectService'
+    end
+    
+    # Returns a list of all Polaris objects accessible to the current user.
+    #
+    # Response body XML (abbreviated):
+    #
+    #    <GetAvailableObjectsResponse xmlns="http://sunspot.arcsolutionsinc.com/Services">
+    #       <GetAvailableObjectsResult xmlns:a="http://ARC.Polaris.Sunspot.Services" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
+    #          <ApiFaults xmlns="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.API.Results" xmlns:b="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.API"/>
+    #          <Errors xmlns="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.API.Results" xmlns:b="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.Types"/>
+    #          <Exception i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.API.Results" xmlns:b="http://schemas.datacontract.org/2004/07/System"/>
+    #          <Success xmlns="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.API.Results">true</Success>
+    #          <a:Objects xmlns:b="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.Types">
+    #             <b:NameValuePair>
+    #                <b:Name>Advertising Rate</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">AdvertisingRate</b:Value>
+    #             </b:NameValuePair>
+    #             <b:NameValuePair>
+    #                <b:Name>Career Center Bundle Product</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">CareerCenterBundleProduct</b:Value>
+    #             </b:NameValuePair>
+    #             <b:NameValuePair>
+    #                <b:Name>Career Center Coupon</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">CareerCenterCoupon</b:Value>
+    #             </b:NameValuePair>
+    #             <b:NameValuePair>
+    #                <b:Name>Tax Product</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">TaxProduct</b:Value>
+    #             </b:NameValuePair>
+    #          </a:Objects>
+    #          <a:_objects xmlns:b="http://schemas.datacontract.org/2004/07/ARC.Polaris.Common.Types">
+    #             <b:NameValuePair>
+    #                <b:Name>Advertising Rate</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">AdvertisingRate</b:Value>
+    #             </b:NameValuePair>
+    #             <b:NameValuePair>
+    #                <b:Name>Career Center Bundle Product</b:Name>
+    #                <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">CareerCenterBundleProduct</b:Value>
+    #             </b:NameValuePair>
+    #          </a:_objects>
+    #       </GetAvailableObjectsResult>
+    #    </GetAvailableObjectsResponse>
+    def available_objects(association_guid, base_object)
+      response = call :get_available_objects! do |soap|
+        soap.body = {
+          "wsdl:associationGuid" => association_guid,
+          "wsdl:baseObject" => base_object,
+          :order! => ["wsdl:associationGuid", "wsdl:baseObject"]
+        }
+      end
+      response.to_hash[:get_available_objects_response][:get_available_objects_result]
+    end
+
+    # Loads an object from the system by its GUID.
+    #
+    # This operation will return either a single object or a null value back.
+    # Note that the security placed upon the logged in user is enforced through
+    # this operation – if you query an object that your logged in Sunspot
+    # account does not have access to, expect an API error to be returned.
+    #
+    # This operation will return a single PolarisObject that represents the
+    # object you are looking for, or null if non were found.
+    #
+    def query_by_guid(guid)
+      response = call :query_by_guid! do |soap|
+        soap.body = {
+          "wsdl:guid" => guid
+        }
+      end
+      response.to_hash[:query_by_guid_response][:query_by_guid_result]
+    end
+
+    # #Upsert #Saves an object into the system, inserting it if it does not
+    # exist and updating it if it does. #This is your general purpose
+    # SaveOrUpdate operation that determines whether or not the object #exists
+    # and updates it if it does, inserts it if it doesn’t. The system uses the
+    # read-only #RepositoryKey property of the PolarisObject to determine
+    # whether or not it exists in the system. #This operation will return an
+    # updated version of the object that was saved. If the object was new, #then
+    # this updated version will contain the generated GUID and any other
+    # automatically generated information.
+    def upsert
+
+    end
+
+    def describe_object(association_guid, base_object)
+      response = call :describe_p_object! do |soap|
+        soap.body = {
+          "wsdl:associationGuid" => association_guid,
+          "wsdl:objectName" => base_object,
+          :order! => ["wsdl:associationGuid", "wsdl:objectName"]
+        }
+      end
+      response.to_hash[:describe_p_object_response][:describe_p_object_result]
+    end
+
+    def get_all(association_guid, base_object)
+      response = call :get_all! do |soap|
+        soap.body = {
+          "wsdl:associationGuid" => association_guid,
+          "wsdl:objectName" => base_object,
+          :order! => ["wsdl:associationGuid", "wsdl:objectName"]
+        }
+      end
+      response.to_hash[:get_all_response][:get_all_result]
+    end
+
+    def query(association_guid, query, first = nil, max = nil)
+      unless first.nil? || max.nil?
+        response = call :query! do |soap|
+          soap.body = {
+            "wsdl:associationGuid" => association_guid,
+            "wsdl:query" => query,
+            "wsdl:firstResult" => first,
+            "wsdl:maxResults" => max,
+            :order! => ["wsdl:associationGuid", "wsdl:query", "wsdl:firstResult", "wsdl:maxResults"]
+          }
+        end
+      else
+        response = call :query! do |soap|
+          soap.body = {
+            "wsdl:associationGuid" => association_guid,
+            "wsdl:query" => query,
+            :order! => ["wsdl:associationGuid", "wsdl:query"]
+          }
+        end
+      end
+      response.to_hash[:query_response][:query_result]
+      #response.to_xml
+    end
+  end
+
+end