gi_cat_driver 0.2.1 → 0.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gi_cat_driver (0.2.0)
+    gi_cat_driver (0.2.2)
       faraday (~> 0.8.7)
       nokogiri (~> 1.5.6)
 

data/README.md

@@ -43,6 +43,9 @@ 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.2
+  * Added new methods to create and delete profiles
+  * Fixed harvester request headers and now work properly
 * 0.2.1
   * Fixed harvester requests to use Faraday
 * 0.2.0

data/lib/gi_cat_driver/version.rb

@@ -1,3 +1,3 @@
 module GiCatDriver
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/gi_cat_driver.rb

@@ -39,11 +39,35 @@ module GiCatDriver
       Faraday.get(@base_url + "/").status == 200
     end
 
+    # Add a new profile with the given name
+    def create_profile( profile_name )
+      response = Faraday.post do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/newBroker"
+        req.body = "inputNewName=#{profile_name}&nameBrokerCopy=%20"
+        req.headers = AUTHORIZATION_HEADERS.merge({'enctype' => 'multipart/form-data',:content_type => 'application/x-www-form-urlencoded'})
+      end
+
+      profile_id = response.body
+      return profile_id
+    end
+
+    # Remove a profile with the given name
+    def delete_profile( profile_name )
+      profile_id = find_profile_id( profile_name )
+      response = Faraday.get do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}", { :opts => 'delete', :random => generate_random_number }
+        req.headers = AUTHORIZATION_HEADERS.merge({'enctype'=>'multipart/form-data'})
+      end
+
+      profile_id = response.body
+      return profile_id
+    end
+
     # Retrieve the ID for a profile given the name
     # Returns an integer ID reference to the profile
     def find_profile_id( profile_name )
       response = Faraday.get do |req|
-        req.url @base_url + '/services/conf/brokerConfigurations', :nameRepository => 'gicat'
+        req.url "#{@base_url}/services/conf/brokerConfigurations", :nameRepository => 'gicat'
         req.headers = AUTHORIZATION_HEADERS
       end
 
@@ -126,8 +150,11 @@ module GiCatDriver
     # Retrive the distributor id given a profile id
     def get_active_profile_distributor_id(id)
       active_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{id}"
-      response = Faraday.get(active_profile_request, STANDARD_HEADERS)
-      id = Nokogiri::XML(response.body).css("component id").text
+      response = Faraday.get do |req|
+        req.url active_profile_request
+        req.headers = AUTHORIZATION_HEADERS
+      end
+      id = Nokogiri.XML(response.body).css("component id").text
       return id
     end
 
@@ -135,7 +162,10 @@ module GiCatDriver
     def get_harvest_resources(profile_id)
       id = get_active_profile_distributor_id(profile_id)
       harvest_resource_request = "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/distributors/#{id}"
-      response = Faraday.get(harvest_resource_request, STANDARD_HEADERS)
+      response = Faraday.get do |req|
+        req.url harvest_resource_request
+        req.headers = AUTHORIZATION_HEADERS
+      end
       doc = Nokogiri::XML(response.body)
       harvestersinfo_array = {}
       doc.css("component").each do |component|
@@ -146,53 +176,38 @@ module GiCatDriver
 
     # Harvest from specified resource
     def harvest_resource_for_active_configuration(harvesterid, harvestername = "n/a")
-      Faraday.get(
-        "#{@base_url}/services/conf/brokerConfigurations/#{self.get_active_profile_id}/harvesters/#{harvesterid}/start",
-        AUTHORIZATION_HEADERS) do |response, request, result, &block|
-          case response.code
-          when 200
-            puts "#{Time.now}: Initiate harvesting GI-Cat resource #{harvestername}. Please wait a couple minutes for the process to complete."
-          else
-            raise "Failed to initiate harvesting GI-Cat resource #{harvestername}."
-            response.return!(request, result, &block)
-          end
-        end
-    end
+      response = Faraday.get do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{self.get_active_profile_id}/harvesters/#{harvesterid}/start"
+        req.headers = AUTHORIZATION_HEADERS
+      end
 
-    # Parsing and handle the harvest status
-    def harvest_status(status, harvestername="default")
-      timestamp = Time.now
-      puts "#{Time.now}: Harvest #{harvestername} status: #{status}"
-      case status
-      when /Harvesting completed/
-        return :completed
-      when /Harvesting error/
-        return :error
+      if response.status == 200
+        puts "#{Time.now}: Initiate harvesting GI-Cat resource #{harvestername}. Please wait a couple minutes for the process to complete."
       else
-        return :pending
+        raise "Failed to initiate harvesting GI-Cat resource #{harvestername}."
+        response.return!(request, result, &block)
       end
     end
 
-    # Run till the harvest of a resource is completed
-    def harvest_request_is_done(harvesterid, harvestername="n/a")
+    # Run a loop to request GI-Cat for the status of a harvest
+    def harvest_request_is_done(harvester_id, harvester_name="n/a")
       while(1) do
-        sleep 10    # Wait for ten seconds
-
-        rnum=rand
-        request = @base_url + "/services/conf/giconf/status?id=#{harvesterid}&rand=#{rnum}"
-
-        response = Faraday.get request, STANDARD_HEADERS
-        responsexml = Nokogiri::XML::Reader(response.body)
-        responsexml.each do |node|
-          if node.name == "status" && !node.inner_xml.empty?
-            status = harvest_status(node.inner_xml, harvestername)
-            if status.eql? :error
-              fail "Error harvesting the resource #{harvestername}"
-            elsif status.eql? :completed
-              puts "Succesfully harvested #{harvestername}"
-              return
-            end
-          end
+        sleep 1    # Wait for one second
+
+#        rnum=rand   # Generate unique request to attempt to bypass cache
+        request = @base_url + "/services/conf/giconf/status?id=#{harvester_id}"
+
+        response = Faraday.get do |req|
+          req.url request
+          req.headers = AUTHORIZATION_HEADERS
+        end
+
+        status = parse_status_xml(response.body, harvester_name)
+        if status.eql? :error
+          fail "Error harvesting the resource #{harvester_name}"
+        elsif status.eql? :completed
+          puts "Succesfully harvested #{harvester_name}"
+          break
         end
       end
     end
@@ -219,5 +234,27 @@ module GiCatDriver
       return profile.attr('id').value
     end
 
+    def parse_status_xml( xml_doc, harvester_name )
+        xml = Nokogiri.XML(xml_doc)
+
+        status = xml.css("status").text
+        timestamp = Time.now
+
+        puts "#{Time.now}: Harvest #{harvester_name} status: #{status}"
+
+        case status
+        when /Harvesting completed/
+          return :completed
+        when /Harvesting error/
+          return :error
+        else
+          return :pending
+        end
+
+    end
+
+    def generate_random_number
+      return rand
+    end
   end
 end

data/spec/fixtures/distributors.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><distributors xmlns="http://imaa.cnr.it/sdi/services/7.0/configurationMessages/schema"><distributor id="UUID-682b22a3-8285-48ed-9dc1-4b0f88881d49"><component><id>UUID-a5d11731-9a58-4818-8018-c085cea8b6e3</id><type>Harvester</type><title>CISL OAI</title></component></distributor></distributors>

data/spec/fixtures/status.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><statusHarvesterGiConf xmlns="http://imaa.cnr.it/sdi/services/7.0/configurationMessages/schema"><id>UUID-a5d11731-9a58-4818-8018-c085cea8b6e3</id><status>Harvesting completed</status><progress>0</progress></statusHarvesterGiConf>

data/spec/gi_cat_driver_spec.rb

@@ -22,8 +22,10 @@ describe GiCatDriver do
       expect(running).to be_true
       a_request(:get, @base_url).should have_been_made.once
     end
+  end
 
-    it "can retrieve the active profile id" do
+  describe "profile configurations" do
+    it "retrieves the active profile id" do
       request_url = @base_url + "services/conf/giconf/configuration"
       stub_request(:get, request_url)
         .with(:headers => {
@@ -38,9 +40,7 @@ describe GiCatDriver do
       a_request(:get, request_url).should have_been_made.once
       expect(profile_id).to eq "1"
     end
-  end
 
-  describe "authorized requests" do
     it "can retrieve a profile id given a profile name" do
       request_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations"
       stub_request(:get,request_url)
@@ -110,6 +110,38 @@ describe GiCatDriver do
       expect(@gi_cat.get_active_profile_id).to eq "1"
     end
 
+    it "adds a profile" do
+      stub_request(:get, "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations").
+        with(:headers => {'Accept'=>'application/xml', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'*/*', 'User-Agent'=>'Ruby'}, :query => {:nameRepository => "gicat"}).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      stub_request(:post, "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/newBroker").
+        with(:headers => {'Accept'=>'application/xml', 'Content-Type'=>'application/x-www-form-urlencoded', 'Enctype'=>'multipart/form-data', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => "5", :headers => {})
+
+      profile_id = @gi_cat.create_profile "new-profile"
+
+      profile_id.should eq "5"
+    end
+
+    it "deletes a profile" do
+      stub_request(:get, "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations").
+        with(:headers => {'Accept'=>'application/xml', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'*/*', 'User-Agent'=>'Ruby'}, :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?opts=delete&random=1").
+        with(:headers => {'Accept'=>'application/xml', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'*/*', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => "1", :headers => {})
+
+      profile_id = @gi_cat.delete_profile "some_profile"
+
+      profile_id.should eq "1"
+    end
+  end
+
+  describe "Lucene indexing" do
     it "enables Lucene for the active profile" do
       enable_lucene_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/luceneEnabled"
       stub_request(:put,enable_lucene_url)
@@ -138,8 +170,8 @@ describe GiCatDriver do
         }, :query => {:opts => "active"})
         .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
 
-      enable_conf_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,enable_conf_url)
+      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'
@@ -150,5 +182,95 @@ describe GiCatDriver do
       @gi_cat.is_lucene_enabled?.should be_true
     end
 
+    it "disables Lucene for the active profile" do
+      disable_lucene_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/luceneEnabled"
+      stub_request(:put,disable_lucene_url)
+        .with(:headers => {
+          'Accept'=>'application/xml', 
+          'User-Agent'=>'Ruby', 
+          'Content-Type'=>'*/*'
+        }, :body => "false").to_return(:status => 200, :body => "", :headers => {})
+
+      conf_request_url = "http://www.somecompany.com/services/conf/giconf/configuration"
+      stub_request(:get,conf_request_url)
+        .with(:headers => {
+          'Accept'=>'*/*', 
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+          'User-Agent'=>'Ruby', 
+          'Content-Type'=>'application/xml'
+        }).to_return(:status => 200, :body => "1", :headers => {})
+
+      enable_conf_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1"
+      stub_request(:get,enable_conf_url)
+        .with(:headers => {
+          'Accept'=>'application/xml', 
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+          'User-Agent'=>'Faraday v0.8.7', 
+          'Content-Type'=>'*/*'
+        }, :query => {:opts => "active"})
+        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :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_disabled.xml"), :headers => {})
+
+      @gi_cat.disable_lucene
+
+      @gi_cat.is_lucene_enabled?.should be_false
+    end
+  end
+
+  describe "resource harvesting into the database" do
+    it "harvests all resources for the active profile" do
+      conf_request_url = "http://www.somecompany.com/services/conf/giconf/configuration"
+      stub_request(:get,conf_request_url)
+        .with(:headers => {
+          'Accept'=>'*/*',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'User-Agent'=>'Ruby',
+          'Content-Type'=>'application/xml'
+        }).to_return(:status => 200, :body => "1", :headers => {})
+
+      request_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1"
+      stub_request(:get,request_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'=>'*/*'
+        })
+        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+
+      get_resources_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/distributors/UUID-6c89ab7d-82aa-446c-902e-0b1f6e412a45"
+      stub_request(:get, get_resources_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'=>'*/*'
+        })
+        .to_return(:status => 200, :body => File.new("spec/fixtures/distributors.xml"), :headers => {})
+
+      start_harvest_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/harvesters/UUID-a5d11731-9a58-4818-8018-c085cea8b6e3/start"
+      stub_request(:get, start_harvest_url)
+        .with(:headers => {
+          'Accept'=>'application/xml',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type'=>'*/*',
+          'User-Agent'=>'Ruby'
+        })
+        .to_return(:status => 200, :body => "", :headers => {})
+
+      harvest_status_url = "http://admin:pass@www.somecompany.com/services/conf/giconf/status?id=UUID-a5d11731-9a58-4818-8018-c085cea8b6e3"
+      stub_request(:get, harvest_status_url).
+        with(:headers => {'Accept'=>'application/xml', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type' => '*/*', 'User-Agent' => 'Ruby'}).
+        to_return(:status => 200, :body => File.new("spec/fixtures/status.xml"), :headers => [])
+
+      @gi_cat.harvest_all_resources_for_active_configuration
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gi_cat_driver
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -194,8 +194,10 @@ files:
 - lib/gi_cat_driver/version.rb
 - spec/esip_opensearch_query_builder_spec.rb
 - spec/fixtures/brokerConfigurations.xml
+- spec/fixtures/distributors.xml
 - spec/fixtures/opensearchesip_lucene_disabled.xml
 - spec/fixtures/opensearchesip_lucene_enabled.xml
+- spec/fixtures/status.xml
 - spec/gi_cat_driver_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -226,7 +228,9 @@ summary: Configure and control deployed instances of GI-Cat.
 test_files:
 - spec/esip_opensearch_query_builder_spec.rb
 - spec/fixtures/brokerConfigurations.xml
+- spec/fixtures/distributors.xml
 - spec/fixtures/opensearchesip_lucene_disabled.xml
 - spec/fixtures/opensearchesip_lucene_enabled.xml
+- spec/fixtures/status.xml
 - spec/gi_cat_driver_spec.rb
 - spec/spec_helper.rb