gi_cat_driver 0.2.3 → 0.2.4

data/Gemfile.lock

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

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.4
+  * Added new methods to create and delete accessors (GI-Cat resources) for a profile
 * 0.2.3
   * Changed the harvest to be sequential. (one resource won't start harvest till the current one is completed or timeout)
 * 0.2.2

data/lib/gi_cat_driver/version.rb

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

data/lib/gi_cat_driver.rb

@@ -129,6 +129,36 @@ module GiCatDriver
       end
     end
 
+    # Create an accessor (xml feed resource) for the given profile with the provided accessor configuration
+    def create_accessor( profile_name, accessor_configuration )
+      profile_id = find_profile_id( profile_name )
+      distributor_id = get_active_profile_distributor_id(profile_id)
+
+      response = Faraday.post do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/distributors/#{distributor_id}"
+        req.headers = AUTHORIZATION_HEADERS.merge({:enctype=>'multipart/form-data', :content_type=>'application/x-www-form-urlencoded'})
+        req.body = accessor_configuration
+      end
+
+      # The response contains a comma separated list of the accessor id as well as the harvester id
+      (accessor_id, harvester_id) = response.body.split(',', 2)
+
+      update_accessor_configuration( profile_id, accessor_id, accessor_configuration )
+
+      return accessor_id
+    end
+
+    # Remove an accessor (xml feed resource) with the given name from the given profile
+    def delete_accessor( profile_name, accessor_name )
+      profile_id = find_profile_id(profile_name)
+      harvester_id = find_harvester_id(profile_name, accessor_name)
+
+      Faraday.get do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/harvesters/#{harvester_id}", { :delete => 'true', :random => generate_random_number }
+        req.headers = AUTHORIZATION_HEADERS.merge({:enctype=>'multipart/form-data'})
+      end
+    end
+
     #### Private Methods
 
     private
@@ -147,15 +177,37 @@ module GiCatDriver
         AUTHORIZATION_HEADERS)
     end
 
-    # Retrive the distributor id given a profile id
-    def get_active_profile_distributor_id(id)
-      active_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{id}"
+    # Retrieve the harvester id given a profile name and accessor name
+    def find_harvester_id( profile_name, accessor_name )
+      profile_id = find_profile_id(profile_name)
+
+      distributor_id = get_active_profile_distributor_id(profile_id)
+
+      harvester_id = get_active_profile_harvester_id(profile_id, distributor_id)
+
+      return harvester_id
+    end
+
+    # Retrieve the distributor id given a profile id
+    def get_active_profile_distributor_id(profile_id)
+      active_profile_request = "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}"
       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
+      distributor_id = Nokogiri.XML(response.body).css("component id").text
+      return distributor_id
+    end
+
+    # Retrieve the harvester id given a profile id and distributor id
+    def get_active_profile_harvester_id(profile_id, distributor_id)
+      harvester_request = "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/distributors/#{distributor_id}"
+      response = Faraday.get do |req|
+        req.url harvester_request
+        req.headers = AUTHORIZATION_HEADERS
+      end
+      harvester_id = Nokogiri.XML(response.body).css("component id").text
+      return harvester_id
     end
 
     # Given a profile id, put all the associated resource id and title into harvest info array
@@ -251,6 +303,15 @@ module GiCatDriver
 
     end
 
+    def update_accessor_configuration( profile_id, accessor_id, accessor_configuration )
+      response = Faraday.post do |req|
+        req.url "#{@base_url}/services/conf/brokerConfigurations/#{profile_id}/accessors/#{accessor_id}/update"
+        req.headers = AUTHORIZATION_HEADERS.merge({:enctype=>'multipart/form-data', :content_type=>'application/x-www-form-urlencoded'})
+        req.body = accessor_configuration
+      end
+      return response.body
+    end
+
     def generate_random_number
       return rand
     end

data/spec/fixtures/harvesters.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><distributors xmlns="http://imaa.cnr.it/sdi/services/7.0/configurationMessages/schema"><distributor id="UUID-f446ba0c-ad5c-44
+    1e-ba66-269042d4f86e"><component><id>UUID-dfe61211-56f4-4fb9-9f99-a7f4d95916c</id><type>Harvester</type><title>fixture-nsidc-oai</title></component></distributor></distributors>

data/spec/gi_cat_driver_spec.rb

@@ -83,7 +83,7 @@ describe GiCatDriver do
           'User-Agent'=>'Ruby', 
           'Content-Type'=>'*/*'
         }, :query => {:opts => "active"})
-        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+        .to_return(:status => 200, :body => "", :headers => {})
 
       active_conf_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations"
       stub_request(:get,active_conf_url)
@@ -168,7 +168,7 @@ describe GiCatDriver do
           'User-Agent'=>'Faraday v0.8.7', 
           'Content-Type'=>'*/*'
         }, :query => {:opts => "active"})
-        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+        .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)
@@ -208,7 +208,7 @@ describe GiCatDriver do
           'User-Agent'=>'Faraday v0.8.7', 
           'Content-Type'=>'*/*'
         }, :query => {:opts => "active"})
-        .to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :headers => {})
+        .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)
@@ -274,4 +274,46 @@ describe GiCatDriver do
     end
   end
 
+  describe "accessor (xml feed resource) configurations" do
+    it "creates a new feed resource for a profile" do
+      profile_name = 'some_profile'
+      accessor_configuration = {:nameComponent => 'fixture-nsidc-oai', :endPoint => 'http://scm.nsidc.org:3000/nsidc/oai.htm', :type => 'OAI-PMH/DIF', :versions => '2.0', :comment => '', :bindingAccessor => 'HTTP_GET', :nameContactPoint => '', :organizationContact => '', :mailContactPoint => '', :telephoneContactPoint => '', :startDate => '', :interval => 'P0Y0M0DT0H0M0S', :typeComponent => 'harvester', :stop => ''}
+
+      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'=>'*/*'}, :query => {:nameRepository => 'gicat'}).
+        to_return(:status => 200, :body => File.new("spec/fixtures/brokerConfigurations.xml"), :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'=>'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(:post, get_resources_url)
+        .with(:headers => {
+          'Accept'=>'application/xml',
+          'User-Agent'=>'Ruby',
+          'Content-Type'=>'application/x-www-form-urlencoded'
+        }, :body => accessor_configuration)
+        .to_return(:status => 200, :body => "UUID-dfe61211-56f4-4fb9-9f99-a7f4d95916c,UUID-0cd0c6a9-498c-400a-9bdd-20778ec62beb", :headers => {})
+
+      update_resource_url = "http://admin:pass@www.somecompany.com/services/conf/brokerConfigurations/1/accessors/UUID-dfe61211-56f4-4fb9-9f99-a7f4d95916c/update"
+      stub_request(:post, update_resource_url)
+        .with(:headers => {
+          'Accept'=>'application/xml',
+          'User-Agent'=>'Ruby',
+          'Enctype'=>'multipart/form-data',
+          'Content-Type'=>'application/x-www-form-urlencoded'
+        }, :body => accessor_configuration)
+        .to_return(:status => 200, :body => "Salvato", :headers => {})
+
+      @gi_cat.create_accessor(profile_name, accessor_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.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70132345151200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 0.8.7
   type: :runtime
   prerelease: false
-  version_requirements: *70132345151200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70132345149560 !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: *70132345149560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70132345148160 !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: *70132345148160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70132345147140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +70,15 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *70132345147140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70132345146380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +86,15 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *70132345146380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: pygments.rb
-  requirement: &70132345145620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +102,15 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *70132345145620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70132345144960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +118,15 @@ dependencies:
         version: 0.99.4
   type: :development
   prerelease: false
-  version_requirements: *70132345144960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.99.4
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70132345144500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +134,15 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *70132345144500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: rocco
-  requirement: &70132345144040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +150,15 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *70132345144040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70132345143500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,7 +166,12 @@ dependencies:
         version: 1.11.0
   type: :development
   prerelease: false
-  version_requirements: *70132345143500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
 description: Configure and control deployed instances of GI-Cat.
 email:
 - stuart.reed@nsidc.org
@@ -145,6 +195,7 @@ files:
 - spec/esip_opensearch_query_builder_spec.rb
 - spec/fixtures/brokerConfigurations.xml
 - spec/fixtures/distributors.xml
+- spec/fixtures/harvesters.xml
 - spec/fixtures/opensearchesip_lucene_disabled.xml
 - spec/fixtures/opensearchesip_lucene_enabled.xml
 - spec/fixtures/status.xml
@@ -171,7 +222,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.
@@ -179,6 +230,7 @@ test_files:
 - spec/esip_opensearch_query_builder_spec.rb
 - spec/fixtures/brokerConfigurations.xml
 - spec/fixtures/distributors.xml
+- spec/fixtures/harvesters.xml
 - spec/fixtures/opensearchesip_lucene_disabled.xml
 - spec/fixtures/opensearchesip_lucene_enabled.xml
 - spec/fixtures/status.xml