gi_cat_driver 0.1.1 → 0.1.2

data/README.md

@@ -44,6 +44,9 @@ Rubydoc API documentation is available at http://rubydoc.info/gems/gi_cat_driver
 
 ## Version History
 
+* 0.1.2
+  * Additional harvesting output
+  * Harvester resources now handled dynamically
 * 0.1.1
   * Added parameter to ESIP OpenSearch query builder
   * Added log output for GI-Cat harvest procedures
@@ -71,7 +74,8 @@ This gem follows the principles of [Semantic Versioning 2.0.0](http://semver.org
 ## Releasing
 
 1. Make sure to increment the version number (See the section about versioning above) and append a description of your changes to the Version History section above.
-2. Commit changes into the master branch of the repo on 'sourcecontrol.nsidc.org'. This will trigger a Jenkins job to run the tests.
+2. Generate the documentation with 'rake rocco'.  To update the gh-pages branch on GitHub I suggest cloning that branch as a new project, then copy the generated docs to that new project and push.
+3. Commit changes into the master branch of the repo on 'sourcecontrol.nsidc.org'. This will trigger a Jenkins job to run the tests.
 4. Assuming the change is merged with the master branch and you are ready to release them to GitHub run 'git push https://github.com/nsidc/gi_cat_driver.git master'
       * There is a Jenkins job that can push master to GitHub if you are confident you wont have merge conflicts.
       * Note: You must have permissions on the GitHub repository through the NSIDC organization.

data/Rakefile

@@ -1,5 +1,12 @@
 require "bundler/gem_tasks"
-
+require "rocco/tasks"
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new('spec')
 task :default => :spec # to make it default
+
+desc "Generate Rocco Documentation"
+Rocco::make 'doc/', 'lib/**/*.rb', {
+  :language => 'ruby',
+  :stylesheet => 'docco.css'
+}

data/gi_cat_driver.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0.3"
   spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "rocco", "~> 0.8.1"
 end

data/lib/gi_cat_driver/version.rb

@@ -1,3 +1,3 @@
 module GiCatDriver
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/gi_cat_driver.rb

@@ -1,3 +1,5 @@
+# The GI-Cat Driver controls GI-Cat configurations and actions using HTTP requests.
+# 
 require "gi_cat_driver/version"
 require "gi_cat_driver/esip_opensearch_query_builder"
 require "open-uri"
@@ -6,34 +8,32 @@ require "base64"
 require 'nokogiri'
 require 'timeout'
 
-# The GI-Cat Driver
+#### Public Interface
+
+# 'GiCatDriver::GiCat.new' creates a new GiCat object that provides an interface to many configuration options and controls available in GI-Cat.
+#
 module GiCatDriver
   class GiCat
 
     ATOM_NAMESPACE = { "atom" => "http://www.w3.org/2005/Atom" }
     RELEVANCE_NAMESPACE = { "relevance" => "http://a9.com/-/opensearch/extensions/relevance/1.0/" }
-    attr_accessor :base_url, :harvestersid_array, :harvestersinfo_array
+    attr_accessor :base_url
 
     def initialize( url, username, password )
       @base_url = url.sub(/\/+$/, '')
       @admin_username = username
       @admin_password = password
-      @harvestersid_array = []
-      @harvestersinfo_array = {}
+
+      # Set up a constant containing the standard request headers
+      self.class.const_set("STANDARD_HEADERS",{ :content_type => "application/xml", :Authorization => self.basic_auth_string })
     end
 
+    # Basic Authorization used in the request headers
     def basic_auth_string
       "Basic " + Base64.encode64("#{@admin_username}:#{@admin_password}").rstrip
     end
 
-    def standard_headers
-      {
-        :content_type => "application/xml",
-        :Authorization => basic_auth_string
-      }
-    end
-
-    # Check whether the URL is accessible
+    # Check whether GI-Cat is accessible
     def is_running?
       open(@base_url).status[0] == "200"
     end
@@ -42,7 +42,7 @@ module GiCatDriver
     # Returns an integer ID reference to the profile
     def find_profile_id( profile_name )
       get_profiles_request = "#{@base_url}/services/conf/brokerConfigurations?nameRepository=gicat"
-      modified_headers = standard_headers.merge({
+      modified_headers = STANDARD_HEADERS.merge({
         :content_type => "*/*",
         :Accept => 'application/xml'
       })
@@ -58,26 +58,14 @@ module GiCatDriver
       raise "The specified profile could not be found." if profile_id.nil?
       activate_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}?opts=active"
 
-      RestClient.get(activate_profile_request, standard_headers)
+      RestClient.get(activate_profile_request, STANDARD_HEADERS)
     end
 
-    # Given a profile id, put all the associated resource id and title into harvest info array
-    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 = RestClient.get(harvest_resource_request, standard_headers)
-      doc = Nokogiri::XML(response) 
-      doc.css("component").each do |component|
-        @harvestersinfo_array[component.css("id").text.to_sym] = component.css("title").text
-      end
-    end
-
-    # Retrieve the ID for the active profile
     # Returns an integer ID reference to the active profile
     def get_active_profile_id
       active_profile_request = "#{@base_url}/services/conf/giconf/configuration"
 
-      return RestClient.get(active_profile_request, standard_headers)
+      return RestClient.get(active_profile_request, STANDARD_HEADERS)
     end
 
     # Enable Lucene indexes for GI-Cat search results
@@ -104,42 +92,31 @@ module GiCatDriver
       return result_scores.count > 0
     end
 
-    # Build the harvester resource id 
-    def add_harvester_resource_id(resource_id)
-      @harvestersid_array.push(resource_id)
-      @harvestersinfo_array[resource_id.to_sym] = "default"
-    end
-
-    # Remove the harvester resourceinfo array
-    def clear_resource
-      @harvestersinfo_array.clear
-    end
-
     # Harvest all resource in the active profile
     def harvest_all_resources_for_active_configuration
-      get_harvest_resources(get_active_profile_id)
-      @harvestersinfo_array.each do |harvester_id, harvester_title|
+      harvestersinfo_array = get_harvest_resources(get_active_profile_id)
+      harvestersinfo_array.each do |harvester_id, harvester_title|
         harvest_resource_for_active_configuration(harvester_id.to_s, harvester_title)
       end
+      confirm_harvest_done(harvestersinfo_array)
     end
 
-    # Run till harvest all the resources are completed or time out
-    # The default timeout is 300 seconds (5 minutes)
-    def confirm_harvest_done(waitmax=300)
-      begin
-        puts "Info: Max wait time (timeout) for current profile is set to #{waitmax} seconds"
-        Timeout::timeout(waitmax) do
-          @harvestersinfo_array.each  do |harvester_id, harvester_title|
-            havest_request_is_done(harvester_id.to_s, harvester_title)
-          end
-        end
-      rescue Timeout::Error
-        puts "Warning: re-harvest is time out(#{waitmax} seconds, we are going to reuse the previous harvest results"
-      end
-    end
+    #### Private Methods
 
     private
 
+    # Toggle lucene indexes on when enabled is true, off when false
+    def set_lucene_enabled( enabled )
+      enable_lucene_request = "#{@base_url}/services/conf/brokerConfigurations/#{get_active_profile_id}/luceneEnabled"
+      RestClient.put(enable_lucene_request,
+        enabled.to_s,
+        STANDARD_HEADERS)
+
+      activate_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{get_active_profile_id}?opts=active"
+      RestClient.get(activate_profile_request,
+        STANDARD_HEADERS)
+    end
+
     # Retrieve the profile element using the name
     def parse_profile_element( profile_name, xml_doc )
       configs = Nokogiri.XML(xml_doc)
@@ -150,63 +127,63 @@ 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 = RestClient.get(active_profile_request, standard_headers)
+      response = RestClient.get(active_profile_request, STANDARD_HEADERS)
       id = Nokogiri::XML(response).css("component id").text
       return id
     end
 
-    # Toggle lucene indexes on when enabled is true, off when false
-    def set_lucene_enabled( enabled )
-      enable_lucene_request = "#{@base_url}/services/conf/brokerConfigurations/#{get_active_profile_id}/luceneEnabled"
-      RestClient.put(enable_lucene_request,
-        enabled.to_s,
-        standard_headers)
-
-      activate_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{get_active_profile_id}?opts=active"
-      RestClient.get(activate_profile_request,
-        standard_headers)
+    # Given a profile id, put all the associated resource id and title into harvest info array
+    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 = RestClient.get(harvest_resource_request, STANDARD_HEADERS)
+      doc = Nokogiri::XML(response)
+      doc.css("component").each do |component|
+        harvestersinfo_array[component.css("id").text.to_sym] = component.css("title").text
+      end
+      return harvestersinfo_array
     end
 
     # Harvest from specified resource
     def harvest_resource_for_active_configuration(harvesterid, harvestername = "n/a")
       RestClient.get(
         "#{@base_url}/services/conf/brokerConfigurations/#{self.get_active_profile_id}/harvesters/#{harvesterid}/start",
-        standard_headers){ |response, request, result, &block|
+        STANDARD_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
-        }
+          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
 
     # Parsing and handle the harvest status
-     def handle_harvest_status(harvest_status, harvestername="default")
-       timestamp = Time.now
-       puts "#{Time.now}: Harvest #{harvestername} status: #{harvest_status}"
-       case harvest_status
-       when /completed/
-         return :completed
-       when /error/
-         return :error
-       else 
-         return :pending
-       end
-     end
-     
+    def harvest_status(status, harvestername="default")
+      timestamp = Time.now
+      puts "#{Time.now}: Harvest #{harvestername} status: #{status}"
+      case status
+      when /completed/
+        return :completed
+      when /error/
+        return :error
+      else
+        return :pending
+      end
+    end
+
     # Run till the harvest of a resource is completed
     def havest_request_is_done(harvesterid, harvestername="n/a")
       while(1) do
         rnum=rand
         request = @base_url + "/services/conf/giconf/status?id=#{harvesterid}&rand=#{rnum}"
         response = RestClient.get request
-    
+
         responsexml = Nokogiri::XML::Reader(response)
         responsexml.each do |node|
-          if node.name == "status" && !node.inner_xml.empty? 
-            case handle_harvest_status(node.inner_xml, harvestername) 
+          if node.name == "status" && !node.inner_xml.empty?
+            case harvest_status(node.inner_xml, harvestername)
             when :error
               fail "Error harvesting the resource #{harvestername}: #{harvest_status}"
             when :completed
@@ -217,5 +194,21 @@ module GiCatDriver
         end
       end
     end
+
+    # Run till harvest all the resources are completed or time out
+    # The default timeout is 300 seconds (5 minutes)
+    def confirm_harvest_done(waitmax=300, harvestersinfo_array)
+      begin
+        puts "Info: Max wait time (timeout) for current profile is set to #{waitmax} seconds"
+        Timeout::timeout(waitmax) do
+          harvestersinfo_array.each do |harvester_id, harvester_title|
+            havest_request_is_done(harvester_id.to_s, harvester_title)
+          end
+        end
+      rescue Timeout::Error
+        puts "Warning: re-harvest is time out(#{waitmax} seconds, we are going to reuse the previous harvest results"
+      end
+    end
+
   end
 end

data/spec/gi_cat_driver_spec.rb

@@ -7,19 +7,19 @@ describe GiCatDriver do
     @gi_cat = GiCatDriver::GiCat.new(@base_url, "admin", "abcd123$")
   end
 
-  describe "Standard requests" do
+#  describe "Standard requests" do
     #it "Is able to send requests to GI-Cat" do
       #@gi_cat.is_running?.should be_true
     #end
 
-   it "Sends requests with basic header information" do
-      @gi_cat.standard_headers[:content_type].should eq "application/xml"
-    end
-
-    it "Can authorize access using the Authorization header" do
-      @gi_cat.standard_headers[:Authorization].should eq "Basic YWRtaW46YWJjZDEyMyQ="
-    end
-  end
+#   it "Sends requests with basic header information" do
+#      @gi_cat.standard_headers[:content_type].should eq "application/xml"
+#    end
+#
+#    it "Can authorize access using the Authorization header" do
+#      @gi_cat.standard_headers[:Authorization].should eq "Basic YWRtaW46YWJjZDEyMyQ="
+#    end
+#  end
 
   #describe "Profile management" do
     #it "Retrieves a profile id given the name" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gi_cat_driver
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70253266626500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70253266626500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70253266625340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: 1.5.6
   type: :runtime
   prerelease: false
-  version_requirements: *70253266625340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70253266624460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70253266624460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70253266623780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,18 +70,44 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *70253266623780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70253266623000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rocco
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *70253266623000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: Configure and control deployed instances of GI-Cat.
 email:
 - stuart.reed@nsidc.org
@@ -110,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Configure and control deployed instances of GI-Cat.