gi_cat_driver 0.2.4 → 0.2.5

data/README.md

@@ -43,6 +43,8 @@ Annotated source code documentation is available at http://nsidc.github.com/gi_c
 Rubydoc API documentation is available at http://rubydoc.info/gems/gi_cat_driver/
 
 ## Version History
+* 0.2.5
+  * Added new methods to enable and disable published profilers (GI-Cat interfaces) for a profile
 * 0.2.4
   * Added new methods to create and delete accessors (GI-Cat resources) for a profile
 * 0.2.3

data/lib/gi_cat_driver.rb

@@ -16,6 +16,7 @@ module GiCatDriver
   class GiCat
 
     ATOM_NAMESPACE = { "atom" => "http://www.w3.org/2005/Atom" }
+    OPENSEARCH_NAMESPACE = { "opensearch" => "http://a9.com/-/spec/opensearch/1.1/" }
     RELEVANCE_NAMESPACE = { "relevance" => "http://a9.com/-/opensearch/extensions/relevance/1.0/" }
     attr_accessor :base_url
 
@@ -105,13 +106,25 @@ module GiCatDriver
       set_lucene_enabled false
     end
 
+    # Perform an ESIP OpenSearch query using a search term against GI-Cat and returns a Nokogiri XML document
+    def query_esip_opensearch( search_term )
+      query_string = EsipOpensearchQueryBuilder::get_query_string({ :st => search_term })
+
+      begin
+        file = open("#{@base_url}/services/opensearchesip#{query_string}")
+      rescue => e
+        raise "Failed to query GI-Cat ESIP OpenSearch interface."
+      end
+
+      return Nokogiri::XML(file)
+    end
+
     # Find out whether Lucene indexing is turned on for the current profile
     # It is desirable to use REST to query GI-Cat for the value of this setting but GI-Cat does not yet support this.  
     # Instead, run a query and check that a 'relevance:score' element is present.
     # Returns true if Lucene is turned on
     def is_lucene_enabled?
-      query_string = EsipOpensearchQueryBuilder::get_query_string({ :st => "arctic%20alaskan%20shrubs" })
-      results = Nokogiri::XML(open("#{@base_url}/services/opensearchesip#{query_string}"))
+      results = query_esip_opensearch("arctic%20alaskan%20shrubs")
 
       result_scores = results.xpath('//atom:feed/atom:entry/relevance:score', ATOM_NAMESPACE.merge(RELEVANCE_NAMESPACE))
       result_scores.map { |score| score.text }
@@ -119,6 +132,11 @@ module GiCatDriver
       return result_scores.count > 0
     end
 
+    # Parse the totalResults element in an OpenSearch ESIP XML document
+    def get_total_results( xml_doc )
+      return xml_doc.xpath('//atom:feed/opensearch:totalResults', ATOM_NAMESPACE.merge(OPENSEARCH_NAMESPACE)).text.to_i
+    end
+
     # Harvest all resource in the active profile
     # The default timeout is 1500 seconds (25 minutes)
     def harvest_all_resources_for_active_configuration timeout=1500
@@ -159,6 +177,29 @@ module GiCatDriver
       end
     end
 
+    # Publish an interface to access GI-Cat data for the given profile name
+    # The interface_configuration is a hash that defines a 'profiler' and 'path'
+    def publish_interface( profile_name, interface_configuration )
+      profile_id = find_profile_id(profile_name)
+
+      response = Faraday.post do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/profilers/"
+        req.headers = AUTHORIZATION_HEADERS.merge({:enctype=>'multipart/form-data', :content_type=>'application/x-www-form-urlencoded'})
+        req.body = interface_configuration
+      end
+
+      return response.body
+    end
+
+    def unpublish_interface( profile_name, interface_name )
+      profile_id = find_profile_id(profile_name)
+
+      Faraday.get do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/profilers/#{interface_name}", { :delete => 'true', :random => generate_random_number }
+        req.headers = AUTHORIZATION_HEADERS.merge({:enctype=>'multipart/form-data', :content_type=>'application/x-www-form-urlencoded'})
+      end
+    end
+
     #### Private Methods
 
     private

data/lib/gi_cat_driver/version.rb

@@ -1,3 +1,3 @@
 module GiCatDriver
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/gi_cat_driver_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
-require 'gi_cat_driver'
 require 'webmock/rspec'
+require 'gi_cat_driver'
 
 describe GiCatDriver do
   before(:all) do
@@ -170,12 +170,7 @@ describe GiCatDriver do
         }, :query => {:opts => "active"})
         .to_return(:status => 200, :body => "", :headers => {})
 
-      query_url = "http://www.somecompany.com/services/opensearchesip?bbox=&ct=&gdc=&lac=&loc=&luc=&outputFormat=&rel=&si=&st=arctic%20alaskan%20shrubs&te=&ts="
-      stub_request(:get, query_url)
-        .with(:headers => {
-          'Accept'=>'*/*',
-          'User-Agent'=>'Ruby'
-        }).to_return(:status => 200, :body => File.new("spec/fixtures/opensearchesip_lucene_enabled.xml"), :headers => {})
+      @gi_cat.stub(:open).and_return File.new("spec/fixtures/opensearchesip_lucene_enabled.xml")
 
       @gi_cat.enable_lucene
 
@@ -274,6 +269,59 @@ describe GiCatDriver do
     end
   end
 
+  describe "profiler (published interface) configurations" do
+    it "publishes the opensearch esip interface" do
+      profile_name = "some_profile"
+      interface_config = {:profiler => "OPENSEARCH-ESIP", :path => "opensearchesip?"}
+
+      active_conf_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations"
+      stub_request(:get,active_conf_url)
+        .with(:headers => {
+          'Accept'=>'application/xml', 
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+          'User-Agent'=>'Ruby', 
+          'Content-Type'=>'*/*'
+        }, :query => {:nameRepository => "gicat"})
+        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+
+      stub_request(:post, "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/profilers/").
+        with(:body => {"path"=>"opensearchesip?", "profiler"=>"OPENSEARCH-ESIP"},
+             :headers => {'Accept'=>'application/xml', 'Content-Type'=>'application/x-www-form-urlencoded', 'Enctype'=>'multipart/form-data', 'User-Agent'=>'Ruby'}).
+             to_return(:status => 200, :body => "save", :headers => {})
+
+      @gi_cat.stub(:open).and_return File.new("spec/fixtures/opensearchesip_lucene_enabled.xml")
+
+      response = @gi_cat.publish_interface(profile_name, interface_config)
+      response.should eql("save")
+      result_xml = @gi_cat.query_esip_opensearch("arctic%20alaskan%20shrubs")
+      @gi_cat.get_total_results(result_xml).should be > 0
+    end
+
+    it "unpublishes the opensearch esip interface" do
+      profile_name = "some_profile"
+      interface_name = "OPENSEARCH-ESIP"
+
+      active_conf_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations"
+      stub_request(:get,active_conf_url)
+        .with(:headers => {
+          'Accept'=>'application/xml', 
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+          'User-Agent'=>'Ruby', 
+          'Content-Type'=>'*/*'
+        }, :query => {:nameRepository => "gicat"})
+        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+
+      @gi_cat.stub(:generate_random_number).and_return("1")
+
+      stub_request(:get, "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/profilers/OPENSEARCH-ESIP?delete=true&random=1").
+        with(:headers => {'Accept'=>'application/xml', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'Enctype'=>'multipart/form-data', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      @gi_cat.unpublish_interface profile_name, interface_name
+      lambda {@gi_cat.query_esip_opensearch "arctic%20alaskan%20shrubs"}.should raise_error(RuntimeError)
+    end
+  end
+
   describe "accessor (xml feed resource) configurations" do
     it "creates a new feed resource for a profile" do
       profile_name = 'some_profile'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gi_cat_driver
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-20 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday