gi_cat_driver 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p374@gi_cat_driver"
+
+#
+# Uncomment the following lines if you want to verify rvm version per project
+#
+# rvmrc_rvm_version="1.10.2" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+#
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gi_cat_driver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stuart Reed
+
+MIT License
+
+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.md

@@ -0,0 +1,34 @@
+# GI-Cat Driver
+
+The GI-Cat driver is a ruby wrapper for GI-Cat services.  Remotely configure administration options for a GI-Cat instance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gi_cat_driver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gi_cat_driver
+
+## Usage
+
+To start using the gem create a new instance
+
+```ruby
+gi_cat = GiCatDriver::GiCat.new('http://www.company.com/api/gi-cat', 'admin', 'password')
+```
+Please note you must provide a URL to a running GI-Cat instance as well as the administrator username and password.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec # to make it default

data/gi_cat_driver.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gi_cat_driver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gi_cat_driver"
+  spec.version       = GiCatDriver::VERSION
+  spec.authors       = ["Stuart Reed"]
+  spec.email         = ["stuart.reed@nsidc.org"]
+  spec.description   = %q{Configure and control deployed instances of GI-Cat.}
+  spec.summary       = %q{Configure and control deployed instances of GI-Cat.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/esip_opensearch_query_builder.rb

@@ -0,0 +1,29 @@
+
+# The EsipOpensearchQueryBuilder uses a hash of relevant key/value pairs to construct a string of parameters for the EsipOpensearchService
+module EsipOpensearchQueryBuilder
+
+  class QueryBuilder
+    def assemble_query(params)
+      return "?" + params.collect{ |k, v| "#{k}=#{v}" }.join("&")
+    end
+  end
+
+  def self.get_query_string( query_params={} )
+    all_params = { 
+      :si => '', 
+      :ct => '', 
+      :st => '', 
+      :bbox => '', 
+      :rel => '', 
+      :loc => '', 
+      :ts => '', 
+      :te => '', 
+      :lac => '', 
+      :luc => '', 
+      :outputFormat => ''
+    }.merge(query_params)
+
+    builder = QueryBuilder.new()
+    return builder.assemble_query(all_params)
+  end
+end

data/lib/gi_cat_driver/version.rb

@@ -0,0 +1,3 @@
+module GiCatDriver
+  VERSION = "0.0.1"
+end

data/lib/gi_cat_driver.rb

@@ -0,0 +1,97 @@
+require "gi_cat_driver/version"
+require "esip_opensearch_query_builder"
+require "open-uri"
+require "rest-client"
+require "base64"
+require 'nokogiri'
+
+module GiCatDriver
+  class GiCat
+
+    ATOM_NAMESPACE = { "atom" => "http://www.w3.org/2005/Atom" }
+    RELEVANCE_NAMESPACE = { "relevance" => "http://a9.com/-/opensearch/extensions/relevance/1.0/" }
+
+    def initialize( url, username, password )
+      @base_url = url.sub(/\/+$/, '')  # strip trailing slashes
+
+      @admin_username = username
+      @admin_password = password
+    end
+
+    def base_url
+      @base_url
+    end
+
+    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
+
+    def is_running?
+      open(@base_url).status[0] == "200"
+    end
+
+    def find_profile_id( profile_name )
+      get_profiles_request = "#{@base_url}/services/conf/brokerConfigurations?nameRepository=gicat"
+      modified_headers = standard_headers.merge({
+        :content_type => "*/*",
+        :Accept => 'application/xml'
+      })
+      xml_doc = RestClient.get(get_profiles_request, modified_headers)
+      profile = parse_profile_element(profile_name, xml_doc)
+
+      return (profile.empty? ? nil : profile.attr('id').value)
+    end
+
+    def parse_profile_element( profile_name, xml_doc )
+      configs = Nokogiri.XML(xml_doc)
+
+      return configs.css("brokerConfiguration[name=#{profile_name}]")
+    end
+
+    def enable_profile( profile_name )
+      profile_id = find_profile_id(profile_name)
+      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)
+    end
+
+    def get_active_profile_id
+      active_profile_request = "#{@base_url}/services/conf/giconf/configuration"
+
+      return RestClient.get(active_profile_request, standard_headers)
+    end
+
+    def enable_lucene
+      set_lucene_enabled true
+    end
+
+    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
+
+    def is_lucene_enabled?
+      query_string = EsipOpensearchQueryBuilder::get_query_string({ :st => "snow" })
+      results = Nokogiri::XML(open("#{@base_url}/services/opensearchesip#{query_string}"))
+
+      result_scores = results.xpath('//atom:feed/atom:entry/relevance:score', ATOM_NAMESPACE.merge(RELEVANCE_NAMESPACE))
+      result_scores.map { |score| score.text }
+
+      return result_scores.count > 0
+    end
+  end
+end

data/spec/esip_opensearch_query_builder_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'esip_opensearch_query_builder'
+
+describe EsipOpensearchQueryBuilder do
+
+  describe "get_query_string returns ESIP OpenSearch URLs" do
+    it "Returns a URL with empty parameters when called without arguments" do
+      query = EsipOpensearchQueryBuilder::get_query_string()
+      query.should eq "?si=&ct=&st=&bbox=&rel=&loc=&ts=&te=&lac=&luc=&outputFormat="
+    end
+
+    it "Returns a URL with a bounding box when called with a bbox argument" do
+      query = EsipOpensearchQueryBuilder::get_query_string( :bbox => 'abcd')
+      query.should eq "?si=&ct=&st=&bbox=abcd&rel=&loc=&ts=&te=&lac=&luc=&outputFormat="
+    end
+
+    it "Returns a URL with a search term when called with a st argument" do
+      query = EsipOpensearchQueryBuilder::get_query_string( :st => 'snow')
+      query.should eq "?si=&ct=&st=snow&bbox=&rel=&loc=&ts=&te=&lac=&luc=&outputFormat="
+    end
+  end
+end

data/spec/gi_cat_driver_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'gi_cat_driver'
+
+describe GiCatDriver do
+  before(:each) do
+    @base_url = ENV["URL"] or throw "Error: Must provide URL environment variable for GI-Cat!"
+    @gi_cat = GiCatDriver::GiCat.new(@base_url, "admin", "abcd123$")
+  end
+
+  it "Initializes with a base url that points to an instance of GI-Cat" do
+    expected = @base_url.sub(/\/+$/, '')
+    @gi_cat.base_url.should eq(expected)
+  end
+
+  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
+
+  describe "Profile management" do
+    it "Retrieves a profile id given the name" do
+      @gi_cat.find_profile_id("NORWEGIAN_CISL_NSIDC_EOL").should eq "1"
+    end
+
+    it "Throws an error if the profile cannot be found" do
+      @gi_cat.find_profile_id("notaprofile").should be_nil
+    end
+
+    it "Enables a profile given the name" do
+      @gi_cat.enable_profile("NORWEGIAN_CISL_NSIDC_EOL")
+      @gi_cat.get_active_profile_id.should eq "1"
+    end
+
+    it "Does not enable a profile if the profile cannot be found" do
+      expect { @gi_cat.enable_profile("notaprofile") }.to raise_error("The specified profile could not be found.")
+    end
+  end
+
+  describe "Lucene Indexing" do
+    it "Enables Lucene for the active profile" do
+      @gi_cat.enable_lucene
+      @gi_cat.is_lucene_enabled?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: gi_cat_driver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stuart Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Configure and control deployed instances of GI-Cat.
+email:
+- stuart.reed@nsidc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gi_cat_driver.gemspec
+- lib/esip_opensearch_query_builder.rb
+- lib/gi_cat_driver.rb
+- lib/gi_cat_driver/version.rb
+- spec/esip_opensearch_query_builder_spec.rb
+- spec/gi_cat_driver_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2265981651223281896
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2265981651223281896
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Configure and control deployed instances of GI-Cat.
+test_files:
+- spec/esip_opensearch_query_builder_spec.rb
+- spec/gi_cat_driver_spec.rb
+- spec/spec_helper.rb